change(example): Update wifi enterprise example

examples/wifi/wifi_enterprise/README.md

@@ -1,7 +1,16 @@
 | Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-S2 | ESP32-S3 |
 | ----------------- | ----- | -------- | -------- | -------- | -------- | -------- |
 
-# WPA2 Enterprise Example
+
+# Understanding different WiFi enterprise modes:
+
+**WPA2 Enterprise**: WPA2-Enterprise is an advanced Wi-Fi security mode primarily used in business environments. It employs a RADIUS server for user-based authentication, supporting various EAP methods like EAP-TLS and EAP-PEAP. This mode enhances security by requiring individual user credentials, establishes secure encryption keys, and allows for efficient user management. It's a scalable and robust solution ideal for large-scale networks seeking strong protection against unauthorized access.
+
+**WPA3 Enterprise**: WPA2-Enterprise + PMF mandatory + CA certificate validaion(required)
+
+**WPA3 Enterprise(192 bit)**: WPA3 Enterprise + AES256 Keys(GCMP256/CCMP256) + BIP256 + RSA3096/EC certs + NSA SuiteB ciphers in EAP authentication.
+
+# WiFi Enterprise Example
 
 This example shows how ESP32 connects to AP with Wi-Fi enterprise encryption. The example does the following steps:
 
@@ -9,8 +18,8 @@ This example shows how ESP32 connects to AP with Wi-Fi enterprise encryption. Th
 2. Install client certificate and client key which is required in TLS method and optional in PEAP and TTLS methods.
 3. Set identity of phase 1 which is optional.
 4. Set user name and password of phase 2 which is required in PEAP and TTLS methods.
-5. Enable wpa2 enterprise.
+5. Enable WiFi enterprise mode.
-6. Connect to AP.
+6. Connect to AP using esp_wifi_connect().
 
 *Note:* 
 1. The certificates currently are generated and are present in examples/wifi/wifi_enterprise/main folder.
@@ -93,25 +102,100 @@ idf.py -p PORT flash monitor
 
 ### Example output
 
-Here is an example of wpa2 enterprise(PEAP method) console output.
+I (31) boot: ESP-IDF v5.2-dev-2787-g40cf6433be-dirty 2nd stage bootloader
-```
+I (31) boot: compile time Sep 12 2023 13:39:03
-I (1352) example: Setting WiFi configuration SSID wpa2_test...
+I (33) boot: Multicore bootloader
-I (1362) wpa: WPA2 ENTERPRISE VERSION: [v2.0] enable
+I (38) boot: chip revision: v3.0
+I (41) boot.esp32: SPI Speed      : 40MHz
+I (46) boot.esp32: SPI Mode       : DIO
+I (51) boot.esp32: SPI Flash Size : 2MB
+I (55) boot: Enabling RNG early entropy source...
+I (61) boot: Partition Table:
+I (64) boot: ## Label            Usage          Type ST Offset   Length
+I (71) boot:  0 nvs              WiFi data        01 02 00009000 00006000
+I (79) boot:  1 phy_init         RF data          01 01 0000f000 00001000
+I (86) boot:  2 factory          factory app      00 00 00010000 00100000
+I (94) boot: End of partition table
+I (98) esp_image: segment 0: paddr=00010020 vaddr=3f400020 size=2aa0ch (174604) map
+I (170) esp_image: segment 1: paddr=0003aa34 vaddr=3ffb0000 size=037a0h ( 14240) load
+I (175) esp_image: segment 2: paddr=0003e1dc vaddr=40080000 size=01e3ch (  7740) load
+I (179) esp_image: segment 3: paddr=00040020 vaddr=400d0020 size=954c8h (611528) map
+I (405) esp_image: segment 4: paddr=000d54f0 vaddr=40081e3c size=13de0h ( 81376) load
+I (449) boot: Loaded app from partition at offset 0x10000
+I (450) boot: Disabling RNG early entropy source...
+I (461) cpu_start: Multicore app
+I (461) cpu_start: Pro cpu up.
+I (462) cpu_start: Starting app cpu, entry point is 0x400811e0
+I (0) cpu_start: App cpu up.
+I (479) cpu_start: Pro cpu start user code
+I (479) cpu_start: cpu freq: 160000000 Hz
+I (479) cpu_start: Application information:
+I (484) cpu_start: Project name:     wifi_enterprise
+I (490) cpu_start: App version:      c6_h2_rng_final_tests-2032-g40c
+I (497) cpu_start: Compile time:     Sep 12 2023 13:38:55
+I (503) cpu_start: ELF file SHA256:  8d1ba00d3...
+I (508) cpu_start: ESP-IDF:          v5.2-dev-2787-g40cf6433be-dirty
+I (515) cpu_start: Min chip rev:     v0.0
+I (520) cpu_start: Max chip rev:     v3.99 
+I (525) cpu_start: Chip rev:         v3.0
+I (530) heap_init: Initializing. RAM available for dynamic allocation:
+I (537) heap_init: At 3FFAE6E0 len 00001920 (6 KiB): DRAM
+I (543) heap_init: At 3FFB7A20 len 000285E0 (161 KiB): DRAM
+I (549) heap_init: At 3FFE0440 len 00003AE0 (14 KiB): D/IRAM
+I (555) heap_init: At 3FFE4350 len 0001BCB0 (111 KiB): D/IRAM
+I (562) heap_init: At 40095C1C len 0000A3E4 (40 KiB): IRAM
+I (570) spi_flash: detected chip: generic
+I (573) spi_flash: flash io: dio
+W (577) spi_flash: Detected size(8192k) larger than the size in the binary image header(2048k). Using the size in the binary image header.
+I (591) app_start: Starting scheduler on CPU0
+I (595) app_start: Starting scheduler on CPU1
+I (595) main_task: Started on CPU0
+I (605) main_task: Calling app_main()
+I (635) wifi:wifi driver task: 3ffbf930, prio:23, stack:6656, core=0
+I (635) wifi:wifi firmware version: e03c1ca
+I (635) wifi:wifi certification version: v7.0
+I (635) wifi:config NVS flash: enabled
+I (635) wifi:config nano formating: disabled
+I (645) wifi:Init data frame dynamic rx buffer num: 32
+I (645) wifi:Init management frame dynamic rx buffer num: 32
+I (655) wifi:Init management short buffer num: 32
+I (655) wifi:Init dynamic tx buffer num: 32
+I (665) wifi:Init static rx buffer size: 1600
+I (665) wifi:Init static rx buffer num: 10
+I (665) wifi:Init dynamic rx buffer num: 32
+I (675) wifi_init: rx ba win: 6
+I (675) wifi_init: tcpip mbox: 32
+I (675) wifi_init: udp mbox: 6
+I (685) wifi_init: tcp mbox: 6
+I (685) wifi_init: tcp tx win: 5744
+I (695) wifi_init: tcp rx win: 5744
+I (695) wifi_init: tcp mss: 1440
+I (695) wifi_init: WiFi IRAM OP enabled
+I (705) wifi_init: WiFi RX IRAM OP enabled
+I (705) example: Setting WiFi configuration SSID ESP_ENTERPRISE_AP...
+I (715) wpa: WiFi Enterprise enable
+I (725) phy_init: phy_version 4771,450c73b,Aug 16 2023,11:03:10
+I (835) wifi:mode : sta (e0:e2:e6:6a:7c:20)
+I (845) wifi:enable tsf
+I (845) main_task: Returned from app_main()
+I (1465) wpa: BSS: Add new id 0 BSSID 38:94:ed:34:07:66 SSID 'ESP_ENTERPRISE_AP' chan 6
+I (1465) wifi:new:<6,0>, old:<1,0>, ap:<255,255>, sta:<6,0>, prof:1
+I (7385) wifi:state: init -> auth (b0)
+I (7395) wifi:state: auth -> assoc (0)
+I (7405) wifi:state: assoc -> run (10)
+I (7405) wpa: wifi_task prio:7, stack:6656
+I (7495) wpa: len=5 not available in input
+I (7555) wpa: SSL: Need 1595 bytes more input data
+I (7605) wpa: SSL: Need 601 bytes more input data
+I (8575) wpa: len=5 not available in input
+I (8695) wpa: application data is null, adding one byte for ack
+I (8725) wpa: >>>>>EAP FINISH
+I (8785) wifi:connected with ESP_ENTERPRISE_AP, aid = 1, channel 6, BW20, bssid = 38:94:ed:34:07:66
+I (8785) wifi:security: WPA2-ENT, phy: bgn, rssi: -22
+I (8785) wifi:pm start, type: 1
 
-I (1362) wifi: rx_ba=1 tx_ba=1
+I (8795) wifi:AP's beacon interval = 102400 us, DTIM period = 3
 
-I (1372) wifi: mode : sta (24:0a:c4:03:b8:dc)
-I (3002) wifi: n:11 0, o:1 0, ap:255 255, sta:11 0, prof:11
-I (3642) wifi: state: init -> auth (b0)
-I (3642) wifi: state: auth -> assoc (0)
-I (3652) wifi: state: assoc -> run (10)
-I (3652) wpa: wpa2_task prio:24, stack:6144
-
-I (3972) wpa: >>>>>wpa2 FINISH
-
-I (3982) wpa: wpa2 task delete
-
-I (3992) wifi: connected with wpa2_test, channel 11
 I (5372) example: ~~~~~~~~~~~
 I (5372) example: IP:0.0.0.0
 I (5372) example: MASK:0.0.0.0

examples/wifi/wifi_enterprise/main/Kconfig.projbuild

@@ -2,15 +2,15 @@ menu "Example Configuration"
 
     config EXAMPLE_WIFI_SSID
         string "WiFi SSID"
-        default "wpa2_test"
+        default "ESP_ENTERPRISE_AP"
         help
             SSID (network name) for the example to connect to.
 
     choice
         prompt "Enterprise configuration to be used"
-        default EXAMPLE_WPA_WPA2_ENTERPRISE
+        default EXAMPLE_WPA3_ENTERPRISE
-        config EXAMPLE_WPA_WPA2_ENTERPRISE
+        config EXAMPLE_WPA2_ENTERPRISE
-            bool "WPA_WPA2_ENT"
+            bool "WPA2_ENT"
         config EXAMPLE_WPA3_ENTERPRISE
             bool "WPA3_ENT"
         config EXAMPLE_WPA3_192BIT_ENTERPRISE
@@ -21,7 +21,7 @@ menu "Example Configuration"
             select ESP_WIFI_SUITE_B_192
     endchoice
 
-    if EXAMPLE_WPA_WPA2_ENTERPRISE
+    if EXAMPLE_WPA2_ENTERPRISE
         config EXAMPLE_VALIDATE_SERVER_CERT
             bool "Validate server"
             default y
@@ -29,21 +29,14 @@ menu "Example Configuration"
                 Validate the servers' certificate using CA cert.
     endif
 
-    if !EXAMPLE_WPA_WPA2_ENTERPRISE
+    if !EXAMPLE_WPA2_ENTERPRISE
         config EXAMPLE_VALIDATE_SERVER_CERT
             default y
     endif
 
-    config EXAMPLE_USE_DEFAULT_CERT_BUNDLE
-        bool "Use default cert bundle"
-        depends on EXAMPLE_VALIDATE_SERVER_CERT
-        default n
-        help
-            Use default CA certificate bundle for WPA enterprise connection
-
     choice
         prompt "EAP method for the example to use"
-        default EXAMPLE_EAP_METHOD_PEAP
+        default EXAMPLE_EAP_METHOD_TLS
         config EXAMPLE_EAP_METHOD_TLS
             bool "TLS"
         config EXAMPLE_EAP_METHOD_PEAP
@@ -90,13 +83,19 @@ menu "Example Configuration"
         depends on EXAMPLE_EAP_METHOD_PEAP || EXAMPLE_EAP_METHOD_TTLS
         default "espressif"
         help
-            Username for EAP method (PEAP and TTLS).
+            Username for EAP method (valid for PEAP and TTLS).
 
     config EXAMPLE_EAP_PASSWORD
         string "EAP PASSWORD"
         depends on EXAMPLE_EAP_METHOD_PEAP || EXAMPLE_EAP_METHOD_TTLS
         default "test11"
         help
-            Password for EAP method (PEAP and TTLS).
+            Password for EAP method (valid for PEAP and TTLS).
 
+    config EXAMPLE_USE_DEFAULT_CERT_BUNDLE
+        bool "Use default cert bundle"
+        depends on EXAMPLE_VALIDATE_SERVER_CERT
+        default n
+        help
+            Use default CA certificate bundle for WiFi enterprise connection
 endmenu

examples/wifi/wifi_enterprise/main/wifi_enterprise_main.c

@@ -1,28 +1,17 @@
-/* WiFi Connection Example using WPA2 Enterprise
+/*
+ * SPDX-FileCopyrightText: 2006-2016 ARM Limited
+ * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD
  *
- * Original Copyright (C) 2006-2016, ARM Limited, All Rights Reserved, Apache 2.0 License.
+ * SPDX-License-Identifier: Apache-2.0
- * Additions Copyright (C) Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD, Apache 2.0 License.
- *
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * 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.
  */
+
 #include <string.h>
 #include <stdlib.h>
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
 #include "freertos/event_groups.h"
 #include "esp_wifi.h"
-#include "esp_wpa2.h"
+#include "esp_eap_client.h"
 #include "esp_event.h"
 #include "esp_log.h"
 #include "esp_system.h"
@@ -63,7 +52,7 @@ static const char *TAG = "example";
    Client key, taken from client.key
 
    The PEM, CRT and KEY file were provided by the person or organization
-   who configured the AP with wpa2 enterprise.
+   who configured the AP with wifi enterprise.
 
    To embed it in the app binary, the PEM, CRT and KEY file is named
    in the component.mk COMPONENT_EMBED_TXTFILES variable.
@@ -115,14 +104,14 @@ static void initialise_wifi(void)
     assert(sta_netif);
 
     wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
-    ESP_ERROR_CHECK( esp_wifi_init(&cfg) );
+    ESP_ERROR_CHECK(esp_wifi_init(&cfg));
-    ESP_ERROR_CHECK( esp_event_handler_register(WIFI_EVENT, ESP_EVENT_ANY_ID, &event_handler, NULL) );
+    ESP_ERROR_CHECK(esp_event_handler_register(WIFI_EVENT, ESP_EVENT_ANY_ID, &event_handler, NULL));
-    ESP_ERROR_CHECK( esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &event_handler, NULL) );
+    ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &event_handler, NULL));
-    ESP_ERROR_CHECK( esp_wifi_set_storage(WIFI_STORAGE_RAM) );
+    ESP_ERROR_CHECK(esp_wifi_set_storage(WIFI_STORAGE_RAM));
     wifi_config_t wifi_config = {
         .sta = {
             .ssid = EXAMPLE_WIFI_SSID,
-#if defined (CONFIG_EXAMPLE_WPA3_192BIT_ENTERPRISE)
+#if defined (CONFIG_EXAMPLE_WPA3_192BIT_ENTERPRISE) || defined (CONFIG_EXAMPLE_WPA3_ENTERPRISE)
             .pmf_cfg = {
                 .required = true
             },
@@ -130,41 +119,43 @@ static void initialise_wifi(void)
         },
     };
     ESP_LOGI(TAG, "Setting WiFi configuration SSID %s...", wifi_config.sta.ssid);
-    ESP_ERROR_CHECK( esp_wifi_set_mode(WIFI_MODE_STA) );
+    ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA) );
-    ESP_ERROR_CHECK( esp_wifi_set_config(WIFI_IF_STA, &wifi_config) );
+    ESP_ERROR_CHECK(esp_wifi_set_config(WIFI_IF_STA, &wifi_config) );
-    ESP_ERROR_CHECK( esp_wifi_sta_wpa2_ent_set_identity((uint8_t *)EXAMPLE_EAP_ID, strlen(EXAMPLE_EAP_ID)) );
+    ESP_ERROR_CHECK(esp_eap_client_set_identity((uint8_t *)EXAMPLE_EAP_ID, strlen(EXAMPLE_EAP_ID)) );
 
 #if defined(CONFIG_EXAMPLE_VALIDATE_SERVER_CERT) || \
     defined(CONFIG_EXAMPLE_WPA3_ENTERPRISE) || \
     defined(CONFIG_EXAMPLE_WPA3_192BIT_ENTERPRISE)
-    ESP_ERROR_CHECK( esp_wifi_sta_wpa2_ent_set_ca_cert(ca_pem_start, ca_pem_bytes) );
+    ESP_ERROR_CHECK(esp_eap_client_set_ca_cert(ca_pem_start, ca_pem_bytes) );
 #endif /* CONFIG_EXAMPLE_VALIDATE_SERVER_CERT */ /* EXAMPLE_WPA3_ENTERPRISE */
 
 #ifdef CONFIG_EXAMPLE_EAP_METHOD_TLS
-    ESP_ERROR_CHECK( esp_wifi_sta_wpa2_ent_set_cert_key(client_crt_start, client_crt_bytes,\
+    ESP_ERROR_CHECK(esp_eap_client_set_certificate_and_key(client_crt_start, client_crt_bytes,
-    		client_key_start, client_key_bytes, NULL, 0) );
+                                      client_key_start, client_key_bytes, NULL, 0) );
 #endif /* CONFIG_EXAMPLE_EAP_METHOD_TLS */
 
-#if defined CONFIG_EXAMPLE_EAP_METHOD_PEAP || CONFIG_EXAMPLE_EAP_METHOD_TTLS
+#if defined (CONFIG_EXAMPLE_EAP_METHOD_PEAP) || \
-    ESP_ERROR_CHECK( esp_wifi_sta_wpa2_ent_set_username((uint8_t *)EXAMPLE_EAP_USERNAME, strlen(EXAMPLE_EAP_USERNAME)) );
+    defined (CONFIG_EXAMPLE_EAP_METHOD_TTLS)
-    ESP_ERROR_CHECK( esp_wifi_sta_wpa2_ent_set_password((uint8_t *)EXAMPLE_EAP_PASSWORD, strlen(EXAMPLE_EAP_PASSWORD)) );
+    ESP_ERROR_CHECK(esp_eap_client_set_username((uint8_t *)EXAMPLE_EAP_USERNAME, strlen(EXAMPLE_EAP_USERNAME)) );
+    ESP_ERROR_CHECK(esp_eap_client_set_password((uint8_t *)EXAMPLE_EAP_PASSWORD, strlen(EXAMPLE_EAP_PASSWORD)) );
 #endif /* CONFIG_EXAMPLE_EAP_METHOD_PEAP || CONFIG_EXAMPLE_EAP_METHOD_TTLS */
 
 #if defined CONFIG_EXAMPLE_EAP_METHOD_TTLS
-    ESP_ERROR_CHECK( esp_wifi_sta_wpa2_ent_set_ttls_phase2_method(TTLS_PHASE2_METHOD) );
+    ESP_ERROR_CHECK(esp_eap_client_set_ttls_phase2_method(TTLS_PHASE2_METHOD) );
 #endif /* CONFIG_EXAMPLE_EAP_METHOD_TTLS */
+
 #if defined (CONFIG_EXAMPLE_WPA3_192BIT_ENTERPRISE)
     ESP_LOGI(TAG, "Enabling 192 bit certification");
-    ESP_ERROR_CHECK(esp_wifi_sta_wpa2_set_suiteb_192bit_certification(true));
+    ESP_ERROR_CHECK(esp_eap_client_set_suiteb_192bit_certification(true));
 #endif
 #ifdef CONFIG_EXAMPLE_USE_DEFAULT_CERT_BUNDLE
-    ESP_ERROR_CHECK(esp_wifi_sta_wpa2_use_default_cert_bundle(true));
+    ESP_ERROR_CHECK(esp_eap_client_use_default_cert_bundle(true));
 #endif
-    ESP_ERROR_CHECK( esp_wifi_sta_wpa2_ent_enable() );
+    ESP_ERROR_CHECK(esp_wifi_sta_enterprise_enable());
-    ESP_ERROR_CHECK( esp_wifi_start() );
+    ESP_ERROR_CHECK(esp_wifi_start());
 }
 
-static void wpa2_enterprise_example_task(void *pvParameters)
+static void wifi_enterprise_example_task(void *pvParameters)
 {
     esp_netif_ip_info_t ip;
     memset(&ip, 0, sizeof(esp_netif_ip_info_t));
@@ -185,7 +176,7 @@ static void wpa2_enterprise_example_task(void *pvParameters)
 
 void app_main(void)
 {
-    ESP_ERROR_CHECK( nvs_flash_init() );
+    ESP_ERROR_CHECK(nvs_flash_init());
     initialise_wifi();
-    xTaskCreate(&wpa2_enterprise_example_task, "wpa2_enterprise_example_task", 4096, NULL, 5, NULL);
+    xTaskCreate(&wifi_enterprise_example_task, "wifi_enterprise_example_task", 4096, NULL, 5, NULL);
 }

tools/ci/check_copyright_ignore.txt

@@ -1305,7 +1305,6 @@ examples/wifi/roaming/main/roaming_example.c
 examples/wifi/scan/main/scan.c
 examples/wifi/smart_config/main/smartconfig_main.c
 examples/wifi/wifi_easy_connect/dpp-enrollee/main/dpp_enrollee_main.c
-examples/wifi/wifi_enterprise/main/wifi_enterprise_main.c
 examples/wifi/wps/main/wps.c
 tools/ble/lib_ble_client.py
 tools/ble/lib_gap.py