ble_sec.h

Go to the documentation of this file.

 
#ifndef __BLE_SEC_H__
#define __BLE_SEC_H__
 
#include "ble_error.h"
#include <stdbool.h>
 
#define AUTH_NONE               0                 
#define AUTH_BOND              (1 << 0)           
#define AUTH_MITM              (1 << 2)           
#define AUTH_SEC_CON           (1 << 3)           
#define AUTH_KEY_PRESS_NOTIFY  (1 << 4)           
#define AUTH_ALL               (AUTH_BOND | AUTH_MITM | AUTH_SEC_CON | AUTH_KEY_PRESS_NOTIFY)  
#define KDIST_NONE      0            
#define KDIST_ENCKEY   (1 << 0)      
#define KDIST_IDKEY    (1 << 1)      
#define KDIST_SIGNKEY  (1 << 2)      
#define KDIST_ALL      (KDIST_ENCKEY | KDIST_IDKEY | KDIST_SIGNKEY)  
typedef enum
{
    IO_DISPLAY_ONLY       = 0x00,       
    IO_DISPLAY_YES_NO     = 0x01,       
    IO_KEYBOARD_ONLY      = 0x02,       
    IO_NO_INPUT_NO_OUTPUT = 0x03,       
    IO_KEYBOARD_DISPLAY   = 0x04        
} sec_io_cap_t;
 
typedef enum
{
    PAIR_REQ,       
    TK_REQ,         
    OOB_REQ,        
    NC_REQ          
} sec_enc_req_type_t;
 
typedef enum
{
    KEY_PRESS_STARTED   = 0x00,        
    KEY_PRESS_ENTERED   = 0x01,        
    KEY_PRESS_ERASED    = 0x02,        
    KEY_PRESS_CLEARED   = 0x03,        
    KEY_PRESS_COMPLETED = 0x04         
} sec_keypress_notify_t;
 
typedef enum
{
    ENC_SUCCESS                     = 0x00, 
    ENC_FAIL_PASSKEY_ENTRY_FAIL     = 0x01, 
    ENC_FAIL_OOB_NOT_AVAILBL        = 0x02, 
    ENC_FAIL_AUTH_REQ               = 0x03, 
    ENC_FAIL_CONFIRM_VAL_FAIL       = 0x04, 
    ENC_FAIL_PAIRING_NOT_SUPPORT    = 0x05, 
    ENC_FAIL_ENCRPT_KEY_SIZE        = 0x06, 
    ENC_FAIL_COMMAND_NOT_SUPPORT    = 0x07, 
    ENC_FAIL_UNSPECIFIED            = 0x08, 
    ENC_FAIL_REPEAT_ATTEMPT         = 0x09, 
    ENC_FAIL_INVALID_PARAM          = 0x0A, 
    ENC_FAIL_DHKEY_CHECK_FAIL       = 0x0B, 
    ENC_FAIL_NUM_CMP_FAIL           = 0x0C, 
    ENC_FAIL_BR_EDR_IN_PROGRESS     = 0x0D, 
    ENC_FAIL_KEY_DRIV_GEN_NOT_ALLOW = 0x0E, 
    ENC_FAIL_LTK_MISSING = 0x0F,            
} sec_enc_ind_t;
 
typedef enum
{
    SEC_MODE1_LEVEL1 = 0x00,    
    SEC_MODE1_LEVEL2 = 0x01,    
    SEC_MODE1_LEVEL3 = 0x02,    
    SEC_MODE1_LEVEL4 = 0x03,    
    SEC_MODE2_LEVEL1 = 0x04,    
    SEC_MODE2_LEVEL2 = 0x05,    
} sec_mode_level_t;
 
typedef enum
{
    SEC_TK_OOB = 0x00,        
    SEC_TK_DISPLAY,           
    SEC_TK_KEY_ENTRY          
} sec_tk_type_t;
 
typedef enum
{
    BOND_INFO_LOAD_FAILED = 0x00,      
    LTK_VALID_MASK_ERR,                
    EDIV_RAND_VALUE_ERR                
} sec_key_missing_reason_t;
typedef struct
{
    sec_mode_level_t level;         
    sec_io_cap_t     io_cap;        
    bool             oob;           
    uint8_t          auth;          
    uint8_t          key_size;      
    uint8_t          ikey_dist;     
    uint8_t          rkey_dist;     
} sec_param_t;
 
typedef struct
{
    uint8_t key[16];          
} sec_tk_t;
 
typedef struct
{
    uint8_t conf[16];        
    uint8_t rand[16];        
} sec_oob_t;
 
typedef union
{
    sec_tk_t  tk;           
    sec_oob_t oob;          
} sec_cfm_enc_data_t;
 
typedef struct
{
    sec_enc_req_type_t req_type;         
    bool               accept;           
    sec_cfm_enc_data_t data;             
} sec_cfm_enc_t;
 
typedef struct
{
    uint8_t value[4];       
} sec_nc_t;
 
typedef union
{
    sec_tk_type_t tk_type;      
    sec_oob_t     oob_data;     
    sec_nc_t      nc_data;      
} sec_enc_req_data_t;
 
typedef struct
{
    sec_enc_req_type_t req_type;        
    sec_enc_req_data_t data;            
} sec_enc_req_t;
 
typedef struct
{
    void (*app_sec_enc_req_cb)(uint8_t conn_idx, sec_enc_req_t *p_enc_req);                   
    void (*app_sec_enc_ind_cb)(uint8_t conn_idx, sec_enc_ind_t enc_ind, uint8_t auth);        
    void (*app_sec_keypress_notify_cb)(uint8_t conn_idx, sec_keypress_notify_t notify_type);  
    void (*app_sec_key_missing_cb)(uint8_t conn_idx, sec_key_missing_reason_t reason);        
} sec_cb_fun_t;
uint16_t ble_sec_params_set(sec_param_t *p_sec_param);
 
uint16_t ble_sec_enc_start(uint8_t conn_idx);
 
uint16_t ble_sec_enc_cfm(uint8_t conn_idx, const sec_cfm_enc_t *p_cfm_enc);
 
uint16_t ble_sec_keypress_notify_send(uint8_t conn_idx, uint8_t notify_type);
#endif