Security Manager (sm)#

The commands in this section are used to manage Bluetooth security, including commands for starting and stopping encryption and commands for management of all bonding operations.

The following procedure can be used to bond with a remote device:

• Use command sm_configure to configure security requirements and I/O capabilities of this device.

• Use command sm_set_bondable_mode to set this device into bondable mode.

• Use command le_gap_connect to open a connection to the remote device.

• After the connection is open, use command sm_increase_security to encrypt the connection. This will also start the bonding process.

If MITM is required, the application needs to display or ask user to enter a passkey during the process. See events sm_passkey_display and sm_passkey_request for more information. The following procedure can be used to respond the bonding initiated by a remote device:

• Use command sm_configure to configure security requirements and I/O capabilities of this device.

• Use command sm_set_bondable_mode to set this device into bondable mode.

• Use command le_gap_start_advertising to set this device into advertising and connectable mode.

• Open a connection to this device from the remote device.

• After the connection is open, start the bonding process on the remote device.

If MITM is required, the application needs to display or ask user to enter a passkey during the process. See events sm_passkey_display and sm_passkey_request for more information.

sm commands#

sm_add_to_whitelist#

This command can be used to add device to whitelist, which can be enabled with le_gap_enable_whitelisting

Command#

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_add_to_whitelist_rsp_t *gecko_cmd_sm_add_to_whitelist(bd_addr address, uint8 address_type);  
  
/* Response id */  
gecko_rsp_sm_add_to_whitelist_id  
  
/* Response structure */  
struct gecko_msg_sm_add_to_whitelist_rsp_t  
{  
  uint16 result  
}  

sm_bonding_confirm#

This command can be used for accepting or rejecting bonding request.

Command#

• 0: Reject

• 1: Accept bonding request

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_bonding_confirm_rsp_t *gecko_cmd_sm_bonding_confirm(uint8 connection, uint8 confirm);  
  
/* Response id */  
gecko_rsp_sm_bonding_confirm_id  
  
/* Response structure */  
struct gecko_msg_sm_bonding_confirm_rsp_t  
{  
  uint16 result  
}  

sm_configure#

This command can be used to configure security requirements and I/O capabilities of the system.

Command#

• 0: Allow bonding without MITM protection

• 1: Bonding requires MITM protection

Bit 1:

• 0: Allow encryption without bonding

• 1: Encryption requires bonding. Note that this setting will also enable bonding.

Bit 2:

• 0: Allow bonding with legacy pairing

• 1: Secure connections only

Bit 3:

• 0: Bonding request does not need to be confirmed

• 1: Bonding requests need to be confirmed. Received bonding requests are notified with sm_confirm_bonding events.

Bit 4:

• 0: Allow all connections

• 1: Allow connections only from bonded devices

Bit 5 to 7: Reserved

Default value: 0x00
5 | uint8 | io_capabilities | I/O Capabilities. See link

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_configure_rsp_t *gecko_cmd_sm_configure(uint8 flags, uint8 io_capabilities);  
  
/* Response id */  
gecko_rsp_sm_configure_id  
  
/* Response structure */  
struct gecko_msg_sm_configure_rsp_t  
{  
  uint16 result  
}  

sm_delete_bonding#

This command can be used to delete specified bonding information or whitelist from Persistent Store.

Command#

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_delete_bonding_rsp_t *gecko_cmd_sm_delete_bonding(uint8 bonding);  
  
/* Response id */  
gecko_rsp_sm_delete_bonding_id  
  
/* Response structure */  
struct gecko_msg_sm_delete_bonding_rsp_t  
{  
  uint16 result  
}  

sm_delete_bondings#

This command can be used to delete all bonding information and whitelist from Persistent Store.

Command#

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_delete_bondings_rsp_t *gecko_cmd_sm_delete_bondings();  
  
/* Response id */  
gecko_rsp_sm_delete_bondings_id  
  
/* Response structure */  
struct gecko_msg_sm_delete_bondings_rsp_t  
{  
  uint16 result  
}  

sm_enter_passkey#

This command can be used to enter a passkey after receiving a passkey request event.

Command#

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_enter_passkey_rsp_t *gecko_cmd_sm_enter_passkey(uint8 connection, int32 passkey);  
  
/* Response id */  
gecko_rsp_sm_enter_passkey_id  
  
/* Response structure */  
struct gecko_msg_sm_enter_passkey_rsp_t  
{  
  uint16 result  
}  

sm_increase_security#

This command can be used to enhance the security of a connection to current security requirements. On an unencrypted connection, this will encrypt the connection and will also perform bonding if requested by both devices. On an encrypted connection, this will cause the connection re-encrypted.

Command#

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_increase_security_rsp_t *gecko_cmd_sm_increase_security(uint8 connection);  
  
/* Response id */  
gecko_rsp_sm_increase_security_id  
  
/* Response structure */  
struct gecko_msg_sm_increase_security_rsp_t  
{  
  uint16 result  
}  

Events generated#

sm_list_all_bondings#

This command can be used to list all bondings stored in the bonding database. Bondings are reported by using the sm_list_bonding_entry event for each bonding and the report is ended with sm_list_all_bondings_complete event. Recommended to be used only for debugging purposes, because reading from the Persistent Store is relatively slow.

Command#

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_list_all_bondings_rsp_t *gecko_cmd_sm_list_all_bondings();  
  
/* Response id */  
gecko_rsp_sm_list_all_bondings_id  
  
/* Response structure */  
struct gecko_msg_sm_list_all_bondings_rsp_t  
{  
  uint16 result  
}  

Events generated#

sm_passkey_confirm#

This command can be used for accepting or rejecting reported confirm value.

Command#

• 0: Reject

• 1: Accept confirm value

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_passkey_confirm_rsp_t *gecko_cmd_sm_passkey_confirm(uint8 connection, uint8 confirm);  
  
/* Response id */  
gecko_rsp_sm_passkey_confirm_id  
  
/* Response structure */  
struct gecko_msg_sm_passkey_confirm_rsp_t  
{  
  uint16 result  
}  

sm_set_bondable_mode#

This command can be used to set whether the device should accept new bondings. By default, the device does not accept new bondings.

Command#

• 0: New bondings not accepted

• 1: Bondings allowed

Default value: 0

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_set_bondable_mode_rsp_t *gecko_cmd_sm_set_bondable_mode(uint8 bondable);  
  
/* Response id */  
gecko_rsp_sm_set_bondable_mode_id  
  
/* Response structure */  
struct gecko_msg_sm_set_bondable_mode_rsp_t  
{  
  uint16 result  
}  

sm_set_debug_mode#

This command can be used to set Security Manager in debug mode. In this mode the secure connections bonding uses debug keys, so that the encrypted packet can be opened by Bluetooth protocol analyzer. To disable the debug mode, you need to restart the device.

Command#

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_set_debug_mode_rsp_t *gecko_cmd_sm_set_debug_mode();  
  
/* Response id */  
gecko_rsp_sm_set_debug_mode_id  
  
/* Response structure */  
struct gecko_msg_sm_set_debug_mode_rsp_t  
{  
  uint16 result  
}  

sm_set_oob_data#

This command can be used to set the OOB data (out-of-band encryption data) for legacy pairing for a device. The OOB data may be, for example, a PIN code exchanged over an alternate path like NFC. The device will not allow any other kind of bonding if OOB data is set. The OOB data cannot be set simultaneously with secure connections OOB data.

Command#

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_set_oob_data_rsp_t *gecko_cmd_sm_set_oob_data(uint8 oob_data_len, const uint8 *oob_data_data);  
  
/* Response id */  
gecko_rsp_sm_set_oob_data_id  
  
/* Response structure */  
struct gecko_msg_sm_set_oob_data_rsp_t  
{  
  uint16 result  
}  

sm_set_passkey#

This command can be used to enter a fixed passkey which will be used in the sm_passkey_display event.

Command#

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_set_passkey_rsp_t *gecko_cmd_sm_set_passkey(int32 passkey);  
  
/* Response id */  
gecko_rsp_sm_set_passkey_id  
  
/* Response structure */  
struct gecko_msg_sm_set_passkey_rsp_t  
{  
  uint16 result  
}  

sm_set_sc_remote_oob_data#

This command can be used to set OOB data and confirm values (out-of-band encryption) received from the remote device for secure connections pairing. OOB data must be enabled with sm_use_sc_oob before setting the remote device OOB data.

Command#

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_set_sc_remote_oob_data_rsp_t *gecko_cmd_sm_set_sc_remote_oob_data(uint8 oob_data_len, const uint8 *oob_data_data);  
  
/* Response id */  
gecko_rsp_sm_set_sc_remote_oob_data_id  
  
/* Response structure */  
struct gecko_msg_sm_set_sc_remote_oob_data_rsp_t  
{  
  uint16 result  
}  

sm_store_bonding_configuration#

This command can be used to set maximum allowed bonding count and bonding policy. The actual maximum number of bondings that can be supported depends on how much user data is stored in the NVM and the NVM size. The default value is 14.

Command#

• 0: If database is full, new bonding attempts will fail

• 1: New bonding will overwrite the oldest existing bonding

• 2: New bonding will overwrite longest time ago used existing bonding

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes

API#

/* Function */  
struct gecko_msg_sm_store_bonding_configuration_rsp_t *gecko_cmd_sm_store_bonding_configuration(uint8 max_bonding_count, uint8 policy_flags);  
  
/* Response id */  
gecko_rsp_sm_store_bonding_configuration_id  
  
/* Response structure */  
struct gecko_msg_sm_store_bonding_configuration_rsp_t  
{  
  uint16 result  
}  

sm_use_sc_oob#

This command can be used to enable the use of OOB data (out-of-band encryption data) for a device for secure connections pairing. The enabling will genarate new OOB data and confirm values which can be sent to the remote device. After enabling the secure connections OOB data, the remote devices OOB data can be set with sm_set_sc_remote_oob_data. Calling this function will erase any set remote device OOB data and confirm values. The device will not allow any other kind of bonding if OOB data is set. The secure connections OOB data cannot be enabled simultaneously with legacy pairing OOB data.

Command#

• 0: disable

• 1: enable

Response#

• 0: success

• Non-zero: an error occurred

For other values refer to the Error codes
6 | uint8array | oob_data | OOB data. 32-byte array. First 16-bytes contain randomly generated OOB data and last 16-bytes confirm value.

API#

/* Function */  
struct gecko_msg_sm_use_sc_oob_rsp_t *gecko_cmd_sm_use_sc_oob(uint8 enable);  
  
/* Response id */  
gecko_rsp_sm_use_sc_oob_id  
  
/* Response structure */  
struct gecko_msg_sm_use_sc_oob_rsp_t  
{  
  uint16 result,  
  uint8array oob_data  
}  

sm events#

sm_passkey_display#

This event indicates a request to display the passkey to the user.

Event#

• NOTE! When displaying the passkey to the user, prefix the number with zeros in order to obtain a 6 digit number

• Example: Passkey value is 42

• Number to display to user is 000042

API#

/* event id*/  
gecko_evt_sm_passkey_display_id  
  
/* event structure*/  
struct gecko_msg_sm_passkey_display_evt_t  
{  
  uint8 connection,  
  uint32 passkey  
}  

sm_passkey_request#

This event indicates a request for the user to enter the passkey displayed on the remote device. Use the command sm_enter_passkey to input the passkey value.

Event#

API#

/* event id*/  
gecko_evt_sm_passkey_request_id  
  
/* event structure*/  
struct gecko_msg_sm_passkey_request_evt_t  
{  
  uint8 connection  
}  

sm_confirm_passkey#

This event indicates a request to display the passkey to the user and for the user to confirm the displayed passkey. Use the command sm_passkey_confirm to accept or reject the displayed passkey.

Event#

• NOTE! When displaying the passkey to the user, prefix the number with zeros in order to obtain a 6 digit number

• Example: Passkey value is 42

• Number to display to user is 000042

API#

/* event id*/  
gecko_evt_sm_confirm_passkey_id  
  
/* event structure*/  
struct gecko_msg_sm_confirm_passkey_evt_t  
{  
  uint8 connection,  
  uint32 passkey  
}  

sm_bonded#

This event is triggered after the pairing or bonding procedure has been successfully completed.

Event#

• 0xff: Pairing completed without bonding - the pairing key will be discarded after disconnection.

• Other: Procedure completed, pairing key stored with given bonding handle

API#

/* event id*/  
gecko_evt_sm_bonded_id  
  
/* event structure*/  
struct gecko_msg_sm_bonded_evt_t  
{  
  uint8 connection,  
  uint8 bonding  
}  

sm_bonding_failed#

This event is triggered if the pairing or bonding procedure has failed.

Event#

API#

/* event id*/  
gecko_evt_sm_bonding_failed_id  
  
/* event structure*/  
struct gecko_msg_sm_bonding_failed_evt_t  
{  
  uint8 connection,  
  uint16 reason  
}  

sm_list_bonding_entry#

This event is triggered by the command sm_list_all_bondings if bondings exist in the local database.

Event#

API#

/* event id*/  
gecko_evt_sm_list_bonding_entry_id  
  
/* event structure*/  
struct gecko_msg_sm_list_bonding_entry_evt_t  
{  
  uint8 bonding,  
  bd_addr address,  
  uint8 address_type  
}  

sm_list_all_bondings_complete#

This event is triggered by the sm_list_all_bondings and follows sm_list_bonding_entry events.

Event#

API#

/* event id*/  
gecko_evt_sm_list_all_bondings_complete_id  
  
/* event structure*/  
struct gecko_msg_sm_list_all_bondings_complete_evt_t  
{  
}  

sm_confirm_bonding#

This event indicates a request to display that new bonding request has been received to the user and for the user to confirm the request. Use the command sm_bonding_confirm to accept or reject the bonding request.

Event#

• NOTE! When the bonding handle is anything else than -1 there is already existing bonding for this connection. Overwriting existing bonding is potential security risk.

API#

/* event id*/  
gecko_evt_sm_confirm_bonding_id  
  
/* event structure*/  
struct gecko_msg_sm_confirm_bonding_evt_t  
{  
  uint8 connection,  
  int8 bonding_handle  
}  

sm enumerations#

sm_bonding_key#

These values define the bonding information of the bonded device stored in persistent store.

Enumerations#

sm_io_capability#

These values define the security management related I/O capabilities supported by the device

Enumerations#