From: Howard Chung <howardchung@google.com>
To: linux-bluetooth@vger.kernel.org, luiz.dentz@gmail.com
Cc: Yun-Hao Chung <howardchung@chromium.org>,
Miao-chen Chou <mcchou@chromium.org>
Subject: [Bluez PATCH v8 12/13] doc: add description of admin policy
Date: Tue, 3 Aug 2021 16:22:36 +0800 [thread overview]
Message-ID: <20210803161319.Bluez.v8.12.I433ab6a7ac1d4f8f8dea496ac14bdbf3597015d3@changeid> (raw)
In-Reply-To: <20210803082237.723766-1-howardchung@google.com>
From: Yun-Hao Chung <howardchung@chromium.org>
This adds admin-policy-api.txt.
Reviewed-by: Miao-chen Chou <mcchou@chromium.org>
---
(no changes since v1)
doc/admin-policy-api.txt | 65 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 65 insertions(+)
create mode 100644 doc/admin-policy-api.txt
diff --git a/doc/admin-policy-api.txt b/doc/admin-policy-api.txt
new file mode 100644
index 000000000000..3f116901dbd7
--- /dev/null
+++ b/doc/admin-policy-api.txt
@@ -0,0 +1,65 @@
+BlueZ D-Bus Admin Policy API description
+***********************************
+
+This API provides methods to control the behavior of bluez as an administrator.
+
+Interface AdminPolicySet1 provides methods to set policies. Once the policy is
+set successfully, it will affect all clients and stay persistently even after
+restarting Bluetooth Daemon. The only way to clear it is to overwrite the
+policy with the same method.
+
+Interface AdminPolicyStatus1 provides readonly properties to indicate the
+current values of admin policy.
+
+
+Admin Policy Set hierarchy
+=================
+
+Service org.bluez
+Interface org.bluez.AdminPolicySet1
+Object path [variable prefix]/{hci0,hci1,...}
+
+Methods void SetServiceAllowList(array{string} UUIDs)
+
+ This method sets the service allowlist by specifying
+ service UUIDs.
+
+ When SetServiceAllowList is called, bluez will block
+ incoming and outgoing connections to the service not in
+ UUIDs for all of the clients.
+
+ Any subsequent calls to this method will supersede any
+ previously set allowlist values. Calling this method
+ with an empty array will allow any service UUIDs to be
+ used.
+
+ The default value is an empty array.
+
+ Possible errors: org.bluez.Error.InvalidArguments
+ org.bluez.Error.Failed
+
+
+Admin Policy Status hierarchy
+=================
+
+Service org.bluez
+Interface org.bluez.AdminPolicyStatus1
+Object path [variable prefix]/{hci0,hci1,...}
+
+Properties array{string} ServiceAllowList [readonly]
+
+ Current value of service allow list.
+
+
+
+Admin Policy Status hierarchy
+=================
+
+Service org.bluez
+Interface org.bluez.AdminPolicyStatus1
+Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
+
+Properties bool IsAffectedByPolicy [readonly]
+
+ Indicate if there is any auto-connect profile in this
+ device is not allowed by admin policy.
--
2.32.0.554.ge1b32706d8-goog
next prev parent reply other threads:[~2021-08-03 8:23 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-03 8:22 [Bluez PATCH v8 00/13] Admin policy series Howard Chung
2021-08-03 8:22 ` [Bluez PATCH v8 01/13] core: add is_allowed property in btd_service Howard Chung
2021-08-03 8:42 ` Admin policy series bluez.test.bot
2021-08-03 8:22 ` [Bluez PATCH v8 02/13] core: add device callbacks to adapter driver Howard Chung
2021-08-03 8:22 ` [Bluez PATCH v8 03/13] core: add adapter and device allowed_uuid functions Howard Chung
2021-08-03 8:22 ` [Bluez PATCH v8 04/13] core: block not allowed UUID connect in auth Howard Chung
2021-08-03 8:22 ` [Bluez PATCH v8 05/13] plugins: new plugin Howard Chung
2021-08-03 8:22 ` [Bluez PATCH v8 06/13] plugins/admin: add admin_policy adapter driver Howard Chung
2021-08-03 8:22 ` [Bluez PATCH v8 07/13] plugins/admin: add ServiceAllowList method Howard Chung
2021-08-03 8:22 ` [Bluez PATCH v8 08/13] plugins/admin: add ServiceAllowList property Howard Chung
2021-08-03 8:22 ` [Bluez PATCH v8 09/13] plugins/admin: add device callbacks Howard Chung
2021-08-03 8:22 ` [Bluez PATCH v8 10/13] plugins/admin: add AffectedByPolicy property Howard Chung
2021-08-03 8:22 ` [Bluez PATCH v8 11/13] plugins/admin: persist policy settings Howard Chung
2021-08-03 8:22 ` Howard Chung [this message]
2021-08-03 8:22 ` [Bluez PATCH v8 13/13] doc: add admin policy file storage description Howard Chung
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=20210803161319.Bluez.v8.12.I433ab6a7ac1d4f8f8dea496ac14bdbf3597015d3@changeid \
--to=howardchung@google.com \
--cc=howardchung@chromium.org \
--cc=linux-bluetooth@vger.kernel.org \
--cc=luiz.dentz@gmail.com \
--cc=mcchou@chromium.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).