◆ sd_ble_gap_sec_params_reply()

uint32_t sd_ble_gap_sec_params_reply	(	uint16_t	conn_handle,
		uint8_t	sec_status,
		ble_gap_sec_params_t const *	p_sec_params,
		ble_gap_sec_keyset_t const *	p_sec_keyset )

#include <ble_gap.h>

Reply with GAP security parameters.

This function is only used to reply to a BLE_GAP_EVT_SEC_PARAMS_REQUEST, calling it at other times will result in an NRF_ERROR_INVALID_STATE.

Events generated

This function is used during authentication procedures see the list of events in the documentation of sd_ble_gap_authenticate.

Relevant Message Sequence Charts

Peripheral Legacy Pairing: Just Works

Parameters

[in]	conn_handle	Connection handle.
[in]	sec_status	Security status, see GAP Security status.
[in]	p_sec_params	Pointer to a ble_gap_sec_params_t security parameters structure. In the central role this must be set to NULL, as the parameters have already been provided during a previous call to sd_ble_gap_authenticate.
[in,out]	p_sec_keyset	Pointer to a ble_gap_sec_keyset_t security keyset structure. Any keys generated and/or distributed as a result of the ongoing security procedure will be stored into the memory referenced by the pointers inside this structure. The keys will be stored and available to the application upon reception of a BLE_GAP_EVT_AUTH_STATUS event. Note that the SoftDevice expects the application to provide memory for storing the peer's keys. So it must be ensured that the relevant pointers inside this structure are not NULL. The pointers to the local key can, however, be NULL, in which case, the local key data will not be available to the application upon reception of the BLE_GAP_EVT_AUTH_STATUS event.

Return values

NRF_SUCCESS	Successfully accepted security parameter from the application.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_BUSY	The stack is busy, process pending events and retry.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied.
NRF_ERROR_INVALID_STATE	Security parameters has not been requested.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid connection handle supplied.
NRF_ERROR_NOT_SUPPORTED	Distribution of own Identity Information is only supported if the Central Address Resolution characteristic is configured to be included or the Softdevice is configured to support peripheral roles only. See ble_gap_cfg_car_incl_cfg_t and ble_gap_cfg_role_count_t.