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