summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHenri Bragge <henri.bragge@ixonos.com>2011-03-31 15:49:29 +0300
committerSamuel Ortiz <sameo@linux.intel.com>2011-04-01 18:25:11 +0200
commit6d780fece898f1b1c894cf26ba0b4160f8688ec8 (patch)
treee9b4bb8194d7d6acf57fd2f4af57bea64315b2cc /doc
parent3053441f5c3338d7c4dc635ab268dc954ea77624 (diff)
downloadconnman-6d780fece898f1b1c894cf26ba0b4160f8688ec8.tar.gz
connman-6d780fece898f1b1c894cf26ba0b4160f8688ec8.tar.bz2
connman-6d780fece898f1b1c894cf26ba0b4160f8688ec8.zip
doc: Add EAP login support in Agent API
Diffstat (limited to 'doc')
-rw-r--r--doc/agent-api.txt40
1 files changed, 36 insertions, 4 deletions
diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index 98499a39..c9a0b0f2 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 passphrase for EAP
+ authentication methods.
string WPS
@@ -77,8 +82,9 @@ Fields string Name
Arguments string Type
- Contains the type of a field. For example "psk",
- "wep", "ssid", "wpspin" or plain "string".
+ Contains the type of a field. For example "psk", "wep"
+ "passphrase", "response", "ssid", "wpspin" or plain
+ "string".
string Requirement
@@ -132,3 +138,29 @@ Examples Requesting a passphrase for WPA2 network
}
==> { "WPS" : "123456" }
+
+ Requesting passphrase for a WPA-Enterprise network:
+
+ RequestInput("/service4",
+ { "Identity" : { "Type" : "string",
+ "Requirement" : "mandatory"
+ },
+ "Passphrase" : { "Type" : "passphrase",
+ "Requirement" : "mandatory"
+ }
+ }
+
+ ==> { "Identity" : "alice", "Passphrase": "secret123" }
+
+ Requesting challenge response for a WPA-Enterprise network:
+
+ RequestInput("/service4",
+ { "Identity" : { "Type" : "string",
+ "Requirement" : "mandatory"
+ },
+ "Passphrase" : { "Type" : "response",
+ "Requirement" : "mandatory"
+ }
+ }
+
+ ==> { "Identity" : "bob", "Passphrase": "secret123" }