[RFC] doc: Add EAP login support in Agent API

Henri Bragge henri.bragge at ixonos.com
Mon Jan 31 01:43:01 PST 2011


---
 doc/agent-api.txt |   36 ++++++++++++++++++++++++++++++++++--
 1 files changed, 34 insertions(+), 2 deletions(-)

diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index 98499a3..bc3b884 100644
--- a/doc/agent-api.txt
+++ b/doc/agent-api.txt
@@ -61,10 +61,15 @@ Fields		string Name
 			Normally returning the "Name" field is the better
 			option here.
 
+		string Identity
+
+			Identity (username) for EAP authentication methods.
+
 		string Passphrase
 
-			The passphrase for a network. For example a WEP
-			key or a PSK passphrase.
+			The passphrase for authentication. For example a WEP
+			key, a PSK passphrase or a password for EAP
+			authentication methods.
 
 		string WPS
 
@@ -97,6 +102,18 @@ Arguments	string Type
 			Contains the list of alternate field names this
 			field can be represented by.
 
+		string Phase2
+
+			EAP Phase2 authentication method. For example "gtc",
+			"mschapv2", or "md5". Used to supplement Passphrase
+			field when requesting credentials for 802.1X networks.
+
+		string Challenge
+
+			Contains a displayable challenge message from EAP
+			authentication request. Used to supplement Passphrase
+			field when requesting credentials for 802.1X networks.
+
 Examples	Requesting a passphrase for WPA2 network
 
 			RequestInput("/service1",
@@ -132,3 +149,18 @@ Examples	Requesting a passphrase for WPA2 network
 				}
 
 			==> { "WPS" : "123456" }
+
+		Requesting credentials for WPA-Enterprise network
+
+			RequestInput("/service4",
+				{ "Identity" : { "Type"        : "string",
+					         "Requirement" : "mandatory",
+					       },
+				  "Passphrase" : { "Type" : "string",
+				                   "Requirement" : "mandatory",
+						   "Phase2" : "gtc",
+						   "Challenge" : "Password: "
+				                 }
+				}
+
+			==> { "Identity" : "bob", "Passphrase": "secret456" }
-- 
1.7.0.4





More information about the connman mailing list