~ubuntu-branches/ubuntu/trusty/wpa/trusty

« back to all changes in this revision

Viewing changes to wpa_supplicant/README-WPS

  • Committer: Package Import Robot
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2014-03-04 16:13:24 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20140304161324-md40gw8imcectbuu
Tags: 2.1-0ubuntu1
* New upstream release (LP: #1099755)
* debian/get-orig-source: update for new git repository for the current
  hostap/wpasupplicant versions.
* Dropped patches due to being applied upstream and included in the current
  source tarball:
  - debian/patches/11_wpa_gui_ftbfs_gcc_4_7.patch
  - debian/patches/13_human_readable_signal.patch
  - debian/patches/git_deinit_p2p_context_on_mgmt_remove_ff1f9c8.patch
  - debian/patches/libnl3-includes.patch
* debian/patches/git_accept_client_cert_from_server.patch: revert the commit:
  "OpenSSL: Do not accept SSL Client certificate for server", which breaks
  many AAA servers that include both client and server EKUs. Cherry-picked
  from hostap git commit b62d5b5.

Show diffs side-by-side

added added

removed removed

Lines of Context:
67
67
 
68
68
CONFIG_WPS_ER=y
69
69
 
 
70
Following parameter can be used to enable support for NFC config method:
 
71
 
 
72
CONFIG_WPS_NFC=y
 
73
 
70
74
 
71
75
WPS needs the Universally Unique IDentifier (UUID; see RFC 4122) for
72
76
the device. This is configured in the runtime configuration for
126
130
This starts the WPS negotiation in the same way as above with the
127
131
generated PIN.
128
132
 
 
133
When the wps_pin command is issued for an AP (including P2P GO) mode
 
134
interface, an optional timeout parameter can be used to specify
 
135
expiration timeout for the PIN in seconds. For example:
 
136
 
 
137
wpa_cli wps_pin any 12345670 300
 
138
 
129
139
 
130
140
If a random PIN is needed for a user interface, "wpa_cli wps_pin get"
131
141
can be used to generate a new PIN without starting WPS negotiation.
249
259
wps_er_stop
250
260
- stop WPS ER functionality
251
261
 
252
 
wps_er_learn <UUID> <AP PIN>
 
262
wps_er_learn <UUID|BSSID> <AP PIN>
253
263
- learn AP configuration
254
264
 
255
 
wps_er_set_config <UUID> <network id>
 
265
wps_er_set_config <UUID|BSSID> <network id>
256
266
- use AP configuration from a locally configured network (e.g., from
257
267
  wps_reg command); this does not change the AP's configuration, but
258
268
  only prepares a configuration to be used when enrolling a new device
259
269
  to the AP
260
270
 
261
 
wps_er_config <UUID> <AP PIN> <new SSID> <auth> <encr> <new key>
 
271
wps_er_config <UUID|BSSID> <AP PIN> <new SSID> <auth> <encr> <new key>
262
272
- examples:
263
273
  wps_er_config 87654321-9abc-def0-1234-56789abc0002 12345670 testing WPA2PSK CCMP 12345678
264
274
  wpa_er_config 87654321-9abc-def0-1234-56789abc0002 12345670 clear OPEN NONE ""
267
277
<encr> must be one of the following: NONE WEP TKIP CCMP
268
278
 
269
279
 
270
 
wps_er_pbc <Enrollee UUID>
 
280
wps_er_pbc <Enrollee UUID|MAC address>
271
281
- accept an Enrollee PBC using External Registrar
272
282
 
273
 
wps_er_pin <Enrollee UUID> <PIN> [Enrollee MAC address]
 
283
wps_er_pin <Enrollee UUID|"any"|MAC address> <PIN> [Enrollee MAC address]
274
284
- add an Enrollee PIN to External Registrar
275
285
- if Enrollee UUID is not known, "any" can be used to add a wildcard PIN
276
286
- if the MAC address of the enrollee is known, it should be configured
303
313
- WPS ER learned AP settings
304
314
 
305
315
WPS-ER-AP-SETTINGS uuid=fd91b4ec-e3fa-5891-a57d-8c59efeed1d2 ssid=test-wps auth_type=0x0020 encr_type=0x0008 key=12345678
 
316
 
 
317
 
 
318
WPS with NFC
 
319
------------
 
320
 
 
321
WPS can be used with NFC-based configuration method. An NFC tag
 
322
containing a password token from the Enrollee can be used to
 
323
authenticate the connection instead of the PIN. In addition, an NFC tag
 
324
with a configuration token can be used to transfer AP settings without
 
325
going through the WPS protocol.
 
326
 
 
327
When the station acts as an Enrollee, a local NFC tag with a password
 
328
token can be used by touching the NFC interface of a Registrar.
 
329
 
 
330
"wps_nfc [BSSID]" command starts WPS protocol run with the local end as
 
331
the Enrollee using the NFC password token that is either pre-configured
 
332
in the configuration file (wps_nfc_dev_pw_id, wps_nfc_dh_pubkey,
 
333
wps_nfc_dh_privkey, wps_nfc_dev_pw) or generated dynamically with
 
334
"wps_nfc_token <WPS|NDEF>" command. The included nfc_pw_token tool
 
335
(build with "make nfc_pw_token") can be used to generate NFC password
 
336
tokens during manufacturing (each station needs to have its own random
 
337
keys).
 
338
 
 
339
The "wps_nfc_config_token <WPS/NDEF>" command can be used to build an
 
340
NFC configuration token when wpa_supplicant is controlling an AP
 
341
interface (AP or P2P GO). The output value from this command is a
 
342
hexdump of the current AP configuration (WPS parameter requests this to
 
343
include only the WPS attributes; NDEF parameter requests additional NDEF
 
344
encapsulation to be included). This data needs to be written to an NFC
 
345
tag with an external program. Once written, the NFC configuration token
 
346
can be used to touch an NFC interface on a station to provision the
 
347
credentials needed to access the network.
 
348
 
 
349
The "wps_nfc_config_token <WPS/NDEF> <network id>" command can be used
 
350
to build an NFC configuration token based on a locally configured
 
351
network.
 
352
 
 
353
If the station includes NFC interface and reads an NFC tag with a MIME
 
354
media type "application/vnd.wfa.wsc", the NDEF message payload (with or
 
355
without NDEF encapsulation) can be delivered to wpa_supplicant using the
 
356
following wpa_cli command:
 
357
 
 
358
wps_nfc_tag_read <hexdump of payload>
 
359
 
 
360
If the NFC tag contains a configuration token, the network is added to
 
361
wpa_supplicant configuration. If the NFC tag contains a password token,
 
362
the token is added to the WPS Registrar component. This information can
 
363
then be used with wps_reg command (when the NFC password token was from
 
364
an AP) using a special value "nfc-pw" in place of the PIN parameter. If
 
365
the ER functionality has been started (wps_er_start), the NFC password
 
366
token is used to enable enrollment of a new station (that was the source
 
367
of the NFC password token).
 
368
 
 
369
"nfc_get_handover_req <NDEF> <WPS-CR>" command can be used to build the
 
370
WPS carrier record for a Handover Request Message for connection
 
371
handover. The first argument selects the format of the output data and
 
372
the second argument selects which type of connection handover is
 
373
requested (WPS-CR = Wi-Fi handover as specified in WSC 2.0).
 
374
 
 
375
"nfc_get_handover_sel <NDEF> <WPS> [UUID|BSSID]" command can be used to
 
376
build the contents of a Handover Select Message for connection handover
 
377
when this does not depend on the contents of the Handover Request
 
378
Message. The first argument selects the format of the output data and
 
379
the second argument selects which type of connection handover is
 
380
requested (WPS = Wi-Fi handover as specified in WSC 2.0). If the options
 
381
UUID|BSSID argument is included, this is a request to build the handover
 
382
message for the specified AP when wpa_supplicant is operating as a WPS
 
383
ER.
 
384
 
 
385
"nfc_rx_handover_req <hexdump of payload>" is used to indicate receipt
 
386
of NFC connection handover request. The payload may include multiple
 
387
carriers the the applicable ones are matched based on the media
 
388
type. The reply data is contents for the Handover Select Message
 
389
(hexdump).
 
390
 
 
391
"nfc_rx_handover_sel <hexdump of payload>" is used to indicate receipt
 
392
of NFC connection handover select. The payload may include multiple
 
393
carriers the the applicable ones are matched based on the media
 
394
type.
 
395
 
 
396
"nfc_report_handover <INIT/RESP> WPS <carrier from handover request>
 
397
<carrier from handover select>" can be used as an alternative way for
 
398
reporting completed NFC connection handover. The first parameter
 
399
indicates whether the local device initiated or responded to the
 
400
connection handover and the carrier records are the selected carrier
 
401
from the handover request and select messages as a hexdump.
 
402
 
 
403
The "wps_er_nfc_config_token <WPS/NDEF> <UUID|BSSID>" command can be
 
404
used to build an NFC configuration token for the specified AP when
 
405
wpa_supplicant is operating as a WPS ER. The output value from this
 
406
command is a hexdump of the selected AP configuration (WPS parameter
 
407
requests this to include only the WPS attributes; NDEF parameter
 
408
requests additional NDEF encapsulation to be included). This data needs
 
409
to be written to an NFC tag with an external program. Once written, the
 
410
NFC configuration token can be used to touch an NFC interface on a
 
411
station to provision the credentials needed to access the network.