ESP_WPA2.h
37 removals
217 lines
30 additions
209 lines
/*
// Hardware crypto support Copyright 2017 Espressif Systems (Shanghai) PTE LTD
* SPDX-FileCopyrightText: 2019-2021 Espressif Systems (Shanghai) CO LTD
//
*
// Licensed under the Apache License, Version 2.0 (the "License");
* SPDX-License-Identifier: Apache-2.0
// you may not use this file except in compliance with the License.
*/
// You may obtain a copy of the License at
#ifndef _ESP_WPA2_H
// http://www.apache.org/licenses/LICENSE-2.0
#define _ESP_WPA2_H
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef ESP_WPA2_H
#define ESP_WPA2_H
#include <stdbool.h>
#include <stdbool.h>
#include "esp_err.h"
#include "esp_err.h"
#include "esp_wifi_crypto_types.h"
typedef enum {
ESP_EAP_TTLS_PHASE2_EAP,
ESP_EAP_TTLS_PHASE2_MSCHAPV2,
ESP_EAP_TTLS_PHASE2_MSCHAP,
ESP_EAP_TTLS_PHASE2_PAP,
ESP_EAP_TTLS_PHASE2_CHAP
} esp_eap_ttls_phase2_types ;
#ifdef __cplusplus
#ifdef __cplusplus
extern "C" {
extern "C" {
#endif
#endif
extern const wpa2_crypto_funcs_t g_wifi_default_wpa2_crypto_funcs;
typedef struct {
const wpa2_crypto_funcs_t *crypto_funcs;
}esp_wpa2_config_t;
#define WPA2_CONFIG_INIT_DEFAULT() { \
.crypto_funcs = &g_wifi_default_wpa2_crypto_funcs \
}
/**
/**
* @brief Enable wpa2 enterprise authentication.
* @brief Enable wpa2 enterprise authentication.
*
*
* @attention 1. wpa2 enterprise authentication can only be used when ESP32 station is enabled.
* @attention 1. wpa2 enterprise authentication can only be used when ESP32 station is enabled.
* @attention 2. wpa2 enterprise authentication can only support TLS, PEAP-MSCHAPv2 and TTLS-MSCHAPv2 method.
* @attention 2. wpa2 enterprise authentication can only support TLS, PEAP-MSCHAPv2 and TTLS-MSCHAPv2 method.
*
*
* @return
* @return
* - ESP_OK: succeed.
* - ESP_OK: succeed.
* - ESP_ERR_NO_MEM: fail(internal memory malloc fail)
* - ESP_ERR_NO_MEM: fail(internal memory malloc fail)
*/
*/
esp_err_t esp_wifi_sta_wpa2_ent_enable(void);
esp_err_t esp_wifi_sta_wpa2_ent_enable(const esp_wpa2_config_t *config);
/**
/**
* @brief Disable wpa2 enterprise authentication.
* @brief Disable wpa2 enterprise authentication.
*
*
* @attention 1. wpa2 enterprise authentication can only be used when ESP32 station is enabled.
* @attention 1. wpa2 enterprise authentication can only be used when ESP32 station is enabled.
* @attention 2. wpa2 enterprise authentication can only support TLS, PEAP-MSCHAPv2 and TTLS-MSCHAPv2 method.
* @attention 2. wpa2 enterprise authentication can only support TLS, PEAP-MSCHAPv2 and TTLS-MSCHAPv2 method.
*
*
* @return
* @return
* - ESP_OK: succeed.
* - ESP_OK: succeed.
*/
*/
esp_err_t esp_wifi_sta_wpa2_ent_disable(void);
esp_err_t esp_wifi_sta_wpa2_ent_disable(void);
/**
/**
* @brief Set identity for PEAP/TTLS method.
* @brief Set identity for PEAP/TTLS method.
*
*
* @attention The API only passes the parameter identity to the global pointer variable in wpa2 enterprise module.
* @attention The API only passes the parameter identity to the global pointer variable in wpa2 enterprise module.
*
*
* @param identity: point to address where stores the identity;
* @param identity: point to address where stores the identity;
* @param len: length of identity, limited to 1~127
* @param len: length of identity, limited to 1~127
*
*
* @return
* @return
* - ESP_OK: succeed
* - ESP_OK: succeed
* - ESP_ERR_INVALID_ARG: fail(len <= 0 or len >= 128)
* - ESP_ERR_INVALID_ARG: fail(len <= 0 or len >= 128)
* - ESP_ERR_NO_MEM: fail(internal memory malloc fail)
* - ESP_ERR_NO_MEM: fail(internal memory malloc fail)
*/
*/
esp_err_t esp_wifi_sta_wpa2_ent_set_identity(const unsigned char *identity, int len);
esp_err_t esp_wifi_sta_wpa2_ent_set_identity(const unsigned char *identity, int len);
/**
/**
* @brief Clear identity for PEAP/TTLS method.
* @brief Clear identity for PEAP/TTLS method.
*/
*/
void esp_wifi_sta_wpa2_ent_clear_identity(void);
void esp_wifi_sta_wpa2_ent_clear_identity(void);
/**
/**
* @brief Set username for PEAP/TTLS method.
* @brief Set username for PEAP/TTLS method.
*
*
* @attention The API only passes the parameter username to the global pointer variable in wpa2 enterprise module.
* @attention The API only passes the parameter username to the global pointer variable in wpa2 enterprise module.
*
*
* @param username: point to address where stores the username;
* @param username: point to address where stores the username;
* @param len: length of username, limited to 1~127
* @param len: length of username, limited to 1~127
*
*
* @return
* @return
* - ESP_OK: succeed
* - ESP_OK: succeed
* - ESP_ERR_INVALID_ARG: fail(len <= 0 or len >= 128)
* - ESP_ERR_INVALID_ARG: fail(len <= 0 or len >= 128)
* - ESP_ERR_NO_MEM: fail(internal memory malloc fail)
* - ESP_ERR_NO_MEM: fail(internal memory malloc fail)
*/
*/
esp_err_t esp_wifi_sta_wpa2_ent_set_username(const unsigned char *username, int len);
esp_err_t esp_wifi_sta_wpa2_ent_set_username(const unsigned char *username, int len);
/**
/**
* @brief Clear username for PEAP/TTLS method.
* @brief Clear username for PEAP/TTLS method.
*/
*/
void esp_wifi_sta_wpa2_ent_clear_username(void);
void esp_wifi_sta_wpa2_ent_clear_username(void);
/**
/**
* @brief Set password for PEAP/TTLS method..
* @brief Set password for PEAP/TTLS method..
*
*
* @attention The API only passes the parameter password to the global pointer variable in wpa2 enterprise module.
* @attention The API only passes the parameter password to the global pointer variable in wpa2 enterprise module.
*
*
* @param password: point to address where stores the password;
* @param password: point to address where stores the password;
* @param len: length of password(len > 0)
* @param len: length of password(len > 0)
*
*
* @return
* @return
* - ESP_OK: succeed
* - ESP_OK: succeed
* - ESP_ERR_INVALID_ARG: fail(len <= 0)
* - ESP_ERR_INVALID_ARG: fail(len <= 0)
* - ESP_ERR_NO_MEM: fail(internal memory malloc fail)
* - ESP_ERR_NO_MEM: fail(internal memory malloc fail)
*/
*/
esp_err_t esp_wifi_sta_wpa2_ent_set_password(const unsigned char *password, int len);
esp_err_t esp_wifi_sta_wpa2_ent_set_password(const unsigned char *password, int len);
/**
/**
* @brief Clear password for PEAP/TTLS method..
* @brief Clear password for PEAP/TTLS method..
*/
*/
void esp_wifi_sta_wpa2_ent_clear_password(void);
void esp_wifi_sta_wpa2_ent_clear_password(void);
/**
/**
* @brief Set new password for MSCHAPv2 method..
* @brief Set new password for MSCHAPv2 method..
*
*
* @attention 1. The API only passes the parameter password to the global pointer variable in wpa2 enterprise module.
* @attention 1. The API only passes the parameter password to the global pointer variable in wpa2 enterprise module.
* @attention 2. The new password is used to substitute the old password when eap-mschapv2 failure request message with error code ERROR_PASSWD_EXPIRED is received.
* @attention 2. The new password is used to substitute the old password when eap-mschapv2 failure request message with error code ERROR_PASSWD_EXPIRED is received.
*
*
* @param new_password: point to address where stores the password;
* @param new_password: point to address where stores the password;
* @param len: length of password
* @param len: length of password
*
*
* @return
* @return
* - ESP_OK: succeed
* - ESP_OK: succeed
* - ESP_ERR_INVALID_ARG: fail(len <= 0)
* - ESP_ERR_INVALID_ARG: fail(len <= 0)
* - ESP_ERR_NO_MEM: fail(internal memory malloc fail)
* - ESP_ERR_NO_MEM: fail(internal memory malloc fail)
*/
*/
esp_err_t esp_wifi_sta_wpa2_ent_set_new_password(const unsigned char *new_password, int len);
esp_err_t esp_wifi_sta_wpa2_ent_set_new_password(const unsigned char *new_password, int len);
/**
/**
* @brief Clear new password for MSCHAPv2 method..
* @brief Clear new password for MSCHAPv2 method..
*/
*/
void esp_wifi_sta_wpa2_ent_clear_new_password(void);
void esp_wifi_sta_wpa2_ent_clear_new_password(void);
/**
/**
* @brief Set CA certificate for PEAP/TTLS method.
* @brief Set CA certificate for PEAP/TTLS method.
*
*
* @attention 1. The API only passes the parameter ca_cert to the global pointer variable in wpa2 enterprise module.
* @attention 1. The API only passes the parameter ca_cert to the global pointer variable in wpa2 enterprise module.
* @attention 2. The ca_cert should be zero terminated.
* @attention 2. The ca_cert should be zero terminated.
*
*
* @param ca_cert: point to address where stores the CA certificate;
* @param ca_cert: point to address where stores the CA certificate;
* @param ca_cert_len: length of ca_cert
* @param ca_cert_len: length of ca_cert
*
*
* @return
* @return
* - ESP_OK: succeed
* - ESP_OK: succeed
*/
*/
esp_err_t esp_wifi_sta_wpa2_ent_set_ca_cert(const unsigned char *ca_cert, int ca_cert_len);
esp_err_t esp_wifi_sta_wpa2_ent_set_ca_cert(const unsigned char *ca_cert, int ca_cert_len);
/**
/**
* @brief Clear CA certificate for PEAP/TTLS method.
* @brief Clear CA certificate for PEAP/TTLS method.
*/
*/
void esp_wifi_sta_wpa2_ent_clear_ca_cert(void);
void esp_wifi_sta_wpa2_ent_clear_ca_cert(void);
/**
/**
* @brief Set client certificate and key.
* @brief Set client certificate and key.
*
*
* @attention 1. The API only passes the parameter client_cert, private_key and private_key_passwd to the global pointer variable in wpa2 enterprise module.
* @attention 1. The API only passes the parameter client_cert, private_key and private_key_passwd to the global pointer variable in wpa2 enterprise module.
* @attention 2. The client_cert, private_key and private_key_passwd should be zero terminated.
* @attention 2. The client_cert, private_key and private_key_passwd should be zero terminated.
*
*
* @param client_cert: point to address where stores the client certificate;
* @param client_cert: point to address where stores the client certificate;
* @param client_cert_len: length of client certificate;
* @param client_cert_len: length of client certificate;
* @param private_key: point to address where stores the private key;
* @param private_key: point to address where stores the private key;
* @param private_key_len: length of private key, limited to 1~2048;
* @param private_key_len: length of private key, limited to 1~2048;
* @param private_key_password: point to address where stores the private key password;
* @param private_key_password: point to address where stores the private key password;
* @param private_key_password_len: length of private key password;
* @param private_key_password_len: length of private key password;
*
*
* @return
* @return
* - ESP_OK: succeed
* - ESP_OK: succeed
*/
*/
esp_err_t esp_wifi_sta_wpa2_ent_set_cert_key(const unsigned char *client_cert, int client_cert_len, const unsigned char *private_key, int private_key_len, const unsigned char *private_key_passwd, int private_key_passwd_len);
esp_err_t esp_wifi_sta_wpa2_ent_set_cert_key(const unsigned char *client_cert, int client_cert_len, const unsigned char *private_key, int private_key_len, const unsigned char *private_key_passwd, int private_key_passwd_len);
/**
/**
* @brief Clear client certificate and key.
* @brief Clear client certificate and key.
*/
*/
void esp_wifi_sta_wpa2_ent_clear_cert_key(void);
void esp_wifi_sta_wpa2_ent_clear_cert_key(void);
/**
/**
* @brief Set wpa2 enterprise certs time check(disable or not).
* @brief Set wpa2 enterprise certs time check(disable or not).
*
*
* @param true: disable wpa2 enterprise certs time check
* @param true: disable wpa2 enterprise certs time check
* @param false: enable wpa2 enterprise certs time check
* @param false: enable wpa2 enterprise certs time check
*
*
* @return
* @return
* - ESP_OK: succeed
* - ESP_OK: succeed
*/
*/
esp_err_t esp_wifi_sta_wpa2_ent_set_disable_time_check(bool disable);
esp_err_t esp_wifi_sta_wpa2_ent_set_disable_time_check(bool disable);
/**
/**
* @brief Get wpa2 enterprise certs time check(disable or not).
* @brief Get wpa2 enterprise certs time check(disable or not).
*
*
* @param disable: store disable value
* @param disable: store disable value
*
*
* @return
* @return
* - ESP_OK: succeed
* - ESP_OK: succeed
*/
*/
esp_err_t esp_wifi_sta_wpa2_ent_get_disable_time_check(bool *disable);
esp_err_t esp_wifi_sta_wpa2_ent_get_disable_time_check(bool *disable);
/**
* @brief Set wpa2 enterprise ttls phase2 method
*
* @param type: the type of phase 2 method to be used
*
* @return
* - ESP_OK: succeed
*/
esp_err_t esp_wifi_sta_wpa2_ent_set_ttls_phase2_method(esp_eap_ttls_phase2_types type);
/**
* @brief enable/disable 192 bit suite b certification checks
*
* @param enable: bool to enable/disable it.
*
* @return
* - ESP_OK: succeed
*/
esp_err_t esp_wifi_sta_wpa2_set_suiteb_192bit_certification(bool enable);
#ifdef __cplusplus
#ifdef __cplusplus
}
}
#endif
#endif
#endif
#endif