ssl/record/record.h

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