Skip to content

Adjusted SecurityManager Doxygen ASCII art #12661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 23, 2020
Merged

Adjusted SecurityManager Doxygen ASCII art #12661

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 36 additions & 36 deletions features/FEATURE_BLE/ble/SecurityManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,19 +124,19 @@ namespace interface {
* Sequence diagram "Just Works" pairing
*
* \verbatim
* /----------- Device 1 --------------\ *------ BLE link ------* /-------------- Device 2 -------------\
* /-------- Device 1 ---------\ *----- BLE link -----* /----------- Device 2-----------\
*
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |---------------------------> requestPairing() | | |
* | | |------[pairing start]------>| | |
* | | | |----------------> pairingRequest() ->|
* | | | acceptPairing() <------------------------ |
* | | |<---[pairing complete]----->| | |
* |<- pairingResult() <---------------| |----------------> pairingResult() -->|
* | | | | | |
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |-------------------> requestPairing() | | |
* | | |-----[pairing start]----->| | |
* | | | |---------> pairingRequest() -->|
* | | | acceptPairing() <--------------------- |
* | | |<--[pairing complete]---->| | |
* |<- pairingResult() <-------| |---------> pairingResult() --->|
* | | | | | |
* @endverbatim
*
*
* @note the requestPairing() call isn't required to trigger pairing. Pairing will also be triggered
* if you request encryption and authentication and no bonding information is available. The sequence will
* be the same save for the lack of explicit requestPairing() call.
Expand All @@ -145,44 +145,44 @@ namespace interface {
* Sequence diagram Encryption request when bonding information is available
*
* \verbatim
* /----------- Device 1 --------------\ *------ BLE link ------* /-------------- Device 2 -------------\
* /--------- Device 1 ---------\ *------ BLE link ------* /--------- Device 2 ---------\
*
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |---------------------------> setLinkEncryption() | | |
* | | |<-[encryption established]->| | |
* |<- linkEncryptionResult() <--------| |---------> linkEncryptionResult() -->|
* | | | | | |
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |--------------------> setLinkEncryption() | | |
* | | |<-[encryption established]->| | |
* |<- linkEncryptionResult() <-| |-> linkEncryptionResult() ->|
* | | | | | |
* @endverbatim
*
*
* @note if bonding information is not available, pairing will be triggered
*
*
* Sequence diagram for Secure Connections passkey entry pairing with one device having a display only
* and other a keyboard
*
* \verbatim
* /----------- Device 1 (keyboard) ---\ *------ BLE link ------* /-------------- Device 2 (display) ---\
* /---- Device 1 (keyboard) ---\ *------ BLE link ------* /----- Device 2 (display) ---\
*
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |---------------------------> requestPairing() | | |
* | | |------[pairing start]------>| | |
* | | | |----------------> pairingRequest() ->|
* | | | acceptPairing() <------------------------ |
* | | |<---[secure con. pairing]-->| | |
* |<- passkeyRequest() <--------------| |----------------> passkeyDisplay() ->|
* | | | | | |
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |--------------------> requestPairing() | | |
* | | |------[pairing start]------>| | |
* | | | |-------> pairingRequest() ->|
* | | | acceptPairing() <--------------- |
* | | |<---[secure con. pairing]-->| | |
* |<- passkeyRequest() <-------| |-------> passkeyDisplay() ->|
* | | | | | |
*
* user reads the passkey on Device 2 and inputs it on Device 1
* user reads the passkey on Device 2 and inputs it on Device 1
*
* | | | | | |
* |-------------------------->passkeyEntered() | | |
* | | |<---[pairing complete]----->| | |
* |<- pairingResult() <---------------| |----------------> pairingResult() -->|
* | | | | | |
* | | | | | |
* |------------------->passkeyEntered() | | |
* | | |<---[pairing complete]----->| | |
* |<- pairingResult() <--------| |-------> pairingResult() -->|
* | | | | | |
* @endverbatim
*
*
*/
#if !defined(DOXYGEN_ONLY)
template <class Impl>
Expand Down