Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
SecurityManager::EventHandler Class Reference
The stack will use these functions to signal events to the application, subclass to override handlers. More...
#include <SecurityManager.h>
Inherited by SecurityManager::LegacyEventHandler.
Public Member Functions | |
| virtual void | pairingRequest (ble::connection_handle_t connectionHandle) |
| Request application to accept or reject pairing. | |
| virtual void | pairingResult (ble::connection_handle_t connectionHandle, SecurityCompletionStatus_t result) |
| Indicate to the application that pairing has completed. | |
| virtual void | whitelistFromBondTable (Gap::Whitelist_t *whitelist) |
| Deliver the requested whitelist to the application. | |
| virtual void | linkEncryptionResult (ble::connection_handle_t connectionHandle, ble::link_encryption_t result) |
| Inform the device of the encryption state of a given link. | |
| virtual void | passkeyDisplay (ble::connection_handle_t connectionHandle, const SecurityManager::Passkey_t passkey) |
| Display the given passkey on the local device. | |
| virtual void | confirmationRequest (ble::connection_handle_t connectionHandle) |
| Indicate to the application that a confirmation is required. | |
| virtual void | passkeyRequest (ble::connection_handle_t connectionHandle) |
| Indicate to the application that a passkey is required. | |
| virtual void | keypressNotification (ble::connection_handle_t connectionHandle, SecurityManager::Keypress_t keypress) |
| Notify the application that a key was pressed by the peer during passkey entry. | |
| virtual void | legacyPairingOobRequest (ble::connection_handle_t connectionHandle) |
| Indicate to the application it needs to return legacy pairing OOB to the stack. | |
| virtual void | legacyPairingOobGenerated (const ble::address_t *address, const ble::oob_tk_t *temporaryKey) |
| Indicate that the application needs to send legacy pairing OOB data to the peer. | |
| virtual void | oobGenerated (const ble::address_t *address, const ble::oob_lesc_value_t *random, const ble::oob_confirm_t *confirm) |
| Indicate that the application needs to send secure connections OOB data to the peer. | |
| virtual void | signingKey (ble::connection_handle_t connectionHandle, const ble::csrk_t *csrk, bool authenticated) |
| Deliver the signing key to the application. | |
Detailed Description
The stack will use these functions to signal events to the application, subclass to override handlers.
Use SecurityManager::setSecurityManagerEventHandler to set the interface implementation to be used.
Definition at line 237 of file SecurityManager.h.
Member Function Documentation
| virtual void confirmationRequest | ( | ble::connection_handle_t | connectionHandle ) | [virtual] |
Indicate to the application that a confirmation is required.
This is used when the device does not have a keyboard but has a yes/no button. The device displays numbers on its display in response to passkeyDisplay and the user checks if they are the same on both devices. The application should proceed by supplying the confirmation using the confirmationEntered function.
- Parameters:
-
[in] connectionHandle connection connectionHandle
Definition at line 319 of file SecurityManager.h.
| virtual void keypressNotification | ( | ble::connection_handle_t | connectionHandle, |
| SecurityManager::Keypress_t | keypress | ||
| ) | [virtual] |
Notify the application that a key was pressed by the peer during passkey entry.
- Parameters:
-
[in] connectionHandle connection connectionHandle [in] keypress type of keypress event
Definition at line 339 of file SecurityManager.h.
| virtual void legacyPairingOobGenerated | ( | const ble::address_t * | address, |
| const ble::oob_tk_t * | temporaryKey | ||
| ) | [virtual] |
Indicate that the application needs to send legacy pairing OOB data to the peer.
- Parameters:
-
[in] address address that will be used in the pairing [in] temporaryKey temporary key to be used in legacy pairing
Definition at line 359 of file SecurityManager.h.
| virtual void legacyPairingOobRequest | ( | ble::connection_handle_t | connectionHandle ) | [virtual] |
Indicate to the application it needs to return legacy pairing OOB to the stack.
- Parameters:
-
[in] connectionHandle connection connectionHandle
Definition at line 349 of file SecurityManager.h.
| virtual void linkEncryptionResult | ( | ble::connection_handle_t | connectionHandle, |
| ble::link_encryption_t | result | ||
| ) | [virtual] |
Inform the device of the encryption state of a given link.
- Parameters:
-
[in] connectionHandle connection connectionHandle [in] result encryption state of the link
Definition at line 290 of file SecurityManager.h.
| virtual void oobGenerated | ( | const ble::address_t * | address, |
| const ble::oob_lesc_value_t * | random, | ||
| const ble::oob_confirm_t * | confirm | ||
| ) | [virtual] |
Indicate that the application needs to send secure connections OOB data to the peer.
- Parameters:
-
[in] address address that will be used in the pairing [in] random random number used to generate the confirmation [in] confirm confirmation value to be use for authentication in secure connections pairing
Definition at line 373 of file SecurityManager.h.
| virtual void pairingRequest | ( | ble::connection_handle_t | connectionHandle ) | [virtual] |
Request application to accept or reject pairing.
Application should respond by calling the appropriate function: acceptPairingRequest or cancelPairingRequest
- Parameters:
-
[in] connectionHandle connection connectionHandle
Definition at line 252 of file SecurityManager.h.
| virtual void pairingResult | ( | ble::connection_handle_t | connectionHandle, |
| SecurityCompletionStatus_t | result | ||
| ) | [virtual] |
Indicate to the application that pairing has completed.
- Parameters:
-
[in] connectionHandle connection connectionHandle [in] result result of the pairing indicating success or reason for failure
Definition at line 262 of file SecurityManager.h.
| virtual void passkeyDisplay | ( | ble::connection_handle_t | connectionHandle, |
| const SecurityManager::Passkey_t | passkey | ||
| ) | [virtual] |
Display the given passkey on the local device.
- Parameters:
-
[in] connectionHandle connection connectionHandle [in] passkey 6 digit passkey to be displayed
Definition at line 305 of file SecurityManager.h.
| virtual void passkeyRequest | ( | ble::connection_handle_t | connectionHandle ) | [virtual] |
Indicate to the application that a passkey is required.
The application should proceed by supplying the passkey through the passkeyEntered function.
- Parameters:
-
[in] connectionHandle connection connectionHandle
Definition at line 329 of file SecurityManager.h.
| virtual void signingKey | ( | ble::connection_handle_t | connectionHandle, |
| const ble::csrk_t * | csrk, | ||
| bool | authenticated | ||
| ) | [virtual] |
Deliver the signing key to the application.
- Parameters:
-
[in] connectionHandle connection connectionHandle [in] csrk signing key, pointer only valid during call [in] authenticated indicates if the signing key is authenticated
Definition at line 392 of file SecurityManager.h.
| virtual void whitelistFromBondTable | ( | Gap::Whitelist_t * | whitelist ) | [virtual] |
Deliver the requested whitelist to the application.
- Parameters:
-
[in] whitelist pointer to the whitelist filled with entries based on bonding information
Definition at line 276 of file SecurityManager.h.
Generated on Tue Jul 12 2022 12:22:50 by
1.7.2