gatt_client: improve gatt_client_set_required_security_level description

This commit is contained in:
Matthias Ringwald 2020-12-02 17:58:35 +01:00
parent 77da83a6e0
commit b11289a818

View File

@ -234,10 +234,12 @@ void gatt_client_init(void);
/**
* @brief Set minimum required security level for GATT Client
* @note The Bluetooth specification makes the GATT Server responsible to check for security.
* This allows an attacker to spoof existing devices with GATT Servers, but skip the authentication part
* If your application is exchanging sensitive data from a remote device, you would need to manually check
* the security level before sending/receive such data. This function allows to have the GATT Client post-pone
* any exchange until the required security level is established.
* This allows an attacker to spoof an existing device with a GATT Servers, but skip the authentication part.
* If your application is exchanging sensitive data with a remote device, you would need to manually check
* the security level before sending/receive such data.
* With level > 0, the GATT Client triggers authentication for all GATT Requests and defers any exchange
* until the required security level is established.
* gatt_client_request_can_write_without_response_event does not trigger authentication
* @pram level, default LEVEL_0 (no encryption required)
*/
void gatt_client_set_required_security_level(gap_security_level_t level);