mbed TLS v2.1.0
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 /* For convenience below and in programs */
59 #if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
60  defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
61  defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED) || \
62  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
63 #define MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED
64 #endif
65 
66 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
67  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
68  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
69 #define MBEDTLS_KEY_EXCHANGE__SOME__ECDHE_ENABLED
70 #endif
71 
72 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
73  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
74  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
75 #define MBEDTLS_KEY_EXCHANGE__SOME__SIGNATURE_ENABLED
76 #endif
77 
78 /*
79  * SSL Error codes
80  */
81 #define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
82 #define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100
83 #define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180
84 #define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200
85 #define MBEDTLS_ERR_SSL_CONN_EOF -0x7280
86 #define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300
87 #define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380
88 #define MBEDTLS_ERR_SSL_NO_RNG -0x7400
89 #define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
90 #define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500
91 #define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580
92 #define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
93 #define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
94 #define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
95 #define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
96 #define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800
97 #define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
98 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900
99 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980
100 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00
101 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80
102 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00
103 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80
104 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00
105 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80
106 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00
107 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80
108 #define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00
109 #define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80
110 #define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00
111 #define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80
112 #define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
113 #define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00
114 #define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80
115 #define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00
116 #define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80
117 #define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00
118 #define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80
119 #define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00
120 #define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80
121 #define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00
122 #define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80
123 #define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00
124 #define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980
125 #define MBEDTLS_ERR_SSL_WANT_READ -0x6900
126 #define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880
127 #define MBEDTLS_ERR_SSL_TIMEOUT -0x6800
129 /*
130  * Various constants
131  */
132 #define MBEDTLS_SSL_MAJOR_VERSION_3 3
133 #define MBEDTLS_SSL_MINOR_VERSION_0 0
134 #define MBEDTLS_SSL_MINOR_VERSION_1 1
135 #define MBEDTLS_SSL_MINOR_VERSION_2 2
136 #define MBEDTLS_SSL_MINOR_VERSION_3 3
138 #define MBEDTLS_SSL_TRANSPORT_STREAM 0
139 #define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1
141 /* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
142  * NONE must be zero so that memset()ing structure to zero works */
143 #define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0
144 #define MBEDTLS_SSL_MAX_FRAG_LEN_512 1
145 #define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2
146 #define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3
147 #define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4
148 #define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5
150 #define MBEDTLS_SSL_IS_CLIENT 0
151 #define MBEDTLS_SSL_IS_SERVER 1
152 
153 #define MBEDTLS_SSL_IS_NOT_FALLBACK 0
154 #define MBEDTLS_SSL_IS_FALLBACK 1
155 
156 #define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
157 #define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
158 
159 #define MBEDTLS_SSL_ETM_DISABLED 0
160 #define MBEDTLS_SSL_ETM_ENABLED 1
161 
162 #define MBEDTLS_SSL_COMPRESS_NULL 0
163 #define MBEDTLS_SSL_COMPRESS_DEFLATE 1
164 
165 #define MBEDTLS_SSL_VERIFY_NONE 0
166 #define MBEDTLS_SSL_VERIFY_OPTIONAL 1
167 #define MBEDTLS_SSL_VERIFY_REQUIRED 2
168 #define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
169 
170 #define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
171 #define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
172 
173 #define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
174 #define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
175 
176 #define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
177 #define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
178 
179 #define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
180 #define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
181 
182 #define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
183 #define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
184 #define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
185 
186 #define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
187 #define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
188 #define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
189 
190 #define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
191 #define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
192 
193 #define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
194 #define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
195 
196 #define MBEDTLS_SSL_ARC4_ENABLED 0
197 #define MBEDTLS_SSL_ARC4_DISABLED 1
198 
199 #define MBEDTLS_SSL_PRESET_DEFAULT 0
200 #define MBEDTLS_SSL_PRESET_SUITEB 2
201 
202 /*
203  * Default range for DTLS retransmission timer value, in milliseconds.
204  * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
205  */
206 #define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
207 #define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
208 
217 #if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
218 #define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400
219 #endif
220 
221 /*
222  * Maxium fragment length in bytes,
223  * determines the size of each of the two internal I/O buffers.
224  *
225  * Note: the RFC defines the default size of SSL / TLS messages. If you
226  * change the value here, other clients / servers may not be able to
227  * communicate with you anymore. Only change this value if you control
228  * both sides of the connection and have it reduced at both sides, or
229  * if you're using the Max Fragment Length extension and you know all your
230  * peers are using it too!
231  */
232 #if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
233 #define MBEDTLS_SSL_MAX_CONTENT_LEN 16384
234 #endif
235 
236 /* \} name SECTION: Module settings */
237 
238 /*
239  * Length of the verify data for secure renegotiation
240  */
241 #if defined(MBEDTLS_SSL_PROTO_SSL3)
242 #define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
243 #else
244 #define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
245 #endif
246 
247 /*
248  * Signaling ciphersuite values (SCSV)
249  */
250 #define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF
251 #define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600
253 /*
254  * Supported Signature and Hash algorithms (For TLS 1.2)
255  * RFC 5246 section 7.4.1.4.1
256  */
257 #define MBEDTLS_SSL_HASH_NONE 0
258 #define MBEDTLS_SSL_HASH_MD5 1
259 #define MBEDTLS_SSL_HASH_SHA1 2
260 #define MBEDTLS_SSL_HASH_SHA224 3
261 #define MBEDTLS_SSL_HASH_SHA256 4
262 #define MBEDTLS_SSL_HASH_SHA384 5
263 #define MBEDTLS_SSL_HASH_SHA512 6
264 
265 #define MBEDTLS_SSL_SIG_ANON 0
266 #define MBEDTLS_SSL_SIG_RSA 1
267 #define MBEDTLS_SSL_SIG_ECDSA 3
268 
269 /*
270  * Client Certificate Types
271  * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
272  */
273 #define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
274 #define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
275 
276 /*
277  * Message, alert and handshake types
278  */
279 #define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
280 #define MBEDTLS_SSL_MSG_ALERT 21
281 #define MBEDTLS_SSL_MSG_HANDSHAKE 22
282 #define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
283 
284 #define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
285 #define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
286 
287 #define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
288 #define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
289 #define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
290 #define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
291 #define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
292 #define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
293 #define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
294 #define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
295 #define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
296 #define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
297 #define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
298 #define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
299 #define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
300 #define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
301 #define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
302 #define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
303 #define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
304 #define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
305 #define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
306 #define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
307 #define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
308 #define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
309 #define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
310 #define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
311 #define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
312 #define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
313 #define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
314 #define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
315 #define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
316 
317 #define MBEDTLS_SSL_HS_HELLO_REQUEST 0
318 #define MBEDTLS_SSL_HS_CLIENT_HELLO 1
319 #define MBEDTLS_SSL_HS_SERVER_HELLO 2
320 #define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
321 #define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
322 #define MBEDTLS_SSL_HS_CERTIFICATE 11
323 #define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
324 #define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
325 #define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
326 #define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
327 #define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
328 #define MBEDTLS_SSL_HS_FINISHED 20
329 
330 /*
331  * TLS extensions
332  */
333 #define MBEDTLS_TLS_EXT_SERVERNAME 0
334 #define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
335 
336 #define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
337 
338 #define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
339 
340 #define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
341 #define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
342 
343 #define MBEDTLS_TLS_EXT_SIG_ALG 13
344 
345 #define MBEDTLS_TLS_EXT_ALPN 16
346 
347 #define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
348 #define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
349 
350 #define MBEDTLS_TLS_EXT_SESSION_TICKET 35
351 
352 #define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
353 
354 /*
355  * Size defines
356  */
357 #if !defined(MBEDTLS_PSK_MAX_LEN)
358 #define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
359 #endif
360 
361 /* Dummy type used only for its size */
363 {
364 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
365  unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
366 #endif
367 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
368  unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
369 #endif
370 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
371  defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
372  defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
373  defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
374  unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
375 #endif
376 #if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
377  unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
378 #endif
379 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
380  unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
381  + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
382 #endif
383 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
384  unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
385 #endif
386 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
387  unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
388  + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
389 #endif
390 };
391 
392 #define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
393 
394 #ifdef __cplusplus
395 extern "C" {
396 #endif
397 
398 /*
399  * SSL state machine
400  */
401 typedef enum
402 {
422 }
424 
425 /* Defined below */
429 
430 /* Defined in ssl_internal.h */
433 #if defined(MBEDTLS_X509_CRT_PARSE_C)
435 #endif
436 #if defined(MBEDTLS_SSL_PROTO_DTLS)
438 #endif
439 
440 /*
441  * This structure is used for storing current session data.
442  */
444 {
445 #if defined(MBEDTLS_HAVE_TIME)
446  time_t start;
447 #endif
450  size_t id_len;
451  unsigned char id[32];
452  unsigned char master[48];
454 #if defined(MBEDTLS_X509_CRT_PARSE_C)
456 #endif /* MBEDTLS_X509_CRT_PARSE_C */
457  uint32_t verify_result;
459 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
460  unsigned char *ticket;
461  size_t ticket_len;
462  uint32_t ticket_lifetime;
463 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
464 
465 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
466  unsigned char mfl_code;
467 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
468 
469 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
471 #endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
472 
473 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
475 #endif
476 };
477 
482 {
483  /* Group items by size (largest first) to minimize padding overhead */
484 
485  /*
486  * Pointers
487  */
488 
489  const int *ciphersuite_list[4];
492  void (*f_dbg)(void *, int, const char *, int, const char *);
493  void *p_dbg;
496  int (*f_rng)(void *, unsigned char *, size_t);
497  void *p_rng;
500  int (*f_get_cache)(void *, mbedtls_ssl_session *);
502  int (*f_set_cache)(void *, const mbedtls_ssl_session *);
503  void *p_cache;
505 #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
506 
507  int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
508  void *p_sni;
509 #endif
510 
511 #if defined(MBEDTLS_X509_CRT_PARSE_C)
512 
513  int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
514  void *p_vrfy;
515 #endif
516 
517 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
518 
519  int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
520  void *p_psk;
521 #endif
522 
523 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
524 
525  int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
526  const unsigned char *, size_t );
528  int (*f_cookie_check)( void *, const unsigned char *, size_t,
529  const unsigned char *, size_t );
530  void *p_cookie;
531 #endif
532 
533 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
534 
535  int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
536  unsigned char *, const unsigned char *, size_t *, uint32_t * );
538  int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
539  void *p_ticket;
540 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
541 
542 #if defined(MBEDTLS_X509_CRT_PARSE_C)
545  mbedtls_x509_crt *ca_chain;
547 #endif /* MBEDTLS_X509_CRT_PARSE_C */
548 
549 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__SIGNATURE_ENABLED)
550  const int *sig_hashes;
551 #endif
552 
553 #if defined(MBEDTLS_ECP_C)
555 #endif
556 
557 #if defined(MBEDTLS_DHM_C)
560 #endif
561 
562 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
563  unsigned char *psk;
564  size_t psk_len;
565  unsigned char *psk_identity;
567 #endif
568 
569 #if defined(MBEDTLS_SSL_ALPN)
570  const char **alpn_list;
571 #endif
572 
573  /*
574  * Numerical settings (int then char)
575  */
576 
577  uint32_t read_timeout;
579 #if defined(MBEDTLS_SSL_PROTO_DTLS)
580  uint32_t hs_timeout_min;
582  uint32_t hs_timeout_max;
584 #endif
585 
586 #if defined(MBEDTLS_SSL_RENEGOTIATION)
588  unsigned char renego_period[8];
590 #endif
591 
592 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
593  unsigned int badmac_limit;
594 #endif
595 
596 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
597  unsigned int dhm_min_bitlen;
598 #endif
599 
600  unsigned char max_major_ver;
601  unsigned char max_minor_ver;
602  unsigned char min_major_ver;
603  unsigned char min_minor_ver;
605  /*
606  * Flags (bitfields)
607  */
608 
609  unsigned int endpoint : 1;
610  unsigned int transport : 1;
611  unsigned int authmode : 2;
612  /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
613  unsigned int allow_legacy_renegotiation : 2 ;
614 #if defined(MBEDTLS_ARC4_C)
615  unsigned int arc4_disabled : 1;
616 #endif
617 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
618  unsigned int mfl_code : 3;
619 #endif
620 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
621  unsigned int encrypt_then_mac : 1 ;
622 #endif
623 #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
624  unsigned int extended_ms : 1;
625 #endif
626 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
627  unsigned int anti_replay : 1;
628 #endif
629 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
630  unsigned int cbc_record_splitting : 1;
631 #endif
632 #if defined(MBEDTLS_SSL_RENEGOTIATION)
633  unsigned int disable_renegotiation : 1;
634 #endif
635 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
636  unsigned int trunc_hmac : 1;
637 #endif
638 #if defined(MBEDTLS_SSL_SESSION_TICKETS)
639  unsigned int session_tickets : 1;
640 #endif
641 #if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
642  unsigned int fallback : 1;
643 #endif
644 };
645 
646 
648 {
651  /*
652  * Miscellaneous
653  */
654  int state;
655 #if defined(MBEDTLS_SSL_RENEGOTIATION)
660 #endif
661 
662  int major_ver;
663  int minor_ver;
665 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
666  unsigned badmac_seen;
667 #endif
668 
669  /*
670  * Callbacks
671  */
672  int (*f_send)(void *, const unsigned char *, size_t);
673  int (*f_recv)(void *, unsigned char *, size_t);
674  int (*f_recv_timeout)(void *, unsigned char *, size_t, uint32_t);
675  void *p_bio;
677  /*
678  * Session layer
679  */
688  /*
689  * Record layer transformations
690  */
696  /*
697  * Timers
698  */
699  void *p_timer;
700  void (*f_set_timer)(void *, uint32_t, uint32_t);
701  int (*f_get_timer)(void *);
703  /*
704  * Record layer (incoming data)
705  */
706  unsigned char *in_buf;
707  unsigned char *in_ctr;
710  unsigned char *in_hdr;
711  unsigned char *in_len;
712  unsigned char *in_iv;
713  unsigned char *in_msg;
714  unsigned char *in_offt;
717  size_t in_msglen;
718  size_t in_left;
719 #if defined(MBEDTLS_SSL_PROTO_DTLS)
720  uint16_t in_epoch;
723 #endif
724 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
725  uint64_t in_window_top;
726  uint64_t in_window;
727 #endif
728 
729  size_t in_hslen;
731  int nb_zero;
734  /*
735  * Record layer (outgoing data)
736  */
737  unsigned char *out_buf;
738  unsigned char *out_ctr;
739  unsigned char *out_hdr;
740  unsigned char *out_len;
741  unsigned char *out_iv;
742  unsigned char *out_msg;
745  size_t out_msglen;
746  size_t out_left;
748 #if defined(MBEDTLS_ZLIB_SUPPORT)
749  unsigned char *compress_buf;
750 #endif
751 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
752  signed char split_done;
753 #endif
754 
755  /*
756  * PKI layer
757  */
760  /*
761  * User settings
762  */
763 #if defined(MBEDTLS_X509_CRT_PARSE_C)
764  char *hostname;
766 #endif
767 
768 #if defined(MBEDTLS_SSL_ALPN)
769  const char *alpn_chosen;
770 #endif
771 
772  /*
773  * Information for DTLS hello verify
774  */
775 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
776  unsigned char *cli_id;
777  size_t cli_id_len;
778 #endif
779 
780  /*
781  * Secure renegotiation
782  */
783  /* needed to know when to send extension on server */
786 #if defined(MBEDTLS_SSL_RENEGOTIATION)
790 #endif
791 };
792 
793 #if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
794 
795 #define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
796 #define MBEDTLS_SSL_CHANNEL_INBOUND 1
797 
798 extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl,
799  const unsigned char *key_enc, const unsigned char *key_dec,
800  size_t keylen,
801  const unsigned char *iv_enc, const unsigned char *iv_dec,
802  size_t ivlen,
803  const unsigned char *mac_enc, const unsigned char *mac_dec,
804  size_t maclen);
805 extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
806 extern int (*mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl);
807 extern int (*mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl);
808 extern int (*mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl);
809 extern int (*mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl);
810 #endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
811 
818 const int *mbedtls_ssl_list_ciphersuites( void );
819 
828 const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
829 
838 int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
839 
848 
865  const mbedtls_ssl_config *conf );
866 
878 
885 void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
886 
901 void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
902 
928 void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
929 
930 #if defined(MBEDTLS_X509_CRT_PARSE_C)
931 
943  int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
944  void *p_vrfy );
945 #endif /* MBEDTLS_X509_CRT_PARSE_C */
946 
955  int (*f_rng)(void *, unsigned char *, size_t),
956  void *p_rng );
957 
973  void (*f_dbg)(void *, int, const char *, int, const char *),
974  void *p_dbg );
975 
1000  void *p_bio,
1001  int (*f_send)(void *, const unsigned char *, size_t),
1002  int (*f_recv)(void *, unsigned char *, size_t),
1003  int (*f_recv_timeout)(void *, unsigned char *, size_t, uint32_t) );
1004 
1021 void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
1022 
1039  void *p_timer,
1040  void (*f_set_timer)(void *, uint32_t int_ms, uint32_t fin_ms),
1041  int (*f_get_timer)(void *) );
1042 
1062 typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1063  const mbedtls_ssl_session *session,
1064  unsigned char *start,
1065  const unsigned char *end,
1066  size_t *tlen,
1067  uint32_t *lifetime );
1068 
1092 typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1093  mbedtls_ssl_session *session,
1094  unsigned char *buf,
1095  size_t len );
1096 
1097 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
1098 
1113  mbedtls_ssl_ticket_write_t *f_ticket_write,
1114  mbedtls_ssl_ticket_parse_t *f_ticket_parse,
1115  void *p_ticket );
1116 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
1117 
1132 typedef int mbedtls_ssl_cookie_write_t( void *ctx,
1133  unsigned char **p, unsigned char *end,
1134  const unsigned char *info, size_t ilen );
1135 
1149 typedef int mbedtls_ssl_cookie_check_t( void *ctx,
1150  const unsigned char *cookie, size_t clen,
1151  const unsigned char *info, size_t ilen );
1152 
1153 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
1154 
1178  mbedtls_ssl_cookie_write_t *f_cookie_write,
1179  mbedtls_ssl_cookie_check_t *f_cookie_check,
1180  void *p_cookie );
1181 
1202  const unsigned char *info,
1203  size_t ilen );
1204 
1205 #endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
1206 
1207 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1208 
1223 void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
1224 #endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
1225 
1226 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1227 
1250 void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
1251 #endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
1252 
1253 #if defined(MBEDTLS_SSL_PROTO_DTLS)
1254 
1270 void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
1271 #endif /* MBEDTLS_SSL_PROTO_DTLS */
1272 
1273 #if defined(MBEDTLS_SSL_SRV_C)
1274 
1312  void *p_cache,
1313  int (*f_get_cache)(void *, mbedtls_ssl_session *),
1314  int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
1315 #endif /* MBEDTLS_SSL_SRV_C */
1316 
1317 #if defined(MBEDTLS_SSL_CLI_C)
1318 
1333 #endif /* MBEDTLS_SSL_CLI_C */
1334 
1351  const int *ciphersuites );
1352 
1373  const int *ciphersuites,
1374  int major, int minor );
1375 
1376 #if defined(MBEDTLS_X509_CRT_PARSE_C)
1377 
1384  mbedtls_x509_crt_profile *profile );
1385 
1394  mbedtls_x509_crt *ca_chain,
1395  mbedtls_x509_crl *ca_crl );
1396 
1421  mbedtls_x509_crt *own_cert,
1422  mbedtls_pk_context *pk_key );
1423 #endif /* MBEDTLS_X509_CRT_PARSE_C */
1424 
1425 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1426 
1441  const unsigned char *psk, size_t psk_len,
1442  const unsigned char *psk_identity, size_t psk_identity_len );
1443 
1444 
1458  const unsigned char *psk, size_t psk_len );
1459 
1485  int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1486  size_t),
1487  void *p_psk );
1488 #endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
1489 
1490 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
1491 
1502 int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf, const char *dhm_P, const char *dhm_G );
1503 
1514 #endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
1515 
1516 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1517 
1526  unsigned int bitlen );
1527 #endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1528 
1529 #if defined(MBEDTLS_ECP_C)
1530 
1560  const mbedtls_ecp_group_id *curves );
1561 #endif /* MBEDTLS_ECP_C */
1562 
1563 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__SIGNATURE_ENABLED)
1564 
1583  const int *hashes );
1584 #endif /* MBEDTLS_KEY_EXCHANGE__SOME__SIGNATURE_ENABLED */
1585 
1586 #if defined(MBEDTLS_X509_CRT_PARSE_C)
1587 
1597 int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
1598 #endif /* MBEDTLS_X509_CRT_PARSE_C */
1599 
1600 #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1601 
1614  mbedtls_x509_crt *own_cert,
1615  mbedtls_pk_context *pk_key );
1616 
1629  mbedtls_x509_crt *ca_chain,
1630  mbedtls_x509_crl *ca_crl );
1631 
1643  int authmode );
1644 
1669  int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
1670  size_t),
1671  void *p_sni );
1672 #endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1673 
1674 #if defined(MBEDTLS_SSL_ALPN)
1675 
1684 int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
1685 
1695 const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
1696 #endif /* MBEDTLS_SSL_ALPN */
1697 
1714 void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
1715 
1734 void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
1735 
1736 #if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1737 
1756 void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
1757 #endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
1758 
1759 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1760 
1772 #endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
1773 
1774 #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1775 
1787 #endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
1788 
1789 #if defined(MBEDTLS_ARC4_C)
1790 
1803 void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
1804 #endif /* MBEDTLS_ARC4_C */
1805 
1806 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1807 
1822 int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
1823 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
1824 
1825 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
1826 
1834 void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
1835 #endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
1836 
1837 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
1838 
1850 #endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
1851 
1852 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
1853 
1863 void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
1864 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
1865 
1866 #if defined(MBEDTLS_SSL_RENEGOTIATION)
1867 
1884 void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
1885 #endif /* MBEDTLS_SSL_RENEGOTIATION */
1886 
1914 void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
1915 
1916 #if defined(MBEDTLS_SSL_RENEGOTIATION)
1917 
1954 void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
1955 
1974  const unsigned char period[8] );
1975 #endif /* MBEDTLS_SSL_RENEGOTIATION */
1976 
1985 
1997 uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
1998 
2006 const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
2007 
2015 const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
2016 
2028 
2029 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2030 
2047 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2048 
2049 #if defined(MBEDTLS_X509_CRT_PARSE_C)
2050 
2065 #endif /* MBEDTLS_X509_CRT_PARSE_C */
2066 
2067 #if defined(MBEDTLS_SSL_CLI_C)
2068 
2085 #endif /* MBEDTLS_SSL_CLI_C */
2086 
2103 
2117 
2118 #if defined(MBEDTLS_SSL_RENEGOTIATION)
2119 
2130 #endif /* MBEDTLS_SSL_RENEGOTIATION */
2131 
2143 int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
2144 
2174 int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
2175 
2187  unsigned char level,
2188  unsigned char message );
2195 
2202 
2214 
2232  int endpoint, int transport, int preset );
2233 
2240 
2247 
2255 
2256 #ifdef __cplusplus
2257 }
2258 #endif
2259 
2260 #endif /* ssl.h */
uint64_t in_window_top
Definition: ssl.h:725
time_t start
Definition: ssl.h:446
void * p_rng
Definition: ssl.h:497
const char ** alpn_list
Definition: ssl.h:570
unsigned int transport
Definition: ssl.h:610
unsigned char * in_ctr
Definition: ssl.h:707
mbedtls_x509_crt * peer_cert
Definition: ssl.h:455
unsigned char * out_msg
Definition: ssl.h:742
unsigned char master[48]
Definition: ssl.h:452
unsigned int trunc_hmac
Definition: ssl.h:636
unsigned char * in_len
Definition: ssl.h:711
unsigned char * in_buf
Definition: ssl.h:706
unsigned int endpoint
Definition: ssl.h:609
Public key container.
Definition: pk.h:122
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:1092
mbedtls_mpi dhm_P
Definition: ssl.h:558
char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]
Definition: ssl.h:789
unsigned char max_minor_ver
Definition: ssl.h:601
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:603
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:1132
unsigned char * in_hdr
Definition: ssl.h:710
size_t psk_identity_len
Definition: ssl.h:566
unsigned int dhm_min_bitlen
Definition: ssl.h:597
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:1149
void * p_sni
Definition: ssl.h:508
unsigned char * ticket
Definition: ssl.h:460
int(* f_get_timer)(void *)
Definition: ssl.h:701
int(* f_recv_timeout)(void *, unsigned char *, size_t, uint32_t)
Definition: ssl.h:674
size_t ticket_len
Definition: ssl.h:461
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:741
mbedtls_ssl_transform * transform_in
Definition: ssl.h:691
size_t in_left
Definition: ssl.h:718
unsigned int authmode
Definition: ssl.h:611
unsigned int badmac_limit
Definition: ssl.h:593
void * p_psk
Definition: ssl.h:520
void mbedtls_ssl_conf_fallback(mbedtls_ssl_config *conf, char fallback)
Set the fallback flag (client-side only).
unsigned int anti_replay
Definition: ssl.h:627
unsigned int fallback
Definition: ssl.h:642
const mbedtls_ecp_group_id * curve_list
Definition: ssl.h:554
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) ...
int(* f_cookie_write)(void *, unsigned char **, unsigned char *, const unsigned char *, size_t)
Callback to create & write a cookie for ClientHello veirifcation.
Definition: ssl.h:525
Certificate revocation list structure.
Definition: x509_crl.h:69
int(* f_get_cache)(void *, mbedtls_ssl_session *)
Callback to retrieve a session from the cache.
Definition: ssl.h:500
unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]
Definition: ssl.h:368
void(* f_dbg)(void *, int, const char *, int, const char *)
Callback for printing debug output.
Definition: ssl.h:492
void * p_cache
Definition: ssl.h:503
int(* f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t)
Callback for setting cert according to SNI extension.
Definition: ssl.h:507
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:365
unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]
Definition: ssl.h:374
unsigned char renego_period[8]
Definition: ssl.h:588
uint32_t ticket_lifetime
Definition: ssl.h:462
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:680
unsigned badmac_seen
Definition: ssl.h:666
void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Enable or disable anti-replay protection for DTLS.
Compatibility names (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:546
mbedtls_ssl_session * session_out
Definition: ssl.h:681
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.
int(* f_ticket_write)(void *, const mbedtls_ssl_session *, unsigned char *, const unsigned char *, size_t *, uint32_t *)
Callback to create & write a session ticket.
Definition: ssl.h:535
mbedtls_ssl_transform * transform_out
Definition: ssl.h:692
unsigned char mfl_code
Definition: ssl.h:466
void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf, const unsigned char period[8])
Set record counter threshold for periodic renegotiation.
int(* f_recv)(void *, unsigned char *, size_t)
Definition: ssl.h:673
unsigned int mfl_code
Definition: ssl.h:618
int(* f_set_cache)(void *, const mbedtls_ssl_session *)
Callback to store a session into the cache.
Definition: ssl.h:502
Multi-precision integer library.
int encrypt_then_mac
Definition: ssl.h:474
size_t in_hslen
Definition: ssl.h:729
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 'len' 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)
int(* f_cookie_check)(void *, const unsigned char *, size_t, const unsigned char *, size_t)
Callback to verify validity of a ClientHello cookie.
Definition: ssl.h:528
uint64_t in_window
Definition: ssl.h:726
int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Notify the peer that the connection is being closed.
void * p_cookie
Definition: ssl.h:530
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:693
uint32_t hs_timeout_min
Definition: ssl.h:580
mbedtls_ssl_handshake_params * handshake
Definition: ssl.h:685
void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Free referenced items in an SSL context and clear memory.
void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf, mbedtls_x509_crt_profile *profile)
Set the X.509 security profile used for verification.
void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Set the current endpoint type.
size_t out_left
Definition: ssl.h:746
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:713
int(* f_send)(void *, const unsigned char *, size_t)
Definition: ssl.h:672
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:602
const char * mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Get the name of the negotiated Application Layer Protocol.
const int * ciphersuite_list[4]
Definition: ssl.h:489
int(* f_rng)(void *, unsigned char *, size_t)
Callback for getting (pseudo-)random numbers.
Definition: ssl.h:496
void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf, unsigned int bitlen)
Set the minimum length for Diffie-Hellman parameters.
void(* f_set_timer)(void *, uint32_t, uint32_t)
Definition: ssl.h:700
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:544
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:683
mbedtls_ssl_states
Definition: ssl.h:401
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:550
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's transport-level identification info.
size_t id_len
Definition: ssl.h:450
unsigned int encrypt_then_mac
Definition: ssl.h:621
void * p_bio
Definition: ssl.h:675
unsigned int cbc_record_splitting
Definition: ssl.h:630
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:656
int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Set the supported Application Layer Protocols.
unsigned char _pms_ecdhe_psk[4+MBEDTLS_ECP_MAX_BYTES+MBEDTLS_PSK_MAX_LEN]
Definition: ssl.h:388
void * p_vrfy
Definition: ssl.h:514
const mbedtls_x509_crt_profile * cert_profile
Definition: ssl.h:543
void * p_timer
Definition: ssl.h:699
Diffie-Hellman-Merkle key exchange.
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:358
unsigned int session_tickets
Definition: ssl.h:639
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:682
unsigned char * in_iv
Definition: ssl.h:712
char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]
Definition: ssl.h:788
void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Initialize an SSL context Just makes the context ready for mbetls_ssl_setup() or mbedtls_ssl_free() ...
mbedtls_ssl_transform * transform_negotiate
Definition: ssl.h:694
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:738
int secure_renegotiation
Definition: ssl.h:784
DHM context structure.
Definition: dhm.h:149
const mbedtls_ssl_config * conf
Definition: ssl.h:649
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.
int(* f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t)
Callback to retrieve PSK key from identity.
Definition: ssl.h:519
unsigned char * in_offt
Definition: ssl.h:714
unsigned int extended_ms
Definition: ssl.h:624
unsigned char max_major_ver
Definition: ssl.h:600
unsigned char * psk
Definition: ssl.h:563
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:769
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:559
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
unsigned int disable_renegotiation
Definition: ssl.h:633
char * hostname
Definition: ssl.h:764
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:745
uint32_t read_timeout
Definition: ssl.h:577
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:384
int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Initiate an SSL renegotiation on the running connection.
int(* f_ticket_parse)(void *, mbedtls_ssl_session *, unsigned char *, size_t)
Callback to parse a session ticket into a session structure.
Definition: ssl.h:538
unsigned char * out_len
Definition: ssl.h:740
int(* f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *)
Callback to customize X.509 certificate chain verification.
Definition: ssl.h:513
unsigned int arc4_disabled
Definition: ssl.h:615
uint32_t hs_timeout_max
Definition: ssl.h:582
MPI structure.
Definition: bignum.h:143
SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Definition: ssl.h:481
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:776
int renego_max_records
Definition: ssl.h:587
mbedtls_x509_crt * ca_chain
Definition: ssl.h:545
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:787
void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Free an SSL configuration context.
unsigned char * psk_identity
Definition: ssl.h:565
int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Read at most 'len' 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:381
size_t next_record_offset
Definition: ssl.h:721
unsigned char * out_buf
Definition: ssl.h:737
size_t psk_len
Definition: ssl.h:564
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:493
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:1062
size_t cli_id_len
Definition: ssl.h:777
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:657
unsigned char * out_hdr
Definition: ssl.h:739
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:377
uint32_t verify_result
Definition: ssl.h:457
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.
unsigned int allow_legacy_renegotiation
Definition: ssl.h:613
signed char split_done
Definition: ssl.h:752
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_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...
void * p_ticket
Definition: ssl.h:539
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:242
size_t in_msglen
Definition: ssl.h:717
uint16_t in_epoch
Definition: ssl.h:720