ssl/record/methods/recmethod_local.h

   1 /*
   2  * Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (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 #include <openssl/bio.h>
  11 #include <openssl/ssl.h>
  12 #include <openssl/err.h>
  13 #include "../../ssl_local.h"
  14 #include "../record_local.h"
  15
  16 /* Protocol version specific function pointers */
  17 struct record_functions_st
  18 {
  19     /*
  20      * Returns either OSSL_RECORD_RETURN_SUCCESS, OSSL_RECORD_RETURN_FATAL or
  21      * OSSL_RECORD_RETURN_NON_FATAL_ERR if we can keep trying to find an
  22      * alternative record layer.
  23      */
  24     int (*set_crypto_state)(OSSL_RECORD_LAYER *rl, int level,
  25                             unsigned char *key, size_t keylen,
  26                             unsigned char *iv, size_t ivlen,
  27                             unsigned char *mackey, size_t mackeylen,
  28                             const EVP_CIPHER *ciph,
  29                             size_t taglen,
  30                             /* TODO(RECLAYER): This probably should not be an int */
  31                             int mactype,
  32                             const EVP_MD *md,
  33                             const SSL_COMP *comp,
  34                             /* TODO(RECLAYER): Remove me */
  35                             SSL_CONNECTION *s);
  36
  37     int (*read_n)(OSSL_RECORD_LAYER *rl, size_t n, size_t max, int extend,
  38                   int clearold, size_t *readbytes);
  39     /*
  40      * Returns:
  41      *    0: if the record is publicly invalid, or an internal error, or AEAD
  42      *       decryption failed, or EtM decryption failed.
  43      *    1: Success or MtE decryption failed (MAC will be randomised)
  44      */
  45     int (*cipher)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *recs, size_t n_recs,
  46                   int sending, SSL_MAC_BUF *macs, size_t macsize,
  47                   /* TODO(RECLAYER): Remove me */ SSL_CONNECTION *s);
  48     /* Returns 1 for success or 0 for error */
  49     int (*mac)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec, unsigned char *md,
  50                int sending, /* TODO(RECLAYER): Remove me */SSL_CONNECTION *ssl);
  51
  52     /* Return 1 for success or 0 for error */
  53     int (*set_protocol_version)(OSSL_RECORD_LAYER *rl, int version);
  54
  55     /* Return 1 for success or 0 for error */
  56     int (*validate_record_header)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
  57
  58     /* Return 1 for success or 0 for error */
  59     int (*post_process_record)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec,
  60                                /* TODO(RECLAYER): Remove me */ SSL_CONNECTION *s);
  61 };
  62
  63 struct ossl_record_layer_st
  64 {
  65     OSSL_LIB_CTX *libctx;
  66     const char *propq;
  67     int isdtls;
  68     int version;
  69     int role;
  70     int direction;
  71     int level;
  72
  73     /*
  74      * A BIO containing any data read in the previous epoch that was destined
  75      * for this epoch
  76      */
  77     BIO *prev;
  78
  79     /* The transport BIO */
  80     BIO *bio;
  81
  82     /*
  83      * A BIO where we will send any data read by us that is destined for the
  84      * next epoch.
  85      */
  86     BIO *next;
  87
  88     /* Types match the equivalent structures in the SSL object */
  89     uint64_t options;
  90     /*
  91      * TODO(RECLAYER): Should we take the opportunity to make this uint64_t
  92      * even though upper layer continue to use uint32_t?
  93      */
  94     uint32_t mode;
  95
  96     /* read IO goes into here */
  97     SSL3_BUFFER rbuf;
  98     /* each decoded record goes in here */
  99     SSL3_RECORD rrec[SSL_MAX_PIPELINES];
 100
 101     /* How many records have we got available in the rrec bufer */
 102     size_t num_recs;
 103
 104     /* The record number in the rrec buffer that can be read next */
 105     size_t curr_rec;
 106
 107     /* The number of records that have been released via tls_release_record */
 108     size_t num_released;
 109
 110     /* where we are when reading */
 111     int rstate;
 112
 113     /* used internally to point at a raw packet */
 114     unsigned char *packet;
 115     size_t packet_length;
 116
 117     /* Sequence number for the next record */
 118     unsigned char sequence[SEQ_NUM_SIZE];
 119
 120     int alert;
 121
 122     /*
 123      * Read as many input bytes as possible (for
 124      * non-blocking reads)
 125      * TODO(RECLAYER): Why isn't this just an option?
 126      */
 127     int read_ahead;
 128
 129     /* The number of consecutive empty records we have received */
 130     size_t empty_record_count;
 131
 132     /* cryptographic state */
 133     EVP_CIPHER_CTX *enc_read_ctx;
 134
 135     /* used for mac generation */
 136     EVP_MD_CTX *read_hash;
 137     /* uncompress */
 138     COMP_CTX *expand;
 139
 140     /* Set to 1 if this is the first handshake. 0 otherwise */
 141     int is_first_handshake;
 142
 143     /* The negotiated maximum fragment length */
 144     unsigned int max_frag_len;
 145
 146     /* The maxium amount of early data we can receive/send */
 147     uint32_t max_early_data;
 148
 149     /* The amount of early data that we have sent/received */
 150     size_t early_data_count;
 151
 152     /* Only used by SSLv3 */
 153     unsigned char mac_secret[EVP_MAX_MD_SIZE];
 154
 155     /* TLSv1.0/TLSv1.1/TLSv1.2 */
 156     int use_etm;
 157
 158     /* TLSv1.3 fields */
 159     /* static IV */
 160     unsigned char iv[EVP_MAX_IV_LENGTH];
 161     /* static read IV */
 162     unsigned char read_iv[EVP_MAX_IV_LENGTH];
 163     int allow_plain_alerts;
 164
 165     /* TLS "any" fields */
 166     /* Set to true if this is the first record in a connection */
 167     unsigned int is_first_record;
 168
 169     size_t taglen;
 170
 171     /* Callbacks */
 172     void *cbarg;
 173     OSSL_FUNC_rlayer_skip_early_data_fn *rlayer_skip_early_data;
 174
 175     /* Function pointers for version specific functions */
 176     struct record_functions_st *funcs;
 177 };
 178
 179 extern struct record_functions_st ssl_3_0_funcs;
 180 extern struct record_functions_st tls_1_funcs;
 181 extern struct record_functions_st tls_1_3_funcs;
 182 extern struct record_functions_st tls_any_funcs;
 183
 184 void ossl_rlayer_fatal(OSSL_RECORD_LAYER *rl, int al, int reason,
 185                        const char *fmt, ...);
 186
 187 # define RLAYERfatal(rl, al, r) RLAYERfatal_data((rl), (al), (r), NULL)
 188 # define RLAYERfatal_data                                          \
 189     (ERR_new(),                                                    \
 190      ERR_set_debug(OPENSSL_FILE, OPENSSL_LINE, OPENSSL_FUNC),      \
 191      ossl_rlayer_fatal)
 192
 193 # define RLAYER_USE_EXPLICIT_IV(rl) ((rl)->version == TLS1_1_VERSION \
 194                                      || (rl)->version == TLS1_2_VERSION)
 195
 196 int ossl_set_tls_provider_parameters(OSSL_RECORD_LAYER *rl,
 197                                      EVP_CIPHER_CTX *ctx,
 198                                      const EVP_CIPHER *ciph,
 199                                      const EVP_MD *md);
 200 /* ssl3_cbc.c */
 201 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
 202 __owur int ssl3_cbc_digest_record(const EVP_MD *md,
 203                                   unsigned char *md_out,
 204                                   size_t *md_out_size,
 205                                   const unsigned char *header,
 206                                   const unsigned char *data,
 207                                   size_t data_size,
 208                                   size_t data_plus_mac_plus_padding_size,
 209                                   const unsigned char *mac_secret,
 210                                   size_t mac_secret_length, char is_sslv3);
 211
 212 int tls_default_read_n(OSSL_RECORD_LAYER *rl, size_t n, size_t max, int extend,
 213                        int clearold, size_t *readbytes);
 214
 215 int tls_default_set_protocol_version(OSSL_RECORD_LAYER *rl, int version);
 216 int tls_default_validate_record_header(OSSL_RECORD_LAYER *rl, SSL3_RECORD *re);
 217 int tls_default_post_process_record(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec, SSL_CONNECTION *s);
 218 int tls13_common_post_process_record(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec,
 219                                      SSL_CONNECTION *s);
 220
 221 int
 222 tls_int_new_record_layer(OSSL_LIB_CTX *libctx, const char *propq, int vers,
 223                          int role, int direction, int level, unsigned char *key,
 224                          size_t keylen, unsigned char *iv, size_t ivlen,
 225                          unsigned char *mackey, size_t mackeylen,
 226                          const EVP_CIPHER *ciph, size_t taglen,
 227                          /* TODO(RECLAYER): This probably should not be an int */
 228                          int mactype,
 229                          const EVP_MD *md, const SSL_COMP *comp, BIO *prev,
 230                          BIO *transport, BIO *next,
 231                          BIO_ADDR *local, BIO_ADDR *peer,
 232                          const OSSL_PARAM *settings, const OSSL_PARAM *options,
 233                          const OSSL_DISPATCH *fns, void *cbarg,
 234                          OSSL_RECORD_LAYER **retrl,
 235                          /* TODO(RECLAYER): Remove me */
 236                          SSL_CONNECTION *s);
 237 int tls_free(OSSL_RECORD_LAYER *rl);
 238 int tls_reset(OSSL_RECORD_LAYER *rl);
 239 int tls_unprocessed_read_pending(OSSL_RECORD_LAYER *rl);
 240 int tls_processed_read_pending(OSSL_RECORD_LAYER *rl);
 241 size_t tls_app_data_pending(OSSL_RECORD_LAYER *rl);
 242 int tls_write_pending(OSSL_RECORD_LAYER *rl);
 243 size_t tls_get_max_record_len(OSSL_RECORD_LAYER *rl);
 244 size_t tls_get_max_records(OSSL_RECORD_LAYER *rl);
 245 int tls_write_records(OSSL_RECORD_LAYER *rl, OSSL_RECORD_TEMPLATE **templates,
 246                       size_t numtempl,  size_t allowance, size_t *sent);
 247 int tls_retry_write_records(OSSL_RECORD_LAYER *rl, size_t allowance,
 248                             size_t *sent);
 249 int tls_get_alert_code(OSSL_RECORD_LAYER *rl);
 250 int tls_set1_bio(OSSL_RECORD_LAYER *rl, BIO *bio);
 251 int tls_read_record(OSSL_RECORD_LAYER *rl, void **rechandle,  int *rversion,
 252                     int *type, unsigned char **data, size_t *datalen,
 253                     uint16_t *epoch, unsigned char *seq_num,
 254                     /* TODO(RECLAYER): Remove me */ SSL_CONNECTION *s);
 255 int tls_release_record(OSSL_RECORD_LAYER *rl, void *rechandle);
 256 int tls_default_set_protocol_version(OSSL_RECORD_LAYER *rl, int version);
 257 int tls_set_protocol_version(OSSL_RECORD_LAYER *rl, int version);
 258 void tls_set_plain_alerts(OSSL_RECORD_LAYER *rl, int allow);
 259 void tls_set_first_handshake(OSSL_RECORD_LAYER *rl, int first);
 260 SSL3_BUFFER *tls_get0_rbuf(OSSL_RECORD_LAYER *rl);
 261 unsigned char *tls_get0_packet(OSSL_RECORD_LAYER *rl);
 262 void tls_set0_packet(OSSL_RECORD_LAYER *rl, unsigned char *packet,
 263                      size_t packetlen);
 264 size_t tls_get_packet_length(OSSL_RECORD_LAYER *rl);
 265 void tls_reset_packet_length(OSSL_RECORD_LAYER *rl);