Wi-Fi connect request parameters. More...

#include <zephyr/net/wifi_mgmt.h>

Data Fields
const uint8_t *	ssid
	SSID.
uint8_t	ssid_length
	SSID length.
const uint8_t *	psk
	Pre-shared key.
uint8_t	psk_length
	Pre-shared key length.
const uint8_t *	sae_password
	SAE password (same as PSK but with no length restrictions), optional.
uint8_t	sae_password_length
	SAE password length.
uint8_t	band
	Frequency band.
uint8_t	channel
	Channel.
enum wifi_security_type	security
	Security type.
enum wifi_mfp_options	mfp
	MFP options.
uint8_t	bssid [WIFI_MAC_ADDR_LEN]
	BSSID.
int	timeout
	Connect timeout in seconds, SYS_FOREVER_MS for no timeout.
const uint8_t *	anon_id
	Anonymous identity used in EAP authentication (Phase 1) for Wi-Fi Enterprise networks.
uint8_t	aid_length
	Length of the anonymous identity, maximum 64 bytes.
const uint8_t *	key_passwd
	Private key password for Wi-Fi Enterprise authentication.
uint8_t	key_passwd_length
	Length of the private key password, maximum 128 bytes.
const uint8_t *	key2_passwd
	Password for a secondary private key, if required by the authentication method.
uint8_t	key2_passwd_length
	Length of the secondary private key password, maximum 128 bytes.
enum wifi_wpa3_enterprise_type	wpa3_ent_mode
	WPA3 Enterprise mode type.
uint8_t	TLS_cipher
	TLS cipher suite to use for EAP-TLS authentication.
int	eap_ver
	EAP (Extensible Authentication Protocol) version to use.
const uint8_t *	eap_identity
	Identity string for EAP authentication (Phase 2, inner authentication).
uint8_t	eap_id_length
	Length of the EAP identity, maximum 64 bytes.
const uint8_t *	eap_password
	Password string for EAP authentication (Phase 2, inner authentication).
uint8_t	eap_passwd_length
	Length of the EAP password, maximum 128 bytes.
bool	verify_peer_cert
	Whether to verify the server's certificate authority (CA) during authentication.
bool	ft_used
	Indicates if Fast BSS Transition (802.11r) is used.
int	nusers
	Number of EAP user identities provided.
uint8_t	passwds
	Number of EAP passwords provided.
const uint8_t *	identities [WIFI_ENT_IDENTITY_MAX_USERS]
	Array of pointers to user identity strings for EAP authentication.
const uint8_t *	passwords [WIFI_ENT_IDENTITY_MAX_USERS]
	Array of pointers to user password strings for EAP authentication.
uint8_t	ignore_broadcast_ssid
	Hidden SSID configure 0: disabled (default) 1: send empty (length=0) SSID in beacon and ignore probe request for broadcast SSID 2: clear SSID, but keep the original length and ignore probe request for broadcast SSID.
enum wifi_frequency_bandwidths	bandwidth
	Parameter used for frequency band.

Detailed Description

Wi-Fi connect request parameters.

Field Documentation

◆ aid_length

uint8_t wifi_connect_req_params::aid_length

Length of the anonymous identity, maximum 64 bytes.

◆ anon_id

const uint8_t* wifi_connect_req_params::anon_id

Anonymous identity used in EAP authentication (Phase 1) for Wi-Fi Enterprise networks.

In EAP methods such as PEAP or TTLS, the anonymous identity is sent in the initial outer authentication exchange to protect the user's real identity (eap_identity). This value is not always required; if not set, the real identity may be exposed. Only used in Phase 1 (outer authentication).

◆ band

uint8_t wifi_connect_req_params::band

Frequency band.

◆ bandwidth

enum wifi_frequency_bandwidths wifi_connect_req_params::bandwidth

Parameter used for frequency band.

◆ bssid

uint8_t wifi_connect_req_params::bssid[WIFI_MAC_ADDR_LEN]

BSSID.

◆ channel

uint8_t wifi_connect_req_params::channel

Channel.

◆ eap_id_length

uint8_t wifi_connect_req_params::eap_id_length

Length of the EAP identity, maximum 64 bytes.

◆ eap_identity

const uint8_t* wifi_connect_req_params::eap_identity

Identity string for EAP authentication (Phase 2, inner authentication).

This is the real username or identity presented to the authentication server after the secure tunnel is established (e.g., inside PEAP or TTLS). Required for most enterprise Wi-Fi networks (e.g., WPA2/WPA3 Enterprise). Applies to Phase 2 (inner authentication).

◆ eap_passwd_length

uint8_t wifi_connect_req_params::eap_passwd_length

Length of the EAP password, maximum 128 bytes.

◆ eap_password

const uint8_t* wifi_connect_req_params::eap_password

Password string for EAP authentication (Phase 2, inner authentication).

Used in EAP methods that require a password (e.g., PEAP, TTLS, EAP-FAST). This is the user's password for the enterprise Wi-Fi network. Applies to Phase 2 (inner authentication).

◆ eap_ver

int wifi_connect_req_params::eap_ver

EAP (Extensible Authentication Protocol) version to use.

EAP is a framework for network authentication, commonly used in enterprise Wi-Fi. This field allows specifying the protocol version if required by the network. Applies to Phase 1 (outer authentication).

◆ ft_used

bool wifi_connect_req_params::ft_used

Indicates if Fast BSS Transition (802.11r) is used.

Fast BSS Transition allows seamless roaming between access points in enterprise networks. Applies to the overall connection, not specific to EAP phases.

◆ identities

const uint8_t* wifi_connect_req_params::identities[WIFI_ENT_IDENTITY_MAX_USERS]

Array of pointers to user identity strings for EAP authentication.

Used for enterprise Wi-Fi networks that require multiple user identities. Applies to Phase 2 (inner authentication).

◆ ignore_broadcast_ssid

uint8_t wifi_connect_req_params::ignore_broadcast_ssid

Hidden SSID configure 0: disabled (default) 1: send empty (length=0) SSID in beacon and ignore probe request for broadcast SSID 2: clear SSID, but keep the original length and ignore probe request for broadcast SSID.

◆ key2_passwd

const uint8_t* wifi_connect_req_params::key2_passwd

Password for a secondary private key, if required by the authentication method.

Rarely used; typically only needed for advanced enterprise setups. Applies to Phase 1 (outer authentication) if a second private key is used.

◆ key2_passwd_length

uint8_t wifi_connect_req_params::key2_passwd_length

Length of the secondary private key password, maximum 128 bytes.

◆ key_passwd

const uint8_t* wifi_connect_req_params::key_passwd

Private key password for Wi-Fi Enterprise authentication.

Used when a client certificate and private key are required (e.g., EAP-TLS). This is the password protecting the private key file. Applies to Phase 1 (outer authentication) when client certificates are used.

◆ key_passwd_length

uint8_t wifi_connect_req_params::key_passwd_length

Length of the private key password, maximum 128 bytes.

◆ mfp

enum wifi_mfp_options wifi_connect_req_params::mfp

MFP options.

◆ nusers

int wifi_connect_req_params::nusers

Number of EAP user identities provided.

Used for advanced enterprise authentication scenarios where multiple user credentials are needed. Applies to Phase 2 (inner authentication).

◆ passwds

uint8_t wifi_connect_req_params::passwds

Number of EAP passwords provided.

Used in conjunction with multiple user identities for enterprise authentication. Applies to Phase 2 (inner authentication).

◆ passwords

const uint8_t* wifi_connect_req_params::passwords[WIFI_ENT_IDENTITY_MAX_USERS]

Array of pointers to user password strings for EAP authentication.

Used for enterprise Wi-Fi networks that require multiple user passwords. Applies to Phase 2 (inner authentication).

◆ psk

const uint8_t* wifi_connect_req_params::psk

Pre-shared key.

◆ psk_length

uint8_t wifi_connect_req_params::psk_length

Pre-shared key length.

◆ sae_password

const uint8_t* wifi_connect_req_params::sae_password

SAE password (same as PSK but with no length restrictions), optional.

◆ sae_password_length

uint8_t wifi_connect_req_params::sae_password_length

SAE password length.

◆ security

enum wifi_security_type wifi_connect_req_params::security

Security type.

◆ ssid

const uint8_t* wifi_connect_req_params::ssid

SSID.

◆ ssid_length

uint8_t wifi_connect_req_params::ssid_length

SSID length.

◆ timeout

int wifi_connect_req_params::timeout

Connect timeout in seconds, SYS_FOREVER_MS for no timeout.

◆ TLS_cipher

uint8_t wifi_connect_req_params::TLS_cipher

TLS cipher suite to use for EAP-TLS authentication.

This selects the cryptographic algorithms used for the secure connection. Only relevant for enterprise networks using EAP-TLS or similar methods. Applies to Phase 1 (outer authentication).

◆ verify_peer_cert

bool wifi_connect_req_params::verify_peer_cert

Whether to verify the server's certificate authority (CA) during authentication.

Set to true to require validation of the server's certificate (recommended for security). Set to false to skip CA verification (not recommended, but sometimes used for testing). Applies to Phase 1 (outer authentication).

◆ wpa3_ent_mode

enum wifi_wpa3_enterprise_type wifi_connect_req_params::wpa3_ent_mode

WPA3 Enterprise mode type.

Selects the WPA3 Enterprise authentication variant to use. WPA3 Enterprise is a security protocol for Wi-Fi networks, often used in organizations, that provides enhanced security over WPA2. This field is only relevant for enterprise networks. Applies to Phase 1 (outer authentication).

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

zephyr/net/wifi_mgmt.h

Data Fields