gapbondmgr.h

Go to the documentation of this file.

/******************************************************************************

 Group: WCS, BTS
 $Target Device: DEVICES $

 ******************************************************************************
 $License: TI_TEXT 2010 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 *****************************************************************************/

#ifndef GAPBONDMGR_H
#define GAPBONDMGR_H

#ifdef __cplusplus
extern "C"
{
#endif

/*-------------------------------------------------------------------
 * INCLUDES
 */
#include "ti/ble/host/gap/gap.h"

/*-------------------------------------------------------------------
 * CONSTANTS
 */

// This is a common file for the legacy and sysconfig examples,
// the parameters under ifndef SYSCFG are defined in this file for
// the legacy examples and generated using the sysconfig tool for
// the sysconfig examples
#ifndef SYSCFG
#if !defined ( GAP_BONDINGS_MAX )
#ifdef CC23X0
#define GAP_BONDINGS_MAX    5
#else
#define GAP_BONDINGS_MAX    10
#endif // CC23X0
#endif

#if GAP_BONDINGS_MAX < 1
#error "GAP_BONDINGS_MAX must be greater than 0"
#endif


#if !defined ( GAP_CHAR_CFG_MAX )
#define GAP_CHAR_CFG_MAX    4
#endif
#endif //SYSCFG

#define GAPBOND_PAIRING_MODE          0x400

#define GAPBOND_MITM_PROTECTION       0x402

#define GAPBOND_IO_CAPABILITIES       0x403

#define GAPBOND_OOB_ENABLED           0x404

#define GAPBOND_OOB_DATA              0x405

#define GAPBOND_BONDING_ENABLED       0x406

#define GAPBOND_KEY_DIST_LIST         0x407

#define GAPBOND_ERASE_ALLBONDS        0x409

#define GAPBOND_AUTO_FAIL_PAIRING     0x40A
#define GAPBOND_AUTO_FAIL_REASON      0x40B

#define GAPBOND_KEYSIZE               0x40C

#define GAPBOND_AUTO_SYNC_AL          0x40D

#define GAPBOND_BOND_COUNT            0x40E

#define GAPBOND_BOND_FAIL_ACTION      0x40F

#define GAPBOND_ERASE_SINGLEBOND      0x410

#define GAPBOND_SECURE_CONNECTION     0x411

#define GAPBOND_ECCKEY_REGEN_POLICY   0x412

#define GAPBOND_ECC_KEYS              0x413

#define GAPBOND_SC_HOST_DEBUG          0x414

#define GAPBOND_ERASE_BOND_IN_CONN     0x415

#define GAPBOND_ALLOW_DEBUG_KEYS       0x416

#define GAPBOND_LRU_BOND_REPLACEMENT  0x418

#define GAPBOND_ERASE_LOCAL_INFO      0x41A

#define GAPBOND_AUTHEN_PAIRING_ONLY   0x41B

#define GAPBOND_SAME_IRK_OPTION       0x41C

#define GAPBOND_ERASE_BONDS_ON_ADDRESS_CHANGE 0x41D

#define GAPBOND_PAIRING_MODE_NO_PAIRING          0x00
#define GAPBOND_PAIRING_MODE_WAIT_FOR_REQ        0x01
#define GAPBOND_PAIRING_MODE_INITIATE            0x02

#define GAPBOND_IO_CAP_DISPLAY_ONLY              0x00
#define GAPBOND_IO_CAP_DISPLAY_YES_NO            0x01
#define GAPBOND_IO_CAP_KEYBOARD_ONLY             0x02
#define GAPBOND_IO_CAP_NO_INPUT_NO_OUTPUT        0x03
#define GAPBOND_IO_CAP_KEYBOARD_DISPLAY          0x04

#define GAPBOND_KEYDIST_PENCKEY                  0x01
#define GAPBOND_KEYDIST_PIDKEY                   0x02
#define GAPBOND_KEYDIST_PSIGN                    0x04
#define GAPBOND_KEYDIST_PLINK                    0x08
#define GAPBOND_KEYDIST_CENCKEY                  0x10
#define GAPBOND_KEYDIST_CIDKEY                   0x20
#define GAPBOND_KEYDIST_CSIGN                    0x40
#define GAPBOND_KEYDIST_CLINK                    0x80

#define GAPBOND_SAME_IRK_UPDATE_BOND_REC               0x00
#define GAPBOND_SAME_IRK_TERMINATE_LINK                0x01

#define GAP_BOND_REC_ID_OFFSET              0 
#define GAP_BOND_LOCAL_LTK_OFFSET           1 
#define GAP_BOND_DEV_LTK_OFFSET             2 
#define GAP_BOND_DEV_IRK_OFFSET             3 
#define GAP_BOND_DEV_CSRK_OFFSET            4 
#define GAP_BOND_DEV_SIGN_COUNTER_OFFSET    5 
#define GAP_BOND_REC_IDS                    6

// Bonded State Flags
#define GAP_BONDED_STATE_NO_RECORD                      0xFF
#define GAP_BONDED_STATE_UNAUTHENTICATED                0x00
#define GAP_BONDED_STATE_AUTHENTICATED                  0x01
#define GAP_BONDED_STATE_SERVICE_CHANGED                0x02
#define GAP_BONDED_STATE_CAR                            0x04
#define GAP_BONDED_STATE_SECURECONNECTION               0x08
#define GAP_BONDED_STATE_RPA_ONLY                       0x10

#define GAPBOND_PAIRING_STATE_STARTED             0x00

#define GAPBOND_PAIRING_STATE_COMPLETE            0x01

#define GAPBOND_PAIRING_STATE_ENCRYPTED           0x02
#define GAPBOND_PAIRING_STATE_BOND_SAVED          0x03
#define GAPBOND_PAIRING_STATE_CAR_READ            0x04
#define GAPBOND_PAIRING_STATE_RPAO_READ           0x05
#define GAPBOND_GENERATE_ECC_DONE                 0x06

#define SMP_PAIRING_FAILED_PASSKEY_ENTRY_FAILED   0x01
#define SMP_PAIRING_FAILED_OOB_NOT_AVAIL          0x02

#define SMP_PAIRING_FAILED_AUTH_REQ               0x03
#define SMP_PAIRING_FAILED_CONFIRM_VALUE          0x04
#define SMP_PAIRING_FAILED_NOT_SUPPORTED          0x05

#define SMP_PAIRING_FAILED_ENC_KEY_SIZE           0x06
#define SMP_PAIRING_FAILED_CMD_NOT_SUPPORTED      0x07
#define SMP_PAIRING_FAILED_UNSPECIFIED            0x08

#define SMP_PAIRING_FAILED_REPEATED_ATTEMPTS      0x09

#define SMP_PAIRING_FAILED_INVALID_PARAMETERS     0x0A

#define SMP_PAIRING_FAILED_DHKEY_CHECK_FAILED     0x0B

#define SMP_PAIRING_FAILED_NUM_COMPARISON_FAILED  0x0C

#define GAPBOND_FAIL_NO_ACTION                         0x00
#define GAPBOND_FAIL_INITIATE_PAIRING                  0x01
#define GAPBOND_FAIL_TERMINATE_LINK                    0x02

#define GAPBOND_FAIL_TERMINATE_ERASE_BONDS             0x03

#define GAPBOND_FAIL_TERMINATE_ERASE_SINGLE_BOND       0x04

#define GAPBOND_SECURE_CONNECTION_NONE                 0x00
#define GAPBOND_SECURE_CONNECTION_ALLOW                0x01
#define GAPBOND_SECURE_CONNECTION_ONLY                 0x02

#define GAPBOND_REGENERATE_ALWAYS                       0x00
#define GAPBOND_REGENERATE_NEVER                        0xFF

#define ECC_KEYLEN                                     32

#define GAPBOND_READ_BY_ADDR                         0
#define GAPBOND_READ_BY_IDX                          1

/*-------------------------------------------------------------------
 * TYPEDEFS
 */

typedef void (*pfnPasscodeCB_t)
(
  uint8_t  *deviceAddr,
  uint16_t connectionHandle,
  uint8_t  uiInputs,
  uint8_t  uiOutputs,
  uint32_t numComparison
);

typedef void (*pfnPairStateCB_t)
(
  uint16_t connectionHandle,
  uint8_t  state,
  uint8_t  status
);

typedef struct
{
  pfnPasscodeCB_t     passcodeCB;       
  pfnPairStateCB_t    pairStateCB;      
} gapBondCBs_t;

typedef struct
{
  uint8_t privateKey[ECC_KEYLEN];     
  uint8_t publicKeyX[ECC_KEYLEN];     
  uint8_t publicKeyY[ECC_KEYLEN];     
} gapBondEccKeys_t;

//structure of OOB data
typedef struct gapBondOOBData
{
    uint8 confirm[KEYLEN];              //calculated/received confirm value
    uint8 rand[KEYLEN];                 //calculated/received random number
} gapBondOOBData_t;

typedef struct
{
  uint8_t   LTK[KEYLEN];              // Long Term Key (LTK)
  uint16_t  div;  //lint -e754        // LTK eDiv
  uint8_t   rand[B_RANDOM_NUM_SIZE];  // LTK random number
  uint8_t   keySize;                  // LTK key size
} gapBondLTK_t;

typedef struct
{
  uint8_t               addr[B_ADDR_LEN];
  GAP_Peer_Addr_Types_t addrType;
  uint8_t               stateFlags;
} gapBondRec_t;

typedef struct
{
  uint16_t attrHandle;  // attribute handle
  uint8_t  value;       // attribute value for this device
} gapBondCharCfg_t;

typedef struct
{
    uint8_t pairMode;
    uint8_t mitm;
    uint8_t ioCap;
    uint8_t bonding;
    uint8_t secureConnection;
    uint8_t authenPairingOnly;
    uint8_t autoSyncAL;
    uint8_t eccReGenPolicy;
    uint8_t KeySize;
    uint8_t removeLRUBond;
    uint8_t KeyDistList;
    uint8_t eccDebugKeys;
    uint8_t eraseBondWhileInConn;
    uint8_t bondFailAction;
    uint8_t sameIrkAction;
} gapBondParams_t;

typedef struct
{
    gapBondRec_t *pBondRec;      // pBondRec - basic bond record
    gapBondLTK_t *pLocalLtk;     // localLTK - LTK used by this device during pairing
    gapBondLTK_t *pDevLtk;       // devLTK - LTK used by the peer device during pairing
    uint8_t *pIRK;               // pIRK - IRK used by the peer device during pairing
    uint8_t *pSRK;               // pSRK - SRK used by the peer device during pairing
    uint32_t *pSignCount;        // signCounter - Sign counter used by the peer device during pairing
    gapBondCharCfg_t *pCharCfg;   // charCfg - GATT characteristic configuration
} gapBondNvRecord_t;

/*-------------------------------------------------------------------
 * API's
 */

extern void GAPBondMgr_Register(gapBondCBs_t *pCB);

uint8_t GAPBondMgr_GetAuthTaskID( void );

void GAPBondMgr_ReadIRKFromNV( uint8_t* keyBuff );

void GAPBondMgr_ReadCSRKFromNV( uint8_t* keyBuff );

extern bStatus_t GAPBondMgr_SetParameter(uint16_t param, uint8_t len,
    void *pValue);

extern bStatus_t GAPBondMgr_GetParameter(uint16_t param, void *pValue);

extern bStatus_t GAPBondMgr_Pair(uint16_t connHandle);

extern bStatus_t GAPBondMgr_FindAddr(uint8_t *pDevAddr,
                                     GAP_Peer_Addr_Types_t addrType,
                                     uint8_t *pIdx,
                                     GAP_Peer_Addr_Types_t *pIdentityAddrType,
                                     uint8_t *pIdentityAddr);

extern bStatus_t GAPBondMgr_ServiceChangeInd(uint16_t connectionHandle,
                                             uint8_t setParam);

extern bStatus_t GAPBondMgr_PasscodeRsp(uint16_t connectionHandle,
                                        uint8_t status, uint32_t passcode);

extern bStatus_t GAPBondMgr_SCGetLocalOOBParameters(gapBondOOBData_t *localOobData);

extern bStatus_t GAPBondMgr_SCSetRemoteOOBParameters(gapBondOOBData_t *remoteOobData,
                                                     uint8 OOBDataFlag);

extern bStatus_t GAPBondMgr_GenerateEccKeys( void );

/*********************************************************************
 * @fn      GAPBondMgr_ReadLocalLTK
 *
 * @brief   Read LTK from an existing bond using the device address
 *          This API is intended to be used by the BLE stack only
 *
 * @param   addrType - peer's address type
 * @param   pDevAddr - peer's address
 * @param   pLocalLTK - LTK used by this device during pairing
 *
 * @return  SUCCESS if bond was extracted
 *          bleGAPNotFound if there is no bond record
 */
bStatus_t GAPBondMgr_ReadLocalLTK(GAP_Peer_Addr_Types_t addrType,
                                         uint8_t *pDevAddr,
                                         gapBondLTK_t *pLocalLtk);

uint8_t GapBondMgr_readBondFromNV(uint8_t mode,
                                  uint8_t *pIdentifier,
                                  GAP_Peer_Addr_Types_t addrType,
                                  gapBondNvRecord_t *pBondRecord);

extern uint8_t GapBondMgr_writeBondToNv(gapBondRec_t *pBondRec,
                                        gapBondLTK_t *pLocalLtk,
                                        gapBondLTK_t *pDevLtk,
                                        uint8_t *pIRK,
                                        uint8_t *pSRK,
                                        uint32_t signCount,
                                        gapBondCharCfg_t *charCfg);

extern uint8_t GapBondMgr_GetPrevAuth(uint16_t connHandle, uint8_t *pMitmReq, uint8_t *pKeySize);

extern uint8_t GapBondMgr_StartEnc(uint16_t connHandle);

bool GAPBondMgr_isEnable( void );
/*-------------------------------------------------------------------
-------------------------------------------------------------------*/
#ifdef __cplusplus
}
#endif

#endif /* GAPBONDMGR_H */