mbed TLS v2.2.1
ssl.h
Go to the documentation of this file.
1 
23 #ifndef MBEDTLS_SSL_H
24 #define MBEDTLS_SSL_H
25 
26 #if !defined(MBEDTLS_CONFIG_FILE)
27 #include "config.h"
28 #else
29 #include MBEDTLS_CONFIG_FILE
30 #endif
31 
32 #include "bignum.h"
33 #include "ecp.h"
34 
35 #include "ssl_ciphersuites.h"
36 
37 #if defined(MBEDTLS_X509_CRT_PARSE_C)
38 #include "x509_crt.h"
39 #include "x509_crl.h"
40 #endif
41 
42 #if defined(MBEDTLS_DHM_C)
43 #include "dhm.h"
44 #endif
45 
46 #if defined(MBEDTLS_ECDH_C)
47 #include "ecdh.h"
48 #endif
49 
50 #if defined(MBEDTLS_ZLIB_SUPPORT)
51 #include "zlib.h"
52 #endif
53 
54 #if defined(MBEDTLS_HAVE_TIME)
55 #include <time.h>
56 #endif
57 
58 /*
59  * SSL Error codes
60  */
61 #define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
62 #define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100
63 #define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180
64 #define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200
65 #define MBEDTLS_ERR_SSL_CONN_EOF -0x7280
66 #define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300
67 #define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380
68 #define MBEDTLS_ERR_SSL_NO_RNG -0x7400
69 #define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
70 #define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500
71 #define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580
72 #define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
73 #define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
74 #define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
75 #define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
76 #define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800
77 #define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
78 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900
79 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980
80 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00
81 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80
82 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00
83 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80
84 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00
85 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80
86 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00
87 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80
88 #define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00
89 #define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80
90 #define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00
91 #define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80
92 #define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
93 #define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00
94 #define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80
95 #define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00
96 #define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80
97 #define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00
98 #define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80
99 #define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00
100 #define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80
101 #define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00
102 #define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80
103 #define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00
104 #define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980
105 #define MBEDTLS_ERR_SSL_WANT_READ -0x6900
106 #define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880
107 #define MBEDTLS_ERR_SSL_TIMEOUT -0x6800
108 #define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780
109 #define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700
111 /*
112  * Various constants
113  */
114 #define MBEDTLS_SSL_MAJOR_VERSION_3 3
115 #define MBEDTLS_SSL_MINOR_VERSION_0 0
116 #define MBEDTLS_SSL_MINOR_VERSION_1 1
117 #define MBEDTLS_SSL_MINOR_VERSION_2 2
118 #define MBEDTLS_SSL_MINOR_VERSION_3 3
120 #define MBEDTLS_SSL_TRANSPORT_STREAM 0
121 #define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1
123 #define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255
125 /* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
126  * NONE must be zero so that memset()ing structure to zero works */
127 #define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0
128 #define MBEDTLS_SSL_MAX_FRAG_LEN_512 1
129 #define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2
130 #define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3
131 #define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4
132 #define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5
134 #define MBEDTLS_SSL_IS_CLIENT 0
135 #define MBEDTLS_SSL_IS_SERVER 1
136 
137 #define MBEDTLS_SSL_IS_NOT_FALLBACK 0
138 #define MBEDTLS_SSL_IS_FALLBACK 1
139 
140 #define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
141 #define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
142 
143 #define MBEDTLS_SSL_ETM_DISABLED 0
144 #define MBEDTLS_SSL_ETM_ENABLED 1
145 
146 #define MBEDTLS_SSL_COMPRESS_NULL 0
147 #define MBEDTLS_SSL_COMPRESS_DEFLATE 1
148 
149 #define MBEDTLS_SSL_VERIFY_NONE 0
150 #define MBEDTLS_SSL_VERIFY_OPTIONAL 1
151 #define MBEDTLS_SSL_VERIFY_REQUIRED 2
152 #define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
153 
154 #define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
155 #define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
156 
157 #define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
158 #define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
159 
160 #define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
161 #define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
162 
163 #define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
164 #define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
165 
166 #define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
167 #define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
168 #define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
169 
170 #define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
171 #define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
172 #define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
173 
174 #define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
175 #define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
176 
177 #define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
178 #define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
179 
180 #define MBEDTLS_SSL_ARC4_ENABLED 0
181 #define MBEDTLS_SSL_ARC4_DISABLED 1
182 
183 #define MBEDTLS_SSL_PRESET_DEFAULT 0
184 #define MBEDTLS_SSL_PRESET_SUITEB 2
185 
186 /*
187  * Default range for DTLS retransmission timer value, in milliseconds.
188  * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
189  */
190 #define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
191 #define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
192 
201 #if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
202 #define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400
203 #endif
204 
205 /*
206  * Maxium fragment length in bytes,
207  * determines the size of each of the two internal I/O buffers.
208  *
209  * Note: the RFC defines the default size of SSL / TLS messages. If you
210  * change the value here, other clients / servers may not be able to
211  * communicate with you anymore. Only change this value if you control
212  * both sides of the connection and have it reduced at both sides, or
213  * if you're using the Max Fragment Length extension and you know all your
214  * peers are using it too!
215  */
216 #if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
217 #define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
218 #endif
219 
220 /* \} name SECTION: Module settings */
221 
222 /*
223  * Length of the verify data for secure renegotiation
224  */
225 #if defined(MBEDTLS_SSL_PROTO_SSL3)
226 #define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
227 #else
228 #define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
229 #endif
230 
231 /*
232  * Signaling ciphersuite values (SCSV)
233  */
234 #define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF
235 #define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600
237 /*
238  * Supported Signature and Hash algorithms (For TLS 1.2)
239  * RFC 5246 section 7.4.1.4.1
240  */
241 #define MBEDTLS_SSL_HASH_NONE 0
242 #define MBEDTLS_SSL_HASH_MD5 1
243 #define MBEDTLS_SSL_HASH_SHA1 2
244 #define MBEDTLS_SSL_HASH_SHA224 3
245 #define MBEDTLS_SSL_HASH_SHA256 4
246 #define MBEDTLS_SSL_HASH_SHA384 5
247 #define MBEDTLS_SSL_HASH_SHA512 6
248 
249 #define MBEDTLS_SSL_SIG_ANON 0
250 #define MBEDTLS_SSL_SIG_RSA 1
251 #define MBEDTLS_SSL_SIG_ECDSA 3
252 
253 /*
254  * Client Certificate Types
255  * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
256  */
257 #define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
258 #define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
259 
260 /*
261  * Message, alert and handshake types
262  */
263 #define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
264 #define MBEDTLS_SSL_MSG_ALERT 21
265 #define MBEDTLS_SSL_MSG_HANDSHAKE 22
266 #define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
267 
268 #define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
269 #define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
270 
271 #define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
272 #define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
273 #define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
274 #define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
275 #define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
276 #define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
277 #define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
278 #define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
279 #define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
280 #define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
281 #define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
282 #define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
283 #define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
284 #define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
285 #define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
286 #define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
287 #define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
288 #define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
289 #define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
290 #define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
291 #define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
292 #define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
293 #define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
294 #define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
295 #define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
296 #define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
297 #define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
298 #define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
299 #define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
300 
301 #define MBEDTLS_SSL_HS_HELLO_REQUEST 0
302 #define MBEDTLS_SSL_HS_CLIENT_HELLO 1
303 #define MBEDTLS_SSL_HS_SERVER_HELLO 2
304 #define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
305 #define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
306 #define MBEDTLS_SSL_HS_CERTIFICATE 11
307 #define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
308 #define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
309 #define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
310 #define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
311 #define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
312 #define MBEDTLS_SSL_HS_FINISHED 20
313 
314 /*
315  * TLS extensions
316  */
317 #define MBEDTLS_TLS_EXT_SERVERNAME 0
318 #define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
319 
320 #define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
321 
322 #define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
323 
324 #define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
325 #define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
326 
327 #define MBEDTLS_TLS_EXT_SIG_ALG 13
328 
329 #define MBEDTLS_TLS_EXT_ALPN 16
330 
331 #define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
332 #define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
333 
334 #define MBEDTLS_TLS_EXT_SESSION_TICKET 35
335 
336 #define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
337 
338 #define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
339 
340 /*
341  * Size defines
342  */
343 #if !defined(MBEDTLS_PSK_MAX_LEN)
344 #define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
345 #endif
346 
347 /* Dummy type used only for its size */
349 {
350 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
351  unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
352 #endif
353 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
354  unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
355 #endif
356 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
357  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
358  defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
359  defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
360  unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
361 #endif
362 #if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
363  unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
364 #endif
365 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
366  unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
367  + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
368 #endif
369 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
370  unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
371 #endif
372 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
373  unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
374  + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
375 #endif
376 #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
377  unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
378 #endif
379 };
380 
381 #define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
382 
383 #ifdef __cplusplus
384 extern "C" {
385 #endif
386 
387 /*
388  * SSL state machine
389  */
390 typedef enum
391 {
411 }
413 
414 /* Defined below */
418 
419 /* Defined in ssl_internal.h */
422 #if defined(MBEDTLS_X509_CRT_PARSE_C)
424 #endif
425 #if defined(MBEDTLS_SSL_PROTO_DTLS)
427 #endif
428 
429 /*
430  * This structure is used for storing current session data.
431  */
433 {
434 #if defined(MBEDTLS_HAVE_TIME)
435  time_t start;
436 #endif
439  size_t id_len;
440  unsigned char id[32];
441  unsigned char master[48];
443 #if defined(MBEDTLS_X509_CRT_PARSE_C)
445 #endif /* MBEDTLS_X509_CRT_PARSE_C */
446  uint32_t verify_result;
448 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
449  unsigned char *ticket;
450  size_t ticket_len;
451  uint32_t ticket_lifetime;
452 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
453 
454 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
455  unsigned char mfl_code;
456 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
457 
458 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
460 #endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
461 
462 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
464 #endif
465 };
466 
471 {
472  /* Group items by size (largest first) to minimize padding overhead */
473 
474  /*
475  * Pointers
476  */
477 
478  const int *ciphersuite_list[4];
481  void (*f_dbg)(void *, int, const char *, int, const char *);
482  void *p_dbg;
485  int (*f_rng)(void *, unsigned char *, size_t);
486  void *p_rng;
489  int (*f_get_cache)(void *, mbedtls_ssl_session *);
491  int (*f_set_cache)(void *, const mbedtls_ssl_session *);
492  void *p_cache;
494 #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
495 
496  int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
497  void *p_sni;
498 #endif
499 
500 #if defined(MBEDTLS_X509_CRT_PARSE_C)
501 
502  int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
503  void *p_vrfy;
504 #endif
505 
506 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
507 
508  int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
509  void *p_psk;
510 #endif
511 
512 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
513 
514  int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
515  const unsigned char *, size_t );
517  int (*f_cookie_check)( void *, const unsigned char *, size_t,
518  const unsigned char *, size_t );
519  void *p_cookie;
520 #endif
521 
522 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
523 
524  int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
525  unsigned char *, const unsigned char *, size_t *, uint32_t * );
527  int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
528  void *p_ticket;
529 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
530 
531 #if defined(MBEDTLS_SSL_EXPORT_KEYS)
532 
533  int (*f_export_keys)( void *, const unsigned char *,
534  const unsigned char *, size_t, size_t, size_t );
536 #endif
537 
538 #if defined(MBEDTLS_X509_CRT_PARSE_C)
541  mbedtls_x509_crt *ca_chain;
543 #endif /* MBEDTLS_X509_CRT_PARSE_C */
544 
545 #if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
546  const int *sig_hashes;
547 #endif
548 
549 #if defined(MBEDTLS_ECP_C)
551 #endif
552 
553 #if defined(MBEDTLS_DHM_C)
556 #endif
557 
558 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
559  unsigned char *psk;
560  size_t psk_len;
561  unsigned char *psk_identity;
563 #endif
564 
565 #if defined(MBEDTLS_SSL_ALPN)
566  const char **alpn_list;
567 #endif
568 
569  /*
570  * Numerical settings (int then char)
571  */
572 
573  uint32_t read_timeout;
575 #if defined(MBEDTLS_SSL_PROTO_DTLS)
576  uint32_t hs_timeout_min;
578  uint32_t hs_timeout_max;
580 #endif
581 
582 #if defined(MBEDTLS_SSL_RENEGOTIATION)
584  unsigned char renego_period[8];
586 #endif
587 
588 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
589  unsigned int badmac_limit;
590 #endif
591 
592 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
593  unsigned int dhm_min_bitlen;
594 #endif
595 
596  unsigned char max_major_ver;
597  unsigned char max_minor_ver;
598  unsigned char min_major_ver;
599  unsigned char min_minor_ver;
601  /*
602  * Flags (bitfields)
603  */
604 
605  unsigned int endpoint : 1;
606  unsigned int transport : 1;
607  unsigned int authmode : 2;
608  /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
609  unsigned int allow_legacy_renegotiation : 2 ;
610 #if defined(MBEDTLS_ARC4_C)
611  unsigned int arc4_disabled : 1;
612 #endif
613 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
614  unsigned int mfl_code : 3;
615 #endif
616 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
617  unsigned int encrypt_then_mac : 1 ;
618 #endif
619 #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
620  unsigned int extended_ms : 1;
621 #endif
622 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
623  unsigned int anti_replay : 1;
624 #endif
625 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
626  unsigned int cbc_record_splitting : 1;
627 #endif
628 #if defined(MBEDTLS_SSL_RENEGOTIATION)
629  unsigned int disable_renegotiation : 1;
630 #endif
631 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
632  unsigned int trunc_hmac : 1;
633 #endif
634 #if defined(MBEDTLS_SSL_SESSION_TICKETS)
635  unsigned int session_tickets : 1;
636 #endif
637 #if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
638  unsigned int fallback : 1;
639 #endif
640 };
641 
642 
644 {
647  /*
648  * Miscellaneous
649  */
650  int state;
651 #if defined(MBEDTLS_SSL_RENEGOTIATION)
656 #endif
657 
658  int major_ver;
659  int minor_ver;
661 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
662  unsigned badmac_seen;
663 #endif
664 
665  /*
666  * Callbacks
667  */
668  int (*f_send)(void *, const unsigned char *, size_t);
669  int (*f_recv)(void *, unsigned char *, size_t);
670  int (*f_recv_timeout)(void *, unsigned char *, size_t, uint32_t);
671  void *p_bio;
673  /*
674  * Session layer
675  */
684  /*
685  * Record layer transformations
686  */
692  /*
693  * Timers
694  */
695  void *p_timer;
696  void (*f_set_timer)(void *, uint32_t, uint32_t);
697  int (*f_get_timer)(void *);
699  /*
700  * Record layer (incoming data)
701  */
702  unsigned char *in_buf;
703  unsigned char *in_ctr;
706  unsigned char *in_hdr;
707  unsigned char *in_len;
708  unsigned char *in_iv;
709  unsigned char *in_msg;
710  unsigned char *in_offt;
713  size_t in_msglen;
714  size_t in_left;
715 #if defined(MBEDTLS_SSL_PROTO_DTLS)
716  uint16_t in_epoch;
719 #endif
720 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
721  uint64_t in_window_top;
722  uint64_t in_window;
723 #endif
724 
725  size_t in_hslen;
727  int nb_zero;
730  /*
731  * Record layer (outgoing data)
732  */
733  unsigned char *out_buf;
734  unsigned char *out_ctr;
735  unsigned char *out_hdr;
736  unsigned char *out_len;
737  unsigned char *out_iv;
738  unsigned char *out_msg;
741  size_t out_msglen;
742  size_t out_left;
744 #if defined(MBEDTLS_ZLIB_SUPPORT)
745  unsigned char *compress_buf;
746 #endif
747 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
748  signed char split_done;
749 #endif
750 
751  /*
752  * PKI layer
753  */
756  /*
757  * User settings
758  */
759 #if defined(MBEDTLS_X509_CRT_PARSE_C)
760  char *hostname;
762 #endif
763 
764 #if defined(MBEDTLS_SSL_ALPN)
765  const char *alpn_chosen;
766 #endif
767 
768  /*
769  * Information for DTLS hello verify
770  */
771 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
772  unsigned char *cli_id;
773  size_t cli_id_len;
774 #endif
775 
776  /*
777  * Secure renegotiation
778  */
779  /* needed to know when to send extension on server */
782 #if defined(MBEDTLS_SSL_RENEGOTIATION)
784  char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN];
785  char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN];
786 #endif
787 };
788 
789 #if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
790 
791 #define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
792 #define MBEDTLS_SSL_CHANNEL_INBOUND 1
793 
795  const unsigned char *key_enc, const unsigned char *key_dec,
796  size_t keylen,
797  const unsigned char *iv_enc, const unsigned char *iv_dec,
798  size_t ivlen,
799  const unsigned char *mac_enc, const unsigned char *mac_dec,
800  size_t maclen);
801 extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
806 #endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
807 
814 const int *mbedtls_ssl_list_ciphersuites( void );
815 
824 const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
825 
834 int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
835 
844 
861  const mbedtls_ssl_config *conf );
862 
874 
881 void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
882 
897 void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
898 
924 void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
925 
926 #if defined(MBEDTLS_X509_CRT_PARSE_C)
927 
939  int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
940  void *p_vrfy );
941 #endif /* MBEDTLS_X509_CRT_PARSE_C */
942 
951  int (*f_rng)(void *, unsigned char *, size_t),
952  void *p_rng );
953 
969  void (*f_dbg)(void *, int, const char *, int, const char *),
970  void *p_dbg );
971 
996  void *p_bio,
997  int (*f_send)(void *, const unsigned char *, size_t),
998  int (*f_recv)(void *, unsigned char *, size_t),
999  int (*f_recv_timeout)(void *, unsigned char *, size_t, uint32_t) );
1000 
1017 void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
1018 
1035  void *p_timer,
1036  void (*f_set_timer)(void *, uint32_t int_ms, uint32_t fin_ms),
1037  int (*f_get_timer)(void *) );
1038 
1058 typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1059  const mbedtls_ssl_session *session,
1060  unsigned char *start,
1061  const unsigned char *end,
1062  size_t *tlen,
1063  uint32_t *lifetime );
1064 
1065 #if defined(MBEDTLS_SSL_EXPORT_KEYS)
1066 
1086 typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
1087  const unsigned char *ms,
1088  const unsigned char *kb,
1089  size_t maclen,
1090  size_t keylen,
1091  size_t ivlen );
1092 #endif /* MBEDTLS_SSL_EXPORT_KEYS */
1093 
1117 typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1118  mbedtls_ssl_session *session,
1119  unsigned char *buf,
1120  size_t len );
1121 
1122 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
1123 
1138  mbedtls_ssl_ticket_write_t *f_ticket_write,
1139  mbedtls_ssl_ticket_parse_t *f_ticket_parse,
1140  void *p_ticket );
1141 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
1142 
1143 #if defined(MBEDTLS_SSL_EXPORT_KEYS)
1144 
1155  mbedtls_ssl_export_keys_t *f_export_keys,
1156  void *p_export_keys );
1157 #endif /* MBEDTLS_SSL_EXPORT_KEYS */
1158 
1173 typedef int mbedtls_ssl_cookie_write_t( void *ctx,
1174  unsigned char **p, unsigned char *end,
1175  const unsigned char *info, size_t ilen );
1176 
1190 typedef int mbedtls_ssl_cookie_check_t( void *ctx,
1191  const unsigned char *cookie, size_t clen,
1192  const unsigned char *info, size_t ilen );
1193 
1194 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
1195 
1224  mbedtls_ssl_cookie_write_t *f_cookie_write,
1225  mbedtls_ssl_cookie_check_t *f_cookie_check,
1226  void *p_cookie );
1227 
1248  const unsigned char *info,
1249  size_t ilen );
1250 
1251 #endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
1252 
1253 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1254 
1269 void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
1270 #endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
1271 
1272 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1273 
1296 void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
1297 #endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
1298 
1299 #if defined(MBEDTLS_SSL_PROTO_DTLS)
1300 
1316 void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
1317 #endif /* MBEDTLS_SSL_PROTO_DTLS */
1318 
1319 #if defined(MBEDTLS_SSL_SRV_C)
1320 
1358  void *p_cache,
1359  int (*f_get_cache)(void *, mbedtls_ssl_session *),
1360  int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
1361 #endif /* MBEDTLS_SSL_SRV_C */
1362 
1363 #if defined(MBEDTLS_SSL_CLI_C)
1364 
1379 #endif /* MBEDTLS_SSL_CLI_C */
1380 
1397  const int *ciphersuites );
1398 
1419  const int *ciphersuites,
1420  int major, int minor );
1421 
1422 #if defined(MBEDTLS_X509_CRT_PARSE_C)
1423 
1434  const mbedtls_x509_crt_profile *profile );
1435 
1444  mbedtls_x509_crt *ca_chain,
1445  mbedtls_x509_crl *ca_crl );
1446 
1471  mbedtls_x509_crt *own_cert,
1472  mbedtls_pk_context *pk_key );
1473 #endif /* MBEDTLS_X509_CRT_PARSE_C */
1474 
1475 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1476 
1491  const unsigned char *psk, size_t psk_len,
1492  const unsigned char *psk_identity, size_t psk_identity_len );
1493 
1494 
1508  const unsigned char *psk, size_t psk_len );
1509 
1535  int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1536  size_t),
1537  void *p_psk );
1538 #endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
1539 
1540 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
1541 
1552 int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf, const char *dhm_P, const char *dhm_G );
1553 
1564 #endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
1565 
1566 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1567 
1576  unsigned int bitlen );
1577 #endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1578 
1579 #if defined(MBEDTLS_ECP_C)
1580 
1608  const mbedtls_ecp_group_id *curves );
1609 #endif /* MBEDTLS_ECP_C */
1610 
1611 #if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
1612 
1631  const int *hashes );
1632 #endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
1633 
1634 #if defined(MBEDTLS_X509_CRT_PARSE_C)
1635 
1645 int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
1646 #endif /* MBEDTLS_X509_CRT_PARSE_C */
1647 
1648 #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1649 
1662  mbedtls_x509_crt *own_cert,
1663  mbedtls_pk_context *pk_key );
1664 
1677  mbedtls_x509_crt *ca_chain,
1678  mbedtls_x509_crl *ca_crl );
1679 
1691  int authmode );
1692 
1717  int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
1718  size_t),
1719  void *p_sni );
1720 #endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1721 
1722 #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
1723 
1741  const unsigned char *pw,
1742  size_t pw_len );
1743 #endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
1744 
1745 #if defined(MBEDTLS_SSL_ALPN)
1746 
1755 int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
1756 
1766 const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
1767 #endif /* MBEDTLS_SSL_ALPN */
1768 
1785 void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
1786 
1805 void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
1806 
1807 #if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1808 
1827 void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
1828 #endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
1829 
1830 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1831 
1843 #endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
1844 
1845 #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1846 
1858 #endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
1859 
1860 #if defined(MBEDTLS_ARC4_C)
1861 
1874 void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
1875 #endif /* MBEDTLS_ARC4_C */
1876 
1877 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1878 
1893 int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
1894 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
1895 
1896 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
1897 
1905 void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
1906 #endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
1907 
1908 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
1909 
1921 #endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
1922 
1923 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
1924 
1934 void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
1935 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
1936 
1937 #if defined(MBEDTLS_SSL_RENEGOTIATION)
1938 
1955 void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
1956 #endif /* MBEDTLS_SSL_RENEGOTIATION */
1957 
1985 void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
1986 
1987 #if defined(MBEDTLS_SSL_RENEGOTIATION)
1988 
2025 void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
2026 
2045  const unsigned char period[8] );
2046 #endif /* MBEDTLS_SSL_RENEGOTIATION */
2047 
2056 
2068 uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
2069 
2077 const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
2078 
2086 const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
2087 
2099 
2100 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2101 
2118 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2119 
2120 #if defined(MBEDTLS_X509_CRT_PARSE_C)
2121 
2136 #endif /* MBEDTLS_X509_CRT_PARSE_C */
2137 
2138 #if defined(MBEDTLS_SSL_CLI_C)
2139 
2156 #endif /* MBEDTLS_SSL_CLI_C */
2157 
2180 
2201 
2202 #if defined(MBEDTLS_SSL_RENEGOTIATION)
2203 
2220 #endif /* MBEDTLS_SSL_RENEGOTIATION */
2221 
2256 int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
2257 
2293 int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
2294 
2312  unsigned char level,
2313  unsigned char message );
2328 
2335 
2347 
2365  int endpoint, int transport, int preset );
2366 
2373 
2380 
2388 
2389 #ifdef __cplusplus
2390 }
2391 #endif
2392 
2393 #endif /* ssl.h */
uint64_t in_window_top
Definition: ssl.h:721
time_t start
Definition: ssl.h:435
void * p_rng
Definition: ssl.h:486
const char ** alpn_list
Definition: ssl.h:566
unsigned char * in_ctr
Definition: ssl.h:703
mbedtls_x509_crt * peer_cert
Definition: ssl.h:444
unsigned char * out_msg
Definition: ssl.h:738
unsigned char * compress_buf
Definition: ssl.h:745
unsigned char * in_len
Definition: ssl.h:707
unsigned char * in_buf
Definition: ssl.h:702
Public key container.
Definition: pk.h:126
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.
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:1117
mbedtls_mpi dhm_P
Definition: ssl.h:554
unsigned char max_minor_ver
Definition: ssl.h:597
const char * mbedtls_ssl_get_ciphersuite_name(const int ciphersuite_id)
Return the name of the ciphersuite associated with the given ID.
void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Enable or disable Encrypt-then-MAC (Default: MBEDTLS_SSL_ETM_ENABLED)
unsigned char min_minor_ver
Definition: ssl.h:599
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:1173
unsigned char * in_hdr
Definition: ssl.h:706
size_t psk_identity_len
Definition: ssl.h:562
unsigned int dhm_min_bitlen
Definition: ssl.h:593
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:1190
void * p_sni
Definition: ssl.h:497
unsigned char * ticket
Definition: ssl.h:449
size_t ticket_len
Definition: ssl.h:450
void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Enable or disable Extended Master Secret negotiation.
unsigned char * out_iv
Definition: ssl.h:737
mbedtls_ssl_transform * transform_in
Definition: ssl.h:687
size_t in_left
Definition: ssl.h:714
unsigned int badmac_limit
Definition: ssl.h:589
void * p_psk
Definition: ssl.h:509
void mbedtls_ssl_conf_fallback(mbedtls_ssl_config *conf, char fallback)
Set the fallback flag (client-side only).
int(* mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl)
const mbedtls_ecp_group_id * curve_list
Definition: ssl.h:550
Elliptic curves over GF(p)
void mbedtls_ssl_conf_cbc_record_splitting(mbedtls_ssl_config *conf, char split)
Enable / Disable 1/n-1 record splitting (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED) ...
Certificate revocation list structure.
Definition: x509_crl.h:69
unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]
Definition: ssl.h:354
void * p_cache
Definition: ssl.h:492
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).
unsigned char _pms_rsa[48]
Definition: ssl.h:351
unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]
Definition: ssl.h:360
uint32_t ticket_lifetime
Definition: ssl.h:451
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...
mbedtls_ssl_session * session_in
Definition: ssl.h:676
unsigned badmac_seen
Definition: ssl.h:662
void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Enable or disable anti-replay protection for DTLS.
Configuration options (set of defines)
void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Set the maximum supported version sent from the client side and/or accepted at the server side (Defau...
uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Return the result of the certificate verification.
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).
mbedtls_x509_crl * ca_crl
Definition: ssl.h:542
mbedtls_ssl_session * session_out
Definition: ssl.h:677
const mbedtls_x509_crt * mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Return the peer certificate from the current connection.
int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl, unsigned char level, unsigned char message)
Send an alert message.
SSL Ciphersuites for mbed TLS.
mbedtls_ssl_transform * transform_out
Definition: ssl.h:688
unsigned char mfl_code
Definition: ssl.h:455
void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf, const unsigned char period[8])
Set record counter threshold for periodic renegotiation.
Multi-precision integer library.
int encrypt_then_mac
Definition: ssl.h:463
size_t in_hslen
Definition: ssl.h:725
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)
Set the Pre Shared Key (PSK) and the expected identity name.
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 (Default: MBEDTLS_SSL_MAX_CONTENT_LEN, usually 2^14 bytes) (Server: set maximum fragment length to emit, usually negotiated by the client during handshake (Client: set maximum fragment length to emit and negotiate with the server during handshake)
int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Try to write exactly &#39;len&#39; application data bytes.
void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Set the minimum accepted SSL/TLS protocol version (Default: TLS 1.0)
uint64_t in_window
Definition: ssl.h:722
int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Notify the peer that the connection is being closed.
void * p_cookie
Definition: ssl.h:519
void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Enable / Disable session tickets (client only).
void mbedtls_ssl_conf_ciphersuites_for_version(mbedtls_ssl_config *conf, const int *ciphersuites, int major, int minor)
Set the list of allowed ciphersuites and the preference order for a specific version of the protocol...
mbedtls_ssl_transform * transform
Definition: ssl.h:689
uint32_t hs_timeout_min
Definition: ssl.h:576
mbedtls_ssl_handshake_params * handshake
Definition: ssl.h:681
void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Free referenced items in an SSL context and clear memory.
void mbedtls_ssl_conf_export_keys_cb(mbedtls_ssl_config *conf, mbedtls_ssl_export_keys_t *f_export_keys, void *p_export_keys)
Configure key export callback.
void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Set the current endpoint type.
size_t out_left
Definition: ssl.h:742
void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Free referenced items in an SSL session including the peer certificate and clear memory.
void mbedtls_ssl_conf_arc4_support(mbedtls_ssl_config *conf, char arc4)
Disable or enable support for RC4 (Default: MBEDTLS_SSL_ARC4_DISABLED)
unsigned char * in_msg
Definition: ssl.h:709
void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf, const int *hashes)
Set the allowed hashes for signatures during the handshake.
unsigned char min_major_ver
Definition: ssl.h:598
const char * mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Get the name of the negotiated Application Layer Protocol.
int(* mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl)
unsigned char _pms_ecjpake[32]
Definition: ssl.h:377
int(* mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl, const unsigned char *key_enc, const unsigned char *key_dec, size_t keylen, const unsigned char *iv_enc, const unsigned char *iv_dec, size_t ivlen, const unsigned char *mac_enc, const unsigned char *mac_dec, size_t maclen)
void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf, unsigned int bitlen)
Set the minimum length for Diffie-Hellman parameters.
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.
mbedtls_ssl_key_cert * key_cert
Definition: ssl.h:540
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_transport(mbedtls_ssl_config *conf, int transport)
Set the transport type (TLS or DTLS).
mbedtls_ssl_session * session_negotiate
Definition: ssl.h:679
mbedtls_ssl_states
Definition: ssl.h:390
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).
const int * sig_hashes
Definition: ssl.h:546
const int * mbedtls_ssl_list_ciphersuites(void)
Returns the list of ciphersuites supported by the SSL/TLS module.
void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Enforce renegotiation requests.
int mbedtls_ssl_set_client_transport_id(mbedtls_ssl_context *ssl, const unsigned char *info, size_t ilen)
Set client&#39;s transport-level identification info.
size_t id_len
Definition: ssl.h:439
void * p_bio
Definition: ssl.h:671
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.
int renego_status
Definition: ssl.h:652
int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Set the supported Application Layer Protocols.
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.
unsigned char _pms_ecdhe_psk[4+MBEDTLS_ECP_MAX_BYTES+MBEDTLS_PSK_MAX_LEN]
Definition: ssl.h:374
void * p_vrfy
Definition: ssl.h:503
const mbedtls_x509_crt_profile * cert_profile
Definition: ssl.h:539
void * p_timer
Definition: ssl.h:695
Diffie-Hellman-Merkle key exchange.
X.509 certificate parsing and writing.
void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf, void *p_cache, int(*f_get_cache)(void *, mbedtls_ssl_session *), int(*f_set_cache)(void *, const mbedtls_ssl_session *))
Set the session cache callbacks (server-side only) If not set, no session resuming is done (except if...
#define MBEDTLS_PSK_MAX_LEN
Definition: ssl.h:344
void mbedtls_ssl_conf_truncated_hmac(mbedtls_ssl_config *conf, int truncate)
Activate negotiation of truncated HMAC (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED) ...
mbedtls_ssl_session * session
Definition: ssl.h:678
unsigned char * in_iv
Definition: ssl.h:708
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() ...
mbedtls_ssl_transform * transform_negotiate
Definition: ssl.h:690
const char * mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Return the name of the current ciphersuite.
mbedtls_ecp_group_id
Domain parameters (curve, subgroup and generator) identifiers.
Definition: ecp.h:53
unsigned char * out_ctr
Definition: ssl.h:734
int secure_renegotiation
Definition: ssl.h:780
DHM context structure.
Definition: dhm.h:149
const mbedtls_ssl_config * conf
Definition: ssl.h:645
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.
unsigned char * in_offt
Definition: ssl.h:710
unsigned char max_major_ver
Definition: ssl.h:596
unsigned char * psk
Definition: ssl.h:559
void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Initialize an SSL configuration context Just makes the context ready for mbedtls_ssl_config_defaults(...
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...
const char * alpn_chosen
Definition: ssl.h:765
Elliptic curve Diffie-Hellman.
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) ...
mbedtls_mpi dhm_G
Definition: ssl.h:555
int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Request resumption of session (client-side only) Session data is copied from presented session struct...
#define MBEDTLS_MPI_MAX_SIZE
Maximum number of bytes for usable MPIs.
Definition: bignum.h:76
void * p_export_keys
Definition: ssl.h:535
char * hostname
Definition: ssl.h:760
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_conf_dh_param(mbedtls_ssl_config *conf, const char *dhm_P, const char *dhm_G)
Set the Diffie-Hellman public P and G values, read as hexadecimal strings (server-side only) (Default...
void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl, void *p_timer, void(*f_set_timer)(void *, uint32_t int_ms, uint32_t fin_ms), int(*f_get_timer)(void *))
Set the timer callbacks (Mandatory for DTLS.)
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.
int mbedtls_ssl_setup(mbedtls_ssl_context *ssl, const mbedtls_ssl_config *conf)
Set up an SSL context for use.
size_t out_msglen
Definition: ssl.h:741
uint32_t read_timeout
Definition: ssl.h:573
void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Prevent or allow legacy renegotiation.
unsigned char _pms_rsa_psk[52+MBEDTLS_PSK_MAX_LEN]
Definition: ssl.h:370
int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Initiate an SSL renegotiation on the running connection.
int(* mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl)
int mbedtls_ssl_export_keys_t(void *p_expkey, const unsigned char *ms, const unsigned char *kb, size_t maclen, size_t keylen, size_t ivlen)
Callback type: Export key block and master secret.
Definition: ssl.h:1086
unsigned char * out_len
Definition: ssl.h:736
uint32_t hs_timeout_max
Definition: ssl.h:578
MPI structure.
Definition: bignum.h:144
X.509 certificate revocation list parsing.
SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Definition: ssl.h:470
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).
Container for an X.509 certificate.
Definition: x509_crt.h:52
unsigned char * cli_id
Definition: ssl.h:772
int renego_max_records
Definition: ssl.h:583
int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl, const unsigned char *pw, size_t pw_len)
Set the EC J-PAKE password for current handshake.
mbedtls_x509_crt * ca_chain
Definition: ssl.h:541
void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Set the timeout period for mbedtls_ssl_read() (Default: no timeout.)
size_t verify_data_len
Definition: ssl.h:783
void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Free an SSL configuration context.
unsigned char * psk_identity
Definition: ssl.h:561
int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Read at most &#39;len&#39; application data bytes.
size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Return the number of data bytes available to read.
unsigned char _pms_dhe_psk[4+MBEDTLS_MPI_MAX_SIZE+MBEDTLS_PSK_MAX_LEN]
Definition: ssl.h:367
size_t next_record_offset
Definition: ssl.h:717
unsigned char * out_buf
Definition: ssl.h:733
size_t psk_len
Definition: ssl.h:560
void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Initialize SSL session structure.
Security profile for certificate verification.
Definition: x509_crt.h:107
void * p_dbg
Definition: ssl.h:482
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:1058
size_t cli_id_len
Definition: ssl.h:773
void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf, uint32_t min, uint32_t max)
Set retransmit timeout values for the DTLS handshale.
int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf, int endpoint, int transport, int preset)
Load reasonnable default SSL configuration values.
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.
void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf, const mbedtls_ecp_group_id *curves)
Set the allowed curves in order of preference.
int renego_records_seen
Definition: ssl.h:653
unsigned char * out_hdr
Definition: ssl.h:735
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.
unsigned char _pms_psk[4+2 *MBEDTLS_PSK_MAX_LEN]
Definition: ssl.h:363
uint32_t verify_result
Definition: ssl.h:446
int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Perform the SSL handshake.
void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl, int authmode)
Set authmode for the current handshake.
signed char split_done
Definition: ssl.h:748
int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Perform a single step of the SSL handshake.
void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl, void *p_bio, int(*f_send)(void *, const unsigned char *, size_t), int(*f_recv)(void *, unsigned char *, size_t), int(*f_recv_timeout)(void *, unsigned char *, size_t, uint32_t))
Set the underlying BIO callbacks for write, read and read-with-timeout.
const char * mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Return the current SSL version (SSLv3/TLSv1/etc)
void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Set the certificate verification mode Default: NONE on server, REQUIRED on client.
int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Reset an already initialized SSL context for re-use while retaining application-set variables...
int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Set hostname for ServerName TLS extension (client-side only)
#define MBEDTLS_ECP_MAX_BYTES
Definition: ecp.h:179
int(* mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl)
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.
int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session)
Save session in order to resume it later (client-side only) Session data is copied to presented sessi...
int(* mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction)
void * p_ticket
Definition: ssl.h:528
void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf, const int *ciphersuites)
Set the list of allowed ciphersuites and the preference order.
size_t mbedtls_ssl_get_max_frag_len(const mbedtls_ssl_context *ssl)
Return the maximum fragment length (payload, in bytes).
#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN
Definition: ssl.h:226
size_t in_msglen
Definition: ssl.h:713
uint16_t in_epoch
Definition: ssl.h:716