security manager doc #418

paul-szczepanek-arm · 2018-02-23T11:49:17Z

same problem as the GAP pull request - the example pages don't exist

Copy edit for active voice, consistent spelling across documents and consistent tense.

AnotherButler

Nice work on this. I've left some comments and queries for you to address.

AnotherButler · 2018-02-28T21:22:00Z

docs/reference/api/connectivity/bluetooth/SecurityManager.md

@@ -0,0 +1,21 @@
+## SecurityManager
+
+SecurityManager deals with authentication and encryption for the link. The process of pairing and optionally bonding provides this. Bonding is achieved by saving the pairing information to be reused on subsequent reconnections.


Query: What link? Could you please provide more context here?
Query: Who or what achieves bonding by saving the pairing information to be reused? Reused by whom or by what?

thanks, information added

AnotherButler · 2018-02-28T21:22:43Z

docs/reference/api/connectivity/bluetooth/SecurityManager.md

+
+SecurityManager deals with authentication and encryption for the link. The process of pairing and optionally bonding provides this. Bonding is achieved by saving the pairing information to be reused on subsequent reconnections.
+
+The process of pairing may produce a set of keys to be used during current or later connections. These are handled by the Security Manager and include the Long Term Encryption Key (LTK), the Identity Resolving Key (IRK) and the Connection Signature Resolving Key (CSRK). The LTK is used to encrypt subsequent connections. IRK is used to identify peers who use random resolvable addresses. CSRK is used to sign and authenticate signed data.


Query: Who or what uses the LTK to encrypt subsequent connections?
Query: Who or what uses IRK to identify peers?
Query: Who or what uses CSRK to sign and authenticate signed data?

thanks, information added

AnotherButler · 2018-02-28T21:24:08Z

docs/reference/api/connectivity/bluetooth/SecurityManager.md

+
+The process of pairing may produce a set of keys to be used during current or later connections. These are handled by the Security Manager and include the Long Term Encryption Key (LTK), the Identity Resolving Key (IRK) and the Connection Signature Resolving Key (CSRK). The LTK is used to encrypt subsequent connections. IRK is used to identify peers who use random resolvable addresses. CSRK is used to sign and authenticate signed data.
+
+The pairing process may provide man-in-the-middle protection (MITM). This is achieved through various means, including out of band communication, depending on the capabilities of the local and peer device.


Query: Could we replace the second sentence with "You can achieve MITM protection through band communication, depending on the capabilities of the local and peer device." for active voice?

changed into active voice, thanks

…into 5.7

…Handbook into 5.7" This reverts commit a6ccb10, reversing changes made to 7709e58.

…nek-arm/Handbook into 5.7"" This reverts commit df15dfb.

paul-szczepanek-arm · 2018-03-01T10:33:45Z

docs/reference/api/connectivity/bluetooth/SecurityManager.md


-The Security Manager will store the keys, if possible permanently, to speed up security requests on subsequent connections.
+The SecurityManager stores the keys, permanently if possible, to speed security requests on subsequent connections.


what's wrong with "speed up"?

paul-szczepanek-arm · 2018-03-01T10:39:05Z

ignore the reverts - I got seriously confused, erm, I mean I seriously confused myself ;)

Copy edit for active voice.

AnotherButler · 2018-03-06T00:02:51Z

docs/reference/api/connectivity/bluetooth/SecurityManager.md

+
+The SecurityManager example demonstrates both a central and a peripheral connecting and performing basic pairing and setting up link security.
+
+[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-SM/)](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-SM)


We've added you to Teams. Please create your example there, and let me know if you have any permissions issues.

@AnotherButler good to merge?

AnotherButler · 2018-03-10T00:29:55Z

With 5.8 coming up, I'm re-creating this against the test site instead of the 5.7 live site. Because of this, I'm closing this PR in favor of PR #450

security manager doc

fe5291d

paul-szczepanek-arm mentioned this pull request Feb 23, 2018

BLE: Security Manager ARMmbed/mbed-os#6188

Merged

4 tasks

pan- approved these changes Feb 23, 2018

View reviewed changes

Copy edit SecurityManager.md

5c26cd4

Copy edit for active voice, consistent spelling across documents and consistent tense.

AnotherButler reviewed Feb 28, 2018

View reviewed changes

paul-szczepanek-arm added 5 commits March 1, 2018 09:21

Merge branch '5.7' of https://github.com/ARMmbed/Handbook into 5.7

7709e58

Merge branch '5.7' of https://github.com/paul-szczepanek-arm/Handbook …

a6ccb10

…into 5.7

Revert "Merge branch '5.7' of https://github.com/paul-szczepanek-arm/…

df15dfb

…Handbook into 5.7" This reverts commit a6ccb10, reversing changes made to 7709e58.

Revert "Revert "Merge branch '5.7' of https://github.com/paul-szczepa…

a635c24

…nek-arm/Handbook into 5.7"" This reverts commit df15dfb.

review comments addressed

35b5fc9

paul-szczepanek-arm commented Mar 1, 2018

View reviewed changes

Copy edit SecurityManager.md

6e45a3e

Copy edit for active voice.

AnotherButler reviewed Mar 6, 2018

View reviewed changes

AnotherButler changed the base branch from 5.7 to new_engine March 10, 2018 00:26

AnotherButler changed the base branch from new_engine to 5.7 March 10, 2018 00:27

AnotherButler mentioned this pull request Mar 10, 2018

Create SecurityManager.md #450

Merged

AnotherButler closed this Mar 10, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

security manager doc #418

security manager doc #418

Uh oh!

paul-szczepanek-arm commented Feb 23, 2018

Uh oh!

AnotherButler left a comment

Uh oh!

AnotherButler Feb 28, 2018

Uh oh!

paul-szczepanek-arm Mar 1, 2018

Uh oh!

AnotherButler Feb 28, 2018

Uh oh!

paul-szczepanek-arm Mar 1, 2018

Uh oh!

AnotherButler Feb 28, 2018

Uh oh!

paul-szczepanek-arm Mar 1, 2018

Uh oh!

paul-szczepanek-arm Mar 1, 2018

Uh oh!

paul-szczepanek-arm commented Mar 1, 2018

Uh oh!

AnotherButler Mar 6, 2018

Uh oh!

paul-szczepanek-arm Mar 8, 2018

Uh oh!

paul-szczepanek-arm Mar 9, 2018

Uh oh!

AnotherButler commented Mar 10, 2018

Uh oh!

Uh oh!

		@@ -0,0 +1,21 @@
		## SecurityManager

		SecurityManager deals with authentication and encryption for the link. The process of pairing and optionally bonding provides this. Bonding is achieved by saving the pairing information to be reused on subsequent reconnections.


		SecurityManager deals with authentication and encryption for the link. The process of pairing and optionally bonding provides this. Bonding is achieved by saving the pairing information to be reused on subsequent reconnections.

		The process of pairing may produce a set of keys to be used during current or later connections. These are handled by the Security Manager and include the Long Term Encryption Key (LTK), the Identity Resolving Key (IRK) and the Connection Signature Resolving Key (CSRK). The LTK is used to encrypt subsequent connections. IRK is used to identify peers who use random resolvable addresses. CSRK is used to sign and authenticate signed data.


		The process of pairing may produce a set of keys to be used during current or later connections. These are handled by the Security Manager and include the Long Term Encryption Key (LTK), the Identity Resolving Key (IRK) and the Connection Signature Resolving Key (CSRK). The LTK is used to encrypt subsequent connections. IRK is used to identify peers who use random resolvable addresses. CSRK is used to sign and authenticate signed data.

		The pairing process may provide man-in-the-middle protection (MITM). This is achieved through various means, including out of band communication, depending on the capabilities of the local and peer device.


		The Security Manager will store the keys, if possible permanently, to speed up security requests on subsequent connections.
		The SecurityManager stores the keys, permanently if possible, to speed security requests on subsequent connections.


		The SecurityManager example demonstrates both a central and a peripheral connecting and performing basic pairing and setting up link security.

		[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-SM/)](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-SM)

security manager doc #418

security manager doc #418

Uh oh!

Conversation

paul-szczepanek-arm commented Feb 23, 2018

Uh oh!

AnotherButler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

paul-szczepanek-arm commented Mar 1, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AnotherButler commented Mar 10, 2018

Uh oh!

Uh oh!