Hi Henri,

>  doc/agent-api.txt |   27 +++++++++++++++++++++++----
>  1 files changed, 23 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/agent-api.txt b/doc/agent-api.txt
> index 98499a3..fbae242 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
>  
> @@ -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"
> +                     "eap-password", "eap-response", "ssid", "wpspin" or
> +                     plain "string".

I like to see consistency here. So using eap-passphrase would be a bit
more consistent. However this also questions now if we not better just
call this simple passphrase. Or does an EAP passphrase is special in
some sort of sense?

And with that in mind, using wps-pin instead of wpspin would be good as
well.
 
>               string Requirement
>  
> @@ -132,3 +138,16 @@ Examples Requesting a passphrase for WPA2 network
>                               }
>  
>                       ==> { "WPS" : "123456" }
> +
> +             Requesting challenge response for a WPA-Enterprise network:
> +
> +                     RequestInput("/service4",
> +                             { "Identity"   : { "Type"        : "string",
> +                                                "Requirement" : "mandatory"
> +                                              },
> +                               "Passphrase" : { "Type" : "eap-response",
> +                                                "Requirement" : "mandatory"
> +                                              }
> +                             }
> +
> +                     ==> { "Identity" : "bob", "Passphrase": "secret456" }

Coming to thing about this now, it might make sense to have some more
generic types for username and password. Or just use string and secret
to allow the UI to tell that one is always visible and the other one
should be hidden.

Same here goes for the WPS PIN type. We might need some generic pin
type. And in addition we also need to document that the returning type
in the result dictionary is type string etc.

In summary, I prefer to only use specific types if they have specific
constraints. Like psk for example has an explicit length constraints.

Regards

Marcel


_______________________________________________
connman mailing list
connman@connman.net
http://lists.connman.net/listinfo/connman

Reply via email to