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 WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst, int clearbufs);
 115 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
 116
 117 /* some client-only functions */
 118 __owur int tls_construct_client_hello(SSL *s, WPACKET *pkt);
 119 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
 120 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
 121 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
 122 __owur int tls_process_cert_status_body(SSL *s, PACKET *pkt, int *al);
 123 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
 124 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
 125 __owur int tls_construct_cert_verify(SSL *s, WPACKET *pkt);
 126 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
 127 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
 128 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
 129 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
 130 __owur int tls_client_key_exchange_post_work(SSL *s);
 131 __owur int tls_construct_cert_status_body(SSL *s, WPACKET *pkt);
 132 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
 133 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
 134 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
 135 __owur int ssl3_check_cert_and_algorithm(SSL *s);
 136 #ifndef OPENSSL_NO_NEXTPROTONEG
 137 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
 138 #endif
 139 __owur MSG_PROCESS_RETURN tls_process_hello_req(SSL *s, PACKET *pkt);
 140 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
 141
 142 /* some server-only functions */
 143 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
 144 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
 145 __owur int tls_construct_server_hello(SSL *s, WPACKET *pkt);
 146 __owur int dtls_construct_hello_verify_request(SSL *s, WPACKET *pkt);
 147 __owur int tls_construct_server_certificate(SSL *s, WPACKET *pkt);
 148 __owur int tls_construct_server_key_exchange(SSL *s, WPACKET *pkt);
 149 __owur int tls_construct_certificate_request(SSL *s, WPACKET *pkt);
 150 __owur int tls_construct_server_done(SSL *s, WPACKET *pkt);
 151 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
 152 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
 153 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
 154 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
 155 #ifndef OPENSSL_NO_NEXTPROTONEG
 156 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
 157 #endif
 158 __owur int tls_construct_new_session_ticket(SSL *s, WPACKET *pkt);
 159
 160
 161 /* Extension processing */
 162
 163 __owur int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
 164                                   RAW_EXTENSION **res, int *al);
 165 __owur int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
 166                                RAW_EXTENSION *exts,  X509 *x, size_t chainidx,
 167                                int *al);
 168 __owur int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts,
 169                                     X509 *x, size_t chainidx, int *al);
 170 __owur int tls_construct_extensions(SSL *s, WPACKET *pkt, unsigned int context,
 171                                     X509 *x, size_t chainidx, int *al);
 172
 173 __owur int tls_psk_do_binder(SSL *s, const EVP_MD *md,
 174                              const unsigned char *msgstart,
 175                              size_t binderoffset, const unsigned char *binderin,
 176                              unsigned char *binderout,
 177                              SSL_SESSION *sess, int sign);
 178
 179 /* Server Extension processing */
 180 int tls_parse_ctos_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
 181                                X509 *x, size_t chainidx, int *al);
 182 int tls_parse_ctos_server_name(SSL *s, PACKET *pkt, unsigned int context,
 183                                X509 *x, size_t chainidx, int *al);
 184 #ifndef OPENSSL_NO_SRP
 185 int tls_parse_ctos_srp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 186                        size_t chainidx, int *al);
 187 #endif
 188 #ifndef OPENSSL_NO_EC
 189 int tls_parse_ctos_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
 190                                  X509 *x, size_t chainidx, int *al);
 191 int tls_parse_ctos_supported_groups(SSL *s, PACKET *pkt, unsigned int context,
 192                                     X509 *x, size_t chainidx, int *al);
 193 #endif
 194 int tls_parse_ctos_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
 195                                   X509 *x, size_t chainidx, int *al);
 196 int tls_parse_ctos_sig_algs(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 197                             size_t chainidx, int *al);
 198 #ifndef OPENSSL_NO_OCSP
 199 int tls_parse_ctos_status_request(SSL *s, PACKET *pkt, unsigned int context,
 200                                   X509 *x, size_t chainidx, int *al);
 201 #endif
 202 #ifndef OPENSSL_NO_NEXTPROTONEG
 203 int tls_parse_ctos_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 204                        size_t chainidx, int *al);
 205 #endif
 206 int tls_parse_ctos_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 207                         size_t chainidx, int *al);
 208 #ifndef OPENSSL_NO_SRTP
 209 int tls_parse_ctos_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 210                             size_t chainidx, int *al);
 211 #endif
 212 int tls_parse_ctos_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 213                        size_t chainidx, int *al);
 214 int tls_parse_ctos_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 215                              size_t chainidx, int *al);
 216 int tls_parse_ctos_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 217                        size_t chainidx, int *al);
 218 int tls_parse_ctos_psk_kex_modes(SSL *s, PACKET *pkt, unsigned int context,
 219                                  X509 *x, size_t chainidx, int *al);
 220 int tls_parse_ctos_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 221                        size_t chainidx, int *al);
 222
 223 int tls_construct_stoc_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
 224                                    X509 *x, size_t chainidx, int *al);
 225 int tls_construct_stoc_server_name(SSL *s, WPACKET *pkt, unsigned int context,
 226                                    X509 *x, size_t chainidx, int *al);
 227 #ifndef OPENSSL_NO_EC
 228 int tls_construct_stoc_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
 229                                      X509 *x, size_t chainidx, int *al);
 230 #endif
 231 int tls_construct_stoc_session_ticket(SSL *s, WPACKET *pkt,
 232                                       unsigned int context, X509 *x,
 233                                       size_t chainidx, int *al);
 234 #ifndef OPENSSL_NO_OCSP
 235 int tls_construct_stoc_status_request(SSL *s, WPACKET *pkt,
 236                                       unsigned int context, X509 *x,
 237                                       size_t chainidx, int *al);
 238 #endif
 239 #ifndef OPENSSL_NO_NEXTPROTONEG
 240 int tls_construct_stoc_next_proto_neg(SSL *s, WPACKET *pkt,
 241                                       unsigned int context, X509 *x,
 242                                       size_t chainidx, int *al);
 243 #endif
 244 int tls_construct_stoc_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 245                             size_t chainidx, int *al);
 246 #ifndef OPENSSL_NO_SRTP
 247 int tls_construct_stoc_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
 248                                 X509 *x, size_t chainidx, int *al);
 249 #endif
 250 int tls_construct_stoc_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 251                            size_t chainidx, int *al);
 252 int tls_construct_stoc_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 253                            size_t chainidx, int *al);
 254 int tls_construct_stoc_key_share(SSL *s, WPACKET *pkt, unsigned int context,
 255                                  X509 *x, size_t chainidx, int *al);
 256 /*
 257  * Not in public headers as this is not an official extension. Only used when
 258  * SSL_OP_CRYPTOPRO_TLSEXT_BUG is set.
 259  */
 260 #define TLSEXT_TYPE_cryptopro_bug      0xfde8
 261 int tls_construct_stoc_cryptopro_bug(SSL *s, WPACKET *pkt, unsigned int context,
 262                                      X509 *x, size_t chainidx, int *al);
 263 int tls_construct_stoc_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 264                            size_t chainidx, int *al);
 265
 266 /* Client Extension processing */
 267 int tls_construct_ctos_renegotiate(SSL *s, WPACKET *pkt, unsigned int context,
 268                                    X509 *x, size_t chainidx, int *al);
 269 int tls_construct_ctos_server_name(SSL *s, WPACKET *pkt, unsigned int context,
 270                                    X509 *x, size_t chainidx, int *al);
 271 #ifndef OPENSSL_NO_SRP
 272 int tls_construct_ctos_srp(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 273                            size_t chainidx, int *al);
 274 #endif
 275 #ifndef OPENSSL_NO_EC
 276 int tls_construct_ctos_ec_pt_formats(SSL *s, WPACKET *pkt, unsigned int context,
 277                                      X509 *x, size_t chainidx, int *al);
 278 int tls_construct_ctos_supported_groups(SSL *s, WPACKET *pkt,
 279                                         unsigned int context, X509 *x,
 280                                         size_t chainidx, int *al);
 281 #endif
 282 int tls_construct_ctos_session_ticket(SSL *s, WPACKET *pkt,
 283                                       unsigned int context, X509 *x,
 284                                       size_t chainidx, int *al);
 285 int tls_construct_ctos_sig_algs(SSL *s, WPACKET *pkt, unsigned int context,
 286                                 X509 *x, size_t chainidx, int *al);
 287 #ifndef OPENSSL_NO_OCSP
 288 int tls_construct_ctos_status_request(SSL *s, WPACKET *pkt,
 289                                       unsigned int context, X509 *x,
 290                                       size_t chainidx, int *al);
 291 #endif
 292 #ifndef OPENSSL_NO_NEXTPROTONEG
 293 int tls_construct_ctos_npn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 294                            size_t chainidx, int *al);
 295 #endif
 296 int tls_construct_ctos_alpn(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 297                             size_t chainidx, int *al);
 298 #ifndef OPENSSL_NO_SRTP
 299 int tls_construct_ctos_use_srtp(SSL *s, WPACKET *pkt, unsigned int context,
 300                                 X509 *x, size_t chainidx, int *al);
 301 #endif
 302 int tls_construct_ctos_etm(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 303                            size_t chainidx, int *al);
 304 #ifndef OPENSSL_NO_CT
 305 int tls_construct_ctos_sct(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 306                            size_t chainidx, int *al);
 307 #endif
 308 int tls_construct_ctos_ems(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 309                            size_t chainidx, int *al);
 310 int tls_construct_ctos_supported_versions(SSL *s, WPACKET *pkt,
 311                                           unsigned int context, X509 *x,
 312                                           size_t chainidx, int *al);
 313 int tls_construct_ctos_key_share(SSL *s, WPACKET *pkt, unsigned int context,
 314                                  X509 *x, size_t chainidx, int *al);
 315 int tls_construct_ctos_psk_kex_modes(SSL *s, WPACKET *pkt, unsigned int context,
 316                                      X509 *x, size_t chainidx, int *al);
 317 int tls_construct_ctos_padding(SSL *s, WPACKET *pkt, unsigned int context,
 318                                X509 *x, size_t chainidx, int *al);
 319 int tls_construct_ctos_psk(SSL *s, WPACKET *pkt, unsigned int context, X509 *x,
 320                            size_t chainidx, int *al);
 321 int tls_parse_stoc_renegotiate(SSL *s, PACKET *pkt, unsigned int context,
 322                                X509 *x, size_t chainidx, int *al);
 323 int tls_parse_stoc_server_name(SSL *s, PACKET *pkt, unsigned int context,
 324                                X509 *x, size_t chainidx, int *al);
 325 #ifndef OPENSSL_NO_EC
 326 int tls_parse_stoc_ec_pt_formats(SSL *s, PACKET *pkt, unsigned int context,
 327                                  X509 *x, size_t chainidx, int *al);
 328 #endif
 329 int tls_parse_stoc_session_ticket(SSL *s, PACKET *pkt, unsigned int context,
 330                                   X509 *x, size_t chainidx, int *al);
 331 #ifndef OPENSSL_NO_OCSP
 332 int tls_parse_stoc_status_request(SSL *s, PACKET *pkt, unsigned int context,
 333                                   X509 *x, size_t chainidx, int *al);
 334 #endif
 335 #ifndef OPENSSL_NO_CT
 336 int tls_parse_stoc_sct(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 337                        size_t chainidx, int *al);
 338 #endif
 339 #ifndef OPENSSL_NO_NEXTPROTONEG
 340 int tls_parse_stoc_npn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 341                        size_t chainidx, int *al);
 342 #endif
 343 int tls_parse_stoc_alpn(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 344                         size_t chainidx, int *al);
 345 #ifndef OPENSSL_NO_SRTP
 346 int tls_parse_stoc_use_srtp(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 347                             size_t chainidx, int *al);
 348 #endif
 349 int tls_parse_stoc_etm(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 350                        size_t chainidx, int *al);
 351 int tls_parse_stoc_ems(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 352                        size_t chainidx, int *al);
 353 int tls_parse_stoc_key_share(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 354                              size_t chainidx, int *al);
 355 int tls_parse_stoc_psk(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
 356                        size_t chainidx, int *al);