refactor: migrate atecc608a_ecdsa example to crypto authlib repository
- ESP32-WROOM-32SE has been discontinued and marked as NRND - This change removes all references to ESP32-WROOM-32SE from IDF - The example has been migrated to esp-cryptoauthlib repository and it can be used through the component manager (https://components.espressif.com/components/espressif/esp-cryptoauthlib)
This commit is contained in:
Mahavir Jain
@@ -154,7 +154,6 @@ ESP32_DOCS = ['api-reference/system/himem.rst',
|
||||
'api-guides/romconsole.rst',
|
||||
'api-reference/system/ipc.rst',
|
||||
'security/secure-boot-v1.rst',
|
||||
'api-reference/peripherals/secure_element.rst',
|
||||
'api-reference/peripherals/dac.rst',
|
||||
'api-reference/peripherals/sd_pullup_requirements.rst',
|
||||
'hw-reference/esp32/**',
|
||||
|
||||
@@ -73,7 +73,6 @@ api-reference/peripherals/dac.rst
|
||||
api-reference/peripherals/touch_element.rst
|
||||
api-reference/peripherals/lcd.rst
|
||||
api-reference/peripherals/ana_cmpr.rst
|
||||
api-reference/peripherals/secure_element.rst
|
||||
api-reference/peripherals/temp_sensor.rst
|
||||
api-reference/peripherals/sdio_slave.rst
|
||||
api-reference/peripherals/clk_tree.rst
|
||||
|
||||
@@ -35,7 +35,6 @@ Peripherals API
|
||||
spi_flash/index
|
||||
spi_master
|
||||
spi_slave
|
||||
:esp32: secure_element
|
||||
:SOC_SPI_SUPPORT_SLAVE_HD_VER2: spi_slave_hd
|
||||
:SOC_TEMP_SENSOR_SUPPORTED: temp_sensor
|
||||
:SOC_TOUCH_SENSOR_SUPPORTED: touch_pad
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
ESP32-WROOM-32SE (Secure Element)
|
||||
=================================
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-WROOM-32SE integrates Microchip's ATECC608A cryptoauth chip in the module. ATECC608A is a secure element, which would generate and store ECC private key in the hardware. The ECC private key can be used to enhance security to connect to IoT cloud services with the use of X.509-based mutual authentication.
|
||||
|
||||
The application example demonstrates ECDSA sign and verify functions using ECC private key stored in ATECC608A.
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
Secure Element ECDSA Sign/Verify example: :example:`peripherals/secure_element/atecc608_ecdsa`.
|
||||
|
||||
How to Configure and Provision ESP32-WROOM-32SE for TLS
|
||||
-------------------------------------------------------
|
||||
|
||||
To configure and provision ATECC608A chip on ESP32-WROOM-32SE please visit `esp_cryptoauth_utility <https://github.com/espressif/esp-cryptoauthlib/blob/master/esp_cryptoauth_utility/README.md#esp_cryptoauth_utility>`_.
|
||||
|
||||
How to Use ATECC608A of ESP32-WROOM-32SE for TLS
|
||||
------------------------------------------------
|
||||
|
||||
ATECC608A can be used for TLS connections using ESP-TLS.
|
||||
|
||||
To configure ESP-TLS for using a secure element, please refer to **ATECC608A (Secure Element) with ESP-TLS** in :doc:`../protocols/esp_tls`.
|
||||
@@ -143,11 +143,11 @@ The following table shows a typical comparison between WolfSSL and MbedTLS when
|
||||
ATECC608A (Secure Element) with ESP-TLS
|
||||
--------------------------------------------------
|
||||
|
||||
ESP-TLS provides support for using ATECC608A cryptoauth chip with ESP32-WROOM-32SE. The use of ATECC608A is supported only when ESP-TLS is used with MbedTLS as its underlying SSL/TLS stack. ESP-TLS uses MbedTLS as its underlying TLS/SSL stack by default unless changed manually.
|
||||
ESP-TLS provides support for using ATECC608A cryptoauth chip with ESP32 series of SoC's. The use of ATECC608A is supported only when ESP-TLS is used with MbedTLS as its underlying SSL/TLS stack. ESP-TLS uses MbedTLS as its underlying TLS/SSL stack by default unless changed manually.
|
||||
|
||||
.. note::
|
||||
|
||||
ATECC608A chip on ESP32-WROOM-32SE must be already configured, for details refer `esp_cryptoauth_utility <https://github.com/espressif/esp-cryptoauthlib/blob/master/esp_cryptoauth_utility/README.md#esp_cryptoauth_utility>`_.
|
||||
ATECC608A chip interfaced to ESP32 must be already configured, for details refer `esp_cryptoauth_utility <https://github.com/espressif/esp-cryptoauthlib/blob/master/esp_cryptoauth_utility/README.md#esp_cryptoauth_utility>`_.
|
||||
|
||||
To enable the secure element support, and use it in your project for TLS connection, you have to follow the below steps:
|
||||
|
||||
|
||||
@@ -145,7 +145,7 @@ It is possible to set authentication parameters through the :cpp:class:`authenti
|
||||
|
||||
* :cpp:member:`password <esp_mqtt_client_config_t::credentials_t::authentication_t::password>`: use a password by setting
|
||||
* :cpp:member:`certificate <esp_mqtt_client_config_t::credentials_t::authentication_t::certificate>` and :cpp:member:`key <esp_mqtt_client_config_t::credentials_t::authentication_t::key>`: mutual authentication with TLS, and both can be provided in PEM or DER format
|
||||
* :cpp:member:`use_secure_element <esp_mqtt_client_config_t::credentials_t::authentication_t::use_secure_element>`: use secure element available in ESP32-WROOM-32SE
|
||||
* :cpp:member:`use_secure_element <esp_mqtt_client_config_t::credentials_t::authentication_t::use_secure_element>`: use secure element (ATECC608A) interfaced to ESP32
|
||||
* :cpp:member:`ds_data <esp_mqtt_client_config_t::credentials_t::authentication_t::ds_data>`: use Digital Signature Peripheral available in some Espressif devices
|
||||
|
||||
Session
|
||||
|
||||
@@ -3,6 +3,9 @@ Peripherals
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
Drivers
|
||||
-------
|
||||
|
||||
In order to control the dependence of other components on drivers at a smaller granularity, the original peripheral drivers under the `driver`` component were split into separate components:
|
||||
|
||||
- `esp_driver_gptimer` - Driver for general purpose timers
|
||||
@@ -41,3 +44,11 @@ Should be changed to:
|
||||
archive: libesp_driver_gpio.a
|
||||
entries:
|
||||
gpio (noflash)
|
||||
|
||||
|
||||
Secure Element
|
||||
--------------
|
||||
|
||||
ATECC608A secure element interfacing example has been moved to `ESP Cryptoauthlib Repository <https://github.com/espressif/esp-cryptoauthlib/tree/master/examples/atecc608_ecdsa>`_ on GitHub.
|
||||
|
||||
This example is also part of the `esp-cryptoauthlib <https://components.espressif.com/component/espressif/esp-cryptoauthlib>`_ in the component manager registry.
|
||||
|
||||
@@ -35,7 +35,6 @@
|
||||
spi_flash/index
|
||||
spi_master
|
||||
spi_slave
|
||||
:esp32: secure_element
|
||||
:SOC_SPI_SUPPORT_SLAVE_HD_VER2: spi_slave_hd
|
||||
:SOC_TEMP_SENSOR_SUPPORTED: temp_sensor
|
||||
:SOC_TOUCH_SENSOR_SUPPORTED: touch_pad
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
ESP32-WROOM-32SE（安全元件）
|
||||
=================================
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
概述
|
||||
--------
|
||||
|
||||
ESP32-WROOM-32SE 模组集成了 Microchip 的 ATECC608A 加密认证芯片。ATECC608A 安全元件可以在硬件中生成并存储 ECC 私钥。通过使用基于 X.509 的双向认证，ECC 私钥可增强设备与物联网云服务连接的安全性。
|
||||
|
||||
有关如何使用存储在 ATECC608A 中的 ECC 私钥进行 ECDSA 签名和验证，请参阅以下应用示例。
|
||||
|
||||
应用示例
|
||||
-------------------
|
||||
|
||||
请参阅安全元件 ECDSA 签名/验证示例 :example:`peripherals/secure_element/atecc608_ecdsa`。
|
||||
|
||||
对 ESP32-WROOM-32SE 配置并配网以进行 TLS 连接
|
||||
-------------------------------------------------------
|
||||
|
||||
要在 ESP32-WROOM-32SE 上配置 ATECC608A 芯片，并对其进行配网，请参阅 `esp_cryptoauth_utility <https://github.com/espressif/esp-cryptoauthlib/blob/master/esp_cryptoauth_utility/README.md#esp_cryptoauth_utility>`_。
|
||||
|
||||
使用 ESP32-WROOM-32SE 的 ATECC608A 进行 TLS 连接
|
||||
------------------------------------------------------
|
||||
|
||||
通过使用 ESP-TLS，ATECC608A 可实现 TLS 连接。
|
||||
|
||||
要配置 ESP-TLS 以使用安全元件，请参阅 :doc:`../protocols/esp_tls` 中的 **ESP-TLS 中的 ATECC608A（安全元件）** 一节。
|
||||
Reference in New Issue
Block a user