sd_ble_gap_lesc_dhkey_reply()

uint32_t sd_ble_gap_lesc_dhkey_reply	(	uint16_t	conn_handle,
		uint8_t	sec_status,
		ble_gap_lesc_dhkey_t const *	p_dhkey )

#include <ble_gap.h>

Reply with an LE Secure connections DHKey.

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

Note

Application is required to validate ble_gap_evt_lesc_dhkey_request_t::p_pk_peer received in BLE_GAP_EVT_LESC_DHKEY_REQUEST according to Bluetooth Core Specification, Vol 3, Part H, Section 2.3.5.6.1.

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 LESC Pairing: Just Works

Peripheral LESC Bonding: Numeric Comparison

Peripheral LESC Bonding: Passkey Entry, Peripheral Displays

Peripheral LESC Bonding: Passkey Entry, User Inputs on Peripheral

Peripheral LESC Bonding: Out of Band

Parameters

[in]	conn_handle	Connection handle.
[in]	sec_status	Security status, see GAP Security status BLE_GAP_SEC_STATUS_SUCCESS if ble_gap_evt_lesc_dhkey_request_t::p_pk_peer validation passed and DHKey generated successfully BLE_GAP_SEC_STATUS_DHKEY_FAILURE if ble_gap_evt_lesc_dhkey_request_t::p_pk_peer validation failed BLE_GAP_SEC_STATUS_INVALID_PARAMS if ble_gap_evt_lesc_dhkey_request_t::p_pk_peer is debug key and application is in a mode in which it cannot accept the debug key
[in]	p_dhkey	LE Secure Connections DHKey. This parameter is ignored if sec_status is not set to BLE_GAP_SEC_STATUS_SUCCESS.

Return values

NRF_SUCCESS	DHKey successfully set.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied.
NRF_ERROR_INVALID_STATE	Invalid state to perform operation. Either: The peer is not authenticated. The application has not pulled a BLE_GAP_EVT_LESC_DHKEY_REQUEST event.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid connection handle supplied.