mirror of
https://github.com/espressif/esp-idf.git
synced 2025-10-25 03:22:43 +00:00
22b1607405
This macro doesn't compile on C++. Order is fixed now. Signed-off-by: Jean Pierre Dudey <jeandudey@hotmail.com> Co-Authored-By: xkevin190 <kevinvelasco193@gmail.com> Merges https://github.com/espressif/esp-idf/pull/4981
144 lines
5.1 KiB
C
144 lines
5.1 KiB
C
// Copyright 2018 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef _ESP_HTTPS_SERVER_H_
|
|
#define _ESP_HTTPS_SERVER_H_
|
|
|
|
#include <stdbool.h>
|
|
#include "esp_err.h"
|
|
#include "esp_http_server.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef enum {
|
|
HTTPD_SSL_TRANSPORT_SECURE, // SSL Enabled
|
|
HTTPD_SSL_TRANSPORT_INSECURE // SSL disabled
|
|
} httpd_ssl_transport_mode_t;
|
|
|
|
/**
|
|
* HTTPS server config struct
|
|
*
|
|
* Please use HTTPD_SSL_CONFIG_DEFAULT() to initialize it.
|
|
*/
|
|
struct httpd_ssl_config {
|
|
/**
|
|
* Underlying HTTPD server config
|
|
*
|
|
* Parameters like task stack size and priority can be adjusted here.
|
|
*/
|
|
httpd_config_t httpd;
|
|
|
|
/** 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) */
|
|
const uint8_t *cacert_pem;
|
|
|
|
/** CA certificate byte length */
|
|
size_t cacert_len;
|
|
|
|
/** Client verify authority certificate (CA used to sign clients, or client cert itself */
|
|
const uint8_t *client_verify_cert_pem;
|
|
|
|
/** Client verify authority cert len */
|
|
size_t client_verify_cert_len;
|
|
|
|
/** Private key */
|
|
const uint8_t *prvtkey_pem;
|
|
|
|
/** Private key byte length */
|
|
size_t prvtkey_len;
|
|
|
|
/** Transport Mode (default secure) */
|
|
httpd_ssl_transport_mode_t transport_mode;
|
|
|
|
/** Port used when transport mode is secure (default 443) */
|
|
uint16_t port_secure;
|
|
|
|
/** Port used when transport mode is insecure (default 80) */
|
|
uint16_t port_insecure;
|
|
};
|
|
|
|
typedef struct httpd_ssl_config httpd_ssl_config_t;
|
|
|
|
/**
|
|
* Default config struct init
|
|
*
|
|
* (http_server default config had to be copied for customization)
|
|
*
|
|
* Notes:
|
|
* - port is set when starting the server, according to 'transport_mode'
|
|
* - one socket uses ~ 40kB RAM with SSL, we reduce the default socket count to 4
|
|
* - SSL sockets are usually long-lived, closing LRU prevents pool exhaustion DOS
|
|
* - Stack size may need adjustments depending on the user application
|
|
*/
|
|
#define HTTPD_SSL_CONFIG_DEFAULT() { \
|
|
.httpd = { \
|
|
.task_priority = tskIDLE_PRIORITY+5, \
|
|
.stack_size = 10240, \
|
|
.core_id = tskNO_AFFINITY, \
|
|
.server_port = 0, \
|
|
.ctrl_port = 32768, \
|
|
.max_open_sockets = 4, \
|
|
.max_uri_handlers = 8, \
|
|
.max_resp_headers = 8, \
|
|
.backlog_conn = 5, \
|
|
.lru_purge_enable = true, \
|
|
.recv_wait_timeout = 5, \
|
|
.send_wait_timeout = 5, \
|
|
.global_user_ctx = NULL, \
|
|
.global_user_ctx_free_fn = NULL, \
|
|
.global_transport_ctx = NULL, \
|
|
.global_transport_ctx_free_fn = NULL, \
|
|
.open_fn = NULL, \
|
|
.close_fn = NULL, \
|
|
.uri_match_fn = NULL \
|
|
}, \
|
|
.cacert_pem = NULL, \
|
|
.cacert_len = 0, \
|
|
.client_verify_cert_pem = NULL, \
|
|
.client_verify_cert_len = 0, \
|
|
.prvtkey_pem = NULL, \
|
|
.prvtkey_len = 0, \
|
|
.transport_mode = HTTPD_SSL_TRANSPORT_SECURE, \
|
|
.port_secure = 443, \
|
|
.port_insecure = 80, \
|
|
}
|
|
|
|
/**
|
|
* Create a SSL capable HTTP server (secure mode may be disabled in config)
|
|
*
|
|
* @param[in,out] config - server config, must not be const. Does not have to stay valid after
|
|
* calling this function.
|
|
* @param[out] handle - storage for the server handle, must be a valid pointer
|
|
* @return success
|
|
*/
|
|
esp_err_t httpd_ssl_start(httpd_handle_t *handle, httpd_ssl_config_t *config);
|
|
|
|
/**
|
|
* Stop the server. Blocks until the server is shut down.
|
|
*
|
|
* @param[in] handle
|
|
*/
|
|
void httpd_ssl_stop(httpd_handle_t handle);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // _ESP_HTTPS_SERVER_H_
|