ssl/record/record.h

   1 /*
   2  * Copyright 1995-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  * These structures should be considered PRIVATE to the record layer. No     *
  13  * non-record layer code should be using these structures in any way.        *
  14  *                                                                           *
  15  *****************************************************************************/
  16
  17 typedef struct ssl3_buffer_st {
  18     /* at least SSL3_RT_MAX_PACKET_SIZE bytes, see ssl3_setup_buffers() */
  19     unsigned char *buf;
  20     /* default buffer size (or 0 if no default set) */
  21     size_t default_len;
  22     /* buffer size */
  23     size_t len;
  24     /* where to 'copy from' */
  25     size_t offset;
  26     /* how many bytes left */
  27     size_t left;
  28 } SSL3_BUFFER;
  29
  30 #define SEQ_NUM_SIZE                            8
  31
  32 typedef struct ssl3_record_st {
  33     /* Record layer version */
  34     /* r */
  35     int rec_version;
  36     /* type of record */
  37     /* r */
  38     int type;
  39     /* How many bytes available */
  40     /* rw */
  41     size_t length;
  42     /*
  43      * How many bytes were available before padding was removed? This is used
  44      * to implement the MAC check in constant time for CBC records.
  45      */
  46     /* rw */
  47     size_t orig_len;
  48     /* read/write offset into 'buf' */
  49     /* r */
  50     size_t off;
  51     /* pointer to the record data */
  52     /* rw */
  53     unsigned char *data;
  54     /* where the decode bytes are */
  55     /* rw */
  56     unsigned char *input;
  57     /* only used with decompression - malloc()ed */
  58     /* r */
  59     unsigned char *comp;
  60     /* Whether the data from this record has already been read or not */
  61     /* r */
  62     unsigned int read;
  63     /* epoch number, needed by DTLS1 */
  64     /* r */
  65     unsigned long epoch;
  66     /* sequence number, needed by DTLS1 */
  67     /* r */
  68     unsigned char seq_num[SEQ_NUM_SIZE];
  69 } SSL3_RECORD;
  70
  71 typedef struct dtls1_bitmap_st {
  72     /* Track 32 packets on 32-bit systems and 64 - on 64-bit systems */
  73     unsigned long map;
  74     /* Max record number seen so far, 64-bit value in big-endian encoding */
  75     unsigned char max_seq_num[SEQ_NUM_SIZE];
  76 } DTLS1_BITMAP;
  77
  78 typedef struct record_pqueue_st {
  79     unsigned short epoch;
  80     struct pqueue_st *q;
  81 } record_pqueue;
  82
  83 typedef struct dtls1_record_data_st {
  84     unsigned char *packet;
  85     size_t packet_length;
  86     SSL3_BUFFER rbuf;
  87     SSL3_RECORD rrec;
  88 #ifndef OPENSSL_NO_SCTP
  89     struct bio_dgram_sctp_rcvinfo recordinfo;
  90 #endif
  91 } DTLS1_RECORD_DATA;
  92
  93 typedef struct dtls_record_layer_st {
  94     /*
  95      * The current data and handshake epoch.  This is initially
  96      * undefined, and starts at zero once the initial handshake is
  97      * completed
  98      */
  99     unsigned short r_epoch;
 100     unsigned short w_epoch;
 101     /* records being received in the current epoch */
 102     DTLS1_BITMAP bitmap;
 103     /* renegotiation starts a new set of sequence numbers */
 104     DTLS1_BITMAP next_bitmap;
 105     /* Received handshake records (processed and unprocessed) */
 106     record_pqueue unprocessed_rcds;
 107     record_pqueue processed_rcds;
 108     /*
 109      * Buffered application records. Only for records between CCS and
 110      * Finished to prevent either protocol violation or unnecessary message
 111      * loss.
 112      */
 113     record_pqueue buffered_app_data;
 114     /*
 115      * storage for Alert/Handshake protocol data received but not yet
 116      * processed by ssl3_read_bytes:
 117      */
 118     unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
 119     size_t alert_fragment_len;
 120     unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
 121     size_t handshake_fragment_len;
 122     /* save last and current sequence numbers for retransmissions */
 123     unsigned char last_write_sequence[8];
 124     unsigned char curr_write_sequence[8];
 125 } DTLS_RECORD_LAYER;
 126
 127 /*****************************************************************************
 128  *                                                                           *
 129  * This structure should be considered "opaque" to anything outside of the   *
 130  * record layer. No non-record layer code should be accessing the members of *
 131  * this structure.                                                           *
 132  *                                                                           *
 133  *****************************************************************************/
 134
 135 typedef struct record_layer_st {
 136     /* The parent SSL structure */
 137     SSL *s;
 138     /*
 139      * Read as many input bytes as possible (for
 140      * non-blocking reads)
 141      */
 142     int read_ahead;
 143     /* where we are when reading */
 144     int rstate;
 145     /* How many pipelines can be used to read data */
 146     size_t numrpipes;
 147     /* How many pipelines can be used to write data */
 148     size_t numwpipes;
 149     /* read IO goes into here */
 150     SSL3_BUFFER rbuf;
 151     /* write IO goes into here */
 152     SSL3_BUFFER wbuf[SSL_MAX_PIPELINES];
 153     /* each decoded record goes in here */
 154     SSL3_RECORD rrec[SSL_MAX_PIPELINES];
 155     /* used internally to point at a raw packet */
 156     unsigned char *packet;
 157     size_t packet_length;
 158     /* number of bytes sent so far */
 159     size_t wnum;
 160     /*
 161      * storage for Alert/Handshake protocol data received but not yet
 162      * processed by ssl3_read_bytes:
 163      */
 164     unsigned char alert_fragment[2];
 165     size_t alert_fragment_len;
 166     unsigned char handshake_fragment[4];
 167     size_t handshake_fragment_len;
 168     /* The number of consecutive empty records we have received */
 169     size_t empty_record_count;
 170     /* partial write - check the numbers match */
 171     /* number bytes written */
 172     size_t wpend_tot;
 173     int wpend_type;
 174     /* number of bytes submitted */
 175     size_t wpend_ret;
 176     const unsigned char *wpend_buf;
 177     unsigned char read_sequence[SEQ_NUM_SIZE];
 178     unsigned char write_sequence[SEQ_NUM_SIZE];
 179     /* Set to true if this is the first record in a connection */
 180     unsigned int is_first_record;
 181     /* Count of the number of consecutive warning alerts received */
 182     unsigned int alert_count;
 183     DTLS_RECORD_LAYER *d;
 184 } RECORD_LAYER;
 185
 186 /*****************************************************************************
 187  *                                                                           *
 188  * The following macros/functions represent the libssl internal API to the   *
 189  * record layer. Any libssl code may call these functions/macros             *
 190  *                                                                           *
 191  *****************************************************************************/
 192
 193 #define MIN_SSL2_RECORD_LEN     9
 194
 195 #define RECORD_LAYER_set_read_ahead(rl, ra)     ((rl)->read_ahead = (ra))
 196 #define RECORD_LAYER_get_read_ahead(rl)         ((rl)->read_ahead)
 197 #define RECORD_LAYER_get_packet(rl)             ((rl)->packet)
 198 #define RECORD_LAYER_get_packet_length(rl)      ((rl)->packet_length)
 199 #define RECORD_LAYER_add_packet_length(rl, inc) ((rl)->packet_length += (inc))
 200 #define DTLS_RECORD_LAYER_get_w_epoch(rl)       ((rl)->d->w_epoch)
 201 #define DTLS_RECORD_LAYER_get_processed_rcds(rl) \
 202                                                 ((rl)->d->processed_rcds)
 203 #define DTLS_RECORD_LAYER_get_unprocessed_rcds(rl) \
 204                                                 ((rl)->d->unprocessed_rcds)
 205
 206 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL *s);
 207 void RECORD_LAYER_clear(RECORD_LAYER *rl);
 208 void RECORD_LAYER_release(RECORD_LAYER *rl);
 209 int RECORD_LAYER_read_pending(const RECORD_LAYER *rl);
 210 int RECORD_LAYER_write_pending(const RECORD_LAYER *rl);
 211 int RECORD_LAYER_set_data(RECORD_LAYER *rl, const unsigned char *buf,
 212                           size_t len);
 213 void RECORD_LAYER_reset_read_sequence(RECORD_LAYER *rl);
 214 void RECORD_LAYER_reset_write_sequence(RECORD_LAYER *rl);
 215 int RECORD_LAYER_is_sslv2_record(RECORD_LAYER *rl);
 216 size_t RECORD_LAYER_get_rrec_length(RECORD_LAYER *rl);
 217 __owur size_t ssl3_pending(const SSL *s);
 218 __owur int ssl3_write_bytes(SSL *s, int type, const void *buf, size_t len,
 219                             size_t *written);
 220 int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
 221                   size_t *pipelens, size_t numpipes,
 222                   int create_empty_fragment, size_t *written);
 223 __owur int ssl3_read_bytes(SSL *s, int type, int *recvd_type,
 224                            unsigned char *buf, size_t len, int peek,
 225                            size_t *read);
 226 __owur int ssl3_setup_buffers(SSL *s);
 227 __owur int ssl3_enc(SSL *s, SSL3_RECORD *inrecs, size_t n_recs, int send);
 228 __owur int n_ssl3_mac(SSL *ssl, SSL3_RECORD *rec, unsigned char *md, int send);
 229 __owur int ssl3_write_pending(SSL *s, int type, const unsigned char *buf, size_t len,
 230                               size_t *written);
 231 __owur int tls1_enc(SSL *s, SSL3_RECORD *recs, size_t n_recs, int send);
 232 __owur int tls1_mac(SSL *ssl, SSL3_RECORD *rec, unsigned char *md, int send);
 233 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl);
 234 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl);
 235 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
 236 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e);
 237 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
 238 void DTLS_RECORD_LAYER_resync_write(RECORD_LAYER *rl);
 239 void DTLS_RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, unsigned char *seq);
 240 __owur int dtls1_read_bytes(SSL *s, int type, int *recvd_type,
 241                             unsigned char *buf, size_t len, int peek,
 242                             size_t *read);
 243 __owur int dtls1_write_bytes(SSL *s, int type, const void *buf, size_t len,
 244                              size_t *written);
 245 int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
 246                    size_t len, int create_empty_fragment, size_t *written);
 247 void dtls1_reset_seq_numbers(SSL *s, int rw);