docs: Add migration guide for WPA3-Enterprise authentication modes for v5.4

This commit is contained in:
Sarvesh Bodakhe
2025-02-21 16:58:04 +05:30
committed by Nachiket Kukade
parent aa97a0fc3c
commit 03e9656ce0
2 changed files with 49 additions and 0 deletions
@@ -20,3 +20,28 @@ Wi-Fi Scan and Connect
- :cpp:struct:`wifi_ap_record_t`:
- The type of ``bandwidth`` has been changed from ``uint8_t`` to ``wifi_bandwidth_t``
Breaking Changes
~~~~~~~~~~~~~~~~
Wi-Fi Authentication Mode Changes for WPA3-Enterprise
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In ESP-IDF versions prior to v5.4, the authentication mode (``wifi_auth_mode_t``) for Access Points (APs) supporting WPA3-Enterprise-Only and WPA3-Enterprise-Transition was identified as ``WIFI_AUTH_WPA2_ENTERPRISE``.
Starting from v5.4, this behavior has been updated:
- APs supporting **WPA3-Enterprise-Only** mode are now detected with ``wifi_auth_mode_t`` set to ``WIFI_AUTH_WPA3_ENTERPRISE``.
- APs supporting **WPA3-Enterprise-Transition** mode are detected with ``wifi_auth_mode_t`` set to ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE``.
.. note::
**Impact on Applications**
If your application strictly checks for ``WIFI_AUTH_WPA2_ENTERPRISE`` or ``WIFI_AUTH_ENTERPRISE`` to identify enterprise APs, it will not recognize APs operating in WPA3-Enterprise-Only or WPA3-Enterprise-Transition modes.
**Recommended Action**
To ensure compatibility with these modes, update your application's authentication mode checks to include the new ``WIFI_AUTH_WPA3_ENTERPRISE`` and ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE`` modes.
This may involve updating conditional statements or authentication procedures to account for ``WIFI_AUTH_WPA3_ENTERPRISE`` and ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE``.