Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
|
Library that provides a way to store and load Wi-Fi credentials. More...
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_MFP_REQUIRED BIT(4) |
#define | WIFI_CREDENTIALS_FLAG_MFP_DISABLED BIT(5) |
#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. | |
Library that provides a way to store and load Wi-Fi credentials.
#define WIFI_CREDENTIALS_FLAG_2_4GHz BIT(2) |
#include <zephyr/net/wifi_credentials.h>
#define WIFI_CREDENTIALS_FLAG_5GHz BIT(3) |
#include <zephyr/net/wifi_credentials.h>
#define WIFI_CREDENTIALS_FLAG_BSSID BIT(0) |
#include <zephyr/net/wifi_credentials.h>
#define WIFI_CREDENTIALS_FLAG_FAVORITE BIT(1) |
#include <zephyr/net/wifi_credentials.h>
#define WIFI_CREDENTIALS_FLAG_MFP_DISABLED BIT(5) |
#include <zephyr/net/wifi_credentials.h>
#define WIFI_CREDENTIALS_FLAG_MFP_REQUIRED BIT(4) |
#include <zephyr/net/wifi_credentials.h>
#define WIFI_CREDENTIALS_MAX_PASSWORD_LEN MAX(WIFI_PSK_MAX_LEN, CONFIG_WIFI_CREDENTIALS_SAE_PASSWORD_LENGTH) |
#include <zephyr/net/wifi_credentials.h>
typedef void(* wifi_credentials_ssid_cb) (void *cb_arg, const char *ssid, size_t ssid_len) |
#include <zephyr/net/wifi_credentials.h>
Callback type for wifi_credentials_for_each_ssid.
[in] | cb_arg | arguments for the callback function. Appropriate cb_arg is transferred by wifi_credentials_for_each_ssid. |
[in] | ssid | SSID |
[in] | ssid_len | length of SSID |
int wifi_credentials_delete_all | ( | void | ) |
#include <zephyr/net/wifi_credentials.h>
Deletes all stored Wi-Fi credentials.
This function deletes all Wi-Fi credentials that have been stored in the system. It is typically used when you want to clear all saved networks.
int wifi_credentials_delete_by_ssid | ( | const char * | ssid, |
size_t | ssid_len ) |
#include <zephyr/net/wifi_credentials.h>
Delete credentials for given SSID.
[in] | ssid | SSID to look for |
[in] | ssid_len | length of SSID |
void wifi_credentials_for_each_ssid | ( | wifi_credentials_ssid_cb | cb, |
void * | cb_arg ) |
#include <zephyr/net/wifi_credentials.h>
Call callback for each registered SSID.
cb | callback |
cb_arg | argument for callback function |
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 ) |
#include <zephyr/net/wifi_credentials.h>
Get credentials for given SSID.
[in] | ssid | SSID to look for |
[in] | ssid_len | length of SSID |
[out] | type | Wi-Fi security type |
[out] | bssid_buf | buffer to store BSSID if it was fixed |
[in] | bssid_buf_len | length of bssid_buf |
[out] | password_buf | buffer to store password |
[in] | password_buf_len | length of password_buf |
[out] | password_len | length of password |
[out] | flags | flags |
[out] | channel | channel |
[out] | timeout | timeout |
int wifi_credentials_get_by_ssid_personal_struct | ( | const char * | ssid, |
size_t | ssid_len, | ||
struct wifi_credentials_personal * | buf ) |
#include <zephyr/net/wifi_credentials.h>
Get credentials for given SSID by struct.
[in] | ssid | SSID to look for |
[in] | ssid_len | length of SSID |
[out] | buf | credentials Pointer to struct where credentials are stored |
bool wifi_credentials_is_empty | ( | void | ) |
#include <zephyr/net/wifi_credentials.h>
Check if credentials storage is empty.
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 ) |
#include <zephyr/net/wifi_credentials.h>
Set credentials for given SSID.
[in] | ssid | SSID to look for |
[in] | ssid_len | length of SSID |
[in] | type | Wi-Fi security type |
[in] | bssid | BSSID (may be NULL) |
[in] | bssid_len | length of BSSID buffer (either 0 or WIFI_MAC_ADDR_LEN) |
[in] | password | password |
[in] | password_len | length of password |
[in] | flags | flags |
[in] | channel | Channel |
[in] | timeout | Timeout |
int wifi_credentials_set_personal_struct | ( | const struct wifi_credentials_personal * | creds | ) |
#include <zephyr/net/wifi_credentials.h>
Set credentials for given SSID by struct.
[in] | creds | credentials Pointer to struct from which credentials are loaded |