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 END_OF_EARLY_DATA_MAX_LENGTH    0
  22 #define SERVER_HELLO_MAX_LENGTH         20000
  23 #define HELLO_RETRY_REQUEST_MAX_LENGTH  20000
  24 #define ENCRYPTED_EXTENSIONS_MAX_LENGTH 20000
  25 #define SERVER_KEY_EXCH_MAX_LENGTH      102400
  26 #define SERVER_HELLO_DONE_MAX_LENGTH    0
  27 #define KEY_UPDATE_MAX_LENGTH           1
  28 #define CCS_MAX_LENGTH                  1
  29 /* Max should actually be 36 but we are generous */
  30 #define FINISHED_MAX_LENGTH             64
  31
  32 /* The maximum number of incoming KeyUpdate messages we will accept */
  33 #define MAX_KEY_UPDATE_MESSAGES     32
  34
  35 /* Dummy message type */
  36 #define SSL3_MT_DUMMY   -1
  37
  38 /* Message processing return codes */
  39 typedef enum {
  40     /* Something bad happened */
  41     MSG_PROCESS_ERROR,
  42     /* We've finished reading - swap to writing */
  43     MSG_PROCESS_FINISHED_READING,
  44     /*
  45      * We've completed the main processing of this message but there is some
  46      * post processing to be done.
  47      */
  48     MSG_PROCESS_CONTINUE_PROCESSING,
  49     /* We've finished this message - read the next message */
  50     MSG_PROCESS_CONTINUE_READING
  51 } MSG_PROCESS_RETURN;
  52
  53 /* Flush the write BIO */
  54 int statem_flush(SSL *s);
  55
  56 typedef int (*confunc_f) (SSL *s, WPACKET *pkt);
  57
  58 #define GET_GROUP_ID(group, idx) \
  59     (unsigned int)(((group)[(idx) * 2] << 8) | (group)[((idx) * 2) + 1])
  60
  61 int check_in_list(SSL *s, unsigned int group_id, const unsigned char *groups,
  62                   size_t num_groups, int checkallow);
  63 int create_synthetic_message_hash(SSL *s);
  64 int parse_ca_names(SSL *s, PACKET *pkt, int *al);
  65 int construct_ca_names(SSL *s, WPACKET *pkt);
  66
  67 /*
  68  * TLS/DTLS client state machine functions
  69  */
  70 int ossl_statem_client_read_transition(SSL *s, int mt);
  71 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
  72 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
  73 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
  74 int ossl_statem_client_construct_message(SSL *s, WPACKET *pkt,
  75                                          confunc_f *confunc, int *mt);
  76 size_t ossl_statem_client_max_message_size(SSL *s);
  77 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
  78 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
  79
  80 /*
  81  * TLS/DTLS server state machine functions
  82  */
  83 int ossl_statem_server_read_transition(SSL *s, int mt);
  84 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
  85 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
  86 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
  87 int ossl_statem_server_construct_message(SSL *s, WPACKET *pkt,
  88                                          confunc_f *confunc,int *mt);
  89 size_t ossl_statem_server_max_message_size(SSL *s);
  90 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
  91 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
  92
  93 /* Functions for getting new message data */
  94 __owur int tls_get_message_header(SSL *s, int *mt);
  95 __owur int tls_get_message_body(SSL *s, size_t *len);
  96 __owur int dtls_get_message(SSL *s, int *mt, size_t *len);
  97
  98 /* Message construction and processing functions */
  99 __owur int tls_process_initial_server_flight(SSL *s, int *al);
 100 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
 101 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
 102 __owur int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
 103 __owur int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
 104
 105 __owur int tls_construct_finished(SSL *s, WPACKET *pkt);
 106 __owur int tls_construct_key_update(SSL *s, WPACKET *pkt);
 107 __owur MSG_PROCESS_RETURN tls_process_key_update(SSL *s, PACKET *pkt);
 108 __owur WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst, int clearbufs);
 109 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
 110
 111 /* some client-only functions */
 112 __owur int tls_construct_client_hello(SSL *s, WPACKET *pkt);
 113 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
 114 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
 115 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
 116 __owur int tls_process_cert_status_body(SSL *s, PACKET *pkt, int *al);
 117 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
 118 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
 119 __owur int tls_construct_cert_verify(SSL *s, WPACKET *pkt);
 120 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
 121 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
 122 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
 123 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
 124 __owur int tls_client_key_exchange_post_work(SSL *s);
 125 __owur int tls_construct_cert_status_body(SSL *s, WPACKET *pkt);
 126 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
 127 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
 128 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
 129 __owur int ssl3_check_cert_and_algorithm(SSL *s);
 130 #ifndef OPENSSL_NO_NEXTPROTONEG
 131 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
 132 #endif
 133 __owur MSG_PROCESS_RETURN tls_process_hello_req(SSL *s, PACKET *pkt);
 134 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
 135 __owur int tls_construct_end_of_early_data(SSL *s, WPACKET *pkt);
 136
 137 /* some server-only functions */
 138 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
 139 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
 140 __owur int tls_construct_server_hello(SSL *s, WPACKET *pkt);
 141 __owur int dtls_construct_hello_verify_request(SSL *s, WPACKET *pkt);
 142 __owur int tls_construct_server_certificate(SSL *s, WPACKET *pkt);
 143 __owur int tls_construct_server_key_exchange(SSL *s, WPACKET *pkt);
 144 __owur int tls_construct_certificate_request(SSL *s, WPACKET *pkt);
 145 __owur int tls_construct_server_done(SSL *s, WPACKET *pkt);
 146 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
 147 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
 148 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
 149 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
 150 #ifndef OPENSSL_NO_NEXTPROTONEG
 151 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
 152 #endif
 153 __owur int tls_construct_new_session_ticket(SSL *s, WPACKET *pkt);
 154 MSG_PROCESS_RETURN tls_process_end_of_early_data(SSL *s, PACKET *pkt);
 155
 156
 157 /* Extension processing */
 158
 159 __owur int extension_is_relevant(SSL *s, unsigned int extctx,
 160                                  unsigned int thisctx);
 161 __owur int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
 162                                   RAW_EXTENSION **res, int *al, size_t *len,
 163                                   int init);
 164 __owur int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
 165                                RAW_EXTENSION *exts,  X509 *x, size_t chainidx,
 166                                int *al);
 167 __owur int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts,
 168                                     X509 *x, size_t chainidx, int *al, int fin);
 169 __owur int should_add_extension(SSL *s, unsigned int extctx,
 170                                 unsigned int thisctx, int max_version);
 171 __owur int tls_construct_extensions(SSL *s, WPACKET *pkt, unsigned int context,
 172                                     X509 *x, size_t chainidx, int *al);
 173
 174 __owur int tls_psk_do_binder(SSL *s, const EVP_MD *md,
 175                              const unsigned char *msgstart,
 176                              size_t binderoffset, const unsigned char *binderin,
 177                              unsigned char *binderout,
 178                              SSL_SESSION *sess, int sign);
 179
 180 /* Server Extension processing */
 181 int tls_parse_ctos_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
 182                                X509 *x, size_t chainidx, int *al);
 183 int tls_parse_ctos_server_name(SSL *s, PACKET *pkt, unsigned int context,
 184                                X509 *x, size_t chainidx, int *al);
 185 #ifndef OPENSSL_NO_SRP
 186 int tls_parse_ctos_srp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 187                        size_t chainidx, int *al);
 188 #endif
 189 int tls_parse_ctos_early_data(SSL *s, PACKET *pkt, unsigned int context,
 190                               X509 *x, size_t chainidx, int *al);
 191 #ifndef OPENSSL_NO_EC
 192 int tls_parse_ctos_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
 193                                  X509 *x, size_t chainidx, int *al);
 194 int tls_parse_ctos_supported_groups(SSL *s, PACKET *pkt, unsigned int context,
 195                                     X509 *x, size_t chainidx, int *al);
 196 #endif
 197 int tls_parse_ctos_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
 198                                   X509 *x, size_t chainidx, int *al);
 199 int tls_parse_ctos_sig_algs(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 200                             size_t chainidx, int *al);
 201 #ifndef OPENSSL_NO_OCSP
 202 int tls_parse_ctos_status_request(SSL *s, PACKET *pkt, unsigned int context,
 203                                   X509 *x, size_t chainidx, int *al);
 204 #endif
 205 #ifndef OPENSSL_NO_NEXTPROTONEG
 206 int tls_parse_ctos_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 207                        size_t chainidx, int *al);
 208 #endif
 209 int tls_parse_ctos_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 210                         size_t chainidx, int *al);
 211 #ifndef OPENSSL_NO_SRTP
 212 int tls_parse_ctos_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 213                             size_t chainidx, int *al);
 214 #endif
 215 int tls_parse_ctos_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 216                        size_t chainidx, int *al);
 217 int tls_parse_ctos_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 218                              size_t chainidx, int *al);
 219 int tls_parse_ctos_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 220                        size_t chainidx, int *al);
 221 int tls_parse_ctos_psk_kex_modes(SSL *s, PACKET *pkt, unsigned int context,
 222                                  X509 *x, size_t chainidx, int *al);
 223 int tls_parse_ctos_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 224                        size_t chainidx, int *al);
 225
 226 int tls_construct_stoc_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
 227                                    X509 *x, size_t chainidx, int *al);
 228 int tls_construct_stoc_server_name(SSL *s, WPACKET *pkt, unsigned int context,
 229                                    X509 *x, size_t chainidx, int *al);
 230 int tls_construct_stoc_early_data(SSL *s, WPACKET *pkt, unsigned int context,
 231                                   X509 *x, size_t chainidx, int *al);
 232 #ifndef OPENSSL_NO_EC
 233 int tls_construct_stoc_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
 234                                      X509 *x, size_t chainidx, int *al);
 235 #endif
 236 int tls_construct_stoc_supported_groups(SSL *s, WPACKET *pkt,
 237                                         unsigned int context, X509 *x,
 238                                         size_t chainidx, int *al);
 239 int tls_construct_stoc_session_ticket(SSL *s, WPACKET *pkt,
 240                                       unsigned int context, X509 *x,
 241                                       size_t chainidx, int *al);
 242 #ifndef OPENSSL_NO_OCSP
 243 int tls_construct_stoc_status_request(SSL *s, WPACKET *pkt,
 244                                       unsigned int context, X509 *x,
 245                                       size_t chainidx, int *al);
 246 #endif
 247 #ifndef OPENSSL_NO_NEXTPROTONEG
 248 int tls_construct_stoc_next_proto_neg(SSL *s, WPACKET *pkt,
 249                                       unsigned int context, X509 *x,
 250                                       size_t chainidx, int *al);
 251 #endif
 252 int tls_construct_stoc_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 253                             size_t chainidx, int *al);
 254 #ifndef OPENSSL_NO_SRTP
 255 int tls_construct_stoc_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
 256                                 X509 *x, size_t chainidx, int *al);
 257 #endif
 258 int tls_construct_stoc_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 259                            size_t chainidx, int *al);
 260 int tls_construct_stoc_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 261                            size_t chainidx, int *al);
 262 int tls_construct_stoc_key_share(SSL *s, WPACKET *pkt, unsigned int context,
 263                                  X509 *x, size_t chainidx, int *al);
 264 /*
 265  * Not in public headers as this is not an official extension. Only used when
 266  * SSL_OP_CRYPTOPRO_TLSEXT_BUG is set.
 267  */
 268 #define TLSEXT_TYPE_cryptopro_bug      0xfde8
 269 int tls_construct_stoc_cryptopro_bug(SSL *s, WPACKET *pkt, unsigned int context,
 270                                      X509 *x, size_t chainidx, int *al);
 271 int tls_construct_stoc_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 272                            size_t chainidx, int *al);
 273
 274 /* Client Extension processing */
 275 int tls_construct_ctos_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
 276                                    X509 *x, size_t chainidx, int *al);
 277 int tls_construct_ctos_server_name(SSL *s, WPACKET *pkt, unsigned int context,
 278                                    X509 *x, size_t chainidx, int *al);
 279 #ifndef OPENSSL_NO_SRP
 280 int tls_construct_ctos_srp(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 281                            size_t chainidx, int *al);
 282 #endif
 283 #ifndef OPENSSL_NO_EC
 284 int tls_construct_ctos_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
 285                                      X509 *x, size_t chainidx, int *al);
 286 int tls_construct_ctos_supported_groups(SSL *s, WPACKET *pkt,
 287                                         unsigned int context, X509 *x,
 288                                         size_t chainidx, int *al);
 289 #endif
 290 int tls_construct_ctos_early_data(SSL *s, WPACKET *pkt, unsigned int context,
 291                                   X509 *x, size_t chainidx, int *al);
 292 int tls_construct_ctos_session_ticket(SSL *s, WPACKET *pkt,
 293                                       unsigned int context, X509 *x,
 294                                       size_t chainidx, int *al);
 295 int tls_construct_ctos_sig_algs(SSL *s, WPACKET *pkt, unsigned int context,
 296                                 X509 *x, size_t chainidx, int *al);
 297 #ifndef OPENSSL_NO_OCSP
 298 int tls_construct_ctos_status_request(SSL *s, WPACKET *pkt,
 299                                       unsigned int context, X509 *x,
 300                                       size_t chainidx, int *al);
 301 #endif
 302 #ifndef OPENSSL_NO_NEXTPROTONEG
 303 int tls_construct_ctos_npn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 304                            size_t chainidx, int *al);
 305 #endif
 306 int tls_construct_ctos_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 307                             size_t chainidx, int *al);
 308 #ifndef OPENSSL_NO_SRTP
 309 int tls_construct_ctos_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
 310                                 X509 *x, size_t chainidx, int *al);
 311 #endif
 312 int tls_construct_ctos_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 313                            size_t chainidx, int *al);
 314 #ifndef OPENSSL_NO_CT
 315 int tls_construct_ctos_sct(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 316                            size_t chainidx, int *al);
 317 #endif
 318 int tls_construct_ctos_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 319                            size_t chainidx, int *al);
 320 int tls_construct_ctos_supported_versions(SSL *s, WPACKET *pkt,
 321                                           unsigned int context, X509 *x,
 322                                           size_t chainidx, int *al);
 323 int tls_construct_ctos_key_share(SSL *s, WPACKET *pkt, unsigned int context,
 324                                  X509 *x, size_t chainidx, int *al);
 325 int tls_construct_ctos_psk_kex_modes(SSL *s, WPACKET *pkt, unsigned int context,
 326                                      X509 *x, size_t chainidx, int *al);
 327 int tls_construct_ctos_cookie(SSL *s, WPACKET *pkt, unsigned int context,
 328                               X509 *x, size_t chainidx, int *al);
 329 int tls_construct_ctos_padding(SSL *s, WPACKET *pkt, unsigned int context,
 330                                X509 *x, size_t chainidx, int *al);
 331 int tls_construct_ctos_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 332                            size_t chainidx, int *al);
 333 int tls_parse_stoc_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
 334                                X509 *x, size_t chainidx, int *al);
 335 int tls_parse_stoc_server_name(SSL *s, PACKET *pkt, unsigned int context,
 336                                X509 *x, size_t chainidx, int *al);
 337 int tls_parse_stoc_early_data(SSL *s, PACKET *pkt, unsigned int context,
 338                               X509 *x, size_t chainidx, int *al);
 339 #ifndef OPENSSL_NO_EC
 340 int tls_parse_stoc_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
 341                                  X509 *x, size_t chainidx, int *al);
 342 #endif
 343 int tls_parse_stoc_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
 344                                   X509 *x, size_t chainidx, int *al);
 345 #ifndef OPENSSL_NO_OCSP
 346 int tls_parse_stoc_status_request(SSL *s, PACKET *pkt, unsigned int context,
 347                                   X509 *x, size_t chainidx, int *al);
 348 #endif
 349 #ifndef OPENSSL_NO_CT
 350 int tls_parse_stoc_sct(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 351                        size_t chainidx, int *al);
 352 #endif
 353 #ifndef OPENSSL_NO_NEXTPROTONEG
 354 int tls_parse_stoc_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 355                        size_t chainidx, int *al);
 356 #endif
 357 int tls_parse_stoc_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 358                         size_t chainidx, int *al);
 359 #ifndef OPENSSL_NO_SRTP
 360 int tls_parse_stoc_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 361                             size_t chainidx, int *al);
 362 #endif
 363 int tls_parse_stoc_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 364                        size_t chainidx, int *al);
 365 int tls_parse_stoc_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 366                        size_t chainidx, int *al);
 367 int tls_parse_stoc_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 368                              size_t chainidx, int *al);
 369 int tls_parse_stoc_cookie(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 370                        size_t chainidx, int *al);
 371 int tls_parse_stoc_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 372                        size_t chainidx, int *al);