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 ENCRYPTED_EXTENSIONS_MAX_LENGTH 20000
  23 #define SERVER_KEY_EXCH_MAX_LENGTH      102400
  24 #define SERVER_HELLO_DONE_MAX_LENGTH    0
  25 #define CCS_MAX_LENGTH                  1
  26 /* Max should actually be 36 but we are generous */
  27 #define FINISHED_MAX_LENGTH             64
  28
  29 /* Message processing return codes */
  30 typedef enum {
  31     /* Something bad happened */
  32     MSG_PROCESS_ERROR,
  33     /* We've finished reading - swap to writing */
  34     MSG_PROCESS_FINISHED_READING,
  35     /*
  36      * We've completed the main processing of this message but there is some
  37      * post processing to be done.
  38      */
  39     MSG_PROCESS_CONTINUE_PROCESSING,
  40     /* We've finished this message - read the next message */
  41     MSG_PROCESS_CONTINUE_READING
  42 } MSG_PROCESS_RETURN;
  43
  44 /* Flush the write BIO */
  45 int statem_flush(SSL *s);
  46
  47 typedef int (*confunc_f) (SSL *s, WPACKET *pkt);
  48
  49 /*
  50  * TLS/DTLS client state machine functions
  51  */
  52 int ossl_statem_client_read_transition(SSL *s, int mt);
  53 WRITE_TRAN ossl_statem_client_write_transition(SSL *s);
  54 WORK_STATE ossl_statem_client_pre_work(SSL *s, WORK_STATE wst);
  55 WORK_STATE ossl_statem_client_post_work(SSL *s, WORK_STATE wst);
  56 int ossl_statem_client_construct_message(SSL *s, WPACKET *pkt,
  57                                          confunc_f *confunc, int *mt);
  58 size_t ossl_statem_client_max_message_size(SSL *s);
  59 MSG_PROCESS_RETURN ossl_statem_client_process_message(SSL *s, PACKET *pkt);
  60 WORK_STATE ossl_statem_client_post_process_message(SSL *s, WORK_STATE wst);
  61
  62 /*
  63  * TLS/DTLS server state machine functions
  64  */
  65 int ossl_statem_server_read_transition(SSL *s, int mt);
  66 WRITE_TRAN ossl_statem_server_write_transition(SSL *s);
  67 WORK_STATE ossl_statem_server_pre_work(SSL *s, WORK_STATE wst);
  68 WORK_STATE ossl_statem_server_post_work(SSL *s, WORK_STATE wst);
  69 int ossl_statem_server_construct_message(SSL *s, WPACKET *pkt,
  70                                          confunc_f *confunc,int *mt);
  71 size_t ossl_statem_server_max_message_size(SSL *s);
  72 MSG_PROCESS_RETURN ossl_statem_server_process_message(SSL *s, PACKET *pkt);
  73 WORK_STATE ossl_statem_server_post_process_message(SSL *s, WORK_STATE wst);
  74
  75 /* Functions for getting new message data */
  76 __owur int tls_get_message_header(SSL *s, int *mt);
  77 __owur int tls_get_message_body(SSL *s, size_t *len);
  78 __owur int dtls_get_message(SSL *s, int *mt, size_t *len);
  79
  80 /* Message construction and processing functions */
  81 __owur int tls_process_initial_server_flight(SSL *s, int *al);
  82 __owur MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt);
  83 __owur MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt);
  84 __owur int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
  85 __owur int dtls_construct_change_cipher_spec(SSL *s, WPACKET *pkt);
  86
  87 __owur int tls_construct_finished(SSL *s, WPACKET *pkt);
  88 __owur WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst);
  89 __owur WORK_STATE dtls_wait_for_dry(SSL *s);
  90
  91 int tls_collect_extensions(PACKET *packet, RAW_EXTENSION **res,
  92                              size_t *numfound, int *ad);
  93
  94 /* some client-only functions */
  95 __owur int tls_construct_client_hello(SSL *s, WPACKET *pkt);
  96 __owur MSG_PROCESS_RETURN tls_process_server_hello(SSL *s, PACKET *pkt);
  97 __owur MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s, PACKET *pkt);
  98 __owur MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s, PACKET *pkt);
  99 __owur MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, PACKET *pkt);
 100 __owur MSG_PROCESS_RETURN tls_process_server_done(SSL *s, PACKET *pkt);
 101 __owur int tls_construct_client_verify(SSL *s, WPACKET *pkt);
 102 __owur WORK_STATE tls_prepare_client_certificate(SSL *s, WORK_STATE wst);
 103 __owur int tls_construct_client_certificate(SSL *s, WPACKET *pkt);
 104 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
 105 __owur int tls_construct_client_key_exchange(SSL *s, WPACKET *pkt);
 106 __owur int tls_client_key_exchange_post_work(SSL *s);
 107 __owur int tls_construct_cert_status(SSL *s, WPACKET *pkt);
 108 __owur MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s, PACKET *pkt);
 109 __owur MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s, PACKET *pkt);
 110 __owur int ssl3_check_cert_and_algorithm(SSL *s);
 111 #ifndef OPENSSL_NO_NEXTPROTONEG
 112 __owur int tls_construct_next_proto(SSL *s, WPACKET *pkt);
 113 #endif
 114 __owur MSG_PROCESS_RETURN dtls_process_hello_verify(SSL *s, PACKET *pkt);
 115
 116 /* some server-only functions */
 117 __owur MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, PACKET *pkt);
 118 __owur WORK_STATE tls_post_process_client_hello(SSL *s, WORK_STATE wst);
 119 __owur int tls_construct_server_hello(SSL *s, WPACKET *pkt);
 120 __owur int dtls_construct_hello_verify_request(SSL *s, WPACKET *pkt);
 121 __owur int tls_construct_server_certificate(SSL *s, WPACKET *pkt);
 122 __owur int tls_construct_server_key_exchange(SSL *s, WPACKET *pkt);
 123 __owur int tls_construct_certificate_request(SSL *s, WPACKET *pkt);
 124 __owur int tls_construct_server_done(SSL *s, WPACKET *pkt);
 125 __owur MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, PACKET *pkt);
 126 __owur MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, PACKET *pkt);
 127 __owur WORK_STATE tls_post_process_client_key_exchange(SSL *s, WORK_STATE wst);
 128 __owur MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt);
 129 #ifndef OPENSSL_NO_NEXTPROTONEG
 130 __owur MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, PACKET *pkt);
 131 #endif
 132 __owur int tls_construct_new_session_ticket(SSL *s, WPACKET *pkt);