[PATCH 2/3] doc: Document passphrase storage options

Matthias Kurz <[email protected]> Fri, 24 Apr 2026 10:31:58 +0200
Newsgroups dev.linux.lists.iwd
Message-ID <[email protected]>
Document RequestPassphraseWithOptions and the Store option for agents
that want to control whether a PSK passphrase is saved in the network
profile.
---
 doc/agent-api.txt | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index e9bb95ca..77e9bc6d 100644
--- a/doc/agent-api.txt
+++ b/doc/agent-api.txt
@@ -90,6 +90,18 @@ Methods		void Release() [noreply]
 
 			Possible Errors: net.connman.iwd.Agent.Error.Canceled
 
+		(string, dict) RequestPassphraseWithOptions(object network)
+
+			This method gets called when trying to connect to
+			a network and passphrase is required.  Agents
+			implementing this method can return options for the
+			passphrase.  If the Store boolean option is present
+			and false, IWD will use the passphrase for this
+			connection attempt but will not save it to the
+			network profile.
+
+			Possible Errors: net.connman.iwd.Agent.Error.Canceled
+
 		string RequestPrivateKeyPassphrase(object network)
 
 			This method gets called when connecting to
-- 
2.54.0