DevKey operations require authorization on the part of the applications
making the requests. Messages to state changing Servers should use keys
from the local Key Database to demonstrate authority.
---
doc/mesh-api.txt | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git a/doc/mesh-api.txt b/doc/mesh-api.txt
index 9b9f4e3de..be2a337ba 100644
--- a/doc/mesh-api.txt
+++ b/doc/mesh-api.txt
@@ -245,7 +245,7 @@ Methods:
org.bluez.mesh.Error.InvalidArguments
org.bluez.mesh.Error.NotFound
- void DevKeySend(object element_path, uint16 destination,
+ void DevKeySend(object element_path, uint16 destination, bool remote,
uint16 net_index, array{byte} data)
This method is used to send a message originated by a local
@@ -259,6 +259,11 @@ Methods:
destination must be a uint16 to a unicast address, or a well
known group address.
+ The remote parameter, if true, looks up the destination address
+ in the key database to encrypt the message. If false the local
+ device key is used. If remote is true, but requested key does
+ not exist, a NotFound error will be returned.
+
The net_index parameter is the subnet index of the network on
which the message is to be sent.
@@ -782,7 +787,7 @@ Methods:
The data parameter is the incoming message.
- void DevKeyMessageReceived(uint16 source, uint16 net_index,
+ void DevKeyMessageReceived(uint16 source, bool local, uint16 net_index,
array{byte} data)
This method is called by meshd daemon when a message arrives
@@ -792,6 +797,10 @@ Methods:
The source parameter is unicast address of the remote
node-element that sent the message.
+ The local parameter if true indicates that the local device key
+ was used to decrypt the message. False indicates that the remote
+ nodes device key was used.
+
The net_index parameter indicates what subnet the message was
received on, and if a response is required, the same subnet
must be used to send the response.
--
2.21.0
