From: Dagan Martinez <dmartinez@starry.com>
To: linux-bluetooth@vger.kernel.org
Cc: Dagan Martinez <dmartinez@starry.com>
Subject: [PATCH BlueZ v3 2/2] doc/gatt-api: Add 'X-notify`/`X-indicate`
Date: Thu, 30 Sep 2021 11:08:19 -0400 [thread overview]
Message-ID: <20210930150819.34270-3-dmartinez@starry.com> (raw)
In-Reply-To: <20210930150819.34270-1-dmartinez@starry.com>
Update docs to reflect the addition of the `X-notify` and `X-indicate`
permissions, which allow a GATT server to restrict CCC write permissions
via permissions set on its associated characteristic.
---
doc/gatt-api.txt | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/doc/gatt-api.txt b/doc/gatt-api.txt
index 120b23d1a..af0aa761d 100644
--- a/doc/gatt-api.txt
+++ b/doc/gatt-api.txt
@@ -253,7 +253,14 @@ 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-notify" and "x-indicate" flags restrict access
+ to notifications and indications by imposing write
+ restrictions on a characteristic's client
+ characteristic configuration descriptor.
+
+ Allowed values:
"broadcast"
"read"
@@ -267,10 +274,16 @@ Properties string UUID [read-only]
"writable-auxiliaries"
"encrypt-read"
"encrypt-write"
+ "encrypt-notify" (Server only)
+ "encrypt-indicate" (Server only)
"encrypt-authenticated-read"
"encrypt-authenticated-write"
+ "encrypt-authenticated-notify" (Server only)
+ "encrypt-authenticated-indicate" (Server only)
"secure-read" (Server only)
"secure-write" (Server only)
+ "secure-notify" (Server only)
+ "secure-indicate" (Server only)
"authorize"
uint16 Handle [read-write, optional] (Server Only)
--
2.31.1
prev parent reply other threads:[~2021-09-30 15:08 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-30 15:08 [PATCH BlueZ v3 0/2] Optionally require security for notify/indicate Dagan Martinez
2021-09-30 15:08 ` [PATCH BlueZ v3 1/2] gatt: Allow GATT server to dicate CCC permissions Dagan Martinez
2021-09-30 20:25 ` Luiz Augusto von Dentz
2021-09-30 15:08 ` Dagan Martinez [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210930150819.34270-3-dmartinez@starry.com \
--to=dmartinez@starry.com \
--cc=linux-bluetooth@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).