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 typedef struct dtls_bitmap_st {
  17     /* Track 64 packets */
  18     uint64_t map;
  19     /* Max record number seen so far, 64-bit value in big-endian encoding */
  20     unsigned char max_seq_num[SEQ_NUM_SIZE];
  21 } DTLS_BITMAP;
  22
  23 /* Protocol version specific function pointers */
  24 struct record_functions_st
  25 {
  26     /*
  27      * Returns either OSSL_RECORD_RETURN_SUCCESS, OSSL_RECORD_RETURN_FATAL or
  28      * OSSL_RECORD_RETURN_NON_FATAL_ERR if we can keep trying to find an
  29      * alternative record layer.
  30      */
  31     int (*set_crypto_state)(OSSL_RECORD_LAYER *rl, int level,
  32                             unsigned char *key, size_t keylen,
  33                             unsigned char *iv, size_t ivlen,
  34                             unsigned char *mackey, size_t mackeylen,
  35                             const EVP_CIPHER *ciph,
  36                             size_t taglen,
  37                             int mactype,
  38                             const EVP_MD *md,
  39                             const SSL_COMP *comp);
  40
  41     int (*read_n)(OSSL_RECORD_LAYER *rl, size_t n, size_t max, int extend,
  42                   int clearold, size_t *readbytes);
  43
  44     int (*get_more_records)(OSSL_RECORD_LAYER *rl);
  45
  46     /*
  47      * Returns:
  48      *    0: if the record is publicly invalid, or an internal error, or AEAD
  49      *       decryption failed, or EtM decryption failed.
  50      *    1: Success or MtE decryption failed (MAC will be randomised)
  51      */
  52     int (*cipher)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *recs, size_t n_recs,
  53                   int sending, SSL_MAC_BUF *macs, size_t macsize);
  54     /* Returns 1 for success or 0 for error */
  55     int (*mac)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec, unsigned char *md,
  56                int sending);
  57
  58     /* Return 1 for success or 0 for error */
  59     int (*set_protocol_version)(OSSL_RECORD_LAYER *rl, int version);
  60
  61     /* Return 1 for success or 0 for error */
  62     int (*validate_record_header)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
  63
  64     /* Return 1 for success or 0 for error */
  65     int (*post_process_record)(OSSL_RECORD_LAYER *rl, SSL3_RECORD *rec);
  66 };
  67
  68 struct ossl_record_layer_st
  69 {
  70     OSSL_LIB_CTX *libctx;
  71     const char *propq;
  72     int isdtls;
  73     int version;
  74     int role;
  75     int direction;
  76     int level;
  77     /* DTLS only */
  78     uint16_t epoch;
  79
  80     /*
  81      * A BIO containing any data read in the previous epoch that was destined
  82      * for this epoch
  83      */
  84     BIO *prev;
  85
  86     /* The transport BIO */
  87     BIO *bio;
  88
  89     /*
  90      * A BIO where we will send any data read by us that is destined for the
  91      * next epoch.
  92      */
  93     BIO *next;
  94
  95     /* Types match the equivalent fields in the SSL object */
  96     uint64_t options;
  97     uint32_t mode;
  98
  99     /* read IO goes into here */
 100     SSL3_BUFFER rbuf;
 101     /* each decoded record goes in here */
 102     SSL3_RECORD rrec[SSL_MAX_PIPELINES];
 103
 104     /* How many records have we got available in the rrec bufer */
 105     size_t num_recs;
 106
 107     /* The record number in the rrec buffer that can be read next */
 108     size_t curr_rec;
 109
 110     /* The number of records that have been released via tls_release_record */
 111     size_t num_released;
 112
 113     /* where we are when reading */
 114     int rstate;
 115
 116     /* used internally to point at a raw packet */
 117     unsigned char *packet;
 118     size_t packet_length;
 119
 120     /* Sequence number for the next record */
 121     unsigned char sequence[SEQ_NUM_SIZE];
 122
 123     int alert;
 124
 125     /*
 126      * Read as many input bytes as possible (for non-blocking reads)
 127      */
 128     int read_ahead;
 129
 130     /* The number of consecutive empty records we have received */
 131     size_t empty_record_count;
 132
 133     /* cryptographic state */
 134     EVP_CIPHER_CTX *enc_ctx;
 135
 136     /* used for mac generation */
 137     EVP_MD_CTX *md_ctx;
 138
 139     /* uncompress */
 140     COMP_CTX *expand;
 141
 142     /* Set to 1 if this is the first handshake. 0 otherwise */
 143     int is_first_handshake;
 144
 145     /* The negotiated maximum fragment length */
 146     unsigned int max_frag_len;
 147
 148     /* The maxium amount of early data we can receive/send */
 149     uint32_t max_early_data;
 150
 151     /* The amount of early data that we have sent/received */
 152     size_t early_data_count;
 153
 154     /* Only used by SSLv3 */
 155     unsigned char mac_secret[EVP_MAX_MD_SIZE];
 156
 157     /* TLSv1.0/TLSv1.1/TLSv1.2 */
 158     int use_etm;
 159
 160     /* Flags for GOST ciphers */
 161     int stream_mac;
 162     int tlstree;
 163
 164     /* TLSv1.3 fields */
 165     /* static IV */
 166     unsigned char iv[EVP_MAX_IV_LENGTH];
 167     /* static read IV */
 168     unsigned char read_iv[EVP_MAX_IV_LENGTH];
 169     int allow_plain_alerts;
 170
 171     /* TLS "any" fields */
 172     /* Set to true if this is the first record in a connection */
 173     unsigned int is_first_record;
 174
 175     size_t taglen;
 176
 177     /* DTLS received handshake records (processed and unprocessed) */
 178     record_pqueue unprocessed_rcds;
 179     record_pqueue processed_rcds;
 180
 181     /* records being received in the current epoch */
 182     DTLS_BITMAP bitmap;
 183     /* renegotiation starts a new set of sequence numbers */
 184     DTLS_BITMAP next_bitmap;
 185
 186     /*
 187      * Whether we are currently in a hanshake or not. Only maintained for DTLS
 188      */
 189     int in_init;
 190
 191     /* Callbacks */
 192     void *cbarg;
 193     OSSL_FUNC_rlayer_skip_early_data_fn *skip_early_data;
 194     OSSL_FUNC_rlayer_msg_callback_fn *msg_callback;
 195     OSSL_FUNC_rlayer_security_fn *security;
 196
 197     size_t max_pipelines;
 198
 199     /* Function pointers for version specific functions */
 200     struct record_functions_st *funcs;
 201 };
 202
 203 typedef struct dtls_rlayer_record_data_st {
 204     unsigned char *packet;
 205     size_t packet_length;
 206     SSL3_BUFFER rbuf;
 207     SSL3_RECORD rrec;
 208 } DTLS_RLAYER_RECORD_DATA;
 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_tmp(OSSL_RECORD_LAYER *rl, OSSL_RECORD_TEMPLATE **templates,
 279                           size_t numtempl,  size_t allowance, size_t *sent);
 280 int tls_retry_write_records_tmp(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 void tls_get_state(OSSL_RECORD_LAYER *rl, const char **shortstr,
 294                    const char **longstr);
 295 int tls_set_options(OSSL_RECORD_LAYER *rl, const OSSL_PARAM *options);
 296 int tls_setup_read_buffer(OSSL_RECORD_LAYER *rl);