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