diff mbox series

[BlueZ,2/2] doc/gatt-api: Add 'X-asynchronous` permissions

Message ID 20210929161656.413300-3-dmartinez@starry.com (mailing list archive)
State Superseded
Headers show
Series Optionally require security for notify/indicate | expand

Checks

Context Check Description
tedd_an/checkpatch success Checkpatch PASS
tedd_an/gitlint success Gitlint PASS

Commit Message

Dagan Martinez Sept. 29, 2021, 4:16 p.m. UTC
Update docs to reflect the addition of `X-asynchronous` permissions,
which allow a GATT server to restrict CCC write permissions via
permissions set on its associated characteristic.
---
 doc/gatt-api.txt | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

Comments

Luiz Augusto von Dentz Sept. 29, 2021, 6:04 p.m. UTC | #1
Hi Dagan,

On Wed, Sep 29, 2021 at 10:42 AM Dagan Martinez <dmartinez@starry.com> wrote:
>
> Update docs to reflect the addition of `X-asynchronous` permissions,
> which allow a GATT server to restrict CCC write permissions via
> permissions set on its associated characteristic.
> ---
>  doc/gatt-api.txt | 11 ++++++++++-
>  1 file changed, 10 insertions(+), 1 deletion(-)
>
> diff --git a/doc/gatt-api.txt b/doc/gatt-api.txt
> index 04789c6d3..2550510ba 100644
> --- a/doc/gatt-api.txt
> +++ b/doc/gatt-api.txt
> @@ -253,7 +253,13 @@ Properties string UUID [read-only]
>                         Defines how the characteristic value can be used. See
>                         Core spec "Table 3.5: Characteristic Properties bit
>                         field", and "Table 3.8: Characteristic Extended
> -                       Properties bit field". Allowed values:
> +                       Properties bit field".
> +
> +                       The "x-asynchronous" flags allow a characteristic to impose write
> +                       restrictions on its client characteristic configuration descriptor,
> +                       if applicable, restricting access to notifications and indications.

Don't really like the asynchronous name, it doesn't really reflect
what we want to accomplish.

> +                       Allowed values:
>
>                                 "broadcast"
>                                 "read"
> @@ -267,10 +273,13 @@ Properties        string UUID [read-only]
>                                 "writable-auxiliaries"
>                                 "encrypt-read"
>                                 "encrypt-write"
> +                               "encrypt-asynchronous" (Server only)
>                                 "encrypt-authenticated-read"
>                                 "encrypt-authenticated-write"
> +                               "encrypt-authenticated-asynchronous" (Server only)

I think for CCC we may just inherit the read/write permissions, or
have it as encrypt-notify/encrypt-indicate, etc.

>                                 "secure-read" (Server only)
>                                 "secure-write" (Server only)
> +                               "secure-asynchronous" (Server only)
>                                 "authorize"
>
>                 uint16 Handle [read-write, optional] (Server Only)
> --
> 2.31.1
>
diff mbox series

Patch

diff --git a/doc/gatt-api.txt b/doc/gatt-api.txt
index 04789c6d3..2550510ba 100644
--- a/doc/gatt-api.txt
+++ b/doc/gatt-api.txt
@@ -253,7 +253,13 @@  Properties	string UUID [read-only]
 			Defines how the characteristic value can be used. See
 			Core spec "Table 3.5: Characteristic Properties bit
 			field", and "Table 3.8: Characteristic Extended
-			Properties bit field". Allowed values:
+			Properties bit field".
+
+			The "x-asynchronous" flags allow a characteristic to impose write
+			restrictions on its client characteristic configuration descriptor,
+			if applicable, restricting access to notifications and indications.
+
+			Allowed values:
 
 				"broadcast"
 				"read"
@@ -267,10 +273,13 @@  Properties	string UUID [read-only]
 				"writable-auxiliaries"
 				"encrypt-read"
 				"encrypt-write"
+				"encrypt-asynchronous" (Server only)
 				"encrypt-authenticated-read"
 				"encrypt-authenticated-write"
+				"encrypt-authenticated-asynchronous" (Server only)
 				"secure-read" (Server only)
 				"secure-write" (Server only)
+				"secure-asynchronous" (Server only)
 				"authorize"
 
 		uint16 Handle [read-write, optional] (Server Only)