SSL/TLS functions. More...

#include "config.h"
#include "bignum.h"
#include "ecp.h"
#include "ssl_ciphersuites.h"

Include dependency graph for ssl.h:

This graph shows which files directly or indirectly include this file:

Classes
union	mbedtls_ssl_premaster_secret

struct	mbedtls_ssl_session

struct	mbedtls_ssl_config

struct	mbedtls_ssl_context

Macros
#define	MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080

#define	MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100

#define	MBEDTLS_ERR_SSL_INVALID_MAC -0x7180

#define	MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200

#define	MBEDTLS_ERR_SSL_CONN_EOF -0x7280

#define	MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300

#define	MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380

#define	MBEDTLS_ERR_SSL_NO_RNG -0x7400

#define	MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480

#define	MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500

#define	MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580

#define	MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600

#define	MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680

#define	MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700

#define	MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780

#define	MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800

#define	MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880

#define	MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900

#define	MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980

#define	MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00

#define	MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80

#define	MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00

#define	MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80

#define	MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00

#define	MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80

#define	MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00

#define	MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80

#define	MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00

#define	MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80

#define	MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00

#define	MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80

#define	MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80

#define	MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00

#define	MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80

#define	MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00

#define	MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80

#define	MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00

#define	MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80

#define	MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00

#define	MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80

#define	MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00

#define	MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80

#define	MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00

#define	MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980

#define	MBEDTLS_ERR_SSL_WANT_READ -0x6900

#define	MBEDTLS_ERR_SSL_WANT_WRITE -0x6880

#define	MBEDTLS_ERR_SSL_TIMEOUT -0x6800

#define	MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780

#define	MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700

#define	MBEDTLS_ERR_SSL_NON_FATAL -0x6680

#define	MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH -0x6600

#define	MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580

#define	MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500

#define	MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480

#define	MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000

#define	MBEDTLS_SSL_MAJOR_VERSION_3 3

#define	MBEDTLS_SSL_MINOR_VERSION_0 0

#define	MBEDTLS_SSL_MINOR_VERSION_1 1

#define	MBEDTLS_SSL_MINOR_VERSION_2 2

#define	MBEDTLS_SSL_MINOR_VERSION_3 3

#define	MBEDTLS_SSL_TRANSPORT_STREAM 0

#define	MBEDTLS_SSL_TRANSPORT_DATAGRAM 1

#define	MBEDTLS_SSL_MAX_HOST_NAME_LEN 255

#define	MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0

#define	MBEDTLS_SSL_MAX_FRAG_LEN_512 1

#define	MBEDTLS_SSL_MAX_FRAG_LEN_1024 2

#define	MBEDTLS_SSL_MAX_FRAG_LEN_2048 3

#define	MBEDTLS_SSL_MAX_FRAG_LEN_4096 4

#define	MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5

#define	MBEDTLS_SSL_IS_CLIENT 0

#define	MBEDTLS_SSL_IS_SERVER 1

#define	MBEDTLS_SSL_IS_NOT_FALLBACK 0

#define	MBEDTLS_SSL_IS_FALLBACK 1

#define	MBEDTLS_SSL_EXTENDED_MS_DISABLED 0

#define	MBEDTLS_SSL_EXTENDED_MS_ENABLED 1

#define	MBEDTLS_SSL_ETM_DISABLED 0

#define	MBEDTLS_SSL_ETM_ENABLED 1

#define	MBEDTLS_SSL_COMPRESS_NULL 0

#define	MBEDTLS_SSL_COMPRESS_DEFLATE 1

#define	MBEDTLS_SSL_VERIFY_NONE 0

#define	MBEDTLS_SSL_VERIFY_OPTIONAL 1

#define	MBEDTLS_SSL_VERIFY_REQUIRED 2

#define	MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */

#define	MBEDTLS_SSL_LEGACY_RENEGOTIATION 0

#define	MBEDTLS_SSL_SECURE_RENEGOTIATION 1

#define	MBEDTLS_SSL_RENEGOTIATION_DISABLED 0

#define	MBEDTLS_SSL_RENEGOTIATION_ENABLED 1

#define	MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0

#define	MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1

#define	MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1

#define	MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16

#define	MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0

#define	MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1

#define	MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2

#define	MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0

#define	MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1

#define	MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */

#define	MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0

#define	MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1

#define	MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0

#define	MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1

#define	MBEDTLS_SSL_ARC4_ENABLED 0

#define	MBEDTLS_SSL_ARC4_DISABLED 1

#define	MBEDTLS_SSL_PRESET_DEFAULT 0

#define	MBEDTLS_SSL_PRESET_SUITEB 2

#define	MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1

#define	MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0

#define	MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000

#define	MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000

#define	MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12

#define	MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF

#define	MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600

#define	MBEDTLS_SSL_HASH_NONE 0

#define	MBEDTLS_SSL_HASH_MD5 1

#define	MBEDTLS_SSL_HASH_SHA1 2

#define	MBEDTLS_SSL_HASH_SHA224 3

#define	MBEDTLS_SSL_HASH_SHA256 4

#define	MBEDTLS_SSL_HASH_SHA384 5

#define	MBEDTLS_SSL_HASH_SHA512 6

#define	MBEDTLS_SSL_SIG_ANON 0

#define	MBEDTLS_SSL_SIG_RSA 1

#define	MBEDTLS_SSL_SIG_ECDSA 3

#define	MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1

#define	MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64

#define	MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20

#define	MBEDTLS_SSL_MSG_ALERT 21

#define	MBEDTLS_SSL_MSG_HANDSHAKE 22

#define	MBEDTLS_SSL_MSG_APPLICATION_DATA 23

#define	MBEDTLS_SSL_ALERT_LEVEL_WARNING 1

#define	MBEDTLS_SSL_ALERT_LEVEL_FATAL 2

#define	MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */

#define	MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */

#define	MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */

#define	MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */

#define	MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */

#define	MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */

#define	MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */

#define	MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */

#define	MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */

#define	MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */

#define	MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */

#define	MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */

#define	MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */

#define	MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */

#define	MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */

#define	MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */

#define	MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */

#define	MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */

#define	MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */

#define	MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */

#define	MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */

#define	MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */

#define	MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */

#define	MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */

#define	MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */

#define	MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */

#define	MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */

#define	MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */

#define	MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */

#define	MBEDTLS_SSL_HS_HELLO_REQUEST 0

#define	MBEDTLS_SSL_HS_CLIENT_HELLO 1

#define	MBEDTLS_SSL_HS_SERVER_HELLO 2

#define	MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3

#define	MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4

#define	MBEDTLS_SSL_HS_CERTIFICATE 11

#define	MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12

#define	MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13

#define	MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14

#define	MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15

#define	MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16

#define	MBEDTLS_SSL_HS_FINISHED 20

#define	MBEDTLS_TLS_EXT_SERVERNAME 0

#define	MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0

#define	MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1

#define	MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4

#define	MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10

#define	MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11

#define	MBEDTLS_TLS_EXT_SIG_ALG 13

#define	MBEDTLS_TLS_EXT_ALPN 16

#define	MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */

#define	MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */

#define	MBEDTLS_TLS_EXT_SESSION_TICKET 35

#define	MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */

#define	MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01

#define	MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */

#define	MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )

SECTION: Module settings
The configuration options you can set for this module are in this section. Either change them in config.h or define them on the compiler command line.
#define	MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400

#define	MBEDTLS_SSL_MAX_CONTENT_LEN 16384
	This macro is invoked by the library when an invalid parameter is detected that is only checked with MBEDTLS_CHECK_PARAMS (see the documentation of that option for context). More...

#define	MBEDTLS_SSL_IN_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN

#define	MBEDTLS_SSL_OUT_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN

#define	MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768

Typedefs
typedef int	mbedtls_ssl_send_t(void ctx, const unsigned char buf, size_t len)
	Callback type: send data on the network. More...

typedef int	mbedtls_ssl_recv_t(void ctx, unsigned char buf, size_t len)
	Callback type: receive data from the network. More...

typedef int	mbedtls_ssl_recv_timeout_t(void ctx, unsigned char buf, size_t len, uint32_t timeout)
	Callback type: receive data from the network, with timeout. More...

typedef void	mbedtls_ssl_set_timer_t(void *ctx, uint32_t int_ms, uint32_t fin_ms)
	Callback type: set a pair of timers/delays to watch. More...

typedef int	mbedtls_ssl_get_timer_t(void *ctx)
	Callback type: get status of timers/delays. More...

typedef struct mbedtls_ssl_session	mbedtls_ssl_session

typedef struct mbedtls_ssl_context	mbedtls_ssl_context

typedef struct mbedtls_ssl_config	mbedtls_ssl_config

typedef struct mbedtls_ssl_transform	mbedtls_ssl_transform

typedef struct mbedtls_ssl_handshake_params	mbedtls_ssl_handshake_params

typedef struct mbedtls_ssl_sig_hash_set_t	mbedtls_ssl_sig_hash_set_t

typedef int	mbedtls_ssl_ticket_write_t(void p_ticket, const mbedtls_ssl_session session, unsigned char start, const unsigned char end, size_t tlen, uint32_t lifetime)
	Callback type: generate and write session ticket. More...

typedef int	mbedtls_ssl_ticket_parse_t(void p_ticket, mbedtls_ssl_session session, unsigned char *buf, size_t len)
	Callback type: parse and load session ticket. More...

typedef int	mbedtls_ssl_cookie_write_t(void ctx, unsigned char p, unsigned char end, const unsigned char *info, size_t ilen)
	Callback type: generate a cookie. More...

typedef int	mbedtls_ssl_cookie_check_t(void ctx, const unsigned char cookie, size_t clen, const unsigned char *info, size_t ilen)
	Callback type: verify a cookie. More...

Functions
const char *	mbedtls_ssl_get_ciphersuite_name (const int ciphersuite_id)
	Return the name of the ciphersuite associated with the given ID. More...

int	mbedtls_ssl_get_ciphersuite_id (const char *ciphersuite_name)
	Return the ID of the ciphersuite associated with the given name. More...

void	mbedtls_ssl_init (mbedtls_ssl_context *ssl)
	Initialize an SSL context Just makes the context ready for mbedtls_ssl_setup() or mbedtls_ssl_free() More...

int	mbedtls_ssl_setup (mbedtls_ssl_context ssl, const mbedtls_ssl_config conf)
	Set up an SSL context for use. More...

int	mbedtls_ssl_session_reset (mbedtls_ssl_context *ssl)
	Reset an already initialized SSL context for re-use while retaining application-set variables, function pointers and data. More...

void	mbedtls_ssl_conf_endpoint (mbedtls_ssl_config *conf, int endpoint)
	Set the current endpoint type. More...

void	mbedtls_ssl_conf_transport (mbedtls_ssl_config *conf, int transport)
	Set the transport type (TLS or DTLS). Default: TLS. More...

void	mbedtls_ssl_conf_authmode (mbedtls_ssl_config *conf, int authmode)
	Set the certificate verification mode Default: NONE on server, REQUIRED on client. More...

void	mbedtls_ssl_conf_rng (mbedtls_ssl_config conf, int(f_rng)(void , unsigned char , size_t), void *p_rng)
	Set the random number generator callback. More...

void	mbedtls_ssl_conf_dbg (mbedtls_ssl_config conf, void(f_dbg)(void , int, const char , int, const char ), void p_dbg)
	Set the debug callback. More...

void	mbedtls_ssl_set_bio (mbedtls_ssl_context ssl, void p_bio, mbedtls_ssl_send_t f_send, mbedtls_ssl_recv_t f_recv, mbedtls_ssl_recv_timeout_t *f_recv_timeout)
	Set the underlying BIO callbacks for write, read and read-with-timeout. More...

void	mbedtls_ssl_conf_read_timeout (mbedtls_ssl_config *conf, uint32_t timeout)
	Set the timeout period for mbedtls_ssl_read() (Default: no timeout.) More...

void	mbedtls_ssl_set_timer_cb (mbedtls_ssl_context ssl, void p_timer, mbedtls_ssl_set_timer_t f_set_timer, mbedtls_ssl_get_timer_t f_get_timer)
	Set the timer callbacks (Mandatory for DTLS.) More...

void	mbedtls_ssl_conf_ciphersuites (mbedtls_ssl_config conf, const int ciphersuites)
	Set the list of allowed ciphersuites and the preference order. First in the list has the highest preference. (Overrides all version-specific lists) More...

void	mbedtls_ssl_conf_ciphersuites_for_version (mbedtls_ssl_config conf, const int ciphersuites, int major, int minor)
	Set the list of allowed ciphersuites and the preference order for a specific version of the protocol. (Only useful on the server side) More...

void	mbedtls_ssl_conf_max_version (mbedtls_ssl_config *conf, int major, int minor)
	Set the maximum supported version sent from the client side and/or accepted at the server side (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION) More...

void	mbedtls_ssl_conf_min_version (mbedtls_ssl_config *conf, int major, int minor)
	Set the minimum accepted SSL/TLS protocol version (Default: TLS 1.0) More...

void	mbedtls_ssl_conf_legacy_renegotiation (mbedtls_ssl_config *conf, int allow_legacy)
	Prevent or allow legacy renegotiation. (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION) More...

int	mbedtls_ssl_check_pending (const mbedtls_ssl_context *ssl)
	Check if there is data already read from the underlying transport but not yet processed. More...

size_t	mbedtls_ssl_get_bytes_avail (const mbedtls_ssl_context *ssl)
	Return the number of application data bytes remaining to be read from the current record. More...

uint32_t	mbedtls_ssl_get_verify_result (const mbedtls_ssl_context *ssl)
	Return the result of the certificate verification. More...

const char *	mbedtls_ssl_get_ciphersuite (const mbedtls_ssl_context *ssl)
	Return the name of the current ciphersuite. More...

const char *	mbedtls_ssl_get_version (const mbedtls_ssl_context *ssl)
	Return the current SSL version (SSLv3/TLSv1/etc) More...

int	mbedtls_ssl_get_record_expansion (const mbedtls_ssl_context *ssl)
	Return the (maximum) number of bytes added by the record layer: header + encryption/MAC overhead (inc. padding) More...

int	mbedtls_ssl_get_max_out_record_payload (const mbedtls_ssl_context *ssl)
	Return the current maximum outgoing record payload in bytes. This takes into account the config.h setting `MBEDTLS_SSL_OUT_CONTENT_LEN`, the configured and negotiated max fragment length extension if used, and for DTLS the path MTU as configured and current record expansion. More...

int	mbedtls_ssl_handshake (mbedtls_ssl_context *ssl)
	Perform the SSL handshake. More...

int	mbedtls_ssl_handshake_step (mbedtls_ssl_context *ssl)
	Perform a single step of the SSL handshake. More...

int	mbedtls_ssl_read (mbedtls_ssl_context ssl, unsigned char buf, size_t len)
	Read at most 'len' application data bytes. More...

int	mbedtls_ssl_write (mbedtls_ssl_context ssl, const unsigned char buf, size_t len)
	Try to write exactly 'len' application data bytes. More...

int	mbedtls_ssl_send_alert_message (mbedtls_ssl_context *ssl, unsigned char level, unsigned char message)
	Send an alert message. More...

int	mbedtls_ssl_close_notify (mbedtls_ssl_context *ssl)
	Notify the peer that the connection is being closed. More...

void	mbedtls_ssl_free (mbedtls_ssl_context *ssl)
	Free referenced items in an SSL context and clear memory. More...

void	mbedtls_ssl_config_init (mbedtls_ssl_config *conf)
	Initialize an SSL configuration context Just makes the context ready for mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free(). More...

int	mbedtls_ssl_config_defaults (mbedtls_ssl_config *conf, int endpoint, int transport, int preset)
	Load reasonnable default SSL configuration values. (You need to call mbedtls_ssl_config_init() first.) More...

void	mbedtls_ssl_config_free (mbedtls_ssl_config *conf)
	Free an SSL configuration context. More...

void	mbedtls_ssl_session_init (mbedtls_ssl_session *session)
	Initialize SSL session structure. More...

void	mbedtls_ssl_session_free (mbedtls_ssl_session *session)
	Free referenced items in an SSL session including the peer certificate and clear memory. More...

Detailed Description

SSL/TLS functions.

Macro Definition Documentation

◆ MBEDTLS_ERR_SSL_ALLOC_FAILED

#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00

Memory allocation failed

◆ MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS

#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500

The asynchronous operation is not completed yet.

◆ MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE

#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00

Processing of the Certificate handshake message failed.

◆ MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST

#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80

Processing of the CertificateRequest handshake message failed.

◆ MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY

#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80

Processing of the CertificateVerify handshake message failed.

◆ MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC

#define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00

Processing of the ChangeCipherSpec handshake message failed.

◆ MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO

#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900

Processing of the ClientHello handshake message failed.

◆ MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE

#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00

Processing of the ClientKeyExchange handshake message failed.

◆ MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS

#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00

Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret.

◆ MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP

#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80

Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public.

◆ MBEDTLS_ERR_SSL_BAD_HS_FINISHED

#define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80

Processing of the Finished handshake message failed.

◆ MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET

#define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00

Processing of the NewSessionTicket handshake message failed.

◆ MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION

#define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80

Handshake protocol not within min/max boundaries

◆ MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO

#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980

Processing of the ServerHello handshake message failed.

◆ MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE

#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80

Processing of the ServerHelloDone handshake message failed.

◆ MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE

#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00

Processing of the ServerKeyExchange handshake message failed.

◆ MBEDTLS_ERR_SSL_BAD_INPUT_DATA

#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100

Bad input parameters to function.

◆ MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL

#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00

A buffer is too small to receive or write a message

◆ MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED

#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680

No CA Chain is set, but required to operate.

◆ MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED

#define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580

The own certificate is not set, but needed by the server.

◆ MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE

#define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500

Our own certificate(s) is/are too large to send in an SSL message.

◆ MBEDTLS_ERR_SSL_CLIENT_RECONNECT

#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780

The client initiated a reconnect from the same port.

◆ MBEDTLS_ERR_SSL_COMPRESSION_FAILED

#define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00

Processing of the compression / decompression failed

◆ MBEDTLS_ERR_SSL_CONN_EOF

#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280

The connection indicated an EOF.

◆ MBEDTLS_ERR_SSL_CONTINUE_PROCESSING

#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580

Internal-only message signaling that further message-processing should be done

◆ MBEDTLS_ERR_SSL_COUNTER_WRAPPING

#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80

A counter would wrap (eg, too many messages exchanged).

◆ MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS

#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000

A cryptographic operation is in progress. Try again later.

◆ MBEDTLS_ERR_SSL_EARLY_MESSAGE

#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480

Internal-only message signaling that a message arrived early.

◆ MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE

#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780

A fatal alert message was received from our peer.

◆ MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE

#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080

The requested feature is not available.

◆ MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED

#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80

DTLS client must retry for hello verification

◆ MBEDTLS_ERR_SSL_HW_ACCEL_FAILED

#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80

Hardware acceleration function returned with error

◆ MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH

#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80

Hardware acceleration function skipped / left alone data

◆ MBEDTLS_ERR_SSL_INTERNAL_ERROR

#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00

Internal error (eg, unexpected failure in lower-level module)

◆ MBEDTLS_ERR_SSL_INVALID_MAC

#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180

Verification of the message MAC failed.

◆ MBEDTLS_ERR_SSL_INVALID_RECORD

#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200

An invalid SSL record was received.

◆ MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH

#define MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH -0x6600

Couldn't set the hash for verifying CertificateVerify

◆ MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN

#define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380

The server has no ciphersuites in common with the client.

◆ MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE

#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480

No client certification received from the client, but required by the authentication mode.

◆ MBEDTLS_ERR_SSL_NO_RNG

#define MBEDTLS_ERR_SSL_NO_RNG -0x7400

No RNG was provided to the SSL module.

◆ MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE

#define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980

None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages).

◆ MBEDTLS_ERR_SSL_NON_FATAL

#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680

The alert message received indicates a non-fatal error.

◆ MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY

#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880

The peer notified us that the connection is going to be closed.

◆ MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED

#define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800

Verification of our peer failed.

◆ MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH

#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00

Public key type mismatch (eg, asked for RSA key exchange and presented EC key)

◆ MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED

#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600

The own private key or pre-shared key is not set, but needed.

◆ MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED

#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80

Session ticket has expired.

◆ MBEDTLS_ERR_SSL_TIMEOUT

#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800

The operation timed out.

◆ MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE

#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700

An unexpected message was received from our peer.

◆ MBEDTLS_ERR_SSL_UNEXPECTED_RECORD

#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700

Record header looks valid but is not expected.

◆ MBEDTLS_ERR_SSL_UNKNOWN_CIPHER

#define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300

An unknown cipher was received.

◆ MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY

#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80

Unknown identity received (eg, PSK identity)

◆ MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO

#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00

Unexpected message at ServerHello in renegotiation.

◆ MBEDTLS_ERR_SSL_WANT_READ

#define MBEDTLS_ERR_SSL_WANT_READ -0x6900

No data of requested type currently available on underlying transport.

◆ MBEDTLS_ERR_SSL_WANT_WRITE

#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880

Connection requires a write call.

◆ MBEDTLS_PREMASTER_SIZE

#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )

◆ MBEDTLS_PSK_MAX_LEN

#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */

◆ MBEDTLS_SSL_ALERT_LEVEL_FATAL

#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2

◆ MBEDTLS_SSL_ALERT_LEVEL_WARNING

#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1

◆ MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED

#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */

◆ MBEDTLS_SSL_ALERT_MSG_BAD_CERT

#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */

◆ MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC

#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */

◆ MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED

#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */

◆ MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED

#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */

◆ MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN

#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */

◆ MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY

#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */

◆ MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR

#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */

◆ MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE

#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */

◆ MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR

#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */

◆ MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED

#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */

◆ MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION

#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */

◆ MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE

#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */

◆ MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER

#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */

◆ MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK

#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */

◆ MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY

#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */

◆ MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR

#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */

◆ MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL

#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */

◆ MBEDTLS_SSL_ALERT_MSG_NO_CERT

#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */

◆ MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION

#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */

◆ MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION

#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */

◆ MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW

#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */

◆ MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE

#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */

◆ MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA

#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */

◆ MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY

#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */

◆ MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME

#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */

◆ MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT

#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */

◆ MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT

#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */

◆ MBEDTLS_SSL_ALERT_MSG_USER_CANCELED

#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */

◆ MBEDTLS_SSL_ANTI_REPLAY_DISABLED

#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0

◆ MBEDTLS_SSL_ANTI_REPLAY_ENABLED

#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1

◆ MBEDTLS_SSL_ARC4_DISABLED

#define MBEDTLS_SSL_ARC4_DISABLED 1

◆ MBEDTLS_SSL_ARC4_ENABLED

#define MBEDTLS_SSL_ARC4_ENABLED 0

◆ MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED

#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0

◆ MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED

#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1

◆ MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED

#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0

◆ MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED

#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1

◆ MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN

#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64

◆ MBEDTLS_SSL_CERT_TYPE_RSA_SIGN

#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1

◆ MBEDTLS_SSL_COMPRESS_DEFLATE

#define MBEDTLS_SSL_COMPRESS_DEFLATE 1

◆ MBEDTLS_SSL_COMPRESS_NULL

#define MBEDTLS_SSL_COMPRESS_NULL 0

◆ MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME

#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400

Lifetime of session tickets (if enabled)

◆ MBEDTLS_SSL_DTLS_MAX_BUFFERING

#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768

Maximum number of heap-allocated bytes for the purpose of DTLS handshake message reassembly and future message buffering.

This should be at least 9/8 * MBEDTLSSL_IN_CONTENT_LEN to account for a reassembled handshake message of maximum size, together with its reassembly bitmap.

A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default) should be sufficient for all practical situations as it allows to reassembly a large handshake message (such as a certificate) while buffering multiple smaller handshake messages.

◆ MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX

#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000

◆ MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN

#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000

◆ MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO

#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF

renegotiation info ext

◆ MBEDTLS_SSL_ETM_DISABLED

#define MBEDTLS_SSL_ETM_DISABLED 0

◆ MBEDTLS_SSL_ETM_ENABLED

#define MBEDTLS_SSL_ETM_ENABLED 1

◆ MBEDTLS_SSL_EXTENDED_MS_DISABLED

#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0

◆ MBEDTLS_SSL_EXTENDED_MS_ENABLED

#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1

◆ MBEDTLS_SSL_FALLBACK_SCSV_VALUE

#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600

RFC 7507 section 2

◆ MBEDTLS_SSL_HASH_MD5

#define MBEDTLS_SSL_HASH_MD5 1

◆ MBEDTLS_SSL_HASH_NONE

#define MBEDTLS_SSL_HASH_NONE 0

◆ MBEDTLS_SSL_HASH_SHA1

#define MBEDTLS_SSL_HASH_SHA1 2

◆ MBEDTLS_SSL_HASH_SHA224

#define MBEDTLS_SSL_HASH_SHA224 3

◆ MBEDTLS_SSL_HASH_SHA256

#define MBEDTLS_SSL_HASH_SHA256 4

◆ MBEDTLS_SSL_HASH_SHA384

#define MBEDTLS_SSL_HASH_SHA384 5

◆ MBEDTLS_SSL_HASH_SHA512

#define MBEDTLS_SSL_HASH_SHA512 6

◆ MBEDTLS_SSL_HS_CERTIFICATE

#define MBEDTLS_SSL_HS_CERTIFICATE 11

◆ MBEDTLS_SSL_HS_CERTIFICATE_REQUEST

#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13

◆ MBEDTLS_SSL_HS_CERTIFICATE_VERIFY

#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15

◆ MBEDTLS_SSL_HS_CLIENT_HELLO

#define MBEDTLS_SSL_HS_CLIENT_HELLO 1

◆ MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE

#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16

◆ MBEDTLS_SSL_HS_FINISHED

#define MBEDTLS_SSL_HS_FINISHED 20

◆ MBEDTLS_SSL_HS_HELLO_REQUEST

#define MBEDTLS_SSL_HS_HELLO_REQUEST 0

◆ MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST

#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3

◆ MBEDTLS_SSL_HS_NEW_SESSION_TICKET

#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4

◆ MBEDTLS_SSL_HS_SERVER_HELLO

#define MBEDTLS_SSL_HS_SERVER_HELLO 2

◆ MBEDTLS_SSL_HS_SERVER_HELLO_DONE

#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14

◆ MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE

#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12

◆ MBEDTLS_SSL_IN_CONTENT_LEN

#define MBEDTLS_SSL_IN_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN

Maximum length (in bytes) of incoming plaintext fragments.

This determines the size of the incoming TLS I/O buffer in such a way that it is capable of holding the specified amount of plaintext data, regardless of the protection mechanism used.

If this option is undefined, it inherits its value from MBEDTLS_SSL_MAX_CONTENT_LEN.

Note: When using a value less than the default of 16KB on the client, it is recommended to use the Maximum Fragment Length (MFL) extension to inform the server about this limitation. On the server, there is no supported, standardized way of informing the client about restriction on the maximum size of incoming messages, and unless the limitation has been communicated by other means, it is recommended to only change the outgoing buffer size MBEDTLS_SSL_OUT_CONTENT_LEN while keeping the default value of 16KB for the incoming buffer.

Uncomment to set the maximum plaintext size of the incoming I/O buffer independently of the outgoing I/O buffer.

◆ MBEDTLS_SSL_IS_CLIENT

#define MBEDTLS_SSL_IS_CLIENT 0

◆ MBEDTLS_SSL_IS_FALLBACK

#define MBEDTLS_SSL_IS_FALLBACK 1

◆ MBEDTLS_SSL_IS_NOT_FALLBACK

#define MBEDTLS_SSL_IS_NOT_FALLBACK 0

◆ MBEDTLS_SSL_IS_SERVER

#define MBEDTLS_SSL_IS_SERVER 1

◆ MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION

#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1

◆ MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE

#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2

◆ MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION

#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0

◆ MBEDTLS_SSL_LEGACY_RENEGOTIATION

#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0

◆ MBEDTLS_SSL_MAJOR_VERSION_3

#define MBEDTLS_SSL_MAJOR_VERSION_3 3

◆ MBEDTLS_SSL_MAX_CONTENT_LEN

#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384

This macro is invoked by the library when an invalid parameter is detected that is only checked with MBEDTLS_CHECK_PARAMS (see the documentation of that option for context).

When you leave this undefined here, a default definition is provided that invokes the function mbedtls_param_failed(), which is declared in platform_util.h for the benefit of the library, but that you need to define in your application.

When you define this here, this replaces the default definition in platform_util.h (which no longer declares the function mbedtls_param_failed()) and it is your responsibility to make sure this macro expands to something suitable (in particular, that all the necessary declarations are visible from within the library - you can ensure that by providing them in this file next to the macro definition).

Note that you may define this macro to expand to nothing, in which case you don't have to worry about declarations or definitions. However, you will then be notified about invalid parameters only in non-void functions, and void function will just silently return early on invalid parameters, which partially negates the benefits of enabling #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.

Parameters

cond	The expression that should evaluate to true, but doesn't.

Maximum length (in bytes) of incoming and outgoing plaintext fragments.

This determines the size of both the incoming and outgoing TLS I/O buffers in such a way that both are capable of holding the specified amount of plaintext data, regardless of the protection mechanism used.

To configure incoming and outgoing I/O buffers separately, use MBEDTLS_SSL_IN_CONTENT_LEN and MBEDTLS_SSL_OUT_CONTENT_LEN, which overwrite the value set by this option.

Note: When using a value less than the default of 16KB on the client, it is recommended to use the Maximum Fragment Length (MFL) extension to inform the server about this limitation. On the server, there is no supported, standardized way of informing the client about restriction on the maximum size of incoming messages, and unless the limitation has been communicated by other means, it is recommended to only change the outgoing buffer size MBEDTLS_SSL_OUT_CONTENT_LEN while keeping the default value of 16KB for the incoming buffer.

Uncomment to set the maximum plaintext size of both incoming and outgoing I/O buffers.

Size of the input / output buffer

◆ MBEDTLS_SSL_MAX_FRAG_LEN_1024

#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2

MaxFragmentLength 2^10

◆ MBEDTLS_SSL_MAX_FRAG_LEN_2048

#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3

MaxFragmentLength 2^11

◆ MBEDTLS_SSL_MAX_FRAG_LEN_4096

#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4

MaxFragmentLength 2^12

◆ MBEDTLS_SSL_MAX_FRAG_LEN_512

#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1

MaxFragmentLength 2^9

◆ MBEDTLS_SSL_MAX_FRAG_LEN_INVALID

#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5

first invalid value

◆ MBEDTLS_SSL_MAX_FRAG_LEN_NONE

#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0

don't use this extension

◆ MBEDTLS_SSL_MAX_HOST_NAME_LEN

#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255

Maximum host name defined in RFC 1035

◆ MBEDTLS_SSL_MINOR_VERSION_0

#define MBEDTLS_SSL_MINOR_VERSION_0 0

SSL v3.0

◆ MBEDTLS_SSL_MINOR_VERSION_1

#define MBEDTLS_SSL_MINOR_VERSION_1 1

TLS v1.0

◆ MBEDTLS_SSL_MINOR_VERSION_2

#define MBEDTLS_SSL_MINOR_VERSION_2 2

TLS v1.1

◆ MBEDTLS_SSL_MINOR_VERSION_3

#define MBEDTLS_SSL_MINOR_VERSION_3 3

TLS v1.2

◆ MBEDTLS_SSL_MSG_ALERT

#define MBEDTLS_SSL_MSG_ALERT 21

◆ MBEDTLS_SSL_MSG_APPLICATION_DATA

#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23

◆ MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC

#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20

◆ MBEDTLS_SSL_MSG_HANDSHAKE

#define MBEDTLS_SSL_MSG_HANDSHAKE 22

◆ MBEDTLS_SSL_OUT_CONTENT_LEN

#define MBEDTLS_SSL_OUT_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN

Maximum length (in bytes) of outgoing plaintext fragments.

This determines the size of the outgoing TLS I/O buffer in such a way that it is capable of holding the specified amount of plaintext data, regardless of the protection mechanism used.

If this option undefined, it inherits its value from MBEDTLS_SSL_MAX_CONTENT_LEN.

It is possible to save RAM by setting a smaller outward buffer, while keeping the default inward 16384 byte buffer to conform to the TLS specification.

The minimum required outward buffer size is determined by the handshake protocol's usage. Handshaking will fail if the outward buffer is too small. The specific size requirement depends on the configured ciphers and any certificate data which is sent during the handshake.

Uncomment to set the maximum plaintext size of the outgoing I/O buffer independently of the incoming I/O buffer.

◆ MBEDTLS_SSL_PRESET_DEFAULT

#define MBEDTLS_SSL_PRESET_DEFAULT 0

◆ MBEDTLS_SSL_PRESET_SUITEB

#define MBEDTLS_SSL_PRESET_SUITEB 2

◆ MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT

#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16

◆ MBEDTLS_SSL_RENEGOTIATION_DISABLED

#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0

◆ MBEDTLS_SSL_RENEGOTIATION_ENABLED

#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1

◆ MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED

#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1

◆ MBEDTLS_SSL_SECURE_RENEGOTIATION

#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1

◆ MBEDTLS_SSL_SESSION_TICKETS_DISABLED

#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0

◆ MBEDTLS_SSL_SESSION_TICKETS_ENABLED

#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1

◆ MBEDTLS_SSL_SIG_ANON

#define MBEDTLS_SSL_SIG_ANON 0

◆ MBEDTLS_SSL_SIG_ECDSA

#define MBEDTLS_SSL_SIG_ECDSA 3

◆ MBEDTLS_SSL_SIG_RSA

#define MBEDTLS_SSL_SIG_RSA 1

◆ MBEDTLS_SSL_TRANSPORT_DATAGRAM

#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1

DTLS

◆ MBEDTLS_SSL_TRANSPORT_STREAM

#define MBEDTLS_SSL_TRANSPORT_STREAM 0

TLS

◆ MBEDTLS_SSL_TRUNC_HMAC_DISABLED

#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0

◆ MBEDTLS_SSL_TRUNC_HMAC_ENABLED

#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1

◆ MBEDTLS_SSL_TRUNCATED_HMAC_LEN

#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */

◆ MBEDTLS_SSL_VERIFY_DATA_MAX_LEN

#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12

◆ MBEDTLS_SSL_VERIFY_NONE

#define MBEDTLS_SSL_VERIFY_NONE 0

◆ MBEDTLS_SSL_VERIFY_OPTIONAL

#define MBEDTLS_SSL_VERIFY_OPTIONAL 1

◆ MBEDTLS_SSL_VERIFY_REQUIRED

#define MBEDTLS_SSL_VERIFY_REQUIRED 2

◆ MBEDTLS_SSL_VERIFY_UNSET

#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */

◆ MBEDTLS_TLS_EXT_ALPN

#define MBEDTLS_TLS_EXT_ALPN 16

◆ MBEDTLS_TLS_EXT_ECJPAKE_KKPP

#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */

◆ MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC

#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */

◆ MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET

#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */

◆ MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH

#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1

◆ MBEDTLS_TLS_EXT_RENEGOTIATION_INFO

#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01

◆ MBEDTLS_TLS_EXT_SERVERNAME

#define MBEDTLS_TLS_EXT_SERVERNAME 0

◆ MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME

#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0

◆ MBEDTLS_TLS_EXT_SESSION_TICKET

#define MBEDTLS_TLS_EXT_SESSION_TICKET 35

◆ MBEDTLS_TLS_EXT_SIG_ALG

#define MBEDTLS_TLS_EXT_SIG_ALG 13

◆ MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES

#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10

◆ MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS

#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11

◆ MBEDTLS_TLS_EXT_TRUNCATED_HMAC

#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4

Typedef Documentation

◆ mbedtls_ssl_config

typedef struct mbedtls_ssl_config mbedtls_ssl_config

◆ mbedtls_ssl_context

typedef struct mbedtls_ssl_context mbedtls_ssl_context

◆ mbedtls_ssl_cookie_check_t

typedef int mbedtls_ssl_cookie_check_t(void *ctx, const unsigned char *cookie, size_t clen, const unsigned char *info, size_t ilen)

Callback type: verify a cookie.

Parameters

ctx	Context for the callback
cookie	Cookie to verify
clen	Length of cookie
info	Client ID info that was passed to `mbedtls_ssl_set_client_transport_id()`
ilen	Length of info in bytes

Returns: The callback must return 0 if cookie is valid, or a negative error code.

◆ mbedtls_ssl_cookie_write_t

typedef int mbedtls_ssl_cookie_write_t(void *ctx, unsigned char **p, unsigned char *end, const unsigned char *info, size_t ilen)

Callback type: generate a cookie.

Parameters

ctx	Context for the callback
p	Buffer to write to, must be updated to point right after the cookie
end	Pointer to one past the end of the output buffer
info	Client ID info that was passed to `mbedtls_ssl_set_client_transport_id()`
ilen	Length of info in bytes

Returns: The callback must return 0 on success, or a negative error code.

◆ mbedtls_ssl_get_timer_t

typedef int mbedtls_ssl_get_timer_t(void *ctx)

Callback type: get status of timers/delays.

Parameters

ctx	Context pointer

Returns: This callback must return: -1 if cancelled (fin_ms == 0), 0 if none of the delays have passed, 1 if only the intermediate delay has passed, 2 if the final delay has passed.

◆ mbedtls_ssl_handshake_params

typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params

◆ mbedtls_ssl_recv_t

typedef int mbedtls_ssl_recv_t(void *ctx, unsigned char *buf, size_t len)

Callback type: receive data from the network.

Note: That callback may be either blocking or non-blocking.

Parameters

ctx	Context for the receive callback (typically a file descriptor)
buf	Buffer to write the received data to
len	Length of the receive buffer

Returns: The callback must return the number of bytes received, or a non-zero error code. If performing non-blocking I/O, MBEDTLS_ERR_SSL_WANT_READ must be returned when the operation would block.

Note: The callback may receive fewer bytes than the length of the buffer. It must always return the number of bytes actually received and written to the buffer.

◆ mbedtls_ssl_recv_timeout_t

typedef int mbedtls_ssl_recv_timeout_t(void *ctx, unsigned char *buf, size_t len, uint32_t timeout)

Callback type: receive data from the network, with timeout.

Note: That callback must block until data is received, or the timeout delay expires, or the operation is interrupted by a signal.

Parameters

ctx	Context for the receive callback (typically a file descriptor)
buf	Buffer to write the received data to
len	Length of the receive buffer
timeout	Maximum nomber of millisecondes to wait for data 0 means no timeout (potentially waiting forever)

Returns: The callback must return the number of bytes received, or a non-zero error code: MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out, MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.

Note: The callback may receive fewer bytes than the length of the buffer. It must always return the number of bytes actually received and written to the buffer.

◆ mbedtls_ssl_send_t

typedef int mbedtls_ssl_send_t(void *ctx, const unsigned char *buf, size_t len)

Callback type: send data on the network.

Note: That callback may be either blocking or non-blocking.

Parameters

ctx	Context for the send callback (typically a file descriptor)
buf	Buffer holding the data to send
len	Length of the data to send

Returns: The callback must return the number of bytes sent if any, or a non-zero error code. If performing non-blocking I/O, MBEDTLS_ERR_SSL_WANT_WRITE must be returned when the operation would block.

Note: The callback is allowed to send fewer bytes than requested. It must always return the number of bytes actually sent.

◆ mbedtls_ssl_session

typedef struct mbedtls_ssl_session mbedtls_ssl_session

◆ mbedtls_ssl_set_timer_t

typedef void mbedtls_ssl_set_timer_t(void *ctx, uint32_t int_ms, uint32_t fin_ms)

Callback type: set a pair of timers/delays to watch.

Parameters

ctx	Context pointer
int_ms	Intermediate delay in milliseconds
fin_ms	Final delay in milliseconds 0 cancels the current timer.

Note: This callback must at least store the necessary information for the associated mbedtls_ssl_get_timer_t callback to return correct information.; If using a event-driven style of programming, an event must be generated when the final delay is passed. The event must cause a call to mbedtls_ssl_handshake() with the proper SSL context to be scheduled. Care must be taken to ensure that at most one such call happens at a time.; Only one timer at a time must be running. Calling this function while a timer is running must cancel it. Cancelled timers must not generate any event.

◆ mbedtls_ssl_sig_hash_set_t

typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t

◆ mbedtls_ssl_ticket_parse_t

typedef int mbedtls_ssl_ticket_parse_t(void *p_ticket, mbedtls_ssl_session *session, unsigned char *buf, size_t len)

Callback type: parse and load session ticket.

Note: This describes what a callback implementation should do. This callback should parse a session ticket as generated by the corresponding mbedtls_ssl_ticket_write_t function, and, if the ticket is authentic and valid, load the session.; The implementation is allowed to modify the first len bytes of the input buffer, eg to use it as a temporary area for the decrypted ticket contents.

Parameters

p_ticket	Context for the callback
session	SSL session to be loaded
buf	Start of the buffer containing the ticket
len	Length of the ticket.

Returns: 0 if successful, or MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or any other non-zero code for other failures.

◆ mbedtls_ssl_ticket_write_t

typedef int mbedtls_ssl_ticket_write_t(void *p_ticket, const mbedtls_ssl_session *session, unsigned char *start, const unsigned char *end, size_t *tlen, uint32_t *lifetime)

Callback type: generate and write session ticket.

Note: This describes what a callback implementation should do. This callback should generate an encrypted and authenticated ticket for the session and write it to the output buffer. Here, ticket means the opaque ticket part of the NewSessionTicket structure of RFC 5077.

Parameters

p_ticket	Context for the callback
session	SSL session to be written in the ticket
start	Start of the output buffer
end	End of the output buffer
tlen	On exit, holds the length written
lifetime	On exit, holds the lifetime of the ticket in seconds

Returns: 0 if successful, or a specific MBEDTLS_ERR_XXX code.

◆ mbedtls_ssl_transform

typedef struct mbedtls_ssl_transform mbedtls_ssl_transform

Enumeration Type Documentation

◆ mbedtls_ssl_states

enum mbedtls_ssl_states

Enumerator
MBEDTLS_SSL_HELLO_REQUEST
MBEDTLS_SSL_CLIENT_HELLO
MBEDTLS_SSL_SERVER_HELLO
MBEDTLS_SSL_SERVER_CERTIFICATE
MBEDTLS_SSL_SERVER_KEY_EXCHANGE
MBEDTLS_SSL_CERTIFICATE_REQUEST
MBEDTLS_SSL_SERVER_HELLO_DONE
MBEDTLS_SSL_CLIENT_CERTIFICATE
MBEDTLS_SSL_CLIENT_KEY_EXCHANGE
MBEDTLS_SSL_CERTIFICATE_VERIFY
MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC
MBEDTLS_SSL_CLIENT_FINISHED
MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC
MBEDTLS_SSL_SERVER_FINISHED
MBEDTLS_SSL_FLUSH_BUFFERS
MBEDTLS_SSL_HANDSHAKE_WRAPUP
MBEDTLS_SSL_HANDSHAKE_OVER
MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET
MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT

Function Documentation

◆ mbedtls_ssl_check_pending()

int mbedtls_ssl_check_pending ( const mbedtls_ssl_context * ssl )

Check if there is data already read from the underlying transport but not yet processed.

Parameters

ssl	SSL context

Returns: 0 if nothing's pending, 1 otherwise.

Note: This is different in purpose and behaviour from mbedtls_ssl_get_bytes_avail in that it considers any kind of unprocessed data, not only unread application data. If mbedtls_ssl_get_bytes returns a non-zero value, this function will also signal pending data, but the converse does not hold. For example, in DTLS there might be further records waiting to be processed from the current underlying transport's datagram.; If this function returns 1 (data pending), this does not imply that a subsequent call to mbedtls_ssl_read will provide any data; e.g., the unprocessed data might turn out to be an alert or a handshake message.; This function is useful in the following situation: If the SSL/TLS module successfully returns from an operation - e.g. a handshake or an application record read - and you're awaiting incoming data next, you must not immediately idle on the underlying transport to have data ready, but you need to check the value of this function first. The reason is that the desired data might already be read but not yet processed. If, in contrast, a previous call to the SSL/TLS module returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary to call this function, as the latter error code entails that all internal data has been processed.

◆ mbedtls_ssl_close_notify()

int mbedtls_ssl_close_notify ( mbedtls_ssl_context * ssl )

Notify the peer that the connection is being closed.

Parameters

ssl	SSL context

Returns: 0 if successful, or a specific SSL error code.

Note: If this function returns something other than 0 or MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using the SSL context for reading or writing, and either free it or call mbedtls_ssl_session_reset() on it before re-using it for a new connection; the current connection must be closed.

◆ mbedtls_ssl_conf_authmode()

void mbedtls_ssl_conf_authmode	(	mbedtls_ssl_config *	conf,
		int	authmode
	)

Set the certificate verification mode Default: NONE on server, REQUIRED on client.

Parameters

conf	SSL configuration
authmode	can be:

MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked (default on server) (insecure on client)

MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the handshake continues even if verification failed; mbedtls_ssl_get_verify_result() can be called after the handshake is complete.

MBEDTLS_SSL_VERIFY_REQUIRED: peer must present a valid certificate, handshake is aborted if verification failed. (default on client)

Note: On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode. With MBEDTLS_SSL_VERIFY_OPTIONAL, the user needs to call mbedtls_ssl_get_verify_result() at the right time(s), which may not be obvious, while REQUIRED always perform the verification as soon as possible. For example, REQUIRED was protecting against the "triple handshake" attack even before it was found.

◆ mbedtls_ssl_conf_ciphersuites()

void mbedtls_ssl_conf_ciphersuites	(	mbedtls_ssl_config *	conf,
		const int *	ciphersuites
	)

Set the list of allowed ciphersuites and the preference order. First in the list has the highest preference. (Overrides all version-specific lists)

The ciphersuites array is not copied, and must remain valid for the lifetime of the ssl_config.

Note: The server uses its own preferences over the preference of the client unless MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!

Parameters

conf	SSL configuration
ciphersuites	0-terminated list of allowed ciphersuites

◆ mbedtls_ssl_conf_ciphersuites_for_version()

void mbedtls_ssl_conf_ciphersuites_for_version	(	mbedtls_ssl_config *	conf,
		const int *	ciphersuites,
		int	major,
		int	minor
	)

Set the list of allowed ciphersuites and the preference order for a specific version of the protocol. (Only useful on the server side)

The ciphersuites array is not copied, and must remain valid for the lifetime of the ssl_config.

Parameters

conf	SSL configuration
ciphersuites	0-terminated list of allowed ciphersuites
major	Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
minor	Minor version number (MBEDTLS_SSL_MINOR_VERSION_0, MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2, MBEDTLS_SSL_MINOR_VERSION_3 supported)

Note: With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2

◆ mbedtls_ssl_conf_dbg()

void mbedtls_ssl_conf_dbg	(	mbedtls_ssl_config *	conf,
		void()(void , int, const char , int, const char )	f_dbg,
		void *	p_dbg
	)

Set the debug callback.

            The callback has the following argument:
            void *           opaque context for the callback
            int              debug level
            const char *     file name
            int              line number
            const char *     message

Parameters

conf	SSL configuration
f_dbg	debug function
p_dbg	debug parameter

◆ mbedtls_ssl_conf_endpoint()

void mbedtls_ssl_conf_endpoint	(	mbedtls_ssl_config *	conf,
		int	endpoint
	)

Set the current endpoint type.

Parameters

conf	SSL configuration
endpoint	must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER

◆ mbedtls_ssl_conf_legacy_renegotiation()

void mbedtls_ssl_conf_legacy_renegotiation	(	mbedtls_ssl_config *	conf,
		int	allow_legacy
	)

Prevent or allow legacy renegotiation. (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)

MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to be established even if the peer does not support secure renegotiation, but does not allow renegotiation to take place if not secure. (Interoperable and secure option)

MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations with non-upgraded peers. Allowing legacy renegotiation makes the connection vulnerable to specific man in the middle attacks. (See RFC 5746) (Most interoperable and least secure option)

MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections if peer does not support secure renegotiation. Results in interoperability issues with non-upgraded peers that do not support renegotiation altogether. (Most secure option, interoperability issues)

Parameters

conf	SSL configuration
allow_legacy	Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION, SSL_ALLOW_LEGACY_RENEGOTIATION or MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)

◆ mbedtls_ssl_conf_max_version()

void mbedtls_ssl_conf_max_version	(	mbedtls_ssl_config *	conf,
		int	major,
		int	minor
	)

Set the maximum supported version sent from the client side and/or accepted at the server side (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)

Note: This ignores ciphersuites from higher versions.; With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2

Parameters

conf	SSL configuration
major	Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
minor	Minor version number (MBEDTLS_SSL_MINOR_VERSION_0, MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2, MBEDTLS_SSL_MINOR_VERSION_3 supported)

◆ mbedtls_ssl_conf_min_version()

void mbedtls_ssl_conf_min_version	(	mbedtls_ssl_config *	conf,
		int	major,
		int	minor
	)

Set the minimum accepted SSL/TLS protocol version (Default: TLS 1.0)

Note: Input outside of the SSL_MAX_XXXXX_VERSION and SSL_MIN_XXXXX_VERSION range is ignored.; MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.; With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2

Parameters

conf	SSL configuration
major	Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
minor	Minor version number (MBEDTLS_SSL_MINOR_VERSION_0, MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2, MBEDTLS_SSL_MINOR_VERSION_3 supported)

◆ mbedtls_ssl_conf_read_timeout()

void mbedtls_ssl_conf_read_timeout	(	mbedtls_ssl_config *	conf,
		uint32_t	timeout
	)

Set the timeout period for mbedtls_ssl_read() (Default: no timeout.)

Parameters

conf	SSL configuration context
timeout	Timeout value in milliseconds. Use 0 for no timeout (default).

Note: With blocking I/O, this will only work if a non-NULL f_recv_timeout was set with mbedtls_ssl_set_bio(). With non-blocking I/O, this will only work if timer callbacks were set with mbedtls_ssl_set_timer_cb().; With non-blocking I/O, you may also skip this function altogether and handle timeouts at the application layer.

◆ mbedtls_ssl_conf_rng()

void mbedtls_ssl_conf_rng	(	mbedtls_ssl_config *	conf,
		int()(void , unsigned char *, size_t)	f_rng,
		void *	p_rng
	)

Set the random number generator callback.

Parameters

conf	SSL configuration
f_rng	RNG function
p_rng	RNG parameter

◆ mbedtls_ssl_conf_transport()

void mbedtls_ssl_conf_transport	(	mbedtls_ssl_config *	conf,
		int	transport
	)

Set the transport type (TLS or DTLS). Default: TLS.

Note: For DTLS, you must either provide a recv callback that doesn't block, or one that handles timeouts, see mbedtls_ssl_set_bio(). You also need to provide timer callbacks with mbedtls_ssl_set_timer_cb().

Parameters

conf	SSL configuration
transport	transport type: MBEDTLS_SSL_TRANSPORT_STREAM for TLS, MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.

◆ mbedtls_ssl_config_defaults()

int mbedtls_ssl_config_defaults	(	mbedtls_ssl_config *	conf,
		int	endpoint,
		int	transport,
		int	preset
	)

Load reasonnable default SSL configuration values. (You need to call mbedtls_ssl_config_init() first.)

Parameters

conf	SSL configuration context
endpoint	MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
transport	MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
preset	a MBEDTLS_SSL_PRESET_XXX value

Note: See mbedtls_ssl_conf_transport() for notes on DTLS.

Returns: 0 if successful, or MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.

◆ mbedtls_ssl_config_free()

void mbedtls_ssl_config_free ( mbedtls_ssl_config * conf )

Free an SSL configuration context.

Parameters

conf	SSL configuration context

◆ mbedtls_ssl_config_init()

void mbedtls_ssl_config_init ( mbedtls_ssl_config * conf )

Initialize an SSL configuration context Just makes the context ready for mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().

Note: You need to call mbedtls_ssl_config_defaults() unless you manually set all of the relevent fields yourself.

Parameters

conf	SSL configuration context

◆ mbedtls_ssl_free()

void mbedtls_ssl_free ( mbedtls_ssl_context * ssl )

Free referenced items in an SSL context and clear memory.

Parameters

ssl	SSL context

◆ mbedtls_ssl_get_bytes_avail()

size_t mbedtls_ssl_get_bytes_avail ( const mbedtls_ssl_context * ssl )

Return the number of application data bytes remaining to be read from the current record.

Parameters

ssl	SSL context

Returns: How many bytes are available in the application data record read buffer.

Note: When working over a datagram transport, this is useful to detect the current datagram's boundary in case mbedtls_ssl_read has written the maximal amount of data fitting into the input buffer.

◆ mbedtls_ssl_get_ciphersuite()

const char* mbedtls_ssl_get_ciphersuite ( const mbedtls_ssl_context * ssl )

Return the name of the current ciphersuite.

Parameters

ssl	SSL context

Returns: a string containing the ciphersuite name

◆ mbedtls_ssl_get_ciphersuite_id()

int mbedtls_ssl_get_ciphersuite_id ( const char * ciphersuite_name )

Return the ID of the ciphersuite associated with the given name.

Parameters

ciphersuite_name SSL ciphersuite name

Returns: the ID with the ciphersuite or 0 if not found

◆ mbedtls_ssl_get_ciphersuite_name()

const char* mbedtls_ssl_get_ciphersuite_name ( const int ciphersuite_id )

Return the name of the ciphersuite associated with the given ID.

Parameters

ciphersuite_id SSL ciphersuite ID

Returns: a string containing the ciphersuite name

◆ mbedtls_ssl_get_max_out_record_payload()

int mbedtls_ssl_get_max_out_record_payload ( const mbedtls_ssl_context * ssl )

Return the current maximum outgoing record payload in bytes. This takes into account the config.h setting MBEDTLS_SSL_OUT_CONTENT_LEN, the configured and negotiated max fragment length extension if used, and for DTLS the path MTU as configured and current record expansion.

Note: With DTLS, mbedtls_ssl_write() will return an error if called with a larger length value. With TLS, mbedtls_ssl_write() will fragment the input if necessary and return the number of bytes written; it is up to the caller to call mbedtls_ssl_write() again in order to send the remaining bytes if any.; This function is not available (always returns an error) when record compression is enabled.

See also: mbedtls_ssl_set_mtu(); mbedtls_ssl_get_max_frag_len(); mbedtls_ssl_get_record_expansion()

Parameters

ssl	SSL context

Returns: Current maximum payload for an outgoing record, or a negative error code.

◆ mbedtls_ssl_get_record_expansion()

int mbedtls_ssl_get_record_expansion ( const mbedtls_ssl_context * ssl )

Return the (maximum) number of bytes added by the record layer: header + encryption/MAC overhead (inc. padding)

Note: This function is not available (always returns an error) when record compression is enabled.

Parameters

ssl	SSL context

Returns: Current maximum record expansion in bytes, or MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is enabled, which makes expansion much less predictable

◆ mbedtls_ssl_get_verify_result()

uint32_t mbedtls_ssl_get_verify_result ( const mbedtls_ssl_context * ssl )

Return the result of the certificate verification.

Parameters

ssl	The SSL context to use.

Returns: 0 if the certificate verification was successful.; -1u if the result is not available. This may happen e.g. if the handshake aborts early, or a verification callback returned a fatal error.; A bitwise combination of MBEDTLS_X509_BADCERT_XXX and MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.

◆ mbedtls_ssl_get_version()

const char* mbedtls_ssl_get_version ( const mbedtls_ssl_context * ssl )

Return the current SSL version (SSLv3/TLSv1/etc)

Parameters

ssl	SSL context

Returns: a string containing the SSL version

◆ mbedtls_ssl_handshake()

int mbedtls_ssl_handshake ( mbedtls_ssl_context * ssl )

Perform the SSL handshake.

Parameters

ssl	SSL context

Returns: 0 if successful.; MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE if the handshake is incomplete and waiting for data to be available for reading from or writing to the underlying transport - in this case you must call this function again when the underlying transport is ready for the operation.; MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous operation is in progress (see mbedtls_ssl_conf_async_private_cb()) - in this case you must call this function again when the operation is ready.; MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic operation is in progress (see mbedtls_ecp_set_max_ops()) - in this case you must call this function again to complete the handshake when you're done attending other tasks.; MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use and the client did not demonstrate reachability yet - in this case you must stop using the context (see below).; Another SSL error code - in this case you must stop using the context (see below).

Warning: If this function returns something other than 0, MBEDTLS_ERR_SSL_WANT_READ, MBEDTLS_ERR_SSL_WANT_WRITE, MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using the SSL context for reading or writing, and either free it or call mbedtls_ssl_session_reset() on it before re-using it for a new connection; the current connection must be closed.

Note: If DTLS is in use, then you may choose to handle MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging purposes, as it is an expected return value rather than an actual error, but you still need to reset/free the context.; Remarks regarding event-driven DTLS: If the function returns MBEDTLS_ERR_SSL_WANT_READ, no datagram from the underlying transport layer is currently being processed, and it is safe to idle until the timer or the underlying transport signal a new event. This is not true for a successful handshake, in which case the datagram of the underlying transport that is currently being processed might or might not contain further DTLS records.

◆ mbedtls_ssl_handshake_step()

int mbedtls_ssl_handshake_step ( mbedtls_ssl_context * ssl )

Perform a single step of the SSL handshake.

Note: The state of the context (ssl->state) will be at the next state after this function returns 0. Do not call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.

Parameters

ssl	SSL context

Returns: See mbedtls_ssl_handshake().

Warning: If this function returns something other than 0, MBEDTLS_ERR_SSL_WANT_READ, MBEDTLS_ERR_SSL_WANT_WRITE, MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using the SSL context for reading or writing, and either free it or call mbedtls_ssl_session_reset() on it before re-using it for a new connection; the current connection must be closed.

◆ mbedtls_ssl_init()

void mbedtls_ssl_init ( mbedtls_ssl_context * ssl )

Initialize an SSL context Just makes the context ready for mbedtls_ssl_setup() or mbedtls_ssl_free()

Parameters

ssl	SSL context

◆ mbedtls_ssl_read()

int mbedtls_ssl_read	(	mbedtls_ssl_context *	ssl,
		unsigned char *	buf,
		size_t	len
	)

Read at most 'len' application data bytes.

Parameters

ssl	SSL context
buf	buffer that will hold the data
len	maximum number of bytes to read

Returns

The (positive) number of bytes read if successful.

0 if the read end of the underlying transport was closed

in this case you must stop using the context (see below).

MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE if the handshake is incomplete and waiting for data to be available for reading from or writing to the underlying transport - in this case you must call this function again when the underlying transport is ready for the operation.

MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous operation is in progress (see mbedtls_ssl_conf_async_private_cb()) - in this case you must call this function again when the operation is ready.

MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic operation is in progress (see mbedtls_ecp_set_max_ops()) - in this case you must call this function again to complete the handshake when you're done attending other tasks.

MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server side of a DTLS connection and the client is initiating a new connection using the same source port. See below.

Another SSL error code - in this case you must stop using the context (see below).

Warning: If this function returns something other than a positive value, MBEDTLS_ERR_SSL_WANT_READ, MBEDTLS_ERR_SSL_WANT_WRITE, MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or MBEDTLS_ERR_SSL_CLIENT_RECONNECT, you must stop using the SSL context for reading or writing, and either free it or call mbedtls_ssl_session_reset() on it before re-using it for a new connection; the current connection must be closed.

Note

When this function returns MBEDTLS_ERR_SSL_CLIENT_RECONNECT (which can only happen server-side), it means that a client is initiating a new connection using the same source port. You can either treat that as a connection close and wait for the client to resend a ClientHello, or directly continue with mbedtls_ssl_handshake() with the same context (as it has been reset internally). Either way, you must make sure this is seen by the application as a new connection: application state, if any, should be reset, and most importantly the identity of the client must be checked again. WARNING: not validating the identity of the client again, or not transmitting the new identity to the application layer, would allow authentication bypass!

Remarks regarding event-driven DTLS:

If the function returns MBEDTLS_ERR_SSL_WANT_READ, no datagram from the underlying transport layer is currently being processed, and it is safe to idle until the timer or the underlying transport signal a new event.
This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was initially available on the underlying transport, as this data may have been only e.g. duplicated messages or a renegotiation request. Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even when reacting to an incoming-data event from the underlying transport.
On success, the datagram of the underlying transport that is currently being processed may contain further DTLS records. You should call mbedtls_ssl_check_pending to check for remaining records.

◆ mbedtls_ssl_send_alert_message()

int mbedtls_ssl_send_alert_message	(	mbedtls_ssl_context *	ssl,
		unsigned char	level,
		unsigned char	message
	)

Send an alert message.

Parameters

ssl	SSL context
level	The alert level of the message (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
message	The alert message (SSL_ALERT_MSG_*)

Returns: 0 if successful, or a specific SSL error code.

Note: If this function returns something other than 0 or MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using the SSL context for reading or writing, and either free it or call mbedtls_ssl_session_reset() on it before re-using it for a new connection; the current connection must be closed.

◆ mbedtls_ssl_session_free()

void mbedtls_ssl_session_free ( mbedtls_ssl_session * session )

Free referenced items in an SSL session including the peer certificate and clear memory.

Note: A session object can be freed even if the SSL context that was used to retrieve the session is still in use.

Parameters

session SSL session

◆ mbedtls_ssl_session_init()

void mbedtls_ssl_session_init ( mbedtls_ssl_session * session )

Initialize SSL session structure.

Parameters

session SSL session

◆ mbedtls_ssl_session_reset()

int mbedtls_ssl_session_reset ( mbedtls_ssl_context * ssl )

Reset an already initialized SSL context for re-use while retaining application-set variables, function pointers and data.

Parameters

ssl	SSL context

Returns: 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED, MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or MBEDTLS_ERR_SSL_COMPRESSION_FAILED

◆ mbedtls_ssl_set_bio()

void mbedtls_ssl_set_bio	(	mbedtls_ssl_context *	ssl,
		void *	p_bio,
		mbedtls_ssl_send_t *	f_send,
		mbedtls_ssl_recv_t *	f_recv,
		mbedtls_ssl_recv_timeout_t *	f_recv_timeout
	)

Set the underlying BIO callbacks for write, read and read-with-timeout.

Parameters

ssl	SSL context
p_bio	parameter (context) shared by BIO callbacks
f_send	write callback
f_recv	read callback
f_recv_timeout	blocking read callback with timeout.

Note

One of f_recv or f_recv_timeout can be NULL, in which case the other is used. If both are non-NULL, f_recv_timeout is used and f_recv is ignored (as if it were NULL).

The two most common use cases are:

non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
blocking I/O, f_recv == NULL, f_recv_timout != NULL

For DTLS, you need to provide either a non-NULL f_recv_timeout callback, or a f_recv that doesn't block.

See the documentations of mbedtls_ssl_sent_t, mbedtls_ssl_recv_t and mbedtls_ssl_recv_timeout_t for the conventions those callbacks must follow.

On some platforms, net_sockets.c provides mbedtls_net_send(), mbedtls_net_recv() and mbedtls_net_recv_timeout() that are suitable to be used here.

◆ mbedtls_ssl_set_timer_cb()

void mbedtls_ssl_set_timer_cb	(	mbedtls_ssl_context *	ssl,
		void *	p_timer,
		mbedtls_ssl_set_timer_t *	f_set_timer,
		mbedtls_ssl_get_timer_t *	f_get_timer
	)

Set the timer callbacks (Mandatory for DTLS.)

Parameters

ssl	SSL context
p_timer	parameter (context) shared by timer callbacks
f_set_timer	set timer callback
f_get_timer	get timer callback. Must return:

Note: See the documentation of mbedtls_ssl_set_timer_t and mbedtls_ssl_get_timer_t for the conventions this pair of callbacks must follow.; On some platforms, timing.c provides mbedtls_timing_set_delay() and mbedtls_timing_get_delay() that are suitable for using here, except if using an event-driven style.; See also the "DTLS tutorial" article in our knowledge base. https://tls.mbed.org/kb/how-to/dtls-tutorial

◆ mbedtls_ssl_setup()

int mbedtls_ssl_setup	(	mbedtls_ssl_context *	ssl,
		const mbedtls_ssl_config *	conf
	)

Set up an SSL context for use.

Note: No copy of the configuration context is made, it can be shared by many mbedtls_ssl_context structures.

Warning: The conf structure will be accessed during the session. It must not be modified or freed as long as the session is active.; This function must be called exactly once per context. Calling mbedtls_ssl_setup again is not supported, even if no session is active.

Parameters

ssl	SSL context
conf	SSL configuration to use

Returns: 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed

◆ mbedtls_ssl_write()

int mbedtls_ssl_write	(	mbedtls_ssl_context *	ssl,
		const unsigned char *	buf,
		size_t	len
	)

Try to write exactly 'len' application data bytes.

Warning: This function will do partial writes in some cases. If the return value is non-negative but less than length, the function must be called again with updated arguments: buf + ret, len - ret (if ret is the return value) until it returns a value equal to the last 'len' argument.

Parameters

ssl	SSL context
buf	buffer holding the data
len	how many bytes must be written

Returns: The (non-negative) number of bytes actually written if successful (may be less than len).; MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE if the handshake is incomplete and waiting for data to be available for reading from or writing to the underlying transport - in this case you must call this function again when the underlying transport is ready for the operation.; MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous operation is in progress (see mbedtls_ssl_conf_async_private_cb()) - in this case you must call this function again when the operation is ready.; MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic operation is in progress (see mbedtls_ecp_set_max_ops()) - in this case you must call this function again to complete the handshake when you're done attending other tasks.; Another SSL error code - in this case you must stop using the context (see below).

Warning: If this function returns something other than a non-negative value, MBEDTLS_ERR_SSL_WANT_READ, MBEDTLS_ERR_SSL_WANT_WRITE, MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using the SSL context for reading or writing, and either free it or call mbedtls_ssl_session_reset() on it before re-using it for a new connection; the current connection must be closed.

Note

When this function returns MBEDTLS_ERR_SSL_WANT_WRITE/READ, it must be called later with the same arguments, until it returns a value greater that or equal to 0. When the function returns MBEDTLS_ERR_SSL_WANT_WRITE there may be some partial data in the output buffer, however this is not yet sent.

If the requested length is greater than the maximum fragment length (either the built-in limit or the one set or negotiated with the peer), then:

with TLS, less bytes than requested are written.
with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned. mbedtls_ssl_get_max_frag_len() may be used to query the active maximum fragment length.

Attempting to write 0 bytes will result in an empty TLS application record being sent.

Enumerations
enum	mbedtls_ssl_states { MBEDTLS_SSL_HELLO_REQUEST, MBEDTLS_SSL_CLIENT_HELLO, MBEDTLS_SSL_SERVER_HELLO, MBEDTLS_SSL_SERVER_CERTIFICATE, MBEDTLS_SSL_SERVER_KEY_EXCHANGE, MBEDTLS_SSL_CERTIFICATE_REQUEST, MBEDTLS_SSL_SERVER_HELLO_DONE, MBEDTLS_SSL_CLIENT_CERTIFICATE, MBEDTLS_SSL_CLIENT_KEY_EXCHANGE, MBEDTLS_SSL_CERTIFICATE_VERIFY, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC, MBEDTLS_SSL_CLIENT_FINISHED, MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC, MBEDTLS_SSL_SERVER_FINISHED, MBEDTLS_SSL_FLUSH_BUFFERS, MBEDTLS_SSL_HANDSHAKE_WRAPUP, MBEDTLS_SSL_HANDSHAKE_OVER, MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET, MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT }

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ MBEDTLS_ERR_SSL_ALLOC_FAILED

◆ MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS

◆ MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE

◆ MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST

◆ MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY

◆ MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC

◆ MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO

◆ MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE

◆ MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS

◆ MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP

◆ MBEDTLS_ERR_SSL_BAD_HS_FINISHED

◆ MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET

◆ MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION

◆ MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO

◆ MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE

◆ MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE

◆ MBEDTLS_ERR_SSL_BAD_INPUT_DATA

◆ MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL

◆ MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED

◆ MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED

◆ MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE

◆ MBEDTLS_ERR_SSL_CLIENT_RECONNECT

◆ MBEDTLS_ERR_SSL_COMPRESSION_FAILED

◆ MBEDTLS_ERR_SSL_CONN_EOF

◆ MBEDTLS_ERR_SSL_CONTINUE_PROCESSING

◆ MBEDTLS_ERR_SSL_COUNTER_WRAPPING

◆ MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS

◆ MBEDTLS_ERR_SSL_EARLY_MESSAGE

◆ MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE

◆ MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE

◆ MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED

◆ MBEDTLS_ERR_SSL_HW_ACCEL_FAILED

◆ MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH

◆ MBEDTLS_ERR_SSL_INTERNAL_ERROR

◆ MBEDTLS_ERR_SSL_INVALID_MAC

◆ MBEDTLS_ERR_SSL_INVALID_RECORD

◆ MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH

◆ MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN

◆ MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE

◆ MBEDTLS_ERR_SSL_NO_RNG

◆ MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE

◆ MBEDTLS_ERR_SSL_NON_FATAL

◆ MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY

◆ MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED

◆ MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH

◆ MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED

◆ MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED

◆ MBEDTLS_ERR_SSL_TIMEOUT

◆ MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE

◆ MBEDTLS_ERR_SSL_UNEXPECTED_RECORD

◆ MBEDTLS_ERR_SSL_UNKNOWN_CIPHER

◆ MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY

◆ MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO

◆ MBEDTLS_ERR_SSL_WANT_READ

◆ MBEDTLS_ERR_SSL_WANT_WRITE

◆ MBEDTLS_PREMASTER_SIZE

◆ MBEDTLS_PSK_MAX_LEN

◆ MBEDTLS_SSL_ALERT_LEVEL_FATAL

◆ MBEDTLS_SSL_ALERT_LEVEL_WARNING

◆ MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED

◆ MBEDTLS_SSL_ALERT_MSG_BAD_CERT

◆ MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC

◆ MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED

◆ MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED

◆ MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN

◆ MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY

◆ MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR

◆ MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE

◆ MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR

◆ MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED

◆ MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION

◆ MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE

◆ MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER