-
Notifications
You must be signed in to change notification settings - Fork 178
security manager doc #418
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.
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
Closed
Closed
security manager doc #418
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
fe5291d
security manager doc
paul-szczepanek-arm 5c26cd4
Copy edit SecurityManager.md
7709e58
Merge branch '5.7' of https://github.com/ARMmbed/Handbook into 5.7
paul-szczepanek-arm a6ccb10
Merge branch '5.7' of https://github.com/paul-szczepanek-arm/Handbook…
paul-szczepanek-arm df15dfb
Revert "Merge branch '5.7' of https://github.com/paul-szczepanek-arm/…
paul-szczepanek-arm a635c24
Revert "Revert "Merge branch '5.7' of https://github.com/paul-szczepa…
paul-szczepanek-arm 35b5fc9
review comments addressed
paul-szczepanek-arm 6e45a3e
Copy edit SecurityManager.md
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
21 changes: 21 additions & 0 deletions
21
docs/reference/api/connectivity/bluetooth/SecurityManager.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
## SecurityManager | ||
|
||
SecurityManager deals with authentication and encryption for the Bluetooth Low Energy link. The process of pairing and optionally bonding provides this. The SecurityManager achieves bonding by saving the pairing information and reusing it on subsequent reconnections in order to save time by not having to perform pairing again. | ||
|
||
The process of pairing may produce a set of keys to be used during current or later connections. The SecurityManager and include the Long Term Encryption Key (LTK), the Identity Resolving Key (IRK) and the Connection Signature Resolving Key (CSRK) handle these. The SecurityManager uses the LTK to encrypt subsequent connections without having to pair again. The Link Controller uses IRK to identify peers who use random resolvable addresses. The application uses CSRK to sign and authenticate signed data. | ||
|
||
The pairing process may provide man-in-the-middle protection (MITM). The SecurityManager achieves this through various means, including out of band communication, depending on the capabilities of the local and peer device. | ||
|
||
The SecurityManager stores the keys, permanently if possible, to speed security requests on subsequent connections. | ||
|
||
Security requests may come explicitly from the user application or implicitly from the GATT server based on attribute requirements. | ||
|
||
### SecurityManager class reference | ||
|
||
[](http://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_security_manager.html) | ||
|
||
### SecurityManager example | ||
|
||
The SecurityManager example demonstrates both a central and a peripheral connecting and performing basic pairing and setting up link security. | ||
|
||
[](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-SM) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We've added you to Teams. Please create your example there, and let me know if you have any permissions issues.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added page
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AnotherButler good to merge?