src/wps/wps.h

   1 /*
   2  * Wi-Fi Protected Setup
   3  * Copyright (c) 2007-2009, Jouni Malinen <j@w1.fi>
   4  *
   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.
   8  *
   9  * Alternatively, this software may be distributed under the terms of BSD
  10  * license.
  11  *
  12  * See README and COPYING for more details.
  13  */
  14
  15 #ifndef WPS_H
  16 #define WPS_H
  17
  18 #include "wps_defs.h"
  19
  20 /**
  21  * enum wsc_op_code - EAP-WSC OP-Code values
  22  */
  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
  31 };
  32
  33 struct wps_registrar;
  34 struct upnp_wps_device_sm;
  35 struct wps_er;
  36
  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
  50  */
  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;
  62 };
  63
  64 #define WPS_DEV_TYPE_LEN 8
  65 #define WPS_DEV_TYPE_BUFSIZE 21
  66 #define WPS_SEC_DEV_TYPE_MAX_LEN 128
  67 /* maximum number of advertised WPS vendor extension attributes */
  68 #define MAX_WPS_VENDOR_EXTENSIONS 10
  69 /* maximum size of WPS Vendor extension attribute */
  70 #define WPS_MAX_VENDOR_EXT_LEN 1024
  71 /* maximum number of parsed WPS vendor extension attributes */
  72 #define MAX_WPS_PARSE_VENDOR_EXT 10
  73
  74 /**
  75  * struct wps_device_data - WPS Device Data
  76  * @mac_addr: Device MAC address
  77  * @device_name: Device Name (0..32 octets encoded in UTF-8)
  78  * @manufacturer: Manufacturer (0..64 octets encoded in UTF-8)
  79  * @model_name: Model Name (0..32 octets encoded in UTF-8)
  80  * @model_number: Model Number (0..32 octets encoded in UTF-8)
  81  * @serial_number: Serial Number (0..32 octets encoded in UTF-8)
  82  * @pri_dev_type: Primary Device Type
  83  * @sec_dev_type: Array of secondary device types
  84  * @num_sec_dev_type: Number of secondary device types
  85  * @os_version: OS Version
  86  * @rf_bands: RF bands (WPS_RF_24GHZ, WPS_RF_50GHZ flags)
  87  * @p2p: Whether the device is a P2P device
  88  */
  89 struct wps_device_data {
  90         u8 mac_addr[ETH_ALEN];
  91         char *device_name;
  92         char *manufacturer;
  93         char *model_name;
  94         char *model_number;
  95         char *serial_number;
  96         u8 pri_dev_type[WPS_DEV_TYPE_LEN];
  97 #define WPS_SEC_DEVICE_TYPES 5
  98         u8 sec_dev_type[WPS_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
  99         u8 num_sec_dev_types;
 100         u32 os_version;
 101         u8 rf_bands;
 102         struct wpabuf *vendor_ext[MAX_WPS_VENDOR_EXTENSIONS];
 103
 104         int p2p;
 105 };
 106
 107 struct oob_conf_data {
 108         enum {
 109                 OOB_METHOD_UNKNOWN = 0,
 110                 OOB_METHOD_DEV_PWD_E,
 111                 OOB_METHOD_DEV_PWD_R,
 112                 OOB_METHOD_CRED,
 113         } oob_method;
 114         struct wpabuf *dev_password;
 115         struct wpabuf *pubkey_hash;
 116 };
 117
 118 /**
 119  * struct wps_config - WPS configuration for a single registration protocol run
 120  */
 121 struct wps_config {
 122         /**
 123          * wps - Pointer to long term WPS context
 124          */
 125         struct wps_context *wps;
 126
 127         /**
 128          * registrar - Whether this end is a Registrar
 129          */
 130         int registrar;
 131
 132         /**
 133          * pin - Enrollee Device Password (%NULL for Registrar or PBC)
 134          */
 135         const u8 *pin;
 136
 137         /**
 138          * pin_len - Length on pin in octets
 139          */
 140         size_t pin_len;
 141
 142         /**
 143          * pbc - Whether this is protocol run uses PBC
 144          */
 145         int pbc;
 146
 147         /**
 148          * assoc_wps_ie: (Re)AssocReq WPS IE (in AP; %NULL if not AP)
 149          */
 150         const struct wpabuf *assoc_wps_ie;
 151
 152         /**
 153          * new_ap_settings - New AP settings (%NULL if not used)
 154          *
 155          * This parameter provides new AP settings when using a wireless
 156          * stations as a Registrar to configure the AP. %NULL means that AP
 157          * will not be reconfigured, i.e., the station will only learn the
 158          * current AP settings by using AP PIN.
 159          */
 160         const struct wps_credential *new_ap_settings;
 161
 162         /**
 163          * peer_addr: MAC address of the peer in AP; %NULL if not AP
 164          */
 165         const u8 *peer_addr;
 166
 167         /**
 168          * use_psk_key - Use PSK format key in Credential
 169          *
 170          * Force PSK format to be used instead of ASCII passphrase when
 171          * building Credential for an Enrollee. The PSK value is set in
 172          * struct wpa_context::psk.
 173          */
 174         int use_psk_key;
 175
 176         /**
 177          * dev_pw_id - Device Password ID for Enrollee when PIN is used
 178          */
 179         u16 dev_pw_id;
 180
 181         /**
 182          * p2p_dev_addr - P2P Device Address from (Re)Association Request
 183          *
 184          * On AP/GO, this is set to the P2P Device Address of the associating
 185          * P2P client if a P2P IE is included in the (Re)Association Request
 186          * frame and the P2P Device Address is included. Otherwise, this is set
 187          * to %NULL to indicate the station does not have a P2P Device Address.
 188          */
 189         const u8 *p2p_dev_addr;
 190
 191         /**
 192          * pbc_in_m1 - Do not remove PushButton config method in M1 (AP)
 193          *
 194          * This can be used to enable a workaround to allow Windows 7 to use
 195          * PBC with the AP.
 196          */
 197         int pbc_in_m1;
 198 };
 199
 200 struct wps_data * wps_init(const struct wps_config *cfg);
 201
 202 void wps_deinit(struct wps_data *data);
 203
 204 /**
 205  * enum wps_process_res - WPS message processing result
 206  */
 207 enum wps_process_res {
 208         /**
 209          * WPS_DONE - Processing done
 210          */
 211         WPS_DONE,
 212
 213         /**
 214          * WPS_CONTINUE - Processing continues
 215          */
 216         WPS_CONTINUE,
 217
 218         /**
 219          * WPS_FAILURE - Processing failed
 220          */
 221         WPS_FAILURE,
 222
 223         /**
 224          * WPS_PENDING - Processing continues, but waiting for an external
 225          *      event (e.g., UPnP message from an external Registrar)
 226          */
 227         WPS_PENDING
 228 };
 229 enum wps_process_res wps_process_msg(struct wps_data *wps,
 230                                      enum wsc_op_code op_code,
 231                                      const struct wpabuf *msg);
 232
 233 struct wpabuf * wps_get_msg(struct wps_data *wps, enum wsc_op_code *op_code);
 234
 235 int wps_is_selected_pbc_registrar(const struct wpabuf *msg);
 236 int wps_is_selected_pin_registrar(const struct wpabuf *msg);
 237 int wps_ap_priority_compar(const struct wpabuf *wps_a,
 238                            const struct wpabuf *wps_b);
 239 int wps_is_addr_authorized(const struct wpabuf *msg, const u8 *addr,
 240                            int ver1_compat);
 241 const u8 * wps_get_uuid_e(const struct wpabuf *msg);
 242 int wps_is_20(const struct wpabuf *msg);
 243
 244 struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type);
 245 struct wpabuf * wps_build_assoc_resp_ie(void);
 246 struct wpabuf * wps_build_probe_req_ie(int pbc, struct wps_device_data *dev,
 247                                        const u8 *uuid,
 248                                        enum wps_request_type req_type,
 249                                        unsigned int num_req_dev_types,
 250                                        const u8 *req_dev_types);
 251
 252
 253 /**
 254  * struct wps_registrar_config - WPS Registrar configuration
 255  */
 256 struct wps_registrar_config {
 257         /**
 258          * new_psk_cb - Callback for new PSK
 259          * @ctx: Higher layer context data (cb_ctx)
 260          * @mac_addr: MAC address of the Enrollee
 261          * @psk: The new PSK
 262          * @psk_len: The length of psk in octets
 263          * Returns: 0 on success, -1 on failure
 264          *
 265          * This callback is called when a new per-device PSK is provisioned.
 266          */
 267         int (*new_psk_cb)(void *ctx, const u8 *mac_addr, const u8 *psk,
 268                           size_t psk_len);
 269
 270         /**
 271          * set_ie_cb - Callback for WPS IE changes
 272          * @ctx: Higher layer context data (cb_ctx)
 273          * @beacon_ie: WPS IE for Beacon
 274          * @probe_resp_ie: WPS IE for Probe Response
 275          * Returns: 0 on success, -1 on failure
 276          *
 277          * This callback is called whenever the WPS IE in Beacon or Probe
 278          * Response frames needs to be changed (AP only). Callee is responsible
 279          * for freeing the buffers.
 280          */
 281         int (*set_ie_cb)(void *ctx, struct wpabuf *beacon_ie,
 282                          struct wpabuf *probe_resp_ie);
 283
 284         /**
 285          * pin_needed_cb - Callback for requesting a PIN
 286          * @ctx: Higher layer context data (cb_ctx)
 287          * @uuid_e: UUID-E of the unknown Enrollee
 288          * @dev: Device Data from the unknown Enrollee
 289          *
 290          * This callback is called whenever an unknown Enrollee requests to use
 291          * PIN method and a matching PIN (Device Password) is not found in
 292          * Registrar data.
 293          */
 294         void (*pin_needed_cb)(void *ctx, const u8 *uuid_e,
 295                               const struct wps_device_data *dev);
 296
 297         /**
 298          * reg_success_cb - Callback for reporting successful registration
 299          * @ctx: Higher layer context data (cb_ctx)
 300          * @mac_addr: MAC address of the Enrollee
 301          * @uuid_e: UUID-E of the Enrollee
 302          *
 303          * This callback is called whenever an Enrollee completes registration
 304          * successfully.
 305          */
 306         void (*reg_success_cb)(void *ctx, const u8 *mac_addr,
 307                                const u8 *uuid_e);
 308
 309         /**
 310          * set_sel_reg_cb - Callback for reporting selected registrar changes
 311          * @ctx: Higher layer context data (cb_ctx)
 312          * @sel_reg: Whether the Registrar is selected
 313          * @dev_passwd_id: Device Password ID to indicate with method or
 314          *      specific password the Registrar intends to use
 315          * @sel_reg_config_methods: Bit field of active config methods
 316          *
 317          * This callback is called whenever the Selected Registrar state
 318          * changes (e.g., a new PIN becomes available or PBC is invoked). This
 319          * callback is only used by External Registrar implementation;
 320          * set_ie_cb() is used by AP implementation in similar caes, but it
 321          * provides the full WPS IE data instead of just the minimal Registrar
 322          * state information.
 323          */
 324         void (*set_sel_reg_cb)(void *ctx, int sel_reg, u16 dev_passwd_id,
 325                                u16 sel_reg_config_methods);
 326
 327         /**
 328          * enrollee_seen_cb - Callback for reporting Enrollee based on ProbeReq
 329          * @ctx: Higher layer context data (cb_ctx)
 330          * @addr: MAC address of the Enrollee
 331          * @uuid_e: UUID of the Enrollee
 332          * @pri_dev_type: Primary device type
 333          * @config_methods: Config Methods
 334          * @dev_password_id: Device Password ID
 335          * @request_type: Request Type
 336          * @dev_name: Device Name (if available)
 337          */
 338         void (*enrollee_seen_cb)(void *ctx, const u8 *addr, const u8 *uuid_e,
 339                                  const u8 *pri_dev_type, u16 config_methods,
 340                                  u16 dev_password_id, u8 request_type,
 341                                  const char *dev_name);
 342
 343         /**
 344          * cb_ctx: Higher layer context data for Registrar callbacks
 345          */
 346         void *cb_ctx;
 347
 348         /**
 349          * skip_cred_build: Do not build credential
 350          *
 351          * This option can be used to disable internal code that builds
 352          * Credential attribute into M8 based on the current network
 353          * configuration and Enrollee capabilities. The extra_cred data will
 354          * then be used as the Credential(s).
 355          */
 356         int skip_cred_build;
 357
 358         /**
 359          * extra_cred: Additional Credential attribute(s)
 360          *
 361          * This optional data (set to %NULL to disable) can be used to add
 362          * Credential attribute(s) for other networks into M8. If
 363          * skip_cred_build is set, this will also override the automatically
 364          * generated Credential attribute.
 365          */
 366         const u8 *extra_cred;
 367
 368         /**
 369          * extra_cred_len: Length of extra_cred in octets
 370          */
 371         size_t extra_cred_len;
 372
 373         /**
 374          * disable_auto_conf - Disable auto-configuration on first registration
 375          *
 376          * By default, the AP that is started in not configured state will
 377          * generate a random PSK and move to configured state when the first
 378          * registration protocol run is completed successfully. This option can
 379          * be used to disable this functionality and leave it up to an external
 380          * program to take care of configuration. This requires the extra_cred
 381          * to be set with a suitable Credential and skip_cred_build being used.
 382          */
 383         int disable_auto_conf;
 384
 385         /**
 386          * static_wep_only - Whether the BSS supports only static WEP
 387          */
 388         int static_wep_only;
 389
 390         /**
 391          * dualband - Whether this is a concurrent dualband AP
 392          */
 393         int dualband;
 394 };
 395
 396
 397 /**
 398  * enum wps_event - WPS event types
 399  */
 400 enum wps_event {
 401         /**
 402          * WPS_EV_M2D - M2D received (Registrar did not know us)
 403          */
 404         WPS_EV_M2D,
 405
 406         /**
 407          * WPS_EV_FAIL - Registration failed
 408          */
 409         WPS_EV_FAIL,
 410
 411         /**
 412          * WPS_EV_SUCCESS - Registration succeeded
 413          */
 414         WPS_EV_SUCCESS,
 415
 416         /**
 417          * WPS_EV_PWD_AUTH_FAIL - Password authentication failed
 418          */
 419         WPS_EV_PWD_AUTH_FAIL,
 420
 421         /**
 422          * WPS_EV_PBC_OVERLAP - PBC session overlap detected
 423          */
 424         WPS_EV_PBC_OVERLAP,
 425
 426         /**
 427          * WPS_EV_PBC_TIMEOUT - PBC walktime expired before protocol run start
 428          */
 429         WPS_EV_PBC_TIMEOUT,
 430
 431         /**
 432          * WPS_EV_ER_AP_ADD - ER: AP added
 433          */
 434         WPS_EV_ER_AP_ADD,
 435
 436         /**
 437          * WPS_EV_ER_AP_REMOVE - ER: AP removed
 438          */
 439         WPS_EV_ER_AP_REMOVE,
 440
 441         /**
 442          * WPS_EV_ER_ENROLLEE_ADD - ER: Enrollee added
 443          */
 444         WPS_EV_ER_ENROLLEE_ADD,
 445
 446         /**
 447          * WPS_EV_ER_ENROLLEE_REMOVE - ER: Enrollee removed
 448          */
 449         WPS_EV_ER_ENROLLEE_REMOVE,
 450
 451         /**
 452          * WPS_EV_ER_AP_SETTINGS - ER: AP Settings learned
 453          */
 454         WPS_EV_ER_AP_SETTINGS,
 455
 456         /**
 457          * WPS_EV_ER_SET_SELECTED_REGISTRAR - ER: SetSelectedRegistrar event
 458          */
 459         WPS_EV_ER_SET_SELECTED_REGISTRAR
 460 };
 461
 462 /**
 463  * union wps_event_data - WPS event data
 464  */
 465 union wps_event_data {
 466         /**
 467          * struct wps_event_m2d - M2D event data
 468          */
 469         struct wps_event_m2d {
 470                 u16 config_methods;
 471                 const u8 *manufacturer;
 472                 size_t manufacturer_len;
 473                 const u8 *model_name;
 474                 size_t model_name_len;
 475                 const u8 *model_number;
 476                 size_t model_number_len;
 477                 const u8 *serial_number;
 478                 size_t serial_number_len;
 479                 const u8 *dev_name;
 480                 size_t dev_name_len;
 481                 const u8 *primary_dev_type; /* 8 octets */
 482                 u16 config_error;
 483                 u16 dev_password_id;
 484         } m2d;
 485
 486         /**
 487          * struct wps_event_fail - Registration failure information
 488          * @msg: enum wps_msg_type
 489          */
 490         struct wps_event_fail {
 491                 int msg;
 492                 u16 config_error;
 493                 u16 error_indication;
 494         } fail;
 495
 496         struct wps_event_pwd_auth_fail {
 497                 int enrollee;
 498                 int part;
 499         } pwd_auth_fail;
 500
 501         struct wps_event_er_ap {
 502                 const u8 *uuid;
 503                 const u8 *mac_addr;
 504                 const char *friendly_name;
 505                 const char *manufacturer;
 506                 const char *manufacturer_url;
 507                 const char *model_description;
 508                 const char *model_name;
 509                 const char *model_number;
 510                 const char *model_url;
 511                 const char *serial_number;
 512                 const char *upc;
 513                 const u8 *pri_dev_type;
 514                 u8 wps_state;
 515         } ap;
 516
 517         struct wps_event_er_enrollee {
 518                 const u8 *uuid;
 519                 const u8 *mac_addr;
 520                 int m1_received;
 521                 u16 config_methods;
 522                 u16 dev_passwd_id;
 523                 const u8 *pri_dev_type;
 524                 const char *dev_name;
 525                 const char *manufacturer;
 526                 const char *model_name;
 527                 const char *model_number;
 528                 const char *serial_number;
 529         } enrollee;
 530
 531         struct wps_event_er_ap_settings {
 532                 const u8 *uuid;
 533                 const struct wps_credential *cred;
 534         } ap_settings;
 535
 536         struct wps_event_er_set_selected_registrar {
 537                 const u8 *uuid;
 538                 int sel_reg;
 539                 u16 dev_passwd_id;
 540                 u16 sel_reg_config_methods;
 541                 enum {
 542                         WPS_ER_SET_SEL_REG_START,
 543                         WPS_ER_SET_SEL_REG_DONE,
 544                         WPS_ER_SET_SEL_REG_FAILED
 545                 } state;
 546         } set_sel_reg;
 547 };
 548
 549 /**
 550  * struct upnp_pending_message - Pending PutWLANResponse messages
 551  * @next: Pointer to next pending message or %NULL
 552  * @addr: NewWLANEventMAC
 553  * @msg: NewMessage
 554  * @type: Message Type
 555  */
 556 struct upnp_pending_message {
 557         struct upnp_pending_message *next;
 558         u8 addr[ETH_ALEN];
 559         struct wpabuf *msg;
 560         enum wps_msg_type type;
 561 };
 562
 563 /**
 564  * struct wps_context - Long term WPS context data
 565  *
 566  * This data is stored at the higher layer Authenticator or Supplicant data
 567  * structures and it is maintained over multiple registration protocol runs.
 568  */
 569 struct wps_context {
 570         /**
 571          * ap - Whether the local end is an access point
 572          */
 573         int ap;
 574
 575         /**
 576          * registrar - Pointer to WPS registrar data from wps_registrar_init()
 577          */
 578         struct wps_registrar *registrar;
 579
 580         /**
 581          * wps_state - Current WPS state
 582          */
 583         enum wps_state wps_state;
 584
 585         /**
 586          * ap_setup_locked - Whether AP setup is locked (only used at AP)
 587          */
 588         int ap_setup_locked;
 589
 590         /**
 591          * uuid - Own UUID
 592          */
 593         u8 uuid[16];
 594
 595         /**
 596          * ssid - SSID
 597          *
 598          * This SSID is used by the Registrar to fill in information for
 599          * Credentials. In addition, AP uses it when acting as an Enrollee to
 600          * notify Registrar of the current configuration.
 601          */
 602         u8 ssid[32];
 603
 604         /**
 605          * ssid_len - Length of ssid in octets
 606          */
 607         size_t ssid_len;
 608
 609         /**
 610          * dev - Own WPS device data
 611          */
 612         struct wps_device_data dev;
 613
 614         /**
 615          * oob_conf - OOB Config data
 616          */
 617         struct oob_conf_data oob_conf;
 618
 619         /**
 620          * oob_dev_pw_id - OOB Device password id
 621          */
 622         u16 oob_dev_pw_id;
 623
 624         /**
 625          * dh_ctx - Context data for Diffie-Hellman operation
 626          */
 627         void *dh_ctx;
 628
 629         /**
 630          * dh_privkey - Diffie-Hellman private key
 631          */
 632         struct wpabuf *dh_privkey;
 633
 634         /**
 635          * dh_pubkey_oob - Diffie-Hellman public key
 636          */
 637         struct wpabuf *dh_pubkey;
 638
 639         /**
 640          * config_methods - Enabled configuration methods
 641          *
 642          * Bit field of WPS_CONFIG_*
 643          */
 644         u16 config_methods;
 645
 646         /**
 647          * encr_types - Enabled encryption types (bit field of WPS_ENCR_*)
 648          */
 649         u16 encr_types;
 650
 651         /**
 652          * auth_types - Authentication types (bit field of WPS_AUTH_*)
 653          */
 654         u16 auth_types;
 655
 656         /**
 657          * network_key - The current Network Key (PSK) or %NULL to generate new
 658          *
 659          * If %NULL, Registrar will generate per-device PSK. In addition, AP
 660          * uses this when acting as an Enrollee to notify Registrar of the
 661          * current configuration.
 662          *
 663          * When using WPA/WPA2-Person, this key can be either the ASCII
 664          * passphrase (8..63 characters) or the 32-octet PSK (64 hex
 665          * characters). When this is set to the ASCII passphrase, the PSK can
 666          * be provided in the psk buffer and used per-Enrollee to control which
 667          * key type is included in the Credential (e.g., to reduce calculation
 668          * need on low-powered devices by provisioning PSK while still allowing
 669          * other devices to get the passphrase).
 670          */
 671         u8 *network_key;
 672
 673         /**
 674          * network_key_len - Length of network_key in octets
 675          */
 676         size_t network_key_len;
 677
 678         /**
 679          * psk - The current network PSK
 680          *
 681          * This optional value can be used to provide the current PSK if
 682          * network_key is set to the ASCII passphrase.
 683          */
 684         u8 psk[32];
 685
 686         /**
 687          * psk_set - Whether psk value is set
 688          */
 689         int psk_set;
 690
 691         /**
 692          * ap_settings - AP Settings override for M7 (only used at AP)
 693          *
 694          * If %NULL, AP Settings attributes will be generated based on the
 695          * current network configuration.
 696          */
 697         u8 *ap_settings;
 698
 699         /**
 700          * ap_settings_len - Length of ap_settings in octets
 701          */
 702         size_t ap_settings_len;
 703
 704         /**
 705          * friendly_name - Friendly Name (required for UPnP)
 706          */
 707         char *friendly_name;
 708
 709         /**
 710          * manufacturer_url - Manufacturer URL (optional for UPnP)
 711          */
 712         char *manufacturer_url;
 713
 714         /**
 715          * model_description - Model Description (recommended for UPnP)
 716          */
 717         char *model_description;
 718
 719         /**
 720          * model_url - Model URL (optional for UPnP)
 721          */
 722         char *model_url;
 723
 724         /**
 725          * upc - Universal Product Code (optional for UPnP)
 726          */
 727         char *upc;
 728
 729         /**
 730          * cred_cb - Callback to notify that new Credentials were received
 731          * @ctx: Higher layer context data (cb_ctx)
 732          * @cred: The received Credential
 733          * Return: 0 on success, -1 on failure
 734          */
 735         int (*cred_cb)(void *ctx, const struct wps_credential *cred);
 736
 737         /**
 738          * event_cb - Event callback (state information about progress)
 739          * @ctx: Higher layer context data (cb_ctx)
 740          * @event: Event type
 741          * @data: Event data
 742          */
 743         void (*event_cb)(void *ctx, enum wps_event event,
 744                          union wps_event_data *data);
 745
 746         /**
 747          * cb_ctx: Higher layer context data for callbacks
 748          */
 749         void *cb_ctx;
 750
 751         struct upnp_wps_device_sm *wps_upnp;
 752
 753         /* Pending messages from UPnP PutWLANResponse */
 754         struct upnp_pending_message *upnp_msgs;
 755 };
 756
 757 struct oob_device_data {
 758         char *device_name;
 759         char *device_path;
 760         void * (*init_func)(struct wps_context *, struct oob_device_data *,
 761                             int);
 762         struct wpabuf * (*read_func)(void *);
 763         int (*write_func)(void *, struct wpabuf *);
 764         void (*deinit_func)(void *);
 765 };
 766
 767 struct oob_nfc_device_data {
 768         int (*init_func)(char *);
 769         void * (*read_func)(size_t *);
 770         int (*write_func)(void *, size_t);
 771         void (*deinit_func)(void);
 772 };
 773
 774 struct wps_registrar *
 775 wps_registrar_init(struct wps_context *wps,
 776                    const struct wps_registrar_config *cfg);
 777 void wps_registrar_deinit(struct wps_registrar *reg);
 778 int wps_registrar_add_pin(struct wps_registrar *reg, const u8 *addr,
 779                           const u8 *uuid, const u8 *pin, size_t pin_len,
 780                           int timeout);
 781 int wps_registrar_invalidate_pin(struct wps_registrar *reg, const u8 *uuid);
 782 int wps_registrar_wps_cancel(struct wps_registrar *reg);
 783 int wps_registrar_unlock_pin(struct wps_registrar *reg, const u8 *uuid);
 784 int wps_registrar_button_pushed(struct wps_registrar *reg,
 785                                 const u8 *p2p_dev_addr);
 786 void wps_registrar_probe_req_rx(struct wps_registrar *reg, const u8 *addr,
 787                                 const struct wpabuf *wps_data,
 788                                 int p2p_wildcard);
 789 int wps_registrar_update_ie(struct wps_registrar *reg);
 790 int wps_registrar_get_info(struct wps_registrar *reg, const u8 *addr,
 791                            char *buf, size_t buflen);
 792 int wps_registrar_config_ap(struct wps_registrar *reg,
 793                             struct wps_credential *cred);
 794
 795 unsigned int wps_pin_checksum(unsigned int pin);
 796 unsigned int wps_pin_valid(unsigned int pin);
 797 unsigned int wps_generate_pin(void);
 798 void wps_free_pending_msgs(struct upnp_pending_message *msgs);
 799
 800 struct oob_device_data * wps_get_oob_device(char *device_type);
 801 struct oob_nfc_device_data * wps_get_oob_nfc_device(char *device_name);
 802 int wps_get_oob_method(char *method);
 803 int wps_process_oob(struct wps_context *wps, struct oob_device_data *oob_dev,
 804                     int registrar);
 805 int wps_attr_text(struct wpabuf *data, char *buf, char *end);
 806
 807 struct wps_er * wps_er_init(struct wps_context *wps, const char *ifname,
 808                             const char *filter);
 809 void wps_er_refresh(struct wps_er *er);
 810 void wps_er_deinit(struct wps_er *er, void (*cb)(void *ctx), void *ctx);
 811 void wps_er_set_sel_reg(struct wps_er *er, int sel_reg, u16 dev_passwd_id,
 812                         u16 sel_reg_config_methods);
 813 int wps_er_pbc(struct wps_er *er, const u8 *uuid);
 814 int wps_er_learn(struct wps_er *er, const u8 *uuid, const u8 *pin,
 815                  size_t pin_len);
 816 int wps_er_set_config(struct wps_er *er, const u8 *uuid,
 817                       const struct wps_credential *cred);
 818 int wps_er_config(struct wps_er *er, const u8 *uuid, const u8 *pin,
 819                   size_t pin_len, const struct wps_credential *cred);
 820
 821 int wps_dev_type_str2bin(const char *str, u8 dev_type[WPS_DEV_TYPE_LEN]);
 822 char * wps_dev_type_bin2str(const u8 dev_type[WPS_DEV_TYPE_LEN], char *buf,
 823                             size_t buf_len);
 824 void uuid_gen_mac_addr(const u8 *mac_addr, u8 *uuid);
 825 u16 wps_config_methods_str2bin(const char *str);
 826
 827 #ifdef CONFIG_WPS_STRICT
 828 int wps_validate_beacon(const struct wpabuf *wps_ie);
 829 int wps_validate_beacon_probe_resp(const struct wpabuf *wps_ie, int probe,
 830                                    const u8 *addr);
 831 int wps_validate_probe_req(const struct wpabuf *wps_ie, const u8 *addr);
 832 int wps_validate_assoc_req(const struct wpabuf *wps_ie);
 833 int wps_validate_assoc_resp(const struct wpabuf *wps_ie);
 834 int wps_validate_m1(const struct wpabuf *tlvs);
 835 int wps_validate_m2(const struct wpabuf *tlvs);
 836 int wps_validate_m2d(const struct wpabuf *tlvs);
 837 int wps_validate_m3(const struct wpabuf *tlvs);
 838 int wps_validate_m4(const struct wpabuf *tlvs);
 839 int wps_validate_m4_encr(const struct wpabuf *tlvs, int wps2);
 840 int wps_validate_m5(const struct wpabuf *tlvs);
 841 int wps_validate_m5_encr(const struct wpabuf *tlvs, int wps2);
 842 int wps_validate_m6(const struct wpabuf *tlvs);
 843 int wps_validate_m6_encr(const struct wpabuf *tlvs, int wps2);
 844 int wps_validate_m7(const struct wpabuf *tlvs);
 845 int wps_validate_m7_encr(const struct wpabuf *tlvs, int ap, int wps2);
 846 int wps_validate_m8(const struct wpabuf *tlvs);
 847 int wps_validate_m8_encr(const struct wpabuf *tlvs, int ap, int wps2);
 848 int wps_validate_wsc_ack(const struct wpabuf *tlvs);
 849 int wps_validate_wsc_nack(const struct wpabuf *tlvs);
 850 int wps_validate_wsc_done(const struct wpabuf *tlvs);
 851 int wps_validate_upnp_set_selected_registrar(const struct wpabuf *tlvs);
 852 #else /* CONFIG_WPS_STRICT */
 853 static inline int wps_validate_beacon(const struct wpabuf *wps_ie){
 854         return 0;
 855 }
 856
 857 static inline int wps_validate_beacon_probe_resp(const struct wpabuf *wps_ie,
 858                                                  int probe, const u8 *addr)
 859 {
 860         return 0;
 861 }
 862
 863 static inline int wps_validate_probe_req(const struct wpabuf *wps_ie,
 864                                          const u8 *addr)
 865 {
 866         return 0;
 867 }
 868
 869 static inline int wps_validate_assoc_req(const struct wpabuf *wps_ie)
 870 {
 871         return 0;
 872 }
 873
 874 static inline int wps_validate_assoc_resp(const struct wpabuf *wps_ie)
 875 {
 876         return 0;
 877 }
 878
 879 static inline int wps_validate_m1(const struct wpabuf *tlvs)
 880 {
 881         return 0;
 882 }
 883
 884 static inline int wps_validate_m2(const struct wpabuf *tlvs)
 885 {
 886         return 0;
 887 }
 888
 889 static inline int wps_validate_m2d(const struct wpabuf *tlvs)
 890 {
 891         return 0;
 892 }
 893
 894 static inline int wps_validate_m3(const struct wpabuf *tlvs)
 895 {
 896         return 0;
 897 }
 898
 899 static inline int wps_validate_m4(const struct wpabuf *tlvs)
 900 {
 901         return 0;
 902 }
 903
 904 static inline int wps_validate_m4_encr(const struct wpabuf *tlvs, int wps2)
 905 {
 906         return 0;
 907 }
 908
 909 static inline int wps_validate_m5(const struct wpabuf *tlvs)
 910 {
 911         return 0;
 912 }
 913
 914 static inline int wps_validate_m5_encr(const struct wpabuf *tlvs, int wps2)
 915 {
 916         return 0;
 917 }
 918
 919 static inline int wps_validate_m6(const struct wpabuf *tlvs)
 920 {
 921         return 0;
 922 }
 923
 924 static inline int wps_validate_m6_encr(const struct wpabuf *tlvs, int wps2)
 925 {
 926         return 0;
 927 }
 928
 929 static inline int wps_validate_m7(const struct wpabuf *tlvs)
 930 {
 931         return 0;
 932 }
 933
 934 static inline int wps_validate_m7_encr(const struct wpabuf *tlvs, int ap,
 935                                        int wps2)
 936 {
 937         return 0;
 938 }
 939
 940 static inline int wps_validate_m8(const struct wpabuf *tlvs)
 941 {
 942         return 0;
 943 }
 944
 945 static inline int wps_validate_m8_encr(const struct wpabuf *tlvs, int ap,
 946                                        int wps2)
 947 {
 948         return 0;
 949 }
 950
 951 static inline int wps_validate_wsc_ack(const struct wpabuf *tlvs)
 952 {
 953         return 0;
 954 }
 955
 956 static inline int wps_validate_wsc_nack(const struct wpabuf *tlvs)
 957 {
 958         return 0;
 959 }
 960
 961 static inline int wps_validate_wsc_done(const struct wpabuf *tlvs)
 962 {
 963         return 0;
 964 }
 965
 966 static inline int wps_validate_upnp_set_selected_registrar(
 967         const struct wpabuf *tlvs)
 968 {
 969         return 0;
 970 }
 971 #endif /* CONFIG_WPS_STRICT */
 972
 973 #endif /* WPS_H */