mirror of
https://github.com/espressif/esp-idf.git
synced 2025-08-05 13:44:32 +02:00
docs: Add esp_tls_errors.h to API reference list
Closes DOC-2797
This commit is contained in:
@@ -116,6 +116,7 @@ INPUT = \
|
|||||||
$(PROJECT_PATH)/components/esp_netif/include/esp_netif.h \
|
$(PROJECT_PATH)/components/esp_netif/include/esp_netif.h \
|
||||||
$(PROJECT_PATH)/components/esp_netif/include/esp_netif_net_stack.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.h \
|
||||||
|
$(PROJECT_PATH)/components/esp-tls/esp_tls_errors.h \
|
||||||
$(PROJECT_PATH)/components/mqtt/esp-mqtt/include/mqtt_client.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/ping/ping_sock.h \
|
||||||
$(PROJECT_PATH)/components/lwip/include/apps/esp_sntp.h \
|
$(PROJECT_PATH)/components/lwip/include/apps/esp_sntp.h \
|
||||||
|
@@ -175,3 +175,4 @@ API Reference
|
|||||||
-------------
|
-------------
|
||||||
|
|
||||||
.. include-build-file:: inc/esp_tls.inc
|
.. include-build-file:: inc/esp_tls.inc
|
||||||
|
.. include-build-file:: inc/esp_tls_errors.inc
|
||||||
|
@@ -85,7 +85,7 @@ SSL
|
|||||||
If the certificate is not null-terminated then ``cert_len`` should also be set.
|
If the certificate is not null-terminated then ``cert_len`` should also be set.
|
||||||
Other SSL related configuration parameters are:
|
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_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_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.
|
* ``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.
|
||||||
|
Reference in New Issue
Block a user