wpa_supplicant / hostapd  2.5
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Fields
wps_context Struct Reference

Long term WPS context data. More...

#include <wps.h>

Data Fields

int ap
 Whether the local end is an access point.
 
struct wps_registrarregistrar
 Pointer to WPS registrar data from wps_registrar_init()
 
enum wps_state wps_state
 Current WPS state.
 
int ap_setup_locked
 Whether AP setup is locked (only used at AP)
 
u8 uuid [16]
 Own UUID.
 
u8 ssid [SSID_MAX_LEN]
 SSID. More...
 
size_t ssid_len
 Length of ssid in octets.
 
struct wps_device_data dev
 Own WPS device data.
 
void * dh_ctx
 Context data for Diffie-Hellman operation.
 
struct wpabufdh_privkey
 Diffie-Hellman private key.
 
struct wpabufdh_pubkey
 Diffie-Hellman public key.
 
u16 config_methods
 Enabled configuration methods. More...
 
u16 encr_types
 Enabled encryption types (bit field of WPS_ENCR_*)
 
u16 auth_types
 Authentication types (bit field of WPS_AUTH_*)
 
u16 ap_encr_type
 Current AP encryption type (WPS_ENCR_*)
 
u16 ap_auth_type
 Current AP authentication types (WPS_AUTH_*)
 
u8 * network_key
 The current Network Key (PSK) or NULL to generate new. More...
 
size_t network_key_len
 Length of network_key in octets.
 
u8 psk [32]
 The current network PSK. More...
 
int psk_set
 Whether psk value is set.
 
u8 * ap_settings
 AP Settings override for M7 (only used at AP) More...
 
size_t ap_settings_len
 Length of ap_settings in octets.
 
char * friendly_name
 Friendly Name (required for UPnP)
 
char * manufacturer_url
 Manufacturer URL (optional for UPnP)
 
char * model_description
 Model Description (recommended for UPnP)
 
char * model_url
 Model URL (optional for UPnP)
 
char * upc
 Universal Product Code (optional for UPnP)
 
int(* cred_cb )(void *ctx, const struct wps_credential *cred)
 Callback to notify that new Credentials were received. More...
 
void(* event_cb )(void *ctx, enum wps_event event, union wps_event_data *data)
 Event callback (state information about progress) More...
 
int(* rf_band_cb )(void *ctx)
 Fetch currently used RF band. More...
 
void * cb_ctx
 cb_ctx: Higher layer context data for callbacks
 
struct upnp_wps_device_smwps_upnp
 
struct upnp_pending_messageupnp_msgs
 
u16 ap_nfc_dev_pw_id
 
struct wpabufap_nfc_dh_pubkey
 
struct wpabufap_nfc_dh_privkey
 
struct wpabufap_nfc_dev_pw
 

Detailed Description

Long term WPS context data.

This data is stored at the higher layer Authenticator or Supplicant data structures and it is maintained over multiple registration protocol runs.

Field Documentation

u8* wps_context::ap_settings

AP Settings override for M7 (only used at AP)

If NULL, AP Settings attributes will be generated based on the current network configuration.

u16 wps_context::config_methods

Enabled configuration methods.

Bit field of WPS_CONFIG_*

int(* wps_context::cred_cb)(void *ctx, const struct wps_credential *cred)

Callback to notify that new Credentials were received.

Parameters
ctxHigher layer context data (cb_ctx)
credThe received Credential Return: 0 on success, -1 on failure
void(* wps_context::event_cb)(void *ctx, enum wps_event event, union wps_event_data *data)

Event callback (state information about progress)

Parameters
ctxHigher layer context data (cb_ctx)
eventEvent type
dataEvent data
u8* wps_context::network_key

The current Network Key (PSK) or NULL to generate new.

If NULL, Registrar will generate per-device PSK. In addition, AP uses this when acting as an Enrollee to notify Registrar of the current configuration.

When using WPA/WPA2-Person, this key can be either the ASCII passphrase (8..63 characters) or the 32-octet PSK (64 hex characters). When this is set to the ASCII passphrase, the PSK can be provided in the psk buffer and used per-Enrollee to control which key type is included in the Credential (e.g., to reduce calculation need on low-powered devices by provisioning PSK while still allowing other devices to get the passphrase).

u8 wps_context::psk[32]

The current network PSK.

This optional value can be used to provide the current PSK if network_key is set to the ASCII passphrase.

int(* wps_context::rf_band_cb)(void *ctx)

Fetch currently used RF band.

Parameters
ctxHigher layer context data (cb_ctx) Return: Current used RF band or 0 if not known
u8 wps_context::ssid[SSID_MAX_LEN]

SSID.

This SSID is used by the Registrar to fill in information for Credentials. In addition, AP uses it when acting as an Enrollee to notify Registrar of the current configuration.


The documentation for this struct was generated from the following file: