ssl/record/record.h

   1 /*
   2  * Copyright 1995-2020 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 typedef struct ssl_connection_st SSL_CONNECTION;
  11 typedef struct ssl3_buffer_st SSL3_BUFFER;
  12
  13 #include <openssl/core_dispatch.h>
  14 #include "recordmethod.h"
  15
  16 /*****************************************************************************
  17  *                                                                           *
  18  * These structures should be considered PRIVATE to the record layer. No     *
  19  * non-record layer code should be using these structures in any way.        *
  20  *                                                                           *
  21  *****************************************************************************/
  22
  23 struct ssl3_buffer_st {
  24     /* at least SSL3_RT_MAX_PACKET_SIZE bytes, see ssl3_setup_buffers() */
  25     unsigned char *buf;
  26     /* default buffer size (or 0 if no default set) */
  27     size_t default_len;
  28     /* buffer size */
  29     size_t len;
  30     /* where to 'copy from' */
  31     size_t offset;
  32     /* how many bytes left */
  33     size_t left;
  34     /* 'buf' is from application for KTLS */
  35     int app_buffer;
  36     /* The type of data stored in this buffer. Only used for writing */
  37     int type;
  38 };
  39
  40 #define SEQ_NUM_SIZE                            8
  41
  42 typedef struct ssl3_record_st {
  43     /* Record layer version */
  44     /* r */
  45     int rec_version;
  46     /* type of record */
  47     /* r */
  48     int type;
  49     /* How many bytes available */
  50     /* rw */
  51     size_t length;
  52     /*
  53      * How many bytes were available before padding was removed? This is used
  54      * to implement the MAC check in constant time for CBC records.
  55      */
  56     /* rw */
  57     size_t orig_len;
  58     /* read/write offset into 'buf' */
  59     /* r */
  60     size_t off;
  61     /* pointer to the record data */
  62     /* rw */
  63     unsigned char *data;
  64     /* where the decode bytes are */
  65     /* rw */
  66     unsigned char *input;
  67     /* only used with decompression - malloc()ed */
  68     /* r */
  69     unsigned char *comp;
  70     /* epoch number, needed by DTLS1 */
  71     /* r */
  72     uint16_t epoch;
  73     /* sequence number, needed by DTLS1 */
  74     /* r */
  75     unsigned char seq_num[SEQ_NUM_SIZE];
  76 } SSL3_RECORD;
  77
  78 typedef struct tls_record_st {
  79     void *rechandle;
  80     int version;
  81     int type;
  82     /* The data buffer containing bytes from the record */
  83     unsigned char *data;
  84     /* Number of remaining to be read in the data buffer */
  85     size_t length;
  86     /* Offset into the data buffer where to start reading */
  87     size_t off;
  88     /* epoch number. DTLS only */
  89     uint16_t epoch;
  90     /* sequence number. DTLS only */
  91     unsigned char seq_num[SEQ_NUM_SIZE];
  92 #ifndef OPENSSL_NO_SCTP
  93     struct bio_dgram_sctp_rcvinfo recordinfo;
  94 #endif
  95 } TLS_RECORD;
  96
  97 typedef struct record_pqueue_st {
  98     uint16_t epoch;
  99     struct pqueue_st *q;
 100 } record_pqueue;
 101
 102 typedef struct dtls_record_layer_st {
 103     /*
 104      * The current data and handshake epoch.  This is initially
 105      * undefined, and starts at zero once the initial handshake is
 106      * completed
 107      */
 108     uint16_t r_epoch;
 109     uint16_t w_epoch;
 110
 111     /*
 112      * Buffered application records. Only for records between CCS and
 113      * Finished to prevent either protocol violation or unnecessary message
 114      * loss.
 115      */
 116     record_pqueue buffered_app_data;
 117     /* save last and current sequence numbers for retransmissions */
 118     unsigned char last_write_sequence[8];
 119     unsigned char curr_write_sequence[8];
 120 } DTLS_RECORD_LAYER;
 121
 122 /*****************************************************************************
 123  *                                                                           *
 124  * This structure should be considered "opaque" to anything outside of the   *
 125  * record layer. No non-record layer code should be accessing the members of *
 126  * this structure.                                                           *
 127  *                                                                           *
 128  *****************************************************************************/
 129
 130 typedef struct record_layer_st {
 131     /* The parent SSL_CONNECTION structure */
 132     SSL_CONNECTION *s;
 133
 134     /* Method to use for the read record layer*/
 135     const OSSL_RECORD_METHOD *rrlmethod;
 136     /* The read record layer object itself */
 137     OSSL_RECORD_LAYER *rrl;
 138     /* BIO to store data destined for the next read record layer epoch */
 139     BIO *rrlnext;
 140     /* Default read buffer length to be passed to the record layer */
 141     size_t default_read_buf_len;
 142
 143     /*
 144      * Read as many input bytes as possible (for
 145      * non-blocking reads)
 146      */
 147     int read_ahead;
 148     /* How many pipelines can be used to write data */
 149     size_t numwpipes;
 150     /* write IO goes into here */
 151     SSL3_BUFFER wbuf[SSL_MAX_PIPELINES + 1];
 152     /* number of bytes sent so far */
 153     size_t wnum;
 154     unsigned char handshake_fragment[4];
 155     size_t handshake_fragment_len;
 156     /* partial write - check the numbers match */
 157     /* number bytes written */
 158     size_t wpend_tot;
 159     int wpend_type;
 160     /* number of bytes submitted */
 161     size_t wpend_ret;
 162     const unsigned char *wpend_buf;
 163
 164     unsigned char write_sequence[SEQ_NUM_SIZE];
 165     /* Count of the number of consecutive warning alerts received */
 166     unsigned int alert_count;
 167     DTLS_RECORD_LAYER *d;
 168
 169     /* How many records we have read from the record layer */
 170     size_t num_recs;
 171     /* The next record from the record layer that we need to process */
 172     size_t curr_rec;
 173     /* Record layer data to be processed */
 174     TLS_RECORD tlsrecs[SSL_MAX_PIPELINES];
 175
 176 } RECORD_LAYER;
 177
 178 /*****************************************************************************
 179  *                                                                           *
 180  * The following macros/functions represent the libssl internal API to the   *
 181  * record layer. Any libssl code may call these functions/macros             *
 182  *                                                                           *
 183  *****************************************************************************/
 184
 185 struct ssl_mac_buf_st {
 186     unsigned char *mac;
 187     int alloced;
 188 };
 189 typedef struct ssl_mac_buf_st SSL_MAC_BUF;
 190
 191 #define MIN_SSL2_RECORD_LEN     9
 192
 193 #define RECORD_LAYER_set_read_ahead(rl, ra)     ((rl)->read_ahead = (ra))
 194 #define RECORD_LAYER_get_read_ahead(rl)         ((rl)->read_ahead)
 195 #define RECORD_LAYER_get_packet(rl)             ((rl)->packet)
 196 #define RECORD_LAYER_add_packet_length(rl, inc) ((rl)->packet_length += (inc))
 197 #define DTLS_RECORD_LAYER_get_w_epoch(rl)       ((rl)->d->w_epoch)
 198 #define RECORD_LAYER_get_rbuf(rl)               (&(rl)->rbuf)
 199 #define RECORD_LAYER_get_wbuf(rl)               ((rl)->wbuf)
 200
 201 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL_CONNECTION *s);
 202 void RECORD_LAYER_clear(RECORD_LAYER *rl);
 203 void RECORD_LAYER_release(RECORD_LAYER *rl);
 204 int RECORD_LAYER_read_pending(const RECORD_LAYER *rl);
 205 int RECORD_LAYER_processed_read_pending(const RECORD_LAYER *rl);
 206 int RECORD_LAYER_write_pending(const RECORD_LAYER *rl);
 207 void RECORD_LAYER_reset_write_sequence(RECORD_LAYER *rl);
 208 int RECORD_LAYER_is_sslv2_record(RECORD_LAYER *rl);
 209 __owur size_t ssl3_pending(const SSL *s);
 210 __owur int ssl3_write_bytes(SSL *s, int type, const void *buf, size_t len,
 211                             size_t *written);
 212 __owur int ssl3_read_bytes(SSL *s, int type, int *recvd_type,
 213                            unsigned char *buf, size_t len, int peek,
 214                            size_t *readbytes);
 215 __owur int ssl3_setup_buffers(SSL_CONNECTION *s);
 216 __owur int ssl3_enc(SSL_CONNECTION *s, SSL3_RECORD *inrecs, size_t n_recs,
 217                     int send, SSL_MAC_BUF *mac, size_t macsize);
 218 __owur int n_ssl3_mac(SSL_CONNECTION *s, SSL3_RECORD *rec, unsigned char *md,
 219                       int send);
 220 __owur int tls_retry_write_records(SSL_CONNECTION *s);
 221 __owur int tls1_enc(SSL_CONNECTION *s, SSL3_RECORD *recs, size_t n_recs,
 222                     int sending, SSL_MAC_BUF *mac, size_t macsize);
 223 __owur int tls1_mac_old(SSL_CONNECTION *s, SSL3_RECORD *rec, unsigned char *md,
 224                         int send);
 225 __owur int tls13_enc(SSL_CONNECTION *s, SSL3_RECORD *recs, size_t n_recs,
 226                      int send, SSL_MAC_BUF *mac, size_t macsize);
 227 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl);
 228 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl);
 229 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
 230 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e);
 231 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
 232 void DTLS_RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, unsigned char *seq);
 233 __owur int dtls1_read_bytes(SSL *s, int type, int *recvd_type,
 234                             unsigned char *buf, size_t len, int peek,
 235                             size_t *readbytes);
 236 __owur int dtls1_write_bytes(SSL_CONNECTION *s, int type, const void *buf,
 237                              size_t len, size_t *written);
 238 int do_dtls1_write(SSL_CONNECTION *s, int type, const unsigned char *buf,
 239                    size_t len, int create_empty_fragment, size_t *written);
 240 void dtls1_reset_seq_numbers(SSL_CONNECTION *s, int rw);
 241 void ssl_release_record(SSL_CONNECTION *s, TLS_RECORD *rr);
 242
 243 # define HANDLE_RLAYER_RETURN(s, ret) \
 244     ossl_tls_handle_rlayer_return(s, ret, OPENSSL_FILE, OPENSSL_LINE)
 245
 246 int ossl_tls_handle_rlayer_return(SSL_CONNECTION *s, int ret, char *file,
 247                                   int line);
 248
 249 int ssl_set_new_record_layer(SSL_CONNECTION *s, int version, int direction,
 250                              int level, unsigned char *key, size_t keylen,
 251                              unsigned char *iv,  size_t ivlen,
 252                              unsigned char *mackey, size_t mackeylen,
 253                              const EVP_CIPHER *ciph, size_t taglen,
 254                              int mactype, const EVP_MD *md,
 255                              const SSL_COMP *comp);
 256
 257 # define OSSL_FUNC_RLAYER_SKIP_EARLY_DATA        1
 258 OSSL_CORE_MAKE_FUNC(int, rlayer_skip_early_data, (void *cbarg))
 259 # define OSSL_FUNC_RLAYER_MSG_CALLBACK           2
 260 OSSL_CORE_MAKE_FUNC(void, rlayer_msg_callback, (int write_p, int version,
 261                                                 int content_type,
 262                                                 const void *buf, size_t len,
 263                                                 void *cbarg))
 264 # define OSSL_FUNC_RLAYER_SECURITY               3
 265 OSSL_CORE_MAKE_FUNC(int, rlayer_security, (void *cbarg, int op, int bits,
 266                                            int nid, void *other))
 267
 268 int tls_write_records(SSL_CONNECTION *s, OSSL_RECORD_TEMPLATE *templates,
 269                       size_t numtempl);