wifi_credentials.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef WIFI_CREDENTIALS_H__
#define WIFI_CREDENTIALS_H__
 
#include <zephyr/types.h>
#include <zephyr/net/wifi.h>
#include <zephyr/kernel.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* this entry contains a BSSID */
#define WIFI_CREDENTIALS_FLAG_BSSID        BIT(0)
/* this entry is to be preferred over others */
#define WIFI_CREDENTIALS_FLAG_FAVORITE     BIT(1)
/* this entry can use the 2.4 GHz band */
#define WIFI_CREDENTIALS_FLAG_2_4GHz       BIT(2)
/* this entry can use the 5 GHz band */
#define WIFI_CREDENTIALS_FLAG_5GHz         BIT(3)
/* this entry can use the 6 GHz band */
#define WIFI_CREDENTIALS_FLAG_6GHz         BIT(4)
/* this entry requires management frame protection */
#define WIFI_CREDENTIALS_FLAG_MFP_REQUIRED BIT(5)
/* this entry disables management frame protection */
#define WIFI_CREDENTIALS_FLAG_MFP_DISABLED BIT(6)
/* this entry has anonymous identity configured */
#define WIFI_CREDENTIALS_FLAG_ANONYMOUS_IDENTITY  BIT(7)
/* this entry has key password configured */
#define WIFI_CREDENTIALS_FLAG_KEY_PASSWORD  BIT(8)
 
/* Maximum length of the password */
#define WIFI_CREDENTIALS_MAX_PASSWORD_LEN                                                          \
        MAX(WIFI_PSK_MAX_LEN, CONFIG_WIFI_CREDENTIALS_SAE_PASSWORD_LENGTH)
 
struct wifi_credentials_header {
        enum wifi_security_type type;
 
        char ssid[WIFI_SSID_MAX_LEN];
 
        size_t ssid_len;
 
        uint32_t flags;
 
        uint32_t timeout;
 
        uint8_t bssid[WIFI_MAC_ADDR_LEN];
 
        uint8_t channel;
 
        char anon_id[16];
 
        uint8_t aid_length;
 
        char key_passwd[16];
 
        uint8_t key_passwd_length;
};
 
struct wifi_credentials_personal {
        struct wifi_credentials_header header;
 
        char password[WIFI_CREDENTIALS_MAX_PASSWORD_LEN];
 
        size_t password_len;
};
 
struct wifi_credentials_enterprise {
        struct wifi_credentials_header header;
 
        size_t identity_len;
 
        size_t anonymous_identity_len;
 
        size_t password_len;
 
        size_t ca_cert_len;
 
        size_t client_cert_len;
 
        size_t private_key_len;
 
        size_t private_key_pw_len;
};
 
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);
 
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);
 
int wifi_credentials_get_by_ssid_personal_struct(const char *ssid, size_t ssid_len,
                                                 struct wifi_credentials_personal *buf);
 
int wifi_credentials_set_personal_struct(const struct wifi_credentials_personal *creds);
 
int wifi_credentials_delete_by_ssid(const char *ssid, size_t ssid_len);
 
bool wifi_credentials_is_empty(void);
 
int wifi_credentials_delete_all(void);
 
typedef void (*wifi_credentials_ssid_cb)(void *cb_arg, const char *ssid, size_t ssid_len);
 
void wifi_credentials_for_each_ssid(wifi_credentials_ssid_cb cb, void *cb_arg);
 
#ifdef __cplusplus
}
#endif
 
#endif /* WIFI_CREDENTIALS_H__ */