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 int check_in_list(SSL *s, unsigned int group_id, const unsigned char *groups,
  73                   size_t num_groups, int checkallow);
  74
  75 /*
  76  * TLS/DTLS client state machine functions
  77  */
  78 int ossl_statem_client_read_transition(SSL *s, int mt);
  79 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
  80 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
  81 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
  82 int ossl_statem_client_construct_message(SSL *s, WPACKET *pkt,
  83                                          confunc_f *confunc, int *mt);
  84 size_t ossl_statem_client_max_message_size(SSL *s);
  85 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
  86 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
  87
  88 /*
  89  * TLS/DTLS server state machine functions
  90  */
  91 int ossl_statem_server_read_transition(SSL *s, int mt);
  92 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
  93 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
  94 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
  95 int ossl_statem_server_construct_message(SSL *s, WPACKET *pkt,
  96                                          confunc_f *confunc,int *mt);
  97 size_t ossl_statem_server_max_message_size(SSL *s);
  98 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
  99 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
 100
 101 /* Functions for getting new message data */
 102 __owur int tls_get_message_header(SSL *s, int *mt);
 103 __owur int tls_get_message_body(SSL *s, size_t *len);
 104 __owur int dtls_get_message(SSL *s, int *mt, size_t *len);
 105
 106 /* Message construction and processing functions */
 107 __owur int tls_process_initial_server_flight(SSL *s, int *al);
 108 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
 109 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
 110 __owur int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
 111 __owur int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
 112
 113 __owur int tls_construct_finished(SSL *s, WPACKET *pkt);
 114 __owur int tls_construct_key_update(SSL *s, WPACKET *pkt);
 115 __owur WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst, int clearbufs);
 116 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
 117
 118 /* some client-only functions */
 119 __owur int tls_construct_client_hello(SSL *s, WPACKET *pkt);
 120 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
 121 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
 122 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
 123 __owur int tls_process_cert_status_body(SSL *s, PACKET *pkt, int *al);
 124 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
 125 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
 126 __owur int tls_construct_cert_verify(SSL *s, WPACKET *pkt);
 127 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
 128 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
 129 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
 130 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
 131 __owur int tls_client_key_exchange_post_work(SSL *s);
 132 __owur int tls_construct_cert_status_body(SSL *s, WPACKET *pkt);
 133 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
 134 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
 135 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
 136 __owur int ssl3_check_cert_and_algorithm(SSL *s);
 137 #ifndef OPENSSL_NO_NEXTPROTONEG
 138 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
 139 #endif
 140 __owur MSG_PROCESS_RETURN tls_process_hello_req(SSL *s, PACKET *pkt);
 141 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
 142
 143 /* some server-only functions */
 144 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
 145 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
 146 __owur int tls_construct_server_hello(SSL *s, WPACKET *pkt);
 147 __owur int dtls_construct_hello_verify_request(SSL *s, WPACKET *pkt);
 148 __owur int tls_construct_server_certificate(SSL *s, WPACKET *pkt);
 149 __owur int tls_construct_server_key_exchange(SSL *s, WPACKET *pkt);
 150 __owur int tls_construct_certificate_request(SSL *s, WPACKET *pkt);
 151 __owur int tls_construct_server_done(SSL *s, WPACKET *pkt);
 152 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
 153 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
 154 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
 155 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
 156 #ifndef OPENSSL_NO_NEXTPROTONEG
 157 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
 158 #endif
 159 __owur int tls_construct_new_session_ticket(SSL *s, WPACKET *pkt);
 160
 161
 162 /* Extension processing */
 163
 164 __owur int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
 165                                   RAW_EXTENSION **res, int *al);
 166 __owur int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
 167                                RAW_EXTENSION *exts,  X509 *x, size_t chainidx,
 168                                int *al);
 169 __owur int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts,
 170                                     X509 *x, size_t chainidx, int *al);
 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 #ifndef OPENSSL_NO_EC
 190 int tls_parse_ctos_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
 191                                  X509 *x, size_t chainidx, int *al);
 192 int tls_parse_ctos_supported_groups(SSL *s, PACKET *pkt, unsigned int context,
 193                                     X509 *x, size_t chainidx, int *al);
 194 #endif
 195 int tls_parse_ctos_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
 196                                   X509 *x, size_t chainidx, int *al);
 197 int tls_parse_ctos_sig_algs(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 198                             size_t chainidx, int *al);
 199 #ifndef OPENSSL_NO_OCSP
 200 int tls_parse_ctos_status_request(SSL *s, PACKET *pkt, unsigned int context,
 201                                   X509 *x, size_t chainidx, int *al);
 202 #endif
 203 #ifndef OPENSSL_NO_NEXTPROTONEG
 204 int tls_parse_ctos_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 205                        size_t chainidx, int *al);
 206 #endif
 207 int tls_parse_ctos_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 208                         size_t chainidx, int *al);
 209 #ifndef OPENSSL_NO_SRTP
 210 int tls_parse_ctos_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 211                             size_t chainidx, int *al);
 212 #endif
 213 int tls_parse_ctos_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 214                        size_t chainidx, int *al);
 215 int tls_parse_ctos_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 216                              size_t chainidx, int *al);
 217 int tls_parse_ctos_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 218                        size_t chainidx, int *al);
 219 int tls_parse_ctos_psk_kex_modes(SSL *s, PACKET *pkt, unsigned int context,
 220                                  X509 *x, size_t chainidx, int *al);
 221 int tls_parse_ctos_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 222                        size_t chainidx, int *al);
 223
 224 int tls_construct_stoc_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
 225                                    X509 *x, size_t chainidx, int *al);
 226 int tls_construct_stoc_server_name(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_session_ticket(SSL *s, WPACKET *pkt,
 284                                       unsigned int context, X509 *x,
 285                                       size_t chainidx, int *al);
 286 int tls_construct_ctos_sig_algs(SSL *s, WPACKET *pkt, unsigned int context,
 287                                 X509 *x, size_t chainidx, int *al);
 288 #ifndef OPENSSL_NO_OCSP
 289 int tls_construct_ctos_status_request(SSL *s, WPACKET *pkt,
 290                                       unsigned int context, X509 *x,
 291                                       size_t chainidx, int *al);
 292 #endif
 293 #ifndef OPENSSL_NO_NEXTPROTONEG
 294 int tls_construct_ctos_npn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 295                            size_t chainidx, int *al);
 296 #endif
 297 int tls_construct_ctos_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 298                             size_t chainidx, int *al);
 299 #ifndef OPENSSL_NO_SRTP
 300 int tls_construct_ctos_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
 301                                 X509 *x, size_t chainidx, int *al);
 302 #endif
 303 int tls_construct_ctos_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 304                            size_t chainidx, int *al);
 305 #ifndef OPENSSL_NO_CT
 306 int tls_construct_ctos_sct(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 307                            size_t chainidx, int *al);
 308 #endif
 309 int tls_construct_ctos_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 310                            size_t chainidx, int *al);
 311 int tls_construct_ctos_supported_versions(SSL *s, WPACKET *pkt,
 312                                           unsigned int context, X509 *x,
 313                                           size_t chainidx, int *al);
 314 int tls_construct_ctos_key_share(SSL *s, WPACKET *pkt, unsigned int context,
 315                                  X509 *x, size_t chainidx, int *al);
 316 int tls_construct_ctos_psk_kex_modes(SSL *s, WPACKET *pkt, unsigned int context,
 317                                      X509 *x, size_t chainidx, int *al);
 318 int tls_construct_ctos_padding(SSL *s, WPACKET *pkt, unsigned int context,
 319                                X509 *x, size_t chainidx, int *al);
 320 int tls_construct_ctos_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 321                            size_t chainidx, int *al);
 322 int tls_parse_stoc_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
 323                                X509 *x, size_t chainidx, int *al);
 324 int tls_parse_stoc_server_name(SSL *s, PACKET *pkt, unsigned int context,
 325                                X509 *x, size_t chainidx, int *al);
 326 #ifndef OPENSSL_NO_EC
 327 int tls_parse_stoc_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
 328                                  X509 *x, size_t chainidx, int *al);
 329 #endif
 330 int tls_parse_stoc_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
 331                                   X509 *x, size_t chainidx, int *al);
 332 #ifndef OPENSSL_NO_OCSP
 333 int tls_parse_stoc_status_request(SSL *s, PACKET *pkt, unsigned int context,
 334                                   X509 *x, size_t chainidx, int *al);
 335 #endif
 336 #ifndef OPENSSL_NO_CT
 337 int tls_parse_stoc_sct(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 338                        size_t chainidx, int *al);
 339 #endif
 340 #ifndef OPENSSL_NO_NEXTPROTONEG
 341 int tls_parse_stoc_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 342                        size_t chainidx, int *al);
 343 #endif
 344 int tls_parse_stoc_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 345                         size_t chainidx, int *al);
 346 #ifndef OPENSSL_NO_SRTP
 347 int tls_parse_stoc_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 348                             size_t chainidx, int *al);
 349 #endif
 350 int tls_parse_stoc_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 351                        size_t chainidx, int *al);
 352 int tls_parse_stoc_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 353                        size_t chainidx, int *al);
 354 int tls_parse_stoc_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 355                              size_t chainidx, int *al);
 356 int tls_parse_stoc_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 357                        size_t chainidx, int *al);