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 int check_in_list(SSL *s, unsigned int group_id, const unsigned char *groups,
  59                   size_t num_groups, int checkallow);
  60 int create_synthetic_message_hash(SSL *s);
  61 int parse_ca_names(SSL *s, PACKET *pkt, int *al);
  62 int construct_ca_names(SSL *s, WPACKET *pkt);
  63
  64 /*
  65  * TLS/DTLS client state machine functions
  66  */
  67 int ossl_statem_client_read_transition(SSL *s, int mt);
  68 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
  69 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
  70 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
  71 int ossl_statem_client_construct_message(SSL *s, WPACKET *pkt,
  72                                          confunc_f *confunc, int *mt);
  73 size_t ossl_statem_client_max_message_size(SSL *s);
  74 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
  75 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
  76
  77 /*
  78  * TLS/DTLS server state machine functions
  79  */
  80 int ossl_statem_server_read_transition(SSL *s, int mt);
  81 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
  82 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
  83 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
  84 int ossl_statem_server_construct_message(SSL *s, WPACKET *pkt,
  85                                          confunc_f *confunc,int *mt);
  86 size_t ossl_statem_server_max_message_size(SSL *s);
  87 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
  88 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
  89
  90 /* Functions for getting new message data */
  91 __owur int tls_get_message_header(SSL *s, int *mt);
  92 __owur int tls_get_message_body(SSL *s, size_t *len);
  93 __owur int dtls_get_message(SSL *s, int *mt, size_t *len);
  94
  95 /* Message construction and processing functions */
  96 __owur int tls_process_initial_server_flight(SSL *s, int *al);
  97 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
  98 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
  99 __owur int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
 100 __owur int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
 101
 102 __owur int tls_construct_finished(SSL *s, WPACKET *pkt);
 103 __owur int tls_construct_key_update(SSL *s, WPACKET *pkt);
 104 __owur MSG_PROCESS_RETURN tls_process_key_update(SSL *s, PACKET *pkt);
 105 __owur WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst, int clearbufs);
 106 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
 107
 108 /* some client-only functions */
 109 __owur int tls_construct_client_hello(SSL *s, WPACKET *pkt);
 110 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
 111 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
 112 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
 113 __owur int tls_process_cert_status_body(SSL *s, PACKET *pkt, int *al);
 114 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
 115 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
 116 __owur int tls_construct_cert_verify(SSL *s, WPACKET *pkt);
 117 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
 118 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
 119 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
 120 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
 121 __owur int tls_client_key_exchange_post_work(SSL *s);
 122 __owur int tls_construct_cert_status_body(SSL *s, WPACKET *pkt);
 123 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
 124 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
 125 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
 126 __owur int ssl3_check_cert_and_algorithm(SSL *s);
 127 #ifndef OPENSSL_NO_NEXTPROTONEG
 128 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
 129 #endif
 130 __owur MSG_PROCESS_RETURN tls_process_hello_req(SSL *s, PACKET *pkt);
 131 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
 132 __owur int tls_construct_end_of_early_data(SSL *s, WPACKET *pkt);
 133
 134 /* some server-only functions */
 135 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
 136 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
 137 __owur int tls_construct_server_hello(SSL *s, WPACKET *pkt);
 138 __owur int dtls_construct_hello_verify_request(SSL *s, WPACKET *pkt);
 139 __owur int tls_construct_server_certificate(SSL *s, WPACKET *pkt);
 140 __owur int tls_construct_server_key_exchange(SSL *s, WPACKET *pkt);
 141 __owur int tls_construct_certificate_request(SSL *s, WPACKET *pkt);
 142 __owur int tls_construct_server_done(SSL *s, WPACKET *pkt);
 143 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
 144 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
 145 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
 146 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
 147 #ifndef OPENSSL_NO_NEXTPROTONEG
 148 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
 149 #endif
 150 __owur int tls_construct_new_session_ticket(SSL *s, WPACKET *pkt);
 151 MSG_PROCESS_RETURN tls_process_end_of_early_data(SSL *s, PACKET *pkt);
 152
 153
 154 /* Extension processing */
 155
 156 __owur int extension_is_relevant(SSL *s, unsigned int extctx,
 157                                  unsigned int thisctx);
 158 __owur int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
 159                                   RAW_EXTENSION **res, int *al, size_t *len);
 160 __owur int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
 161                                RAW_EXTENSION *exts,  X509 *x, size_t chainidx,
 162                                int *al);
 163 __owur int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts,
 164                                     X509 *x, size_t chainidx, int *al);
 165 __owur int should_add_extension(SSL *s, unsigned int extctx,
 166                                 unsigned int thisctx, int max_version);
 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 int tls_parse_ctos_early_data(SSL *s, PACKET *pkt, unsigned int context,
 186                               X509 *x, size_t chainidx, int *al);
 187 #ifndef OPENSSL_NO_EC
 188 int tls_parse_ctos_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
 189                                  X509 *x, size_t chainidx, int *al);
 190 int tls_parse_ctos_supported_groups(SSL *s, PACKET *pkt, unsigned int context,
 191                                     X509 *x, size_t chainidx, int *al);
 192 #endif
 193 int tls_parse_ctos_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
 194                                   X509 *x, size_t chainidx, int *al);
 195 int tls_parse_ctos_sig_algs(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 196                             size_t chainidx, int *al);
 197 #ifndef OPENSSL_NO_OCSP
 198 int tls_parse_ctos_status_request(SSL *s, PACKET *pkt, unsigned int context,
 199                                   X509 *x, size_t chainidx, int *al);
 200 #endif
 201 #ifndef OPENSSL_NO_NEXTPROTONEG
 202 int tls_parse_ctos_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 203                        size_t chainidx, int *al);
 204 #endif
 205 int tls_parse_ctos_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 206                         size_t chainidx, int *al);
 207 #ifndef OPENSSL_NO_SRTP
 208 int tls_parse_ctos_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 209                             size_t chainidx, int *al);
 210 #endif
 211 int tls_parse_ctos_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 212                        size_t chainidx, int *al);
 213 int tls_parse_ctos_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 214                              size_t chainidx, int *al);
 215 int tls_parse_ctos_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 216                        size_t chainidx, int *al);
 217 int tls_parse_ctos_psk_kex_modes(SSL *s, PACKET *pkt, unsigned int context,
 218                                  X509 *x, size_t chainidx, int *al);
 219 int tls_parse_ctos_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 220                        size_t chainidx, int *al);
 221
 222 int tls_construct_stoc_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
 223                                    X509 *x, size_t chainidx, int *al);
 224 int tls_construct_stoc_server_name(SSL *s, WPACKET *pkt, unsigned int context,
 225                                    X509 *x, size_t chainidx, int *al);
 226 int tls_construct_stoc_early_data(SSL *s, WPACKET *pkt, unsigned int context,
 227                                   X509 *x, size_t chainidx, int *al);
 228 #ifndef OPENSSL_NO_EC
 229 int tls_construct_stoc_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
 230                                      X509 *x, size_t chainidx, int *al);
 231 #endif
 232 int tls_construct_stoc_session_ticket(SSL *s, WPACKET *pkt,
 233                                       unsigned int context, X509 *x,
 234                                       size_t chainidx, int *al);
 235 #ifndef OPENSSL_NO_OCSP
 236 int tls_construct_stoc_status_request(SSL *s, WPACKET *pkt,
 237                                       unsigned int context, X509 *x,
 238                                       size_t chainidx, int *al);
 239 #endif
 240 #ifndef OPENSSL_NO_NEXTPROTONEG
 241 int tls_construct_stoc_next_proto_neg(SSL *s, WPACKET *pkt,
 242                                       unsigned int context, X509 *x,
 243                                       size_t chainidx, int *al);
 244 #endif
 245 int tls_construct_stoc_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 246                             size_t chainidx, int *al);
 247 #ifndef OPENSSL_NO_SRTP
 248 int tls_construct_stoc_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
 249                                 X509 *x, size_t chainidx, int *al);
 250 #endif
 251 int tls_construct_stoc_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 252                            size_t chainidx, int *al);
 253 int tls_construct_stoc_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 254                            size_t chainidx, int *al);
 255 int tls_construct_stoc_key_share(SSL *s, WPACKET *pkt, unsigned int context,
 256                                  X509 *x, size_t chainidx, int *al);
 257 /*
 258  * Not in public headers as this is not an official extension. Only used when
 259  * SSL_OP_CRYPTOPRO_TLSEXT_BUG is set.
 260  */
 261 #define TLSEXT_TYPE_cryptopro_bug      0xfde8
 262 int tls_construct_stoc_cryptopro_bug(SSL *s, WPACKET *pkt, unsigned int context,
 263                                      X509 *x, size_t chainidx, int *al);
 264 int tls_construct_stoc_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 265                            size_t chainidx, int *al);
 266
 267 /* Client Extension processing */
 268 int tls_construct_ctos_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
 269                                    X509 *x, size_t chainidx, int *al);
 270 int tls_construct_ctos_server_name(SSL *s, WPACKET *pkt, unsigned int context,
 271                                    X509 *x, size_t chainidx, int *al);
 272 #ifndef OPENSSL_NO_SRP
 273 int tls_construct_ctos_srp(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 274                            size_t chainidx, int *al);
 275 #endif
 276 #ifndef OPENSSL_NO_EC
 277 int tls_construct_ctos_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
 278                                      X509 *x, size_t chainidx, int *al);
 279 int tls_construct_ctos_supported_groups(SSL *s, WPACKET *pkt,
 280                                         unsigned int context, X509 *x,
 281                                         size_t chainidx, int *al);
 282 #endif
 283 int tls_construct_ctos_early_data(SSL *s, WPACKET *pkt, unsigned int context,
 284                                   X509 *x, size_t chainidx, int *al);
 285 int tls_construct_ctos_session_ticket(SSL *s, WPACKET *pkt,
 286                                       unsigned int context, X509 *x,
 287                                       size_t chainidx, int *al);
 288 int tls_construct_ctos_sig_algs(SSL *s, WPACKET *pkt, unsigned int context,
 289                                 X509 *x, size_t chainidx, int *al);
 290 #ifndef OPENSSL_NO_OCSP
 291 int tls_construct_ctos_status_request(SSL *s, WPACKET *pkt,
 292                                       unsigned int context, X509 *x,
 293                                       size_t chainidx, int *al);
 294 #endif
 295 #ifndef OPENSSL_NO_NEXTPROTONEG
 296 int tls_construct_ctos_npn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 297                            size_t chainidx, int *al);
 298 #endif
 299 int tls_construct_ctos_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 300                             size_t chainidx, int *al);
 301 #ifndef OPENSSL_NO_SRTP
 302 int tls_construct_ctos_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
 303                                 X509 *x, size_t chainidx, int *al);
 304 #endif
 305 int tls_construct_ctos_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 306                            size_t chainidx, int *al);
 307 #ifndef OPENSSL_NO_CT
 308 int tls_construct_ctos_sct(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 309                            size_t chainidx, int *al);
 310 #endif
 311 int tls_construct_ctos_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 312                            size_t chainidx, int *al);
 313 int tls_construct_ctos_supported_versions(SSL *s, WPACKET *pkt,
 314                                           unsigned int context, X509 *x,
 315                                           size_t chainidx, int *al);
 316 int tls_construct_ctos_key_share(SSL *s, WPACKET *pkt, unsigned int context,
 317                                  X509 *x, size_t chainidx, int *al);
 318 int tls_construct_ctos_psk_kex_modes(SSL *s, WPACKET *pkt, unsigned int context,
 319                                      X509 *x, size_t chainidx, int *al);
 320 int tls_construct_ctos_cookie(SSL *s, WPACKET *pkt, unsigned int context,
 321                               X509 *x, size_t chainidx, int *al);
 322 int tls_construct_ctos_padding(SSL *s, WPACKET *pkt, unsigned int context,
 323                                X509 *x, size_t chainidx, int *al);
 324 int tls_construct_ctos_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 325                            size_t chainidx, int *al);
 326 int tls_parse_stoc_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
 327                                X509 *x, size_t chainidx, int *al);
 328 int tls_parse_stoc_server_name(SSL *s, PACKET *pkt, unsigned int context,
 329                                X509 *x, size_t chainidx, int *al);
 330 int tls_parse_stoc_early_data(SSL *s, PACKET *pkt, unsigned int context,
 331                               X509 *x, size_t chainidx, int *al);
 332 #ifndef OPENSSL_NO_EC
 333 int tls_parse_stoc_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
 334                                  X509 *x, size_t chainidx, int *al);
 335 #endif
 336 int tls_parse_stoc_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
 337                                   X509 *x, size_t chainidx, int *al);
 338 #ifndef OPENSSL_NO_OCSP
 339 int tls_parse_stoc_status_request(SSL *s, PACKET *pkt, unsigned int context,
 340                                   X509 *x, size_t chainidx, int *al);
 341 #endif
 342 #ifndef OPENSSL_NO_CT
 343 int tls_parse_stoc_sct(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 344                        size_t chainidx, int *al);
 345 #endif
 346 #ifndef OPENSSL_NO_NEXTPROTONEG
 347 int tls_parse_stoc_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 348                        size_t chainidx, int *al);
 349 #endif
 350 int tls_parse_stoc_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 351                         size_t chainidx, int *al);
 352 #ifndef OPENSSL_NO_SRTP
 353 int tls_parse_stoc_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 354                             size_t chainidx, int *al);
 355 #endif
 356 int tls_parse_stoc_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 357                        size_t chainidx, int *al);
 358 int tls_parse_stoc_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 359                        size_t chainidx, int *al);
 360 int tls_parse_stoc_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 361                              size_t chainidx, int *al);
 362 int tls_parse_stoc_cookie(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 363                        size_t chainidx, int *al);
 364 int tls_parse_stoc_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 365                        size_t chainidx, int *al);