From 03e9656ce08701e6bd09aeb5db423cbe0cf60db0 Mon Sep 17 00:00:00 2001 From: Sarvesh Bodakhe Date: Mon, 17 Feb 2025 16:47:22 +0530 Subject: [PATCH] docs: Add migration guide for WPA3-Enterprise authentication modes for v5.4 --- .../migration-guides/release-5.x/5.4/wifi.rst | 25 +++++++++++++++++++ .../migration-guides/release-5.x/5.4/wifi.rst | 24 ++++++++++++++++++ 2 files changed, 49 insertions(+) diff --git a/docs/en/migration-guides/release-5.x/5.4/wifi.rst b/docs/en/migration-guides/release-5.x/5.4/wifi.rst index ddcc2c49f1..76fb84f7fa 100644 --- a/docs/en/migration-guides/release-5.x/5.4/wifi.rst +++ b/docs/en/migration-guides/release-5.x/5.4/wifi.rst @@ -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``. diff --git a/docs/zh_CN/migration-guides/release-5.x/5.4/wifi.rst b/docs/zh_CN/migration-guides/release-5.x/5.4/wifi.rst index ed9be5db8d..03437db2f6 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.4/wifi.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.4/wifi.rst @@ -20,5 +20,29 @@ Wi-Fi 扫描和连接 - ``bandwidth`` 的类型从 ``uint8_t`` 更改为 ``wifi_bandwidth_t`` +重大更新 +~~~~~~~~ + +WPA3 企业版 Wi‑Fi 认证模式更改 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +在 ESP‑IDF v5.4 之前，支持 WPA3‑Enterprise‑Only 和 WPA3‑Enterprise‑Transition 的接入点（AP）的认证模式（``wifi_auth_mode_t``）均被识别为 ``WIFI_AUTH_WPA2_ENTERPRISE``. + +从 v5.4 开始，该行为已更新： + +- 支持 **WPA3‑Enterprise‑Only** 模式的AP现在被检测时，其 ``wifi_auth_mode_t`` 设置为 ``WIFI_AUTH_WPA3_ENTERPRISE``. +- 支持 **WPA3‑Enterprise‑Transition** 模式的AP被检测时，其 ``wifi_auth_mode_t`` 设置为 ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE``. + +.. note:: + + **对应用程序的影响** + + 如果您的应用程序严格检查 ``WIFI_AUTH_WPA2_ENTERPRISE`` 或 ``WIFI_AUTH_ENTERPRISE`` 来识别企业级 AP，则无法识别以 WPA3‑Enterprise‑Only 或 WPA3‑Enterprise‑Transition 模式运行的 AP. + **建议操作** + + 为确保与这些模式兼容，请更新您的应用程序关于认证模式的检查逻辑，将新的 ``WIFI_AUTH_WPA3_ENTERPRISE`` 和 ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE`` 模式包含进来. + + 这可能涉及更新条件判断语句或认证流程，以涵盖 ``WIFI_AUTH_WPA3_ENTERPRISE`` 和 ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE`` 的情况. +