revert between 56095 -> 55830 in arch
[AROS.git] / workbench / network / WirelessManager / src / wps / wps.h
blob1fd1e52bbd77c65d11f8b4c4c59bb8e04f9b3032
1 /*
2 * Wi-Fi Protected Setup
3 * Copyright (c) 2007-2009, 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
10 * license.
12 * See README and COPYING for more details.
15 #ifndef WPS_H
16 #define WPS_H
18 #include "wps_defs.h"
20 /**
21 * enum wsc_op_code - EAP-WSC OP-Code values
23 enum wsc_op_code {
24 WSC_UPnP = 0 /* No OP Code in UPnP transport */,
25 WSC_Start = 0x01,
26 WSC_ACK = 0x02,
27 WSC_NACK = 0x03,
28 WSC_MSG = 0x04,
29 WSC_Done = 0x05,
30 WSC_FRAG_ACK = 0x06
33 struct wps_registrar;
34 struct upnp_wps_device_sm;
35 struct wps_er;
37 /**
38 * struct wps_credential - WPS Credential
39 * @ssid: SSID
40 * @ssid_len: Length of SSID
41 * @auth_type: Authentication Type (WPS_AUTH_OPEN, .. flags)
42 * @encr_type: Encryption Type (WPS_ENCR_NONE, .. flags)
43 * @key_idx: Key index
44 * @key: Key
45 * @key_len: Key length in octets
46 * @mac_addr: MAC address of the Credential receiver
47 * @cred_attr: Unparsed Credential attribute data (used only in cred_cb());
48 * this may be %NULL, if not used
49 * @cred_attr_len: Length of cred_attr in octets
51 struct wps_credential {
52 u8 ssid[32];
53 size_t ssid_len;
54 u16 auth_type;
55 u16 encr_type;
56 u8 key_idx;
57 u8 key[64];
58 size_t key_len;
59 u8 mac_addr[ETH_ALEN];
60 const u8 *cred_attr;
61 size_t cred_attr_len;
64 #define WPS_DEV_TYPE_LEN 8
65 #define WPS_DEV_TYPE_BUFSIZE 21
67 /**
68 * struct wps_device_data - WPS Device Data
69 * @mac_addr: Device MAC address
70 * @device_name: Device Name (0..32 octets encoded in UTF-8)
71 * @manufacturer: Manufacturer (0..64 octets encoded in UTF-8)
72 * @model_name: Model Name (0..32 octets encoded in UTF-8)
73 * @model_number: Model Number (0..32 octets encoded in UTF-8)
74 * @serial_number: Serial Number (0..32 octets encoded in UTF-8)
75 * @pri_dev_type: Primary Device Type
76 * @os_version: OS Version
77 * @rf_bands: RF bands (WPS_RF_24GHZ, WPS_RF_50GHZ flags)
79 struct wps_device_data {
80 u8 mac_addr[ETH_ALEN];
81 char *device_name;
82 char *manufacturer;
83 char *model_name;
84 char *model_number;
85 char *serial_number;
86 u8 pri_dev_type[WPS_DEV_TYPE_LEN];
87 u32 os_version;
88 u8 rf_bands;
91 struct oob_conf_data {
92 enum {
93 OOB_METHOD_UNKNOWN = 0,
94 OOB_METHOD_DEV_PWD_E,
95 OOB_METHOD_DEV_PWD_R,
96 OOB_METHOD_CRED,
97 } oob_method;
98 struct wpabuf *dev_password;
99 struct wpabuf *pubkey_hash;
103 * struct wps_config - WPS configuration for a single registration protocol run
105 struct wps_config {
107 * wps - Pointer to long term WPS context
109 struct wps_context *wps;
112 * registrar - Whether this end is a Registrar
114 int registrar;
117 * pin - Enrollee Device Password (%NULL for Registrar or PBC)
119 const u8 *pin;
122 * pin_len - Length on pin in octets
124 size_t pin_len;
127 * pbc - Whether this is protocol run uses PBC
129 int pbc;
132 * assoc_wps_ie: (Re)AssocReq WPS IE (in AP; %NULL if not AP)
134 const struct wpabuf *assoc_wps_ie;
137 * new_ap_settings - New AP settings (%NULL if not used)
139 * This parameter provides new AP settings when using a wireless
140 * stations as a Registrar to configure the AP. %NULL means that AP
141 * will not be reconfigured, i.e., the station will only learn the
142 * current AP settings by using AP PIN.
144 const struct wps_credential *new_ap_settings;
147 * peer_addr: MAC address of the peer in AP; %NULL if not AP
149 const u8 *peer_addr;
152 * use_psk_key - Use PSK format key in Credential
154 * Force PSK format to be used instead of ASCII passphrase when
155 * building Credential for an Enrollee. The PSK value is set in
156 * struct wpa_context::psk.
158 int use_psk_key;
161 struct wps_data * wps_init(const struct wps_config *cfg);
163 void wps_deinit(struct wps_data *data);
166 * enum wps_process_res - WPS message processing result
168 enum wps_process_res {
170 * WPS_DONE - Processing done
172 WPS_DONE,
175 * WPS_CONTINUE - Processing continues
177 WPS_CONTINUE,
180 * WPS_FAILURE - Processing failed
182 WPS_FAILURE,
185 * WPS_PENDING - Processing continues, but waiting for an external
186 * event (e.g., UPnP message from an external Registrar)
188 WPS_PENDING
190 enum wps_process_res wps_process_msg(struct wps_data *wps,
191 enum wsc_op_code op_code,
192 const struct wpabuf *msg);
194 struct wpabuf * wps_get_msg(struct wps_data *wps, enum wsc_op_code *op_code);
196 int wps_is_selected_pbc_registrar(const struct wpabuf *msg);
197 int wps_is_selected_pin_registrar(const struct wpabuf *msg);
198 const u8 * wps_get_uuid_e(const struct wpabuf *msg);
200 struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type);
201 struct wpabuf * wps_build_assoc_resp_ie(void);
202 struct wpabuf * wps_build_probe_req_ie(int pbc, struct wps_device_data *dev,
203 const u8 *uuid,
204 enum wps_request_type req_type);
208 * struct wps_registrar_config - WPS Registrar configuration
210 struct wps_registrar_config {
212 * new_psk_cb - Callback for new PSK
213 * @ctx: Higher layer context data (cb_ctx)
214 * @mac_addr: MAC address of the Enrollee
215 * @psk: The new PSK
216 * @psk_len: The length of psk in octets
217 * Returns: 0 on success, -1 on failure
219 * This callback is called when a new per-device PSK is provisioned.
221 int (*new_psk_cb)(void *ctx, const u8 *mac_addr, const u8 *psk,
222 size_t psk_len);
225 * set_ie_cb - Callback for WPS IE changes
226 * @ctx: Higher layer context data (cb_ctx)
227 * @beacon_ie: WPS IE for Beacon
228 * @probe_resp_ie: WPS IE for Probe Response
229 * Returns: 0 on success, -1 on failure
231 * This callback is called whenever the WPS IE in Beacon or Probe
232 * Response frames needs to be changed (AP only). Callee is responsible
233 * for freeing the buffers.
235 int (*set_ie_cb)(void *ctx, struct wpabuf *beacon_ie,
236 struct wpabuf *probe_resp_ie);
239 * pin_needed_cb - Callback for requesting a PIN
240 * @ctx: Higher layer context data (cb_ctx)
241 * @uuid_e: UUID-E of the unknown Enrollee
242 * @dev: Device Data from the unknown Enrollee
244 * This callback is called whenever an unknown Enrollee requests to use
245 * PIN method and a matching PIN (Device Password) is not found in
246 * Registrar data.
248 void (*pin_needed_cb)(void *ctx, const u8 *uuid_e,
249 const struct wps_device_data *dev);
252 * reg_success_cb - Callback for reporting successful registration
253 * @ctx: Higher layer context data (cb_ctx)
254 * @mac_addr: MAC address of the Enrollee
255 * @uuid_e: UUID-E of the Enrollee
257 * This callback is called whenever an Enrollee completes registration
258 * successfully.
260 void (*reg_success_cb)(void *ctx, const u8 *mac_addr,
261 const u8 *uuid_e);
264 * set_sel_reg_cb - Callback for reporting selected registrar changes
265 * @ctx: Higher layer context data (cb_ctx)
266 * @sel_reg: Whether the Registrar is selected
267 * @dev_passwd_id: Device Password ID to indicate with method or
268 * specific password the Registrar intends to use
269 * @sel_reg_config_methods: Bit field of active config methods
271 * This callback is called whenever the Selected Registrar state
272 * changes (e.g., a new PIN becomes available or PBC is invoked). This
273 * callback is only used by External Registrar implementation;
274 * set_ie_cb() is used by AP implementation in similar caes, but it
275 * provides the full WPS IE data instead of just the minimal Registrar
276 * state information.
278 void (*set_sel_reg_cb)(void *ctx, int sel_reg, u16 dev_passwd_id,
279 u16 sel_reg_config_methods);
282 * enrollee_seen_cb - Callback for reporting Enrollee based on ProbeReq
283 * @ctx: Higher layer context data (cb_ctx)
284 * @addr: MAC address of the Enrollee
285 * @uuid_e: UUID of the Enrollee
286 * @pri_dev_type: Primary device type
287 * @config_methods: Config Methods
288 * @dev_password_id: Device Password ID
289 * @request_type: Request Type
290 * @dev_name: Device Name (if available)
292 void (*enrollee_seen_cb)(void *ctx, const u8 *addr, const u8 *uuid_e,
293 const u8 *pri_dev_type, u16 config_methods,
294 u16 dev_password_id, u8 request_type,
295 const char *dev_name);
298 * cb_ctx: Higher layer context data for Registrar callbacks
300 void *cb_ctx;
303 * skip_cred_build: Do not build credential
305 * This option can be used to disable internal code that builds
306 * Credential attribute into M8 based on the current network
307 * configuration and Enrollee capabilities. The extra_cred data will
308 * then be used as the Credential(s).
310 int skip_cred_build;
313 * extra_cred: Additional Credential attribute(s)
315 * This optional data (set to %NULL to disable) can be used to add
316 * Credential attribute(s) for other networks into M8. If
317 * skip_cred_build is set, this will also override the automatically
318 * generated Credential attribute.
320 const u8 *extra_cred;
323 * extra_cred_len: Length of extra_cred in octets
325 size_t extra_cred_len;
328 * disable_auto_conf - Disable auto-configuration on first registration
330 * By default, the AP that is started in not configured state will
331 * generate a random PSK and move to configured state when the first
332 * registration protocol run is completed successfully. This option can
333 * be used to disable this functionality and leave it up to an external
334 * program to take care of configuration. This requires the extra_cred
335 * to be set with a suitable Credential and skip_cred_build being used.
337 int disable_auto_conf;
340 * static_wep_only - Whether the BSS supports only static WEP
342 int static_wep_only;
347 * enum wps_event - WPS event types
349 enum wps_event {
351 * WPS_EV_M2D - M2D received (Registrar did not know us)
353 WPS_EV_M2D,
356 * WPS_EV_FAIL - Registration failed
358 WPS_EV_FAIL,
361 * WPS_EV_SUCCESS - Registration succeeded
363 WPS_EV_SUCCESS,
366 * WPS_EV_PWD_AUTH_FAIL - Password authentication failed
368 WPS_EV_PWD_AUTH_FAIL,
371 * WPS_EV_PBC_OVERLAP - PBC session overlap detected
373 WPS_EV_PBC_OVERLAP,
376 * WPS_EV_PBC_TIMEOUT - PBC walktime expired before protocol run start
378 WPS_EV_PBC_TIMEOUT,
381 * WPS_EV_ER_AP_ADD - ER: AP added
383 WPS_EV_ER_AP_ADD,
386 * WPS_EV_ER_AP_REMOVE - ER: AP removed
388 WPS_EV_ER_AP_REMOVE,
391 * WPS_EV_ER_ENROLLEE_ADD - ER: Enrollee added
393 WPS_EV_ER_ENROLLEE_ADD,
396 * WPS_EV_ER_ENROLLEE_REMOVE - ER: Enrollee removed
398 WPS_EV_ER_ENROLLEE_REMOVE
402 * union wps_event_data - WPS event data
404 union wps_event_data {
406 * struct wps_event_m2d - M2D event data
408 struct wps_event_m2d {
409 u16 config_methods;
410 const u8 *manufacturer;
411 size_t manufacturer_len;
412 const u8 *model_name;
413 size_t model_name_len;
414 const u8 *model_number;
415 size_t model_number_len;
416 const u8 *serial_number;
417 size_t serial_number_len;
418 const u8 *dev_name;
419 size_t dev_name_len;
420 const u8 *primary_dev_type; /* 8 octets */
421 u16 config_error;
422 u16 dev_password_id;
423 } m2d;
426 * struct wps_event_fail - Registration failure information
427 * @msg: enum wps_msg_type
429 struct wps_event_fail {
430 int msg;
431 } fail;
433 struct wps_event_pwd_auth_fail {
434 int enrollee;
435 int part;
436 } pwd_auth_fail;
438 struct wps_event_er_ap {
439 const u8 *uuid;
440 const u8 *mac_addr;
441 const char *friendly_name;
442 const char *manufacturer;
443 const char *manufacturer_url;
444 const char *model_description;
445 const char *model_name;
446 const char *model_number;
447 const char *model_url;
448 const char *serial_number;
449 const char *upc;
450 const u8 *pri_dev_type;
451 u8 wps_state;
452 } ap;
454 struct wps_event_er_enrollee {
455 const u8 *uuid;
456 const u8 *mac_addr;
457 int m1_received;
458 u16 config_methods;
459 u16 dev_passwd_id;
460 const u8 *pri_dev_type;
461 const char *dev_name;
462 const char *manufacturer;
463 const char *model_name;
464 const char *model_number;
465 const char *serial_number;
466 } enrollee;
470 * struct upnp_pending_message - Pending PutWLANResponse messages
471 * @next: Pointer to next pending message or %NULL
472 * @addr: NewWLANEventMAC
473 * @msg: NewMessage
474 * @type: Message Type
476 struct upnp_pending_message {
477 struct upnp_pending_message *next;
478 u8 addr[ETH_ALEN];
479 struct wpabuf *msg;
480 enum wps_msg_type type;
484 * struct wps_context - Long term WPS context data
486 * This data is stored at the higher layer Authenticator or Supplicant data
487 * structures and it is maintained over multiple registration protocol runs.
489 struct wps_context {
491 * ap - Whether the local end is an access point
493 int ap;
496 * registrar - Pointer to WPS registrar data from wps_registrar_init()
498 struct wps_registrar *registrar;
501 * wps_state - Current WPS state
503 enum wps_state wps_state;
506 * ap_setup_locked - Whether AP setup is locked (only used at AP)
508 int ap_setup_locked;
511 * uuid - Own UUID
513 u8 uuid[16];
516 * ssid - SSID
518 * This SSID is used by the Registrar to fill in information for
519 * Credentials. In addition, AP uses it when acting as an Enrollee to
520 * notify Registrar of the current configuration.
522 u8 ssid[32];
525 * ssid_len - Length of ssid in octets
527 size_t ssid_len;
530 * dev - Own WPS device data
532 struct wps_device_data dev;
535 * oob_conf - OOB Config data
537 struct oob_conf_data oob_conf;
540 * oob_dev_pw_id - OOB Device password id
542 u16 oob_dev_pw_id;
545 * dh_ctx - Context data for Diffie-Hellman operation
547 void *dh_ctx;
550 * dh_privkey - Diffie-Hellman private key
552 struct wpabuf *dh_privkey;
555 * dh_pubkey_oob - Diffie-Hellman public key
557 struct wpabuf *dh_pubkey;
560 * config_methods - Enabled configuration methods
562 * Bit field of WPS_CONFIG_*
564 u16 config_methods;
567 * encr_types - Enabled encryption types (bit field of WPS_ENCR_*)
569 u16 encr_types;
572 * auth_types - Authentication types (bit field of WPS_AUTH_*)
574 u16 auth_types;
577 * network_key - The current Network Key (PSK) or %NULL to generate new
579 * If %NULL, Registrar will generate per-device PSK. In addition, AP
580 * uses this when acting as an Enrollee to notify Registrar of the
581 * current configuration.
583 * When using WPA/WPA2-Person, this key can be either the ASCII
584 * passphrase (8..63 characters) or the 32-octet PSK (64 hex
585 * characters). When this is set to the ASCII passphrase, the PSK can
586 * be provided in the psk buffer and used per-Enrollee to control which
587 * key type is included in the Credential (e.g., to reduce calculation
588 * need on low-powered devices by provisioning PSK while still allowing
589 * other devices to get the passphrase).
591 u8 *network_key;
594 * network_key_len - Length of network_key in octets
596 size_t network_key_len;
599 * psk - The current network PSK
601 * This optional value can be used to provide the current PSK if
602 * network_key is set to the ASCII passphrase.
604 u8 psk[32];
607 * psk_set - Whether psk value is set
609 int psk_set;
612 * ap_settings - AP Settings override for M7 (only used at AP)
614 * If %NULL, AP Settings attributes will be generated based on the
615 * current network configuration.
617 u8 *ap_settings;
620 * ap_settings_len - Length of ap_settings in octets
622 size_t ap_settings_len;
625 * friendly_name - Friendly Name (required for UPnP)
627 char *friendly_name;
630 * manufacturer_url - Manufacturer URL (optional for UPnP)
632 char *manufacturer_url;
635 * model_description - Model Description (recommended for UPnP)
637 char *model_description;
640 * model_url - Model URL (optional for UPnP)
642 char *model_url;
645 * upc - Universal Product Code (optional for UPnP)
647 char *upc;
650 * cred_cb - Callback to notify that new Credentials were received
651 * @ctx: Higher layer context data (cb_ctx)
652 * @cred: The received Credential
653 * Return: 0 on success, -1 on failure
655 int (*cred_cb)(void *ctx, const struct wps_credential *cred);
658 * event_cb - Event callback (state information about progress)
659 * @ctx: Higher layer context data (cb_ctx)
660 * @event: Event type
661 * @data: Event data
663 void (*event_cb)(void *ctx, enum wps_event event,
664 union wps_event_data *data);
667 * cb_ctx: Higher layer context data for callbacks
669 void *cb_ctx;
671 struct upnp_wps_device_sm *wps_upnp;
673 /* Pending messages from UPnP PutWLANResponse */
674 struct upnp_pending_message *upnp_msgs;
677 struct oob_device_data {
678 char *device_name;
679 char *device_path;
680 void * (*init_func)(struct wps_context *, struct oob_device_data *,
681 int);
682 struct wpabuf * (*read_func)(void *);
683 int (*write_func)(void *, struct wpabuf *);
684 void (*deinit_func)(void *);
687 struct oob_nfc_device_data {
688 int (*init_func)(char *);
689 void * (*read_func)(size_t *);
690 int (*write_func)(void *, size_t);
691 void (*deinit_func)(void);
694 struct wps_registrar *
695 wps_registrar_init(struct wps_context *wps,
696 const struct wps_registrar_config *cfg);
697 void wps_registrar_deinit(struct wps_registrar *reg);
698 int wps_registrar_add_pin(struct wps_registrar *reg, const u8 *uuid,
699 const u8 *pin, size_t pin_len, int timeout);
700 int wps_registrar_invalidate_pin(struct wps_registrar *reg, const u8 *uuid);
701 int wps_registrar_unlock_pin(struct wps_registrar *reg, const u8 *uuid);
702 int wps_registrar_button_pushed(struct wps_registrar *reg);
703 void wps_registrar_probe_req_rx(struct wps_registrar *reg, const u8 *addr,
704 const struct wpabuf *wps_data);
705 int wps_registrar_update_ie(struct wps_registrar *reg);
706 int wps_registrar_get_info(struct wps_registrar *reg, const u8 *addr,
707 char *buf, size_t buflen);
709 unsigned int wps_pin_checksum(unsigned int pin);
710 unsigned int wps_pin_valid(unsigned int pin);
711 unsigned int wps_generate_pin(void);
712 void wps_free_pending_msgs(struct upnp_pending_message *msgs);
714 struct oob_device_data * wps_get_oob_device(char *device_type);
715 struct oob_nfc_device_data * wps_get_oob_nfc_device(char *device_name);
716 int wps_get_oob_method(char *method);
717 int wps_process_oob(struct wps_context *wps, struct oob_device_data *oob_dev,
718 int registrar);
719 int wps_attr_text(struct wpabuf *data, char *buf, char *end);
721 struct wps_er * wps_er_init(struct wps_context *wps, const char *ifname);
722 void wps_er_refresh(struct wps_er *er);
723 void wps_er_deinit(struct wps_er *er, void (*cb)(void *ctx), void *ctx);
724 void wps_er_set_sel_reg(struct wps_er *er, int sel_reg, u16 dev_passwd_id,
725 u16 sel_reg_config_methods);
726 int wps_er_pbc(struct wps_er *er, const u8 *uuid);
727 int wps_er_learn(struct wps_er *er, const u8 *uuid, const u8 *pin,
728 size_t pin_len);
730 int wps_dev_type_str2bin(const char *str, u8 dev_type[WPS_DEV_TYPE_LEN]);
731 char * wps_dev_type_bin2str(const u8 dev_type[WPS_DEV_TYPE_LEN], char *buf,
732 size_t buf_len);
733 void uuid_gen_mac_addr(const u8 *mac_addr, u8 *uuid);
734 u16 wps_config_methods_str2bin(const char *str);
736 #endif /* WPS_H */