ssl/record/record.h

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57 /* ====================================================================
  58  * Copyright (c) 1998-2015 The OpenSSL Project.  All rights reserved.
  59  *
  60  * Redistribution and use in source and binary forms, with or without
  61  * modification, are permitted provided that the following conditions
  62  * are met:
  63  *
  64  * 1. Redistributions of source code must retain the above copyright
  65  *    notice, this list of conditions and the following disclaimer.
  66  *
  67  * 2. Redistributions in binary form must reproduce the above copyright
  68  *    notice, this list of conditions and the following disclaimer in
  69  *    the documentation and/or other materials provided with the
  70  *    distribution.
  71  *
  72  * 3. All advertising materials mentioning features or use of this
  73  *    software must display the following acknowledgment:
  74  *    "This product includes software developed by the OpenSSL Project
  75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  76  *
  77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  78  *    endorse or promote products derived from this software without
  79  *    prior written permission. For written permission, please contact
  80  *    openssl-core@openssl.org.
  81  *
  82  * 5. Products derived from this software may not be called "OpenSSL"
  83  *    nor may "OpenSSL" appear in their names without prior written
  84  *    permission of the OpenSSL Project.
  85  *
  86  * 6. Redistributions of any form whatsoever must retain the following
  87  *    acknowledgment:
  88  *    "This product includes software developed by the OpenSSL Project
  89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  90  *
  91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 102  * OF THE POSSIBILITY OF SUCH DAMAGE.
 103  * ====================================================================
 104  *
 105  * This product includes cryptographic software written by Eric Young
 106  * (eay@cryptsoft.com).  This product includes software written by Tim
 107  * Hudson (tjh@cryptsoft.com).
 108  *
 109  */
 110
 111 /*****************************************************************************
 112  *                                                                           *
 113  * These structures should be considered PRIVATE to the record layer. No     *
 114  * non-record layer code should be using these structures in any way.        *
 115  *                                                                           *
 116  *****************************************************************************/
 117
 118 typedef struct ssl3_buffer_st {
 119     /* at least SSL3_RT_MAX_PACKET_SIZE bytes, see ssl3_setup_buffers() */
 120     unsigned char *buf;
 121     /* default buffer size (or 0 if no default set) */
 122     size_t default_len;
 123     /* buffer size */
 124     size_t len;
 125     /* where to 'copy from' */
 126     int offset;
 127     /* how many bytes left */
 128     int left;
 129 } SSL3_BUFFER;
 130
 131 #define SEQ_NUM_SIZE                            8
 132
 133 typedef struct ssl3_record_st {
 134     /* Record layer version */
 135     /* r */
 136     int rec_version;
 137
 138     /* type of record */
 139     /* r */
 140     int type;
 141
 142     /* How many bytes available */
 143     /* rw */
 144     unsigned int length;
 145
 146     /*
 147      * How many bytes were available before padding was removed? This is used
 148      * to implement the MAC check in constant time for CBC records.
 149      */
 150     /* rw */
 151     unsigned int orig_len;
 152
 153     /* read/write offset into 'buf' */
 154     /* r */
 155     unsigned int off;
 156
 157     /* pointer to the record data */
 158     /* rw */
 159     unsigned char *data;
 160
 161     /* where the decode bytes are */
 162     /* rw */
 163     unsigned char *input;
 164
 165     /* only used with decompression - malloc()ed */
 166     /* r */
 167     unsigned char *comp;
 168
 169     /* epoch number, needed by DTLS1 */
 170     /* r */
 171     unsigned long epoch;
 172
 173     /* sequence number, needed by DTLS1 */
 174     /* r */
 175     unsigned char seq_num[SEQ_NUM_SIZE];
 176 } SSL3_RECORD;
 177
 178 typedef struct dtls1_bitmap_st {
 179     /* Track 32 packets on 32-bit systems and 64 - on 64-bit systems */
 180     unsigned long map;
 181
 182     /* Max record number seen so far, 64-bit value in big-endian encoding */
 183     unsigned char max_seq_num[SEQ_NUM_SIZE];
 184 } DTLS1_BITMAP;
 185
 186 typedef struct record_pqueue_st {
 187     unsigned short epoch;
 188     struct pqueue_st *q;
 189 } record_pqueue;
 190
 191 typedef struct dtls1_record_data_st {
 192     unsigned char *packet;
 193     unsigned int packet_length;
 194     SSL3_BUFFER rbuf;
 195     SSL3_RECORD rrec;
 196 #  ifndef OPENSSL_NO_SCTP
 197     struct bio_dgram_sctp_rcvinfo recordinfo;
 198 #  endif
 199 } DTLS1_RECORD_DATA;
 200
 201
 202 typedef struct dtls_record_layer_st {
 203     /*
 204      * The current data and handshake epoch.  This is initially
 205      * undefined, and starts at zero once the initial handshake is
 206      * completed
 207      */
 208     unsigned short r_epoch;
 209     unsigned short w_epoch;
 210
 211     /* records being received in the current epoch */
 212     DTLS1_BITMAP bitmap;
 213     /* renegotiation starts a new set of sequence numbers */
 214     DTLS1_BITMAP next_bitmap;
 215
 216     /* Received handshake records (processed and unprocessed) */
 217     record_pqueue unprocessed_rcds;
 218     record_pqueue processed_rcds;
 219     /*
 220      * Buffered application records. Only for records between CCS and
 221      * Finished to prevent either protocol violation or unnecessary message
 222      * loss.
 223      */
 224     record_pqueue buffered_app_data;
 225     /*
 226      * storage for Alert/Handshake protocol data received but not yet
 227      * processed by ssl3_read_bytes:
 228      */
 229     unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH];
 230     unsigned int alert_fragment_len;
 231     unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH];
 232     unsigned int handshake_fragment_len;
 233
 234     /* save last and current sequence numbers for retransmissions */
 235     unsigned char last_write_sequence[8];
 236     unsigned char curr_write_sequence[8];
 237 } DTLS_RECORD_LAYER;
 238
 239 /*****************************************************************************
 240  *                                                                           *
 241  * This structure should be considered "opaque" to anything outside of the   *
 242  * record layer. No non-record layer code should be accessing the members of *
 243  * this structure.                                                           *
 244  *                                                                           *
 245  *****************************************************************************/
 246
 247 typedef struct record_layer_st {
 248     /* The parent SSL structure */
 249     SSL *s;
 250     /*
 251      * Read as many input bytes as possible (for
 252      * non-blocking reads)
 253      */
 254     int read_ahead;
 255     /* where we are when reading */
 256     int rstate;
 257
 258     /* How many pipelines can be used to read data */
 259     unsigned int numrpipes;
 260     /* How many pipelines can be used to write data */
 261     unsigned int numwpipes;
 262     /* read IO goes into here */
 263     SSL3_BUFFER rbuf;
 264     /* write IO goes into here */
 265     SSL3_BUFFER wbuf[SSL_MAX_PIPELINES];
 266     /* each decoded record goes in here */
 267     SSL3_RECORD rrec[SSL_MAX_PIPELINES];
 268
 269     /* used internally to point at a raw packet */
 270     unsigned char *packet;
 271     unsigned int packet_length;
 272
 273     /* number of bytes sent so far */
 274     unsigned int wnum;
 275
 276     /*
 277      * storage for Alert/Handshake protocol data received but not yet
 278      * processed by ssl3_read_bytes:
 279      */
 280     unsigned char alert_fragment[2];
 281     unsigned int alert_fragment_len;
 282     unsigned char handshake_fragment[4];
 283     unsigned int handshake_fragment_len;
 284
 285     /* partial write - check the numbers match */
 286     /* number bytes written */
 287     int wpend_tot;
 288     int wpend_type;
 289     /* number of bytes submitted */
 290     int wpend_ret;
 291     const unsigned char *wpend_buf;
 292
 293     unsigned char read_sequence[SEQ_NUM_SIZE];
 294     unsigned char write_sequence[SEQ_NUM_SIZE];
 295
 296     DTLS_RECORD_LAYER *d;
 297 } RECORD_LAYER;
 298
 299
 300 /*****************************************************************************
 301  *                                                                           *
 302  * The following macros/functions represent the libssl internal API to the   *
 303  * record layer. Any libssl code may call these functions/macros             *
 304  *                                                                           *
 305  *****************************************************************************/
 306
 307 #define MIN_SSL2_RECORD_LEN     9
 308
 309 #define RECORD_LAYER_set_read_ahead(rl, ra)     ((rl)->read_ahead = (ra))
 310 #define RECORD_LAYER_get_read_ahead(rl)         ((rl)->read_ahead)
 311 #define RECORD_LAYER_get_packet(rl)             ((rl)->packet)
 312 #define RECORD_LAYER_get_packet_length(rl)      ((rl)->packet_length)
 313 #define RECORD_LAYER_add_packet_length(rl, inc) ((rl)->packet_length += (inc))
 314 #define DTLS_RECORD_LAYER_get_w_epoch(rl)       ((rl)->d->w_epoch)
 315 #define DTLS_RECORD_LAYER_get_processed_rcds(rl) \
 316                                                 ((rl)->d->processed_rcds)
 317 #define DTLS_RECORD_LAYER_get_unprocessed_rcds(rl) \
 318                                                 ((rl)->d->unprocessed_rcds)
 319
 320 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL *s);
 321 void RECORD_LAYER_clear(RECORD_LAYER *rl);
 322 void RECORD_LAYER_release(RECORD_LAYER *rl);
 323 int RECORD_LAYER_read_pending(const RECORD_LAYER *rl);
 324 int RECORD_LAYER_write_pending(const RECORD_LAYER *rl);
 325 int RECORD_LAYER_set_data(RECORD_LAYER *rl, const unsigned char *buf, int len);
 326 void RECORD_LAYER_reset_read_sequence(RECORD_LAYER *rl);
 327 void RECORD_LAYER_reset_write_sequence(RECORD_LAYER *rl);
 328 int RECORD_LAYER_is_sslv2_record(RECORD_LAYER *rl);
 329 unsigned int RECORD_LAYER_get_rrec_length(RECORD_LAYER *rl);
 330 __owur int ssl3_pending(const SSL *s);
 331 __owur int ssl3_write_bytes(SSL *s, int type, const void *buf, int len);
 332 __owur int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
 333                          unsigned int *pipelens, unsigned int numpipes,
 334                          int create_empty_fragment);
 335 __owur int ssl3_read_bytes(SSL *s, int type, int *recvd_type,
 336                            unsigned char *buf, int len, int peek);
 337 __owur int ssl3_setup_buffers(SSL *s);
 338 __owur int ssl3_enc(SSL *s, SSL3_RECORD *inrecs, unsigned int n_recs, int send);
 339 __owur int n_ssl3_mac(SSL *ssl, SSL3_RECORD *rec, unsigned char *md, int send);
 340 __owur int ssl3_write_pending(SSL *s, int type, const unsigned char *buf,
 341                        unsigned int len);
 342 __owur int tls1_enc(SSL *s, SSL3_RECORD *recs, unsigned int n_recs, int send);
 343 __owur int tls1_mac(SSL *ssl, SSL3_RECORD *rec, unsigned char *md, int send);
 344 int DTLS_RECORD_LAYER_new(RECORD_LAYER *rl);
 345 void DTLS_RECORD_LAYER_free(RECORD_LAYER *rl);
 346 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
 347 void DTLS_RECORD_LAYER_set_saved_w_epoch(RECORD_LAYER *rl, unsigned short e);
 348 void DTLS_RECORD_LAYER_clear(RECORD_LAYER *rl);
 349 void DTLS_RECORD_LAYER_resync_write(RECORD_LAYER *rl);
 350 void DTLS_RECORD_LAYER_set_write_sequence(RECORD_LAYER *rl, unsigned char *seq);
 351 __owur int dtls1_read_bytes(SSL *s, int type, int *recvd_type,
 352                             unsigned char *buf, int len, int peek);
 353 __owur int dtls1_write_bytes(SSL *s, int type, const void *buf, int len);
 354 __owur int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
 355                    unsigned int len, int create_empty_fragement);
 356 void dtls1_reset_seq_numbers(SSL *s, int rw);
 357