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                             int mactype,
  31                             const EVP_MD *md,
  32                             const SSL_COMP *comp);
  33
  34     int (*read_n)(OSSL_RECORD_LAYER *rl, size_t n, size_t max, int extend,
  35                   int clearold, size_t *readbytes);
  36
  37     int (*get_more_records)(OSSL_RECORD_LAYER *rl);
  38
  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     /* Returns 1 for success or 0 for error */
  48     int (*mac)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec, unsigned char *md,
  49                int sending);
  50
  51     /* Return 1 for success or 0 for error */
  52     int (*set_protocol_version)(OSSL_RECORD_LAYER *rl, int version);
  53
  54     /* Return 1 for success or 0 for error */
  55     int (*validate_record_header)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
  56
  57     /* Return 1 for success or 0 for error */
  58     int (*post_process_record)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
  59 };
  60
  61 struct ossl_record_layer_st
  62 {
  63     OSSL_LIB_CTX *libctx;
  64     const char *propq;
  65     int isdtls;
  66     int version;
  67     int role;
  68     int direction;
  69     int level;
  70     /* DTLS only */
  71     unsigned int epoch;
  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_ctx;
 134
 135     /* used for mac generation */
 136     EVP_MD_CTX *md_ctx;
 137
 138     /* uncompress */
 139     COMP_CTX *expand;
 140
 141     /* Set to 1 if this is the first handshake. 0 otherwise */
 142     int is_first_handshake;
 143
 144     /* The negotiated maximum fragment length */
 145     unsigned int max_frag_len;
 146
 147     /* The maxium amount of early data we can receive/send */
 148     uint32_t max_early_data;
 149
 150     /* The amount of early data that we have sent/received */
 151     size_t early_data_count;
 152
 153     /* Only used by SSLv3 */
 154     unsigned char mac_secret[EVP_MAX_MD_SIZE];
 155
 156     /* TLSv1.0/TLSv1.1/TLSv1.2 */
 157     int use_etm;
 158
 159     /* Flags for GOST ciphers */
 160     int stream_mac;
 161     int tlstree;
 162
 163     /* TLSv1.3 fields */
 164     /* static IV */
 165     unsigned char iv[EVP_MAX_IV_LENGTH];
 166     /* static read IV */
 167     unsigned char read_iv[EVP_MAX_IV_LENGTH];
 168     int allow_plain_alerts;
 169
 170     /* TLS "any" fields */
 171     /* Set to true if this is the first record in a connection */
 172     unsigned int is_first_record;
 173
 174     size_t taglen;
 175
 176     /* DTLS received handshake records (processed and unprocessed) */
 177     record_pqueue unprocessed_rcds;
 178     record_pqueue processed_rcds;
 179
 180     /* records being received in the current epoch */
 181     DTLS1_BITMAP bitmap;
 182     /* renegotiation starts a new set of sequence numbers */
 183     DTLS1_BITMAP next_bitmap;
 184
 185     /*
 186      * Whether we are currently in a hanshake or not. Only maintained for DTLS
 187      */
 188     int in_init;
 189
 190     /* Callbacks */
 191     void *cbarg;
 192     OSSL_FUNC_rlayer_skip_early_data_fn *skip_early_data;
 193     OSSL_FUNC_rlayer_msg_callback_fn *msg_callback;
 194     OSSL_FUNC_rlayer_security_fn *security;
 195
 196     size_t max_pipelines;
 197
 198     /* Function pointers for version specific functions */
 199     struct record_functions_st *funcs;
 200 };
 201
 202 typedef struct dtls_rlayer_record_data_st {
 203     unsigned char *packet;
 204     size_t packet_length;
 205     SSL3_BUFFER rbuf;
 206     SSL3_RECORD rrec;
 207 } DTLS_RLAYER_RECORD_DATA;
 208
 209
 210 extern struct record_functions_st ssl_3_0_funcs;
 211 extern struct record_functions_st tls_1_funcs;
 212 extern struct record_functions_st tls_1_3_funcs;
 213 extern struct record_functions_st tls_any_funcs;
 214 extern struct record_functions_st dtls_1_funcs;
 215 extern struct record_functions_st dtls_any_funcs;
 216
 217 void ossl_rlayer_fatal(OSSL_RECORD_LAYER *rl, int al, int reason,
 218                        const char *fmt, ...);
 219
 220 # define RLAYERfatal(rl, al, r) RLAYERfatal_data((rl), (al), (r), NULL)
 221 # define RLAYERfatal_data                                          \
 222     (ERR_new(),                                                    \
 223      ERR_set_debug(OPENSSL_FILE, OPENSSL_LINE, OPENSSL_FUNC),      \
 224      ossl_rlayer_fatal)
 225
 226 # define RLAYER_USE_EXPLICIT_IV(rl) ((rl)->version == TLS1_1_VERSION \
 227                                      || (rl)->version == TLS1_2_VERSION \
 228                                      || (rl)->isdtls)
 229
 230 int ossl_set_tls_provider_parameters(OSSL_RECORD_LAYER *rl,
 231                                      EVP_CIPHER_CTX *ctx,
 232                                      const EVP_CIPHER *ciph,
 233                                      const EVP_MD *md);
 234 /* ssl3_cbc.c */
 235 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
 236 __owur int ssl3_cbc_digest_record(const EVP_MD *md,
 237                                   unsigned char *md_out,
 238                                   size_t *md_out_size,
 239                                   const unsigned char *header,
 240                                   const unsigned char *data,
 241                                   size_t data_size,
 242                                   size_t data_plus_mac_plus_padding_size,
 243                                   const unsigned char *mac_secret,
 244                                   size_t mac_secret_length, char is_sslv3);
 245
 246 int tls_default_read_n(OSSL_RECORD_LAYER *rl, size_t n, size_t max, int extend,
 247                        int clearold, size_t *readbytes);
 248 int tls_get_more_records(OSSL_RECORD_LAYER *rl);
 249 int dtls_get_more_records(OSSL_RECORD_LAYER *rl);
 250
 251 int tls_default_set_protocol_version(OSSL_RECORD_LAYER *rl, int version);
 252 int tls_default_validate_record_header(OSSL_RECORD_LAYER *rl, SSL3_RECORD *re);
 253 int tls_do_uncompress(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
 254 int tls_default_post_process_record(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
 255 int tls13_common_post_process_record(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
 256
 257 int
 258 tls_int_new_record_layer(OSSL_LIB_CTX *libctx, const char *propq, int vers,
 259                          int role, int direction, int level, unsigned char *key,
 260                          size_t keylen, unsigned char *iv, size_t ivlen,
 261                          unsigned char *mackey, size_t mackeylen,
 262                          const EVP_CIPHER *ciph, size_t taglen,
 263                          int mactype,
 264                          const EVP_MD *md, const SSL_COMP *comp, BIO *prev,
 265                          BIO *transport, BIO *next,
 266                          BIO_ADDR *local, BIO_ADDR *peer,
 267                          const OSSL_PARAM *settings, const OSSL_PARAM *options,
 268                          const OSSL_DISPATCH *fns, void *cbarg,
 269                          OSSL_RECORD_LAYER **retrl);
 270 int tls_free(OSSL_RECORD_LAYER *rl);
 271 int tls_reset(OSSL_RECORD_LAYER *rl);
 272 int tls_unprocessed_read_pending(OSSL_RECORD_LAYER *rl);
 273 int tls_processed_read_pending(OSSL_RECORD_LAYER *rl);
 274 size_t tls_app_data_pending(OSSL_RECORD_LAYER *rl);
 275 int tls_write_pending(OSSL_RECORD_LAYER *rl);
 276 size_t tls_get_max_record_len(OSSL_RECORD_LAYER *rl);
 277 size_t tls_get_max_records(OSSL_RECORD_LAYER *rl);
 278 int tls_write_records(OSSL_RECORD_LAYER *rl, OSSL_RECORD_TEMPLATE **templates,
 279                       size_t numtempl,  size_t allowance, size_t *sent);
 280 int tls_retry_write_records(OSSL_RECORD_LAYER *rl, size_t allowance,
 281                             size_t *sent);
 282 int tls_get_alert_code(OSSL_RECORD_LAYER *rl);
 283 int tls_set1_bio(OSSL_RECORD_LAYER *rl, BIO *bio);
 284 int tls_read_record(OSSL_RECORD_LAYER *rl, void **rechandle,  int *rversion,
 285                     int *type, unsigned char **data, size_t *datalen,
 286                     uint16_t *epoch, unsigned char *seq_num);
 287 int tls_release_record(OSSL_RECORD_LAYER *rl, void *rechandle);
 288 int tls_default_set_protocol_version(OSSL_RECORD_LAYER *rl, int version);
 289 int tls_set_protocol_version(OSSL_RECORD_LAYER *rl, int version);
 290 void tls_set_plain_alerts(OSSL_RECORD_LAYER *rl, int allow);
 291 void tls_set_first_handshake(OSSL_RECORD_LAYER *rl, int first);
 292 void tls_set_max_pipelines(OSSL_RECORD_LAYER *rl, size_t max_pipelines);
 293 int rlayer_setup_read_buffer(OSSL_RECORD_LAYER *rl);