Documentation

Documentation

Includes

lwip/opt.h

#include "lwip/opt.h"
#include "lwip/opt.h"

lwip/altcp.h

#include "lwip/altcp.h"
#include "lwip/altcp.h"

Macros

Marco LWIP_HDR_ALTCP_TLS_H

#define LWIP_HDR_ALTCP_TLS_H

      

Functions

Func altcp_tls_free_config

void altcp_tls_free_config(struct altcp_tls_config *conf);
/** @ingroup altcp_tls
 * Free an ALTCP_TLS configuration handle
 */

Func altcp_tls_wrap

struct altcp_pcb *altcp_tls_wrap(struct altcp_tls_config *config, struct altcp_pcb *inner_pcb);
/** @ingroup altcp_tls
 * Create new ALTCP_TLS layer wrapping an existing pcb as inner connection (e.g. TLS over TCP)
 */

Func altcp_tls_new

struct altcp_pcb *altcp_tls_new(struct altcp_tls_config *config, u8_t ip_type);
/** @ingroup altcp_tls
 * Create new ALTCP_TLS pcb and its inner tcp pcb
 */

Func altcp_tls_alloc

struct altcp_pcb *altcp_tls_alloc(void *arg, u8_t ip_type);
/** @ingroup altcp_tls
 * Create new ALTCP_TLS layer pcb and its inner tcp pcb.
 * Same as @ref altcp_tls_new but this allocator function fits to
 * @ref altcp_allocator_t / @ref altcp_new.\n
 'arg' must contain a struct altcp_tls_config *.
 */

Func altcp_tls_context

void *altcp_tls_context(struct altcp_pcb *conn);
/** @ingroup altcp_tls
 * Return pointer to internal TLS context so application can tweak it.
 * Real type depends on port (e.g. mbedtls)
 */

Vars

Variable altcp_tls_config

struct altcp_tls_config;
/** @ingroup altcp_tls
 * ALTCP_TLS configuration handle, content depends on port (e.g. mbedtls)
 */

Variable altcp_tls_config

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 server configuration handle
 */

Variable altcp_tls_config

struct altcp_tls_config *altcp_tls_create_config_client(const u8_t *cert, size_t cert_len);
/** @ingroup altcp_tls
 * Create an ALTCP_TLS client configuration handle
 */

Variable altcp_tls_config

struct altcp_tls_config *altcp_tls_create_config_client_2wayauth(const u8_t *ca, size_t ca_len, 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 with two-way server/client authentication
 */

Consts

Types

Typedefs