iwd/doc/agent-api.txt

Agent Manager hierarchy
=======================

Service		net.connman.iwd
Interface	net.connman.iwd.AgentManager
Object path	/net/connman/iwd

Methods		void RegisterAgent(object path)

			Register new agent for handling user secrets requests.
			The agent object's methods on the net.connman.iwd.Agent
			interface will be called when IWD needs to request
			credentials for a connection to a network in station
			mode.

			Possible Errors: [service].InvalidArguments
					 [service].Failed
					 [service].AlreadyExists

		void UnregisterAgent(object path)

			Unregister an existing agent.

			Possible Errors: [service].InvalidArguments
					 [service].Failed
					 [service].NotFound


Agent hierarchy
===============

Service		unique name
Interface	net.connman.iwd.Agent
Object path	freely definable

Methods		void Release() [noreply]

			This method gets called when the service daemon
			unregisters the agent. An agent can use it to do
			cleanup tasks. There is no need to unregister the
			agent, because when this method gets called it has
			already been unregistered.

		string RequestPassphrase(object network)

			This method gets called when trying to connect to
			a network and passphrase is required.

			Possible Errors: net.connman.iwd.Agent.Error.Canceled

		string RequestPrivateKeyPassphrase(object network)

			This method gets called when connecting to
			a network that requires authentication using a
			locally-stored encrypted private key file, to
			obtain that private key's encryption passphrase.

			Possible Errors: net.connman.iwd.Agent.Error.Canceled

		(string, string) RequestUserNameAndPassword(object network)

			This method gets called when connecting to
			a network that requires authentication using a
			user name and password.

			Possible Errors: net.connman.iwd.Agent.Error.Canceled

		string RequestUserPassword(object network, string user)

			This method gets called when connecting to
			a network that requires authentication with a
			user password.  The user name is optionally passed
			in the parameter.

			Possible Errors: net.connman.iwd.Agent.Error.Canceled

		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 "out-of-range", "user-canceled",
			"timed-out" or "shutdown".

Examples	Requesting a passphrase for WPA2 network

			RequestPassphrase("/net/connman/iwd/0/3/54657374_psk")
			==> "secret123"