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. The current version of wpa_supplicant does not
  51 support operation as an external WLAN Management Registrar for adding
  52 new client devices or configuring the AP over UPnP.
  53
  54
  55 wpa_supplicant configuration
  56 ----------------------------
  57
  58 WPS is an optional component that needs to be enabled in
  59 wpa_supplicant build configuration (.config). Here is an example
  60 configuration that includes WPS support and Linux wireless extensions
  61 -based driver interface:
  62
  63 CONFIG_DRIVER_WEXT=y
  64 CONFIG_WPS=y
  65 CONFIG_WPS2=y
  66
  67
  68 WPS needs the Universally Unique IDentifier (UUID; see RFC 4122) for
  69 the device. This is configured in the runtime configuration for
  70 wpa_supplicant (if not set, UUID will be generated based on local MAC
  71 address):
  72
  73 # example UUID for WPS
  74 uuid=12345678-9abc-def0-1234-56789abcdef0
  75
  76 The network configuration blocks needed for WPS are added
  77 automatically based on control interface commands, so they do not need
  78 to be added explicitly in the configuration file.
  79
  80 WPS registration will generate new network blocks for the acquired
  81 credentials. If these are to be stored for future use (after
  82 restarting wpa_supplicant), wpa_supplicant will need to be configured
  83 to allow configuration file updates:
  84
  85 update_config=1
  86
  87
  88
  89 External operations
  90 -------------------
  91
  92 WPS requires either a device PIN code (usually, 8-digit number) or a
  93 pushbutton event (for PBC) to allow a new WPS Enrollee to join the
  94 network. wpa_supplicant uses the control interface as an input channel
  95 for these events.
  96
  97 If the client device has a display, a random PIN has to be generated
  98 for each WPS registration session. wpa_supplicant can do this with a
  99 control interface request, e.g., by calling wpa_cli:
 100
 101 wpa_cli wps_pin any
 102
 103 This will return the generated 8-digit PIN which will then need to be
 104 entered at the Registrar to complete WPS registration. At that point,
 105 the client will be enrolled with credentials needed to connect to the
 106 AP to access the network.
 107
 108
 109 If the client device does not have a display that could show the
 110 random PIN, a hardcoded PIN that is printed on a label can be
 111 used. wpa_supplicant is notified this with a control interface
 112 request, e.g., by calling wpa_cli:
 113
 114 wpa_cli wps_pin any 12345670
 115
 116 This starts the WPS negotiation in the same way as above with the
 117 generated PIN.
 118
 119
 120 If the client design wants to support optional WPS PBC mode, this can
 121 be enabled by either a physical button in the client device or a
 122 virtual button in the user interface. The PBC operation requires that
 123 a button is also pressed at the AP/Registrar at about the same time (2
 124 minute window). wpa_supplicant is notified of the local button event
 125 over the control interface, e.g., by calling wpa_cli:
 126
 127 wpa_cli wps_pbc
 128
 129 At this point, the AP/Registrar has two minutes to complete WPS
 130 negotiation which will generate a new WPA PSK in the same way as the
 131 PIN method described above.
 132
 133
 134 If the client wants to operate in the Registrar role to learn the
 135 current AP configuration and optionally, to configure an AP,
 136 wpa_supplicant is notified over the control interface, e.g., with
 137 wpa_cli:
 138
 139 wpa_cli wps_reg <AP BSSID> <AP PIN>
 140 (example: wpa_cli wps_reg 02:34:56:78:9a:bc 12345670)
 141
 142 This is used to fetch the current AP settings instead of actually
 143 changing them. The main difference with the wps_pin command is that
 144 wps_reg uses the AP PIN (e.g., from a label on the AP) instead of a
 145 PIN generated at the client.
 146
 147 In order to change the AP configuration, the new configuration
 148 parameters are given to the wps_reg command:
 149
 150 wpa_cli wps_reg <AP BSSID> <AP PIN> <new SSID> <auth> <encr> <new key>
 151 examples:
 152   wpa_cli wps_reg 02:34:56:78:9a:bc 12345670 testing WPA2PSK CCMP 12345678
 153   wpa_cli wps_reg 02:34:56:78:9a:bc 12345670 clear OPEN NONE ""
 154
 155 <auth> must be one of the following: OPEN WPAPSK WPA2PSK
 156 <encr> must be one of the following: NONE WEP TKIP CCMP
 157
 158
 159 Scanning
 160 --------
 161
 162 Scan results ('wpa_cli scan_results' or 'wpa_cli bss <idx>') include a
 163 flags field that is used to indicate whether the BSS support WPS. If
 164 the AP support WPS, but has not recently activated a Registrar, [WPS]
 165 flag will be included. If PIN method has been recently selected,
 166 [WPS-PIN] is shown instead. Similarly, [WPS-PBC] is shown if PBC mode
 167 is in progress. GUI programs can use these as triggers for suggesting
 168 a guided WPS configuration to the user. In addition, control interface
 169 monitor events WPS-AP-AVAILABLE{,-PBC,-PIN} can be used to find out if
 170 there are WPS enabled APs in scan results without having to go through
 171 all the details in the GUI. These notification could be used, e.g., to
 172 suggest possible WPS connection to the user.
 173
 174
 175 wpa_gui
 176 -------
 177
 178 wpa_gui-qt4 directory contains a sample GUI that shows an example of
 179 how WPS support can be integrated into the GUI. Its main window has a
 180 WPS tab that guides user through WPS registration with automatic AP
 181 selection. In addition, it shows how WPS can be started manually by
 182 selecting an AP from scan results.
 183
 184
 185 Credential processing
 186 ---------------------
 187
 188 By default, wpa_supplicant processes received credentials and updates
 189 its configuration internally. However, it is possible to
 190 control these operations from external programs, if desired.
 191
 192 This internal processing can be disabled with wps_cred_processing=1
 193 option. When this is used, an external program is responsible for
 194 processing the credential attributes and updating wpa_supplicant
 195 configuration based on them.
 196
 197 Following control interface messages are sent out for external programs:
 198
 199 WPS-CRED-RECEIVED  <hexdump of Credential attribute(s)>
 200 For example:
 201 <2>WPS-CRED-RECEIVED 100e006f10260001011045000c6a6b6d2d7770732d74657374100300020020100f000200081027004030653462303435366332363666653064333961643135353461316634626637313234333761636664623766333939653534663166316230323061643434386235102000060266a0ee1727
 202
 203
 204 wpa_supplicant as WPS External Registrar (ER)
 205 ---------------------------------------------
 206
 207 wpa_supplicant can be used as a WPS ER to configure an AP or enroll
 208 new Enrollee to join the network. This functionality uses UPnP and
 209 requires that a working IP connectivity is available with the AP (this
 210 can be either over a wired or wireless connection).
 211
 212 Separate wpa_supplicant process can be started for WPS ER
 213 operations. A special "none" driver can be used in such a case to
 214 indicate that no local network interface is actually controlled. For
 215 example, following command could be used to start the ER:
 216
 217 wpa_supplicant -Dnone -c er.conf -ieth0
 218
 219 Sample er.conf:
 220
 221 ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=admin
 222 device_name=WPS External Registrar
 223
 224
 225 wpa_cli commands for ER functionality:
 226
 227 wps_er_start [IP address]
 228 - start WPS ER functionality
 229 - the optional IP address parameter can be used to filter operations only
 230   to include a single AP
 231 - if run again while ER is active, the stored information (discovered APs
 232   and Enrollees) are shown again
 233
 234 wps_er_stop
 235 - stop WPS ER functionality
 236
 237 wps_er_learn <UUID> <AP PIN>
 238 - learn AP configuration
 239
 240 wps_er_config <UUID> <AP PIN> <new SSID> <auth> <encr> <new key>
 241 - examples:
 242   wps_er_config 87654321-9abc-def0-1234-56789abc0002 12345670 testing WPA2PSK CCMP 12345678
 243   wpa_er_config 87654321-9abc-def0-1234-56789abc0002 12345670 clear OPEN NONE ""
 244
 245 <auth> must be one of the following: OPEN WPAPSK WPA2PSK
 246 <encr> must be one of the following: NONE WEP TKIP CCMP
 247
 248
 249 wps_er_pbc <Enrollee UUID>
 250 - accept an Enrollee PBC using External Registrar
 251
 252 wps_er_pin <Enrollee UUID> <PIN>
 253 - add an Enrollee PIN to External Registrar
 254
 255
 256 WPS ER events:
 257
 258 WPS_EVENT_ER_AP_ADD
 259 - WPS ER discovered an AP
 260
 261 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/
 262
 263 WPS_EVENT_ER_AP_REMOVE
 264 - WPS ER removed an AP entry
 265
 266 WPS-ER-AP-REMOVE 87654321-9abc-def0-1234-56789abc0002
 267
 268 WPS_EVENT_ER_ENROLLEE_ADD
 269 - WPS ER discovered a new Enrollee
 270
 271 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|
 272
 273 WPS_EVENT_ER_ENROLLEE_REMOVE
 274 - WPS ER removed an Enrollee entry
 275
 276 WPS-ER-ENROLLEE-REMOVE 2b7093f1-d6fb-5108-adbb-bea66bb87333 02:66:a0:ee:17:27
 277
 278 WPS-ER-AP-SETTINGS
 279 - WPS ER learned AP settings
 280
 281 WPS-ER-AP-SETTINGS uuid=fd91b4ec-e3fa-5891-a57d-8c59efeed1d2 ssid=test-wps auth_type=0x0020 encr_type=0x0008 key=12345678