2 * Wi-Fi Protected Setup
3 * Copyright (c) 2007-2008, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
21 * enum wsc_op_code - EAP-WSC OP-Code values
24 WSC_UPnP
= 0 /* No OP Code in UPnP transport */,
34 struct upnp_wps_device_sm
;
37 * struct wps_credential - WPS Credential
39 * @ssid_len: Length of SSID
40 * @auth_type: Authentication Type (WPS_AUTH_OPEN, .. flags)
41 * @encr_type: Encryption Type (WPS_ENCR_NONE, .. flags)
44 * @key_len: Key length in octets
45 * @mac_addr: MAC address of the peer
46 * @cred_attr: Unparsed Credential attribute data (used only in cred_cb());
47 * this may be %NULL, if not used
48 * @cred_attr_len: Length of cred_attr in octets
50 struct wps_credential
{
58 u8 mac_addr
[ETH_ALEN
];
64 * struct wps_device_data - WPS Device Data
65 * @mac_addr: Device MAC address
66 * @device_name: Device Name (0..32 octets encoded in UTF-8)
67 * @manufacturer: Manufacturer (0..64 octets encoded in UTF-8)
68 * @model_name: Model Name (0..32 octets encoded in UTF-8)
69 * @model_number: Model Number (0..32 octets encoded in UTF-8)
70 * @serial_number: Serial Number (0..32 octets encoded in UTF-8)
71 * @categ: Primary Device Category
72 * @oui: Primary Device OUI
73 * @sub_categ: Primary Device Sub-Category
74 * @os_version: OS Version
75 * @rf_bands: RF bands (WPS_RF_24GHZ, WPS_RF_50GHZ flags)
77 struct wps_device_data
{
78 u8 mac_addr
[ETH_ALEN
];
91 struct oob_conf_data
{
93 OOB_METHOD_UNKNOWN
= 0,
98 struct wpabuf
*dev_password
;
99 struct wpabuf
*pubkey_hash
;
103 * struct wps_config - WPS configuration for a single registration protocol run
107 * wps - Pointer to long term WPS context
109 struct wps_context
*wps
;
112 * registrar - Whether this end is a Registrar
117 * pin - Enrollee Device Password (%NULL for Registrar or PBC)
122 * pin_len - Length on pin in octets
127 * pbc - Whether this is protocol run uses PBC
132 * assoc_wps_ie: (Re)AssocReq WPS IE (in AP; %NULL if not AP)
134 const struct wpabuf
*assoc_wps_ie
;
137 struct wps_data
* wps_init(const struct wps_config
*cfg
);
139 void wps_deinit(struct wps_data
*data
);
142 * enum wps_process_res - WPS message processing result
144 enum wps_process_res
{
146 * WPS_DONE - Processing done
151 * WPS_CONTINUE - Processing continues
156 * WPS_FAILURE - Processing failed
161 * WPS_PENDING - Processing continues, but waiting for an external
162 * event (e.g., UPnP message from an external Registrar)
166 enum wps_process_res
wps_process_msg(struct wps_data
*wps
,
167 enum wsc_op_code op_code
,
168 const struct wpabuf
*msg
);
170 struct wpabuf
* wps_get_msg(struct wps_data
*wps
, enum wsc_op_code
*op_code
);
172 int wps_is_selected_pbc_registrar(const struct wpabuf
*msg
);
173 int wps_is_selected_pin_registrar(const struct wpabuf
*msg
);
174 const u8
* wps_get_uuid_e(const struct wpabuf
*msg
);
176 struct wpabuf
* wps_build_assoc_req_ie(enum wps_request_type req_type
);
177 struct wpabuf
* wps_build_probe_req_ie(int pbc
, struct wps_device_data
*dev
,
179 enum wps_request_type req_type
);
183 * struct wps_registrar_config - WPS Registrar configuration
185 struct wps_registrar_config
{
187 * new_psk_cb - Callback for new PSK
188 * @ctx: Higher layer context data (cb_ctx)
189 * @mac_addr: MAC address of the Enrollee
191 * @psk_len: The length of psk in octets
192 * Returns: 0 on success, -1 on failure
194 * This callback is called when a new per-device PSK is provisioned.
196 int (*new_psk_cb
)(void *ctx
, const u8
*mac_addr
, const u8
*psk
,
200 * set_ie_cb - Callback for WPS IE changes
201 * @ctx: Higher layer context data (cb_ctx)
202 * @beacon_ie: WPS IE for Beacon
203 * @beacon_ie_len: WPS IE length for Beacon
204 * @probe_resp_ie: WPS IE for Probe Response
205 * @probe_resp_ie_len: WPS IE length for Probe Response
206 * Returns: 0 on success, -1 on failure
208 * This callback is called whenever the WPS IE in Beacon or Probe
209 * Response frames needs to be changed (AP only).
211 int (*set_ie_cb
)(void *ctx
, const u8
*beacon_ie
, size_t beacon_ie_len
,
212 const u8
*probe_resp_ie
, size_t probe_resp_ie_len
);
215 * pin_needed_cb - Callback for requesting a PIN
216 * @ctx: Higher layer context data (cb_ctx)
217 * @uuid_e: UUID-E of the unknown Enrollee
218 * @dev: Device Data from the unknown Enrollee
220 * This callback is called whenever an unknown Enrollee requests to use
221 * PIN method and a matching PIN (Device Password) is not found in
224 void (*pin_needed_cb
)(void *ctx
, const u8
*uuid_e
,
225 const struct wps_device_data
*dev
);
228 * reg_success_cb - Callback for reporting successful registration
229 * @ctx: Higher layer context data (cb_ctx)
230 * @mac_addr: MAC address of the Enrollee
231 * @uuid_e: UUID-E of the Enrollee
233 * This callback is called whenever an Enrollee completes registration
236 void (*reg_success_cb
)(void *ctx
, const u8
*mac_addr
,
240 * cb_ctx: Higher layer context data for Registrar callbacks
245 * skip_cred_build: Do not build credential
247 * This option can be used to disable internal code that builds
248 * Credential attribute into M8 based on the current network
249 * configuration and Enrollee capabilities. The extra_cred data will
250 * then be used as the Credential(s).
255 * extra_cred: Additional Credential attribute(s)
257 * This optional data (set to %NULL to disable) can be used to add
258 * Credential attribute(s) for other networks into M8. If
259 * skip_cred_build is set, this will also override the automatically
260 * generated Credential attribute.
262 const u8
*extra_cred
;
265 * extra_cred_len: Length of extra_cred in octets
267 size_t extra_cred_len
;
270 * disable_auto_conf - Disable auto-configuration on first registration
272 * By default, the AP that is started in not configured state will
273 * generate a random PSK and move to configured state when the first
274 * registration protocol run is completed successfully. This option can
275 * be used to disable this functionality and leave it up to an external
276 * program to take care of configuration. This requires the extra_cred
277 * to be set with a suitable Credential and skip_cred_build being used.
279 int disable_auto_conf
;
284 * enum wps_event - WPS event types
288 * WPS_EV_M2D - M2D received (Registrar did not know us)
293 * WPS_EV_FAIL - Registration failed
298 * WPS_EV_SUCCESS - Registration succeeded
303 * WPS_EV_PWD_AUTH_FAIL - Password authentication failed
309 * union wps_event_data - WPS event data
311 union wps_event_data
{
313 * struct wps_event_m2d - M2D event data
315 struct wps_event_m2d
{
317 const u8
*manufacturer
;
318 size_t manufacturer_len
;
319 const u8
*model_name
;
320 size_t model_name_len
;
321 const u8
*model_number
;
322 size_t model_number_len
;
323 const u8
*serial_number
;
324 size_t serial_number_len
;
327 const u8
*primary_dev_type
; /* 8 octets */
333 * struct wps_event_fail - Registration failure information
334 * @msg: enum wps_msg_type
336 struct wps_event_fail
{
340 struct wps_event_pwd_auth_fail
{
347 * struct upnp_pending_message - Pending PutWLANResponse messages
348 * @next: Pointer to next pending message or %NULL
349 * @addr: NewWLANEventMAC
351 * @type: Message Type
353 struct upnp_pending_message
{
354 struct upnp_pending_message
*next
;
357 enum wps_msg_type type
;
361 * struct wps_context - Long term WPS context data
363 * This data is stored at the higher layer Authenticator or Supplicant data
364 * structures and it is maintained over multiple registration protocol runs.
368 * ap - Whether the local end is an access point
373 * registrar - Pointer to WPS registrar data from wps_registrar_init()
375 struct wps_registrar
*registrar
;
378 * wps_state - Current WPS state
380 enum wps_state wps_state
;
383 * ap_setup_locked - Whether AP setup is locked (only used at AP)
395 * This SSID is used by the Registrar to fill in information for
396 * Credentials. In addition, AP uses it when acting as an Enrollee to
397 * notify Registrar of the current configuration.
402 * ssid_len - Length of ssid in octets
407 * dev - Own WPS device data
409 struct wps_device_data dev
;
412 * oob_conf - OOB Config data
414 struct oob_conf_data oob_conf
;
417 * oob_dev_pw_id - OOB Device password id
422 * dh_privkey - Diffie-Hellman private key
424 struct wpabuf
*dh_privkey
;
427 * dh_pubkey_oob - Diffie-Hellman public key
429 struct wpabuf
*dh_pubkey
;
432 * config_methods - Enabled configuration methods
434 * Bit field of WPS_CONFIG_*
439 * encr_types - Enabled encryption types (bit field of WPS_ENCR_*)
444 * auth_types - Authentication types (bit field of WPS_AUTH_*)
449 * network_key - The current Network Key (PSK) or %NULL to generate new
451 * If %NULL, Registrar will generate per-device PSK. In addition, AP
452 * uses this when acting as an Enrollee to notify Registrar of the
453 * current configuration.
458 * network_key_len - Length of network_key in octets
460 size_t network_key_len
;
463 * ap_settings - AP Settings override for M7 (only used at AP)
465 * If %NULL, AP Settings attributes will be generated based on the
466 * current network configuration.
471 * ap_settings_len - Length of ap_settings in octets
473 size_t ap_settings_len
;
476 * friendly_name - Friendly Name (required for UPnP)
481 * manufacturer_url - Manufacturer URL (optional for UPnP)
483 char *manufacturer_url
;
486 * model_description - Model Description (recommended for UPnP)
488 char *model_description
;
491 * model_url - Model URL (optional for UPnP)
496 * upc - Universal Product Code (optional for UPnP)
501 * cred_cb - Callback to notify that new Credentials were received
502 * @ctx: Higher layer context data (cb_ctx)
503 * @cred: The received Credential
504 * Return: 0 on success, -1 on failure
506 int (*cred_cb
)(void *ctx
, const struct wps_credential
*cred
);
509 * event_cb - Event callback (state information about progress)
510 * @ctx: Higher layer context data (cb_ctx)
514 void (*event_cb
)(void *ctx
, enum wps_event event
,
515 union wps_event_data
*data
);
518 * cb_ctx: Higher layer context data for callbacks
522 struct upnp_wps_device_sm
*wps_upnp
;
524 /* Pending messages from UPnP PutWLANResponse */
525 struct upnp_pending_message
*upnp_msgs
;
528 struct oob_device_data
{
530 void * (*init_func
)(struct wps_context
*, struct oob_device_data
*,
532 struct wpabuf
* (*read_func
)(void *);
533 int (*write_func
)(void *, struct wpabuf
*);
534 void (*deinit_func
)(void *);
537 struct wps_registrar
*
538 wps_registrar_init(struct wps_context
*wps
,
539 const struct wps_registrar_config
*cfg
);
540 void wps_registrar_deinit(struct wps_registrar
*reg
);
541 int wps_registrar_add_pin(struct wps_registrar
*reg
, const u8
*uuid
,
542 const u8
*pin
, size_t pin_len
);
543 int wps_registrar_invalidate_pin(struct wps_registrar
*reg
, const u8
*uuid
);
544 int wps_registrar_unlock_pin(struct wps_registrar
*reg
, const u8
*uuid
);
545 int wps_registrar_button_pushed(struct wps_registrar
*reg
);
546 void wps_registrar_probe_req_rx(struct wps_registrar
*reg
, const u8
*addr
,
547 const struct wpabuf
*wps_data
);
548 int wps_registrar_update_ie(struct wps_registrar
*reg
);
549 int wps_registrar_set_selected_registrar(struct wps_registrar
*reg
,
550 const struct wpabuf
*msg
);
552 unsigned int wps_pin_checksum(unsigned int pin
);
553 unsigned int wps_pin_valid(unsigned int pin
);
554 unsigned int wps_generate_pin(void);
555 void wps_free_pending_msgs(struct upnp_pending_message
*msgs
);
557 struct oob_device_data
* wps_get_oob_device(char *device_type
);
558 int wps_get_oob_method(char *method
);
559 int wps_process_oob(struct wps_context
*wps
, struct oob_device_data
*oob_dev
,