Zephyr API Documentation 4.0.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
wifi_credentials.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2024 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef WIFI_CREDENTIALS_H__
8#define WIFI_CREDENTIALS_H__
9
10#include <zephyr/types.h>
11#include <zephyr/net/wifi.h>
12#include <zephyr/kernel.h>
13
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27/* this entry contains a BSSID */
28#define WIFI_CREDENTIALS_FLAG_BSSID BIT(0)
29/* this entry is to be preferred over others */
30#define WIFI_CREDENTIALS_FLAG_FAVORITE BIT(1)
31/* this entry can use the 2.4 GHz band */
32#define WIFI_CREDENTIALS_FLAG_2_4GHz BIT(2)
33/* this entry can use the 5 GHz band */
34#define WIFI_CREDENTIALS_FLAG_5GHz BIT(3)
35/* this entry requires management frame protection */
36#define WIFI_CREDENTIALS_FLAG_MFP_REQUIRED BIT(4)
37/* this entry disables management frame protection */
38#define WIFI_CREDENTIALS_FLAG_MFP_DISABLED BIT(5)
39
40#define WIFI_CREDENTIALS_MAX_PASSWORD_LEN \
41 MAX(WIFI_PSK_MAX_LEN, CONFIG_WIFI_CREDENTIALS_SAE_PASSWORD_LENGTH)
42
60
74
89
111 enum wifi_security_type *type, uint8_t *bssid_buf,
112 size_t bssid_buf_len, char *password_buf,
113 size_t password_buf_len, size_t *password_len,
115
136 const uint8_t *bssid, size_t bssid_len, const char *password,
137 size_t password_len, uint32_t flags, uint8_t channel,
139
153 struct wifi_credentials_personal *buf);
154
166
177
184
194
202typedef void (*wifi_credentials_ssid_cb)(void *cb_arg, const char *ssid, size_t ssid_len);
203
211
212#ifdef __cplusplus
213}
214#endif
215
218#endif /* WIFI_CREDENTIALS_H__ */
int wifi_credentials_set_personal_struct(const struct wifi_credentials_personal *creds)
Set credentials for given SSID by struct.
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.
void(* wifi_credentials_ssid_cb)(void *cb_arg, const char *ssid, size_t ssid_len)
Callback type for wifi_credentials_for_each_ssid.
Definition wifi_credentials.h:202
void wifi_credentials_for_each_ssid(wifi_credentials_ssid_cb cb, void *cb_arg)
Call callback for each registered 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.
bool wifi_credentials_is_empty(void)
Check if credentials storage is empty.
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_delete_by_ssid(const char *ssid, size_t ssid_len)
Delete credentials for given SSID.
int wifi_credentials_delete_all(void)
Deletes all stored Wi-Fi credentials.
#define WIFI_CREDENTIALS_MAX_PASSWORD_LEN
Definition wifi_credentials.h:40
#define WIFI_MAC_ADDR_LEN
MAC address length.
Definition wifi.h:235
#define WIFI_SSID_MAX_LEN
Max SSID length.
Definition wifi.h:227
wifi_security_type
IEEE 802.11 security types.
Definition wifi.h:42
Public kernel APIs.
flags
Definition parser.h:96
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
Wi-Fi Enterprise credentials entry.
Definition wifi_credentials.h:79
size_t client_cert_len
Length of the client certificate.
Definition wifi_credentials.h:85
struct wifi_credentials_header header
Header.
Definition wifi_credentials.h:80
size_t ca_cert_len
Length of the CA certificate.
Definition wifi_credentials.h:84
size_t private_key_len
Length of the private key.
Definition wifi_credentials.h:86
size_t anonymous_identity_len
Length of the anonymous identity.
Definition wifi_credentials.h:82
size_t identity_len
Length of the identity.
Definition wifi_credentials.h:81
size_t private_key_pw_len
Length of the private key password.
Definition wifi_credentials.h:87
size_t password_len
Length of the password.
Definition wifi_credentials.h:83
Wi-Fi credentials entry header.
Definition wifi_credentials.h:51
char ssid[32]
SSID (Service Set Identifier)
Definition wifi_credentials.h:53
uint8_t bssid[6]
BSSID (Basic Service Set Identifier)
Definition wifi_credentials.h:57
uint32_t flags
Flags for controlling detail settings.
Definition wifi_credentials.h:55
enum wifi_security_type type
Wi-Fi security type.
Definition wifi_credentials.h:52
uint8_t channel
Channel on which the network operates.
Definition wifi_credentials.h:58
size_t ssid_len
Length of the SSID.
Definition wifi_credentials.h:54
uint32_t timeout
Timeout for connecting to the network.
Definition wifi_credentials.h:56
Wi-Fi Personal credentials entry.
Definition wifi_credentials.h:69
struct wifi_credentials_header header
Header.
Definition wifi_credentials.h:70
size_t password_len
Length of the password.
Definition wifi_credentials.h:72
char password[MAX(64, CONFIG_WIFI_CREDENTIALS_SAE_PASSWORD_LENGTH)]
Password/PSK.
Definition wifi_credentials.h:71
IEEE 802.11 protocol and general Wi-Fi definitions.