27 #ifndef POLARSSL_SSL_H
28 #define POLARSSL_SSL_H
30 #if !defined(POLARSSL_CONFIG_FILE)
33 #include POLARSSL_CONFIG_FILE
41 #if defined(POLARSSL_MD5_C)
45 #if defined(POLARSSL_SHA1_C)
49 #if defined(POLARSSL_SHA256_C)
53 #if defined(POLARSSL_SHA512_C)
58 #if defined(POLARSSL_AES_C)
62 #if defined(POLARSSL_X509_CRT_PARSE_C)
67 #if defined(POLARSSL_DHM_C)
71 #if defined(POLARSSL_ECDH_C)
75 #if defined(POLARSSL_ZLIB_SUPPORT)
79 #if defined(POLARSSL_HAVE_TIME)
84 #if defined(POLARSSL_KEY_EXCHANGE_PSK_ENABLED) || \
85 defined(POLARSSL_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
86 defined(POLARSSL_KEY_EXCHANGE_DHE_PSK_ENABLED) || \
87 defined(POLARSSL_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
88 #define POLARSSL_KEY_EXCHANGE__SOME__PSK_ENABLED
91 #if defined(POLARSSL_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
92 defined(POLARSSL_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
93 defined(POLARSSL_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
94 #define POLARSSL_KEY_EXCHANGE__SOME__ECDHE_ENABLED
97 #if defined(_MSC_VER) && !defined(inline)
98 #define inline _inline
100 #if defined(__ARMCC_VERSION) && !defined(inline)
101 #define inline __inline
108 #define POLARSSL_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
109 #define POLARSSL_ERR_SSL_BAD_INPUT_DATA -0x7100
110 #define POLARSSL_ERR_SSL_INVALID_MAC -0x7180
111 #define POLARSSL_ERR_SSL_INVALID_RECORD -0x7200
112 #define POLARSSL_ERR_SSL_CONN_EOF -0x7280
113 #define POLARSSL_ERR_SSL_UNKNOWN_CIPHER -0x7300
114 #define POLARSSL_ERR_SSL_NO_CIPHER_CHOSEN -0x7380
115 #define POLARSSL_ERR_SSL_NO_RNG -0x7400
116 #define POLARSSL_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
117 #define POLARSSL_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500
118 #define POLARSSL_ERR_SSL_CERTIFICATE_REQUIRED -0x7580
119 #define POLARSSL_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
120 #define POLARSSL_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
121 #define POLARSSL_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
122 #define POLARSSL_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
123 #define POLARSSL_ERR_SSL_PEER_VERIFY_FAILED -0x7800
124 #define POLARSSL_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
125 #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900
126 #define POLARSSL_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980
127 #define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00
128 #define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80
129 #define POLARSSL_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00
130 #define POLARSSL_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80
131 #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00
132 #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80
133 #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00
134 #define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80
135 #define POLARSSL_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00
136 #define POLARSSL_ERR_SSL_BAD_HS_FINISHED -0x7E80
137 #define POLARSSL_ERR_SSL_MALLOC_FAILED -0x7F00
138 #define POLARSSL_ERR_SSL_HW_ACCEL_FAILED -0x7F80
139 #define POLARSSL_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
140 #define POLARSSL_ERR_SSL_COMPRESSION_FAILED -0x6F00
141 #define POLARSSL_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80
142 #define POLARSSL_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00
143 #define POLARSSL_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80
144 #define POLARSSL_ERR_SSL_PK_TYPE_MISMATCH -0x6D00
145 #define POLARSSL_ERR_SSL_UNKNOWN_IDENTITY -0x6C80
146 #define POLARSSL_ERR_SSL_INTERNAL_ERROR -0x6C00
147 #define POLARSSL_ERR_SSL_COUNTER_WRAPPING -0x6B80
152 #define SSL_MAJOR_VERSION_3 3
153 #define SSL_MINOR_VERSION_0 0
154 #define SSL_MINOR_VERSION_1 1
155 #define SSL_MINOR_VERSION_2 2
156 #define SSL_MINOR_VERSION_3 3
159 #define SSL_MIN_MAJOR_VERSION SSL_MAJOR_VERSION_3
161 #if defined(POLARSSL_SSL_PROTO_SSL3)
162 #define SSL_MIN_MINOR_VERSION SSL_MINOR_VERSION_0
164 #if defined(POLARSSL_SSL_PROTO_TLS1)
165 #define SSL_MIN_MINOR_VERSION SSL_MINOR_VERSION_1
167 #if defined(POLARSSL_SSL_PROTO_TLS1_1)
168 #define SSL_MIN_MINOR_VERSION SSL_MINOR_VERSION_2
170 #if defined(POLARSSL_SSL_PROTO_TLS1_2)
171 #define SSL_MIN_MINOR_VERSION SSL_MINOR_VERSION_3
178 #define SSL_MAX_MAJOR_VERSION SSL_MAJOR_VERSION_3
180 #if defined(POLARSSL_SSL_PROTO_TLS1_2)
181 #define SSL_MAX_MINOR_VERSION SSL_MINOR_VERSION_3
183 #if defined(POLARSSL_SSL_PROTO_TLS1_1)
184 #define SSL_MAX_MINOR_VERSION SSL_MINOR_VERSION_2
186 #if defined(POLARSSL_SSL_PROTO_TLS1)
187 #define SSL_MAX_MINOR_VERSION SSL_MINOR_VERSION_1
189 #if defined(POLARSSL_SSL_PROTO_SSL3)
190 #define SSL_MAX_MINOR_VERSION SSL_MINOR_VERSION_0
198 #define SSL_MAX_FRAG_LEN_NONE 0
199 #define SSL_MAX_FRAG_LEN_512 1
200 #define SSL_MAX_FRAG_LEN_1024 2
201 #define SSL_MAX_FRAG_LEN_2048 3
202 #define SSL_MAX_FRAG_LEN_4096 4
203 #define SSL_MAX_FRAG_LEN_INVALID 5
205 #define SSL_IS_CLIENT 0
206 #define SSL_IS_SERVER 1
207 #define SSL_COMPRESS_NULL 0
208 #define SSL_COMPRESS_DEFLATE 1
210 #define SSL_VERIFY_NONE 0
211 #define SSL_VERIFY_OPTIONAL 1
212 #define SSL_VERIFY_REQUIRED 2
214 #define SSL_INITIAL_HANDSHAKE 0
215 #define SSL_RENEGOTIATION 1
216 #define SSL_RENEGOTIATION_DONE 2
217 #define SSL_RENEGOTIATION_PENDING 3
219 #define SSL_LEGACY_RENEGOTIATION 0
220 #define SSL_SECURE_RENEGOTIATION 1
222 #define SSL_RENEGOTIATION_DISABLED 0
223 #define SSL_RENEGOTIATION_ENABLED 1
225 #define SSL_RENEGOTIATION_NOT_ENFORCED -1
226 #define SSL_RENEGO_MAX_RECORDS_DEFAULT 16
228 #define SSL_LEGACY_NO_RENEGOTIATION 0
229 #define SSL_LEGACY_ALLOW_RENEGOTIATION 1
230 #define SSL_LEGACY_BREAK_HANDSHAKE 2
232 #define SSL_TRUNC_HMAC_DISABLED 0
233 #define SSL_TRUNC_HMAC_ENABLED 1
234 #define SSL_TRUNCATED_HMAC_LEN 10
236 #define SSL_SESSION_TICKETS_DISABLED 0
237 #define SSL_SESSION_TICKETS_ENABLED 1
247 #if !defined(SSL_DEFAULT_TICKET_LIFETIME)
248 #define SSL_DEFAULT_TICKET_LIFETIME 86400
260 #if !defined(SSL_MAX_CONTENT_LEN)
261 #define SSL_MAX_CONTENT_LEN 16384
272 #if defined(POLARSSL_ZLIB_SUPPORT)
273 #define SSL_COMPRESSION_ADD 1024
275 #define SSL_COMPRESSION_ADD 0
278 #if defined(POLARSSL_RC4_C) || defined(POLARSSL_CIPHER_MODE_CBC)
280 #if defined(POLARSSL_SHA512_C)
281 #define SSL_MAC_ADD 48
282 #elif defined(POLARSSL_SHA256_C)
283 #define SSL_MAC_ADD 32
285 #define SSL_MAC_ADD 20
289 #define SSL_MAC_ADD 16
292 #if defined(POLARSSL_CIPHER_MODE_CBC)
293 #define SSL_PADDING_ADD 256
295 #define SSL_PADDING_ADD 0
298 #define SSL_BUFFER_LEN ( SSL_MAX_CONTENT_LEN \
299 + SSL_COMPRESSION_ADD \
308 #define SSL_EMPTY_RENEGOTIATION_INFO 0xFF
314 #define SSL_HASH_NONE 0
315 #define SSL_HASH_MD5 1
316 #define SSL_HASH_SHA1 2
317 #define SSL_HASH_SHA224 3
318 #define SSL_HASH_SHA256 4
319 #define SSL_HASH_SHA384 5
320 #define SSL_HASH_SHA512 6
322 #define SSL_SIG_ANON 0
323 #define SSL_SIG_RSA 1
324 #define SSL_SIG_ECDSA 3
330 #define SSL_CERT_TYPE_RSA_SIGN 1
331 #define SSL_CERT_TYPE_ECDSA_SIGN 64
336 #define SSL_MSG_CHANGE_CIPHER_SPEC 20
337 #define SSL_MSG_ALERT 21
338 #define SSL_MSG_HANDSHAKE 22
339 #define SSL_MSG_APPLICATION_DATA 23
341 #define SSL_ALERT_LEVEL_WARNING 1
342 #define SSL_ALERT_LEVEL_FATAL 2
344 #define SSL_ALERT_MSG_CLOSE_NOTIFY 0
345 #define SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10
346 #define SSL_ALERT_MSG_BAD_RECORD_MAC 20
347 #define SSL_ALERT_MSG_DECRYPTION_FAILED 21
348 #define SSL_ALERT_MSG_RECORD_OVERFLOW 22
349 #define SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30
350 #define SSL_ALERT_MSG_HANDSHAKE_FAILURE 40
351 #define SSL_ALERT_MSG_NO_CERT 41
352 #define SSL_ALERT_MSG_BAD_CERT 42
353 #define SSL_ALERT_MSG_UNSUPPORTED_CERT 43
354 #define SSL_ALERT_MSG_CERT_REVOKED 44
355 #define SSL_ALERT_MSG_CERT_EXPIRED 45
356 #define SSL_ALERT_MSG_CERT_UNKNOWN 46
357 #define SSL_ALERT_MSG_ILLEGAL_PARAMETER 47
358 #define SSL_ALERT_MSG_UNKNOWN_CA 48
359 #define SSL_ALERT_MSG_ACCESS_DENIED 49
360 #define SSL_ALERT_MSG_DECODE_ERROR 50
361 #define SSL_ALERT_MSG_DECRYPT_ERROR 51
362 #define SSL_ALERT_MSG_EXPORT_RESTRICTION 60
363 #define SSL_ALERT_MSG_PROTOCOL_VERSION 70
364 #define SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71
365 #define SSL_ALERT_MSG_INTERNAL_ERROR 80
366 #define SSL_ALERT_MSG_USER_CANCELED 90
367 #define SSL_ALERT_MSG_NO_RENEGOTIATION 100
368 #define SSL_ALERT_MSG_UNSUPPORTED_EXT 110
369 #define SSL_ALERT_MSG_UNRECOGNIZED_NAME 112
370 #define SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115
371 #define SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120
373 #define SSL_HS_HELLO_REQUEST 0
374 #define SSL_HS_CLIENT_HELLO 1
375 #define SSL_HS_SERVER_HELLO 2
376 #define SSL_HS_NEW_SESSION_TICKET 4
377 #define SSL_HS_CERTIFICATE 11
378 #define SSL_HS_SERVER_KEY_EXCHANGE 12
379 #define SSL_HS_CERTIFICATE_REQUEST 13
380 #define SSL_HS_SERVER_HELLO_DONE 14
381 #define SSL_HS_CERTIFICATE_VERIFY 15
382 #define SSL_HS_CLIENT_KEY_EXCHANGE 16
383 #define SSL_HS_FINISHED 20
388 #define TLS_EXT_SERVERNAME 0
389 #define TLS_EXT_SERVERNAME_HOSTNAME 0
391 #define TLS_EXT_MAX_FRAGMENT_LENGTH 1
393 #define TLS_EXT_TRUNCATED_HMAC 4
395 #define TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
396 #define TLS_EXT_SUPPORTED_POINT_FORMATS 11
398 #define TLS_EXT_SIG_ALG 13
400 #define TLS_EXT_ALPN 16
402 #define TLS_EXT_SESSION_TICKET 35
404 #define TLS_EXT_RENEGOTIATION_INFO 0xFF01
411 #define TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
416 #if !defined(POLARSSL_PSK_MAX_LEN)
417 #define POLARSSL_PSK_MAX_LEN 32
423 #if defined(POLARSSL_KEY_EXCHANGE_RSA_ENABLED)
426 #if defined(POLARSSL_KEY_EXCHANGE_DHE_RSA_ENABLED)
429 #if defined(POLARSSL_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
430 defined(POLARSSL_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
431 defined(POLARSSL_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
432 defined(POLARSSL_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
435 #if defined(POLARSSL_KEY_EXCHANGE_PSK_ENABLED)
438 #if defined(POLARSSL_KEY_EXCHANGE_DHE_PSK_ENABLED)
442 #if defined(POLARSSL_KEY_EXCHANGE_RSA_PSK_ENABLED)
445 #if defined(POLARSSL_KEY_EXCHANGE_DHE_PSK_ENABLED)
451 #define POLARSSL_PREMASTER_SIZE sizeof( union _ssl_premaster_secret )
462 const unsigned char *input,
unsigned char *output,
463 size_t output_max_len );
465 int (*f_rng)(
void *,
unsigned char *, size_t),
void *p_rng,
466 int mode,
md_type_t md_alg,
unsigned int hashlen,
467 const unsigned char *hash,
unsigned char *sig );
500 #if defined(POLARSSL_SSL_SESSION_TICKETS)
503 #if defined(POLARSSL_X509_CRT_PARSE_C)
512 #if defined(POLARSSL_HAVE_TIME)
518 unsigned char id[32];
521 #if defined(POLARSSL_X509_CRT_PARSE_C)
526 #if defined(POLARSSL_SSL_SESSION_TICKETS)
532 #if defined(POLARSSL_SSL_MAX_FRAGMENT_LENGTH)
536 #if defined(POLARSSL_SSL_TRUNCATED_HMAC)
561 #if defined(POLARSSL_SSL_PROTO_SSL3)
576 #if defined(POLARSSL_ZLIB_SUPPORT)
577 z_stream ctx_deflate;
578 z_stream ctx_inflate;
593 #if defined(POLARSSL_DHM_C)
596 #if defined(POLARSSL_ECDH_C)
599 #if defined(POLARSSL_ECDH_C) || defined(POLARSSL_ECDSA_C)
602 #if defined(POLARSSL_X509_CRT_PARSE_C)
610 #if defined(POLARSSL_SSL_SERVER_NAME_INDICATION)
618 #if defined(POLARSSL_SSL_PROTO_SSL3) || defined(POLARSSL_SSL_PROTO_TLS1) || \
619 defined(POLARSSL_SSL_PROTO_TLS1_1)
623 #if defined(POLARSSL_SSL_PROTO_TLS1_2)
624 #if defined(POLARSSL_SHA256_C)
627 #if defined(POLARSSL_SHA512_C)
635 int (*
tls_prf)(
const unsigned char *, size_t,
const char *,
636 const unsigned char *, size_t,
637 unsigned char *, size_t);
650 #if defined(POLARSSL_SSL_SESSION_TICKETS)
655 #if defined(POLARSSL_SSL_SESSION_TICKETS)
668 #if defined(POLARSSL_X509_CRT_PARSE_C)
701 int (*
f_rng)(
void *,
unsigned char *, size_t);
702 void (*
f_dbg)(
void *, int,
const char *);
703 int (*
f_recv)(
void *,
unsigned char *, size_t);
704 int (*
f_send)(
void *,
const unsigned char *, size_t);
716 #if defined(POLARSSL_SSL_SERVER_NAME_INDICATION)
721 #if defined(POLARSSL_X509_CRT_PARSE_C)
726 #if defined(POLARSSL_KEY_EXCHANGE__SOME__PSK_ENABLED)
779 #if defined(POLARSSL_ZLIB_SUPPORT)
780 unsigned char *compress_buf;
782 #if defined(POLARSSL_SSL_MAX_FRAGMENT_LENGTH)
789 #if defined(POLARSSL_X509_CRT_PARSE_C)
800 #if defined(POLARSSL_SSL_SESSION_TICKETS)
815 #if defined(POLARSSL_SSL_SET_CURVES)
818 #if defined(POLARSSL_SSL_TRUNCATED_HMAC)
821 #if defined(POLARSSL_SSL_SESSION_TICKETS)
826 #if defined(POLARSSL_DHM_C)
831 #if defined(POLARSSL_KEY_EXCHANGE__SOME__PSK_ENABLED)
841 #if defined(POLARSSL_SSL_SERVER_NAME_INDICATION)
849 #if defined(POLARSSL_SSL_ALPN)
867 #if defined(POLARSSL_SSL_HW_RECORD_ACCEL)
869 #define SSL_CHANNEL_OUTBOUND 0
870 #define SSL_CHANNEL_INBOUND 1
873 const unsigned char *key_enc,
const unsigned char *key_dec,
875 const unsigned char *iv_enc,
const unsigned char *iv_dec,
877 const unsigned char *mac_enc,
const unsigned char *mac_dec,
879 extern int (*ssl_hw_record_activate)(
ssl_context *ssl,
int direction);
880 extern int (*ssl_hw_record_reset)(
ssl_context *ssl);
881 extern int (*ssl_hw_record_write)(
ssl_context *ssl);
882 extern int (*ssl_hw_record_read)(
ssl_context *ssl);
883 extern int (*ssl_hw_record_finish)(
ssl_context *ssl);
973 #if defined(POLARSSL_X509_CRT_PARSE_C)
986 int (*f_vrfy)(
void *,
x509_crt *,
int,
int *),
998 int (*f_rng)(
void *,
unsigned char *,
size_t),
1009 void (*f_dbg)(
void *,
int,
const char *),
1022 int (*f_recv)(
void *,
unsigned char *,
size_t),
void *p_recv,
1023 int (*f_send)(
void *,
const unsigned char *,
size_t),
void *p_send );
1063 int (*f_get_cache)(
void *,
ssl_session *),
void *p_get_cache,
1064 int (*f_set_cache)(
void *,
const ssl_session *),
void *p_set_cache );
1110 const int *ciphersuites,
1111 int major,
int minor );
1113 #if defined(POLARSSL_X509_CRT_PARSE_C)
1123 x509_crl *ca_crl,
const char *peer_cn );
1146 #if defined(POLARSSL_RSA_C)
1199 #if defined(POLARSSL_KEY_EXCHANGE__SOME__PSK_ENABLED)
1213 const unsigned char *psk_identity,
size_t psk_identity_len );
1236 int (*f_psk)(
void *,
ssl_context *,
const unsigned char *,
1241 #if defined(POLARSSL_DHM_C)
1267 #if defined(POLARSSL_SSL_SET_CURVES)
1289 #if defined(POLARSSL_SSL_SERVER_NAME_INDICATION)
1322 int (*f_sni)(
void *,
ssl_context *,
const unsigned char *,
1327 #if defined(POLARSSL_SSL_ALPN)
1384 #if defined(POLARSSL_SSL_MAX_FRAGMENT_LENGTH)
1403 #if defined(POLARSSL_SSL_TRUNCATED_HMAC)
1418 #if defined(POLARSSL_SSL_SESSION_TICKETS)
1558 #if defined(POLARSSL_X509_CRT_PARSE_C)
1669 unsigned char level,
1670 unsigned char message );
1749 #if defined(POLARSSL_KEY_EXCHANGE__SOME__PSK_ENABLED)
1753 #if defined(POLARSSL_PK_C)
1760 #if defined(POLARSSL_SSL_SET_CURVES)
1764 #if defined(POLARSSL_X509_CRT_PARSE_C)
1788 int cert_endpoint );
1795 const unsigned char *A = (
const unsigned char *) a;
1796 const unsigned char *B = (
const unsigned char *) b;
1797 unsigned char diff = 0;
1799 for( i = 0; i < n; i++ )
1800 diff |= A[i] ^ B[i];