Zephyr API Documentation 4.2.0-rc2
A Scalable Open Source RTOS
 4.2.0-rc2
wifi_credentials.h File Reference
#include <zephyr/types.h>
#include <zephyr/net/wifi.h>
#include <zephyr/kernel.h>

Go to the source code of this file.

Data Structures

struct  wifi_credentials_header
 Wi-Fi credentials entry header. More...
struct  wifi_credentials_personal
 Wi-Fi Personal credentials entry. More...
struct  wifi_credentials_enterprise
 Wi-Fi Enterprise credentials entry. More...

Macros

#define WIFI_CREDENTIALS_FLAG_BSSID   BIT(0)
#define WIFI_CREDENTIALS_FLAG_FAVORITE   BIT(1)
#define WIFI_CREDENTIALS_FLAG_2_4GHz   BIT(2)
#define WIFI_CREDENTIALS_FLAG_5GHz   BIT(3)
#define WIFI_CREDENTIALS_FLAG_6GHz   BIT(4)
#define WIFI_CREDENTIALS_FLAG_MFP_REQUIRED   BIT(5)
#define WIFI_CREDENTIALS_FLAG_MFP_DISABLED   BIT(6)
#define WIFI_CREDENTIALS_FLAG_ANONYMOUS_IDENTITY   BIT(7)
#define WIFI_CREDENTIALS_FLAG_KEY_PASSWORD   BIT(8)
#define WIFI_CREDENTIALS_MAX_PASSWORD_LEN    MAX(WIFI_PSK_MAX_LEN, CONFIG_WIFI_CREDENTIALS_SAE_PASSWORD_LENGTH)

Typedefs

typedef void(* wifi_credentials_ssid_cb) (void *cb_arg, const char *ssid, size_t ssid_len)
 Callback type for wifi_credentials_for_each_ssid.

Functions

int wifi_credentials_get_by_ssid_personal (const char *ssid, size_t ssid_len, enum wifi_security_type *type, uint8_t *bssid_buf, size_t bssid_buf_len, char *password_buf, size_t password_buf_len, size_t *password_len, uint32_t *flags, uint8_t *channel, uint32_t *timeout)
 Get credentials for given SSID.
int wifi_credentials_set_personal (const char *ssid, size_t ssid_len, enum wifi_security_type type, const uint8_t *bssid, size_t bssid_len, const char *password, size_t password_len, uint32_t flags, uint8_t channel, uint32_t timeout)
 Set credentials for given SSID.
int wifi_credentials_get_by_ssid_personal_struct (const char *ssid, size_t ssid_len, struct wifi_credentials_personal *buf)
 Get credentials for given SSID by struct.
int wifi_credentials_set_personal_struct (const struct wifi_credentials_personal *creds)
 Set credentials for given SSID by struct.
int wifi_credentials_delete_by_ssid (const char *ssid, size_t ssid_len)
 Delete credentials for given SSID.
bool wifi_credentials_is_empty (void)
 Check if credentials storage is empty.
int wifi_credentials_delete_all (void)
 Deletes all stored Wi-Fi credentials.
void wifi_credentials_for_each_ssid (wifi_credentials_ssid_cb cb, void *cb_arg)
 Call callback for each registered SSID.