contrib/wpa/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
  66
  67 WPS needs the Universally Unique IDentifier (UUID; see RFC 4122) for
  68 the device. This is configured in the runtime configuration for
  69 wpa_supplicant (if not set, UUID will be generated based on local MAC
  70 address):
  71
  72 # example UUID for WPS
  73 uuid=12345678-9abc-def0-1234-56789abcdef0
  74
  75 The network configuration blocks needed for WPS are added
  76 automatically based on control interface commands, so they do not need
  77 to be added explicitly in the configuration file.
  78
  79 WPS registration will generate new network blocks for the acquired
  80 credentials. If these are to be stored for future use (after
  81 restarting wpa_supplicant), wpa_supplicant will need to be configured
  82 to allow configuration file updates:
  83
  84 update_config=1
  85
  86
  87
  88 External operations
  89 -------------------
  90
  91 WPS requires either a device PIN code (usually, 8-digit number) or a
  92 pushbutton event (for PBC) to allow a new WPS Enrollee to join the
  93 network. wpa_supplicant uses the control interface as an input channel
  94 for these events.
  95
  96 If the client device has a display, a random PIN has to be generated
  97 for each WPS registration session. wpa_supplicant can do this with a
  98 control interface request, e.g., by calling wpa_cli:
  99
 100 wpa_cli wps_pin any
 101
 102 This will return the generated 8-digit PIN which will then need to be
 103 entered at the Registrar to complete WPS registration. At that point,
 104 the client will be enrolled with credentials needed to connect to the
 105 AP to access the network.
 106
 107
 108 If the client device does not have a display that could show the
 109 random PIN, a hardcoded PIN that is printed on a label can be
 110 used. wpa_supplicant is notified this with a control interface
 111 request, e.g., by calling wpa_cli:
 112
 113 wpa_cli wps_pin any 12345670
 114
 115 This starts the WPS negotiation in the same way as above with the
 116 generated PIN.
 117
 118
 119 If the client design wants to support optional WPS PBC mode, this can
 120 be enabled by either a physical button in the client device or a
 121 virtual button in the user interface. The PBC operation requires that
 122 a button is also pressed at the AP/Registrar at about the same time (2
 123 minute window). wpa_supplicant is notified of the local button event
 124 over the control interface, e.g., by calling wpa_cli:
 125
 126 wpa_cli wps_pbc
 127
 128 At this point, the AP/Registrar has two minutes to complete WPS
 129 negotiation which will generate a new WPA PSK in the same way as the
 130 PIN method described above.
 131
 132
 133 If the client wants to operate in the Registrar role to learn the
 134 current AP configuration and optionally, to configure an AP,
 135 wpa_supplicant is notified over the control interface, e.g., with
 136 wpa_cli:
 137
 138 wpa_cli wps_reg <AP BSSID> <AP PIN>
 139 (example: wpa_cli wps_reg 02:34:56:78:9a:bc 12345670)
 140
 141 This is used to fetch the current AP settings instead of actually
 142 changing them. The main difference with the wps_pin command is that
 143 wps_reg uses the AP PIN (e.g., from a label on the AP) instead of a
 144 PIN generated at the client.
 145
 146 In order to change the AP configuration, the new configuration
 147 parameters are given to the wps_reg command:
 148
 149 wpa_cli wps_reg <AP BSSID> <AP PIN> <new SSID> <auth> <encr> <new key>
 150 examples:
 151   wpa_cli wps_reg 02:34:56:78:9a:bc 12345670 testing WPA2PSK CCMP 12345678
 152   wpa_cli wps_reg 02:34:56:78:9a:bc 12345670 clear OPEN NONE ""
 153
 154 <auth> must be one of the following: OPEN WPAPSK WPA2PSK
 155 <encr> must be one of the following: NONE WEP TKIP CCMP
 156
 157
 158 Scanning
 159 --------
 160
 161 Scan results ('wpa_cli scan_results' or 'wpa_cli bss <idx>') include a
 162 flags field that is used to indicate whether the BSS support WPS. If
 163 the AP support WPS, but has not recently activated a Registrar, [WPS]
 164 flag will be included. If PIN method has been recently selected,
 165 [WPS-PIN] is shown instead. Similarly, [WPS-PBC] is shown if PBC mode
 166 is in progress. GUI programs can use these as triggers for suggesting
 167 a guided WPS configuration to the user. In addition, control interface
 168 monitor events WPS-AP-AVAILABLE{,-PBC,-PIN} can be used to find out if
 169 there are WPS enabled APs in scan results without having to go through
 170 all the details in the GUI. These notification could be used, e.g., to
 171 suggest possible WPS connection to the user.
 172
 173
 174 wpa_gui
 175 -------
 176
 177 wpa_gui-qt4 directory contains a sample GUI that shows an example of
 178 how WPS support can be integrated into the GUI. Its main window has a
 179 WPS tab that guides user through WPS registration with automatic AP
 180 selection. In addition, it shows how WPS can be started manually by
 181 selecting an AP from scan results.
 182
 183
 184 Credential processing
 185 ---------------------
 186
 187 By default, wpa_supplicant processes received credentials and updates
 188 its configuration internally. However, it is possible to
 189 control these operations from external programs, if desired.
 190
 191 This internal processing can be disabled with wps_cred_processing=1
 192 option. When this is used, an external program is responsible for
 193 processing the credential attributes and updating wpa_supplicant
 194 configuration based on them.
 195
 196 Following control interface messages are sent out for external programs:
 197
 198 WPS-CRED-RECEIVED  <hexdump of Credential attribute(s)>
 199 For example:
 200 <2>WPS-CRED-RECEIVED 100e006f10260001011045000c6a6b6d2d7770732d74657374100300020020100f000200081027004030653462303435366332363666653064333961643135353461316634626637313234333761636664623766333939653534663166316230323061643434386235102000060266a0ee1727