Chapter 2. API Reference
API Reference
Header File
• components/esp_https_server/include/esp_https_server.h
Functions
esp_err_t httpd_ssl_start(httpd_handle_t *handle, httpd_ssl_config_t *config)
Create a SSL capable HTTP server (secure mode may be disabled in config)
Return success
Parameters
• [inout] config: - server config, must not be const. Does not have to stay valid after calling
this function.
• [out] handle: - storage for the server handle, must be a valid pointer
void httpd_ssl_stop(httpd_handle_t handle)
Stop the server. Blocks until the server is shut down.
Parameters
• [in] handle:
Structures
struct esp_https_server_user_cb_arg
Callback data struct, contains the ESP-TLS connection handle.
struct httpd_ssl_config
HTTPS server config struct
Please use HTTPD_SSL_CONFIG_DEFAULT() to initialize it.
Public Members
httpd_config_t httpd
Underlying HTTPD server config
Parameters like task stack size and priority can be adjusted here.
const uint8_t *cacert_pem
CA certificate (here it is treated as server cert) Todo: Fix this change in release/v5.0 as it would be
a breaking change i.e. Rename the nomenclature of variables holding different certs in https_server
component as well as example 1)The cacert variable should hold the CA which is used to authenticate
clients (should inherit current role of client_verify_cert_pem var) 2)There should be another variable
servercert which whould hold servers own certificate (should inherit current role of cacert var)
size_t cacert_len
CA certificate byte length
const uint8_t *client_verify_cert_pem
Client verify authority certificate (CA used to sign clients, or client cert itself
size_t client_verify_cert_len
Client verify authority cert len
const uint8_t *prvtkey_pem
Private key
size_t prvtkey_len
Private key byte length
httpd_ssl_transport_mode_t transport_mode
Transport Mode (default secure)
Espressif Systems 594
Submit Document Feedback
Release v4.4
To Next Page
Loading...