[PATCH BlueZ 16/20] doc/mesh-api: Add ExportKeys call
From: Inga Stotland <hidden>
Date: 2021-09-23 03:27:26
Subsystem:
the rest · Maintainer:
Linus Torvalds
Add description for a new method: ExportKeys() on org.bluez.mesh.Management1 interface. This method is used by the authorized application to export information about network keys, application keys and device keys present in the local key database. --- doc/mesh-api.txt | 56 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+)
diff --git a/doc/mesh-api.txt b/doc/mesh-api.txt
index ce651c801..85de6705e 100644
--- a/doc/mesh-api.txt
+++ b/doc/mesh-api.txt@@ -728,6 +728,62 @@ Methods: PossibleErrors: org.bluez.mesh.Error.InvalidArguments + dict ExportKeys(void) + + This method is used by the application to export information + about network keys, application keys and device keys present + in the local key database. + + dict + A dictionary that contains information for the keys + stored in the keyring with the following keys defined: + + NetKeys: + array{struct} net_keys: + + uint16 index + Subnet index + + array{byte}[16] key + + dict: + A dictionary that contains optional + key info with the following keys + defined: + + uint8 Phase + Key Refresh phase of the subnet + + array{byte}[16] OldKey + + array{struct} AppKeys: + + uint16 index + + Application key index + + array{byte}[16] key + + dict: + A dictionary of optional + key info with the + following keys defined: + + array{byte}[16] OldKey + + DevKeys: + array{struct} dev_keys: + + Device Key information for known remote + nodes in the configured Mesh network + + uint16 unicast + + Unicast address of the node's primary + element + + array{byte}[16] key + Mesh Application Hierarchy ========================== Service unique name
--
2.31.1