mbed TLS v3.3.0
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
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 */
22#ifndef MBEDTLS_SSL_H
23#define MBEDTLS_SSL_H
26
27#include "mbedtls/build_info.h"
28
29#include "mbedtls/bignum.h"
30#include "mbedtls/ecp.h"
31
33
34#if defined(MBEDTLS_X509_CRT_PARSE_C)
35#include "mbedtls/x509_crt.h"
36#include "mbedtls/x509_crl.h"
37#endif
38
39#if defined(MBEDTLS_DHM_C)
40#include "mbedtls/dhm.h"
41#endif
42
43/* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due
44 * to guards in TLS code. There is a gap in functionality that access to
45 * ecdh_ctx structure is needed for MBEDTLS_ECDSA_C which does not seem correct.
46 */
47#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
48#include "mbedtls/ecdh.h"
49#endif
50
51#if defined(MBEDTLS_HAVE_TIME)
53#endif
54
55#include "psa/crypto.h"
56
57/*
58 * SSL Error codes
59 */
61#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000
63#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
65#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100
67#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180
69#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200
71#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280
73#define MBEDTLS_ERR_SSL_DECODE_ERROR -0x7300
74/* Error space gap */
76#define MBEDTLS_ERR_SSL_NO_RNG -0x7400
78#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
80#define MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION -0x7500
82#define MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL -0x7580
84#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
86#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
88#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
90#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
92#define MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME -0x7800
94#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
95/* Error space gap */
96/* Error space gap */
98#define MBEDTLS_ERR_SSL_BAD_CERTIFICATE -0x7A00
99/* Error space gap */
104#define MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET -0x7B00
106#define MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA -0x7B80
108#define MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA -0x7C00
109/* Error space gap */
110/* Error space gap */
111/* Error space gap */
112/* Error space gap */
113/* Error space gap */
115#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00
117#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80
119#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
121#define MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION -0x6E80
123#define MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE -0x6E00
125#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80
127#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00
129#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80
131#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00
133#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80
135#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00
137#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80
139#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00
140/* Error space gap */
142#define MBEDTLS_ERR_SSL_WANT_READ -0x6900
144#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880
146#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800
148#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780
150#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700
152#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680
154#define MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER -0x6600
156#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580
158#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500
160#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480
161/* Error space gap */
162/* Error space gap */
163/* Error space gap */
164/* Error space gap */
165/* Error space gap */
166/* Error space gap */
167/* Error space gap */
168/* Error space gap */
170#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000
172#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00
174#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80
175
176/*
177 * Constants from RFC 8446 for TLS 1.3 PSK modes
178 *
179 * Those are used in the Pre-Shared Key Exchange Modes extension.
180 * See Section 4.2.9 in RFC 8446.
181 */
182#define MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE 0 /* Pure PSK-based exchange */
183#define MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE 1 /* PSK+ECDHE-based exchange */
184
185/*
186 * TLS 1.3 NamedGroup values
187 *
188 * From RF 8446
189 * enum {
190 * // Elliptic Curve Groups (ECDHE)
191 * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019),
192 * x25519(0x001D), x448(0x001E),
193 * // Finite Field Groups (DHE)
194 * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102),
195 * ffdhe6144(0x0103), ffdhe8192(0x0104),
196 * // Reserved Code Points
197 * ffdhe_private_use(0x01FC..0x01FF),
198 * ecdhe_private_use(0xFE00..0xFEFF),
199 * (0xFFFF)
200 * } NamedGroup;
201 *
202 */
203
204/* Elliptic Curve Groups (ECDHE) */
205#define MBEDTLS_SSL_IANA_TLS_GROUP_NONE 0
206#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 0x0012
207#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 0x0013
208#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 0x0014
209#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 0x0015
210#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 0x0016
211#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 0x0017
212#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 0x0018
213#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 0x0019
214#define MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 0x001A
215#define MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 0x001B
216#define MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 0x001C
217#define MBEDTLS_SSL_IANA_TLS_GROUP_X25519 0x001D
218#define MBEDTLS_SSL_IANA_TLS_GROUP_X448 0x001E
219/* Finite Field Groups (DHE) */
220#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 0x0100
221#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072 0x0101
222#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096 0x0102
223#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144 0x0103
224#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 0x0104
225
226/*
227 * TLS 1.3 Key Exchange Modes
228 *
229 * Mbed TLS internal identifiers for use with the SSL configuration API
230 * mbedtls_ssl_conf_tls13_key_exchange_modes().
231 */
232
233#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK ( 1u << 0 )
236#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL ( 1u << 1 )
239#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ( 1u << 2 )
243/* Convenience macros for sets of key exchanges. */
244#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL \
245 ( MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
246 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL | \
247 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL )
248#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL \
249 ( MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
250 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL )
251#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL \
252 ( MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL | \
253 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL )
255#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE ( 0 )
256
257/*
258 * Various constants
259 */
260
261#if !defined(MBEDTLS_DEPRECATED_REMOVED)
262/* These are the high and low bytes of ProtocolVersion as defined by:
263 * - RFC 5246: ProtocolVersion version = { 3, 3 }; // TLS v1.2
264 * - RFC 8446: see section 4.2.1
265 */
266#define MBEDTLS_SSL_MAJOR_VERSION_3 3
267#define MBEDTLS_SSL_MINOR_VERSION_3 3
268#define MBEDTLS_SSL_MINOR_VERSION_4 4
269#endif /* MBEDTLS_DEPRECATED_REMOVED */
270
271#define MBEDTLS_SSL_TRANSPORT_STREAM 0
272#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1
274#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255
275#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255
277#define MBEDTLS_SSL_MAX_ALPN_LIST_LEN 65535
279/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
280 * NONE must be zero so that memset()ing structure to zero works */
281#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0
282#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1
283#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2
284#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3
285#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4
286#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5
288#define MBEDTLS_SSL_IS_CLIENT 0
289#define MBEDTLS_SSL_IS_SERVER 1
290
291#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
292#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
293
294#define MBEDTLS_SSL_CID_DISABLED 0
295#define MBEDTLS_SSL_CID_ENABLED 1
296
297#define MBEDTLS_SSL_ETM_DISABLED 0
298#define MBEDTLS_SSL_ETM_ENABLED 1
299
300#define MBEDTLS_SSL_COMPRESS_NULL 0
301
302#define MBEDTLS_SSL_VERIFY_NONE 0
303#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
304#define MBEDTLS_SSL_VERIFY_REQUIRED 2
305#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
306
307#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
308#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
309
310#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
311#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
312
313#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
314#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
315
316#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
317#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
318
319#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
320#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
321#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
322
323#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
324#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
325#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
326
327#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
328#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
329
330#define MBEDTLS_SSL_PRESET_DEFAULT 0
331#define MBEDTLS_SSL_PRESET_SUITEB 2
332
333#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
334#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
335
336#define MBEDTLS_SSL_EARLY_DATA_DISABLED 0
337#define MBEDTLS_SSL_EARLY_DATA_ENABLED 1
338
339#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
340#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
341
342#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT 1
343#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER 0
344
345#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
346#if defined(PSA_WANT_ALG_SHA_384)
347#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 48
348#elif defined(PSA_WANT_ALG_SHA_256)
349#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 32
350#endif
351#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
352/*
353 * Default range for DTLS retransmission timer value, in milliseconds.
354 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
355 */
356#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
357#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
358
367/*
368 * Maximum fragment length in bytes,
369 * determines the size of each of the two internal I/O buffers.
370 *
371 * Note: the RFC defines the default size of SSL / TLS messages. If you
372 * change the value here, other clients / servers may not be able to
373 * communicate with you anymore. Only change this value if you control
374 * both sides of the connection and have it reduced at both sides, or
375 * if you're using the Max Fragment Length extension and you know all your
376 * peers are using it too!
377 */
378#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
379#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
380#endif
381
382#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
383#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
384#endif
385
386/*
387 * Maximum number of heap-allocated bytes for the purpose of
388 * DTLS handshake message reassembly and future message buffering.
389 */
390#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
391#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
392#endif
393
394/*
395 * Maximum length of CIDs for incoming and outgoing messages.
396 */
397#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
398#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
399#endif
400
401#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
402#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
403#endif
404
405#if !defined(MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY)
406#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
407#endif
408
411/*
412 * Default to standard CID mode
413 */
414#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
415 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT)
416#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
417#endif
418
419/*
420 * Length of the verify data for secure renegotiation
421 */
422#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
423
424/*
425 * Signaling ciphersuite values (SCSV)
426 */
427#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF
429/*
430 * Supported Signature and Hash algorithms (For TLS 1.2)
431 * RFC 5246 section 7.4.1.4.1
432 */
433#define MBEDTLS_SSL_HASH_NONE 0
434#define MBEDTLS_SSL_HASH_MD5 1
435#define MBEDTLS_SSL_HASH_SHA1 2
436#define MBEDTLS_SSL_HASH_SHA224 3
437#define MBEDTLS_SSL_HASH_SHA256 4
438#define MBEDTLS_SSL_HASH_SHA384 5
439#define MBEDTLS_SSL_HASH_SHA512 6
440
441#define MBEDTLS_SSL_SIG_ANON 0
442#define MBEDTLS_SSL_SIG_RSA 1
443#define MBEDTLS_SSL_SIG_ECDSA 3
444
445/*
446 * TLS 1.3 signature algorithms
447 * RFC 8446, Section 4.2.2
448 */
449
450/* RSASSA-PKCS1-v1_5 algorithms */
451#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256 0x0401
452#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384 0x0501
453#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512 0x0601
454
455/* ECDSA algorithms */
456#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256 0x0403
457#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384 0x0503
458#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512 0x0603
459
460/* RSASSA-PSS algorithms with public key OID rsaEncryption */
461#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256 0x0804
462#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384 0x0805
463#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512 0x0806
464
465/* EdDSA algorithms */
466#define MBEDTLS_TLS1_3_SIG_ED25519 0x0807
467#define MBEDTLS_TLS1_3_SIG_ED448 0x0808
468
469/* RSASSA-PSS algorithms with public key OID RSASSA-PSS */
470#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA256 0x0809
471#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA384 0x080A
472#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA512 0x080B
473
474/* LEGACY ALGORITHMS */
475#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA1 0x0201
476#define MBEDTLS_TLS1_3_SIG_ECDSA_SHA1 0x0203
477
478#define MBEDTLS_TLS1_3_SIG_NONE 0x0
479
480/*
481 * Client Certificate Types
482 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
483 */
484#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
485#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
486
487/*
488 * Message, alert and handshake types
489 */
490#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
491#define MBEDTLS_SSL_MSG_ALERT 21
492#define MBEDTLS_SSL_MSG_HANDSHAKE 22
493#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
494#define MBEDTLS_SSL_MSG_CID 25
495
496#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
497#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
498
499#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
500#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
501#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
502#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
503#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
504#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
505#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
506#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
507#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
508#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
509#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
510#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
511#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
512#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
513#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
514#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
515#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
516#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
517#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
518#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
519#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
520#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
521#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
522#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
523#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
524#define MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION 109 /* 0x6d -- new in TLS 1.3 */
525#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
526#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
527#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
528#define MBEDTLS_SSL_ALERT_MSG_CERT_REQUIRED 116 /* 0x74 */
529#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
530
531#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
532#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
533#define MBEDTLS_SSL_HS_SERVER_HELLO 2
534#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
535#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
536#define MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS 8 // NEW IN TLS 1.3
537#define MBEDTLS_SSL_HS_CERTIFICATE 11
538#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
539#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
540#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
541#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
542#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
543#define MBEDTLS_SSL_HS_FINISHED 20
544#define MBEDTLS_SSL_HS_MESSAGE_HASH 254
545
546/*
547 * TLS extensions
548 */
549#define MBEDTLS_TLS_EXT_SERVERNAME 0
550#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
551
552#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
553
554#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
555#define MBEDTLS_TLS_EXT_STATUS_REQUEST 5 /* RFC 6066 TLS 1.2 and 1.3 */
556
557#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
558#define MBEDTLS_TLS_EXT_SUPPORTED_GROUPS 10 /* RFC 8422,7919 TLS 1.2 and 1.3 */
559#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
560
561#define MBEDTLS_TLS_EXT_SIG_ALG 13 /* RFC 8446 TLS 1.3 */
562#define MBEDTLS_TLS_EXT_USE_SRTP 14
563#define MBEDTLS_TLS_EXT_HEARTBEAT 15 /* RFC 6520 TLS 1.2 and 1.3 */
564#define MBEDTLS_TLS_EXT_ALPN 16
565
566#define MBEDTLS_TLS_EXT_SCT 18 /* RFC 6962 TLS 1.2 and 1.3 */
567#define MBEDTLS_TLS_EXT_CLI_CERT_TYPE 19 /* RFC 7250 TLS 1.2 and 1.3 */
568#define MBEDTLS_TLS_EXT_SERV_CERT_TYPE 20 /* RFC 7250 TLS 1.2 and 1.3 */
569#define MBEDTLS_TLS_EXT_PADDING 21 /* RFC 7685 TLS 1.2 and 1.3 */
570#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
571#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
572
573#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
574
575#define MBEDTLS_TLS_EXT_PRE_SHARED_KEY 41 /* RFC 8446 TLS 1.3 */
576#define MBEDTLS_TLS_EXT_EARLY_DATA 42 /* RFC 8446 TLS 1.3 */
577#define MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS 43 /* RFC 8446 TLS 1.3 */
578#define MBEDTLS_TLS_EXT_COOKIE 44 /* RFC 8446 TLS 1.3 */
579#define MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES 45 /* RFC 8446 TLS 1.3 */
580
581#define MBEDTLS_TLS_EXT_CERT_AUTH 47 /* RFC 8446 TLS 1.3 */
582#define MBEDTLS_TLS_EXT_OID_FILTERS 48 /* RFC 8446 TLS 1.3 */
583#define MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH 49 /* RFC 8446 TLS 1.3 */
584#define MBEDTLS_TLS_EXT_SIG_ALG_CERT 50 /* RFC 8446 TLS 1.3 */
585#define MBEDTLS_TLS_EXT_KEY_SHARE 51 /* RFC 8446 TLS 1.3 */
586
587#if MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
588#define MBEDTLS_TLS_EXT_CID 54 /* RFC 9146 DTLS 1.2 CID */
589#else
590#define MBEDTLS_TLS_EXT_CID 254 /* Pre-RFC 9146 DTLS 1.2 CID */
591#endif
592
593#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
594
595#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
596
597/*
598 * Size defines
599 */
600#if !defined(MBEDTLS_PSK_MAX_LEN)
601#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
602#endif
603
604/* Dummy type used only for its size */
606{
607#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
608 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
609#endif
610#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
611 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
612#endif
613#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
614 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
615 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
616 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
617 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
618#endif
619#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
620 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
621#endif
622#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
624 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
625#endif
626#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
627 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
628#endif
629#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
631 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
632#endif
633#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
634 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
635#endif
636};
637
638#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
639
640#define MBEDTLS_TLS1_3_MD_MAX_SIZE PSA_HASH_MAX_SIZE
641
642
643/* Length in number of bytes of the TLS sequence number */
644#define MBEDTLS_SSL_SEQUENCE_NUMBER_LEN 8
645
646#ifdef __cplusplus
647extern "C" {
648#endif
649
650/*
651 * SSL state machine
652 */
653typedef enum
654{
671
684}
686
704typedef int mbedtls_ssl_send_t( void *ctx,
705 const unsigned char *buf,
706 size_t len );
707
728typedef int mbedtls_ssl_recv_t( void *ctx,
729 unsigned char *buf,
730 size_t len );
731
754typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
755 unsigned char *buf,
756 size_t len,
757 uint32_t timeout );
780typedef void mbedtls_ssl_set_timer_t( void * ctx,
781 uint32_t int_ms,
782 uint32_t fin_ms );
783
795typedef int mbedtls_ssl_get_timer_t( void * ctx );
796
797/* Defined below */
801
802/* Defined in library/ssl_misc.h */
806#if defined(MBEDTLS_X509_CRT_PARSE_C)
808#endif
809#if defined(MBEDTLS_SSL_PROTO_DTLS)
811#endif
812
813#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
814typedef uint8_t mbedtls_ssl_tls13_ticket_flags;
815
816#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION \
817 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK /* 1U << 0 */
818#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION \
819 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL /* 1U << 2 */
820#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA ( 1U << 3 )
821
822#define MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK \
823 ( MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION | \
824 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION | \
825 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA )
826#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
827
851typedef int mbedtls_ssl_cache_get_t( void *data,
852 unsigned char const *session_id,
853 size_t session_id_len,
854 mbedtls_ssl_session *session );
873typedef int mbedtls_ssl_cache_set_t( void *data,
874 unsigned char const *session_id,
875 size_t session_id_len,
876 const mbedtls_ssl_session *session );
877
878#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
879#if defined(MBEDTLS_X509_CRT_PARSE_C)
951typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
952 mbedtls_x509_crt *cert,
953 mbedtls_md_type_t md_alg,
954 const unsigned char *hash,
955 size_t hash_len );
956
1017typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
1018 mbedtls_x509_crt *cert,
1019 const unsigned char *input,
1020 size_t input_len );
1021#endif /* MBEDTLS_X509_CRT_PARSE_C */
1022
1065typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
1066 unsigned char *output,
1067 size_t *output_len,
1068 size_t output_size );
1069
1087typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
1088#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
1089
1090#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
1091 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1092#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
1093#if defined(MBEDTLS_SHA256_C)
1094#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
1095#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
1096#elif defined(MBEDTLS_SHA384_C)
1097#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
1098#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
1099#elif defined(MBEDTLS_SHA1_C)
1100#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
1101#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
1102#else
1103/* This is already checked in check_config.h, but be sure. */
1104#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
1105#endif
1106#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
1107 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1108
1109typedef struct
1110{
1111 unsigned char client_application_traffic_secret_N[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
1112 unsigned char server_application_traffic_secret_N[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
1113 unsigned char exporter_master_secret [ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
1114 unsigned char resumption_master_secret [ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
1116
1117#if defined(MBEDTLS_SSL_DTLS_SRTP)
1118
1119#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
1120#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
1121/*
1122 * For code readability use a typedef for DTLS-SRTP profiles
1123 *
1124 * Use_srtp extension protection profiles values as defined in
1125 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
1126 *
1127 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
1128 * must be updated too.
1129 */
1130#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ( (uint16_t) 0x0001)
1131#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ( (uint16_t) 0x0002)
1132#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ( (uint16_t) 0x0005)
1133#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ( (uint16_t) 0x0006)
1134/* This one is not iana defined, but for code readability. */
1135#define MBEDTLS_TLS_SRTP_UNSET ( (uint16_t) 0x0000)
1136
1137typedef uint16_t mbedtls_ssl_srtp_profile;
1138
1139typedef struct mbedtls_dtls_srtp_info_t
1140{
1142 mbedtls_ssl_srtp_profile MBEDTLS_PRIVATE(chosen_dtls_srtp_profile);
1144 uint16_t MBEDTLS_PRIVATE(mki_len);
1146 unsigned char MBEDTLS_PRIVATE(mki_value)[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
1147}
1148mbedtls_dtls_srtp_info;
1149
1150#endif /* MBEDTLS_SSL_DTLS_SRTP */
1151
1153typedef enum
1154{
1159
1160/*
1161 * This structure is used for storing current session data.
1162 *
1163 * Note: when changing this definition, we need to check and update:
1164 * - in tests/suites/test_suite_ssl.function:
1165 * ssl_populate_session() and ssl_serialize_session_save_load()
1166 * - in library/ssl_tls.c:
1167 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
1168 * mbedtls_ssl_session_save() and ssl_session_load()
1169 * ssl_session_copy()
1170 */
1172{
1173#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1174 unsigned char MBEDTLS_PRIVATE(mfl_code);
1175#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
1176
1177 unsigned char MBEDTLS_PRIVATE(exported);
1178
1183
1184#if defined(MBEDTLS_HAVE_TIME)
1186#endif
1187 int MBEDTLS_PRIVATE(ciphersuite);
1188 size_t MBEDTLS_PRIVATE(id_len);
1189 unsigned char MBEDTLS_PRIVATE(id)[32];
1190 unsigned char MBEDTLS_PRIVATE(master)[48];
1192#if defined(MBEDTLS_X509_CRT_PARSE_C)
1193#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
1195#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1198 unsigned char *MBEDTLS_PRIVATE(peer_cert_digest);
1199 size_t MBEDTLS_PRIVATE(peer_cert_digest_len);
1200 mbedtls_md_type_t MBEDTLS_PRIVATE(peer_cert_digest_type);
1201#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
1202#endif /* MBEDTLS_X509_CRT_PARSE_C */
1203 uint32_t MBEDTLS_PRIVATE(verify_result);
1205#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
1206 unsigned char *MBEDTLS_PRIVATE(ticket);
1207 size_t MBEDTLS_PRIVATE(ticket_len);
1208 uint32_t MBEDTLS_PRIVATE(ticket_lifetime);
1209#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
1210
1211#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
1212 uint8_t MBEDTLS_PRIVATE(endpoint);
1213 uint8_t MBEDTLS_PRIVATE(ticket_flags);
1214 uint32_t MBEDTLS_PRIVATE(ticket_age_add);
1215 uint8_t MBEDTLS_PRIVATE(resumption_key_len);
1216 unsigned char MBEDTLS_PRIVATE(resumption_key)[MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN];
1217
1218#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && defined(MBEDTLS_SSL_CLI_C)
1219 char *MBEDTLS_PRIVATE(hostname);
1220#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION && MBEDTLS_SSL_CLI_C */
1221
1222#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_CLI_C)
1223 mbedtls_time_t MBEDTLS_PRIVATE(ticket_received);
1224#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_CLI_C */
1225
1226#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
1227
1228#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1229 int MBEDTLS_PRIVATE(encrypt_then_mac);
1230#endif
1231
1232#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1234#endif
1235};
1236
1237/*
1238 * Identifiers for PRFs used in various versions of TLS.
1239 */
1240typedef enum
1241{
1249
1250typedef enum
1251{
1253#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1254 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_EARLY_SECRET,
1255 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_EARLY_EXPORTER_SECRET,
1256 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
1257 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
1258 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
1259 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
1260#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1262
1278typedef void mbedtls_ssl_export_keys_t( void *p_expkey,
1280 const unsigned char *secret,
1281 size_t secret_len,
1282 const unsigned char client_random[32],
1283 const unsigned char server_random[32],
1284 mbedtls_tls_prf_types tls_prf_type );
1285
1286#if defined(MBEDTLS_SSL_SRV_C)
1303#endif
1304
1305/* A type for storing user data in a library structure.
1306 *
1307 * The representation of type may change in future versions of the library.
1308 * Only the behaviors guaranteed by documented accessor functions are
1309 * guaranteed to remain stable.
1310 */
1311typedef union
1312{
1313 uintptr_t n; /* typically a handle to an associated object */
1314 void *p; /* typically a pointer to extra data */
1316
1321{
1322 /* Group items mostly by size. This helps to reduce memory wasted to
1323 * padding. It also helps to keep smaller fields early in the structure,
1324 * so that elements tend to be in the 128-element direct access window
1325 * on Arm Thumb, which reduces the code size. */
1326
1330 /*
1331 * Flags (could be bit-fields to save RAM, but separate bytes make
1332 * the code smaller on architectures with an instruction for direct
1333 * byte access).
1334 */
1335
1336 uint8_t MBEDTLS_PRIVATE(endpoint);
1337 uint8_t MBEDTLS_PRIVATE(transport);
1338 uint8_t MBEDTLS_PRIVATE(authmode);
1339 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
1340 uint8_t MBEDTLS_PRIVATE(allow_legacy_renegotiation);
1341#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1342 uint8_t MBEDTLS_PRIVATE(mfl_code);
1344#endif
1345#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1346 uint8_t MBEDTLS_PRIVATE(encrypt_then_mac);
1347#endif
1348#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1349 uint8_t MBEDTLS_PRIVATE(extended_ms);
1350#endif
1351#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1352 uint8_t MBEDTLS_PRIVATE(anti_replay);
1353#endif
1354#if defined(MBEDTLS_SSL_RENEGOTIATION)
1355 uint8_t MBEDTLS_PRIVATE(disable_renegotiation);
1356#endif
1357#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1358 defined(MBEDTLS_SSL_CLI_C)
1359 uint8_t MBEDTLS_PRIVATE(session_tickets);
1360#endif
1361
1362#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1363 defined(MBEDTLS_SSL_SRV_C) && \
1364 defined(MBEDTLS_SSL_PROTO_TLS1_3)
1365 uint16_t MBEDTLS_PRIVATE(new_session_tickets_count);
1366#endif
1367
1368#if defined(MBEDTLS_SSL_SRV_C)
1369 uint8_t MBEDTLS_PRIVATE(cert_req_ca_list);
1371 uint8_t MBEDTLS_PRIVATE(respect_cli_pref);
1374#endif
1375#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1376 uint8_t MBEDTLS_PRIVATE(ignore_unexpected_cid);
1379#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1380#if defined(MBEDTLS_SSL_DTLS_SRTP)
1381 uint8_t MBEDTLS_PRIVATE(dtls_srtp_mki_support); /* support having mki_value
1382 in the use_srtp extension? */
1383#endif
1384
1385 /*
1386 * Pointers
1387 */
1388
1390 const int *MBEDTLS_PRIVATE(ciphersuite_list);
1391
1392#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1394 int MBEDTLS_PRIVATE(tls13_kex_modes);
1395#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1396
1398 void (*MBEDTLS_PRIVATE(f_dbg))(void *, int, const char *, int, const char *);
1399 void *MBEDTLS_PRIVATE(p_dbg);
1402 int (*MBEDTLS_PRIVATE(f_rng))(void *, unsigned char *, size_t);
1403 void *MBEDTLS_PRIVATE(p_rng);
1409 void *MBEDTLS_PRIVATE(p_cache);
1411#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1413 int (*MBEDTLS_PRIVATE(f_sni))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1414 void *MBEDTLS_PRIVATE(p_sni);
1415#endif
1416
1417#if defined(MBEDTLS_X509_CRT_PARSE_C)
1419 int (*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
1420 void *MBEDTLS_PRIVATE(p_vrfy);
1421#endif
1422
1423#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
1424#if defined(MBEDTLS_SSL_SRV_C)
1426 int (*MBEDTLS_PRIVATE(f_psk))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1427 void *MBEDTLS_PRIVATE(p_psk);
1428#endif
1429#endif
1430
1431#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
1433 int (*MBEDTLS_PRIVATE(f_cookie_write))( void *, unsigned char **, unsigned char *,
1434 const unsigned char *, size_t );
1436 int (*MBEDTLS_PRIVATE(f_cookie_check))( void *, const unsigned char *, size_t,
1437 const unsigned char *, size_t );
1438 void *MBEDTLS_PRIVATE(p_cookie);
1439#endif
1440
1441#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
1443 int (*MBEDTLS_PRIVATE(f_ticket_write))( void *, const mbedtls_ssl_session *,
1444 unsigned char *, const unsigned char *, size_t *, uint32_t * );
1446 int (*MBEDTLS_PRIVATE(f_ticket_parse))( void *, mbedtls_ssl_session *, unsigned char *, size_t);
1447 void *MBEDTLS_PRIVATE(p_ticket);
1448#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
1449#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1450 size_t MBEDTLS_PRIVATE(cid_len);
1451#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1452
1453#if defined(MBEDTLS_X509_CRT_PARSE_C)
1458#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1460 void *MBEDTLS_PRIVATE(p_ca_cb);
1461#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
1462#endif /* MBEDTLS_X509_CRT_PARSE_C */
1463
1464#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
1465#if defined(MBEDTLS_X509_CRT_PARSE_C)
1466 mbedtls_ssl_async_sign_t *MBEDTLS_PRIVATE(f_async_sign_start);
1467 mbedtls_ssl_async_decrypt_t *MBEDTLS_PRIVATE(f_async_decrypt_start);
1468#endif /* MBEDTLS_X509_CRT_PARSE_C */
1469 mbedtls_ssl_async_resume_t *MBEDTLS_PRIVATE(f_async_resume);
1470 mbedtls_ssl_async_cancel_t *MBEDTLS_PRIVATE(f_async_cancel);
1471 void *MBEDTLS_PRIVATE(p_async_config_data);
1472#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
1473
1474#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
1475
1476#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1477 const int *MBEDTLS_PRIVATE(sig_hashes);
1478#endif
1479 const uint16_t *MBEDTLS_PRIVATE(sig_algs);
1480#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
1481
1482#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
1484#endif
1485
1486 const uint16_t *MBEDTLS_PRIVATE(group_list);
1488#if defined(MBEDTLS_DHM_C)
1491#endif
1492
1493#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
1494
1495#if defined(MBEDTLS_USE_PSA_CRYPTO)
1502#endif /* MBEDTLS_USE_PSA_CRYPTO */
1503 unsigned char *MBEDTLS_PRIVATE(psk);
1507 size_t MBEDTLS_PRIVATE(psk_len);
1513 unsigned char *MBEDTLS_PRIVATE(psk_identity);
1518 size_t MBEDTLS_PRIVATE(psk_identity_len);
1524#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
1525
1526#if defined(MBEDTLS_SSL_EARLY_DATA)
1527 int MBEDTLS_PRIVATE(early_data_enabled);
1531#if defined(MBEDTLS_SSL_SRV_C)
1532 /* The maximum amount of 0-RTT data. RFC 8446 section 4.6.1 */
1533 uint32_t MBEDTLS_PRIVATE(max_early_data_size);
1534#endif /* MBEDTLS_SSL_SRV_C */
1535
1536#endif /* MBEDTLS_SSL_EARLY_DATA */
1537
1538#if defined(MBEDTLS_SSL_ALPN)
1539 const char **MBEDTLS_PRIVATE(alpn_list);
1540#endif
1541
1542#if defined(MBEDTLS_SSL_DTLS_SRTP)
1544 const mbedtls_ssl_srtp_profile *MBEDTLS_PRIVATE(dtls_srtp_profile_list);
1546 size_t MBEDTLS_PRIVATE(dtls_srtp_profile_list_len);
1547#endif /* MBEDTLS_SSL_DTLS_SRTP */
1548
1549 /*
1550 * Numerical settings (int)
1551 */
1552
1553 uint32_t MBEDTLS_PRIVATE(read_timeout);
1555#if defined(MBEDTLS_SSL_PROTO_DTLS)
1556 uint32_t MBEDTLS_PRIVATE(hs_timeout_min);
1558 uint32_t MBEDTLS_PRIVATE(hs_timeout_max);
1560#endif
1561
1562#if defined(MBEDTLS_SSL_RENEGOTIATION)
1563 int MBEDTLS_PRIVATE(renego_max_records);
1564 unsigned char MBEDTLS_PRIVATE(renego_period)[8];
1566#endif
1567
1568 unsigned int MBEDTLS_PRIVATE(badmac_limit);
1570#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1571 unsigned int MBEDTLS_PRIVATE(dhm_min_bitlen);
1572#endif
1573
1580
1581#if defined(MBEDTLS_SSL_SRV_C)
1583#endif /* MBEDTLS_SSL_SRV_C */
1584
1585#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1587#endif
1588};
1589
1591{
1594 /*
1595 * Miscellaneous
1596 */
1597 int MBEDTLS_PRIVATE(state);
1598#if defined(MBEDTLS_SSL_RENEGOTIATION)
1599 int MBEDTLS_PRIVATE(renego_status);
1600 int MBEDTLS_PRIVATE(renego_records_seen);
1603#endif /* MBEDTLS_SSL_RENEGOTIATION */
1604
1620
1621 unsigned MBEDTLS_PRIVATE(badmac_seen);
1623#if defined(MBEDTLS_X509_CRT_PARSE_C)
1625 int (*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
1626 void *MBEDTLS_PRIVATE(p_vrfy);
1627#endif
1628
1634 void *MBEDTLS_PRIVATE(p_bio);
1636 /*
1637 * Session layer
1638 */
1647 /*
1648 * Record layer transformations
1649 */
1663#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1666 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_application);
1667#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1668
1669 /*
1670 * Timers
1671 */
1672 void *MBEDTLS_PRIVATE(p_timer);
1677 /*
1678 * Record layer (incoming data)
1679 */
1680 unsigned char *MBEDTLS_PRIVATE(in_buf);
1681 unsigned char *MBEDTLS_PRIVATE(in_ctr);
1684 unsigned char *MBEDTLS_PRIVATE(in_hdr);
1685#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1686 unsigned char *MBEDTLS_PRIVATE(in_cid);
1688#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1689 unsigned char *MBEDTLS_PRIVATE(in_len);
1690 unsigned char *MBEDTLS_PRIVATE(in_iv);
1691 unsigned char *MBEDTLS_PRIVATE(in_msg);
1692 unsigned char *MBEDTLS_PRIVATE(in_offt);
1694 int MBEDTLS_PRIVATE(in_msgtype);
1695 size_t MBEDTLS_PRIVATE(in_msglen);
1696 size_t MBEDTLS_PRIVATE(in_left);
1697#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1698 size_t MBEDTLS_PRIVATE(in_buf_len);
1699#endif
1700#if defined(MBEDTLS_SSL_PROTO_DTLS)
1701 uint16_t MBEDTLS_PRIVATE(in_epoch);
1702 size_t MBEDTLS_PRIVATE(next_record_offset);
1704#endif /* MBEDTLS_SSL_PROTO_DTLS */
1705#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1706 uint64_t MBEDTLS_PRIVATE(in_window_top);
1707 uint64_t MBEDTLS_PRIVATE(in_window);
1708#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
1709
1710 size_t MBEDTLS_PRIVATE(in_hslen);
1712 int MBEDTLS_PRIVATE(nb_zero);
1714 int MBEDTLS_PRIVATE(keep_current_message);
1717 /* The following three variables indicate if and, if yes,
1718 * what kind of alert is pending to be sent.
1719 */
1720 unsigned char MBEDTLS_PRIVATE(send_alert);
1724 unsigned char MBEDTLS_PRIVATE(alert_type);
1726 int MBEDTLS_PRIVATE(alert_reason);
1730#if defined(MBEDTLS_SSL_PROTO_DTLS)
1731 uint8_t MBEDTLS_PRIVATE(disable_datagram_packing);
1733#endif /* MBEDTLS_SSL_PROTO_DTLS */
1734
1735 /*
1736 * Record layer (outgoing data)
1737 */
1738 unsigned char *MBEDTLS_PRIVATE(out_buf);
1739 unsigned char *MBEDTLS_PRIVATE(out_ctr);
1740 unsigned char *MBEDTLS_PRIVATE(out_hdr);
1741#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1742 unsigned char *MBEDTLS_PRIVATE(out_cid);
1744#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1745 unsigned char *MBEDTLS_PRIVATE(out_len);
1746 unsigned char *MBEDTLS_PRIVATE(out_iv);
1747 unsigned char *MBEDTLS_PRIVATE(out_msg);
1749 int MBEDTLS_PRIVATE(out_msgtype);
1750 size_t MBEDTLS_PRIVATE(out_msglen);
1751 size_t MBEDTLS_PRIVATE(out_left);
1752#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1753 size_t MBEDTLS_PRIVATE(out_buf_len);
1754#endif
1755
1758#if defined(MBEDTLS_SSL_PROTO_DTLS)
1759 uint16_t MBEDTLS_PRIVATE(mtu);
1760#endif /* MBEDTLS_SSL_PROTO_DTLS */
1761
1762 /*
1763 * User settings
1764 */
1765#if defined(MBEDTLS_X509_CRT_PARSE_C)
1766 char *MBEDTLS_PRIVATE(hostname);
1768#endif /* MBEDTLS_X509_CRT_PARSE_C */
1769
1770#if defined(MBEDTLS_SSL_ALPN)
1771 const char *MBEDTLS_PRIVATE(alpn_chosen);
1772#endif /* MBEDTLS_SSL_ALPN */
1773
1774#if defined(MBEDTLS_SSL_DTLS_SRTP)
1775 /*
1776 * use_srtp extension
1777 */
1778 mbedtls_dtls_srtp_info MBEDTLS_PRIVATE(dtls_srtp_info);
1779#endif /* MBEDTLS_SSL_DTLS_SRTP */
1780
1781 /*
1782 * Information for DTLS hello verify
1783 */
1784#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
1785 unsigned char *MBEDTLS_PRIVATE(cli_id);
1786 size_t MBEDTLS_PRIVATE(cli_id_len);
1787#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
1788
1789 /*
1790 * Secure renegotiation
1791 */
1792 /* needed to know when to send extension on server */
1793 int MBEDTLS_PRIVATE(secure_renegotiation);
1795#if defined(MBEDTLS_SSL_RENEGOTIATION)
1796 size_t MBEDTLS_PRIVATE(verify_data_len);
1799#endif /* MBEDTLS_SSL_RENEGOTIATION */
1800
1801#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1802 /* CID configuration to use in subsequent handshakes. */
1803
1809 uint8_t MBEDTLS_PRIVATE(own_cid_len);
1810 uint8_t MBEDTLS_PRIVATE(negotiate_cid);
1814#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1815
1816#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
1817 int MBEDTLS_PRIVATE(early_data_status);
1818#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
1819
1822 void *MBEDTLS_PRIVATE(p_export_keys);
1834};
1835
1844const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
1845
1854int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
1855
1864
1886 const mbedtls_ssl_config *conf );
1887
1898
1906
1922
1950
1951#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_EARLY_DATA)
1971void mbedtls_ssl_tls13_conf_early_data( mbedtls_ssl_config *conf,
1972 int early_data_enabled );
1973
1974#if defined(MBEDTLS_SSL_SRV_C)
1998void mbedtls_ssl_tls13_conf_max_early_data_size(
1999 mbedtls_ssl_config *conf, uint32_t max_early_data_size );
2000#endif /* MBEDTLS_SSL_SRV_C */
2001
2002#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_EARLY_DATA */
2003
2004#if defined(MBEDTLS_X509_CRT_PARSE_C)
2021 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2022 void *p_vrfy );
2023#endif /* MBEDTLS_X509_CRT_PARSE_C */
2024
2033 int (*f_rng)(void *, unsigned char *, size_t),
2034 void *p_rng );
2035
2051 void (*f_dbg)(void *, int, const char *, int, const char *),
2052 void *p_dbg );
2053
2065 const mbedtls_ssl_context *ssl )
2066{
2067 return( ssl->MBEDTLS_PRIVATE( conf ) );
2068}
2069
2101 void *p_bio,
2102 mbedtls_ssl_send_t *f_send,
2103 mbedtls_ssl_recv_t *f_recv,
2104 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
2105
2106#if defined(MBEDTLS_SSL_PROTO_DTLS)
2107
2108#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2109
2110
2196 int enable,
2197 unsigned char const *own_cid,
2198 size_t own_cid_len );
2199
2230 int *enabled,
2231 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
2232 size_t *own_cid_len );
2233
2272 int *enabled,
2273 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
2274 size_t *peer_cid_len );
2275
2276#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
2277
2317void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu );
2318#endif /* MBEDTLS_SSL_PROTO_DTLS */
2319
2320#if defined(MBEDTLS_X509_CRT_PARSE_C)
2340 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2341 void *p_vrfy );
2342#endif /* MBEDTLS_X509_CRT_PARSE_C */
2343
2361
2407 unsigned char *buf,
2408 size_t buflen );
2409
2431 void *p_timer,
2432 mbedtls_ssl_set_timer_t *f_set_timer,
2433 mbedtls_ssl_get_timer_t *f_get_timer );
2434
2435#if defined(MBEDTLS_SSL_SRV_C)
2447 mbedtls_ssl_hs_cb_t f_cert_cb )
2448{
2449 conf->MBEDTLS_PRIVATE(f_cert_cb) = f_cert_cb;
2450}
2451#endif /* MBEDTLS_SSL_SRV_C */
2452
2472typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
2473 const mbedtls_ssl_session *session,
2474 unsigned char *start,
2475 const unsigned char *end,
2476 size_t *tlen,
2477 uint32_t *lifetime );
2478
2502typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
2503 mbedtls_ssl_session *session,
2504 unsigned char *buf,
2505 size_t len );
2506
2507#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
2523 mbedtls_ssl_ticket_write_t *f_ticket_write,
2524 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2525 void *p_ticket );
2526#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
2527
2547 mbedtls_ssl_export_keys_t *f_export_keys,
2548 void *p_export_keys );
2549
2561 mbedtls_ssl_config *conf,
2562 void *p )
2563{
2564 conf->MBEDTLS_PRIVATE(user_data).p = p;
2565}
2566
2575 mbedtls_ssl_config *conf,
2576 uintptr_t n )
2577{
2578 conf->MBEDTLS_PRIVATE(user_data).n = n;
2579}
2580
2592 mbedtls_ssl_config *conf )
2593{
2594 return( conf->MBEDTLS_PRIVATE(user_data).p );
2595}
2596
2607static inline uintptr_t mbedtls_ssl_conf_get_user_data_n(
2608 mbedtls_ssl_config *conf )
2609{
2610 return( conf->MBEDTLS_PRIVATE(user_data).n );
2611}
2612
2625 void *p )
2626{
2627 ssl->MBEDTLS_PRIVATE(user_data).p = p;
2628}
2629
2639 uintptr_t n )
2640{
2641 ssl->MBEDTLS_PRIVATE(user_data).n = n;
2642}
2643
2655 mbedtls_ssl_context *ssl )
2656{
2657 return( ssl->MBEDTLS_PRIVATE(user_data).p );
2658}
2659
2670static inline uintptr_t mbedtls_ssl_get_user_data_n(
2671 mbedtls_ssl_context *ssl )
2672{
2673 return( ssl->MBEDTLS_PRIVATE(user_data).n );
2674}
2675
2676#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
2707void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
2708 mbedtls_ssl_async_sign_t *f_async_sign,
2709 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2710 mbedtls_ssl_async_resume_t *f_async_resume,
2711 mbedtls_ssl_async_cancel_t *f_async_cancel,
2712 void *config_data );
2713
2722void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
2723
2738void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
2739
2751void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
2752 void *ctx );
2753#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
2754
2769typedef int mbedtls_ssl_cookie_write_t( void *ctx,
2770 unsigned char **p, unsigned char *end,
2771 const unsigned char *info, size_t ilen );
2772
2786typedef int mbedtls_ssl_cookie_check_t( void *ctx,
2787 const unsigned char *cookie, size_t clen,
2788 const unsigned char *info, size_t ilen );
2789
2790#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
2820 mbedtls_ssl_cookie_write_t *f_cookie_write,
2821 mbedtls_ssl_cookie_check_t *f_cookie_check,
2822 void *p_cookie );
2823
2844 const unsigned char *info,
2845 size_t ilen );
2846
2847#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
2848
2849#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
2866#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
2867
2892
2893#if defined(MBEDTLS_SSL_PROTO_DTLS)
2894
2924 unsigned allow_packing );
2925
2957void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
2958#endif /* MBEDTLS_SSL_PROTO_DTLS */
2959
2960#if defined(MBEDTLS_SSL_SRV_C)
2999 void *p_cache,
3000 mbedtls_ssl_cache_get_t *f_get_cache,
3001 mbedtls_ssl_cache_set_t *f_set_cache );
3002#endif /* MBEDTLS_SSL_SRV_C */
3003
3004#if defined(MBEDTLS_SSL_CLI_C)
3051#endif /* MBEDTLS_SSL_CLI_C */
3052
3086 const unsigned char *buf,
3087 size_t len );
3088
3115 unsigned char *buf,
3116 size_t buf_len,
3117 size_t *olen );
3118
3161 const int *ciphersuites );
3162
3163#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3206void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config* conf,
3207 const int kex_modes );
3208#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3209
3210#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3211#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
3212#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
3246 int ignore_other_cids );
3247#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3248
3249#if defined(MBEDTLS_X509_CRT_PARSE_C)
3261 const mbedtls_x509_crt_profile *profile );
3262
3275 mbedtls_x509_crt *ca_chain,
3276 mbedtls_x509_crl *ca_crl );
3277
3278#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
3290static inline
3292 const mbedtls_x509_crt *crt )
3293{
3294 conf->MBEDTLS_PRIVATE(dn_hints) = crt;
3295}
3296#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
3297
3298#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
3350void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
3352 void *p_ca_cb );
3353#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
3354
3392 mbedtls_x509_crt *own_cert,
3393 mbedtls_pk_context *pk_key );
3394#endif /* MBEDTLS_X509_CRT_PARSE_C */
3395
3396#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
3430 const unsigned char *psk, size_t psk_len,
3431 const unsigned char *psk_identity, size_t psk_identity_len );
3432
3433#if defined(MBEDTLS_USE_PSA_CRYPTO)
3471int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
3473 const unsigned char *psk_identity,
3474 size_t psk_identity_len );
3475#endif /* MBEDTLS_USE_PSA_CRYPTO */
3476
3494 const unsigned char *psk, size_t psk_len );
3495
3496#if defined(MBEDTLS_USE_PSA_CRYPTO)
3517int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
3519#endif /* MBEDTLS_USE_PSA_CRYPTO */
3520
3521#if defined(MBEDTLS_SSL_SRV_C)
3561 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
3562 size_t),
3563 void *p_psk );
3564#endif /* MBEDTLS_SSL_SRV_C */
3565#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
3566
3567#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
3582 const unsigned char *dhm_P, size_t P_len,
3583 const unsigned char *dhm_G, size_t G_len );
3584
3595#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
3596
3597#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
3607 unsigned int bitlen );
3608#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
3609
3610#if defined(MBEDTLS_ECP_C)
3611#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3654 const mbedtls_ecp_group_id *curves );
3655#endif /* MBEDTLS_DEPRECATED_REMOVED */
3656#endif /* MBEDTLS_ECP_C */
3657
3696 const uint16_t *groups );
3697
3698#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
3699#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
3730 const int *hashes );
3731#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
3732
3743 const uint16_t* sig_algs );
3744#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
3745
3746#if defined(MBEDTLS_X509_CRT_PARSE_C)
3765int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
3766#endif /* MBEDTLS_X509_CRT_PARSE_C */
3767
3768#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3788 size_t *name_len );
3789
3806 mbedtls_x509_crt *own_cert,
3807 mbedtls_pk_context *pk_key );
3808
3821 mbedtls_x509_crt *ca_chain,
3822 mbedtls_x509_crl *ca_crl );
3823
3824#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
3836 const mbedtls_x509_crt *crt );
3837#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
3838
3850 int authmode );
3851
3875 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
3876 size_t),
3877 void *p_sni );
3878#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3879
3880#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
3899int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
3900 const unsigned char *pw,
3901 size_t pw_len );
3902#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
3903
3904#if defined(MBEDTLS_SSL_ALPN)
3917int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
3918
3929#endif /* MBEDTLS_SSL_ALPN */
3930
3931#if defined(MBEDTLS_SSL_DTLS_SRTP)
3932#if defined(MBEDTLS_DEBUG_C)
3933static inline const char *mbedtls_ssl_get_srtp_profile_as_string( mbedtls_ssl_srtp_profile profile )
3934{
3935 switch( profile )
3936 {
3937 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
3938 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80" );
3939 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
3940 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32" );
3941 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
3942 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80" );
3943 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
3944 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32" );
3945 default: break;
3946 }
3947 return( "" );
3948}
3949#endif /* MBEDTLS_DEBUG_C */
3963void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
3964 int support_mki_value );
3965
3985int mbedtls_ssl_conf_dtls_srtp_protection_profiles
3986 ( mbedtls_ssl_config *conf,
3987 const mbedtls_ssl_srtp_profile *profiles );
3988
4005int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
4006 unsigned char *mki_value,
4007 uint16_t mki_len );
4026void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
4027 mbedtls_dtls_srtp_info *dtls_srtp_info );
4028#endif /* MBEDTLS_SSL_DTLS_SRTP */
4029
4030#if !defined(MBEDTLS_DEPRECATED_REMOVED)
4049#endif /* MBEDTLS_DEPRECATED_REMOVED */
4050
4064 mbedtls_ssl_protocol_version tls_version )
4065{
4066 conf->MBEDTLS_PRIVATE(max_tls_version) = tls_version;
4067}
4068
4069#if !defined(MBEDTLS_DEPRECATED_REMOVED)
4105#endif /* MBEDTLS_DEPRECATED_REMOVED */
4106
4120 mbedtls_ssl_protocol_version tls_version )
4121{
4122 conf->MBEDTLS_PRIVATE(min_tls_version) = tls_version;
4123}
4124
4125#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4138#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4139
4140#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4153#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
4154
4155#if defined(MBEDTLS_SSL_SRV_C)
4166 char cert_req_ca_list );
4167#endif /* MBEDTLS_SSL_SRV_C */
4168
4169#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4204int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
4205#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4206
4207#if defined(MBEDTLS_SSL_SRV_C)
4218#endif /* MBEDTLS_SSL_SRV_C */
4219
4220#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4221 defined(MBEDTLS_SSL_CLI_C)
4233#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4234 MBEDTLS_SSL_CLI_C */
4235
4236#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4237 defined(MBEDTLS_SSL_SRV_C) && \
4238 defined(MBEDTLS_SSL_PROTO_TLS1_3)
4256void mbedtls_ssl_conf_new_session_tickets( mbedtls_ssl_config *conf,
4257 uint16_t num_tickets );
4258#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4259 MBEDTLS_SSL_SRV_C &&
4260 MBEDTLS_SSL_PROTO_TLS1_3*/
4261
4262#if defined(MBEDTLS_SSL_RENEGOTIATION)
4281#endif /* MBEDTLS_SSL_RENEGOTIATION */
4282
4311
4312#if defined(MBEDTLS_SSL_RENEGOTIATION)
4351
4378 const unsigned char period[8] );
4379#endif /* MBEDTLS_SSL_RENEGOTIATION */
4380
4420
4437
4451
4460
4469
4470
4483 const mbedtls_ssl_context *ssl )
4484{
4485 return ssl->MBEDTLS_PRIVATE(tls_version);
4486}
4487
4496
4506
4533
4553
4554#if defined(MBEDTLS_X509_CRT_PARSE_C)
4586#endif /* MBEDTLS_X509_CRT_PARSE_C */
4587
4588#if defined(MBEDTLS_SSL_CLI_C)
4624 mbedtls_ssl_session *session );
4625#endif /* MBEDTLS_SSL_CLI_C */
4626
4678
4691{
4692 return( ssl->MBEDTLS_PRIVATE( state ) >= MBEDTLS_SSL_HANDSHAKE_OVER );
4693}
4694
4729
4730#if defined(MBEDTLS_SSL_RENEGOTIATION)
4755#endif /* MBEDTLS_SSL_RENEGOTIATION */
4756
4834int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
4835
4896int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
4897
4915 unsigned char level,
4916 unsigned char message );
4931
4932#if defined(MBEDTLS_SSL_EARLY_DATA)
4933
4934#if defined(MBEDTLS_SSL_SRV_C)
4979int mbedtls_ssl_read_early_data( mbedtls_ssl_context *ssl,
4980 unsigned char *buf, size_t len );
4981#endif /* MBEDTLS_SSL_SRV_C */
4982
4983#if defined(MBEDTLS_SSL_CLI_C)
5040int mbedtls_ssl_write_early_data( mbedtls_ssl_context *ssl,
5041 const unsigned char *buf, size_t len );
5042
5043#define MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT 0
5044#define MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED 1
5045#define MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED 2
5072int mbedtls_ssl_get_early_data_status( mbedtls_ssl_context *ssl );
5073#endif /* MBEDTLS_SSL_CLI_C */
5074
5075#endif /* MBEDTLS_SSL_EARLY_DATA */
5076
5083
5084#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
5142 unsigned char *buf,
5143 size_t buf_len,
5144 size_t *olen );
5145
5215 const unsigned char *buf,
5216 size_t len );
5217#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
5218
5230
5247 int endpoint, int transport, int preset );
5248
5255
5262
5273
5290 const unsigned char *secret, size_t slen,
5291 const char *label,
5292 const unsigned char *random, size_t rlen,
5293 unsigned char *dstbuf, size_t dlen );
5294
5295#ifdef __cplusplus
5296}
5297#endif
5298
5299#endif /* ssl.h */
Multi-precision integer library.
#define MBEDTLS_MPI_MAX_SIZE
Definition: bignum.h:85
Build-time configuration info.
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:346
mbedtls_ecp_group_id
Definition: ecp.h:114
psa_key_id_t mbedtls_svc_key_id_t
Definition: crypto_types.h:296
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:843
mbedtls_md_type_t
Supported message digests.
Definition: md.h:55
mbed TLS Platform time abstraction
time_t mbedtls_time_t
Definition: platform_time.h:39
Common and shared functions used by multiple modules in the Mbed TLS library.
#define MBEDTLS_DEPRECATED
Definition: platform_util.h:53
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
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:601
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:851
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:2472
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:402
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:1278
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:2591
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:2670
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:2574
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:803
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:398
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:1241
@ MBEDTLS_SSL_TLS_PRF_SHA384
Definition: ssl.h:1243
@ MBEDTLS_SSL_HKDF_EXPAND_SHA256
Definition: ssl.h:1246
@ MBEDTLS_SSL_TLS_PRF_SHA256
Definition: ssl.h:1244
@ MBEDTLS_SSL_TLS_PRF_NONE
Definition: ssl.h:1242
@ MBEDTLS_SSL_HKDF_EXPAND_SHA384
Definition: ssl.h:1245
int mbedtls_ssl_send_t(void *ctx, const unsigned char *buf, size_t len)
Callback type: send data on the network.
Definition: ssl.h:704
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:654
@ MBEDTLS_SSL_CERTIFICATE_VERIFY
Definition: ssl.h:664
@ MBEDTLS_SSL_HANDSHAKE_OVER
Definition: ssl.h:681
@ MBEDTLS_SSL_SERVER_HELLO_DONE
Definition: ssl.h:661
@ MBEDTLS_SSL_NEW_SESSION_TICKET
Definition: ssl.h:672
@ MBEDTLS_SSL_SERVER_FINISHED
Definition: ssl.h:668
@ MBEDTLS_SSL_SERVER_KEY_EXCHANGE
Definition: ssl.h:659
@ MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
Definition: ssl.h:675
@ MBEDTLS_SSL_SERVER_HELLO
Definition: ssl.h:657
@ MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST
Definition: ssl.h:680
@ MBEDTLS_SSL_CLIENT_KEY_EXCHANGE
Definition: ssl.h:663
@ MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO
Definition: ssl.h:678
@ MBEDTLS_SSL_CLIENT_HELLO
Definition: ssl.h:656
@ MBEDTLS_SSL_SERVER_CERTIFICATE
Definition: ssl.h:658
@ MBEDTLS_SSL_CERTIFICATE_REQUEST
Definition: ssl.h:660
@ MBEDTLS_SSL_CLIENT_FINISHED
Definition: ssl.h:666
@ MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC
Definition: ssl.h:667
@ MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT
Definition: ssl.h:673
@ MBEDTLS_SSL_HANDSHAKE_WRAPUP
Definition: ssl.h:670
@ MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED
Definition: ssl.h:677
@ MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC
Definition: ssl.h:665
@ MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
Definition: ssl.h:676
@ MBEDTLS_SSL_HELLO_REQUEST
Definition: ssl.h:655
@ MBEDTLS_SSL_CLIENT_CERTIFICATE
Definition: ssl.h:662
@ MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH
Definition: ssl.h:683
@ MBEDTLS_SSL_FLUSH_BUFFERS
Definition: ssl.h:669
@ MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Definition: ssl.h:682
@ MBEDTLS_SSL_HELLO_RETRY_REQUEST
Definition: ssl.h:674
@ MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO
Definition: ssl.h:679
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:1302
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:1154
@ MBEDTLS_SSL_VERSION_TLS1_2
Definition: ssl.h:1156
@ MBEDTLS_SSL_VERSION_TLS1_3
Definition: ssl.h:1157
@ MBEDTLS_SSL_VERSION_UNKNOWN
Definition: ssl.h:1155
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:4690
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:2502
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:2446
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:805
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:644
mbedtls_ssl_key_export_type
Definition: ssl.h:1251
@ MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET
Definition: ssl.h:1252
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:2769
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:4482
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:804
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:780
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:2064
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:754
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:3291
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:422
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:2607
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:2786
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:873
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:640
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:4063
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:810
int mbedtls_ssl_recv_t(void *ctx, unsigned char *buf, size_t len)
Callback type: receive data from the network.
Definition: ssl.h:728
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:2560
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:2654
int mbedtls_ssl_get_timer_t(void *ctx)
Callback type: get status of timers/delays.
Definition: ssl.h:795
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:2637
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:4119
struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert
Definition: ssl.h:807
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:2623
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:115
MPI structure.
Definition: bignum.h:204
Public key container.
Definition: pk.h:195
unsigned char _pms_ecdhe_psk[4+MBEDTLS_ECP_MAX_BYTES+MBEDTLS_PSK_MAX_LEN]
Definition: ssl.h:631
unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]
Definition: ssl.h:611
unsigned char _pms_psk[4+2 *MBEDTLS_PSK_MAX_LEN]
Definition: ssl.h:620
unsigned char _pms_rsa_psk[52+MBEDTLS_PSK_MAX_LEN]
Definition: ssl.h:627
unsigned char _pms_rsa[48]
Definition: ssl.h:608
unsigned char _pms_dhe_psk[4+MBEDTLS_MPI_MAX_SIZE+MBEDTLS_PSK_MAX_LEN]
Definition: ssl.h:624
unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]
Definition: ssl.h:617
X.509 certificate revocation list parsing.
X.509 certificate parsing and writing.