NameDateSize

..Today9

.gitignoreH A D04-Aug-201074

ChangeLogH A D10-Sep-201133.5 KiB

config_file.cH A D04-Aug-201054.6 KiB

config_file.hH A D04-Aug-2010562

ctrl_iface.cH A D10-Sep-201117.1 KiB

ctrl_iface.hH A D04-Aug-2010880

defconfigH A D04-Aug-20105.1 KiB

dump_state.cH A D04-Aug-20104.7 KiB

dump_state.hH A D04-Aug-2010549

eap_register.cH A D04-Aug-20102.9 KiB

eap_register.hH A D04-Aug-2010528

eap_testing.txtH A D04-Aug-20102.5 KiB

hlr_auc_gw.cH A D04-Aug-201015.1 KiB

hlr_auc_gw.milenage_dbH A D04-Aug-2010734

hostapd.8H A D04-Aug-20101.5 KiB

hostapd.acceptH A D04-Aug-2010276

hostapd.confH A D10-Sep-201141 KiB

hostapd.denyH A D04-Aug-2010144

hostapd.eap_userH A D04-Aug-20103.9 KiB

hostapd.radius_clientsH A D04-Aug-2010142

hostapd.sim_dbH A D04-Aug-2010409

hostapd.vlanH A D04-Aug-2010282

hostapd.wpa_pskH A D04-Aug-2010549

hostapd_cli.1H A D04-Aug-20101.8 KiB

hostapd_cli.cH A D10-Sep-201121.4 KiB

logwatch/H12-Oct-20156

main.cH A D04-Aug-201012.6 KiB

MakefileH A D10-Sep-201116.6 KiB

nt_password_hash.cH A D04-Aug-20101.1 KiB

READMEH A D04-Aug-201017.2 KiB

README-WPSH A D10-Sep-201110.2 KiB

wired.confH A D04-Aug-20101.1 KiB

README

1hostapd - user space IEEE 802.11 AP and IEEE 802.1X/WPA/WPA2/EAP
2	  Authenticator and RADIUS authentication server
3================================================================
4
5Copyright (c) 2002-2010, Jouni Malinen <j@w1.fi> and contributors
6All Rights Reserved.
7
8This program is dual-licensed under both the GPL version 2 and BSD
9license. Either license may be used at your option.
10
11
12
13License
14-------
15
16GPL v2:
17
18This program is free software; you can redistribute it and/or modify
19it under the terms of the GNU General Public License version 2 as
20published by the Free Software Foundation.
21
22This program is distributed in the hope that it will be useful,
23but WITHOUT ANY WARRANTY; without even the implied warranty of
24MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25GNU General Public License for more details.
26
27You should have received a copy of the GNU General Public License
28along with this program; if not, write to the Free Software
29Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
30
31(this copy of the license is in COPYING file)
32
33
34Alternatively, this software may be distributed, used, and modified
35under the terms of BSD license:
36
37Redistribution and use in source and binary forms, with or without
38modification, are permitted provided that the following conditions are
39met:
40
411. Redistributions of source code must retain the above copyright
42   notice, this list of conditions and the following disclaimer.
43
442. Redistributions in binary form must reproduce the above copyright
45   notice, this list of conditions and the following disclaimer in the
46   documentation and/or other materials provided with the distribution.
47
483. Neither the name(s) of the above-listed copyright holder(s) nor the
49   names of its contributors may be used to endorse or promote products
50   derived from this software without specific prior written permission.
51
52THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
54LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
55A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
56OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
57SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
58LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
59DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
60THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
61(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
62OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
63
64
65
66Introduction
67============
68
69Originally, hostapd was an optional user space component for Host AP
70driver. It adds more features to the basic IEEE 802.11 management
71included in the kernel driver: using external RADIUS authentication
72server for MAC address based access control, IEEE 802.1X Authenticator
73and dynamic WEP keying, RADIUS accounting, WPA/WPA2 (IEEE 802.11i/RSN)
74Authenticator and dynamic TKIP/CCMP keying.
75
76The current version includes support for other drivers, an integrated
77EAP server (i.e., allow full authentication without requiring
78an external RADIUS authentication server), and RADIUS authentication
79server for EAP authentication.
80
81
82Requirements
83------------
84
85Current hardware/software requirements:
86- drivers:
87	Host AP driver for Prism2/2.5/3.
88	(http://hostap.epitest.fi/)
89	Please note that station firmware version needs to be 1.7.0 or newer
90	to work in WPA mode.
91
92	madwifi driver for cards based on Atheros chip set (ar521x)
93	(http://sourceforge.net/projects/madwifi/)
94	Please note that you will need to add the correct path for
95	madwifi driver root directory in .config (see defconfig file for
96	an example: CFLAGS += -I<path>)
97
98	mac80211-based drivers that support AP mode (with driver=nl80211).
99	This includes drivers for Atheros (ath9k) and Broadcom (b43)
100	chipsets.
101
102	Any wired Ethernet driver for wired IEEE 802.1X authentication
103	(experimental code)
104
105	FreeBSD -current (with some kernel mods that have not yet been
106	committed when hostapd v0.3.0 was released)
107	BSD net80211 layer (e.g., Atheros driver)
108
109
110Build configuration
111-------------------
112
113In order to be able to build hostapd, you will need to create a build
114time configuration file, .config that selects which optional
115components are included. See defconfig file for example configuration
116and list of available options.
117
118
119
120IEEE 802.1X
121===========
122
123IEEE Std 802.1X-2001 is a standard for port-based network access
124control. In case of IEEE 802.11 networks, a "virtual port" is used
125between each associated station and the AP. IEEE 802.11 specifies
126minimal authentication mechanism for stations, whereas IEEE 802.1X
127introduces a extensible mechanism for authenticating and authorizing
128users.
129
130IEEE 802.1X uses elements called Supplicant, Authenticator, Port
131Access Entity, and Authentication Server. Supplicant is a component in
132a station and it performs the authentication with the Authentication
133Server. An access point includes an Authenticator that relays the packets
134between a Supplicant and an Authentication Server. In addition, it has a
135Port Access Entity (PAE) with Authenticator functionality for
136controlling the virtual port authorization, i.e., whether to accept
137packets from or to the station.
138
139IEEE 802.1X uses Extensible Authentication Protocol (EAP). The frames
140between a Supplicant and an Authenticator are sent using EAP over LAN
141(EAPOL) and the Authenticator relays these frames to the Authentication
142Server (and similarly, relays the messages from the Authentication
143Server to the Supplicant). The Authentication Server can be colocated with the
144Authenticator, in which case there is no need for additional protocol
145for EAP frame transmission. However, a more common configuration is to
146use an external Authentication Server and encapsulate EAP frame in the
147frames used by that server. RADIUS is suitable for this, but IEEE
148802.1X would also allow other mechanisms.
149
150Host AP driver includes PAE functionality in the kernel driver. It
151is a relatively simple mechanism for denying normal frames going to
152or coming from an unauthorized port. PAE allows IEEE 802.1X related
153frames to be passed between the Supplicant and the Authenticator even
154on an unauthorized port.
155
156User space daemon, hostapd, includes Authenticator functionality. It
157receives 802.1X (EAPOL) frames from the Supplicant using the wlan#ap
158device that is also used with IEEE 802.11 management frames. The
159frames to the Supplicant are sent using the same device.
160
161The normal configuration of the Authenticator would use an external
162Authentication Server. hostapd supports RADIUS encapsulation of EAP
163packets, so the Authentication Server should be a RADIUS server, like
164FreeRADIUS (http://www.freeradius.org/). The Authenticator in hostapd
165relays the frames between the Supplicant and the Authentication
166Server. It also controls the PAE functionality in the kernel driver by
167controlling virtual port authorization, i.e., station-AP
168connection, based on the IEEE 802.1X state.
169
170When a station would like to use the services of an access point, it
171will first perform IEEE 802.11 authentication. This is normally done
172with open systems authentication, so there is no security. After
173this, IEEE 802.11 association is performed. If IEEE 802.1X is
174configured to be used, the virtual port for the station is set in
175Unauthorized state and only IEEE 802.1X frames are accepted at this
176point. The Authenticator will then ask the Supplicant to authenticate
177with the Authentication Server. After this is completed successfully,
178the virtual port is set to Authorized state and frames from and to the
179station are accepted.
180
181Host AP configuration for IEEE 802.1X
182-------------------------------------
183
184The user space daemon has its own configuration file that can be used to
185define AP options. Distribution package contains an example
186configuration file (hostapd/hostapd.conf) that can be used as a basis
187for configuration. It includes examples of all supported configuration
188options and short description of each option. hostapd should be started
189with full path to the configuration file as the command line argument,
190e.g., './hostapd /etc/hostapd.conf'. If you have more that one wireless
191LAN card, you can use one hostapd process for multiple interfaces by
192giving a list of configuration files (one per interface) in the command
193line.
194
195hostapd includes a minimal co-located IEEE 802.1X server which can be
196used to test IEEE 802.1X authentication. However, it should not be
197used in normal use since it does not provide any security. This can be
198configured by setting ieee8021x and minimal_eap options in the
199configuration file.
200
201An external Authentication Server (RADIUS) is configured with
202auth_server_{addr,port,shared_secret} options. In addition,
203ieee8021x and own_ip_addr must be set for this mode. With such
204configuration, the co-located Authentication Server is not used and EAP
205frames will be relayed using EAPOL between the Supplicant and the
206Authenticator and RADIUS encapsulation between the Authenticator and
207the Authentication Server. Other than this, the functionality is similar
208to the case with the co-located Authentication Server.
209
210Authentication Server and Supplicant
211------------------------------------
212
213Any RADIUS server supporting EAP should be usable as an IEEE 802.1X
214Authentication Server with hostapd Authenticator. FreeRADIUS
215(http://www.freeradius.org/) has been successfully tested with hostapd
216Authenticator and both Xsupplicant (http://www.open1x.org) and Windows
217XP Supplicants. EAP/TLS was used with Xsupplicant and
218EAP/MD5-Challenge with Windows XP.
219
220http://www.missl.cs.umd.edu/wireless/eaptls/ has useful information
221about using EAP/TLS with FreeRADIUS and Xsupplicant (just replace
222Cisco access point with Host AP driver, hostapd daemon, and a Prism2
223card ;-). http://www.freeradius.org/doc/EAP-MD5.html has information
224about using EAP/MD5 with FreeRADIUS, including instructions for WinXP
225configuration. http://www.denobula.com/EAPTLS.pdf has a HOWTO on
226EAP/TLS use with WinXP Supplicant.
227
228Automatic WEP key configuration
229-------------------------------
230
231EAP/TLS generates a session key that can be used to send WEP keys from
232an AP to authenticated stations. The Authenticator in hostapd can be
233configured to automatically select a random default/broadcast key
234(shared by all authenticated stations) with wep_key_len_broadcast
235option (5 for 40-bit WEP or 13 for 104-bit WEP). In addition,
236wep_key_len_unicast option can be used to configure individual unicast
237keys for stations. This requires support for individual keys in the
238station driver.
239
240WEP keys can be automatically updated by configuring rekeying. This
241will improve security of the network since same WEP key will only be
242used for a limited period of time. wep_rekey_period option sets the
243interval for rekeying in seconds.
244
245
246WPA/WPA2
247========
248
249Features
250--------
251
252Supported WPA/IEEE 802.11i features:
253- WPA-PSK ("WPA-Personal")
254- WPA with EAP (e.g., with RADIUS authentication server) ("WPA-Enterprise")
255- key management for CCMP, TKIP, WEP104, WEP40
256- RSN/WPA2 (IEEE 802.11i), including PMKSA caching and pre-authentication
257
258WPA
259---
260
261The original security mechanism of IEEE 802.11 standard was not
262designed to be strong and has proved to be insufficient for most
263networks that require some kind of security. Task group I (Security)
264of IEEE 802.11 working group (http://www.ieee802.org/11/) has worked
265to address the flaws of the base standard and has in practice
266completed its work in May 2004. The IEEE 802.11i amendment to the IEEE
267802.11 standard was approved in June 2004 and this amendment is likely
268to be published in July 2004.
269
270Wi-Fi Alliance (http://www.wi-fi.org/) used a draft version of the
271IEEE 802.11i work (draft 3.0) to define a subset of the security
272enhancements that can be implemented with existing wlan hardware. This
273is called Wi-Fi Protected Access<TM> (WPA). This has now become a
274mandatory component of interoperability testing and certification done
275by Wi-Fi Alliance. Wi-Fi provides information about WPA at its web
276site (http://www.wi-fi.org/OpenSection/protected_access.asp).
277
278IEEE 802.11 standard defined wired equivalent privacy (WEP) algorithm
279for protecting wireless networks. WEP uses RC4 with 40-bit keys,
28024-bit initialization vector (IV), and CRC32 to protect against packet
281forgery. All these choices have proven to be insufficient: key space is
282too small against current attacks, RC4 key scheduling is insufficient
283(beginning of the pseudorandom stream should be skipped), IV space is
284too small and IV reuse makes attacks easier, there is no replay
285protection, and non-keyed authentication does not protect against bit
286flipping packet data.
287
288WPA is an intermediate solution for the security issues. It uses
289Temporal Key Integrity Protocol (TKIP) to replace WEP. TKIP is a
290compromise on strong security and possibility to use existing
291hardware. It still uses RC4 for the encryption like WEP, but with
292per-packet RC4 keys. In addition, it implements replay protection,
293keyed packet authentication mechanism (Michael MIC).
294
295Keys can be managed using two different mechanisms. WPA can either use
296an external authentication server (e.g., RADIUS) and EAP just like
297IEEE 802.1X is using or pre-shared keys without need for additional
298servers. Wi-Fi calls these "WPA-Enterprise" and "WPA-Personal",
299respectively. Both mechanisms will generate a master session key for
300the Authenticator (AP) and Supplicant (client station).
301
302WPA implements a new key handshake (4-Way Handshake and Group Key
303Handshake) for generating and exchanging data encryption keys between
304the Authenticator and Supplicant. This handshake is also used to
305verify that both Authenticator and Supplicant know the master session
306key. These handshakes are identical regardless of the selected key
307management mechanism (only the method for generating master session
308key changes).
309
310
311IEEE 802.11i / WPA2
312-------------------
313
314The design for parts of IEEE 802.11i that were not included in WPA has
315finished (May 2004) and this amendment to IEEE 802.11 was approved in
316June 2004. Wi-Fi Alliance is using the final IEEE 802.11i as a new
317version of WPA called WPA2. This includes, e.g., support for more
318robust encryption algorithm (CCMP: AES in Counter mode with CBC-MAC)
319to replace TKIP and optimizations for handoff (reduced number of
320messages in initial key handshake, pre-authentication, and PMKSA caching).
321
322Some wireless LAN vendors are already providing support for CCMP in
323their WPA products. There is no "official" interoperability
324certification for CCMP and/or mixed modes using both TKIP and CCMP, so
325some interoperability issues can be expected even though many
326combinations seem to be working with equipment from different vendors.
327Testing for WPA2 is likely to start during the second half of 2004.
328
329hostapd configuration for WPA/WPA2
330----------------------------------
331
332TODO
333
334# Enable WPA. Setting this variable configures the AP to require WPA (either
335# WPA-PSK or WPA-RADIUS/EAP based on other configuration). For WPA-PSK, either
336# wpa_psk or wpa_passphrase must be set and wpa_key_mgmt must include WPA-PSK.
337# For WPA-RADIUS/EAP, ieee8021x must be set (but without dynamic WEP keys),
338# RADIUS authentication server must be configured, and WPA-EAP must be included
339# in wpa_key_mgmt.
340# This field is a bit field that can be used to enable WPA (IEEE 802.11i/D3.0)
341# and/or WPA2 (full IEEE 802.11i/RSN):
342# bit0 = WPA
343# bit1 = IEEE 802.11i/RSN (WPA2)
344#wpa=1
345
346# WPA pre-shared keys for WPA-PSK. This can be either entered as a 256-bit
347# secret in hex format (64 hex digits), wpa_psk, or as an ASCII passphrase
348# (8..63 characters) that will be converted to PSK. This conversion uses SSID
349# so the PSK changes when ASCII passphrase is used and the SSID is changed.
350#wpa_psk=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
351#wpa_passphrase=secret passphrase
352
353# Set of accepted key management algorithms (WPA-PSK, WPA-EAP, or both). The
354# entries are separated with a space.
355#wpa_key_mgmt=WPA-PSK WPA-EAP
356
357# Set of accepted cipher suites (encryption algorithms) for pairwise keys
358# (unicast packets). This is a space separated list of algorithms:
359# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i]
360# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i]
361# Group cipher suite (encryption algorithm for broadcast and multicast frames)
362# is automatically selected based on this configuration. If only CCMP is
363# allowed as the pairwise cipher, group cipher will also be CCMP. Otherwise,
364# TKIP will be used as the group cipher.
365#wpa_pairwise=TKIP CCMP
366
367# Time interval for rekeying GTK (broadcast/multicast encryption keys) in
368# seconds.
369#wpa_group_rekey=600
370
371# Time interval for rekeying GMK (master key used internally to generate GTKs
372# (in seconds).
373#wpa_gmk_rekey=86400
374
375# Enable IEEE 802.11i/RSN/WPA2 pre-authentication. This is used to speed up
376# roaming be pre-authenticating IEEE 802.1X/EAP part of the full RSN
377# authentication and key handshake before actually associating with a new AP.
378#rsn_preauth=1
379#
380# Space separated list of interfaces from which pre-authentication frames are
381# accepted (e.g., 'eth0' or 'eth0 wlan0wds0'. This list should include all
382# interface that are used for connections to other APs. This could include
383# wired interfaces and WDS links. The normal wireless data interface towards
384# associated stations (e.g., wlan0) should not be added, since
385# pre-authentication is only used with APs other than the currently associated
386# one.
387#rsn_preauth_interfaces=eth0
388

README-WPS

1hostapd and Wi-Fi Protected Setup (WPS)
2=======================================
3
4This document describes how the WPS implementation in hostapd can be
5configured and how an external component on an AP (e.g., web UI) is
6used to enable enrollment of client devices.
7
8
9Introduction to WPS
10-------------------
11
12Wi-Fi Protected Setup (WPS) is a mechanism for easy configuration of a
13wireless network. It allows automated generation of random keys (WPA
14passphrase/PSK) and configuration of an access point and client
15devices. WPS includes number of methods for setting up connections
16with PIN method and push-button configuration (PBC) being the most
17commonly deployed options.
18
19While WPS can enable more home networks to use encryption in the
20wireless network, it should be noted that the use of the PIN and
21especially PBC mechanisms for authenticating the initial key setup is
22not very secure. As such, use of WPS may not be suitable for
23environments that require secure network access without chance for
24allowing outsiders to gain access during the setup phase.
25
26WPS uses following terms to describe the entities participating in the
27network setup:
28- access point: the WLAN access point
29- Registrar: a device that control a network and can authorize
30  addition of new devices); this may be either in the AP ("internal
31  Registrar") or in an external device, e.g., a laptop, ("external
32  Registrar")
33- Enrollee: a device that is being authorized to use the network
34
35It should also be noted that the AP and a client device may change
36roles (i.e., AP acts as an Enrollee and client device as a Registrar)
37when WPS is used to configure the access point.
38
39
40More information about WPS is available from Wi-Fi Alliance:
41http://www.wi-fi.org/wifi-protected-setup
42
43
44hostapd implementation
45----------------------
46
47hostapd includes an optional WPS component that can be used as an
48internal WPS Registrar to manage addition of new WPS enabled clients
49to the network. In addition, WPS Enrollee functionality in hostapd can
50be used to allow external WPS Registrars to configure the access
51point, e.g., for initial network setup. In addition, hostapd can proxy a
52WPS registration between a wireless Enrollee and an external Registrar
53(e.g., Microsoft Vista or Atheros JumpStart) with UPnP.
54
55
56hostapd configuration
57---------------------
58
59WPS is an optional component that needs to be enabled in hostapd build
60configuration (.config). Here is an example configuration that
61includes WPS support and uses madwifi driver interface:
62
63CONFIG_DRIVER_MADWIFI=y
64CFLAGS += -I/usr/src/madwifi-0.9.3
65CONFIG_WPS=y
66CONFIG_WPS_UPNP=y
67
68
69Following section shows an example runtime configuration
70(hostapd.conf) that enables WPS:
71
72# Configure the driver and network interface
73driver=madwifi
74interface=ath0
75
76# WPA2-Personal configuration for the AP
77ssid=wps-test
78wpa=2
79wpa_key_mgmt=WPA-PSK
80wpa_pairwise=CCMP
81# Default WPA passphrase for legacy (non-WPS) clients
82wpa_passphrase=12345678
83# Enable random per-device PSK generation for WPS clients
84# Please note that the file has to exists for hostapd to start (i.e., create an
85# empty file as a starting point).
86wpa_psk_file=/etc/hostapd.psk
87
88# Enable control interface for PBC/PIN entry
89ctrl_interface=/var/run/hostapd
90
91# Enable internal EAP server for EAP-WSC (part of Wi-Fi Protected Setup)
92eap_server=1
93
94# WPS configuration (AP configured, do not allow external WPS Registrars)
95wps_state=2
96ap_setup_locked=1
97# If UUID is not configured, it will be generated based on local MAC address.
98uuid=87654321-9abc-def0-1234-56789abc0000
99wps_pin_requests=/var/run/hostapd.pin-req
100device_name=Wireless AP
101manufacturer=Company
102model_name=WAP
103model_number=123
104serial_number=12345
105device_type=6-0050F204-1
106os_version=01020300
107config_methods=label display push_button keypad
108
109# if external Registrars are allowed, UPnP support could be added:
110#upnp_iface=br0
111#friendly_name=WPS Access Point
112
113
114External operations
115-------------------
116
117WPS requires either a device PIN code (usually, 8-digit number) or a
118pushbutton event (for PBC) to allow a new WPS Enrollee to join the
119network. hostapd uses the control interface as an input channel for
120these events.
121
122When a client device (WPS Enrollee) connects to hostapd (WPS
123Registrar) in order to start PIN mode negotiation for WPS, an
124identifier (Enrollee UUID) is sent. hostapd will need to be configured
125with a device password (PIN) for this Enrollee. This is an operation
126that requires user interaction (assuming there are no pre-configured
127PINs on the AP for a set of Enrollee).
128
129The PIN request with information about the device is appended to the
130wps_pin_requests file (/var/run/hostapd.pin-req in this example). In
131addition, hostapd control interface event is sent as a notification of
132a new device. The AP could use, e.g., a web UI for showing active
133Enrollees to the user and request a PIN for an Enrollee.
134
135The PIN request file has one line for every Enrollee that connected to
136the AP, but for which there was no PIN. Following information is
137provided for each Enrollee (separated with tabulators):
138- timestamp (seconds from 1970-01-01)
139- Enrollee UUID
140- MAC address
141- Device name
142- Manufacturer
143- Model Name
144- Model Number
145- Serial Number
146- Device category
147
148Example line in the /var/run/hostapd.pin-req file:
1491200188391	53b63a98-d29e-4457-a2ed-094d7e6a669c	Intel(R) Centrino(R)	Intel Corporation	Intel(R) Centrino(R)	-	-	1-0050F204-1
150
151Control interface data:
152WPS-PIN-NEEDED [UUID-E|MAC Address|Device Name|Manufacturer|Model Name|Model Number|Serial Number|Device Category]
153For example:
154<2>WPS-PIN-NEEDED [53b63a98-d29e-4457-a2ed-094d7e6a669c|02:12:34:56:78:9a|Device|Manuf|Model|Model Number|Serial Number|1-0050F204-1]
155
156When the user enters a PIN for a pending Enrollee, e.g., on the web
157UI), hostapd needs to be notified of the new PIN over the control
158interface. This can be done either by using the UNIX domain socket
159-based control interface directly (src/common/wpa_ctrl.c provides
160helper functions for using the interface) or by calling hostapd_cli.
161
162Example command to add a PIN (12345670) for an Enrollee:
163
164hostapd_cli wps_pin 53b63a98-d29e-4457-a2ed-094d7e6a669c 12345670
165
166If the UUID-E is not available (e.g., Enrollee waits for the Registrar
167to be selected before connecting), wildcard UUID may be used to allow
168the PIN to be used once with any UUID:
169
170hostapd_cli wps_pin any 12345670
171
172To reduce likelihood of PIN being used with other devices or of
173forgetting an active PIN available for potential attackers, expiration
174time can be set for the new PIN:
175
176hostapd_cli wps_pin any 12345670 300
177
178
179After this, the Enrollee can connect to the AP again and complete WPS
180negotiation. At that point, a new, random WPA PSK is generated for the
181client device and the client can then use that key to connect to the
182AP to access the network.
183
184
185If the AP includes a pushbutton, WPS PBC mode can be used. It is
186enabled by pushing a button on both the AP and the client at about the
187same time (2 minute window). hostapd needs to be notified about the AP
188button pushed event over the control interface, e.g., by calling
189hostapd_cli:
190
191hostapd_cli wps_pbc
192
193At this point, the client has two minutes to complete WPS negotiation
194which will generate a new WPA PSK in the same way as the PIN method
195described above.
196
197
198When an external Registrar is used, the AP can act as an Enrollee and
199use its AP PIN. A static AP PIN (e.g., one one a label in the AP
200device) can be configured in hostapd.conf (ap_pin parameter). A more
201secure option is to use hostapd_cli wps_ap_pin command to enable the
202AP PIN only based on user action (and even better security by using a
203random AP PIN for each session, i.e., by using "wps_ap_pin random"
204command with a timeout value). Following commands are available for
205managing the dynamic AP PIN operations:
206
207hostapd_cli wps_ap_pin disable
208- disable AP PIN (i.e., do not allow external Registrars to use it to
209  learn the current AP settings or to reconfigure the AP)
210
211hostapd_cli wps_ap_pin random [timeout]
212- generate a random AP PIN and enable it
213- if the optional timeout parameter is given, the AP PIN will be enabled
214  for the specified number of seconds
215
216hostapd_cli wps_ap_pin get
217- fetch the current AP PIN
218
219hostapd_cli wps_ap_pin set <PIN> [timeout]
220- set the AP PIN and enable it
221- if the optional timeout parameter is given, the AP PIN will be enabled
222  for the specified number of seconds
223
224
225Credential generation and configuration changes
226-----------------------------------------------
227
228By default, hostapd generates credentials for Enrollees and processing
229AP configuration updates internally. However, it is possible to
230control these operations from external programs, if desired.
231
232The internal credential generation can be disabled with
233skip_cred_build=1 option in the configuration. extra_cred option will
234then need to be used to provide pre-configured Credential attribute(s)
235for hostapd to use. The exact data from this binary file will be sent,
236i.e., it will have to include valid WPS attributes. extra_cred can
237also be used to add additional networks if the Registrar is used to
238configure credentials for multiple networks.
239
240Processing of received configuration updates can be disabled with
241wps_cred_processing=1 option. When this is used, an external program
242is responsible for creating hostapd configuration files and processing
243configuration updates based on messages received from hostapd over
244control interface. This will also include the initial configuration on
245first successful registration if the AP is initially set in
246unconfigured state.
247
248Following control interface messages are sent out for external programs:
249
250WPS-REG-SUCCESS <Enrollee MAC address <UUID-E>
251For example:
252<2>WPS-REG-SUCCESS 02:66:a0:ee:17:27 2b7093f1-d6fb-5108-adbb-bea66bb87333
253
254This can be used to tricker change from unconfigured to configured
255state (random configuration based on the first successful WPS
256registration). In addition, this can be used to update AP UI about the
257status of WPS registration progress.
258
259
260WPS-NEW-AP-SETTINGS <hexdump of AP Setup attributes>
261For example:
262<2>WPS-NEW-AP-SETTINGS 10260001011045000c6a6b6d2d7770732d74657374100300020020100f00020008102700403065346230343536633236366665306433396164313535346131663462663731323433376163666462376633393965353466316631623032306164343438623510200006024231cede15101e000844
263
264This can be used to update the externally stored AP configuration and
265then update hostapd configuration (followed by restarting of hostapd).
266