PolarSSL v1.2.8
ssl.h
Go to the documentation of this file.
1 
27 #ifndef POLARSSL_SSL_H
28 #define POLARSSL_SSL_H
29 
30 #include <time.h>
31 
32 #include "net.h"
33 #include "rsa.h"
34 #include "md5.h"
35 #include "sha1.h"
36 #include "sha2.h"
37 #include "sha4.h"
38 #include "x509.h"
39 #include "config.h"
40 
41 #if defined(POLARSSL_DHM_C)
42 #include "dhm.h"
43 #endif
44 
45 #if defined(POLARSSL_ZLIB_SUPPORT)
46 #include "zlib.h"
47 #endif
48 
49 #if defined(_MSC_VER) && !defined(inline)
50 #define inline _inline
51 #else
52 #if defined(__ARMCC_VERSION) && !defined(inline)
53 #define inline __inline
54 #endif /* __ARMCC_VERSION */
55 #endif /*_MSC_VER */
56 
57 /*
58  * SSL Error codes
59  */
60 #define POLARSSL_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
61 #define POLARSSL_ERR_SSL_BAD_INPUT_DATA -0x7100
62 #define POLARSSL_ERR_SSL_INVALID_MAC -0x7180
63 #define POLARSSL_ERR_SSL_INVALID_RECORD -0x7200
64 #define POLARSSL_ERR_SSL_CONN_EOF -0x7280
65 #define POLARSSL_ERR_SSL_UNKNOWN_CIPHER -0x7300
66 #define POLARSSL_ERR_SSL_NO_CIPHER_CHOSEN -0x7380
67 #define POLARSSL_ERR_SSL_NO_SESSION_FOUND -0x7400
68 #define POLARSSL_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
69 #define POLARSSL_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500
70 #define POLARSSL_ERR_SSL_CERTIFICATE_REQUIRED -0x7580
71 #define POLARSSL_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
72 #define POLARSSL_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
73 #define POLARSSL_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
74 #define POLARSSL_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
75 #define POLARSSL_ERR_SSL_PEER_VERIFY_FAILED -0x7800
76 #define POLARSSL_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
77 #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900
78 #define POLARSSL_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980
79 #define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00
80 #define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80
81 #define POLARSSL_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00
82 #define POLARSSL_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80
83 #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00
84 #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_DHM_RP -0x7C80
85 #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_DHM_CS -0x7D00
86 #define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80
87 #define POLARSSL_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00
88 #define POLARSSL_ERR_SSL_BAD_HS_FINISHED -0x7E80
89 #define POLARSSL_ERR_SSL_MALLOC_FAILED -0x7F00
90 #define POLARSSL_ERR_SSL_HW_ACCEL_FAILED -0x7F80
91 #define POLARSSL_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
92 #define POLARSSL_ERR_SSL_COMPRESSION_FAILED -0x6F00
93 #define POLARSSL_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80
95 /*
96  * Various constants
97  */
98 #define SSL_MAJOR_VERSION_3 3
99 #define SSL_MINOR_VERSION_0 0
100 #define SSL_MINOR_VERSION_1 1
101 #define SSL_MINOR_VERSION_2 2
102 #define SSL_MINOR_VERSION_3 3
104 #define SSL_IS_CLIENT 0
105 #define SSL_IS_SERVER 1
106 #define SSL_COMPRESS_NULL 0
107 #define SSL_COMPRESS_DEFLATE 1
108 
109 #define SSL_VERIFY_NONE 0
110 #define SSL_VERIFY_OPTIONAL 1
111 #define SSL_VERIFY_REQUIRED 2
112 
113 #define SSL_INITIAL_HANDSHAKE 0
114 #define SSL_RENEGOTIATION 1
115 
116 #define SSL_LEGACY_RENEGOTIATION 0
117 #define SSL_SECURE_RENEGOTIATION 1
118 
119 #define SSL_RENEGOTIATION_DISABLED 0
120 #define SSL_RENEGOTIATION_ENABLED 1
121 
122 #define SSL_LEGACY_NO_RENEGOTIATION 0
123 #define SSL_LEGACY_ALLOW_RENEGOTIATION 1
124 #define SSL_LEGACY_BREAK_HANDSHAKE 2
125 
126 /*
127  * Size of the input / output buffer.
128  * Note: the RFC defines the default size of SSL / TLS messages. If you
129  * change the value here, other clients / servers may not be able to
130  * communicate with you anymore. Only change this value if you control
131  * both sides of the connection and have it reduced at both sides!
132  */
133 #if !defined(POLARSSL_CONFIG_OPTIONS)
134 #define SSL_MAX_CONTENT_LEN 16384
135 #endif /* !POLARSSL_CONFIG_OPTIONS */
136 
137 /*
138  * Allow an extra 512 bytes for the record header
139  * and encryption overhead (counter + MAC + padding)
140  * and allow for a maximum of 1024 of compression expansion if
141  * enabled.
142  */
143 #if defined(POLARSSL_ZLIB_SUPPORT)
144 #define SSL_COMPRESSION_ADD 1024
145 #else
146 #define SSL_COMPRESSION_ADD 0
147 #endif
148 
149 #define SSL_BUFFER_LEN (SSL_MAX_CONTENT_LEN + SSL_COMPRESSION_ADD + 512)
150 
151 /*
152  * Supported ciphersuites (Official IANA names)
153  */
154 #define TLS_RSA_WITH_NULL_MD5 0x01
155 #define TLS_RSA_WITH_NULL_SHA 0x02
156 #define TLS_RSA_WITH_NULL_SHA256 0x3B
157 #define TLS_RSA_WITH_DES_CBC_SHA 0x09
158 #define TLS_DHE_RSA_WITH_DES_CBC_SHA 0x15
160 #define TLS_RSA_WITH_RC4_128_MD5 0x04
161 #define TLS_RSA_WITH_RC4_128_SHA 0x05
162 
163 #define TLS_RSA_WITH_3DES_EDE_CBC_SHA 0x0A
164 #define TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA 0x16
165 
166 #define TLS_RSA_WITH_AES_128_CBC_SHA 0x2F
167 #define TLS_DHE_RSA_WITH_AES_128_CBC_SHA 0x33
168 #define TLS_RSA_WITH_AES_256_CBC_SHA 0x35
169 #define TLS_DHE_RSA_WITH_AES_256_CBC_SHA 0x39
170 #define TLS_RSA_WITH_AES_128_CBC_SHA256 0x3C
171 #define TLS_RSA_WITH_AES_256_CBC_SHA256 0x3D
172 #define TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 0x67
173 #define TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 0x6B
175 #define TLS_RSA_WITH_CAMELLIA_128_CBC_SHA 0x41
176 #define TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA 0x45
177 #define TLS_RSA_WITH_CAMELLIA_256_CBC_SHA 0x84
178 #define TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA 0x88
179 #define TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xBA
180 #define TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 0xBE
181 #define TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 0xC0
182 #define TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256 0xC4
184 #define TLS_RSA_WITH_AES_128_GCM_SHA256 0x9C
185 #define TLS_RSA_WITH_AES_256_GCM_SHA384 0x9D
186 #define TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 0x9E
187 #define TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 0x9F
188 
189 #define SSL_EMPTY_RENEGOTIATION_INFO 0xFF
191 /*
192  * Supported Signature and Hash algorithms (For TLS 1.2)
193  */
194 #define SSL_HASH_NONE 0
195 #define SSL_HASH_MD5 1
196 #define SSL_HASH_SHA1 2
197 #define SSL_HASH_SHA224 3
198 #define SSL_HASH_SHA256 4
199 #define SSL_HASH_SHA384 5
200 #define SSL_HASH_SHA512 6
201 
202 #define SSL_SIG_RSA 1
203 
204 /*
205  * Client Certificate Types
206  */
207 #define SSL_CERT_TYPE_RSA_SIGN 1
208 
209 /*
210  * Message, alert and handshake types
211  */
212 #define SSL_MSG_CHANGE_CIPHER_SPEC 20
213 #define SSL_MSG_ALERT 21
214 #define SSL_MSG_HANDSHAKE 22
215 #define SSL_MSG_APPLICATION_DATA 23
216 
217 #define SSL_ALERT_LEVEL_WARNING 1
218 #define SSL_ALERT_LEVEL_FATAL 2
219 
220 #define SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
221 #define SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
222 #define SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
223 #define SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
224 #define SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
225 #define SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
226 #define SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
227 #define SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
228 #define SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
229 #define SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
230 #define SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
231 #define SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
232 #define SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
233 #define SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
234 #define SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
235 #define SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
236 #define SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
237 #define SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
238 #define SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
239 #define SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
240 #define SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
241 #define SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
242 #define SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
243 #define SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
244 #define SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
245 #define SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
246 
247 #define SSL_HS_HELLO_REQUEST 0
248 #define SSL_HS_CLIENT_HELLO 1
249 #define SSL_HS_SERVER_HELLO 2
250 #define SSL_HS_CERTIFICATE 11
251 #define SSL_HS_SERVER_KEY_EXCHANGE 12
252 #define SSL_HS_CERTIFICATE_REQUEST 13
253 #define SSL_HS_SERVER_HELLO_DONE 14
254 #define SSL_HS_CERTIFICATE_VERIFY 15
255 #define SSL_HS_CLIENT_KEY_EXCHANGE 16
256 #define SSL_HS_FINISHED 20
257 
258 /*
259  * TLS extensions
260  */
261 #define TLS_EXT_SERVERNAME 0
262 #define TLS_EXT_SERVERNAME_HOSTNAME 0
263 
264 #define TLS_EXT_SIG_ALG 13
265 
266 #define TLS_EXT_RENEGOTIATION_INFO 0xFF01
267 
268 
269 /*
270  * Generic function pointers for allowing external RSA private key
271  * implementations.
272  */
273 typedef int (*rsa_decrypt_func)( void *ctx, int mode, size_t *olen,
274  const unsigned char *input, unsigned char *output,
275  size_t output_max_len );
276 typedef int (*rsa_sign_func)( void *ctx,
277  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
278  int mode, int hash_id, unsigned int hashlen,
279  const unsigned char *hash, unsigned char *sig );
280 typedef size_t (*rsa_key_len_func)( void *ctx );
281 
282 /*
283  * SSL state machine
284  */
285 typedef enum
286 {
304 }
305 ssl_states;
306 
307 typedef struct _ssl_session ssl_session;
308 typedef struct _ssl_context ssl_context;
311 
312 /*
313  * This structure is used for storing current session data.
314  */
316 {
317  time_t start;
320  size_t length;
321  unsigned char id[32];
322  unsigned char master[48];
324 };
325 
326 /*
327  * This structure contains a full set of runtime transform parameters
328  * either in negotiation or active.
329  */
331 {
332  /*
333  * Session specific crypto layer
334  */
335  unsigned int keylen;
336  size_t minlen;
337  size_t ivlen;
338  size_t fixed_ivlen;
339  size_t maclen;
341  unsigned char iv_enc[16];
342  unsigned char iv_dec[16];
344  unsigned char mac_enc[32];
345  unsigned char mac_dec[32];
347  uint32_t ctx_enc[136];
348  uint32_t ctx_dec[136];
350  /*
351  * Session specific compression layer
352  */
353 #if defined(POLARSSL_ZLIB_SUPPORT)
354  z_stream ctx_deflate;
355  z_stream ctx_inflate;
356 #endif
357 };
358 
359 /*
360  * This structure contains the parameters only needed during handshake.
361  */
363 {
364  /*
365  * Handshake specific crypto variables
366  */
367  int sig_alg;
368  int cert_type;
370 #if defined(POLARSSL_DHM_C)
372 #endif
373 
374  /*
375  * Checksum contexts
376  */
381 
382  void (*update_checksum)(ssl_context *, unsigned char *, size_t);
383  void (*calc_verify)(ssl_context *, unsigned char *);
384  void (*calc_finished)(ssl_context *, unsigned char *, int);
385  int (*tls_prf)(unsigned char *, size_t, char *,
386  unsigned char *, size_t,
387  unsigned char *, size_t);
388 
389  size_t pmslen;
391  unsigned char randbytes[64];
392  unsigned char premaster[POLARSSL_MPI_MAX_SIZE];
395  int resume;
396 };
397 
399 {
400  /*
401  * Miscellaneous
402  */
403  int state;
406  int major_ver;
407  int minor_ver;
414  /*
415  * Callbacks (RNG, debug, I/O, verification)
416  */
417  int (*f_rng)(void *, unsigned char *, size_t);
418  void (*f_dbg)(void *, int, const char *);
419  int (*f_recv)(void *, unsigned char *, size_t);
420  int (*f_send)(void *, const unsigned char *, size_t);
421  int (*f_vrfy)(void *, x509_cert *, int, int *);
422  int (*f_get_cache)(void *, ssl_session *);
423  int (*f_set_cache)(void *, const ssl_session *);
424  int (*f_sni)(void *, ssl_context *, const unsigned char *, size_t);
425 
426  void *p_rng;
427  void *p_dbg;
428  void *p_recv;
429  void *p_send;
430  void *p_vrfy;
431  void *p_get_cache;
432  void *p_set_cache;
433  void *p_sni;
434  void *p_hw_data;
436  /*
437  * Session layer
438  */
447  /*
448  * Record layer transformations
449  */
455  /*
456  * Record layer (incoming data)
457  */
458  unsigned char *in_ctr;
459  unsigned char *in_hdr;
460  unsigned char *in_msg;
461  unsigned char *in_offt;
464  size_t in_msglen;
465  size_t in_left;
467  size_t in_hslen;
468  int nb_zero;
470  /*
471  * Record layer (outgoing data)
472  */
473  unsigned char *out_ctr;
474  unsigned char *out_hdr;
475  unsigned char *out_msg;
478  size_t out_msglen;
479  size_t out_left;
481  /*
482  * PKI layer
483  */
484  void *rsa_key;
492  const char *peer_cn;
494  /*
495  * User settings
496  */
497  int endpoint;
498  int authmode;
503  const int **ciphersuites;
505 #if defined(POLARSSL_DHM_C)
508 #endif
509 
510  /*
511  * TLS extensions
512  */
513  unsigned char *hostname;
514  size_t hostname_len;
515 
516  /*
517  * Secure renegotiation
518  */
522  char own_verify_data[36];
523  char peer_verify_data[36];
524 };
525 
526 #ifdef __cplusplus
527 extern "C" {
528 #endif
529 
530 extern const int ssl_default_ciphersuites[];
531 
532 #if defined(POLARSSL_SSL_HW_RECORD_ACCEL)
533 extern int (*ssl_hw_record_init)(ssl_context *ssl,
534  const unsigned char *key_enc, const unsigned char *key_dec,
535  const unsigned char *iv_enc, const unsigned char *iv_dec,
536  const unsigned char *mac_enc, const unsigned char *mac_dec);
537 extern int (*ssl_hw_record_reset)(ssl_context *ssl);
538 extern int (*ssl_hw_record_write)(ssl_context *ssl);
539 extern int (*ssl_hw_record_read)(ssl_context *ssl);
540 extern int (*ssl_hw_record_finish)(ssl_context *ssl);
541 #endif
542 
549 static inline const int *ssl_list_ciphersuites( void )
550 {
551  return ssl_default_ciphersuites;
552 }
553 
562 const char *ssl_get_ciphersuite_name( const int ciphersuite_id );
563 
572 int ssl_get_ciphersuite_id( const char *ciphersuite_name );
573 
582 int ssl_init( ssl_context *ssl );
583 
594 int ssl_session_reset( ssl_context *ssl );
595 
602 void ssl_set_endpoint( ssl_context *ssl, int endpoint );
603 
621 void ssl_set_authmode( ssl_context *ssl, int authmode );
622 
634 void ssl_set_verify( ssl_context *ssl,
635  int (*f_vrfy)(void *, x509_cert *, int, int *),
636  void *p_vrfy );
637 
645 void ssl_set_rng( ssl_context *ssl,
646  int (*f_rng)(void *, unsigned char *, size_t),
647  void *p_rng );
648 
656 void ssl_set_dbg( ssl_context *ssl,
657  void (*f_dbg)(void *, int, const char *),
658  void *p_dbg );
659 
669 void ssl_set_bio( ssl_context *ssl,
670  int (*f_recv)(void *, unsigned char *, size_t), void *p_recv,
671  int (*f_send)(void *, const unsigned char *, size_t), void *p_send );
672 
711  int (*f_get_cache)(void *, ssl_session *), void *p_get_cache,
712  int (*f_set_cache)(void *, const ssl_session *), void *p_set_cache );
713 
726 void ssl_set_session( ssl_context *ssl, const ssl_session *session );
727 
736 void ssl_set_ciphersuites( ssl_context *ssl, const int *ciphersuites );
737 
753  const int *ciphersuites,
754  int major, int minor );
755 
764 void ssl_set_ca_chain( ssl_context *ssl, x509_cert *ca_chain,
765  x509_crl *ca_crl, const char *peer_cn );
766 
778 void ssl_set_own_cert( ssl_context *ssl, x509_cert *own_cert,
779  rsa_context *rsa_key );
780 
800 void ssl_set_own_cert_alt( ssl_context *ssl, x509_cert *own_cert,
801  void *rsa_key,
802  rsa_decrypt_func rsa_decrypt,
803  rsa_sign_func rsa_sign,
804  rsa_key_len_func rsa_key_len );
805 
806 #if defined(POLARSSL_DHM_C)
807 
818 int ssl_set_dh_param( ssl_context *ssl, const char *dhm_P, const char *dhm_G );
819 
829 int ssl_set_dh_param_ctx( ssl_context *ssl, dhm_context *dhm_ctx );
830 #endif
831 
842 int ssl_set_hostname( ssl_context *ssl, const char *hostname );
843 
863 void ssl_set_sni( ssl_context *ssl,
864  int (*f_sni)(void *, ssl_context *, const unsigned char *,
865  size_t),
866  void *p_sni );
867 
877 void ssl_set_max_version( ssl_context *ssl, int major, int minor );
878 
879 
890 void ssl_set_min_version( ssl_context *ssl, int major, int minor );
891 
905 void ssl_set_renegotiation( ssl_context *ssl, int renegotiation );
906 
934 void ssl_legacy_renegotiation( ssl_context *ssl, int allow_legacy );
935 
943 size_t ssl_get_bytes_avail( const ssl_context *ssl );
944 
956 int ssl_get_verify_result( const ssl_context *ssl );
957 
965 const char *ssl_get_ciphersuite( const ssl_context *ssl );
966 
974 const char *ssl_get_version( const ssl_context *ssl );
975 
990 const x509_cert *ssl_get_peer_cert( const ssl_context *ssl );
991 
1000 int ssl_handshake( ssl_context *ssl );
1001 
1014 int ssl_handshake_step( ssl_context *ssl );
1015 
1023 int ssl_renegotiate( ssl_context *ssl );
1024 
1035 int ssl_read( ssl_context *ssl, unsigned char *buf, size_t len );
1036 
1051 int ssl_write( ssl_context *ssl, const unsigned char *buf, size_t len );
1052 
1064  unsigned char level,
1065  unsigned char message );
1071 int ssl_close_notify( ssl_context *ssl );
1072 
1078 void ssl_free( ssl_context *ssl );
1079 
1086 void ssl_session_free( ssl_session *session );
1087 
1094 void ssl_transform_free( ssl_transform *transform );
1095 
1102 void ssl_handshake_free( ssl_handshake_params *handshake );
1103 
1104 /*
1105  * Internal functions (do not call directly)
1106  */
1109 void ssl_handshake_wrapup( ssl_context *ssl );
1110 
1112 
1113 int ssl_derive_keys( ssl_context *ssl );
1114 
1115 int ssl_read_record( ssl_context *ssl );
1120 int ssl_fetch_input( ssl_context *ssl, size_t nb_want );
1121 
1122 int ssl_write_record( ssl_context *ssl );
1123 int ssl_flush_output( ssl_context *ssl );
1124 
1127 
1130 
1131 int ssl_parse_finished( ssl_context *ssl );
1132 int ssl_write_finished( ssl_context *ssl );
1133 
1134 void ssl_optimize_checksum( ssl_context *ssl, int ciphersuite );
1135 
1136 #ifdef __cplusplus
1137 }
1138 #endif
1139 
1140 #endif /* ssl.h */