Mbed TLS v3.5.2
Loading...
Searching...
No Matches
ssl.h
Go to the documentation of this file.
1
6/*
7 * Copyright The Mbed TLS Contributors
8 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9 */
10#ifndef MBEDTLS_SSL_H
11#define MBEDTLS_SSL_H
14
15#include "mbedtls/build_info.h"
16
17#include "mbedtls/bignum.h"
18#include "mbedtls/ecp.h"
19
21
22#if defined(MBEDTLS_X509_CRT_PARSE_C)
23#include "mbedtls/x509_crt.h"
24#include "mbedtls/x509_crl.h"
25#endif
26
27#if defined(MBEDTLS_DHM_C)
28#include "mbedtls/dhm.h"
29#endif
30
31#include "mbedtls/md.h"
32
33#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED)
34#include "mbedtls/ecdh.h"
35#endif
36
37#if defined(MBEDTLS_HAVE_TIME)
39#endif
40
41#include "psa/crypto.h"
42
43/*
44 * SSL Error codes
45 */
47#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000
49#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
51#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100
53#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180
55#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200
57#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280
59#define MBEDTLS_ERR_SSL_DECODE_ERROR -0x7300
60/* Error space gap */
62#define MBEDTLS_ERR_SSL_NO_RNG -0x7400
64#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
66#define MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION -0x7500
68#define MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL -0x7580
70#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
72#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
74#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
76#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
78#define MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME -0x7800
80#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
81/* Error space gap */
82/* Error space gap */
84#define MBEDTLS_ERR_SSL_BAD_CERTIFICATE -0x7A00
85/* Error space gap */
90#define MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET -0x7B00
92#define MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA -0x7B80
94#define MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA -0x7C00
95/* Error space gap */
96/* Error space gap */
97/* Error space gap */
98/* Error space gap */
100#define MBEDTLS_ERR_SSL_CACHE_ENTRY_NOT_FOUND -0x7E80
102#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00
104#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80
106#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
108#define MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION -0x6E80
110#define MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE -0x6E00
112#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80
114#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00
116#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80
118#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00
120#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80
122#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00
124#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80
126#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00
127/* Error space gap */
129#define MBEDTLS_ERR_SSL_WANT_READ -0x6900
131#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880
133#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800
135#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780
137#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700
139#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680
141#define MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER -0x6600
143#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580
145#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500
147#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480
148/* Error space gap */
149/* Error space gap */
150/* Error space gap */
151/* Error space gap */
152/* Error space gap */
153/* Error space gap */
154/* Error space gap */
155/* Error space gap */
157#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000
159#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00
161#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80
162
163/*
164 * Constants from RFC 8446 for TLS 1.3 PSK modes
165 *
166 * Those are used in the Pre-Shared Key Exchange Modes extension.
167 * See Section 4.2.9 in RFC 8446.
168 */
169#define MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE 0 /* Pure PSK-based exchange */
170#define MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE 1 /* PSK+ECDHE-based exchange */
171
172/*
173 * TLS 1.3 NamedGroup values
174 *
175 * From RF 8446
176 * enum {
177 * // Elliptic Curve Groups (ECDHE)
178 * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019),
179 * x25519(0x001D), x448(0x001E),
180 * // Finite Field Groups (DHE)
181 * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102),
182 * ffdhe6144(0x0103), ffdhe8192(0x0104),
183 * // Reserved Code Points
184 * ffdhe_private_use(0x01FC..0x01FF),
185 * ecdhe_private_use(0xFE00..0xFEFF),
186 * (0xFFFF)
187 * } NamedGroup;
188 *
189 */
190
191/* Elliptic Curve Groups (ECDHE) */
192#define MBEDTLS_SSL_IANA_TLS_GROUP_NONE 0
193#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 0x0012
194#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 0x0013
195#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 0x0014
196#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 0x0015
197#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 0x0016
198#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 0x0017
199#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 0x0018
200#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 0x0019
201#define MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 0x001A
202#define MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 0x001B
203#define MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 0x001C
204#define MBEDTLS_SSL_IANA_TLS_GROUP_X25519 0x001D
205#define MBEDTLS_SSL_IANA_TLS_GROUP_X448 0x001E
206/* Finite Field Groups (DHE) */
207#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 0x0100
208#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072 0x0101
209#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096 0x0102
210#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144 0x0103
211#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 0x0104
212
213/*
214 * TLS 1.3 Key Exchange Modes
215 *
216 * Mbed TLS internal identifiers for use with the SSL configuration API
217 * mbedtls_ssl_conf_tls13_key_exchange_modes().
218 */
219
220#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK (1u << 0)
223#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL (1u << 1)
226#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL (1u << 2)
230/* Convenience macros for sets of key exchanges. */
231#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL \
232 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
233 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL | \
234 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL)
235#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL \
236 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
237 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL)
238#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL \
239 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL | \
240 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL)
242#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE (0)
243
244/*
245 * Various constants
246 */
247
248#if !defined(MBEDTLS_DEPRECATED_REMOVED)
249/* These are the high and low bytes of ProtocolVersion as defined by:
250 * - RFC 5246: ProtocolVersion version = { 3, 3 }; // TLS v1.2
251 * - RFC 8446: see section 4.2.1
252 */
253#define MBEDTLS_SSL_MAJOR_VERSION_3 3
254#define MBEDTLS_SSL_MINOR_VERSION_3 3
255#define MBEDTLS_SSL_MINOR_VERSION_4 4
256#endif /* MBEDTLS_DEPRECATED_REMOVED */
257
258#define MBEDTLS_SSL_TRANSPORT_STREAM 0
259#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1
261#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255
262#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255
264#define MBEDTLS_SSL_MAX_ALPN_LIST_LEN 65535
266/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
267 * NONE must be zero so that memset()ing structure to zero works */
268#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0
269#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1
270#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2
271#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3
272#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4
273#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5
275#define MBEDTLS_SSL_IS_CLIENT 0
276#define MBEDTLS_SSL_IS_SERVER 1
277
278#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
279#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
280
281#define MBEDTLS_SSL_CID_DISABLED 0
282#define MBEDTLS_SSL_CID_ENABLED 1
283
284#define MBEDTLS_SSL_ETM_DISABLED 0
285#define MBEDTLS_SSL_ETM_ENABLED 1
286
287#define MBEDTLS_SSL_COMPRESS_NULL 0
288
289#define MBEDTLS_SSL_VERIFY_NONE 0
290#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
291#define MBEDTLS_SSL_VERIFY_REQUIRED 2
292#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
293
294#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
295#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
296
297#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
298#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
299
300#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
301#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
302
303#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
304#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
305
306#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
307#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
308#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
309
310#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
311#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
312#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
313
314#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
315#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
316
317#define MBEDTLS_SSL_PRESET_DEFAULT 0
318#define MBEDTLS_SSL_PRESET_SUITEB 2
319
320#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
321#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
322
323#define MBEDTLS_SSL_EARLY_DATA_DISABLED 0
324#define MBEDTLS_SSL_EARLY_DATA_ENABLED 1
325
326#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
327#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
328
329#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT 1
330#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER 0
331
332#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
333#if defined(PSA_WANT_ALG_SHA_384)
334#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 48
335#elif defined(PSA_WANT_ALG_SHA_256)
336#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 32
337#endif
338#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
339/*
340 * Default range for DTLS retransmission timer value, in milliseconds.
341 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
342 */
343#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
344#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
345
354/*
355 * Maximum fragment length in bytes,
356 * determines the size of each of the two internal I/O buffers.
357 *
358 * Note: the RFC defines the default size of SSL / TLS messages. If you
359 * change the value here, other clients / servers may not be able to
360 * communicate with you anymore. Only change this value if you control
361 * both sides of the connection and have it reduced at both sides, or
362 * if you're using the Max Fragment Length extension and you know all your
363 * peers are using it too!
364 */
365#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
366#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
367#endif
368
369#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
370#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
371#endif
372
373/*
374 * Maximum number of heap-allocated bytes for the purpose of
375 * DTLS handshake message reassembly and future message buffering.
376 */
377#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
378#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
379#endif
380
381/*
382 * Maximum length of CIDs for incoming and outgoing messages.
383 */
384#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
385#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
386#endif
387
388#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
389#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
390#endif
391
392#if !defined(MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY)
393#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
394#endif
395
396#if !defined(MBEDTLS_SSL_MAX_EARLY_DATA_SIZE)
397#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
398#endif
399
400#if !defined(MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE)
401#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
402#endif
403
404#if !defined(MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH)
405#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
406#endif
407
408#if !defined(MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS)
409#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
410#endif
411
414/*
415 * Default to standard CID mode
416 */
417#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
418 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT)
419#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
420#endif
421
422/*
423 * Length of the verify data for secure renegotiation
424 */
425#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
426
427/*
428 * Signaling ciphersuite values (SCSV)
429 */
430#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF
432/*
433 * Supported Signature and Hash algorithms (For TLS 1.2)
434 * RFC 5246 section 7.4.1.4.1
435 */
436#define MBEDTLS_SSL_HASH_NONE 0
437#define MBEDTLS_SSL_HASH_MD5 1
438#define MBEDTLS_SSL_HASH_SHA1 2
439#define MBEDTLS_SSL_HASH_SHA224 3
440#define MBEDTLS_SSL_HASH_SHA256 4
441#define MBEDTLS_SSL_HASH_SHA384 5
442#define MBEDTLS_SSL_HASH_SHA512 6
443
444#define MBEDTLS_SSL_SIG_ANON 0
445#define MBEDTLS_SSL_SIG_RSA 1
446#define MBEDTLS_SSL_SIG_ECDSA 3
447
448/*
449 * TLS 1.3 signature algorithms
450 * RFC 8446, Section 4.2.2
451 */
452
453/* RSASSA-PKCS1-v1_5 algorithms */
454#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256 0x0401
455#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384 0x0501
456#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512 0x0601
457
458/* ECDSA algorithms */
459#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256 0x0403
460#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384 0x0503
461#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512 0x0603
462
463/* RSASSA-PSS algorithms with public key OID rsaEncryption */
464#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256 0x0804
465#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384 0x0805
466#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512 0x0806
467
468/* EdDSA algorithms */
469#define MBEDTLS_TLS1_3_SIG_ED25519 0x0807
470#define MBEDTLS_TLS1_3_SIG_ED448 0x0808
471
472/* RSASSA-PSS algorithms with public key OID RSASSA-PSS */
473#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA256 0x0809
474#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA384 0x080A
475#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA512 0x080B
476
477/* LEGACY ALGORITHMS */
478#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA1 0x0201
479#define MBEDTLS_TLS1_3_SIG_ECDSA_SHA1 0x0203
480
481#define MBEDTLS_TLS1_3_SIG_NONE 0x0
482
483/*
484 * Client Certificate Types
485 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
486 */
487#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
488#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
489
490/*
491 * Message, alert and handshake types
492 */
493#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
494#define MBEDTLS_SSL_MSG_ALERT 21
495#define MBEDTLS_SSL_MSG_HANDSHAKE 22
496#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
497#define MBEDTLS_SSL_MSG_CID 25
498
499#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
500#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
501
502#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
503#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
504#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
505#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
506#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
507#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
508#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
509#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
510#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
511#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
512#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
513#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
514#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
515#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
516#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
517#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
518#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
519#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
520#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
521#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
522#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
523#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
524#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
525#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
526#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
527#define MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION 109 /* 0x6d -- new in TLS 1.3 */
528#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
529#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
530#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
531#define MBEDTLS_SSL_ALERT_MSG_CERT_REQUIRED 116 /* 0x74 */
532#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
533
534#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
535#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
536#define MBEDTLS_SSL_HS_SERVER_HELLO 2
537#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
538#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
539#define MBEDTLS_SSL_HS_END_OF_EARLY_DATA 5
540#define MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS 8
541#define MBEDTLS_SSL_HS_CERTIFICATE 11
542#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
543#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
544#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
545#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
546#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
547#define MBEDTLS_SSL_HS_FINISHED 20
548#define MBEDTLS_SSL_HS_MESSAGE_HASH 254
549
550/*
551 * TLS extensions
552 */
553#define MBEDTLS_TLS_EXT_SERVERNAME 0
554#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
555
556#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
557
558#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
559#define MBEDTLS_TLS_EXT_STATUS_REQUEST 5 /* RFC 6066 TLS 1.2 and 1.3 */
560
561#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
562#define MBEDTLS_TLS_EXT_SUPPORTED_GROUPS 10 /* RFC 8422,7919 TLS 1.2 and 1.3 */
563#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
564
565#define MBEDTLS_TLS_EXT_SIG_ALG 13 /* RFC 8446 TLS 1.3 */
566#define MBEDTLS_TLS_EXT_USE_SRTP 14
567#define MBEDTLS_TLS_EXT_HEARTBEAT 15 /* RFC 6520 TLS 1.2 and 1.3 */
568#define MBEDTLS_TLS_EXT_ALPN 16
569
570#define MBEDTLS_TLS_EXT_SCT 18 /* RFC 6962 TLS 1.2 and 1.3 */
571#define MBEDTLS_TLS_EXT_CLI_CERT_TYPE 19 /* RFC 7250 TLS 1.2 and 1.3 */
572#define MBEDTLS_TLS_EXT_SERV_CERT_TYPE 20 /* RFC 7250 TLS 1.2 and 1.3 */
573#define MBEDTLS_TLS_EXT_PADDING 21 /* RFC 7685 TLS 1.2 and 1.3 */
574#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
575#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
576
577#define MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT 28 /* RFC 8449 (implemented for TLS 1.3 only) */
578
579#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
580
581#define MBEDTLS_TLS_EXT_PRE_SHARED_KEY 41 /* RFC 8446 TLS 1.3 */
582#define MBEDTLS_TLS_EXT_EARLY_DATA 42 /* RFC 8446 TLS 1.3 */
583#define MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS 43 /* RFC 8446 TLS 1.3 */
584#define MBEDTLS_TLS_EXT_COOKIE 44 /* RFC 8446 TLS 1.3 */
585#define MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES 45 /* RFC 8446 TLS 1.3 */
586
587#define MBEDTLS_TLS_EXT_CERT_AUTH 47 /* RFC 8446 TLS 1.3 */
588#define MBEDTLS_TLS_EXT_OID_FILTERS 48 /* RFC 8446 TLS 1.3 */
589#define MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH 49 /* RFC 8446 TLS 1.3 */
590#define MBEDTLS_TLS_EXT_SIG_ALG_CERT 50 /* RFC 8446 TLS 1.3 */
591#define MBEDTLS_TLS_EXT_KEY_SHARE 51 /* RFC 8446 TLS 1.3 */
592
593#if MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
594#define MBEDTLS_TLS_EXT_CID 54 /* RFC 9146 DTLS 1.2 CID */
595#else
596#define MBEDTLS_TLS_EXT_CID 254 /* Pre-RFC 9146 DTLS 1.2 CID */
597#endif
598
599#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
600
601#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
602
603/*
604 * Size defines
605 */
606#if !defined(MBEDTLS_PSK_MAX_LEN)
607/*
608 * If the library supports TLS 1.3 tickets and the cipher suite
609 * TLS1-3-AES-256-GCM-SHA384, set the PSK maximum length to 48 instead of 32.
610 * That way, the TLS 1.3 client and server are able to resume sessions where
611 * the cipher suite is TLS1-3-AES-256-GCM-SHA384 (pre-shared keys are 48
612 * bytes long in that case).
613 */
614#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
615 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
616 defined(MBEDTLS_AES_C) && defined(MBEDTLS_GCM_C) && \
617 defined(MBEDTLS_MD_CAN_SHA384)
618#define MBEDTLS_PSK_MAX_LEN 48 /* 384 bits */
619#else
620#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
621#endif
622#endif /* !MBEDTLS_PSK_MAX_LEN */
623
624/* Dummy type used only for its size */
626 unsigned char dummy; /* Make the union non-empty even with SSL disabled */
627#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
628 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
629#endif
630#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
631 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
632#endif
633#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
634 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
635 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
636 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
637 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
638#endif
639#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
640 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
641#endif
642#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
644 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
645#endif
646#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
647 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
648#endif
649#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
651 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
652#endif
653#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
654 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
655#endif
656};
657
658#define MBEDTLS_PREMASTER_SIZE sizeof(union mbedtls_ssl_premaster_secret)
659
660#define MBEDTLS_TLS1_3_MD_MAX_SIZE PSA_HASH_MAX_SIZE
661
662
663/* Length in number of bytes of the TLS sequence number */
664#define MBEDTLS_SSL_SEQUENCE_NUMBER_LEN 8
665
666#ifdef __cplusplus
667extern "C" {
668#endif
669
670/*
671 * SSL state machine
672 */
707
725typedef int mbedtls_ssl_send_t(void *ctx,
726 const unsigned char *buf,
727 size_t len);
728
749typedef int mbedtls_ssl_recv_t(void *ctx,
750 unsigned char *buf,
751 size_t len);
752
775typedef int mbedtls_ssl_recv_timeout_t(void *ctx,
776 unsigned char *buf,
777 size_t len,
778 uint32_t timeout);
801typedef void mbedtls_ssl_set_timer_t(void *ctx,
802 uint32_t int_ms,
803 uint32_t fin_ms);
804
816typedef int mbedtls_ssl_get_timer_t(void *ctx);
817
818/* Defined below */
822
823/* Defined in library/ssl_misc.h */
827#if defined(MBEDTLS_X509_CRT_PARSE_C)
829#endif
830#if defined(MBEDTLS_SSL_PROTO_DTLS)
832#endif
833
834#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
835#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION \
836 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK /* 1U << 0 */
837#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION \
838 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL /* 1U << 2 */
839#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA (1U << 3)
840
841#define MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK \
842 (MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION | \
843 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION | \
844 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA)
845#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
846
870typedef int mbedtls_ssl_cache_get_t(void *data,
871 unsigned char const *session_id,
872 size_t session_id_len,
873 mbedtls_ssl_session *session);
892typedef int mbedtls_ssl_cache_set_t(void *data,
893 unsigned char const *session_id,
894 size_t session_id_len,
895 const mbedtls_ssl_session *session);
896
897#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
898#if defined(MBEDTLS_X509_CRT_PARSE_C)
970typedef int mbedtls_ssl_async_sign_t(mbedtls_ssl_context *ssl,
971 mbedtls_x509_crt *cert,
972 mbedtls_md_type_t md_alg,
973 const unsigned char *hash,
974 size_t hash_len);
975
1036typedef int mbedtls_ssl_async_decrypt_t(mbedtls_ssl_context *ssl,
1037 mbedtls_x509_crt *cert,
1038 const unsigned char *input,
1039 size_t input_len);
1040#endif /* MBEDTLS_X509_CRT_PARSE_C */
1041
1084typedef int mbedtls_ssl_async_resume_t(mbedtls_ssl_context *ssl,
1085 unsigned char *output,
1086 size_t *output_len,
1087 size_t output_size);
1088
1106typedef void mbedtls_ssl_async_cancel_t(mbedtls_ssl_context *ssl);
1107#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
1108
1109#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
1110 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1111#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
1112#if defined(MBEDTLS_MD_CAN_SHA256)
1113#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
1114#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
1115#elif defined(MBEDTLS_MD_CAN_SHA384)
1116#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
1117#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
1118#elif defined(MBEDTLS_MD_CAN_SHA1)
1119#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
1120#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
1121#else
1122/* This is already checked in check_config.h, but be sure. */
1123#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
1124#endif
1125#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
1126 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1127
1128typedef struct {
1129 unsigned char client_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1130 unsigned char server_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1131 unsigned char exporter_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1132 unsigned char resumption_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1134
1135#if defined(MBEDTLS_SSL_DTLS_SRTP)
1136
1137#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
1138#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
1139/*
1140 * For code readability use a typedef for DTLS-SRTP profiles
1141 *
1142 * Use_srtp extension protection profiles values as defined in
1143 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
1144 *
1145 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
1146 * must be updated too.
1147 */
1148#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ((uint16_t) 0x0001)
1149#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ((uint16_t) 0x0002)
1150#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ((uint16_t) 0x0005)
1151#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ((uint16_t) 0x0006)
1152/* This one is not iana defined, but for code readability. */
1153#define MBEDTLS_TLS_SRTP_UNSET ((uint16_t) 0x0000)
1154
1155typedef uint16_t mbedtls_ssl_srtp_profile;
1156
1157typedef struct mbedtls_dtls_srtp_info_t {
1159 mbedtls_ssl_srtp_profile MBEDTLS_PRIVATE(chosen_dtls_srtp_profile);
1161 uint16_t MBEDTLS_PRIVATE(mki_len);
1163 unsigned char MBEDTLS_PRIVATE(mki_value)[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
1164}
1165mbedtls_dtls_srtp_info;
1166
1167#endif /* MBEDTLS_SSL_DTLS_SRTP */
1168
1175
1176/*
1177 * This structure is used for storing current session data.
1178 *
1179 * Note: when changing this definition, we need to check and update:
1180 * - in tests/suites/test_suite_ssl.function:
1181 * ssl_populate_session() and ssl_serialize_session_save_load()
1182 * - in library/ssl_tls.c:
1183 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
1184 * mbedtls_ssl_session_save() and ssl_session_load()
1185 * ssl_session_copy()
1186 */
1188#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1189 unsigned char MBEDTLS_PRIVATE(mfl_code);
1190#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
1191
1192 unsigned char MBEDTLS_PRIVATE(exported);
1193
1198
1199#if defined(MBEDTLS_HAVE_TIME)
1201#endif
1202 int MBEDTLS_PRIVATE(ciphersuite);
1203 size_t MBEDTLS_PRIVATE(id_len);
1204 unsigned char MBEDTLS_PRIVATE(id)[32];
1205 unsigned char MBEDTLS_PRIVATE(master)[48];
1207#if defined(MBEDTLS_X509_CRT_PARSE_C)
1208#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1210#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1213 unsigned char *MBEDTLS_PRIVATE(peer_cert_digest);
1214 size_t MBEDTLS_PRIVATE(peer_cert_digest_len);
1215 mbedtls_md_type_t MBEDTLS_PRIVATE(peer_cert_digest_type);
1216#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1217#endif /* MBEDTLS_X509_CRT_PARSE_C */
1218 uint32_t MBEDTLS_PRIVATE(verify_result);
1220#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
1221 unsigned char *MBEDTLS_PRIVATE(ticket);
1222 size_t MBEDTLS_PRIVATE(ticket_len);
1223 uint32_t MBEDTLS_PRIVATE(ticket_lifetime);
1224#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
1225
1226#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
1227 uint8_t MBEDTLS_PRIVATE(endpoint);
1228 uint8_t MBEDTLS_PRIVATE(ticket_flags);
1229 uint32_t MBEDTLS_PRIVATE(ticket_age_add);
1230 uint8_t MBEDTLS_PRIVATE(resumption_key_len);
1231 unsigned char MBEDTLS_PRIVATE(resumption_key)[MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN];
1232
1233#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && defined(MBEDTLS_SSL_CLI_C)
1234 char *MBEDTLS_PRIVATE(hostname);
1235#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION && MBEDTLS_SSL_CLI_C */
1236
1237#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_CLI_C)
1238 mbedtls_time_t MBEDTLS_PRIVATE(ticket_received);
1239#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_CLI_C */
1240
1241#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
1242
1243#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1244 int MBEDTLS_PRIVATE(encrypt_then_mac);
1245#endif
1246
1247#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1249#endif
1250};
1251
1252/*
1253 * Identifiers for PRFs used in various versions of TLS.
1254 */
1263
1264typedef enum {
1266#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1267 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_EARLY_SECRET,
1268 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_EARLY_EXPORTER_SECRET,
1269 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
1270 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
1271 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
1272 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
1273#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1275
1291typedef void mbedtls_ssl_export_keys_t(void *p_expkey,
1293 const unsigned char *secret,
1294 size_t secret_len,
1295 const unsigned char client_random[32],
1296 const unsigned char server_random[32],
1297 mbedtls_tls_prf_types tls_prf_type);
1298
1299#if defined(MBEDTLS_SSL_SRV_C)
1316#endif
1317
1318/* A type for storing user data in a library structure.
1319 *
1320 * The representation of type may change in future versions of the library.
1321 * Only the behaviors guaranteed by documented accessor functions are
1322 * guaranteed to remain stable.
1323 */
1324typedef union {
1325 uintptr_t n; /* typically a handle to an associated object */
1326 void *p; /* typically a pointer to extra data */
1328
1333 /* Group items mostly by size. This helps to reduce memory wasted to
1334 * padding. It also helps to keep smaller fields early in the structure,
1335 * so that elements tend to be in the 128-element direct access window
1336 * on Arm Thumb, which reduces the code size. */
1337
1341 /*
1342 * Flags (could be bit-fields to save RAM, but separate bytes make
1343 * the code smaller on architectures with an instruction for direct
1344 * byte access).
1345 */
1346
1347 uint8_t MBEDTLS_PRIVATE(endpoint);
1348 uint8_t MBEDTLS_PRIVATE(transport);
1349 uint8_t MBEDTLS_PRIVATE(authmode);
1350 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
1351 uint8_t MBEDTLS_PRIVATE(allow_legacy_renegotiation);
1352#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1353 uint8_t MBEDTLS_PRIVATE(mfl_code);
1355#endif
1356#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1357 uint8_t MBEDTLS_PRIVATE(encrypt_then_mac);
1358#endif
1359#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1360 uint8_t MBEDTLS_PRIVATE(extended_ms);
1361#endif
1362#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1363 uint8_t MBEDTLS_PRIVATE(anti_replay);
1364#endif
1365#if defined(MBEDTLS_SSL_RENEGOTIATION)
1366 uint8_t MBEDTLS_PRIVATE(disable_renegotiation);
1367#endif
1368#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1369 defined(MBEDTLS_SSL_CLI_C)
1370 uint8_t MBEDTLS_PRIVATE(session_tickets);
1371#endif
1372
1373#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1374 defined(MBEDTLS_SSL_SRV_C) && \
1375 defined(MBEDTLS_SSL_PROTO_TLS1_3)
1376 uint16_t MBEDTLS_PRIVATE(new_session_tickets_count);
1377#endif
1378
1379#if defined(MBEDTLS_SSL_SRV_C)
1380 uint8_t MBEDTLS_PRIVATE(cert_req_ca_list);
1382 uint8_t MBEDTLS_PRIVATE(respect_cli_pref);
1385#endif
1386#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1387 uint8_t MBEDTLS_PRIVATE(ignore_unexpected_cid);
1390#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1391#if defined(MBEDTLS_SSL_DTLS_SRTP)
1392 uint8_t MBEDTLS_PRIVATE(dtls_srtp_mki_support); /* support having mki_value
1393 in the use_srtp extension? */
1394#endif
1395
1396 /*
1397 * Pointers
1398 */
1399
1401 const int *MBEDTLS_PRIVATE(ciphersuite_list);
1402
1403#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1405 int MBEDTLS_PRIVATE(tls13_kex_modes);
1406#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1407
1409 void(*MBEDTLS_PRIVATE(f_dbg))(void *, int, const char *, int, const char *);
1410 void *MBEDTLS_PRIVATE(p_dbg);
1413 int(*MBEDTLS_PRIVATE(f_rng))(void *, unsigned char *, size_t);
1414 void *MBEDTLS_PRIVATE(p_rng);
1420 void *MBEDTLS_PRIVATE(p_cache);
1422#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1424 int(*MBEDTLS_PRIVATE(f_sni))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1425 void *MBEDTLS_PRIVATE(p_sni);
1426#endif
1427
1428#if defined(MBEDTLS_X509_CRT_PARSE_C)
1430 int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
1431 void *MBEDTLS_PRIVATE(p_vrfy);
1432#endif
1433
1434#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
1435#if defined(MBEDTLS_SSL_SRV_C)
1437 int(*MBEDTLS_PRIVATE(f_psk))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1438 void *MBEDTLS_PRIVATE(p_psk);
1439#endif
1440#endif
1441
1442#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
1444 int(*MBEDTLS_PRIVATE(f_cookie_write))(void *, unsigned char **, unsigned char *,
1445 const unsigned char *, size_t);
1447 int(*MBEDTLS_PRIVATE(f_cookie_check))(void *, const unsigned char *, size_t,
1448 const unsigned char *, size_t);
1449 void *MBEDTLS_PRIVATE(p_cookie);
1450#endif
1451
1452#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
1454 int(*MBEDTLS_PRIVATE(f_ticket_write))(void *, const mbedtls_ssl_session *,
1455 unsigned char *, const unsigned char *, size_t *,
1456 uint32_t *);
1458 int(*MBEDTLS_PRIVATE(f_ticket_parse))(void *, mbedtls_ssl_session *, unsigned char *, size_t);
1459 void *MBEDTLS_PRIVATE(p_ticket);
1460#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
1461#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1462 size_t MBEDTLS_PRIVATE(cid_len);
1463#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1464
1465#if defined(MBEDTLS_X509_CRT_PARSE_C)
1470#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1472 void *MBEDTLS_PRIVATE(p_ca_cb);
1473#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
1474#endif /* MBEDTLS_X509_CRT_PARSE_C */
1475
1476#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
1477#if defined(MBEDTLS_X509_CRT_PARSE_C)
1478 mbedtls_ssl_async_sign_t *MBEDTLS_PRIVATE(f_async_sign_start);
1479 mbedtls_ssl_async_decrypt_t *MBEDTLS_PRIVATE(f_async_decrypt_start);
1480#endif /* MBEDTLS_X509_CRT_PARSE_C */
1481 mbedtls_ssl_async_resume_t *MBEDTLS_PRIVATE(f_async_resume);
1482 mbedtls_ssl_async_cancel_t *MBEDTLS_PRIVATE(f_async_cancel);
1483 void *MBEDTLS_PRIVATE(p_async_config_data);
1484#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
1485
1486#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
1487
1488#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1489 const int *MBEDTLS_PRIVATE(sig_hashes);
1490#endif
1491 const uint16_t *MBEDTLS_PRIVATE(sig_algs);
1492#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
1493
1494#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
1496#endif
1497
1498 const uint16_t *MBEDTLS_PRIVATE(group_list);
1500#if defined(MBEDTLS_DHM_C)
1503#endif
1504
1505#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
1506
1507#if defined(MBEDTLS_USE_PSA_CRYPTO)
1514#endif /* MBEDTLS_USE_PSA_CRYPTO */
1515 unsigned char *MBEDTLS_PRIVATE(psk);
1519 size_t MBEDTLS_PRIVATE(psk_len);
1525 unsigned char *MBEDTLS_PRIVATE(psk_identity);
1530 size_t MBEDTLS_PRIVATE(psk_identity_len);
1536#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
1537
1538#if defined(MBEDTLS_SSL_EARLY_DATA)
1539 int MBEDTLS_PRIVATE(early_data_enabled);
1543#if defined(MBEDTLS_SSL_SRV_C)
1544 /* The maximum amount of 0-RTT data. RFC 8446 section 4.6.1 */
1545 uint32_t MBEDTLS_PRIVATE(max_early_data_size);
1546#endif /* MBEDTLS_SSL_SRV_C */
1547
1548#endif /* MBEDTLS_SSL_EARLY_DATA */
1549
1550#if defined(MBEDTLS_SSL_ALPN)
1551 const char **MBEDTLS_PRIVATE(alpn_list);
1552#endif
1553
1554#if defined(MBEDTLS_SSL_DTLS_SRTP)
1556 const mbedtls_ssl_srtp_profile *MBEDTLS_PRIVATE(dtls_srtp_profile_list);
1558 size_t MBEDTLS_PRIVATE(dtls_srtp_profile_list_len);
1559#endif /* MBEDTLS_SSL_DTLS_SRTP */
1560
1561 /*
1562 * Numerical settings (int)
1563 */
1564
1565 uint32_t MBEDTLS_PRIVATE(read_timeout);
1567#if defined(MBEDTLS_SSL_PROTO_DTLS)
1568 uint32_t MBEDTLS_PRIVATE(hs_timeout_min);
1570 uint32_t MBEDTLS_PRIVATE(hs_timeout_max);
1572#endif
1573
1574#if defined(MBEDTLS_SSL_RENEGOTIATION)
1575 int MBEDTLS_PRIVATE(renego_max_records);
1576 unsigned char MBEDTLS_PRIVATE(renego_period)[8];
1578#endif
1579
1580 unsigned int MBEDTLS_PRIVATE(badmac_limit);
1582#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1583 unsigned int MBEDTLS_PRIVATE(dhm_min_bitlen);
1584#endif
1585
1592
1593#if defined(MBEDTLS_SSL_SRV_C)
1595#endif /* MBEDTLS_SSL_SRV_C */
1596
1597#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1599#endif
1600};
1601
1605 /*
1606 * Miscellaneous
1607 */
1608 int MBEDTLS_PRIVATE(state);
1609#if defined(MBEDTLS_SSL_RENEGOTIATION)
1610 int MBEDTLS_PRIVATE(renego_status);
1611 int MBEDTLS_PRIVATE(renego_records_seen);
1614#endif /* MBEDTLS_SSL_RENEGOTIATION */
1615
1633
1634 unsigned MBEDTLS_PRIVATE(badmac_seen);
1636#if defined(MBEDTLS_X509_CRT_PARSE_C)
1638 int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
1639 void *MBEDTLS_PRIVATE(p_vrfy);
1640#endif
1641
1647 void *MBEDTLS_PRIVATE(p_bio);
1649 /*
1650 * Session layer
1651 */
1660 /*
1661 * Record layer transformations
1662 */
1672#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1676#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1677
1678#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1681 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_application);
1682#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1683
1684 /*
1685 * Timers
1686 */
1687 void *MBEDTLS_PRIVATE(p_timer);
1692 /*
1693 * Record layer (incoming data)
1694 */
1695 unsigned char *MBEDTLS_PRIVATE(in_buf);
1696 unsigned char *MBEDTLS_PRIVATE(in_ctr);
1699 unsigned char *MBEDTLS_PRIVATE(in_hdr);
1700#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1701 unsigned char *MBEDTLS_PRIVATE(in_cid);
1703#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1704 unsigned char *MBEDTLS_PRIVATE(in_len);
1705 unsigned char *MBEDTLS_PRIVATE(in_iv);
1706 unsigned char *MBEDTLS_PRIVATE(in_msg);
1707 unsigned char *MBEDTLS_PRIVATE(in_offt);
1709 int MBEDTLS_PRIVATE(in_msgtype);
1710 size_t MBEDTLS_PRIVATE(in_msglen);
1711 size_t MBEDTLS_PRIVATE(in_left);
1712#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1713 size_t MBEDTLS_PRIVATE(in_buf_len);
1714#endif
1715#if defined(MBEDTLS_SSL_PROTO_DTLS)
1716 uint16_t MBEDTLS_PRIVATE(in_epoch);
1717 size_t MBEDTLS_PRIVATE(next_record_offset);
1719#endif /* MBEDTLS_SSL_PROTO_DTLS */
1720#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1721 uint64_t MBEDTLS_PRIVATE(in_window_top);
1722 uint64_t MBEDTLS_PRIVATE(in_window);
1723#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
1724
1725 size_t MBEDTLS_PRIVATE(in_hslen);
1727 int MBEDTLS_PRIVATE(nb_zero);
1729 int MBEDTLS_PRIVATE(keep_current_message);
1732 /* The following three variables indicate if and, if yes,
1733 * what kind of alert is pending to be sent.
1734 */
1735 unsigned char MBEDTLS_PRIVATE(send_alert);
1739 unsigned char MBEDTLS_PRIVATE(alert_type);
1741 int MBEDTLS_PRIVATE(alert_reason);
1745#if defined(MBEDTLS_SSL_PROTO_DTLS)
1746 uint8_t MBEDTLS_PRIVATE(disable_datagram_packing);
1748#endif /* MBEDTLS_SSL_PROTO_DTLS */
1749
1750 /*
1751 * Record layer (outgoing data)
1752 */
1753 unsigned char *MBEDTLS_PRIVATE(out_buf);
1754 unsigned char *MBEDTLS_PRIVATE(out_ctr);
1755 unsigned char *MBEDTLS_PRIVATE(out_hdr);
1756#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1757 unsigned char *MBEDTLS_PRIVATE(out_cid);
1759#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1760 unsigned char *MBEDTLS_PRIVATE(out_len);
1761 unsigned char *MBEDTLS_PRIVATE(out_iv);
1762 unsigned char *MBEDTLS_PRIVATE(out_msg);
1764 int MBEDTLS_PRIVATE(out_msgtype);
1765 size_t MBEDTLS_PRIVATE(out_msglen);
1766 size_t MBEDTLS_PRIVATE(out_left);
1767#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1768 size_t MBEDTLS_PRIVATE(out_buf_len);
1769#endif
1770
1773#if defined(MBEDTLS_SSL_PROTO_DTLS)
1774 uint16_t MBEDTLS_PRIVATE(mtu);
1775#endif /* MBEDTLS_SSL_PROTO_DTLS */
1776
1777 /*
1778 * User settings
1779 */
1780#if defined(MBEDTLS_X509_CRT_PARSE_C)
1781 char *MBEDTLS_PRIVATE(hostname);
1783#endif /* MBEDTLS_X509_CRT_PARSE_C */
1784
1785#if defined(MBEDTLS_SSL_ALPN)
1786 const char *MBEDTLS_PRIVATE(alpn_chosen);
1787#endif /* MBEDTLS_SSL_ALPN */
1788
1789#if defined(MBEDTLS_SSL_DTLS_SRTP)
1790 /*
1791 * use_srtp extension
1792 */
1793 mbedtls_dtls_srtp_info MBEDTLS_PRIVATE(dtls_srtp_info);
1794#endif /* MBEDTLS_SSL_DTLS_SRTP */
1795
1796 /*
1797 * Information for DTLS hello verify
1798 */
1799#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
1800 unsigned char *MBEDTLS_PRIVATE(cli_id);
1801 size_t MBEDTLS_PRIVATE(cli_id_len);
1802#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
1803
1804 /*
1805 * Secure renegotiation
1806 */
1807 /* needed to know when to send extension on server */
1808 int MBEDTLS_PRIVATE(secure_renegotiation);
1810#if defined(MBEDTLS_SSL_RENEGOTIATION)
1811 size_t MBEDTLS_PRIVATE(verify_data_len);
1814#endif /* MBEDTLS_SSL_RENEGOTIATION */
1815
1816#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1817 /* CID configuration to use in subsequent handshakes. */
1818
1824 uint8_t MBEDTLS_PRIVATE(own_cid_len);
1825 uint8_t MBEDTLS_PRIVATE(negotiate_cid);
1829#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1830
1831#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
1832 int MBEDTLS_PRIVATE(early_data_status);
1833#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
1834
1837 void *MBEDTLS_PRIVATE(p_export_keys);
1849};
1850
1859const char *mbedtls_ssl_get_ciphersuite_name(const int ciphersuite_id);
1860
1869int mbedtls_ssl_get_ciphersuite_id(const char *ciphersuite_name);
1870
1879
1905 const mbedtls_ssl_config *conf);
1906
1917
1925
1935{
1936 return conf->MBEDTLS_PRIVATE(endpoint);
1937}
1938
1954
1982
1983#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_EARLY_DATA)
2003void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
2004 int early_data_enabled);
2005
2006#if defined(MBEDTLS_SSL_SRV_C)
2030void mbedtls_ssl_tls13_conf_max_early_data_size(
2031 mbedtls_ssl_config *conf, uint32_t max_early_data_size);
2032#endif /* MBEDTLS_SSL_SRV_C */
2033
2034#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_EARLY_DATA */
2035
2036#if defined(MBEDTLS_X509_CRT_PARSE_C)
2053 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2054 void *p_vrfy);
2055#endif /* MBEDTLS_X509_CRT_PARSE_C */
2056
2065 int (*f_rng)(void *, unsigned char *, size_t),
2066 void *p_rng);
2067
2083 void (*f_dbg)(void *, int, const char *, int, const char *),
2084 void *p_dbg);
2085
2097 const mbedtls_ssl_context *ssl)
2098{
2099 return ssl->MBEDTLS_PRIVATE(conf);
2100}
2101
2133 void *p_bio,
2134 mbedtls_ssl_send_t *f_send,
2135 mbedtls_ssl_recv_t *f_recv,
2136 mbedtls_ssl_recv_timeout_t *f_recv_timeout);
2137
2138#if defined(MBEDTLS_SSL_PROTO_DTLS)
2139
2140#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2141
2142
2228 int enable,
2229 unsigned char const *own_cid,
2230 size_t own_cid_len);
2231
2262 int *enabled,
2263 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
2264 size_t *own_cid_len);
2265
2304 int *enabled,
2305 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
2306 size_t *peer_cid_len);
2307
2308#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
2309
2350#endif /* MBEDTLS_SSL_PROTO_DTLS */
2351
2352#if defined(MBEDTLS_X509_CRT_PARSE_C)
2372 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2373 void *p_vrfy);
2374#endif /* MBEDTLS_X509_CRT_PARSE_C */
2375
2393
2439 unsigned char *buf,
2440 size_t buflen);
2441
2463 void *p_timer,
2464 mbedtls_ssl_set_timer_t *f_set_timer,
2465 mbedtls_ssl_get_timer_t *f_get_timer);
2466
2467#if defined(MBEDTLS_SSL_SRV_C)
2479 mbedtls_ssl_hs_cb_t f_cert_cb)
2480{
2481 conf->MBEDTLS_PRIVATE(f_cert_cb) = f_cert_cb;
2482}
2483#endif /* MBEDTLS_SSL_SRV_C */
2484
2504typedef int mbedtls_ssl_ticket_write_t(void *p_ticket,
2505 const mbedtls_ssl_session *session,
2506 unsigned char *start,
2507 const unsigned char *end,
2508 size_t *tlen,
2509 uint32_t *lifetime);
2510
2534typedef int mbedtls_ssl_ticket_parse_t(void *p_ticket,
2535 mbedtls_ssl_session *session,
2536 unsigned char *buf,
2537 size_t len);
2538
2539#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
2555 mbedtls_ssl_ticket_write_t *f_ticket_write,
2556 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2557 void *p_ticket);
2558#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
2559
2579 mbedtls_ssl_export_keys_t *f_export_keys,
2580 void *p_export_keys);
2581
2593 mbedtls_ssl_config *conf,
2594 void *p)
2595{
2596 conf->MBEDTLS_PRIVATE(user_data).p = p;
2597}
2598
2607 mbedtls_ssl_config *conf,
2608 uintptr_t n)
2609{
2610 conf->MBEDTLS_PRIVATE(user_data).n = n;
2611}
2612
2624 mbedtls_ssl_config *conf)
2625{
2626 return conf->MBEDTLS_PRIVATE(user_data).p;
2627}
2628
2639static inline uintptr_t mbedtls_ssl_conf_get_user_data_n(
2640 mbedtls_ssl_config *conf)
2641{
2642 return conf->MBEDTLS_PRIVATE(user_data).n;
2643}
2644
2657 void *p)
2658{
2659 ssl->MBEDTLS_PRIVATE(user_data).p = p;
2660}
2661
2671 uintptr_t n)
2672{
2673 ssl->MBEDTLS_PRIVATE(user_data).n = n;
2674}
2675
2688{
2689 return ssl->MBEDTLS_PRIVATE(user_data).p;
2690}
2691
2702static inline uintptr_t mbedtls_ssl_get_user_data_n(
2704{
2705 return ssl->MBEDTLS_PRIVATE(user_data).n;
2706}
2707
2708#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
2739void mbedtls_ssl_conf_async_private_cb(mbedtls_ssl_config *conf,
2740 mbedtls_ssl_async_sign_t *f_async_sign,
2741 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2742 mbedtls_ssl_async_resume_t *f_async_resume,
2743 mbedtls_ssl_async_cancel_t *f_async_cancel,
2744 void *config_data);
2745
2754void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf);
2755
2770void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl);
2771
2783void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2784 void *ctx);
2785#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
2786
2801typedef int mbedtls_ssl_cookie_write_t(void *ctx,
2802 unsigned char **p, unsigned char *end,
2803 const unsigned char *info, size_t ilen);
2804
2818typedef int mbedtls_ssl_cookie_check_t(void *ctx,
2819 const unsigned char *cookie, size_t clen,
2820 const unsigned char *info, size_t ilen);
2821
2822#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
2852 mbedtls_ssl_cookie_write_t *f_cookie_write,
2853 mbedtls_ssl_cookie_check_t *f_cookie_check,
2854 void *p_cookie);
2855
2876 const unsigned char *info,
2877 size_t ilen);
2878
2879#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
2880
2881#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
2898#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
2899
2924
2925#if defined(MBEDTLS_SSL_PROTO_DTLS)
2926
2956 unsigned allow_packing);
2957
2989void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf, uint32_t min, uint32_t max);
2990#endif /* MBEDTLS_SSL_PROTO_DTLS */
2991
2992#if defined(MBEDTLS_SSL_SRV_C)
3031 void *p_cache,
3032 mbedtls_ssl_cache_get_t *f_get_cache,
3033 mbedtls_ssl_cache_set_t *f_set_cache);
3034#endif /* MBEDTLS_SSL_SRV_C */
3035
3036#if defined(MBEDTLS_SSL_CLI_C)
3083#endif /* MBEDTLS_SSL_CLI_C */
3084
3118 const unsigned char *buf,
3119 size_t len);
3120
3147 unsigned char *buf,
3148 size_t buf_len,
3149 size_t *olen);
3150
3193 const int *ciphersuites);
3194
3195#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3238void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
3239 const int kex_modes);
3240#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3241
3242#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3243#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
3244#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
3278 int ignore_other_cids);
3279#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3280
3281#if defined(MBEDTLS_X509_CRT_PARSE_C)
3293 const mbedtls_x509_crt_profile *profile);
3294
3307 mbedtls_x509_crt *ca_chain,
3308 mbedtls_x509_crl *ca_crl);
3309
3310#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
3322static inline
3324 const mbedtls_x509_crt *crt)
3325{
3326 conf->MBEDTLS_PRIVATE(dn_hints) = crt;
3327}
3328#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
3329
3330#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
3382void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
3384 void *p_ca_cb);
3385#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
3386
3424 mbedtls_x509_crt *own_cert,
3425 mbedtls_pk_context *pk_key);
3426#endif /* MBEDTLS_X509_CRT_PARSE_C */
3427
3428#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
3462 const unsigned char *psk, size_t psk_len,
3463 const unsigned char *psk_identity, size_t psk_identity_len);
3464
3465#if defined(MBEDTLS_USE_PSA_CRYPTO)
3503int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
3505 const unsigned char *psk_identity,
3506 size_t psk_identity_len);
3507#endif /* MBEDTLS_USE_PSA_CRYPTO */
3508
3526 const unsigned char *psk, size_t psk_len);
3527
3528#if defined(MBEDTLS_USE_PSA_CRYPTO)
3549int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
3551#endif /* MBEDTLS_USE_PSA_CRYPTO */
3552
3553#if defined(MBEDTLS_SSL_SRV_C)
3593 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
3594 size_t),
3595 void *p_psk);
3596#endif /* MBEDTLS_SSL_SRV_C */
3597#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
3598
3599#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
3614 const unsigned char *dhm_P, size_t P_len,
3615 const unsigned char *dhm_G, size_t G_len);
3616
3627#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
3628
3629#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
3639 unsigned int bitlen);
3640#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
3641
3642#if defined(MBEDTLS_ECP_C)
3643#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3686 const mbedtls_ecp_group_id *curves);
3687#endif /* MBEDTLS_DEPRECATED_REMOVED */
3688#endif /* MBEDTLS_ECP_C */
3689
3728 const uint16_t *groups);
3729
3730#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
3731#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
3762 const int *hashes);
3763#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
3764
3775 const uint16_t *sig_algs);
3776#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
3777
3778#if defined(MBEDTLS_X509_CRT_PARSE_C)
3797int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname);
3798
3809static inline const char *mbedtls_ssl_get_hostname(mbedtls_ssl_context *ssl)
3810{
3811 return ssl->MBEDTLS_PRIVATE(hostname);
3812}
3813#endif /* MBEDTLS_X509_CRT_PARSE_C */
3814
3815#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3835 size_t *name_len);
3836
3853 mbedtls_x509_crt *own_cert,
3854 mbedtls_pk_context *pk_key);
3855
3868 mbedtls_x509_crt *ca_chain,
3869 mbedtls_x509_crl *ca_crl);
3870
3871#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
3883 const mbedtls_x509_crt *crt);
3884#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
3885
3897 int authmode);
3898
3922 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
3923 size_t),
3924 void *p_sni);
3925#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3926
3927#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
3946int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
3947 const unsigned char *pw,
3948 size_t pw_len);
3949
3964int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
3966#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
3967
3968#if defined(MBEDTLS_SSL_ALPN)
3982
3993#endif /* MBEDTLS_SSL_ALPN */
3994
3995#if defined(MBEDTLS_SSL_DTLS_SRTP)
3996#if defined(MBEDTLS_DEBUG_C)
3997static inline const char *mbedtls_ssl_get_srtp_profile_as_string(mbedtls_ssl_srtp_profile profile)
3998{
3999 switch (profile) {
4000 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
4001 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80";
4002 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
4003 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32";
4004 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
4005 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80";
4006 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
4007 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32";
4008 default: break;
4009 }
4010 return "";
4011}
4012#endif /* MBEDTLS_DEBUG_C */
4026void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
4027 int support_mki_value);
4028
4048int mbedtls_ssl_conf_dtls_srtp_protection_profiles
4049 (mbedtls_ssl_config *conf,
4050 const mbedtls_ssl_srtp_profile *profiles);
4051
4068int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
4069 unsigned char *mki_value,
4070 uint16_t mki_len);
4089void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
4090 mbedtls_dtls_srtp_info *dtls_srtp_info);
4091#endif /* MBEDTLS_SSL_DTLS_SRTP */
4092
4093#if !defined(MBEDTLS_DEPRECATED_REMOVED)
4112 int minor);
4113#endif /* MBEDTLS_DEPRECATED_REMOVED */
4114
4128 mbedtls_ssl_protocol_version tls_version)
4129{
4130 conf->MBEDTLS_PRIVATE(max_tls_version) = tls_version;
4131}
4132
4133#if !defined(MBEDTLS_DEPRECATED_REMOVED)
4169 int minor);
4170#endif /* MBEDTLS_DEPRECATED_REMOVED */
4171
4185 mbedtls_ssl_protocol_version tls_version)
4186{
4187 conf->MBEDTLS_PRIVATE(min_tls_version) = tls_version;
4188}
4189
4190#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4203#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4204
4205#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4218#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
4219
4220#if defined(MBEDTLS_SSL_SRV_C)
4231 char cert_req_ca_list);
4232#endif /* MBEDTLS_SSL_SRV_C */
4233
4234#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4269int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code);
4270#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4271
4272#if defined(MBEDTLS_SSL_SRV_C)
4283#endif /* MBEDTLS_SSL_SRV_C */
4284
4285#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4286 defined(MBEDTLS_SSL_CLI_C)
4298#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4299 MBEDTLS_SSL_CLI_C */
4300
4301#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4302 defined(MBEDTLS_SSL_SRV_C) && \
4303 defined(MBEDTLS_SSL_PROTO_TLS1_3)
4321void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
4322 uint16_t num_tickets);
4323#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4324 MBEDTLS_SSL_SRV_C &&
4325 MBEDTLS_SSL_PROTO_TLS1_3*/
4326
4327#if defined(MBEDTLS_SSL_RENEGOTIATION)
4346#endif /* MBEDTLS_SSL_RENEGOTIATION */
4347
4376
4377#if defined(MBEDTLS_SSL_RENEGOTIATION)
4416
4443 const unsigned char period[8]);
4444#endif /* MBEDTLS_SSL_RENEGOTIATION */
4445
4485
4502
4516
4525
4534
4535
4548 const mbedtls_ssl_context *ssl)
4549{
4550 return ssl->MBEDTLS_PRIVATE(tls_version);
4551}
4552
4561
4571
4598
4618
4619#if defined(MBEDTLS_X509_CRT_PARSE_C)
4651#endif /* MBEDTLS_X509_CRT_PARSE_C */
4652
4653#if defined(MBEDTLS_SSL_CLI_C)
4689 mbedtls_ssl_session *session);
4690#endif /* MBEDTLS_SSL_CLI_C */
4691
4748
4761{
4762 return ssl->MBEDTLS_PRIVATE(state) >= MBEDTLS_SSL_HANDSHAKE_OVER;
4763}
4764
4799
4800#if defined(MBEDTLS_SSL_RENEGOTIATION)
4825#endif /* MBEDTLS_SSL_RENEGOTIATION */
4826
4904int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len);
4905
4966int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len);
4967
4985 unsigned char level,
4986 unsigned char message);
5001
5002#if defined(MBEDTLS_SSL_EARLY_DATA)
5003
5004#if defined(MBEDTLS_SSL_SRV_C)
5049int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
5050 unsigned char *buf, size_t len);
5051#endif /* MBEDTLS_SSL_SRV_C */
5052
5053#if defined(MBEDTLS_SSL_CLI_C)
5110int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
5111 const unsigned char *buf, size_t len);
5112
5113#define MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT 0
5114#define MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED 1
5115#define MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED 2
5142int mbedtls_ssl_get_early_data_status(mbedtls_ssl_context *ssl);
5143#endif /* MBEDTLS_SSL_CLI_C */
5144
5145#endif /* MBEDTLS_SSL_EARLY_DATA */
5146
5153
5154#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
5212 unsigned char *buf,
5213 size_t buf_len,
5214 size_t *olen);
5215
5285 const unsigned char *buf,
5286 size_t len);
5287#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
5288
5300
5317 int endpoint, int transport, int preset);
5318
5325
5332
5343
5360 const unsigned char *secret, size_t slen,
5361 const char *label,
5362 const unsigned char *random, size_t rlen,
5363 unsigned char *dstbuf, size_t dlen);
5364
5365#ifdef __cplusplus
5366}
5367#endif
5368
5369#endif /* ssl.h */
Multi-precision integer library.
#define MBEDTLS_MPI_MAX_SIZE
Definition bignum.h:73
Platform Security Architecture cryptography module.
This file contains Diffie-Hellman-Merkle (DHM) key exchange definitions and functions.
This file contains ECDH definitions and functions.
This file provides an API for Elliptic Curves over GF(P) (ECP).
#define MBEDTLS_ECP_MAX_BYTES
Definition ecp.h:353
mbedtls_ecp_group_id
Definition ecp.h:101
psa_key_id_t mbedtls_svc_key_id_t
int(* mbedtls_x509_crt_ca_cb_t)(void *p_ctx, mbedtls_x509_crt const *child, mbedtls_x509_crt **candidate_cas)
The type of trusted certificate callbacks.
Definition x509_crt.h:784
Build-time configuration info.
This file contains the generic functions for message-digest (hashing) and HMAC.
mbedtls_md_type_t
Supported message digests.
Definition md.h:161
Mbed TLS Platform time abstraction.
time_t mbedtls_time_t
Common and shared functions used by multiple modules in the Mbed TLS library.
#define MBEDTLS_DEPRECATED
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
static const char * mbedtls_ssl_get_hostname(mbedtls_ssl_context *ssl)
Get the hostname that checked against the received server certificate. It is used to set the ServerNa...
Definition ssl.h:3809
void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf, char cert_req_ca_list)
Whether to send a list of acceptable CAs in CertificateRequest messages. (Default: do send)
#define MBEDTLS_PSK_MAX_LEN
Definition ssl.h:620
void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl, const mbedtls_x509_crt *crt)
Set DN hints sent to client in CertificateRequest message.
const mbedtls_x509_crt * mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Return the peer certificate from the current connection.
void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Set the timeout period for mbedtls_ssl_read() (Default: no timeout.)
int mbedtls_ssl_cache_get_t(void *data, unsigned char const *session_id, size_t session_id_len, mbedtls_ssl_session *session)
Callback type: server-side session cache getter.
Definition ssl.h:870
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.
Definition ssl.h:2504
void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Enable or disable Extended Master Secret negotiation. (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Set the Maximum Transport Unit (MTU). Special value: 0 means unset (no limit). This represents the ma...
int mbedtls_ssl_set_client_transport_id(mbedtls_ssl_context *ssl, const unsigned char *info, size_t ilen)
Set client's transport-level identification info. (Server only. DTLS only.)
void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf, const unsigned char period[8])
Set record counter threshold for periodic renegotiation. (Default: 2^48 - 1)
#define MBEDTLS_SSL_CID_OUT_LEN_MAX
Definition ssl.h:389
void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Prevent or allow legacy renegotiation. (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf, int(*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t), void *p_psk)
Set the PSK callback (server-side only).
void mbedtls_ssl_export_keys_t(void *p_expkey, mbedtls_ssl_key_export_type type, const unsigned char *secret, size_t secret_len, const unsigned char client_random[32], const unsigned char server_random[32], mbedtls_tls_prf_types tls_prf_type)
Callback type: Export key alongside random values for session identification, and PRF for implementat...
Definition ssl.h:1291
int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf, const unsigned char *psk, size_t psk_len, const unsigned char *psk_identity, size_t psk_identity_len)
Configure pre-shared keys (PSKs) and their identities to be used in PSK-based ciphersuites.
int mbedtls_ssl_session_save(const mbedtls_ssl_session *session, unsigned char *buf, size_t buf_len, size_t *olen)
Save session structure as serialized data in a buffer. On client, this can be used for saving session...
void MBEDTLS_DEPRECATED mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf, const int *hashes)
Set the allowed hashes for signatures during the handshake.
static void * mbedtls_ssl_conf_get_user_data_p(mbedtls_ssl_config *conf)
Retrieve the user data in an SSL configuration as a pointer.
Definition ssl.h:2623
int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Reset an already initialized SSL context for re-use while retaining application-set variables,...
static uintptr_t mbedtls_ssl_get_user_data_n(mbedtls_ssl_context *ssl)
Retrieve the user data in an SSL context as an integer.
Definition ssl.h:2702
static void mbedtls_ssl_conf_set_user_data_n(mbedtls_ssl_config *conf, uintptr_t n)
Set the user data in an SSL configuration to an integer.
Definition ssl.h:2606
int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl, unsigned char *buf, size_t buflen)
Check whether a buffer contains a valid and authentic record that has not been seen before....
const char * mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Get the name of the negotiated Application Layer Protocol. This function should be called after the h...
struct mbedtls_ssl_transform mbedtls_ssl_transform
Definition ssl.h:824
void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Enforce renegotiation requests. (Default: enforced, max_records = 16)
void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Free referenced items in an SSL context and clear memory.
void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Set the transport type (TLS or DTLS). Default: TLS.
int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl, int *enabled, unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX], size_t *own_cid_len)
Get information about our request for usage of the CID extension in the current connection.
#define MBEDTLS_SSL_CID_IN_LEN_MAX
Definition ssl.h:385
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.)
void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl, mbedtls_x509_crt *ca_chain, mbedtls_x509_crl *ca_crl)
Set the data required to verify peer certificate for the current handshake.
const unsigned char * mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl, size_t *name_len)
Retrieve SNI extension value for the current handshake. Available in f_cert_cb of mbedtls_ssl_conf_ce...
mbedtls_tls_prf_types
Definition ssl.h:1255
@ MBEDTLS_SSL_TLS_PRF_SHA384
Definition ssl.h:1257
@ MBEDTLS_SSL_HKDF_EXPAND_SHA256
Definition ssl.h:1260
@ MBEDTLS_SSL_TLS_PRF_SHA256
Definition ssl.h:1258
@ MBEDTLS_SSL_TLS_PRF_NONE
Definition ssl.h:1256
@ MBEDTLS_SSL_HKDF_EXPAND_SHA384
Definition ssl.h:1259
int mbedtls_ssl_send_t(void *ctx, const unsigned char *buf, size_t len)
Callback type: send data on the network.
Definition ssl.h:725
void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf, int(*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t), void *p_sni)
Set server side ServerName TLS extension callback (optional, server-side only).
mbedtls_ssl_states
Definition ssl.h:673
@ MBEDTLS_SSL_CERTIFICATE_VERIFY
Definition ssl.h:683
@ MBEDTLS_SSL_HANDSHAKE_OVER
Definition ssl.h:702
@ MBEDTLS_SSL_SERVER_HELLO_DONE
Definition ssl.h:680
@ MBEDTLS_SSL_END_OF_EARLY_DATA
Definition ssl.h:695
@ MBEDTLS_SSL_NEW_SESSION_TICKET
Definition ssl.h:691
@ MBEDTLS_SSL_SERVER_FINISHED
Definition ssl.h:687
@ MBEDTLS_SSL_SERVER_KEY_EXCHANGE
Definition ssl.h:678
@ MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
Definition ssl.h:694
@ MBEDTLS_SSL_SERVER_HELLO
Definition ssl.h:676
@ MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST
Definition ssl.h:701
@ MBEDTLS_SSL_CLIENT_KEY_EXCHANGE
Definition ssl.h:682
@ MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO
Definition ssl.h:698
@ MBEDTLS_SSL_CLIENT_HELLO
Definition ssl.h:675
@ MBEDTLS_SSL_SERVER_CERTIFICATE
Definition ssl.h:677
@ MBEDTLS_SSL_CERTIFICATE_REQUEST
Definition ssl.h:679
@ MBEDTLS_SSL_CLIENT_FINISHED
Definition ssl.h:685
@ MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC
Definition ssl.h:686
@ MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT
Definition ssl.h:692
@ MBEDTLS_SSL_HANDSHAKE_WRAPUP
Definition ssl.h:689
@ MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED
Definition ssl.h:697
@ MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC
Definition ssl.h:684
@ MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
Definition ssl.h:696
@ MBEDTLS_SSL_HELLO_REQUEST
Definition ssl.h:674
@ MBEDTLS_SSL_CLIENT_CERTIFICATE
Definition ssl.h:681
@ MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH
Definition ssl.h:704
@ MBEDTLS_SSL_FLUSH_BUFFERS
Definition ssl.h:688
@ MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO
Definition ssl.h:700
@ MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Definition ssl.h:703
@ MBEDTLS_SSL_HELLO_RETRY_REQUEST
Definition ssl.h:693
@ MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO
Definition ssl.h:699
void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl, int(*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), void *p_vrfy)
Set a connection-specific verification callback (optional).
void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Set the current endpoint type.
int(* mbedtls_ssl_hs_cb_t)(mbedtls_ssl_context *ssl)
Callback type: generic handshake callback.
Definition ssl.h:1315
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.
mbedtls_ssl_protocol_version
Definition ssl.h:1170
@ MBEDTLS_SSL_VERSION_TLS1_2
Definition ssl.h:1172
@ MBEDTLS_SSL_VERSION_TLS1_3
Definition ssl.h:1173
@ MBEDTLS_SSL_VERSION_UNKNOWN
Definition ssl.h:1171
int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl, unsigned char level, unsigned char message)
Send an alert message.
const char * mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Return the current TLS version.
static int mbedtls_ssl_is_handshake_over(mbedtls_ssl_context *ssl)
After calling mbedtls_ssl_handshake() to start the SSL handshake you can call this function to check ...
Definition ssl.h:4760
int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf, const unsigned char *dhm_P, size_t P_len, const unsigned char *dhm_G, size_t G_len)
Set the Diffie-Hellman public P and G values from big-endian binary presentations....
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.
void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Enable or disable anti-replay protection for DTLS. (DTLS only, no effect on TLS.) Default: enabled.
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.
Definition ssl.h:2534
int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Initiate an SSL renegotiation on the running connection. Client: perform the renegotiation right now....
static void mbedtls_ssl_conf_cert_cb(mbedtls_ssl_config *conf, mbedtls_ssl_hs_cb_t f_cert_cb)
Set the certificate selection callback (server-side only).
Definition ssl.h:2478
int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Perform the SSL handshake.
int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf, mbedtls_x509_crt *own_cert, mbedtls_pk_context *pk_key)
Set own certificate chain and private key.
struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t
Definition ssl.h:826
int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl, const unsigned char *psk, size_t psk_len)
Set the pre-shared Key (PSK) for the current handshake.
uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Return the result of the certificate verification.
#define MBEDTLS_SSL_SEQUENCE_NUMBER_LEN
Definition ssl.h:664
mbedtls_ssl_key_export_type
Definition ssl.h:1264
@ MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET
Definition ssl.h:1265
int mbedtls_ssl_session_load(mbedtls_ssl_session *session, const unsigned char *buf, size_t len)
Load serialized session data into a session structure. On client, this can be used for loading saved ...
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.
Definition ssl.h:2801
static mbedtls_ssl_protocol_version mbedtls_ssl_get_version_number(const mbedtls_ssl_context *ssl)
Return the (D)TLS protocol version negotiated in the given connection.
Definition ssl.h:4547
void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Set the certificate verification mode Default: NONE on server, REQUIRED on client.
void mbedtls_ssl_conf_dtls_cookies(mbedtls_ssl_config *conf, mbedtls_ssl_cookie_write_t *f_cookie_write, mbedtls_ssl_cookie_check_t *f_cookie_check, void *p_cookie)
Register callbacks for DTLS cookies (Server only. DTLS only.)
int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Return the current maximum outgoing record payload in bytes.
int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Try to write exactly 'len' application data bytes.
struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params
Definition ssl.h:825
int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Return the current maximum incoming record payload in bytes.
void mbedtls_ssl_conf_preference_order(mbedtls_ssl_config *conf, int order)
Pick the ciphersuites order according to the second parameter in the SSL Server module (MBEDTLS_SSL_S...
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.
Definition ssl.h:801
void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf, uint32_t min, uint32_t max)
Set retransmit timeout values for the DTLS handshake. (DTLS only, no effect on TLS....
static const mbedtls_ssl_config * mbedtls_ssl_context_get_config(const mbedtls_ssl_context *ssl)
Return the SSL configuration structure associated with the given SSL context.
Definition ssl.h:2096
void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf, const uint16_t *sig_algs)
Configure allowed signature algorithms for use in TLS 1.3.
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.
Definition ssl.h:775
void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf, mbedtls_ssl_ticket_write_t *f_ticket_write, mbedtls_ssl_ticket_parse_t *f_ticket_parse, void *p_ticket)
Configure SSL session ticket callbacks (server only). (Default: none.)
void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Free an SSL configuration context.
static void mbedtls_ssl_conf_dn_hints(mbedtls_ssl_config *conf, const mbedtls_x509_crt *crt)
Set DN hints sent to client in CertificateRequest message.
Definition ssl.h:3323
void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf, const mbedtls_x509_crt_profile *profile)
Set the X.509 security profile used for verification.
void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Initialize SSL session structure.
#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN
Definition ssl.h:425
int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl, int *enabled, unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX], size_t *peer_cid_len)
Get information about the use of the CID extension in the current connection.
int mbedtls_ssl_context_load(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Load serialized connection data to an SSL context.
void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl, int authmode)
Set authmode for the current handshake.
void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl, unsigned allow_packing)
Allow or disallow packing of multiple handshake records within a single datagram.
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()
void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf, mbedtls_x509_crt *ca_chain, mbedtls_x509_crl *ca_crl)
Set the data required to verify peer certificate.
static uintptr_t mbedtls_ssl_conf_get_user_data_n(mbedtls_ssl_config *conf)
Retrieve the user data in an SSL configuration as an integer.
Definition ssl.h:2639
int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf, size_t len, int ignore_other_cids)
Specify the length of Connection IDs for incoming encrypted DTLS records, as well as the behaviour on...
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.
const char * mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Return the name of the current ciphersuite.
int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Load a session for session resumption.
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...
void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf, void *p_cache, mbedtls_ssl_cache_get_t *f_get_cache, mbedtls_ssl_cache_set_t *f_set_cache)
Set the session cache callbacks (server-side only) If not set, no session resuming is done (except if...
void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Enable / Disable session tickets (client only). (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED....
int mbedtls_ssl_get_ciphersuite_id(const char *ciphersuite_name)
Return the ID of the ciphersuite associated with the given name.
void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Set a limit on the number of records with a bad MAC before terminating the connection....
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.
Definition ssl.h:2818
void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf, unsigned int bitlen)
Set the minimum length for Diffie-Hellman parameters. (Client-side only.) (Default: 1024 bits....
int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl, mbedtls_x509_crt *own_cert, mbedtls_pk_context *pk_key)
Set own certificate and key for the current handshake.
int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf, int endpoint, int transport, int preset)
Load reasonable default SSL configuration values. (You need to call mbedtls_ssl_config_init() first....
int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Read at most 'len' application data bytes.
void MBEDTLS_DEPRECATED mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf, const mbedtls_ecp_group_id *curves)
Set the allowed curves in order of preference.
int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Set or reset the hostname to check against the received server certificate. It sets the ServerName TL...
void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf, const uint16_t *groups)
Set the allowed groups in order of preference.
void MBEDTLS_DEPRECATED 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.
int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Perform a single step of the SSL handshake.
int mbedtls_ssl_cache_set_t(void *data, unsigned char const *session_id, size_t session_id_len, const mbedtls_ssl_session *session)
Callback type: server-side session cache setter.
Definition ssl.h:892
void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Enable / Disable renegotiation support for connection when initiated by peer (Default: MBEDTLS_SSL_RE...
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.
const char * mbedtls_ssl_get_ciphersuite_name(const int ciphersuite_id)
Return the name of the ciphersuite associated with the given ID.
#define MBEDTLS_TLS1_3_MD_MAX_SIZE
Definition ssl.h:660
void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Initialize an SSL configuration context Just makes the context ready for mbedtls_ssl_config_defaults(...
static void mbedtls_ssl_conf_max_tls_version(mbedtls_ssl_config *conf, mbedtls_ssl_protocol_version tls_version)
Set the maximum supported version sent from the client side and/or accepted at the server side.
Definition ssl.h:4127
int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl, unsigned char *buf, size_t buf_len, size_t *olen)
Save an active connection as serialized data in a buffer. This allows the freeing or re-using of the ...
int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf, const unsigned char *secret, size_t slen, const char *label, const unsigned char *random, size_t rlen, unsigned char *dstbuf, size_t dlen)
TLS-PRF function for key derivation.
struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item
Definition ssl.h:831
int mbedtls_ssl_recv_t(void *ctx, unsigned char *buf, size_t len)
Callback type: receive data from the network.
Definition ssl.h:749
void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Free referenced items in an SSL session including the peer certificate and clear memory.
int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Notify the peer that the connection is being closed.
int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Set the maximum fragment length to emit and/or negotiate. (Typical: the smaller of MBEDTLS_SSL_IN_CON...
int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Return the id of the current ciphersuite.
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 pref...
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.
int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session)
Export a session in order to resume it later.
void MBEDTLS_DEPRECATED mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Set the minimum accepted SSL/TLS protocol version.
static void mbedtls_ssl_conf_set_user_data_p(mbedtls_ssl_config *conf, void *p)
Set the user data in an SSL configuration to a pointer.
Definition ssl.h:2592
static void * mbedtls_ssl_get_user_data_p(mbedtls_ssl_context *ssl)
Retrieve the user data in an SSL context as a pointer.
Definition ssl.h:2686
int mbedtls_ssl_get_timer_t(void *ctx)
Callback type: get status of timers/delays.
Definition ssl.h:816
int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Set the supported Application Layer Protocols.
static void mbedtls_ssl_set_user_data_n(mbedtls_ssl_context *ssl, uintptr_t n)
Set the user data in an SSL context to an integer.
Definition ssl.h:2669
int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Set the Diffie-Hellman public P and G values, read from existing context (server-side only)
static void mbedtls_ssl_conf_min_tls_version(mbedtls_ssl_config *conf, mbedtls_ssl_protocol_version tls_version)
Set the minimum supported version sent from the client side and/or accepted at the server side.
Definition ssl.h:4184
struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert
Definition ssl.h:828
int mbedtls_ssl_setup(mbedtls_ssl_context *ssl, const mbedtls_ssl_config *conf)
Set up an SSL context for use.
static void mbedtls_ssl_set_user_data_p(mbedtls_ssl_context *ssl, void *p)
Set the user data in an SSL context to a pointer.
Definition ssl.h:2655
static int mbedtls_ssl_conf_get_endpoint(const mbedtls_ssl_config *conf)
Get the current endpoint type.
Definition ssl.h:1934
void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Enable or disable Encrypt-then-MAC (Default: MBEDTLS_SSL_ETM_ENABLED)
void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf, int(*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), void *p_vrfy)
Set the verification callback (Optional).
void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl, mbedtls_ssl_export_keys_t *f_export_keys, void *p_export_keys)
Configure a key export callback. (Default: none.)
int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl, int enable, unsigned char const *own_cid, size_t own_cid_len)
Configure the use of the Connection ID (CID) extension in the next handshake.
SSL Ciphersuites for Mbed TLS.
The DHM context structure.
Definition dhm.h:101
MPI structure.
Definition bignum.h:207
Public key container.
Definition pk.h:227
unsigned char _pms_ecdhe_psk[4+MBEDTLS_ECP_MAX_BYTES+MBEDTLS_PSK_MAX_LEN]
Definition ssl.h:651
unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]
Definition ssl.h:631
unsigned char _pms_psk[4+2 *MBEDTLS_PSK_MAX_LEN]
Definition ssl.h:640
unsigned char _pms_rsa_psk[52+MBEDTLS_PSK_MAX_LEN]
Definition ssl.h:647
unsigned char dummy
Definition ssl.h:626
unsigned char _pms_rsa[48]
Definition ssl.h:628
unsigned char _pms_dhe_psk[4+MBEDTLS_MPI_MAX_SIZE+MBEDTLS_PSK_MAX_LEN]
Definition ssl.h:644
unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]
Definition ssl.h:637
X.509 certificate revocation list parsing.
X.509 certificate parsing and writing.