diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index 9d94f5e1ab..d26d10797c 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -116,6 +116,7 @@ INPUT = \ $(PROJECT_PATH)/components/esp_netif/include/esp_netif.h \ $(PROJECT_PATH)/components/esp_netif/include/esp_netif_net_stack.h \ $(PROJECT_PATH)/components/esp-tls/esp_tls.h \ + $(PROJECT_PATH)/components/esp-tls/esp_tls_errors.h \ $(PROJECT_PATH)/components/mqtt/esp-mqtt/include/mqtt_client.h \ $(PROJECT_PATH)/components/lwip/include/apps/ping/ping_sock.h \ $(PROJECT_PATH)/components/lwip/include/apps/esp_sntp.h \ diff --git a/docs/en/api-reference/protocols/esp_crt_bundle.rst b/docs/en/api-reference/protocols/esp_crt_bundle.rst index 49c1c5352e..08463aad5e 100644 --- a/docs/en/api-reference/protocols/esp_crt_bundle.rst +++ b/docs/en/api-reference/protocols/esp_crt_bundle.rst @@ -48,6 +48,8 @@ If using mbedTLS directly then the bundle may be activated by directly calling t esp_crt_bundle_attach(&conf); +.. _updating_bundle: + Generating the List of Root Certificates ---------------------------------------- The list of root certificates comes from Mozilla's NSS root certificate store, which can be found `here `_ @@ -57,12 +59,12 @@ Another alternative would be to download the finished list directly from the cur The common certificates bundle were made by selecting the authorities with a market share of more than 1 % from w3tech's `SSL Survey `_. These authorities were then used to pick the names of the certificates for the filter list, `cmn_crt_authorities.csv`, from `this list `_ provided by Mozilla. -.. _updating_bundle: + Updating the Certificate Bundle ------------------------------- -The bundle is embedded into the app and can be updated along with the app by an OTA update. If you want to include a more up-to-date bundle than the bundle currently included in IDF, then the certificate list can be downloaded from Mozilla as described in :ref:`updating_bundle`. +The bundle is embedded into the app and can be updated along with the app by an OTA update. If you want to include a more up-to-date bundle than the bundle currently included in ESP-IDF, then the certificate list can be downloaded from Mozilla as described in :ref:`updating_bundle`. diff --git a/docs/en/api-reference/protocols/esp_tls.rst b/docs/en/api-reference/protocols/esp_tls.rst index 979e5363bd..1dac78860f 100644 --- a/docs/en/api-reference/protocols/esp_tls.rst +++ b/docs/en/api-reference/protocols/esp_tls.rst @@ -175,3 +175,4 @@ API Reference ------------- .. include-build-file:: inc/esp_tls.inc +.. include-build-file:: inc/esp_tls_errors.inc diff --git a/docs/en/api-reference/protocols/mqtt.rst b/docs/en/api-reference/protocols/mqtt.rst index 7d00a03767..5b8410700e 100644 --- a/docs/en/api-reference/protocols/mqtt.rst +++ b/docs/en/api-reference/protocols/mqtt.rst @@ -85,7 +85,7 @@ SSL If the certificate is not null-terminated then ``cert_len`` should also be set. Other SSL related configuration parameters are: - * ``use_global_ca_store``: use the global certificate store to verify server certificate, see ``esp-tls.h`` for more information + * ``use_global_ca_store``: use the global certificate store to verify server certificate, see :component_file:`esp-tls/esp_tls.h` for more information * ``client_cert_pem``: pointer to certificate data in PEM or DER format for SSL mutual authentication, default is NULL, not required if mutual authentication is not needed. * ``client_cert_len``: length of the buffer pointed to by client_cert_pem. May be 0 for null-terminated pem. * ``client_key_pem``: pointer to private key data in PEM or DER format for SSL mutual authentication, default is NULL, not required if mutual authentication is not needed.