Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
SecurityManager::EventHandler Class Reference

The stack will use these functions to signal events to the application, subclass to override handlers. More...

#include <SecurityManager.h>

Public Member Functions

virtual void pairingRequest (ble::connection_handle_t connectionHandle)
 Request application to accept or reject pairing. More...
 
virtual void pairingResult (ble::connection_handle_t connectionHandle, SecurityCompletionStatus_t result)
 Indicate to the application that pairing has completed. More...
 
virtual void peerIdentity (ble::connection_handle_t connectionHandle, const address_t *peer_address, bool address_is_public)
 Indicate that a peer address has been saved by the security manager or if we are bonded to the peer the identity has been retrieved from the database on connection. More...
 
virtual void whitelistFromBondTable (::ble::whitelist_t *whitelist)
 Deliver the requested whitelist to the application. More...
 
virtual void linkEncryptionResult (ble::connection_handle_t connectionHandle, ble::link_encryption_t result)
 Inform the device of the encryption state of a given link. More...
 
virtual void passkeyDisplay (ble::connection_handle_t connectionHandle, const Passkey_t passkey)
 Display the given passkey on the local device. More...
 
virtual void confirmationRequest (ble::connection_handle_t connectionHandle)
 Indicate to the application that a confirmation is required. More...
 
virtual void passkeyRequest (ble::connection_handle_t connectionHandle)
 Indicate to the application that a passkey is required. More...
 
virtual void keypressNotification (ble::connection_handle_t connectionHandle, ble::Keypress_t keypress)
 Notify the application that a key was pressed by the peer during passkey entry. More...
 
virtual void legacyPairingOobRequest (ble::connection_handle_t connectionHandle)
 Indicate to the application it needs to return legacy pairing OOB to the stack. More...
 
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. More...
 
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. More...
 
virtual void signingKey (ble::connection_handle_t connectionHandle, const ble::csrk_t *csrk, bool authenticated)
 Deliver the signing key to the application. More...
 
 ~EventHandler ()=default
 Prevent polymorphic deletion and avoid unnecessary virtual destructor as the SecurityManager class will never delete the instance it contains. More...
 

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 244 of file SecurityManager.h.

Constructor & Destructor Documentation

~EventHandler ( )
default

Prevent polymorphic deletion and avoid unnecessary virtual destructor as the SecurityManager class will never delete the instance it contains.

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]connectionHandleconnection connectionHandle

Definition at line 339 of file SecurityManager.h.

virtual void keypressNotification ( ble::connection_handle_t  connectionHandle,
ble::Keypress_t  keypress 
)
virtual

Notify the application that a key was pressed by the peer during passkey entry.

Parameters
[in]connectionHandleconnection connectionHandle
[in]keypresstype of keypress event

Definition at line 359 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]addressaddress that will be used in the pairing
[in]temporaryKeytemporary key to be used in legacy pairing

Definition at line 379 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]connectionHandleconnection connectionHandle

Definition at line 369 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]connectionHandleconnection connectionHandle
[in]resultencryption state of the link

Definition at line 310 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]addressaddress that will be used in the pairing
[in]randomrandom number used to generate the confirmation
[in]confirmconfirmation value to be use for authentication in secure connections pairing

Definition at line 393 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]connectionHandleconnection connectionHandle

Definition at line 256 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]connectionHandleconnection connectionHandle
[in]resultresult of the pairing indicating success or reason for failure

Definition at line 266 of file SecurityManager.h.

virtual void passkeyDisplay ( ble::connection_handle_t  connectionHandle,
const Passkey_t  passkey 
)
virtual

Display the given passkey on the local device.

Parameters
[in]connectionHandleconnection connectionHandle
[in]passkey6 digit passkey to be displayed

Definition at line 325 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]connectionHandleconnection connectionHandle

Definition at line 349 of file SecurityManager.h.

virtual void peerIdentity ( ble::connection_handle_t  connectionHandle,
const address_t peer_address,
bool  address_is_public 
)
virtual

Indicate that a peer address has been saved by the security manager or if we are bonded to the peer the identity has been retrieved from the database on connection.

Parameters
[in]connectionHandleConnection handle.
[in]peer_addressPeer address that has been saved by the security database, NULL it not found.
[in]address_is_publicAddress type, true if public. Invalid if peer_address NULL.

Definition at line 279 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]connectionHandleconnection connectionHandle
[in]csrksigning key, pointer only valid during call
[in]authenticatedindicates if the signing key is authenticated

Definition at line 412 of file SecurityManager.h.

virtual void whitelistFromBondTable ( ::ble::whitelist_t whitelist)
virtual

Deliver the requested whitelist to the application.

Parameters
[in]whitelistpointer to the whitelist filled with entries based on bonding information

Definition at line 296 of file SecurityManager.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.