esp-idf/components/esp-tls/Kconfig

menu "ESP-TLS"
    choice ESP_TLS_LIBRARY_CHOOSE
        prompt "Choose SSL/TLS library for ESP-TLS (See help for more Info)"
        default ESP_TLS_USING_MBEDTLS
        help
            The ESP-TLS APIs support multiple backend TLS libraries. Currently mbedTLS and WolfSSL are
            supported. Different TLS libraries may support different features and have different resource
            usage. Consult the ESP-TLS documentation in ESP-IDF Programming guide for more details.
        config ESP_TLS_USING_MBEDTLS
            bool "mbedTLS"
        config ESP_TLS_USING_WOLFSSL
            depends on TLS_STACK_WOLFSSL
            bool "wolfSSL (License info in wolfSSL directory README)"
    endchoice

    config ESP_TLS_USE_SECURE_ELEMENT
        bool "Use Secure Element (ATECC608A) with ESP-TLS"
        depends on IDF_TARGET_ESP32 && ESP_TLS_USING_MBEDTLS
        select ATCA_MBEDTLS_ECDSA
        select ATCA_MBEDTLS_ECDSA_SIGN
        select ATCA_MBEDTLS_ECDSA_VERIFY
        default n
        help
            Enable use of Secure Element for ESP-TLS, this enables internal support for
            ATECC608A peripheral on ESPWROOM32SE, which can be used for TLS connection.

    config ESP_TLS_USE_DS_PERIPHERAL
        bool "Use Digital Signature (DS) Peripheral with ESP-TLS"
        depends on (IDF_TARGET_ESP32C3 || IDF_TARGET_ESP32S2) && ESP_TLS_USING_MBEDTLS
        default y
        help
            Enable use of the Digital Signature Peripheral for ESP-TLS.The DS peripheral
            can only be used when it is appropriately configured for TLS.
            Consult the ESP-TLS documentation in ESP-IDF Programming Guide for more details.

    config ESP_TLS_SERVER
        bool "Enable ESP-TLS Server"
        default n
        help
            Enable support for creating server side SSL/TLS session, available for mbedTLS
            as well as wolfSSL TLS library.

    config ESP_TLS_PSK_VERIFICATION
        bool "Enable PSK verification"
        select MBEDTLS_PSK_MODES if ESP_TLS_USING_MBEDTLS
        select MBEDTLS_KEY_EXCHANGE_PSK if ESP_TLS_USING_MBEDTLS
        select MBEDTLS_KEY_EXCHANGE_DHE_PSK if ESP_TLS_USING_MBEDTLS
        select MBEDTLS_KEY_EXCHANGE_ECDHE_PSK if ESP_TLS_USING_MBEDTLS
        select MBEDTLS_KEY_EXCHANGE_RSA_PSK if ESP_TLS_USING_MBEDTLS
        default n
        help
            Enable support for pre shared key ciphers, supported for both mbedTLS as well as
            wolfSSL TLS library.

    config ESP_TLS_INSECURE
        bool "Allow potentially insecure options"
        help
            You can enable some potentially insecure options. These options should only be used for testing pusposes.
            Only enable these options if you are very sure.

    config ESP_TLS_SKIP_SERVER_CERT_VERIFY
        bool "Skip server certificate verification by default (WARNING: ONLY FOR TESTING PURPOSE, READ HELP)"
        depends on ESP_TLS_INSECURE
        help
            After enabling this option the esp-tls client will skip the server certificate verification
            by default. Note that this option will only modify the default behaviour of esp-tls client
            regarding server cert verification. The default behaviour should only be applicable when
            no other option regarding the server cert verification is opted in the esp-tls config
            (e.g. crt_bundle_attach, use_global_ca_store etc.).
            WARNING : Enabling this option comes with a potential risk of establishing a TLS connection
            with a server which has a fake identity, provided that the server certificate
            is not provided either through API or other mechanism like ca_store etc.

    config ESP_WOLFSSL_SMALL_CERT_VERIFY
        bool "Enable SMALL_CERT_VERIFY"
        depends on ESP_TLS_USING_WOLFSSL
        default y
        help
            Enables server verification with Intermediate CA cert, does not authenticate full chain
            of trust upto the root CA cert (After Enabling this option client only needs to have Intermediate
            CA certificate of the server to authenticate server, root CA cert is not necessary).

    config ESP_DEBUG_WOLFSSL
        bool "Enable debug logs for wolfSSL"
        depends on ESP_TLS_USING_WOLFSSL
        default n
        help
            Enable detailed debug prints for wolfSSL SSL library.

endmenu
esp_tls: Add support for server side SSL/TLS connection Currently, esp-tls supports creation of SSL/TLS connection on the client side. This commit includes support for creating SSL/TLS connection on the server side. 2019-05-28 01:49:02 -04:00			`menu "ESP-TLS"`
ESP_TLS: Restructuring esp_tls 1)Segregating mbedtls API into seperate file and cleaned esp_tls.c 2)Added support for wolfssl for CMake and make 3)Added support for debug_wolfssl (with menuconfig option) 4)Added info on wolfssl in ESP-TLS docs 2019-09-07 06:54:54 -04:00			`choice ESP_TLS_LIBRARY_CHOOSE`
			`prompt "Choose SSL/TLS library for ESP-TLS (See help for more Info)"`
			`default ESP_TLS_USING_MBEDTLS`
			`help`
			`The ESP-TLS APIs support multiple backend TLS libraries. Currently mbedTLS and WolfSSL are`
			`supported. Different TLS libraries may support different features and have different resource`
			`usage. Consult the ESP-TLS documentation in ESP-IDF Programming guide for more details.`
			`config ESP_TLS_USING_MBEDTLS`
			`bool "mbedTLS"`
			`config ESP_TLS_USING_WOLFSSL`
			`depends on TLS_STACK_WOLFSSL`
			`bool "wolfSSL (License info in wolfSSL directory README)"`
			`endchoice`
esp_tls: Add support for server side SSL/TLS connection Currently, esp-tls supports creation of SSL/TLS connection on the client side. This commit includes support for creating SSL/TLS connection on the server side. 2019-05-28 01:49:02 -04:00
secure_element: atecc608_ecdsa example * Replaced crypotoauthlib with esp-cryptoauthlib * Added menuconfig option for esp-tls about using HSM * Added error codes for HSM in esp-tls, * Added support to select different type of ATECC608A chips * Added README, updated docs * tcp_transport: Added option to enable secure_element for ssl Closes https://github.com/espressif/esp-idf/issues/4432 2020-04-06 10:42:52 -04:00			`config ESP_TLS_USE_SECURE_ELEMENT`
			`bool "Use Secure Element (ATECC608A) with ESP-TLS"`
			`depends on IDF_TARGET_ESP32 && ESP_TLS_USING_MBEDTLS`
			`select ATCA_MBEDTLS_ECDSA`
			`select ATCA_MBEDTLS_ECDSA_SIGN`
			`select ATCA_MBEDTLS_ECDSA_VERIFY`
			`default n`
			`help`
			`Enable use of Secure Element for ESP-TLS, this enables internal support for`
			`ATECC608A peripheral on ESPWROOM32SE, which can be used for TLS connection.`

esp32s2/esp_ds: Digital Signature software support 1)Added support for alt rsa sign implementation with DS peripheral ( through ESP-TLS - mbedTLS SSL/TLS stack) 2020-06-16 08:40:12 -04:00			`config ESP_TLS_USE_DS_PERIPHERAL`
			`bool "Use Digital Signature (DS) Peripheral with ESP-TLS"`
esp32c3/Digital Signature: mbedtls integration through ESP-TLS 2021-01-17 11:08:34 -05:00			`depends on (IDF_TARGET_ESP32C3 \|\| IDF_TARGET_ESP32S2) && ESP_TLS_USING_MBEDTLS`
esp32s2/esp_ds: Digital Signature software support 1)Added support for alt rsa sign implementation with DS peripheral ( through ESP-TLS - mbedTLS SSL/TLS stack) 2020-06-16 08:40:12 -04:00			`default y`
			`help`
			`Enable use of the Digital Signature Peripheral for ESP-TLS.The DS peripheral`
			`can only be used when it is appropriately configured for TLS.`
			`Consult the ESP-TLS documentation in ESP-IDF Programming Guide for more details.`

esp_tls: Add support for server side SSL/TLS connection Currently, esp-tls supports creation of SSL/TLS connection on the client side. This commit includes support for creating SSL/TLS connection on the server side. 2019-05-28 01:49:02 -04:00			`config ESP_TLS_SERVER`
			`bool "Enable ESP-TLS Server"`
ESP_TLS: Restructuring esp_tls 1)Segregating mbedtls API into seperate file and cleaned esp_tls.c 2)Added support for wolfssl for CMake and make 3)Added support for debug_wolfssl (with menuconfig option) 4)Added info on wolfssl in ESP-TLS docs 2019-09-07 06:54:54 -04:00			`default n`
esp_tls: Add support for server side SSL/TLS connection Currently, esp-tls supports creation of SSL/TLS connection on the client side. This commit includes support for creating SSL/TLS connection on the server side. 2019-05-28 01:49:02 -04:00			`help`
esp-tls: Add support for https_server using wolfSSL 2020-01-17 04:27:08 -05:00			`Enable support for creating server side SSL/TLS session, available for mbedTLS`
			`as well as wolfSSL TLS library.`
esp_tls: Add support for server side SSL/TLS connection Currently, esp-tls supports creation of SSL/TLS connection on the client side. This commit includes support for creating SSL/TLS connection on the server side. 2019-05-28 01:49:02 -04:00
esp_tls: enable psk verification mode, added mqtt example using psk authentication 2019-05-23 15:48:08 -04:00			`config ESP_TLS_PSK_VERIFICATION`
			`bool "Enable PSK verification"`
esp_tls_wolfssl: Add support for PSK using wolfSSL, enable SNI and ALPN 2020-03-11 07:48:27 -04:00			`select MBEDTLS_PSK_MODES if ESP_TLS_USING_MBEDTLS`
			`select MBEDTLS_KEY_EXCHANGE_PSK if ESP_TLS_USING_MBEDTLS`
			`select MBEDTLS_KEY_EXCHANGE_DHE_PSK if ESP_TLS_USING_MBEDTLS`
			`select MBEDTLS_KEY_EXCHANGE_ECDHE_PSK if ESP_TLS_USING_MBEDTLS`
			`select MBEDTLS_KEY_EXCHANGE_RSA_PSK if ESP_TLS_USING_MBEDTLS`
esp_tls: enable psk verification mode, added mqtt example using psk authentication 2019-05-23 15:48:08 -04:00			`default n`
			`help`
esp_tls_wolfssl: Add support for PSK using wolfSSL, enable SNI and ALPN 2020-03-11 07:48:27 -04:00			`Enable support for pre shared key ciphers, supported for both mbedTLS as well as`
			`wolfSSL TLS library.`
esp_tls: enable psk verification mode, added mqtt example using psk authentication 2019-05-23 15:48:08 -04:00
esp-tls: Changed default behaviour for esp-tls client ( for security purpose) By default esp-tls client will now return error if no server verify option is provided, earlier it used to skip the verification by default. Added config option to skip server verification by default (for testing purpose) Updated required docs 2020-12-23 13:00:40 -05:00			`config ESP_TLS_INSECURE`
			`bool "Allow potentially insecure options"`
			`help`
			`You can enable some potentially insecure options. These options should only be used for testing pusposes.`
			`Only enable these options if you are very sure.`

			`config ESP_TLS_SKIP_SERVER_CERT_VERIFY`
			`bool "Skip server certificate verification by default (WARNING: ONLY FOR TESTING PURPOSE, READ HELP)"`
			`depends on ESP_TLS_INSECURE`
			`help`
			`After enabling this option the esp-tls client will skip the server certificate verification`
			`by default. Note that this option will only modify the default behaviour of esp-tls client`
			`regarding server cert verification. The default behaviour should only be applicable when`
			`no other option regarding the server cert verification is opted in the esp-tls config`
			`(e.g. crt_bundle_attach, use_global_ca_store etc.).`
			`WARNING : Enabling this option comes with a potential risk of establishing a TLS connection`
			`with a server which has a fake identity, provided that the server certificate`
			`is not provided either through API or other mechanism like ca_store etc.`

ESP_TLS: Restructuring esp_tls 1)Segregating mbedtls API into seperate file and cleaned esp_tls.c 2)Added support for wolfssl for CMake and make 3)Added support for debug_wolfssl (with menuconfig option) 4)Added info on wolfssl in ESP-TLS docs 2019-09-07 06:54:54 -04:00			`config ESP_WOLFSSL_SMALL_CERT_VERIFY`
			`bool "Enable SMALL_CERT_VERIFY"`
			`depends on ESP_TLS_USING_WOLFSSL`
			`default y`
			`help`
			`Enables server verification with Intermediate CA cert, does not authenticate full chain`
			`of trust upto the root CA cert (After Enabling this option client only needs to have Intermediate`
			`CA certificate of the server to authenticate server, root CA cert is not necessary).`
esp_tls: Add support for server side SSL/TLS connection Currently, esp-tls supports creation of SSL/TLS connection on the client side. This commit includes support for creating SSL/TLS connection on the server side. 2019-05-28 01:49:02 -04:00
ESP_TLS: Restructuring esp_tls 1)Segregating mbedtls API into seperate file and cleaned esp_tls.c 2)Added support for wolfssl for CMake and make 3)Added support for debug_wolfssl (with menuconfig option) 4)Added info on wolfssl in ESP-TLS docs 2019-09-07 06:54:54 -04:00			`config ESP_DEBUG_WOLFSSL`
			`bool "Enable debug logs for wolfSSL"`
			`depends on ESP_TLS_USING_WOLFSSL`
			`default n`
			`help`
			`Enable detailed debug prints for wolfSSL SSL library.`

			`endmenu`