wpa_supplicant/README-WPS

   1 wpa_supplicant and Wi-Fi Protected Setup (WPS)
   2 ==============================================
   3
   4 This document describes how the WPS implementation in wpa_supplicant
   5 can be configured and how an external component on the client (e.g.,
   6 management GUI) is used to enable WPS enrollment and registrar
   7 registration.
   8
   9
  10 Introduction to WPS
  11 -------------------
  12
  13 Wi-Fi Protected Setup (WPS) is a mechanism for easy configuration of a
  14 wireless network. It allows automated generation of random keys (WPA
  15 passphrase/PSK) and configuration of an access point and client
  16 devices. WPS includes number of methods for setting up connections
  17 with PIN method and push-button configuration (PBC) being the most
  18 commonly deployed options.
  19
  20 While WPS can enable more home networks to use encryption in the
  21 wireless network, it should be noted that the use of the PIN and
  22 especially PBC mechanisms for authenticating the initial key setup is
  23 not very secure. As such, use of WPS may not be suitable for
  24 environments that require secure network access without chance for
  25 allowing outsiders to gain access during the setup phase.
  26
  27 WPS uses following terms to describe the entities participating in the
  28 network setup:
  29 - access point: the WLAN access point
  30 - Registrar: a device that control a network and can authorize
  31   addition of new devices); this may be either in the AP ("internal
  32   Registrar") or in an external device, e.g., a laptop, ("external
  33   Registrar")
  34 - Enrollee: a device that is being authorized to use the network
  35
  36 It should also be noted that the AP and a client device may change
  37 roles (i.e., AP acts as an Enrollee and client device as a Registrar)
  38 when WPS is used to configure the access point.
  39
  40
  41 More information about WPS is available from Wi-Fi Alliance:
  42 http://www.wi-fi.org/wifi-protected-setup
  43
  44
  45 wpa_supplicant implementation
  46 -----------------------------
  47
  48 wpa_supplicant includes an optional WPS component that can be used as
  49 an Enrollee to enroll new network credential or as a Registrar to
  50 configure an AP.
  51
  52
  53 wpa_supplicant configuration
  54 ----------------------------
  55
  56 WPS is an optional component that needs to be enabled in
  57 wpa_supplicant build configuration (.config). Here is an example
  58 configuration that includes WPS support and Linux nl80211 -based
  59 driver interface:
  60
  61 CONFIG_DRIVER_NL80211=y
  62 CONFIG_WPS=y
  63 CONFIG_WPS2=y
  64
  65 If you want to enable WPS external registrar (ER) functionality, you
  66 will also need to add following line:
  67
  68 CONFIG_WPS_ER=y
  69
  70 Following parameter can be used to enable support for NFC config method:
  71
  72 CONFIG_WPS_NFC=y
  73
  74
  75 WPS needs the Universally Unique IDentifier (UUID; see RFC 4122) for
  76 the device. This is configured in the runtime configuration for
  77 wpa_supplicant (if not set, UUID will be generated based on local MAC
  78 address):
  79
  80 # example UUID for WPS
  81 uuid=12345678-9abc-def0-1234-56789abcdef0
  82
  83 The network configuration blocks needed for WPS are added
  84 automatically based on control interface commands, so they do not need
  85 to be added explicitly in the configuration file.
  86
  87 WPS registration will generate new network blocks for the acquired
  88 credentials. If these are to be stored for future use (after
  89 restarting wpa_supplicant), wpa_supplicant will need to be configured
  90 to allow configuration file updates:
  91
  92 update_config=1
  93
  94
  95
  96 External operations
  97 -------------------
  98
  99 WPS requires either a device PIN code (usually, 8-digit number) or a
 100 pushbutton event (for PBC) to allow a new WPS Enrollee to join the
 101 network. wpa_supplicant uses the control interface as an input channel
 102 for these events.
 103
 104 The PIN value used in the commands must be processed by an UI to
 105 remove non-digit characters and potentially, to verify the checksum
 106 digit. "wpa_cli wps_check_pin <PIN>" can be used to do such processing.
 107 It returns FAIL if the PIN is invalid, or FAIL-CHECKSUM if the checksum
 108 digit is incorrect, or the processed PIN (non-digit characters removed)
 109 if the PIN is valid.
 110
 111 If the client device has a display, a random PIN has to be generated
 112 for each WPS registration session. wpa_supplicant can do this with a
 113 control interface request, e.g., by calling wpa_cli:
 114
 115 wpa_cli wps_pin any
 116
 117 This will return the generated 8-digit PIN which will then need to be
 118 entered at the Registrar to complete WPS registration. At that point,
 119 the client will be enrolled with credentials needed to connect to the
 120 AP to access the network.
 121
 122
 123 If the client device does not have a display that could show the
 124 random PIN, a hardcoded PIN that is printed on a label can be
 125 used. wpa_supplicant is notified this with a control interface
 126 request, e.g., by calling wpa_cli:
 127
 128 wpa_cli wps_pin any 12345670
 129
 130 This starts the WPS negotiation in the same way as above with the
 131 generated PIN.
 132
 133
 134 If a random PIN is needed for a user interface, "wpa_cli wps_pin get"
 135 can be used to generate a new PIN without starting WPS negotiation.
 136 This random PIN can then be passed as an argument to another wps_pin
 137 call when the actual operation should be started.
 138
 139 If the client design wants to support optional WPS PBC mode, this can
 140 be enabled by either a physical button in the client device or a
 141 virtual button in the user interface. The PBC operation requires that
 142 a button is also pressed at the AP/Registrar at about the same time (2
 143 minute window). wpa_supplicant is notified of the local button event
 144 over the control interface, e.g., by calling wpa_cli:
 145
 146 wpa_cli wps_pbc
 147
 148 At this point, the AP/Registrar has two minutes to complete WPS
 149 negotiation which will generate a new WPA PSK in the same way as the
 150 PIN method described above.
 151
 152
 153 If the client wants to operate in the Registrar role to learn the
 154 current AP configuration and optionally, to configure an AP,
 155 wpa_supplicant is notified over the control interface, e.g., with
 156 wpa_cli:
 157
 158 wpa_cli wps_reg <AP BSSID> <AP PIN>
 159 (example: wpa_cli wps_reg 02:34:56:78:9a:bc 12345670)
 160
 161 This is used to fetch the current AP settings instead of actually
 162 changing them. The main difference with the wps_pin command is that
 163 wps_reg uses the AP PIN (e.g., from a label on the AP) instead of a
 164 PIN generated at the client.
 165
 166 In order to change the AP configuration, the new configuration
 167 parameters are given to the wps_reg command:
 168
 169 wpa_cli wps_reg <AP BSSID> <AP PIN> <new SSID> <auth> <encr> <new key>
 170 examples:
 171   wpa_cli wps_reg 02:34:56:78:9a:bc 12345670 testing WPA2PSK CCMP 12345678
 172   wpa_cli wps_reg 02:34:56:78:9a:bc 12345670 clear OPEN NONE ""
 173
 174 <auth> must be one of the following: OPEN WPAPSK WPA2PSK
 175 <encr> must be one of the following: NONE WEP TKIP CCMP
 176
 177
 178 Scanning
 179 --------
 180
 181 Scan results ('wpa_cli scan_results' or 'wpa_cli bss <idx>') include a
 182 flags field that is used to indicate whether the BSS support WPS. If
 183 the AP support WPS, but has not recently activated a Registrar, [WPS]
 184 flag will be included. If PIN method has been recently selected,
 185 [WPS-PIN] is shown instead. Similarly, [WPS-PBC] is shown if PBC mode
 186 is in progress. GUI programs can use these as triggers for suggesting
 187 a guided WPS configuration to the user. In addition, control interface
 188 monitor events WPS-AP-AVAILABLE{,-PBC,-PIN} can be used to find out if
 189 there are WPS enabled APs in scan results without having to go through
 190 all the details in the GUI. These notification could be used, e.g., to
 191 suggest possible WPS connection to the user.
 192
 193
 194 wpa_gui
 195 -------
 196
 197 wpa_gui-qt4 directory contains a sample GUI that shows an example of
 198 how WPS support can be integrated into the GUI. Its main window has a
 199 WPS tab that guides user through WPS registration with automatic AP
 200 selection. In addition, it shows how WPS can be started manually by
 201 selecting an AP from scan results.
 202
 203
 204 Credential processing
 205 ---------------------
 206
 207 By default, wpa_supplicant processes received credentials and updates
 208 its configuration internally. However, it is possible to
 209 control these operations from external programs, if desired.
 210
 211 This internal processing can be disabled with wps_cred_processing=1
 212 option. When this is used, an external program is responsible for
 213 processing the credential attributes and updating wpa_supplicant
 214 configuration based on them.
 215
 216 Following control interface messages are sent out for external programs:
 217
 218 WPS-CRED-RECEIVED  <hexdump of Credential attribute(s)>
 219 For example:
 220 <2>WPS-CRED-RECEIVED 100e006f10260001011045000c6a6b6d2d7770732d74657374100300020020100f000200081027004030653462303435366332363666653064333961643135353461316634626637313234333761636664623766333939653534663166316230323061643434386235102000060266a0ee1727
 221
 222
 223 wpa_supplicant as WPS External Registrar (ER)
 224 ---------------------------------------------
 225
 226 wpa_supplicant can be used as a WPS ER to configure an AP or enroll
 227 new Enrollee to join the network. This functionality uses UPnP and
 228 requires that a working IP connectivity is available with the AP (this
 229 can be either over a wired or wireless connection).
 230
 231 Separate wpa_supplicant process can be started for WPS ER
 232 operations. A special "none" driver can be used in such a case to
 233 indicate that no local network interface is actually controlled. For
 234 example, following command could be used to start the ER:
 235
 236 wpa_supplicant -Dnone -c er.conf -ieth0
 237
 238 Sample er.conf:
 239
 240 ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=admin
 241 device_name=WPS External Registrar
 242
 243
 244 wpa_cli commands for ER functionality:
 245
 246 wps_er_start [IP address]
 247 - start WPS ER functionality
 248 - the optional IP address parameter can be used to filter operations only
 249   to include a single AP
 250 - if run again while ER is active, the stored information (discovered APs
 251   and Enrollees) are shown again
 252
 253 wps_er_stop
 254 - stop WPS ER functionality
 255
 256 wps_er_learn <UUID> <AP PIN>
 257 - learn AP configuration
 258
 259 wps_er_set_config <UUID> <network id>
 260 - use AP configuration from a locally configured network (e.g., from
 261   wps_reg command); this does not change the AP's configuration, but
 262   only prepares a configuration to be used when enrolling a new device
 263   to the AP
 264
 265 wps_er_config <UUID> <AP PIN> <new SSID> <auth> <encr> <new key>
 266 - examples:
 267   wps_er_config 87654321-9abc-def0-1234-56789abc0002 12345670 testing WPA2PSK CCMP 12345678
 268   wpa_er_config 87654321-9abc-def0-1234-56789abc0002 12345670 clear OPEN NONE ""
 269
 270 <auth> must be one of the following: OPEN WPAPSK WPA2PSK
 271 <encr> must be one of the following: NONE WEP TKIP CCMP
 272
 273
 274 wps_er_pbc <Enrollee UUID>
 275 - accept an Enrollee PBC using External Registrar
 276
 277 wps_er_pin <Enrollee UUID> <PIN> [Enrollee MAC address]
 278 - add an Enrollee PIN to External Registrar
 279 - if Enrollee UUID is not known, "any" can be used to add a wildcard PIN
 280 - if the MAC address of the enrollee is known, it should be configured
 281   to allow the AP to advertise list of authorized enrollees
 282
 283
 284 WPS ER events:
 285
 286 WPS_EVENT_ER_AP_ADD
 287 - WPS ER discovered an AP
 288
 289 WPS-ER-AP-ADD 87654321-9abc-def0-1234-56789abc0002 02:11:22:33:44:55 pri_dev_type=6-0050F204-1 wps_state=1 |Very friendly name|Company|Long description of the model|WAP|http://w1.fi/|http://w1.fi/hostapd/
 290
 291 WPS_EVENT_ER_AP_REMOVE
 292 - WPS ER removed an AP entry
 293
 294 WPS-ER-AP-REMOVE 87654321-9abc-def0-1234-56789abc0002
 295
 296 WPS_EVENT_ER_ENROLLEE_ADD
 297 - WPS ER discovered a new Enrollee
 298
 299 WPS-ER-ENROLLEE-ADD 2b7093f1-d6fb-5108-adbb-bea66bb87333 02:66:a0:ee:17:27 M1=1 config_methods=0x14d dev_passwd_id=0 pri_dev_type=1-0050F204-1 |Wireless Client|Company|cmodel|123|12345|
 300
 301 WPS_EVENT_ER_ENROLLEE_REMOVE
 302 - WPS ER removed an Enrollee entry
 303
 304 WPS-ER-ENROLLEE-REMOVE 2b7093f1-d6fb-5108-adbb-bea66bb87333 02:66:a0:ee:17:27
 305
 306 WPS-ER-AP-SETTINGS
 307 - WPS ER learned AP settings
 308
 309 WPS-ER-AP-SETTINGS uuid=fd91b4ec-e3fa-5891-a57d-8c59efeed1d2 ssid=test-wps auth_type=0x0020 encr_type=0x0008 key=12345678
 310
 311
 312 WPS with NFC
 313 ------------
 314
 315 WPS can be used with NFC-based configuration method. An NFC tag
 316 containing a password token from the Enrollee can be used to
 317 authenticate the connection instead of the PIN. In addition, an NFC tag
 318 with a configuration token can be used to transfer AP settings without
 319 going through the WPS protocol.
 320
 321 When the station acts as an Enrollee, a local NFC tag with a password
 322 token can be used by touching the NFC interface of a Registrar.
 323
 324 "wps_nfc [BSSID]" command starts WPS protocol run with the local end as
 325 the Enrollee using the NFC password token that is either pre-configured
 326 in the configuration file (wps_nfc_dev_pw_id, wps_nfc_dh_pubkey,
 327 wps_nfc_dh_privkey, wps_nfc_dev_pw) or generated dynamically with
 328 "wps_nfc_token <WPS|NDEF>" command. The included nfc_pw_token tool
 329 (build with "make nfc_pw_token") can be used to generate NFC password
 330 tokens during manufacturing (each station needs to have its own random
 331 keys).
 332
 333 If the station includes NFC interface and reads an NFC tag with a MIME
 334 media type "application/vnd.wfa.wsc", the NDEF message payload (with or
 335 without NDEF encapsulation) can be delivered to wpa_supplicant using the
 336 following wpa_cli command:
 337
 338 wps_nfc_tag_read <hexdump of payload>
 339
 340 If the NFC tag contains a configuration token, the network is added to
 341 wpa_supplicant configuration. If the NFC tag contains a password token,
 342 the token is added to the WPS Registrar component. This information can
 343 then be used with wps_reg command (when the NFC password token was from
 344 an AP) using a special value "nfc-pw" in place of the PIN parameter. If
 345 the ER functionality has been started (wps_er_start), the NFC password
 346 token is used to enable enrollment of a new station (that was the source
 347 of the NFC password token).