WPS: Add wps_check_pin command for processing PIN from user input

[libeap.git] / wpa_supplicant / README-WPS

diff --git a/wpa_supplicant/README-WPS b/wpa_supplicant/README-WPS
index 30ed2aa..8a773e2 100644 (file)
--- a/wpa_supplicant/README-WPS
+++ b/wpa_supplicant/README-WPS
@@ -62,6 +62,7 @@ configuration that includes WPS support and Linux wireless extensions
 
 CONFIG_DRIVER_WEXT=y
 CONFIG_WPS=y
+CONFIG_WPS2=y
 
 
 WPS needs the Universally Unique IDentifier (UUID; see RFC 4122) for
@@ -93,6 +94,13 @@ pushbutton event (for PBC) to allow a new WPS Enrollee to join the
 network. wpa_supplicant uses the control interface as an input channel
 for these events.
 
+The PIN value used in the commands must be processed by an UI to
+remove non-digit characters and potentially, to verify the checksum
+digit. "wpa_cli wps_check_pin <PIN>" can be used to do such processing.
+It returns FAIL if the PIN is invalid, or FAIL-CHECKSUM if the checksum
+digit is incorrect, or the processed PIN (non-digit characters removed)
+if the PIN is valid.
+
 If the client device has a display, a random PIN has to be generated
 for each WPS registration session. wpa_supplicant can do this with a
 control interface request, e.g., by calling wpa_cli:
@@ -236,6 +244,15 @@ wps_er_stop
 wps_er_learn <UUID> <AP PIN>
 - learn AP configuration
 
+wps_er_config <UUID> <AP PIN> <new SSID> <auth> <encr> <new key>
+- examples:
+  wps_er_config 87654321-9abc-def0-1234-56789abc0002 12345670 testing WPA2PSK CCMP 12345678
+  wpa_er_config 87654321-9abc-def0-1234-56789abc0002 12345670 clear OPEN NONE ""
+
+<auth> must be one of the following: OPEN WPAPSK WPA2PSK
+<encr> must be one of the following: NONE WEP TKIP CCMP
+
+
 wps_er_pbc <Enrollee UUID>
 - accept an Enrollee PBC using External Registrar