Merge branch 'docs/wifi_wpa3_ent_migration_guide_backport_v5.4' into 'release/v5.4'

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

See merge request espressif/esp-idf!37189
This commit is contained in:
Jiang Jiang Jian 2025-03-03 11:36:51 +08:00
commit 154b7548cb
2 changed files with 49 additions and 0 deletions

View File

@ -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``.

View File

@ -20,5 +20,29 @@ Wi-Fi 扫描和连接
- ``bandwidth`` 的类型从 ``uint8_t`` 更改为 ``wifi_bandwidth_t``
重大更新
~~~~~~~~
WPA3 企业版 WiFi 认证模式更改
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
在 ESPIDF v5.4 之前,支持 WPA3EnterpriseOnly 和 WPA3EnterpriseTransition 的接入点AP的认证模式``wifi_auth_mode_t``)均被识别为 ``WIFI_AUTH_WPA2_ENTERPRISE``.
从 v5.4 开始,该行为已更新:
- 支持 **WPA3EnterpriseOnly** 模式的AP现在被检测时``wifi_auth_mode_t`` 设置为 ``WIFI_AUTH_WPA3_ENTERPRISE``.
- 支持 **WPA3EnterpriseTransition** 模式的AP被检测时``wifi_auth_mode_t`` 设置为 ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE``.
.. note::
**对应用程序的影响**
如果您的应用程序严格检查 ``WIFI_AUTH_WPA2_ENTERPRISE````WIFI_AUTH_ENTERPRISE`` 来识别企业级 AP则无法识别以 WPA3EnterpriseOnly 或 WPA3EnterpriseTransition 模式运行的 AP.
**建议操作**
为确保与这些模式兼容,请更新您的应用程序关于认证模式的检查逻辑,将新的 ``WIFI_AUTH_WPA3_ENTERPRISE````WIFI_AUTH_WPA2_WPA3_ENTERPRISE`` 模式包含进来.
这可能涉及更新条件判断语句或认证流程,以涵盖 ``WIFI_AUTH_WPA3_ENTERPRISE````WIFI_AUTH_WPA2_WPA3_ENTERPRISE`` 的情况.