ble/net/sm.h header reference
[Bluetooth Low Energy library module]
The source code of this header can be browsed online.
Description [link]
This header defines Network Layer API for Security Manager Protocol.
Security manager layer is involved in the pairing process. Once paired, connections can be encrypted without SM layer taking action.
SM layer expects its delegate to handle pairing requests and respond to them.
SM is expected to be bound on a L2CAP layer.
There is a generic implementation of this layer in the library that can be created through ble_sm_create.
Members [link]
Types [link]
- struct ble_sm_delegate_vtable_s
- struct ble_sm_handler_s
- enum ble_sm_pairing_mode_e
- struct ble_sm_param_s
Functions [link]
- struct ble_sm_delegate_vtable_s * ble_sm_delegate_vtable_s_from_base(void *x)
- struct ble_sm_handler_s * ble_sm_handler_s_from_base(void *x)
- void ble_sm_pairing_abort(struct net_layer_s *layer, enum sm_reason reason)
- void ble_sm_pairing_accept(struct net_layer_s *layer, bool_t mitm_protection, uint32_t pin, const void *oob_data)
- void ble_sm_pairing_request(struct net_layer_s *layer, bool_t mitm_protection, bool_t bonding)
Members detail [link]
#define BLE_SM_H_ [link]
This macro is declared in ble/net/sm.h source file, line 21.
struct ble_sm_delegate_vtable_s [link]
This struct is declared in ble/net/sm.h source file, line 89.
| Field | Description |
|---|---|
| struct net_layer_delegate_vtable_s base; | |
| void (*pairing_requested)(void *delegate, struct net_layer_s *layer, bool_t bonding) ; | |
| void (*pairing_failed)(void *delegate, struct net_layer_s *layer, enum sm_reason reason) ; | |
| void (*pairing_success)(void *delegate, struct net_layer_s *layer) ; | |
| void (*bonding_success)(void *delegate, struct net_layer_s *layer) ; |
struct ble_sm_delegate_vtable_s * ble_sm_delegate_vtable_s_from_base(void *x) [link]
This function is declared in ble/net/sm.h source file, line 103.
struct ble_sm_handler_s [link]
This struct is declared in ble/net/sm.h source file, line 71.
| Field | Description |
|---|---|
| struct net_layer_handler_s base; | |
| void (*pairing_request)(struct net_layer_s *layer, bool_t mitm_protectionbool_t bonding) ; | |
| void (*pairing_accept)(struct net_layer_s *layer, bool_t mitm_protectionuint32_t pin, const void *oob_data) ; | |
| void (*pairing_abort)(struct net_layer_s *layer, enum sm_reason reason) ; |
struct ble_sm_handler_s * ble_sm_handler_s_from_base(void *x) [link]
This function is declared in ble/net/sm.h source file, line 86.
void ble_sm_pairing_abort(struct net_layer_s *layer, enum sm_reason reason) [link]
This function is declared in ble/net/sm.h source file, line 123.
void ble_sm_pairing_accept(struct net_layer_s *layer, bool_t mitm_protection, uint32_t pin, const void *oob_data) [link]
This function is declared in ble/net/sm.h source file, line 117.
enum ble_sm_pairing_mode_e [link]
This enum is declared in ble/net/sm.h source file, line 64.
| Identifier | Description |
|---|---|
| BLE_SM_PAIRING_JUSTWORKS | |
| BLE_SM_PAIRING_PIN | |
| BLE_SM_PAIRING_OOB |
void ble_sm_pairing_request(struct net_layer_s *layer, bool_t mitm_protection, bool_t bonding) [link]
This function is declared in ble/net/sm.h source file, line 108.
struct ble_sm_param_s [link]
This struct is declared in ble/net/sm.h source file, line 57.
| Field | Description |
|---|---|
| struct ble_peer_s * peer; | |
| struct ble_addr_s local_addr; | |
| struct dev_rng_s * rng; | |
| struct device_crypto_s * crypto; |