doc: PKEX support for DPP

PKEX is part of the WFA EasyConnect specification and is
an additional boostrapping method (like QR codes) for
exchanging public keys between a configurator and enrollee.

PKEX operates over wifi and requires a key/code be exchanged
prior to the protocol. The key is used to encrypt the exchange
of the boostrapping information, then DPP authentication is
started immediately aftewards.

This can be useful for devices which don't have the ability to
scan a QR code, or even as a more convenient way to share
wireless credentials if the PSK is very secure (i.e. not a
human readable string).

PKEX would be used via the three DBus APIs on a new interface
SharedCodeDeviceProvisioning.

ConfigureEnrollee(a{sv}) will start a configurator with a
static shared code (optionally identifier) passed in as the
argument to this method.

StartEnrollee(a{sv}) will start a PKEX enrollee using a static
shared code (optionally identifier) passed as the argument to
the method.

StartConfigurator(o) will start a PKEX configurator and use the
agent specified by the path argument. The configurator will query
the agent for a specific code when an enrollee sends the initial
exchange message.

After the PKEX protocol is finished, DPP bootstrapping keys have
been exchanged and DPP Authentication will start, followed by
configuration.
This commit is contained in:
James Prestwood 2023-11-07 09:06:26 -08:00 committed by Denis Kenzior
parent 8864329928
commit 20f13184f2
1 changed files with 142 additions and 0 deletions

View File

@ -71,3 +71,145 @@ Properties boolean Started [readonly]
Indicates the DPP URI. This property is only available
when Started is true.
Interface net.connman.iwd.SharedCodeDeviceProvisioning [Experimental]
Object path /net/connman/iwd/{phy0,phy1,...}/{1,2,...}
void ConfigureEnrollee(a{sv})
Starts a DPP configurator using a shared code (and
optionally identifier) set in the dictionary argument.
Valid dictionary keys are:
string Code
The shared code to use. The code used by both
parties (configurator and enrollee) must match.
string Identifier
An optional identifier. The identifier used by
both parties must match. Per the DPP spec the
identifier "shall be a UTF-8 string not greater
than eighty (80) octets"
As with the DeviceProvisioning interface, configurators
must be connected to the network they wish to configure
in order to start.
Once started a configurator (acting as a responder) will
listen on the currently connected channel for an
enrollee's initial exchange request which will kick off
the shared code bootstrapping protocol (PKEX). Once
completed DPP will start automatically. Only one
enrollee can be configured per call to
ConfigureEnrollee, i.e. once PKEX/DPP has finished
(including failure) the configurator will stop.
The SharedCode methods have an eventual timeout and will
stop automatically after 2 minutes.
Possible errors: net.connman.iwd.Busy
net.connman.iwd.NotConnected
net.connman.InvalidArguments
void StartEnrollee(a{sv})
Starts a DPP enrollee using a shared code (and
optionally identifier) set in the dictionary argument
(described above in ConfigureEnrollee).
As with the device provisioning interface, enrollees
must be disconnected in order to start.
Once started an enrollee (acting as an initiator) will
iterate channels sending out broadcast exchange requests
waiting for a response from a configurator. A response
will kick off the shared code bootstrapping protocol
(PKEX), followed by DPP if successful. Once the
protocols have completed, or failed, the enrollee will
stop. If failed, StartEnrollee will need to be called
again to retry.
Possible errors: net.connman.iwd.Busy
net.connman.iwd.InvalidArguments
void StartConfigurator(object agent_path)
Start a shared code configurator using an agent
(distingushed by 'agent_path') to obtain the shared
code. This method is meant for an automated use case
where a configurator is capable of configuring multiple
enrollees, and distinguishing between them by their
identifier.
If the agent service disappears during the shared code
exchange it will be stopped, and the protocol will fail.
This method behaves nearly the same as ConfigureEnrollee
except upon receiving an enrollees first exchange
request the registered agent will be asked for the
shared code using the RequestSharedCode method.
Though the agent can provide shared codes for multiple
enrollees, this method will only configure a single
enrollee at a time. Once completed it will need to be
called again to configure additional enrollees.
Possible errors: net.connman.iwd.Busy
net.connman.iwd.NotConnected
net.connman.iwd.NoAgent
Stop()
Stop a currently running configurator/enrollee. Note
that this will also interrupt DPP if the protocol has
advanced that far. Since DPP is initiated implicitly
from the shared code APIs it will also be canceled.
Calling Stop() if DPP was started via the
DeviceProvisioning interface will not stop it.
Properties boolean Started [readonly]
True if shared code device provisioning is currently
active. (configurator or enrollee is started)
string Role [readonly, optional]
Indicates the DPP role. Possible values are "enrollee"
or "configurator". This property is only available when
Started is true.
SharedCodeAgent hierarchy
=========================
Service unique name
Interface net.connman.iwd.SharedCodeAgent [Experimental]
Object path freely definable
Methods void Release() [noreply]
This method gets called when the service daemon
unregisters the agent.
string RequestSharedCode(string identifier)
This method gets called when a shared code is requested
for a particular enrollee, distingushed by the
identifier. The shared code agent should lookup the
identifier and return the shared code, or return an
error if not found.
Possible Errors: [service].Error.Canceled
[service].Error.NotFound
void Cancel(string reason) [noreply]
This method gets called to indicate that the agent
request failed before a reply was returned. The
argument will indicate why the request is being
cancelled and may be "user-canceled", "timed-out" or
"shutdown".
Examples Requesting a shared code for an enrollee identified by "foo"
RequestSharedCode("foo") ==> "super_secret_code"