diff options
author | Inga Stotland <inga.stotland@intel.com> | 2021-09-22 20:25:59 -0700 |
---|---|---|
committer | Brian Gix <brian.gix@intel.com> | 2021-09-27 13:22:39 -0700 |
commit | 1dc110689577ddd14c44b1c869f695856381d03f (patch) | |
tree | e5a018245f5f248e97ab3c0ae34965d2367424ee /doc | |
parent | 4e16431a51152ea78b1af0674016e0040cf65952 (diff) | |
download | bluez-1dc110689577ddd14c44b1c869f695856381d03f.tar.gz |
doc/mesh-api: Add ExportKeys call
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.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/mesh-api.txt | 56 |
1 files changed, 56 insertions, 0 deletions
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 |