Skip to content

Commit

Permalink
Merge branch 'doc/update_espnow_doc' into 'master'
Browse files Browse the repository at this point in the history
docs(wifi): Updated the LMK description in ESP-NOW

Closes IDFGH-11890

See merge request espressif/esp-idf!29607
  • Loading branch information
MaxwellAlan committed Mar 14, 2024
2 parents 5a682c3 + 68c887e commit a98e252
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/en/api-reference/network/esp_now.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ As ESP-NOW is connectionless, the MAC header is a little different from that of
Security
--------

ESP-NOW uses the CCMP method, which is described in IEEE Std. 802.11-2012, to protect the vendor-specific action frame. The Wi-Fi device maintains a Primary Master Key (PMK) and several Local Master Keys (LMK). The lengths of both PMK and LMk are 16 bytes.
ESP-NOW uses the CCMP method, which is described in IEEE Std. 802.11-2012, to protect the vendor-specific action frame. The Wi-Fi device maintains a Primary Master Key (PMK) and several Local Master Keys (LMKs, each paired device has one LMK). The lengths of both PMK and LMK are 16 bytes.

* PMK is used to encrypt LMK with the AES-128 algorithm. Call :cpp:func:`esp_now_set_pmk()` to set PMK. If PMK is not set, a default PMK will be used.
* LMK of the paired device is used to encrypt the vendor-specific action frame with the CCMP method. The maximum number of different LMKs is six. If the LMK of the paired device is not set, the vendor-specific action frame will not be encrypted.
* LMK of the paired device is used to encrypt the vendor-specific action frame with the CCMP method. If the LMK of the paired device is not set, the vendor-specific action frame will not be encrypted.

Encrypting multicast vendor-specific action frame is not supported.

Expand Down
4 changes: 2 additions & 2 deletions docs/zh_CN/api-reference/network/esp_now.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ ESP-NOW 使用各个供应商的动作帧传输数据,默认比特率为 1 Mbp
安全
--------

ESP-NOW 采用 CCMP 方法保护供应商特定动作帧的安全,具体可参考 IEEE Std. 802.11-2012。Wi-Fi 设备维护一个初始主密钥 (PMK) 和若干本地主密钥 (LMK),长度均为 16 个字节。
ESP-NOW 采用 CCMP 方法保护供应商特定动作帧的安全,具体可参考 IEEE Std. 802.11-2012。Wi-Fi 设备维护一个初始主密钥 (PMK) 和若干本地主密钥 (LMKs,每个配对设备拥有一个 LMK),长度均为 16 个字节。

* PMK 可使用 AES-128 算法加密 LMK。请调用 :cpp:func:`esp_now_set_pmk()` 设置 PMK。如果未设置 PMK,将使用默认 PMK。
* LMK 可通过 CCMP 方法对供应商特定的动作帧进行加密,最多拥有 6 个不同的 LMK。如果未设置配对设备的 LMK,则动作帧不进行加密。
* LMK 可通过 CCMP 方法对供应商特定的动作帧进行加密。如果未设置配对设备的 LMK,则动作帧不进行加密。

目前,不支持加密组播供应商特定的动作帧。

Expand Down

0 comments on commit a98e252

Please sign in to comment.