ssl/statem/statem_locl.h

   1 /*
   2  * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /*****************************************************************************
  11  *                                                                           *
  12  * The following definitions are PRIVATE to the state machine. They should   *
  13  * NOT be used outside of the state machine.                                 *
  14  *                                                                           *
  15  *****************************************************************************/
  16
  17 /* Max message length definitions */
  18
  19 /* The spec allows for a longer length than this, but we limit it */
  20 #define HELLO_VERIFY_REQUEST_MAX_LENGTH 258
  21 #define SERVER_HELLO_MAX_LENGTH         20000
  22 #define HELLO_RETRY_REQUEST_MAX_LENGTH  20000
  23 #define ENCRYPTED_EXTENSIONS_MAX_LENGTH 20000
  24 #define SERVER_KEY_EXCH_MAX_LENGTH      102400
  25 #define SERVER_HELLO_DONE_MAX_LENGTH    0
  26 #define CCS_MAX_LENGTH                  1
  27 /* Max should actually be 36 but we are generous */
  28 #define FINISHED_MAX_LENGTH             64
  29
  30 /* Extension context codes */
  31 /* This extension is only allowed in TLS */
  32 #define EXT_TLS_ONLY                        0x0001
  33 /* This extension is only allowed in DTLS */
  34 #define EXT_DTLS_ONLY                       0x0002
  35 /* Some extensions may be allowed in DTLS but we don't implement them for it */
  36 #define EXT_TLS_IMPLEMENTATION_ONLY         0x0004
  37 /* Most extensions are not defined for SSLv3 but EXT_TYPE_renegotiate is */
  38 #define EXT_SSL3_ALLOWED                    0x0008
  39 /* Extension is only defined for TLS1.2 and above */
  40 #define EXT_TLS1_2_AND_BELOW_ONLY           0x0010
  41 /* Extension is only defined for TLS1.3 and above */
  42 #define EXT_TLS1_3_ONLY                     0x0020
  43 #define EXT_CLIENT_HELLO                    0x0040
  44 /* Really means TLS1.2 or below */
  45 #define EXT_TLS1_2_SERVER_HELLO             0x0080
  46 #define EXT_TLS1_3_SERVER_HELLO             0x0100
  47 #define EXT_TLS1_3_ENCRYPTED_EXTENSIONS     0x0200
  48 #define EXT_TLS1_3_HELLO_RETRY_REQUEST      0x0400
  49 #define EXT_TLS1_3_CERTIFICATE              0x0800
  50 #define EXT_TLS1_3_NEW_SESSION_TICKET       0x1000
  51
  52 /* Message processing return codes */
  53 typedef enum {
  54     /* Something bad happened */
  55     MSG_PROCESS_ERROR,
  56     /* We've finished reading - swap to writing */
  57     MSG_PROCESS_FINISHED_READING,
  58     /*
  59      * We've completed the main processing of this message but there is some
  60      * post processing to be done.
  61      */
  62     MSG_PROCESS_CONTINUE_PROCESSING,
  63     /* We've finished this message - read the next message */
  64     MSG_PROCESS_CONTINUE_READING
  65 } MSG_PROCESS_RETURN;
  66
  67 /* Flush the write BIO */
  68 int statem_flush(SSL *s);
  69
  70 typedef int (*confunc_f) (SSL *s, WPACKET *pkt);
  71
  72 /*
  73  * TLS/DTLS client state machine functions
  74  */
  75 int ossl_statem_client_read_transition(SSL *s, int mt);
  76 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
  77 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
  78 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
  79 int ossl_statem_client_construct_message(SSL *s, WPACKET *pkt,
  80                                          confunc_f *confunc, int *mt);
  81 size_t ossl_statem_client_max_message_size(SSL *s);
  82 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
  83 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
  84
  85 /*
  86  * TLS/DTLS server state machine functions
  87  */
  88 int ossl_statem_server_read_transition(SSL *s, int mt);
  89 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
  90 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
  91 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
  92 int ossl_statem_server_construct_message(SSL *s, WPACKET *pkt,
  93                                          confunc_f *confunc,int *mt);
  94 size_t ossl_statem_server_max_message_size(SSL *s);
  95 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
  96 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
  97
  98 /* Functions for getting new message data */
  99 __owur int tls_get_message_header(SSL *s, int *mt);
 100 __owur int tls_get_message_body(SSL *s, size_t *len);
 101 __owur int dtls_get_message(SSL *s, int *mt, size_t *len);
 102
 103 /* Message construction and processing functions */
 104 __owur int tls_process_initial_server_flight(SSL *s, int *al);
 105 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
 106 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
 107 __owur int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
 108 __owur int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
 109
 110 __owur int tls_construct_finished(SSL *s, WPACKET *pkt);
 111 __owur WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst, int clearbufs);
 112 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
 113
 114 /* some client-only functions */
 115 __owur int tls_construct_client_hello(SSL *s, WPACKET *pkt);
 116 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
 117 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
 118 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
 119 __owur int tls_process_cert_status_body(SSL *s, PACKET *pkt, int *al);
 120 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
 121 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
 122 __owur int tls_construct_cert_verify(SSL *s, WPACKET *pkt);
 123 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
 124 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
 125 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
 126 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
 127 __owur int tls_client_key_exchange_post_work(SSL *s);
 128 __owur int tls_construct_cert_status_body(SSL *s, WPACKET *pkt);
 129 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
 130 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
 131 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
 132 __owur int ssl3_check_cert_and_algorithm(SSL *s);
 133 #ifndef OPENSSL_NO_NEXTPROTONEG
 134 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
 135 #endif
 136 __owur MSG_PROCESS_RETURN tls_process_hello_req(SSL *s, PACKET *pkt);
 137 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
 138
 139 /* some server-only functions */
 140 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
 141 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
 142 __owur int tls_construct_server_hello(SSL *s, WPACKET *pkt);
 143 __owur int dtls_construct_hello_verify_request(SSL *s, WPACKET *pkt);
 144 __owur int tls_construct_server_certificate(SSL *s, WPACKET *pkt);
 145 __owur int tls_construct_server_key_exchange(SSL *s, WPACKET *pkt);
 146 __owur int tls_construct_certificate_request(SSL *s, WPACKET *pkt);
 147 __owur int tls_construct_server_done(SSL *s, WPACKET *pkt);
 148 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
 149 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
 150 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
 151 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
 152 #ifndef OPENSSL_NO_NEXTPROTONEG
 153 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
 154 #endif
 155 __owur int tls_construct_new_session_ticket(SSL *s, WPACKET *pkt);
 156
 157
 158 /* Extension processing */
 159
 160 __owur int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
 161                                   RAW_EXTENSION **res, int *al);
 162 __owur int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
 163                                RAW_EXTENSION *exts,  X509 *x, size_t chainidx,
 164                                int *al);
 165 __owur int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts,
 166                                     X509 *x, size_t chainidx, int *al);
 167 __owur int tls_construct_extensions(SSL *s, WPACKET *pkt, unsigned int context,
 168                                     X509 *x, size_t chainidx, int *al);
 169
 170 __owur int tls_psk_do_binder(SSL *s, const EVP_MD *md,
 171                              const unsigned char *msgstart,
 172                              size_t binderoffset, const unsigned char *binderin,
 173                              unsigned char *binderout,
 174                              SSL_SESSION *sess, int sign);
 175
 176 /* Server Extension processing */
 177 int tls_parse_ctos_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
 178                                X509 *x, size_t chainidx, int *al);
 179 int tls_parse_ctos_server_name(SSL *s, PACKET *pkt, unsigned int context,
 180                                X509 *x, size_t chainidx, int *al);
 181 #ifndef OPENSSL_NO_SRP
 182 int tls_parse_ctos_srp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 183                        size_t chainidx, int *al);
 184 #endif
 185 #ifndef OPENSSL_NO_EC
 186 int tls_parse_ctos_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
 187                                  X509 *x, size_t chainidx, int *al);
 188 int tls_parse_ctos_supported_groups(SSL *s, PACKET *pkt, unsigned int context,
 189                                     X509 *x, size_t chainidx, int *al);
 190 #endif
 191 int tls_parse_ctos_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
 192                                   X509 *x, size_t chainidx, int *al);
 193 int tls_parse_ctos_sig_algs(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 194                             size_t chainidx, int *al);
 195 #ifndef OPENSSL_NO_OCSP
 196 int tls_parse_ctos_status_request(SSL *s, PACKET *pkt, unsigned int context,
 197                                   X509 *x, size_t chainidx, int *al);
 198 #endif
 199 #ifndef OPENSSL_NO_NEXTPROTONEG
 200 int tls_parse_ctos_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 201                        size_t chainidx, int *al);
 202 #endif
 203 int tls_parse_ctos_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 204                         size_t chainidx, int *al);
 205 #ifndef OPENSSL_NO_SRTP
 206 int tls_parse_ctos_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 207                             size_t chainidx, int *al);
 208 #endif
 209 int tls_parse_ctos_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 210                        size_t chainidx, int *al);
 211 int tls_parse_ctos_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 212                              size_t chainidx, int *al);
 213 int tls_parse_ctos_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 214                        size_t chainidx, int *al);
 215 int tls_parse_ctos_psk_kex_modes(SSL *s, PACKET *pkt, unsigned int context,
 216                                  X509 *x, size_t chainidx, int *al);
 217 int tls_parse_ctos_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 218                        size_t chainidx, int *al);
 219
 220 int tls_construct_stoc_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
 221                                    X509 *x, size_t chainidx, int *al);
 222 int tls_construct_stoc_server_name(SSL *s, WPACKET *pkt, unsigned int context,
 223                                    X509 *x, size_t chainidx, int *al);
 224 #ifndef OPENSSL_NO_EC
 225 int tls_construct_stoc_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
 226                                      X509 *x, size_t chainidx, int *al);
 227 #endif
 228 int tls_construct_stoc_session_ticket(SSL *s, WPACKET *pkt,
 229                                       unsigned int context, X509 *x,
 230                                       size_t chainidx, int *al);
 231 #ifndef OPENSSL_NO_OCSP
 232 int tls_construct_stoc_status_request(SSL *s, WPACKET *pkt,
 233                                       unsigned int context, X509 *x,
 234                                       size_t chainidx, int *al);
 235 #endif
 236 #ifndef OPENSSL_NO_NEXTPROTONEG
 237 int tls_construct_stoc_next_proto_neg(SSL *s, WPACKET *pkt,
 238                                       unsigned int context, X509 *x,
 239                                       size_t chainidx, int *al);
 240 #endif
 241 int tls_construct_stoc_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 242                             size_t chainidx, int *al);
 243 #ifndef OPENSSL_NO_SRTP
 244 int tls_construct_stoc_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
 245                                 X509 *x, size_t chainidx, int *al);
 246 #endif
 247 int tls_construct_stoc_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 248                            size_t chainidx, int *al);
 249 int tls_construct_stoc_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 250                            size_t chainidx, int *al);
 251 int tls_construct_stoc_key_share(SSL *s, WPACKET *pkt, unsigned int context,
 252                                  X509 *x, size_t chainidx, int *al);
 253 /*
 254  * Not in public headers as this is not an official extension. Only used when
 255  * SSL_OP_CRYPTOPRO_TLSEXT_BUG is set.
 256  */
 257 #define TLSEXT_TYPE_cryptopro_bug      0xfde8
 258 int tls_construct_stoc_cryptopro_bug(SSL *s, WPACKET *pkt, unsigned int context,
 259                                      X509 *x, size_t chainidx, int *al);
 260 int tls_construct_stoc_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 261                            size_t chainidx, int *al);
 262
 263 /* Client Extension processing */
 264 int tls_construct_ctos_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
 265                                    X509 *x, size_t chainidx, int *al);
 266 int tls_construct_ctos_server_name(SSL *s, WPACKET *pkt, unsigned int context,
 267                                    X509 *x, size_t chainidx, int *al);
 268 #ifndef OPENSSL_NO_SRP
 269 int tls_construct_ctos_srp(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 270                            size_t chainidx, int *al);
 271 #endif
 272 #ifndef OPENSSL_NO_EC
 273 int tls_construct_ctos_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
 274                                      X509 *x, size_t chainidx, int *al);
 275 int tls_construct_ctos_supported_groups(SSL *s, WPACKET *pkt,
 276                                         unsigned int context, X509 *x,
 277                                         size_t chainidx, int *al);
 278 #endif
 279 int tls_construct_ctos_session_ticket(SSL *s, WPACKET *pkt,
 280                                       unsigned int context, X509 *x,
 281                                       size_t chainidx, int *al);
 282 int tls_construct_ctos_sig_algs(SSL *s, WPACKET *pkt, unsigned int context,
 283                                 X509 *x, size_t chainidx, int *al);
 284 #ifndef OPENSSL_NO_OCSP
 285 int tls_construct_ctos_status_request(SSL *s, WPACKET *pkt,
 286                                       unsigned int context, X509 *x,
 287                                       size_t chainidx, int *al);
 288 #endif
 289 #ifndef OPENSSL_NO_NEXTPROTONEG
 290 int tls_construct_ctos_npn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 291                            size_t chainidx, int *al);
 292 #endif
 293 int tls_construct_ctos_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 294                             size_t chainidx, int *al);
 295 #ifndef OPENSSL_NO_SRTP
 296 int tls_construct_ctos_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
 297                                 X509 *x, size_t chainidx, int *al);
 298 #endif
 299 int tls_construct_ctos_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 300                            size_t chainidx, int *al);
 301 #ifndef OPENSSL_NO_CT
 302 int tls_construct_ctos_sct(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 303                            size_t chainidx, int *al);
 304 #endif
 305 int tls_construct_ctos_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 306                            size_t chainidx, int *al);
 307 int tls_construct_ctos_supported_versions(SSL *s, WPACKET *pkt,
 308                                           unsigned int context, X509 *x,
 309                                           size_t chainidx, int *al);
 310 int tls_construct_ctos_key_share(SSL *s, WPACKET *pkt, unsigned int context,
 311                                  X509 *x, size_t chainidx, int *al);
 312 int tls_construct_ctos_psk_kex_modes(SSL *s, WPACKET *pkt, unsigned int context,
 313                                      X509 *x, size_t chainidx, int *al);
 314 int tls_construct_ctos_padding(SSL *s, WPACKET *pkt, unsigned int context,
 315                                X509 *x, size_t chainidx, int *al);
 316 int tls_construct_ctos_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 317                            size_t chainidx, int *al);
 318 int tls_parse_stoc_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
 319                                X509 *x, size_t chainidx, int *al);
 320 int tls_parse_stoc_server_name(SSL *s, PACKET *pkt, unsigned int context,
 321                                X509 *x, size_t chainidx, int *al);
 322 #ifndef OPENSSL_NO_EC
 323 int tls_parse_stoc_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
 324                                  X509 *x, size_t chainidx, int *al);
 325 #endif
 326 int tls_parse_stoc_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
 327                                   X509 *x, size_t chainidx, int *al);
 328 #ifndef OPENSSL_NO_OCSP
 329 int tls_parse_stoc_status_request(SSL *s, PACKET *pkt, unsigned int context,
 330                                   X509 *x, size_t chainidx, int *al);
 331 #endif
 332 #ifndef OPENSSL_NO_CT
 333 int tls_parse_stoc_sct(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 334                        size_t chainidx, int *al);
 335 #endif
 336 #ifndef OPENSSL_NO_NEXTPROTONEG
 337 int tls_parse_stoc_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 338                        size_t chainidx, int *al);
 339 #endif
 340 int tls_parse_stoc_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 341                         size_t chainidx, int *al);
 342 #ifndef OPENSSL_NO_SRTP
 343 int tls_parse_stoc_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 344                             size_t chainidx, int *al);
 345 #endif
 346 int tls_parse_stoc_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 347                        size_t chainidx, int *al);
 348 int tls_parse_stoc_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 349                        size_t chainidx, int *al);
 350 int tls_parse_stoc_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 351                              size_t chainidx, int *al);
 352 int tls_parse_stoc_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 353                        size_t chainidx, int *al);