Improve documentation, add TLS stuff

This commit is contained in:
Dirk Ziegelmeier
2017-03-28 21:25:49 +02:00
parent 9b6192bd65
commit 3266511ebb
5 changed files with 29 additions and 1 deletions

View File

@@ -2593,6 +2593,11 @@ httpd_init(void)
}
#if HTTPD_ENABLE_HTTPS
/**
* @ingroup httpd
* Initialize the httpd: set up a listening PCB and bind it to the defined port.
* Also set up TLS connection handling (HTTPS).
*/
void
httpd_inits(struct altcp_tls_config *conf)
{

View File

@@ -367,6 +367,11 @@ smtp_set_server_port(u16_t port)
}
#if LWIP_ALTCP && LWIP_ALTCP_TLS
/** @ingroup smtp
* Set TLS configuration for next SMTP connection
*
* @param tls_config TLS configuration
*/
void
smtp_set_tls_config(struct altcp_tls_config *tls_config)
{

View File

@@ -2,6 +2,8 @@
* @file
* Application layered TCP/TLS connection API (to be used from TCPIP thread)
*
* @defgroup altcp_tls TLS layer
* @ingroup altcp
* This file contains function prototypes for a TLS layer.
*/
@@ -51,13 +53,26 @@
extern "C" {
#endif
/** @ingroup altcp_tls
* ALTCP_TLS configuration handle, content depends on port (e.g. mbedtls)
*/
struct altcp_tls_config;
/** @ingroup altcp_tls
* Create an ALTCP_TLS server configuration handle
*/
struct altcp_tls_config *altcp_tls_create_config_server_privkey_cert(const u8_t *privkey, size_t privkey_len,
const u8_t *privkey_pass, size_t privkey_pass_len,
const u8_t *cert, size_t cert_len);
/** @ingroup altcp_tls
* Create an ALTCP_TLS client configuration handle
*/
struct altcp_tls_config *altcp_tls_create_config_client(const u8_t *cert, size_t cert_len);
/** @ingroup altcp_tls
* Create new ALTCP_TLS layer
*/
struct altcp_pcb *altcp_tls_new(struct altcp_tls_config* config, struct altcp_pcb *inner_pcb);
#ifdef __cplusplus

View File

@@ -79,6 +79,7 @@ struct mqtt_connect_client_info_t {
u8_t will_qos;
u8_t will_retain;
#if LWIP_ALTCP && LWIP_ALTCP_TLS
/** TLS configuration for secure connections */
struct altcp_tls_config *tls_config;
#endif
};