Skip to content

Commit 1633c1a

Browse files
author
Jiang Jiang Jian
committed
Merge branch 'docs/wifi_wpa3_ent_migration_guide_v5.4' into 'master'
docs(wifi): Add migration guide for WPA3-Enterprise authentication modes for v5.4 See merge request espressif/esp-idf!36827
2 parents a38893d + 9ed5ea1 commit 1633c1a

File tree

2 files changed

+52
-0
lines changed
  • docs
    • en/migration-guides/release-5.x/5.4
    • zh_CN/migration-guides/release-5.x/5.4

2 files changed

+52
-0
lines changed

docs/en/migration-guides/release-5.x/5.4/wifi.rst

+25
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,28 @@ Wi-Fi Scan and Connect
2020
- :cpp:struct:`wifi_ap_record_t`:
2121

2222
- The type of ``bandwidth`` has been changed from ``uint8_t`` to ``wifi_bandwidth_t``
23+
24+
Breaking Changes
25+
~~~~~~~~~~~~~~~~
26+
27+
Wi-Fi Authentication Mode Changes for WPA3-Enterprise
28+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
29+
30+
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``.
31+
32+
Starting from v5.4, this behavior has been updated:
33+
34+
- APs supporting **WPA3-Enterprise-Only** mode are now detected with ``wifi_auth_mode_t`` set to ``WIFI_AUTH_WPA3_ENTERPRISE``.
35+
- APs supporting **WPA3-Enterprise-Transition** mode are detected with ``wifi_auth_mode_t`` set to ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE``.
36+
37+
.. note::
38+
39+
**Impact on Applications**
40+
41+
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.
42+
43+
**Recommended Action**
44+
45+
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.
46+
47+
This may involve updating conditional statements or authentication procedures to account for ``WIFI_AUTH_WPA3_ENTERPRISE`` and ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE``.

docs/zh_CN/migration-guides/release-5.x/5.4/wifi.rst

+27
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,30 @@ Wi-Fi 扫描和连接
2020
- :cpp:struct:`wifi_ap_record_t` 中:
2121

2222
- ``bandwidth`` 的类型从 ``uint8_t`` 更改为 ``wifi_bandwidth_t``
23+
24+
重大更新
25+
~~~~~~~~
26+
27+
WPA3 企业版 Wi‑Fi 认证模式更改
28+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
29+
30+
在 ESP‑IDF v5.4 之前,支持 WPA3‑Enterprise‑Only 和 WPA3‑Enterprise‑Transition 的接入点(AP)的认证模式(``wifi_auth_mode_t``)均被识别为 ``WIFI_AUTH_WPA2_ENTERPRISE``.
31+
32+
从 v5.4 开始,该行为已更新:
33+
34+
- 支持 **WPA3‑Enterprise‑Only** 模式的AP现在被检测时,其 ``wifi_auth_mode_t`` 设置为 ``WIFI_AUTH_WPA3_ENTERPRISE``.
35+
- 支持 **WPA3‑Enterprise‑Transition** 模式的AP被检测时,其 ``wifi_auth_mode_t`` 设置为 ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE``.
36+
37+
.. note::
38+
39+
**对应用程序的影响**
40+
41+
如果您的应用程序严格检查 ``WIFI_AUTH_WPA2_ENTERPRISE`` 或 ``WIFI_AUTH_ENTERPRISE`` 来识别企业级 AP,则无法识别以 WPA3‑Enterprise‑Only 或 WPA3‑Enterprise‑Transition 模式运行的 AP.
42+
43+
44+
**建议操作**
45+
46+
为确保与这些模式兼容,请更新您的应用程序关于认证模式的检查逻辑,将新的 ``WIFI_AUTH_WPA3_ENTERPRISE`` 和 ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE`` 模式包含进来.
47+
48+
这可能涉及更新条件判断语句或认证流程,以涵盖 ``WIFI_AUTH_WPA3_ENTERPRISE`` 和 ``WIFI_AUTH_WPA2_WPA3_ENTERPRISE`` 的情况.
49+

0 commit comments

Comments
 (0)