ssl/s3_pkt.c

   1 /* ssl/s3_pkt.c */
   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-2002 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 #include <stdio.h>
 113 #include <limits.h>
 114 #include <errno.h>
 115 #define USE_SOCKETS
 116 #include "ssl_locl.h"
 117 #include <openssl/evp.h>
 118 #include <openssl/buffer.h>
 119 #include <openssl/rand.h>
 120
 121 #ifndef  EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
 122 # define EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK 0
 123 #endif
 124
 125 #if     defined(OPENSSL_SMALL_FOOTPRINT) || \
 126         !(      defined(AES_ASM) &&     ( \
 127                 defined(__x86_64)       || defined(__x86_64__)  || \
 128                 defined(_M_AMD64)       || defined(_M_X64)      || \
 129                 defined(__INTEL__)      ) \
 130         )
 131 # undef EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
 132 # define EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK 0
 133 #endif
 134
 135 static int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
 136                          unsigned int len, int create_empty_fragment);
 137 static int ssl3_get_record(SSL *s);
 138
 139 int ssl3_read_n(SSL *s, int n, int max, int extend)
 140 {
 141     /*
 142      * If extend == 0, obtain new n-byte packet; if extend == 1, increase
 143      * packet by another n bytes. The packet will be in the sub-array of
 144      * s->s3->rbuf.buf specified by s->packet and s->packet_length. (If
 145      * s->read_ahead is set, 'max' bytes may be stored in rbuf [plus
 146      * s->packet_length bytes if extend == 1].)
 147      */
 148     int i, len, left;
 149     long align = 0;
 150     unsigned char *pkt;
 151     SSL3_BUFFER *rb;
 152
 153     if (n <= 0)
 154         return n;
 155
 156     rb = &(s->s3->rbuf);
 157     if (rb->buf == NULL)
 158         if (!ssl3_setup_read_buffer(s))
 159             return -1;
 160
 161     left = rb->left;
 162 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
 163     align = (long)rb->buf + SSL3_RT_HEADER_LENGTH;
 164     align = (-align) & (SSL3_ALIGN_PAYLOAD - 1);
 165 #endif
 166
 167     if (!extend) {
 168         /* start with empty packet ... */
 169         if (left == 0)
 170             rb->offset = align;
 171         else if (align != 0 && left >= SSL3_RT_HEADER_LENGTH) {
 172             /*
 173              * check if next packet length is large enough to justify payload
 174              * alignment...
 175              */
 176             pkt = rb->buf + rb->offset;
 177             if (pkt[0] == SSL3_RT_APPLICATION_DATA
 178                 && (pkt[3] << 8 | pkt[4]) >= 128) {
 179                 /*
 180                  * Note that even if packet is corrupted and its length field
 181                  * is insane, we can only be led to wrong decision about
 182                  * whether memmove will occur or not. Header values has no
 183                  * effect on memmove arguments and therefore no buffer
 184                  * overrun can be triggered.
 185                  */
 186                 memmove(rb->buf + align, pkt, left);
 187                 rb->offset = align;
 188             }
 189         }
 190         s->packet = rb->buf + rb->offset;
 191         s->packet_length = 0;
 192         /* ... now we can act as if 'extend' was set */
 193     }
 194
 195     /*
 196      * For DTLS/UDP reads should not span multiple packets because the read
 197      * operation returns the whole packet at once (as long as it fits into
 198      * the buffer).
 199      */
 200     if (SSL_IS_DTLS(s)) {
 201         if (left == 0 && extend)
 202             return 0;
 203         if (left > 0 && n > left)
 204             n = left;
 205     }
 206
 207     /* if there is enough in the buffer from a previous read, take some */
 208     if (left >= n) {
 209         s->packet_length += n;
 210         rb->left = left - n;
 211         rb->offset += n;
 212         return (n);
 213     }
 214
 215     /* else we need to read more data */
 216
 217     len = s->packet_length;
 218     pkt = rb->buf + align;
 219     /*
 220      * Move any available bytes to front of buffer: 'len' bytes already
 221      * pointed to by 'packet', 'left' extra ones at the end
 222      */
 223     if (s->packet != pkt) {     /* len > 0 */
 224         memmove(pkt, s->packet, len + left);
 225         s->packet = pkt;
 226         rb->offset = len + align;
 227     }
 228
 229     if (n > (int)(rb->len - rb->offset)) { /* does not happen */
 230         SSLerr(SSL_F_SSL3_READ_N, ERR_R_INTERNAL_ERROR);
 231         return -1;
 232     }
 233
 234     /* We always act like read_ahead is set for DTLS */
 235     if (!s->read_ahead && !SSL_IS_DTLS(s))
 236         /* ignore max parameter */
 237         max = n;
 238     else {
 239         if (max < n)
 240             max = n;
 241         if (max > (int)(rb->len - rb->offset))
 242             max = rb->len - rb->offset;
 243     }
 244
 245     while (left < n) {
 246         /*
 247          * Now we have len+left bytes at the front of s->s3->rbuf.buf and
 248          * need to read in more until we have len+n (up to len+max if
 249          * possible)
 250          */
 251
 252         clear_sys_error();
 253         if (s->rbio != NULL) {
 254             s->rwstate = SSL_READING;
 255             i = BIO_read(s->rbio, pkt + len + left, max - left);
 256         } else {
 257             SSLerr(SSL_F_SSL3_READ_N, SSL_R_READ_BIO_NOT_SET);
 258             i = -1;
 259         }
 260
 261         if (i <= 0) {
 262             rb->left = left;
 263             if (s->mode & SSL_MODE_RELEASE_BUFFERS && !SSL_IS_DTLS(s))
 264                 if (len + left == 0)
 265                     ssl3_release_read_buffer(s);
 266             return (i);
 267         }
 268         left += i;
 269         /*
 270          * reads should *never* span multiple packets for DTLS because the
 271          * underlying transport protocol is message oriented as opposed to
 272          * byte oriented as in the TLS case.
 273          */
 274         if (SSL_IS_DTLS(s)) {
 275             if (n > left)
 276                 n = left;       /* makes the while condition false */
 277         }
 278     }
 279
 280     /* done reading, now the book-keeping */
 281     rb->offset += n;
 282     rb->left = left - n;
 283     s->packet_length += n;
 284     s->rwstate = SSL_NOTHING;
 285     return (n);
 286 }
 287
 288 /*
 289  * MAX_EMPTY_RECORDS defines the number of consecutive, empty records that
 290  * will be processed per call to ssl3_get_record. Without this limit an
 291  * attacker could send empty records at a faster rate than we can process and
 292  * cause ssl3_get_record to loop forever.
 293  */
 294 #define MAX_EMPTY_RECORDS 32
 295
 296 /*-
 297  * Call this to get a new input record.
 298  * It will return <= 0 if more data is needed, normally due to an error
 299  * or non-blocking IO.
 300  * When it finishes, one packet has been decoded and can be found in
 301  * ssl->s3->rrec.type    - is the type of record
 302  * ssl->s3->rrec.data,   - data
 303  * ssl->s3->rrec.length, - number of bytes
 304  */
 305 /* used only by ssl3_read_bytes */
 306 static int ssl3_get_record(SSL *s)
 307 {
 308     int ssl_major, ssl_minor, al;
 309     int enc_err, n, i, ret = -1;
 310     SSL3_RECORD *rr;
 311     SSL_SESSION *sess;
 312     unsigned char *p;
 313     unsigned char md[EVP_MAX_MD_SIZE];
 314     short version;
 315     unsigned mac_size, orig_len;
 316     size_t extra;
 317     unsigned empty_record_count = 0;
 318
 319     rr = &(s->s3->rrec);
 320     sess = s->session;
 321
 322     if (s->options & SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER)
 323         extra = SSL3_RT_MAX_EXTRA;
 324     else
 325         extra = 0;
 326     if (extra && !s->s3->init_extra) {
 327         /*
 328          * An application error: SLS_OP_MICROSOFT_BIG_SSLV3_BUFFER set after
 329          * ssl3_setup_buffers() was done
 330          */
 331         SSLerr(SSL_F_SSL3_GET_RECORD, ERR_R_INTERNAL_ERROR);
 332         return -1;
 333     }
 334
 335  again:
 336     /* check if we have the header */
 337     if ((s->rstate != SSL_ST_READ_BODY) ||
 338         (s->packet_length < SSL3_RT_HEADER_LENGTH)) {
 339         n = ssl3_read_n(s, SSL3_RT_HEADER_LENGTH, s->s3->rbuf.len, 0);
 340         if (n <= 0)
 341             return (n);         /* error or non-blocking */
 342         s->rstate = SSL_ST_READ_BODY;
 343
 344         p = s->packet;
 345         if (s->msg_callback)
 346             s->msg_callback(0, 0, SSL3_RT_HEADER, p, 5, s,
 347                             s->msg_callback_arg);
 348
 349         /* Pull apart the header into the SSL3_RECORD */
 350         rr->type = *(p++);
 351         ssl_major = *(p++);
 352         ssl_minor = *(p++);
 353         version = (ssl_major << 8) | ssl_minor;
 354         n2s(p, rr->length);
 355 #if 0
 356         fprintf(stderr, "Record type=%d, Length=%d\n", rr->type, rr->length);
 357 #endif
 358
 359         /* Lets check version */
 360         if (!s->first_packet) {
 361             if (version != s->version) {
 362                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_WRONG_VERSION_NUMBER);
 363                 if ((s->version & 0xFF00) == (version & 0xFF00)
 364                     && !s->enc_write_ctx && !s->write_hash)
 365                     /*
 366                      * Send back error using their minor version number :-)
 367                      */
 368                     s->version = (unsigned short)version;
 369                 al = SSL_AD_PROTOCOL_VERSION;
 370                 goto f_err;
 371             }
 372         }
 373
 374         if ((version >> 8) != SSL3_VERSION_MAJOR) {
 375             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_WRONG_VERSION_NUMBER);
 376             goto err;
 377         }
 378
 379         if (rr->length > s->s3->rbuf.len - SSL3_RT_HEADER_LENGTH) {
 380             al = SSL_AD_RECORD_OVERFLOW;
 381             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_PACKET_LENGTH_TOO_LONG);
 382             goto f_err;
 383         }
 384
 385         /* now s->rstate == SSL_ST_READ_BODY */
 386     }
 387
 388     /* s->rstate == SSL_ST_READ_BODY, get and decode the data */
 389
 390     if (rr->length > s->packet_length - SSL3_RT_HEADER_LENGTH) {
 391         /* now s->packet_length == SSL3_RT_HEADER_LENGTH */
 392         i = rr->length;
 393         n = ssl3_read_n(s, i, i, 1);
 394         if (n <= 0)
 395             return (n);         /* error or non-blocking io */
 396         /*
 397          * now n == rr->length, and s->packet_length == SSL3_RT_HEADER_LENGTH
 398          * + rr->length
 399          */
 400     }
 401
 402     s->rstate = SSL_ST_READ_HEADER; /* set state for later operations */
 403
 404     /*
 405      * At this point, s->packet_length == SSL3_RT_HEADER_LNGTH + rr->length,
 406      * and we have that many bytes in s->packet
 407      */
 408     rr->input = &(s->packet[SSL3_RT_HEADER_LENGTH]);
 409
 410     /*
 411      * ok, we can now read from 's->packet' data into 'rr' rr->input points
 412      * at rr->length bytes, which need to be copied into rr->data by either
 413      * the decryption or by the decompression When the data is 'copied' into
 414      * the rr->data buffer, rr->input will be pointed at the new buffer
 415      */
 416
 417     /*
 418      * We now have - encrypted [ MAC [ compressed [ plain ] ] ] rr->length
 419      * bytes of encrypted compressed stuff.
 420      */
 421
 422     /* check is not needed I believe */
 423     if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH + extra) {
 424         al = SSL_AD_RECORD_OVERFLOW;
 425         SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
 426         goto f_err;
 427     }
 428
 429     /* decrypt in place in 'rr->input' */
 430     rr->data = rr->input;
 431
 432     enc_err = s->method->ssl3_enc->enc(s, 0);
 433     /*-
 434      * enc_err is:
 435      *    0: (in non-constant time) if the record is publically invalid.
 436      *    1: if the padding is valid
 437      *    -1: if the padding is invalid
 438      */
 439     if (enc_err == 0) {
 440         al = SSL_AD_DECRYPTION_FAILED;
 441         SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BLOCK_CIPHER_PAD_IS_WRONG);
 442         goto f_err;
 443     }
 444 #ifdef TLS_DEBUG
 445     printf("dec %d\n", rr->length);
 446     {
 447         unsigned int z;
 448         for (z = 0; z < rr->length; z++)
 449             printf("%02X%c", rr->data[z], ((z + 1) % 16) ? ' ' : '\n');
 450     }
 451     printf("\n");
 452 #endif
 453
 454     /* r->length is now the compressed data plus mac */
 455     if ((sess != NULL) &&
 456         (s->enc_read_ctx != NULL) && (EVP_MD_CTX_md(s->read_hash) != NULL)) {
 457         /* s->read_hash != NULL => mac_size != -1 */
 458         unsigned char *mac = NULL;
 459         unsigned char mac_tmp[EVP_MAX_MD_SIZE];
 460         mac_size = EVP_MD_CTX_size(s->read_hash);
 461         OPENSSL_assert(mac_size <= EVP_MAX_MD_SIZE);
 462
 463         /*
 464          * kludge: *_cbc_remove_padding passes padding length in rr->type
 465          */
 466         orig_len = rr->length + ((unsigned int)rr->type >> 8);
 467
 468         /*
 469          * orig_len is the length of the record before any padding was
 470          * removed. This is public information, as is the MAC in use,
 471          * therefore we can safely process the record in a different amount
 472          * of time if it's too short to possibly contain a MAC.
 473          */
 474         if (orig_len < mac_size ||
 475             /* CBC records must have a padding length byte too. */
 476             (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
 477              orig_len < mac_size + 1)) {
 478             al = SSL_AD_DECODE_ERROR;
 479             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_LENGTH_TOO_SHORT);
 480             goto f_err;
 481         }
 482
 483         if (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE) {
 484             /*
 485              * We update the length so that the TLS header bytes can be
 486              * constructed correctly but we need to extract the MAC in
 487              * constant time from within the record, without leaking the
 488              * contents of the padding bytes.
 489              */
 490             mac = mac_tmp;
 491             ssl3_cbc_copy_mac(mac_tmp, rr, mac_size, orig_len);
 492             rr->length -= mac_size;
 493         } else {
 494             /*
 495              * In this case there's no padding, so |orig_len| equals
 496              * |rec->length| and we checked that there's enough bytes for
 497              * |mac_size| above.
 498              */
 499             rr->length -= mac_size;
 500             mac = &rr->data[rr->length];
 501         }
 502
 503         i = s->method->ssl3_enc->mac(s, md, 0 /* not send */ );
 504         if (i < 0 || mac == NULL
 505             || CRYPTO_memcmp(md, mac, (size_t)mac_size) != 0)
 506             enc_err = -1;
 507         if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH + extra + mac_size)
 508             enc_err = -1;
 509     }
 510
 511     if (enc_err < 0) {
 512         /*
 513          * A separate 'decryption_failed' alert was introduced with TLS 1.0,
 514          * SSL 3.0 only has 'bad_record_mac'.  But unless a decryption
 515          * failure is directly visible from the ciphertext anyway, we should
 516          * not reveal which kind of error occured -- this might become
 517          * visible to an attacker (e.g. via a logfile)
 518          */
 519         al = SSL_AD_BAD_RECORD_MAC;
 520         SSLerr(SSL_F_SSL3_GET_RECORD,
 521                SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
 522         goto f_err;
 523     }
 524
 525     /* r->length is now just compressed */
 526     if (s->expand != NULL) {
 527         if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH + extra) {
 528             al = SSL_AD_RECORD_OVERFLOW;
 529             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_COMPRESSED_LENGTH_TOO_LONG);
 530             goto f_err;
 531         }
 532         if (!ssl3_do_uncompress(s)) {
 533             al = SSL_AD_DECOMPRESSION_FAILURE;
 534             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BAD_DECOMPRESSION);
 535             goto f_err;
 536         }
 537     }
 538
 539     if (rr->length > SSL3_RT_MAX_PLAIN_LENGTH + extra) {
 540         al = SSL_AD_RECORD_OVERFLOW;
 541         SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_DATA_LENGTH_TOO_LONG);
 542         goto f_err;
 543     }
 544
 545     rr->off = 0;
 546     /*-
 547      * So at this point the following is true
 548      * ssl->s3->rrec.type   is the type of record
 549      * ssl->s3->rrec.length == number of bytes in record
 550      * ssl->s3->rrec.off    == offset to first valid byte
 551      * ssl->s3->rrec.data   == where to take bytes from, increment
 552      *                         after use :-).
 553      */
 554
 555     /* we have pulled in a full packet so zero things */
 556     s->packet_length = 0;
 557
 558     /* just read a 0 length packet */
 559     if (rr->length == 0) {
 560         empty_record_count++;
 561         if (empty_record_count > MAX_EMPTY_RECORDS) {
 562             al = SSL_AD_UNEXPECTED_MESSAGE;
 563             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_RECORD_TOO_SMALL);
 564             goto f_err;
 565         }
 566         goto again;
 567     }
 568 #if 0
 569     fprintf(stderr, "Ultimate Record type=%d, Length=%d\n", rr->type,
 570             rr->length);
 571 #endif
 572
 573     return (1);
 574
 575  f_err:
 576     ssl3_send_alert(s, SSL3_AL_FATAL, al);
 577  err:
 578     return (ret);
 579 }
 580
 581 int ssl3_do_uncompress(SSL *ssl)
 582 {
 583 #ifndef OPENSSL_NO_COMP
 584     int i;
 585     SSL3_RECORD *rr;
 586
 587     rr = &(ssl->s3->rrec);
 588     i = COMP_expand_block(ssl->expand, rr->comp,
 589                           SSL3_RT_MAX_PLAIN_LENGTH, rr->data,
 590                           (int)rr->length);
 591     if (i < 0)
 592         return (0);
 593     else
 594         rr->length = i;
 595     rr->data = rr->comp;
 596 #endif
 597     return (1);
 598 }
 599
 600 int ssl3_do_compress(SSL *ssl)
 601 {
 602 #ifndef OPENSSL_NO_COMP
 603     int i;
 604     SSL3_RECORD *wr;
 605
 606     wr = &(ssl->s3->wrec);
 607     i = COMP_compress_block(ssl->compress, wr->data,
 608                             SSL3_RT_MAX_COMPRESSED_LENGTH,
 609                             wr->input, (int)wr->length);
 610     if (i < 0)
 611         return (0);
 612     else
 613         wr->length = i;
 614
 615     wr->input = wr->data;
 616 #endif
 617     return (1);
 618 }
 619
 620 /*
 621  * Call this to write data in records of type 'type' It will return <= 0 if
 622  * not all data has been sent or non-blocking IO.
 623  */
 624 int ssl3_write_bytes(SSL *s, int type, const void *buf_, int len)
 625 {
 626     const unsigned char *buf = buf_;
 627     int tot;
 628     unsigned int n, nw;
 629 #if !defined(OPENSSL_NO_MULTIBLOCK) && EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
 630     unsigned int max_send_fragment;
 631 #endif
 632     SSL3_BUFFER *wb = &(s->s3->wbuf);
 633     int i;
 634
 635     s->rwstate = SSL_NOTHING;
 636     OPENSSL_assert(s->s3->wnum <= INT_MAX);
 637     tot = s->s3->wnum;
 638     s->s3->wnum = 0;
 639
 640     if (SSL_in_init(s) && !s->in_handshake) {
 641         i = s->handshake_func(s);
 642         if (i < 0)
 643             return (i);
 644         if (i == 0) {
 645             SSLerr(SSL_F_SSL3_WRITE_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
 646             return -1;
 647         }
 648     }
 649
 650     /*
 651      * ensure that if we end up with a smaller value of data to write out
 652      * than the the original len from a write which didn't complete for
 653      * non-blocking I/O and also somehow ended up avoiding the check for
 654      * this in ssl3_write_pending/SSL_R_BAD_WRITE_RETRY as it must never be
 655      * possible to end up with (len-tot) as a large number that will then
 656      * promptly send beyond the end of the users buffer ... so we trap and
 657      * report the error in a way the user will notice
 658      */
 659     if (len < tot) {
 660         SSLerr(SSL_F_SSL3_WRITE_BYTES, SSL_R_BAD_LENGTH);
 661         return (-1);
 662     }
 663
 664     /*
 665      * first check if there is a SSL3_BUFFER still being written out.  This
 666      * will happen with non blocking IO
 667      */
 668     if (wb->left != 0) {
 669         i = ssl3_write_pending(s, type, &buf[tot], s->s3->wpend_tot);
 670         if (i <= 0) {
 671             /* XXX should we ssl3_release_write_buffer if i<0? */
 672             s->s3->wnum = tot;
 673             return i;
 674         }
 675         tot += i;               /* this might be last fragment */
 676     }
 677 #if !defined(OPENSSL_NO_MULTIBLOCK) && EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
 678     /*
 679      * Depending on platform multi-block can deliver several *times*
 680      * better performance. Downside is that it has to allocate
 681      * jumbo buffer to accomodate up to 8 records, but the
 682      * compromise is considered worthy.
 683      */
 684     if (type == SSL3_RT_APPLICATION_DATA &&
 685         len >= 4 * (int)(max_send_fragment = s->max_send_fragment) &&
 686         s->compress == NULL && s->msg_callback == NULL &&
 687         SSL_USE_EXPLICIT_IV(s) &&
 688         EVP_CIPHER_flags(s->enc_write_ctx->cipher) &
 689         EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK) {
 690         unsigned char aad[13];
 691         EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM mb_param;
 692         int packlen;
 693
 694         /* minimize address aliasing conflicts */
 695         if ((max_send_fragment & 0xfff) == 0)
 696             max_send_fragment -= 512;
 697
 698         if (tot == 0 || wb->buf == NULL) { /* allocate jumbo buffer */
 699             ssl3_release_write_buffer(s);
 700
 701             packlen = EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
 702                                           EVP_CTRL_TLS1_1_MULTIBLOCK_MAX_BUFSIZE,
 703                                           max_send_fragment, NULL);
 704
 705             if (len >= 8 * (int)max_send_fragment)
 706                 packlen *= 8;
 707             else
 708                 packlen *= 4;
 709
 710             wb->buf = OPENSSL_malloc(packlen);
 711             if(!wb->buf) {
 712                 SSLerr(SSL_F_SSL3_WRITE_BYTES, ERR_R_MALLOC_FAILURE);
 713                 return -1;
 714             }
 715             wb->len = packlen;
 716         } else if (tot == len) { /* done? */
 717             OPENSSL_free(wb->buf); /* free jumbo buffer */
 718             wb->buf = NULL;
 719             return tot;
 720         }
 721
 722         n = (len - tot);
 723         for (;;) {
 724             if (n < 4 * max_send_fragment) {
 725                 OPENSSL_free(wb->buf); /* free jumbo buffer */
 726                 wb->buf = NULL;
 727                 break;
 728             }
 729
 730             if (s->s3->alert_dispatch) {
 731                 i = s->method->ssl_dispatch_alert(s);
 732                 if (i <= 0) {
 733                     s->s3->wnum = tot;
 734                     return i;
 735                 }
 736             }
 737
 738             if (n >= 8 * max_send_fragment)
 739                 nw = max_send_fragment * (mb_param.interleave = 8);
 740             else
 741                 nw = max_send_fragment * (mb_param.interleave = 4);
 742
 743             memcpy(aad, s->s3->write_sequence, 8);
 744             aad[8] = type;
 745             aad[9] = (unsigned char)(s->version >> 8);
 746             aad[10] = (unsigned char)(s->version);
 747             aad[11] = 0;
 748             aad[12] = 0;
 749             mb_param.out = NULL;
 750             mb_param.inp = aad;
 751             mb_param.len = nw;
 752
 753             packlen = EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
 754                                           EVP_CTRL_TLS1_1_MULTIBLOCK_AAD,
 755                                           sizeof(mb_param), &mb_param);
 756
 757             if (packlen <= 0 || packlen > (int)wb->len) { /* never happens */
 758                 OPENSSL_free(wb->buf); /* free jumbo buffer */
 759                 wb->buf = NULL;
 760                 break;
 761             }
 762
 763             mb_param.out = wb->buf;
 764             mb_param.inp = &buf[tot];
 765             mb_param.len = nw;
 766
 767             if (EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
 768                                     EVP_CTRL_TLS1_1_MULTIBLOCK_ENCRYPT,
 769                                     sizeof(mb_param), &mb_param) <= 0)
 770                 return -1;
 771
 772             s->s3->write_sequence[7] += mb_param.interleave;
 773             if (s->s3->write_sequence[7] < mb_param.interleave) {
 774                 int j = 6;
 775                 while (j >= 0 && (++s->s3->write_sequence[j--]) == 0) ;
 776             }
 777
 778             wb->offset = 0;
 779             wb->left = packlen;
 780
 781             s->s3->wpend_tot = nw;
 782             s->s3->wpend_buf = &buf[tot];
 783             s->s3->wpend_type = type;
 784             s->s3->wpend_ret = nw;
 785
 786             i = ssl3_write_pending(s, type, &buf[tot], nw);
 787             if (i <= 0) {
 788                 if (i < 0) {
 789                     OPENSSL_free(wb->buf);
 790                     wb->buf = NULL;
 791                 }
 792                 s->s3->wnum = tot;
 793                 return i;
 794             }
 795             if (i == (int)n) {
 796                 OPENSSL_free(wb->buf); /* free jumbo buffer */
 797                 wb->buf = NULL;
 798                 return tot + i;
 799             }
 800             n -= i;
 801             tot += i;
 802         }
 803     } else
 804 #endif
 805     if (tot == len) {           /* done? */
 806         if (s->mode & SSL_MODE_RELEASE_BUFFERS && !SSL_IS_DTLS(s))
 807             ssl3_release_write_buffer(s);
 808
 809         return tot;
 810     }
 811
 812     n = (len - tot);
 813     for (;;) {
 814         if (n > s->max_send_fragment)
 815             nw = s->max_send_fragment;
 816         else
 817             nw = n;
 818
 819         i = do_ssl3_write(s, type, &(buf[tot]), nw, 0);
 820         if (i <= 0) {
 821             /* XXX should we ssl3_release_write_buffer if i<0? */
 822             s->s3->wnum = tot;
 823             return i;
 824         }
 825
 826         if ((i == (int)n) ||
 827             (type == SSL3_RT_APPLICATION_DATA &&
 828              (s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE))) {
 829             /*
 830              * next chunk of data should get another prepended empty fragment
 831              * in ciphersuites with known-IV weakness:
 832              */
 833             s->s3->empty_fragment_done = 0;
 834
 835             if ((i == (int)n) && s->mode & SSL_MODE_RELEASE_BUFFERS &&
 836                 !SSL_IS_DTLS(s))
 837                 ssl3_release_write_buffer(s);
 838
 839             return tot + i;
 840         }
 841
 842         n -= i;
 843         tot += i;
 844     }
 845 }
 846
 847 static int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
 848                          unsigned int len, int create_empty_fragment)
 849 {
 850     unsigned char *p, *plen;
 851     int i, mac_size, clear = 0;
 852     int prefix_len = 0;
 853     int eivlen;
 854     long align = 0;
 855     SSL3_RECORD *wr;
 856     SSL3_BUFFER *wb = &(s->s3->wbuf);
 857     SSL_SESSION *sess;
 858
 859     /*
 860      * first check if there is a SSL3_BUFFER still being written out.  This
 861      * will happen with non blocking IO
 862      */
 863     if (wb->left != 0)
 864         return (ssl3_write_pending(s, type, buf, len));
 865
 866     /* If we have an alert to send, lets send it */
 867     if (s->s3->alert_dispatch) {
 868         i = s->method->ssl_dispatch_alert(s);
 869         if (i <= 0)
 870             return (i);
 871         /* if it went, fall through and send more stuff */
 872     }
 873
 874     if (wb->buf == NULL)
 875         if (!ssl3_setup_write_buffer(s))
 876             return -1;
 877
 878     if (len == 0 && !create_empty_fragment)
 879         return 0;
 880
 881     wr = &(s->s3->wrec);
 882     sess = s->session;
 883
 884     if ((sess == NULL) ||
 885         (s->enc_write_ctx == NULL) ||
 886         (EVP_MD_CTX_md(s->write_hash) == NULL)) {
 887 #if 1
 888         clear = s->enc_write_ctx ? 0 : 1; /* must be AEAD cipher */
 889 #else
 890         clear = 1;
 891 #endif
 892         mac_size = 0;
 893     } else {
 894         mac_size = EVP_MD_CTX_size(s->write_hash);
 895         if (mac_size < 0)
 896             goto err;
 897     }
 898
 899     /*
 900      * 'create_empty_fragment' is true only when this function calls itself
 901      */
 902     if (!clear && !create_empty_fragment && !s->s3->empty_fragment_done) {
 903         /*
 904          * countermeasure against known-IV weakness in CBC ciphersuites (see
 905          * http://www.openssl.org/~bodo/tls-cbc.txt)
 906          */
 907
 908         if (s->s3->need_empty_fragments && type == SSL3_RT_APPLICATION_DATA) {
 909             /*
 910              * recursive function call with 'create_empty_fragment' set; this
 911              * prepares and buffers the data for an empty fragment (these
 912              * 'prefix_len' bytes are sent out later together with the actual
 913              * payload)
 914              */
 915             prefix_len = do_ssl3_write(s, type, buf, 0, 1);
 916             if (prefix_len <= 0)
 917                 goto err;
 918
 919             if (prefix_len >
 920                 (SSL3_RT_HEADER_LENGTH + SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD))
 921             {
 922                 /* insufficient space */
 923                 SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
 924                 goto err;
 925             }
 926         }
 927
 928         s->s3->empty_fragment_done = 1;
 929     }
 930
 931     if (create_empty_fragment) {
 932 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
 933         /*
 934          * extra fragment would be couple of cipher blocks, which would be
 935          * multiple of SSL3_ALIGN_PAYLOAD, so if we want to align the real
 936          * payload, then we can just pretent we simply have two headers.
 937          */
 938         align = (long)wb->buf + 2 * SSL3_RT_HEADER_LENGTH;
 939         align = (-align) & (SSL3_ALIGN_PAYLOAD - 1);
 940 #endif
 941         p = wb->buf + align;
 942         wb->offset = align;
 943     } else if (prefix_len) {
 944         p = wb->buf + wb->offset + prefix_len;
 945     } else {
 946 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
 947         align = (long)wb->buf + SSL3_RT_HEADER_LENGTH;
 948         align = (-align) & (SSL3_ALIGN_PAYLOAD - 1);
 949 #endif
 950         p = wb->buf + align;
 951         wb->offset = align;
 952     }
 953
 954     /* write the header */
 955
 956     *(p++) = type & 0xff;
 957     wr->type = type;
 958
 959     *(p++) = (s->version >> 8);
 960     /*
 961      * Some servers hang if iniatial client hello is larger than 256 bytes
 962      * and record version number > TLS 1.0
 963      */
 964     if (s->state == SSL3_ST_CW_CLNT_HELLO_B
 965         && !s->renegotiate && TLS1_get_version(s) > TLS1_VERSION)
 966         *(p++) = 0x1;
 967     else
 968         *(p++) = s->version & 0xff;
 969
 970     /* field where we are to write out packet length */
 971     plen = p;
 972     p += 2;
 973     /* Explicit IV length, block ciphers appropriate version flag */
 974     if (s->enc_write_ctx && SSL_USE_EXPLICIT_IV(s)) {
 975         int mode = EVP_CIPHER_CTX_mode(s->enc_write_ctx);
 976         if (mode == EVP_CIPH_CBC_MODE) {
 977             eivlen = EVP_CIPHER_CTX_iv_length(s->enc_write_ctx);
 978             if (eivlen <= 1)
 979                 eivlen = 0;
 980         }
 981         /* Need explicit part of IV for GCM mode */
 982         else if (mode == EVP_CIPH_GCM_MODE)
 983             eivlen = EVP_GCM_TLS_EXPLICIT_IV_LEN;
 984         else
 985             eivlen = 0;
 986     } else
 987         eivlen = 0;
 988
 989     /* lets setup the record stuff. */
 990     wr->data = p + eivlen;
 991     wr->length = (int)len;
 992     wr->input = (unsigned char *)buf;
 993
 994     /*
 995      * we now 'read' from wr->input, wr->length bytes into wr->data
 996      */
 997
 998     /* first we compress */
 999     if (s->compress != NULL) {
1000         if (!ssl3_do_compress(s)) {
1001             SSLerr(SSL_F_DO_SSL3_WRITE, SSL_R_COMPRESSION_FAILURE);
1002             goto err;
1003         }
1004     } else {
1005         memcpy(wr->data, wr->input, wr->length);
1006         wr->input = wr->data;
1007     }
1008
1009     /*
1010      * we should still have the output to wr->data and the input from
1011      * wr->input.  Length should be wr->length. wr->data still points in the
1012      * wb->buf
1013      */
1014
1015     if (mac_size != 0) {
1016         if (s->method->ssl3_enc->mac(s, &(p[wr->length + eivlen]), 1) < 0)
1017             goto err;
1018         wr->length += mac_size;
1019     }
1020
1021     wr->input = p;
1022     wr->data = p;
1023
1024     if (eivlen) {
1025         /*
1026          * if (RAND_pseudo_bytes(p, eivlen) <= 0) goto err;
1027          */
1028         wr->length += eivlen;
1029     }
1030
1031     if (s->method->ssl3_enc->enc(s, 1) < 1)
1032         goto err;
1033
1034     /* record length after mac and block padding */
1035     s2n(wr->length, plen);
1036
1037     if (s->msg_callback)
1038         s->msg_callback(1, 0, SSL3_RT_HEADER, plen - 5, 5, s,
1039                         s->msg_callback_arg);
1040
1041     /*
1042      * we should now have wr->data pointing to the encrypted data, which is
1043      * wr->length long
1044      */
1045     wr->type = type;            /* not needed but helps for debugging */
1046     wr->length += SSL3_RT_HEADER_LENGTH;
1047
1048     if (create_empty_fragment) {
1049         /*
1050          * we are in a recursive call; just return the length, don't write
1051          * out anything here
1052          */
1053         return wr->length;
1054     }
1055
1056     /* now let's set up wb */
1057     wb->left = prefix_len + wr->length;
1058
1059     /*
1060      * memorize arguments so that ssl3_write_pending can detect bad write
1061      * retries later
1062      */
1063     s->s3->wpend_tot = len;
1064     s->s3->wpend_buf = buf;
1065     s->s3->wpend_type = type;
1066     s->s3->wpend_ret = len;
1067
1068     /* we now just need to write the buffer */
1069     return ssl3_write_pending(s, type, buf, len);
1070  err:
1071     return -1;
1072 }
1073
1074 /* if s->s3->wbuf.left != 0, we need to call this */
1075 int ssl3_write_pending(SSL *s, int type, const unsigned char *buf,
1076                        unsigned int len)
1077 {
1078     int i;
1079     SSL3_BUFFER *wb = &(s->s3->wbuf);
1080
1081 /* XXXX */
1082     if ((s->s3->wpend_tot > (int)len)
1083         || ((s->s3->wpend_buf != buf) &&
1084             !(s->mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER))
1085         || (s->s3->wpend_type != type)) {
1086         SSLerr(SSL_F_SSL3_WRITE_PENDING, SSL_R_BAD_WRITE_RETRY);
1087         return (-1);
1088     }
1089
1090     for (;;) {
1091         clear_sys_error();
1092         if (s->wbio != NULL) {
1093             s->rwstate = SSL_WRITING;
1094             i = BIO_write(s->wbio,
1095                           (char *)&(wb->buf[wb->offset]),
1096                           (unsigned int)wb->left);
1097         } else {
1098             SSLerr(SSL_F_SSL3_WRITE_PENDING, SSL_R_BIO_NOT_SET);
1099             i = -1;
1100         }
1101         if (i == wb->left) {
1102             wb->left = 0;
1103             wb->offset += i;
1104             s->rwstate = SSL_NOTHING;
1105             return (s->s3->wpend_ret);
1106         } else if (i <= 0) {
1107             if (s->version == DTLS1_VERSION || s->version == DTLS1_BAD_VER) {
1108                 /*
1109                  * For DTLS, just drop it. That's kind of the whole point in
1110                  * using a datagram service
1111                  */
1112                 wb->left = 0;
1113             }
1114             return (i);
1115         }
1116         wb->offset += i;
1117         wb->left -= i;
1118     }
1119 }
1120
1121 /*-
1122  * Return up to 'len' payload bytes received in 'type' records.
1123  * 'type' is one of the following:
1124  *
1125  *   -  SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
1126  *   -  SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
1127  *   -  0 (during a shutdown, no data has to be returned)
1128  *
1129  * If we don't have stored data to work from, read a SSL/TLS record first
1130  * (possibly multiple records if we still don't have anything to return).
1131  *
1132  * This function must handle any surprises the peer may have for us, such as
1133  * Alert records (e.g. close_notify), ChangeCipherSpec records (not really
1134  * a surprise, but handled as if it were), or renegotiation requests.
1135  * Also if record payloads contain fragments too small to process, we store
1136  * them until there is enough for the respective protocol (the record protocol
1137  * may use arbitrary fragmentation and even interleaving):
1138  *     Change cipher spec protocol
1139  *             just 1 byte needed, no need for keeping anything stored
1140  *     Alert protocol
1141  *             2 bytes needed (AlertLevel, AlertDescription)
1142  *     Handshake protocol
1143  *             4 bytes needed (HandshakeType, uint24 length) -- we just have
1144  *             to detect unexpected Client Hello and Hello Request messages
1145  *             here, anything else is handled by higher layers
1146  *     Application data protocol
1147  *             none of our business
1148  */
1149 int ssl3_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek)
1150 {
1151     int al, i, j, ret;
1152     unsigned int n;
1153     SSL3_RECORD *rr;
1154     void (*cb) (const SSL *ssl, int type2, int val) = NULL;
1155
1156     if (s->s3->rbuf.buf == NULL) /* Not initialized yet */
1157         if (!ssl3_setup_read_buffer(s))
1158             return (-1);
1159
1160     if ((type && (type != SSL3_RT_APPLICATION_DATA)
1161          && (type != SSL3_RT_HANDSHAKE)) || (peek
1162                                              && (type !=
1163                                                  SSL3_RT_APPLICATION_DATA))) {
1164         SSLerr(SSL_F_SSL3_READ_BYTES, ERR_R_INTERNAL_ERROR);
1165         return -1;
1166     }
1167
1168     if ((type == SSL3_RT_HANDSHAKE) && (s->s3->handshake_fragment_len > 0))
1169         /* (partially) satisfy request from storage */
1170     {
1171         unsigned char *src = s->s3->handshake_fragment;
1172         unsigned char *dst = buf;
1173         unsigned int k;
1174
1175         /* peek == 0 */
1176         n = 0;
1177         while ((len > 0) && (s->s3->handshake_fragment_len > 0)) {
1178             *dst++ = *src++;
1179             len--;
1180             s->s3->handshake_fragment_len--;
1181             n++;
1182         }
1183         /* move any remaining fragment bytes: */
1184         for (k = 0; k < s->s3->handshake_fragment_len; k++)
1185             s->s3->handshake_fragment[k] = *src++;
1186         return n;
1187     }
1188
1189     /*
1190      * Now s->s3->handshake_fragment_len == 0 if type == SSL3_RT_HANDSHAKE.
1191      */
1192
1193     if (!s->in_handshake && SSL_in_init(s)) {
1194         /* type == SSL3_RT_APPLICATION_DATA */
1195         i = s->handshake_func(s);
1196         if (i < 0)
1197             return (i);
1198         if (i == 0) {
1199             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
1200             return (-1);
1201         }
1202     }
1203  start:
1204     s->rwstate = SSL_NOTHING;
1205
1206     /*-
1207      * s->s3->rrec.type         - is the type of record
1208      * s->s3->rrec.data,    - data
1209      * s->s3->rrec.off,     - offset into 'data' for next read
1210      * s->s3->rrec.length,  - number of bytes.
1211      */
1212     rr = &(s->s3->rrec);
1213
1214     /* get new packet if necessary */
1215     if ((rr->length == 0) || (s->rstate == SSL_ST_READ_BODY)) {
1216         ret = ssl3_get_record(s);
1217         if (ret <= 0)
1218             return (ret);
1219     }
1220
1221     /* we now have a packet which can be read and processed */
1222
1223     if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
1224                                    * reset by ssl3_get_finished */
1225         && (rr->type != SSL3_RT_HANDSHAKE)) {
1226         al = SSL_AD_UNEXPECTED_MESSAGE;
1227         SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_DATA_BETWEEN_CCS_AND_FINISHED);
1228         goto f_err;
1229     }
1230
1231     /*
1232      * If the other end has shut down, throw anything we read away (even in
1233      * 'peek' mode)
1234      */
1235     if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1236         rr->length = 0;
1237         s->rwstate = SSL_NOTHING;
1238         return (0);
1239     }
1240
1241     if (type == rr->type) {     /* SSL3_RT_APPLICATION_DATA or
1242                                  * SSL3_RT_HANDSHAKE */
1243         /*
1244          * make sure that we are not getting application data when we are
1245          * doing a handshake for the first time
1246          */
1247         if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
1248             (s->enc_read_ctx == NULL)) {
1249             al = SSL_AD_UNEXPECTED_MESSAGE;
1250             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_APP_DATA_IN_HANDSHAKE);
1251             goto f_err;
1252         }
1253
1254         if (len <= 0)
1255             return (len);
1256
1257         if ((unsigned int)len > rr->length)
1258             n = rr->length;
1259         else
1260             n = (unsigned int)len;
1261
1262         memcpy(buf, &(rr->data[rr->off]), n);
1263         if (!peek) {
1264             rr->length -= n;
1265             rr->off += n;
1266             if (rr->length == 0) {
1267                 s->rstate = SSL_ST_READ_HEADER;
1268                 rr->off = 0;
1269                 if (s->mode & SSL_MODE_RELEASE_BUFFERS
1270                     && s->s3->rbuf.left == 0)
1271                     ssl3_release_read_buffer(s);
1272             }
1273         }
1274         return (n);
1275     }
1276
1277     /*
1278      * If we get here, then type != rr->type; if we have a handshake message,
1279      * then it was unexpected (Hello Request or Client Hello).
1280      */
1281
1282     /*
1283      * In case of record types for which we have 'fragment' storage, fill
1284      * that so that we can process the data at a fixed place.
1285      */
1286     {
1287         unsigned int dest_maxlen = 0;
1288         unsigned char *dest = NULL;
1289         unsigned int *dest_len = NULL;
1290
1291         if (rr->type == SSL3_RT_HANDSHAKE) {
1292             dest_maxlen = sizeof s->s3->handshake_fragment;
1293             dest = s->s3->handshake_fragment;
1294             dest_len = &s->s3->handshake_fragment_len;
1295         } else if (rr->type == SSL3_RT_ALERT) {
1296             dest_maxlen = sizeof s->s3->alert_fragment;
1297             dest = s->s3->alert_fragment;
1298             dest_len = &s->s3->alert_fragment_len;
1299         }
1300 #ifndef OPENSSL_NO_HEARTBEATS
1301         else if (rr->type == TLS1_RT_HEARTBEAT) {
1302             tls1_process_heartbeat(s);
1303
1304             /* Exit and notify application to read again */
1305             rr->length = 0;
1306             s->rwstate = SSL_READING;
1307             BIO_clear_retry_flags(SSL_get_rbio(s));
1308             BIO_set_retry_read(SSL_get_rbio(s));
1309             return (-1);
1310         }
1311 #endif
1312
1313         if (dest_maxlen > 0) {
1314             n = dest_maxlen - *dest_len; /* available space in 'dest' */
1315             if (rr->length < n)
1316                 n = rr->length; /* available bytes */
1317
1318             /* now move 'n' bytes: */
1319             while (n-- > 0) {
1320                 dest[(*dest_len)++] = rr->data[rr->off++];
1321                 rr->length--;
1322             }
1323
1324             if (*dest_len < dest_maxlen)
1325                 goto start;     /* fragment was too small */
1326         }
1327     }
1328
1329     /*-
1330      * s->s3->handshake_fragment_len == 4  iff  rr->type == SSL3_RT_HANDSHAKE;
1331      * s->s3->alert_fragment_len == 2      iff  rr->type == SSL3_RT_ALERT.
1332      * (Possibly rr is 'empty' now, i.e. rr->length may be 0.)
1333      */
1334
1335     /* If we are a client, check for an incoming 'Hello Request': */
1336     if ((!s->server) &&
1337         (s->s3->handshake_fragment_len >= 4) &&
1338         (s->s3->handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
1339         (s->session != NULL) && (s->session->cipher != NULL)) {
1340         s->s3->handshake_fragment_len = 0;
1341
1342         if ((s->s3->handshake_fragment[1] != 0) ||
1343             (s->s3->handshake_fragment[2] != 0) ||
1344             (s->s3->handshake_fragment[3] != 0)) {
1345             al = SSL_AD_DECODE_ERROR;
1346             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_BAD_HELLO_REQUEST);
1347             goto f_err;
1348         }
1349
1350         if (s->msg_callback)
1351             s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
1352                             s->s3->handshake_fragment, 4, s,
1353                             s->msg_callback_arg);
1354
1355         if (SSL_is_init_finished(s) &&
1356             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
1357             !s->s3->renegotiate) {
1358             ssl3_renegotiate(s);
1359             if (ssl3_renegotiate_check(s)) {
1360                 i = s->handshake_func(s);
1361                 if (i < 0)
1362                     return (i);
1363                 if (i == 0) {
1364                     SSLerr(SSL_F_SSL3_READ_BYTES,
1365                            SSL_R_SSL_HANDSHAKE_FAILURE);
1366                     return (-1);
1367                 }
1368
1369                 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
1370                     if (s->s3->rbuf.left == 0) { /* no read-ahead left? */
1371                         BIO *bio;
1372                         /*
1373                          * In the case where we try to read application data,
1374                          * but we trigger an SSL handshake, we return -1 with
1375                          * the retry option set.  Otherwise renegotiation may
1376                          * cause nasty problems in the blocking world
1377                          */
1378                         s->rwstate = SSL_READING;
1379                         bio = SSL_get_rbio(s);
1380                         BIO_clear_retry_flags(bio);
1381                         BIO_set_retry_read(bio);
1382                         return (-1);
1383                     }
1384                 }
1385             }
1386         }
1387         /*
1388          * we either finished a handshake or ignored the request, now try
1389          * again to obtain the (application) data we were asked for
1390          */
1391         goto start;
1392     }
1393     /*
1394      * If we are a server and get a client hello when renegotiation isn't
1395      * allowed send back a no renegotiation alert and carry on. WARNING:
1396      * experimental code, needs reviewing (steve)
1397      */
1398     if (s->server &&
1399         SSL_is_init_finished(s) &&
1400         !s->s3->send_connection_binding &&
1401         (s->version > SSL3_VERSION) &&
1402         (s->s3->handshake_fragment_len >= 4) &&
1403         (s->s3->handshake_fragment[0] == SSL3_MT_CLIENT_HELLO) &&
1404         (s->session != NULL) && (s->session->cipher != NULL) &&
1405         !(s->ctx->options & SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)) {
1406         /*
1407          * s->s3->handshake_fragment_len = 0;
1408          */
1409         rr->length = 0;
1410         ssl3_send_alert(s, SSL3_AL_WARNING, SSL_AD_NO_RENEGOTIATION);
1411         goto start;
1412     }
1413     if (s->s3->alert_fragment_len >= 2) {
1414         int alert_level = s->s3->alert_fragment[0];
1415         int alert_descr = s->s3->alert_fragment[1];
1416
1417         s->s3->alert_fragment_len = 0;
1418
1419         if (s->msg_callback)
1420             s->msg_callback(0, s->version, SSL3_RT_ALERT,
1421                             s->s3->alert_fragment, 2, s, s->msg_callback_arg);
1422
1423         if (s->info_callback != NULL)
1424             cb = s->info_callback;
1425         else if (s->ctx->info_callback != NULL)
1426             cb = s->ctx->info_callback;
1427
1428         if (cb != NULL) {
1429             j = (alert_level << 8) | alert_descr;
1430             cb(s, SSL_CB_READ_ALERT, j);
1431         }
1432
1433         if (alert_level == SSL3_AL_WARNING) {
1434             s->s3->warn_alert = alert_descr;
1435             if (alert_descr == SSL_AD_CLOSE_NOTIFY) {
1436                 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
1437                 return (0);
1438             }
1439             /*
1440              * This is a warning but we receive it if we requested
1441              * renegotiation and the peer denied it. Terminate with a fatal
1442              * alert because if application tried to renegotiatie it
1443              * presumably had a good reason and expects it to succeed. In
1444              * future we might have a renegotiation where we don't care if
1445              * the peer refused it where we carry on.
1446              */
1447             else if (alert_descr == SSL_AD_NO_RENEGOTIATION) {
1448                 al = SSL_AD_HANDSHAKE_FAILURE;
1449                 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_NO_RENEGOTIATION);
1450                 goto f_err;
1451             }
1452 #ifdef SSL_AD_MISSING_SRP_USERNAME
1453             else if (alert_descr == SSL_AD_MISSING_SRP_USERNAME)
1454                 return (0);
1455 #endif
1456         } else if (alert_level == SSL3_AL_FATAL) {
1457             char tmp[16];
1458
1459             s->rwstate = SSL_NOTHING;
1460             s->s3->fatal_alert = alert_descr;
1461             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_AD_REASON_OFFSET + alert_descr);
1462             BIO_snprintf(tmp, sizeof tmp, "%d", alert_descr);
1463             ERR_add_error_data(2, "SSL alert number ", tmp);
1464             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
1465             SSL_CTX_remove_session(s->ctx, s->session);
1466             return (0);
1467         } else {
1468             al = SSL_AD_ILLEGAL_PARAMETER;
1469             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_UNKNOWN_ALERT_TYPE);
1470             goto f_err;
1471         }
1472
1473         goto start;
1474     }
1475
1476     if (s->shutdown & SSL_SENT_SHUTDOWN) { /* but we have not received a
1477                                             * shutdown */
1478         s->rwstate = SSL_NOTHING;
1479         rr->length = 0;
1480         return (0);
1481     }
1482
1483     if (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC) {
1484         /*
1485          * 'Change Cipher Spec' is just a single byte, so we know exactly
1486          * what the record payload has to look like
1487          */
1488         if ((rr->length != 1) || (rr->off != 0) ||
1489             (rr->data[0] != SSL3_MT_CCS)) {
1490             al = SSL_AD_ILLEGAL_PARAMETER;
1491             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_BAD_CHANGE_CIPHER_SPEC);
1492             goto f_err;
1493         }
1494
1495         /* Check we have a cipher to change to */
1496         if (s->s3->tmp.new_cipher == NULL) {
1497             al = SSL_AD_UNEXPECTED_MESSAGE;
1498             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_CCS_RECEIVED_EARLY);
1499             goto f_err;
1500         }
1501
1502         if (!(s->s3->flags & SSL3_FLAGS_CCS_OK)) {
1503             al = SSL_AD_UNEXPECTED_MESSAGE;
1504             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_CCS_RECEIVED_EARLY);
1505             goto f_err;
1506         }
1507
1508         s->s3->flags &= ~SSL3_FLAGS_CCS_OK;
1509
1510         rr->length = 0;
1511
1512         if (s->msg_callback)
1513             s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
1514                             rr->data, 1, s, s->msg_callback_arg);
1515
1516         s->s3->change_cipher_spec = 1;
1517         if (!ssl3_do_change_cipher_spec(s))
1518             goto err;
1519         else
1520             goto start;
1521     }
1522
1523     /*
1524      * Unexpected handshake message (Client Hello, or protocol violation)
1525      */
1526     if ((s->s3->handshake_fragment_len >= 4) && !s->in_handshake) {
1527         if (((s->state & SSL_ST_MASK) == SSL_ST_OK) &&
1528             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS)) {
1529 #if 0                           /* worked only because C operator preferences
1530                                  * are not as expected (and because this is
1531                                  * not really needed for clients except for
1532                                  * detecting protocol violations): */
1533             s->state = SSL_ST_BEFORE | (s->server)
1534                 ? SSL_ST_ACCEPT : SSL_ST_CONNECT;
1535 #else
1536             s->state = s->server ? SSL_ST_ACCEPT : SSL_ST_CONNECT;
1537 #endif
1538             s->renegotiate = 1;
1539             s->new_session = 1;
1540         }
1541         i = s->handshake_func(s);
1542         if (i < 0)
1543             return (i);
1544         if (i == 0) {
1545             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
1546             return (-1);
1547         }
1548
1549         if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
1550             if (s->s3->rbuf.left == 0) { /* no read-ahead left? */
1551                 BIO *bio;
1552                 /*
1553                  * In the case where we try to read application data, but we
1554                  * trigger an SSL handshake, we return -1 with the retry
1555                  * option set.  Otherwise renegotiation may cause nasty
1556                  * problems in the blocking world
1557                  */
1558                 s->rwstate = SSL_READING;
1559                 bio = SSL_get_rbio(s);
1560                 BIO_clear_retry_flags(bio);
1561                 BIO_set_retry_read(bio);
1562                 return (-1);
1563             }
1564         }
1565         goto start;
1566     }
1567
1568     switch (rr->type) {
1569     default:
1570 #ifndef OPENSSL_NO_TLS
1571         /*
1572          * TLS up to v1.1 just ignores unknown message types: TLS v1.2 give
1573          * an unexpected message alert.
1574          */
1575         if (s->version >= TLS1_VERSION && s->version <= TLS1_1_VERSION) {
1576             rr->length = 0;
1577             goto start;
1578         }
1579 #endif
1580         al = SSL_AD_UNEXPECTED_MESSAGE;
1581         SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1582         goto f_err;
1583     case SSL3_RT_CHANGE_CIPHER_SPEC:
1584     case SSL3_RT_ALERT:
1585     case SSL3_RT_HANDSHAKE:
1586         /*
1587          * we already handled all of these, with the possible exception of
1588          * SSL3_RT_HANDSHAKE when s->in_handshake is set, but that should not
1589          * happen when type != rr->type
1590          */
1591         al = SSL_AD_UNEXPECTED_MESSAGE;
1592         SSLerr(SSL_F_SSL3_READ_BYTES, ERR_R_INTERNAL_ERROR);
1593         goto f_err;
1594     case SSL3_RT_APPLICATION_DATA:
1595         /*
1596          * At this point, we were expecting handshake data, but have
1597          * application data.  If the library was running inside ssl3_read()
1598          * (i.e. in_read_app_data is set) and it makes sense to read
1599          * application data at this point (session renegotiation not yet
1600          * started), we will indulge it.
1601          */
1602         if (s->s3->in_read_app_data &&
1603             (s->s3->total_renegotiations != 0) &&
1604             (((s->state & SSL_ST_CONNECT) &&
1605               (s->state >= SSL3_ST_CW_CLNT_HELLO_A) &&
1606               (s->state <= SSL3_ST_CR_SRVR_HELLO_A)
1607              ) || ((s->state & SSL_ST_ACCEPT) &&
1608                    (s->state <= SSL3_ST_SW_HELLO_REQ_A) &&
1609                    (s->state >= SSL3_ST_SR_CLNT_HELLO_A)
1610              )
1611             )) {
1612             s->s3->in_read_app_data = 2;
1613             return (-1);
1614         } else {
1615             al = SSL_AD_UNEXPECTED_MESSAGE;
1616             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1617             goto f_err;
1618         }
1619     }
1620     /* not reached */
1621
1622  f_err:
1623     ssl3_send_alert(s, SSL3_AL_FATAL, al);
1624  err:
1625     return (-1);
1626 }
1627
1628 int ssl3_do_change_cipher_spec(SSL *s)
1629 {
1630     int i;
1631     const char *sender;
1632     int slen;
1633
1634     if (s->state & SSL_ST_ACCEPT)
1635         i = SSL3_CHANGE_CIPHER_SERVER_READ;
1636     else
1637         i = SSL3_CHANGE_CIPHER_CLIENT_READ;
1638
1639     if (s->s3->tmp.key_block == NULL) {
1640         if (s->session == NULL || s->session->master_key_length == 0) {
1641             /* might happen if dtls1_read_bytes() calls this */
1642             SSLerr(SSL_F_SSL3_DO_CHANGE_CIPHER_SPEC,
1643                    SSL_R_CCS_RECEIVED_EARLY);
1644             return (0);
1645         }
1646
1647         s->session->cipher = s->s3->tmp.new_cipher;
1648         if (!s->method->ssl3_enc->setup_key_block(s))
1649             return (0);
1650     }
1651
1652     if (!s->method->ssl3_enc->change_cipher_state(s, i))
1653         return (0);
1654
1655     /*
1656      * we have to record the message digest at this point so we can get it
1657      * before we read the finished message
1658      */
1659     if (s->state & SSL_ST_CONNECT) {
1660         sender = s->method->ssl3_enc->server_finished_label;
1661         slen = s->method->ssl3_enc->server_finished_label_len;
1662     } else {
1663         sender = s->method->ssl3_enc->client_finished_label;
1664         slen = s->method->ssl3_enc->client_finished_label_len;
1665     }
1666
1667     i = s->method->ssl3_enc->final_finish_mac(s,
1668                                               sender, slen,
1669                                               s->s3->tmp.peer_finish_md);
1670     if (i == 0) {
1671         SSLerr(SSL_F_SSL3_DO_CHANGE_CIPHER_SPEC, ERR_R_INTERNAL_ERROR);
1672         return 0;
1673     }
1674     s->s3->tmp.peer_finish_md_len = i;
1675
1676     return (1);
1677 }
1678
1679 int ssl3_send_alert(SSL *s, int level, int desc)
1680 {
1681     /* Map tls/ssl alert value to correct one */
1682     desc = s->method->ssl3_enc->alert_value(desc);
1683     if (s->version == SSL3_VERSION && desc == SSL_AD_PROTOCOL_VERSION)
1684         desc = SSL_AD_HANDSHAKE_FAILURE; /* SSL 3.0 does not have
1685                                           * protocol_version alerts */
1686     if (desc < 0)
1687         return -1;
1688     /* If a fatal one, remove from cache */
1689     if ((level == 2) && (s->session != NULL))
1690         SSL_CTX_remove_session(s->ctx, s->session);
1691
1692     s->s3->alert_dispatch = 1;
1693     s->s3->send_alert[0] = level;
1694     s->s3->send_alert[1] = desc;
1695     if (s->s3->wbuf.left == 0)  /* data still being written out? */
1696         return s->method->ssl_dispatch_alert(s);
1697     /*
1698      * else data is still being written out, we will get written some time in
1699      * the future
1700      */
1701     return -1;
1702 }
1703
1704 int ssl3_dispatch_alert(SSL *s)
1705 {
1706     int i, j;
1707     void (*cb) (const SSL *ssl, int type, int val) = NULL;
1708
1709     s->s3->alert_dispatch = 0;
1710     i = do_ssl3_write(s, SSL3_RT_ALERT, &s->s3->send_alert[0], 2, 0);
1711     if (i <= 0) {
1712         s->s3->alert_dispatch = 1;
1713     } else {
1714         /*
1715          * Alert sent to BIO.  If it is important, flush it now. If the
1716          * message does not get sent due to non-blocking IO, we will not
1717          * worry too much.
1718          */
1719         if (s->s3->send_alert[0] == SSL3_AL_FATAL)
1720             (void)BIO_flush(s->wbio);
1721
1722         if (s->msg_callback)
1723             s->msg_callback(1, s->version, SSL3_RT_ALERT, s->s3->send_alert,
1724                             2, s, s->msg_callback_arg);
1725
1726         if (s->info_callback != NULL)
1727             cb = s->info_callback;
1728         else if (s->ctx->info_callback != NULL)
1729             cb = s->ctx->info_callback;
1730
1731         if (cb != NULL) {
1732             j = (s->s3->send_alert[0] << 8) | s->s3->send_alert[1];
1733             cb(s, SSL_CB_WRITE_ALERT, j);
1734         }
1735     }
1736     return (i);
1737 }