179 lines
7.8 KiB
C
179 lines
7.8 KiB
C
|
/**************************************************************************************************
|
|||
|
|
Filename: mac_security.h
|
|||
|
|
Revised: $Date: 2011-03-25 15:25:58 -0700 (Fri, 25 Mar 2011) $
|
|||
|
|
Revision: $Revision: 25522 $
|
|||
|
|
|
|||
|
|
Description: Internal interface file for MAC security module.
|
|||
|
|
|
|||
|
|
|
|||
|
|
Copyright 2010-2011 Texas Instruments Incorporated. All rights reserved.
|
|||
|
|
|
|||
|
|
IMPORTANT: Your use of this Software is limited to those specific rights
|
|||
|
|
granted under the terms of a software license agreement between the user
|
|||
|
|
who downloaded the software, his/her employer (which must be your employer)
|
|||
|
|
and Texas Instruments Incorporated (the "License"). You may not use this
|
|||
|
|
Software unless you agree to abide by the terms of the License. The License
|
|||
|
|
limits your use, and you acknowledge, that the Software may not be modified,
|
|||
|
|
copied or distributed unless embedded on a Texas Instruments microcontroller
|
|||
|
|
or used solely and exclusively in conjunction with a Texas Instruments radio
|
|||
|
|
frequency transceiver, which is integrated into your product. Other than for
|
|||
|
|
the foregoing purpose, you may not use, reproduce, copy, prepare derivative
|
|||
|
|
works of, modify, distribute, perform, display or sell this Software and/or
|
|||
|
|
its documentation for any purpose.
|
|||
|
|
|
|||
|
|
YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE AND DOCUMENTATION ARE
|
|||
|
|
PROVIDED <EFBFBD>AS IS<EFBFBD> WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
|
|||
|
|
INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE,
|
|||
|
|
NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL
|
|||
|
|
TEXAS INSTRUMENTS OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER CONTRACT,
|
|||
|
|
NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER
|
|||
|
|
LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
|
|||
|
|
INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE
|
|||
|
|
OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT
|
|||
|
|
OF SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
|
|||
|
|
(INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
|
|||
|
|
|
|||
|
|
Should you have any questions regarding your right to use this Software,
|
|||
|
|
contact Texas Instruments Incorporated at www.TI.com.
|
|||
|
|
**************************************************************************************************/
|
|||
|
|
|
|||
|
|
#ifndef MAC_SECURITY_H
|
|||
|
|
#define MAC_SECURITY_H
|
|||
|
|
|
|||
|
|
/* ------------------------------------------------------------------------------------------------
|
|||
|
|
* Includes
|
|||
|
|
* ------------------------------------------------------------------------------------------------
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
#include "mac_api.h"
|
|||
|
|
#include "mac_high_level.h"
|
|||
|
|
|
|||
|
|
/* ------------------------------------------------------------------------------------------------
|
|||
|
|
* Typedefs
|
|||
|
|
* ------------------------------------------------------------------------------------------------
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
/* Max frame counter */
|
|||
|
|
#define MAC_MAX_FRAME_COUNTER 0xFFFFFFFF
|
|||
|
|
|
|||
|
|
/* Nonce length */
|
|||
|
|
#define MAC_NONCE_LEN 13
|
|||
|
|
|
|||
|
|
/* MIC length */
|
|||
|
|
#define MAC_MIC_LEN 16
|
|||
|
|
|
|||
|
|
/* This MAC status is only locally used in MAC security */
|
|||
|
|
#define MAC_CONDITIONALLY_PASSED (MAC_IMPROPER_SECURITY_LEVEL-1)
|
|||
|
|
|
|||
|
|
/* Device lookup size short */
|
|||
|
|
#define MAC_DEVICE_LOOKUP_SHORT_LEN 4
|
|||
|
|
|
|||
|
|
/* Device lookup size lonh */
|
|||
|
|
#define MAC_DEVICE_LOOKUP_LONG_LEN 8
|
|||
|
|
|
|||
|
|
|
|||
|
|
/* ------------------------------------------------------------------------------------------------
|
|||
|
|
* Global Variables
|
|||
|
|
* ------------------------------------------------------------------------------------------------
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
/* Length M of authentication tag indexed by security level */
|
|||
|
|
extern CODE const uint8 macAuthTagLen[];
|
|||
|
|
|
|||
|
|
/* Length of key source indexed by key identifier mode */
|
|||
|
|
extern CODE const uint8 macKeySourceLen[];
|
|||
|
|
|
|||
|
|
/* Incoming frame counter in the auxiliary security header */
|
|||
|
|
extern uint32 macFrameCounter;
|
|||
|
|
|
|||
|
|
/* ------------------------------------------------------------------------------------------------
|
|||
|
|
* Function Prototypes
|
|||
|
|
* ------------------------------------------------------------------------------------------------
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
/**************************************************************************************************
|
|||
|
|
* @fn macOutgoingFrameSecurity
|
|||
|
|
*
|
|||
|
|
* @brief The inputs to this procedure are the frame to be secured and the security
|
|||
|
|
* parameters from the originating primitive or automatic request PIB attributes.
|
|||
|
|
* The outputs from this procedure are the status of the procedure and, if this status
|
|||
|
|
* is MAC_SUCCESS, pointer to the key to be used to secure the outgoing frame.
|
|||
|
|
*
|
|||
|
|
* input parameters
|
|||
|
|
*
|
|||
|
|
* @param pBuf - Pointer to buffer containing tx struct.
|
|||
|
|
* @param pDstAddr - Destination address.
|
|||
|
|
* @param dstPanId - Destination PAN ID.
|
|||
|
|
*
|
|||
|
|
* output parameters
|
|||
|
|
*
|
|||
|
|
* @param ppKey - Pointer to pointer to key to be used to secure the outgoing frame
|
|||
|
|
*
|
|||
|
|
* @return MAC_SUCCESS if successful, otherwise failure status.
|
|||
|
|
**************************************************************************************************
|
|||
|
|
*/
|
|||
|
|
MAC_INTERNAL_API uint8 macOutgoingFrameSecurity( macTx_t *pBuf,
|
|||
|
|
sAddr_t *pDstAddr,
|
|||
|
|
uint16 dstPanId,
|
|||
|
|
uint8 **ppKey );
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**************************************************************************************************
|
|||
|
|
* @fn macIncomingFrameSecurity
|
|||
|
|
*
|
|||
|
|
* @brief The input to this procedure is the frame to be unsecured. The outputs from this
|
|||
|
|
* procedure are the unsecured frame, the security level, the key identifier mode, the
|
|||
|
|
* key source, the key index, and the status of the procedure. All outputs of this
|
|||
|
|
* procedure are assumed to be invalid unless and until explicitly set in this
|
|||
|
|
* procedure. It is assumed that the PIB attributes associating KeyDescriptors in
|
|||
|
|
* macKeyTable with a single, unique device or a number of devices will have been
|
|||
|
|
* established by the next higher layer.
|
|||
|
|
*
|
|||
|
|
* input parameters
|
|||
|
|
*
|
|||
|
|
* @param pMsg - pointer to the frame to be unsecured.
|
|||
|
|
*
|
|||
|
|
* output parameters
|
|||
|
|
*
|
|||
|
|
* @param pMsg - pointer to the unsecured frame
|
|||
|
|
*
|
|||
|
|
* @return MAC_SUCCESS if successful, otherwise failure status.
|
|||
|
|
**************************************************************************************************
|
|||
|
|
*/
|
|||
|
|
MAC_INTERNAL_API uint8 macIncomingFrameSecurity( macRx_t *pMsg );
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**************************************************************************************************
|
|||
|
|
* @fn macCcmStarTransform
|
|||
|
|
*
|
|||
|
|
* @brief This function is used to do CCM* transformation. The inputs to this procedure are
|
|||
|
|
* the key, nonce, a data, m data. The output from this procedure is c data.
|
|||
|
|
*
|
|||
|
|
* input parameters
|
|||
|
|
*
|
|||
|
|
* @param pKey - pointer to key
|
|||
|
|
* @param securityLevel - security level
|
|||
|
|
* @param pAData - pointer to a data
|
|||
|
|
* @param aDataLen - a data length
|
|||
|
|
* @param pMData - pointer to m data
|
|||
|
|
* @param mDataLen - m data length
|
|||
|
|
*
|
|||
|
|
* output parameters
|
|||
|
|
*
|
|||
|
|
* @return MAC_SUCCESS if successful, otherwise failure status.
|
|||
|
|
**************************************************************************************************
|
|||
|
|
*/
|
|||
|
|
MAC_INTERNAL_API uint8 macCcmStarTransform( uint8 *pKey,
|
|||
|
|
uint8 securityLevel,
|
|||
|
|
uint8 *pAData,
|
|||
|
|
uint8 aDataLen,
|
|||
|
|
uint8 *pMData,
|
|||
|
|
uint8 mDataLen );
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**************************************************************************************************
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
#endif /* MAC_SECURITY_H */
|
|||
|
|
|