2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
58 /* ====================================================================
59 * Copyright (c) 1998-2002 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
116 #include "ssl_locl.h"
117 #include <openssl/evp.h>
118 #include <openssl/buffer.h>
119 #include <openssl/rand.h>
121 #ifndef EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
122 # define EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK 0
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__) ) \
131 # undef EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
132 # define EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK 0
135 int ssl3_read_n(SSL *s, int n, int max, int extend)
138 * If extend == 0, obtain new n-byte packet; if extend == 1, increase
139 * packet by another n bytes. The packet will be in the sub-array of
140 * s->s3->rbuf.buf specified by s->packet and s->packet_length. (If
141 * s->rlayer.read_ahead is set, 'max' bytes may be stored in rbuf [plus
142 * s->packet_length bytes if extend == 1].)
152 rb = RECORD_LAYER_get_rbuf(&s->rlayer);
154 if (!ssl3_setup_read_buffer(s))
158 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
159 align = (long)rb->buf + SSL3_RT_HEADER_LENGTH;
160 align = (-align) & (SSL3_ALIGN_PAYLOAD - 1);
164 /* start with empty packet ... */
167 else if (align != 0 && left >= SSL3_RT_HEADER_LENGTH) {
169 * check if next packet length is large enough to justify payload
172 pkt = rb->buf + rb->offset;
173 if (pkt[0] == SSL3_RT_APPLICATION_DATA
174 && (pkt[3] << 8 | pkt[4]) >= 128) {
176 * Note that even if packet is corrupted and its length field
177 * is insane, we can only be led to wrong decision about
178 * whether memmove will occur or not. Header values has no
179 * effect on memmove arguments and therefore no buffer
180 * overrun can be triggered.
182 memmove(rb->buf + align, pkt, left);
186 s->packet = rb->buf + rb->offset;
187 s->packet_length = 0;
188 /* ... now we can act as if 'extend' was set */
192 * For DTLS/UDP reads should not span multiple packets because the read
193 * operation returns the whole packet at once (as long as it fits into
196 if (SSL_IS_DTLS(s)) {
197 if (left == 0 && extend)
199 if (left > 0 && n > left)
203 /* if there is enough in the buffer from a previous read, take some */
205 s->packet_length += n;
211 /* else we need to read more data */
213 len = s->packet_length;
214 pkt = rb->buf + align;
216 * Move any available bytes to front of buffer: 'len' bytes already
217 * pointed to by 'packet', 'left' extra ones at the end
219 if (s->packet != pkt) { /* len > 0 */
220 memmove(pkt, s->packet, len + left);
222 rb->offset = len + align;
225 if (n > (int)(rb->len - rb->offset)) { /* does not happen */
226 SSLerr(SSL_F_SSL3_READ_N, ERR_R_INTERNAL_ERROR);
230 /* We always act like read_ahead is set for DTLS */
231 if (!RECORD_LAYER_get_read_ahead(&s->rlayer) && !SSL_IS_DTLS(s))
232 /* ignore max parameter */
237 if (max > (int)(rb->len - rb->offset))
238 max = rb->len - rb->offset;
243 * Now we have len+left bytes at the front of s->s3->rbuf.buf and
244 * need to read in more until we have len+n (up to len+max if
249 if (s->rbio != NULL) {
250 s->rwstate = SSL_READING;
251 i = BIO_read(s->rbio, pkt + len + left, max - left);
253 SSLerr(SSL_F_SSL3_READ_N, SSL_R_READ_BIO_NOT_SET);
259 if (s->mode & SSL_MODE_RELEASE_BUFFERS && !SSL_IS_DTLS(s))
261 ssl3_release_read_buffer(s);
266 * reads should *never* span multiple packets for DTLS because the
267 * underlying transport protocol is message oriented as opposed to
268 * byte oriented as in the TLS case.
270 if (SSL_IS_DTLS(s)) {
272 n = left; /* makes the while condition false */
276 /* done reading, now the book-keeping */
279 s->packet_length += n;
280 s->rwstate = SSL_NOTHING;
286 * Call this to write data in records of type 'type' It will return <= 0 if
287 * not all data has been sent or non-blocking IO.
289 int ssl3_write_bytes(SSL *s, int type, const void *buf_, int len)
291 const unsigned char *buf = buf_;
294 #if !defined(OPENSSL_NO_MULTIBLOCK) && EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
295 unsigned int max_send_fragment;
297 SSL3_BUFFER *wb = RECORD_LAYER_get_wbuf(&s->rlayer);
299 unsigned int u_len = (unsigned int)len;
302 SSLerr(SSL_F_SSL3_WRITE_BYTES, SSL_R_SSL_NEGATIVE_LENGTH);
306 s->rwstate = SSL_NOTHING;
307 OPENSSL_assert(s->s3->wnum <= INT_MAX);
311 if (SSL_in_init(s) && !s->in_handshake) {
312 i = s->handshake_func(s);
316 SSLerr(SSL_F_SSL3_WRITE_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
322 * ensure that if we end up with a smaller value of data to write out
323 * than the the original len from a write which didn't complete for
324 * non-blocking I/O and also somehow ended up avoiding the check for
325 * this in ssl3_write_pending/SSL_R_BAD_WRITE_RETRY as it must never be
326 * possible to end up with (len-tot) as a large number that will then
327 * promptly send beyond the end of the users buffer ... so we trap and
328 * report the error in a way the user will notice
331 SSLerr(SSL_F_SSL3_WRITE_BYTES, SSL_R_BAD_LENGTH);
336 * first check if there is a SSL3_BUFFER still being written out. This
337 * will happen with non blocking IO
340 i = ssl3_write_pending(s, type, &buf[tot], s->s3->wpend_tot);
342 /* XXX should we ssl3_release_write_buffer if i<0? */
346 tot += i; /* this might be last fragment */
348 #if !defined(OPENSSL_NO_MULTIBLOCK) && EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
350 * Depending on platform multi-block can deliver several *times*
351 * better performance. Downside is that it has to allocate
352 * jumbo buffer to accomodate up to 8 records, but the
353 * compromise is considered worthy.
355 if (type == SSL3_RT_APPLICATION_DATA &&
356 u_len >= 4 * (max_send_fragment = s->max_send_fragment) &&
357 s->compress == NULL && s->msg_callback == NULL &&
358 !SSL_USE_ETM(s) && SSL_USE_EXPLICIT_IV(s) &&
359 EVP_CIPHER_flags(s->enc_write_ctx->cipher) &
360 EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK) {
361 unsigned char aad[13];
362 EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM mb_param;
365 /* minimize address aliasing conflicts */
366 if ((max_send_fragment & 0xfff) == 0)
367 max_send_fragment -= 512;
369 if (tot == 0 || wb->buf == NULL) { /* allocate jumbo buffer */
370 ssl3_release_write_buffer(s);
372 packlen = EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
373 EVP_CTRL_TLS1_1_MULTIBLOCK_MAX_BUFSIZE,
374 max_send_fragment, NULL);
376 if (u_len >= 8 * max_send_fragment)
381 wb->buf = OPENSSL_malloc(packlen);
383 SSLerr(SSL_F_SSL3_WRITE_BYTES, ERR_R_MALLOC_FAILURE);
387 } else if (tot == len) { /* done? */
388 OPENSSL_free(wb->buf); /* free jumbo buffer */
395 if (n < 4 * max_send_fragment) {
396 OPENSSL_free(wb->buf); /* free jumbo buffer */
401 if (s->s3->alert_dispatch) {
402 i = s->method->ssl_dispatch_alert(s);
409 if (n >= 8 * max_send_fragment)
410 nw = max_send_fragment * (mb_param.interleave = 8);
412 nw = max_send_fragment * (mb_param.interleave = 4);
414 memcpy(aad, s->s3->write_sequence, 8);
416 aad[9] = (unsigned char)(s->version >> 8);
417 aad[10] = (unsigned char)(s->version);
424 packlen = EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
425 EVP_CTRL_TLS1_1_MULTIBLOCK_AAD,
426 sizeof(mb_param), &mb_param);
428 if (packlen <= 0 || packlen > (int)wb->len) { /* never happens */
429 OPENSSL_free(wb->buf); /* free jumbo buffer */
434 mb_param.out = wb->buf;
435 mb_param.inp = &buf[tot];
438 if (EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
439 EVP_CTRL_TLS1_1_MULTIBLOCK_ENCRYPT,
440 sizeof(mb_param), &mb_param) <= 0)
443 s->s3->write_sequence[7] += mb_param.interleave;
444 if (s->s3->write_sequence[7] < mb_param.interleave) {
446 while (j >= 0 && (++s->s3->write_sequence[j--]) == 0) ;
452 s->s3->wpend_tot = nw;
453 s->s3->wpend_buf = &buf[tot];
454 s->s3->wpend_type = type;
455 s->s3->wpend_ret = nw;
457 i = ssl3_write_pending(s, type, &buf[tot], nw);
459 if (i < 0 && (!s->wbio || !BIO_should_retry(s->wbio))) {
460 OPENSSL_free(wb->buf);
467 OPENSSL_free(wb->buf); /* free jumbo buffer */
476 if (tot == len) { /* done? */
477 if (s->mode & SSL_MODE_RELEASE_BUFFERS && !SSL_IS_DTLS(s))
478 ssl3_release_write_buffer(s);
485 if (n > s->max_send_fragment)
486 nw = s->max_send_fragment;
490 i = do_ssl3_write(s, type, &(buf[tot]), nw, 0);
492 /* XXX should we ssl3_release_write_buffer if i<0? */
498 (type == SSL3_RT_APPLICATION_DATA &&
499 (s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE))) {
501 * next chunk of data should get another prepended empty fragment
502 * in ciphersuites with known-IV weakness:
504 s->s3->empty_fragment_done = 0;
506 if ((i == (int)n) && s->mode & SSL_MODE_RELEASE_BUFFERS &&
508 ssl3_release_write_buffer(s);
518 int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
519 unsigned int len, int create_empty_fragment)
521 unsigned char *p, *plen;
522 int i, mac_size, clear = 0;
527 SSL3_BUFFER *wb = RECORD_LAYER_get_wbuf(&s->rlayer);
531 * first check if there is a SSL3_BUFFER still being written out. This
532 * will happen with non blocking IO
535 return (ssl3_write_pending(s, type, buf, len));
537 /* If we have an alert to send, lets send it */
538 if (s->s3->alert_dispatch) {
539 i = s->method->ssl_dispatch_alert(s);
542 /* if it went, fall through and send more stuff */
546 if (!ssl3_setup_write_buffer(s))
549 if (len == 0 && !create_empty_fragment)
552 wr = RECORD_LAYER_get_wrec(&s->rlayer);
555 if ((sess == NULL) ||
556 (s->enc_write_ctx == NULL) ||
557 (EVP_MD_CTX_md(s->write_hash) == NULL)) {
558 clear = s->enc_write_ctx ? 0 : 1; /* must be AEAD cipher */
561 mac_size = EVP_MD_CTX_size(s->write_hash);
567 * 'create_empty_fragment' is true only when this function calls itself
569 if (!clear && !create_empty_fragment && !s->s3->empty_fragment_done) {
571 * countermeasure against known-IV weakness in CBC ciphersuites (see
572 * http://www.openssl.org/~bodo/tls-cbc.txt)
575 if (s->s3->need_empty_fragments && type == SSL3_RT_APPLICATION_DATA) {
577 * recursive function call with 'create_empty_fragment' set; this
578 * prepares and buffers the data for an empty fragment (these
579 * 'prefix_len' bytes are sent out later together with the actual
582 prefix_len = do_ssl3_write(s, type, buf, 0, 1);
587 (SSL3_RT_HEADER_LENGTH + SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD))
589 /* insufficient space */
590 SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
595 s->s3->empty_fragment_done = 1;
598 if (create_empty_fragment) {
599 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
601 * extra fragment would be couple of cipher blocks, which would be
602 * multiple of SSL3_ALIGN_PAYLOAD, so if we want to align the real
603 * payload, then we can just pretent we simply have two headers.
605 align = (long)wb->buf + 2 * SSL3_RT_HEADER_LENGTH;
606 align = (-align) & (SSL3_ALIGN_PAYLOAD - 1);
610 } else if (prefix_len) {
611 p = wb->buf + wb->offset + prefix_len;
613 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
614 align = (long)wb->buf + SSL3_RT_HEADER_LENGTH;
615 align = (-align) & (SSL3_ALIGN_PAYLOAD - 1);
621 /* write the header */
623 *(p++) = type & 0xff;
626 *(p++) = (s->version >> 8);
628 * Some servers hang if iniatial client hello is larger than 256 bytes
629 * and record version number > TLS 1.0
631 if (s->state == SSL3_ST_CW_CLNT_HELLO_B
632 && !s->renegotiate && TLS1_get_version(s) > TLS1_VERSION)
635 *(p++) = s->version & 0xff;
637 /* field where we are to write out packet length */
640 /* Explicit IV length, block ciphers appropriate version flag */
641 if (s->enc_write_ctx && SSL_USE_EXPLICIT_IV(s)) {
642 int mode = EVP_CIPHER_CTX_mode(s->enc_write_ctx);
643 if (mode == EVP_CIPH_CBC_MODE) {
644 eivlen = EVP_CIPHER_CTX_iv_length(s->enc_write_ctx);
648 /* Need explicit part of IV for GCM mode */
649 else if (mode == EVP_CIPH_GCM_MODE)
650 eivlen = EVP_GCM_TLS_EXPLICIT_IV_LEN;
656 /* lets setup the record stuff. */
657 wr->data = p + eivlen;
658 wr->length = (int)len;
659 wr->input = (unsigned char *)buf;
662 * we now 'read' from wr->input, wr->length bytes into wr->data
665 /* first we compress */
666 if (s->compress != NULL) {
667 if (!ssl3_do_compress(s)) {
668 SSLerr(SSL_F_DO_SSL3_WRITE, SSL_R_COMPRESSION_FAILURE);
672 memcpy(wr->data, wr->input, wr->length);
673 wr->input = wr->data;
677 * we should still have the output to wr->data and the input from
678 * wr->input. Length should be wr->length. wr->data still points in the
682 if (!SSL_USE_ETM(s) && mac_size != 0) {
683 if (s->method->ssl3_enc->mac(s, &(p[wr->length + eivlen]), 1) < 0)
685 wr->length += mac_size;
693 * if (RAND_pseudo_bytes(p, eivlen) <= 0) goto err;
695 wr->length += eivlen;
698 if (s->method->ssl3_enc->enc(s, 1) < 1)
701 if (SSL_USE_ETM(s) && mac_size != 0) {
702 if (s->method->ssl3_enc->mac(s, p + wr->length, 1) < 0)
704 wr->length += mac_size;
707 /* record length after mac and block padding */
708 s2n(wr->length, plen);
711 s->msg_callback(1, 0, SSL3_RT_HEADER, plen - 5, 5, s,
712 s->msg_callback_arg);
715 * we should now have wr->data pointing to the encrypted data, which is
718 wr->type = type; /* not needed but helps for debugging */
719 wr->length += SSL3_RT_HEADER_LENGTH;
721 if (create_empty_fragment) {
723 * we are in a recursive call; just return the length, don't write
729 /* now let's set up wb */
730 wb->left = prefix_len + wr->length;
733 * memorize arguments so that ssl3_write_pending can detect bad write
736 s->s3->wpend_tot = len;
737 s->s3->wpend_buf = buf;
738 s->s3->wpend_type = type;
739 s->s3->wpend_ret = len;
741 /* we now just need to write the buffer */
742 return ssl3_write_pending(s, type, buf, len);
747 /* if s->s3->wbuf.left != 0, we need to call this */
748 int ssl3_write_pending(SSL *s, int type, const unsigned char *buf,
752 SSL3_BUFFER *wb = RECORD_LAYER_get_wbuf(&s->rlayer);
755 if ((s->s3->wpend_tot > (int)len)
756 || ((s->s3->wpend_buf != buf) &&
757 !(s->mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER))
758 || (s->s3->wpend_type != type)) {
759 SSLerr(SSL_F_SSL3_WRITE_PENDING, SSL_R_BAD_WRITE_RETRY);
765 if (s->wbio != NULL) {
766 s->rwstate = SSL_WRITING;
767 i = BIO_write(s->wbio,
768 (char *)&(wb->buf[wb->offset]),
769 (unsigned int)wb->left);
771 SSLerr(SSL_F_SSL3_WRITE_PENDING, SSL_R_BIO_NOT_SET);
777 s->rwstate = SSL_NOTHING;
778 return (s->s3->wpend_ret);
780 if (s->version == DTLS1_VERSION || s->version == DTLS1_BAD_VER) {
782 * For DTLS, just drop it. That's kind of the whole point in
783 * using a datagram service
795 * Return up to 'len' payload bytes received in 'type' records.
796 * 'type' is one of the following:
798 * - SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
799 * - SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
800 * - 0 (during a shutdown, no data has to be returned)
802 * If we don't have stored data to work from, read a SSL/TLS record first
803 * (possibly multiple records if we still don't have anything to return).
805 * This function must handle any surprises the peer may have for us, such as
806 * Alert records (e.g. close_notify), ChangeCipherSpec records (not really
807 * a surprise, but handled as if it were), or renegotiation requests.
808 * Also if record payloads contain fragments too small to process, we store
809 * them until there is enough for the respective protocol (the record protocol
810 * may use arbitrary fragmentation and even interleaving):
811 * Change cipher spec protocol
812 * just 1 byte needed, no need for keeping anything stored
814 * 2 bytes needed (AlertLevel, AlertDescription)
816 * 4 bytes needed (HandshakeType, uint24 length) -- we just have
817 * to detect unexpected Client Hello and Hello Request messages
818 * here, anything else is handled by higher layers
819 * Application data protocol
820 * none of our business
822 int ssl3_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek)
827 void (*cb) (const SSL *ssl, int type2, int val) = NULL;
829 if (!SSL3_BUFFER_is_initialised(RECORD_LAYER_get_rbuf(&s->rlayer))) {
830 /* Not initialized yet */
831 if (!ssl3_setup_read_buffer(s))
835 if ((type && (type != SSL3_RT_APPLICATION_DATA)
836 && (type != SSL3_RT_HANDSHAKE)) || (peek
838 SSL3_RT_APPLICATION_DATA))) {
839 SSLerr(SSL_F_SSL3_READ_BYTES, ERR_R_INTERNAL_ERROR);
843 if ((type == SSL3_RT_HANDSHAKE) && (s->s3->handshake_fragment_len > 0))
844 /* (partially) satisfy request from storage */
846 unsigned char *src = s->s3->handshake_fragment;
847 unsigned char *dst = buf;
852 while ((len > 0) && (s->s3->handshake_fragment_len > 0)) {
855 s->s3->handshake_fragment_len--;
858 /* move any remaining fragment bytes: */
859 for (k = 0; k < s->s3->handshake_fragment_len; k++)
860 s->s3->handshake_fragment[k] = *src++;
865 * Now s->s3->handshake_fragment_len == 0 if type == SSL3_RT_HANDSHAKE.
868 if (!s->in_handshake && SSL_in_init(s)) {
869 /* type == SSL3_RT_APPLICATION_DATA */
870 i = s->handshake_func(s);
874 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
879 s->rwstate = SSL_NOTHING;
882 * s->s3->rrec.type - is the type of record
883 * s->s3->rrec.data, - data
884 * s->s3->rrec.off, - offset into 'data' for next read
885 * s->s3->rrec.length, - number of bytes.
887 rr = RECORD_LAYER_get_rrec(&s->rlayer);
889 /* get new packet if necessary */
890 if ((rr->length == 0) || (s->rstate == SSL_ST_READ_BODY)) {
891 ret = ssl3_get_record(s);
896 /* we now have a packet which can be read and processed */
898 if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
899 * reset by ssl3_get_finished */
900 && (rr->type != SSL3_RT_HANDSHAKE)) {
901 al = SSL_AD_UNEXPECTED_MESSAGE;
902 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_DATA_BETWEEN_CCS_AND_FINISHED);
907 * If the other end has shut down, throw anything we read away (even in
910 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
912 s->rwstate = SSL_NOTHING;
916 if (type == rr->type) { /* SSL3_RT_APPLICATION_DATA or
917 * SSL3_RT_HANDSHAKE */
919 * make sure that we are not getting application data when we are
920 * doing a handshake for the first time
922 if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
923 (s->enc_read_ctx == NULL)) {
924 al = SSL_AD_UNEXPECTED_MESSAGE;
925 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_APP_DATA_IN_HANDSHAKE);
932 if ((unsigned int)len > rr->length)
935 n = (unsigned int)len;
937 memcpy(buf, &(rr->data[rr->off]), n);
941 if (rr->length == 0) {
942 s->rstate = SSL_ST_READ_HEADER;
944 if (s->mode & SSL_MODE_RELEASE_BUFFERS
945 && SSL3_BUFFER_get_left(
946 RECORD_LAYER_get_rbuf(&s->rlayer)) == 0)
947 ssl3_release_read_buffer(s);
954 * If we get here, then type != rr->type; if we have a handshake message,
955 * then it was unexpected (Hello Request or Client Hello).
959 * In case of record types for which we have 'fragment' storage, fill
960 * that so that we can process the data at a fixed place.
963 unsigned int dest_maxlen = 0;
964 unsigned char *dest = NULL;
965 unsigned int *dest_len = NULL;
967 if (rr->type == SSL3_RT_HANDSHAKE) {
968 dest_maxlen = sizeof s->s3->handshake_fragment;
969 dest = s->s3->handshake_fragment;
970 dest_len = &s->s3->handshake_fragment_len;
971 } else if (rr->type == SSL3_RT_ALERT) {
972 dest_maxlen = sizeof s->s3->alert_fragment;
973 dest = s->s3->alert_fragment;
974 dest_len = &s->s3->alert_fragment_len;
976 #ifndef OPENSSL_NO_HEARTBEATS
977 else if (rr->type == TLS1_RT_HEARTBEAT) {
978 /* We can ignore 0 return values */
979 if(tls1_process_heartbeat(s) < 0) {
983 /* Exit and notify application to read again */
985 s->rwstate = SSL_READING;
986 BIO_clear_retry_flags(SSL_get_rbio(s));
987 BIO_set_retry_read(SSL_get_rbio(s));
992 if (dest_maxlen > 0) {
993 n = dest_maxlen - *dest_len; /* available space in 'dest' */
995 n = rr->length; /* available bytes */
997 /* now move 'n' bytes: */
999 dest[(*dest_len)++] = rr->data[rr->off++];
1003 if (*dest_len < dest_maxlen)
1004 goto start; /* fragment was too small */
1009 * s->s3->handshake_fragment_len == 4 iff rr->type == SSL3_RT_HANDSHAKE;
1010 * s->s3->alert_fragment_len == 2 iff rr->type == SSL3_RT_ALERT.
1011 * (Possibly rr is 'empty' now, i.e. rr->length may be 0.)
1014 /* If we are a client, check for an incoming 'Hello Request': */
1016 (s->s3->handshake_fragment_len >= 4) &&
1017 (s->s3->handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
1018 (s->session != NULL) && (s->session->cipher != NULL)) {
1019 s->s3->handshake_fragment_len = 0;
1021 if ((s->s3->handshake_fragment[1] != 0) ||
1022 (s->s3->handshake_fragment[2] != 0) ||
1023 (s->s3->handshake_fragment[3] != 0)) {
1024 al = SSL_AD_DECODE_ERROR;
1025 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_BAD_HELLO_REQUEST);
1029 if (s->msg_callback)
1030 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
1031 s->s3->handshake_fragment, 4, s,
1032 s->msg_callback_arg);
1034 if (SSL_is_init_finished(s) &&
1035 !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
1036 !s->s3->renegotiate) {
1037 ssl3_renegotiate(s);
1038 if (ssl3_renegotiate_check(s)) {
1039 i = s->handshake_func(s);
1043 SSLerr(SSL_F_SSL3_READ_BYTES,
1044 SSL_R_SSL_HANDSHAKE_FAILURE);
1048 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
1049 if (SSL3_BUFFER_get_left(
1050 RECORD_LAYER_get_rbuf(&s->rlayer)) == 0) {
1051 /* no read-ahead left? */
1054 * In the case where we try to read application data,
1055 * but we trigger an SSL handshake, we return -1 with
1056 * the retry option set. Otherwise renegotiation may
1057 * cause nasty problems in the blocking world
1059 s->rwstate = SSL_READING;
1060 bio = SSL_get_rbio(s);
1061 BIO_clear_retry_flags(bio);
1062 BIO_set_retry_read(bio);
1069 * we either finished a handshake or ignored the request, now try
1070 * again to obtain the (application) data we were asked for
1075 * If we are a server and get a client hello when renegotiation isn't
1076 * allowed send back a no renegotiation alert and carry on. WARNING:
1077 * experimental code, needs reviewing (steve)
1080 SSL_is_init_finished(s) &&
1081 !s->s3->send_connection_binding &&
1082 (s->version > SSL3_VERSION) &&
1083 (s->s3->handshake_fragment_len >= 4) &&
1084 (s->s3->handshake_fragment[0] == SSL3_MT_CLIENT_HELLO) &&
1085 (s->session != NULL) && (s->session->cipher != NULL) &&
1086 !(s->ctx->options & SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)) {
1088 * s->s3->handshake_fragment_len = 0;
1091 ssl3_send_alert(s, SSL3_AL_WARNING, SSL_AD_NO_RENEGOTIATION);
1094 if (s->s3->alert_fragment_len >= 2) {
1095 int alert_level = s->s3->alert_fragment[0];
1096 int alert_descr = s->s3->alert_fragment[1];
1098 s->s3->alert_fragment_len = 0;
1100 if (s->msg_callback)
1101 s->msg_callback(0, s->version, SSL3_RT_ALERT,
1102 s->s3->alert_fragment, 2, s, s->msg_callback_arg);
1104 if (s->info_callback != NULL)
1105 cb = s->info_callback;
1106 else if (s->ctx->info_callback != NULL)
1107 cb = s->ctx->info_callback;
1110 j = (alert_level << 8) | alert_descr;
1111 cb(s, SSL_CB_READ_ALERT, j);
1114 if (alert_level == SSL3_AL_WARNING) {
1115 s->s3->warn_alert = alert_descr;
1116 if (alert_descr == SSL_AD_CLOSE_NOTIFY) {
1117 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
1121 * This is a warning but we receive it if we requested
1122 * renegotiation and the peer denied it. Terminate with a fatal
1123 * alert because if application tried to renegotiatie it
1124 * presumably had a good reason and expects it to succeed. In
1125 * future we might have a renegotiation where we don't care if
1126 * the peer refused it where we carry on.
1128 else if (alert_descr == SSL_AD_NO_RENEGOTIATION) {
1129 al = SSL_AD_HANDSHAKE_FAILURE;
1130 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_NO_RENEGOTIATION);
1133 #ifdef SSL_AD_MISSING_SRP_USERNAME
1134 else if (alert_descr == SSL_AD_MISSING_SRP_USERNAME)
1137 } else if (alert_level == SSL3_AL_FATAL) {
1140 s->rwstate = SSL_NOTHING;
1141 s->s3->fatal_alert = alert_descr;
1142 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_AD_REASON_OFFSET + alert_descr);
1143 BIO_snprintf(tmp, sizeof tmp, "%d", alert_descr);
1144 ERR_add_error_data(2, "SSL alert number ", tmp);
1145 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
1146 SSL_CTX_remove_session(s->ctx, s->session);
1149 al = SSL_AD_ILLEGAL_PARAMETER;
1150 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_UNKNOWN_ALERT_TYPE);
1157 if (s->shutdown & SSL_SENT_SHUTDOWN) { /* but we have not received a
1159 s->rwstate = SSL_NOTHING;
1164 if (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC) {
1166 * 'Change Cipher Spec' is just a single byte, so we know exactly
1167 * what the record payload has to look like
1169 if ((rr->length != 1) || (rr->off != 0) ||
1170 (rr->data[0] != SSL3_MT_CCS)) {
1171 al = SSL_AD_ILLEGAL_PARAMETER;
1172 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_BAD_CHANGE_CIPHER_SPEC);
1176 /* Check we have a cipher to change to */
1177 if (s->s3->tmp.new_cipher == NULL) {
1178 al = SSL_AD_UNEXPECTED_MESSAGE;
1179 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_CCS_RECEIVED_EARLY);
1183 if (!(s->s3->flags & SSL3_FLAGS_CCS_OK)) {
1184 al = SSL_AD_UNEXPECTED_MESSAGE;
1185 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_CCS_RECEIVED_EARLY);
1189 s->s3->flags &= ~SSL3_FLAGS_CCS_OK;
1193 if (s->msg_callback)
1194 s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
1195 rr->data, 1, s, s->msg_callback_arg);
1197 s->s3->change_cipher_spec = 1;
1198 if (!ssl3_do_change_cipher_spec(s))
1205 * Unexpected handshake message (Client Hello, or protocol violation)
1207 if ((s->s3->handshake_fragment_len >= 4) && !s->in_handshake) {
1208 if (((s->state & SSL_ST_MASK) == SSL_ST_OK) &&
1209 !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS)) {
1210 s->state = s->server ? SSL_ST_ACCEPT : SSL_ST_CONNECT;
1214 i = s->handshake_func(s);
1218 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
1222 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
1223 if (SSL3_BUFFER_get_left(RECORD_LAYER_get_rbuf(&s->rlayer)) == 0) {
1224 /* no read-ahead left? */
1227 * In the case where we try to read application data, but we
1228 * trigger an SSL handshake, we return -1 with the retry
1229 * option set. Otherwise renegotiation may cause nasty
1230 * problems in the blocking world
1232 s->rwstate = SSL_READING;
1233 bio = SSL_get_rbio(s);
1234 BIO_clear_retry_flags(bio);
1235 BIO_set_retry_read(bio);
1245 * TLS up to v1.1 just ignores unknown message types: TLS v1.2 give
1246 * an unexpected message alert.
1248 if (s->version >= TLS1_VERSION && s->version <= TLS1_1_VERSION) {
1252 al = SSL_AD_UNEXPECTED_MESSAGE;
1253 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1255 case SSL3_RT_CHANGE_CIPHER_SPEC:
1257 case SSL3_RT_HANDSHAKE:
1259 * we already handled all of these, with the possible exception of
1260 * SSL3_RT_HANDSHAKE when s->in_handshake is set, but that should not
1261 * happen when type != rr->type
1263 al = SSL_AD_UNEXPECTED_MESSAGE;
1264 SSLerr(SSL_F_SSL3_READ_BYTES, ERR_R_INTERNAL_ERROR);
1266 case SSL3_RT_APPLICATION_DATA:
1268 * At this point, we were expecting handshake data, but have
1269 * application data. If the library was running inside ssl3_read()
1270 * (i.e. in_read_app_data is set) and it makes sense to read
1271 * application data at this point (session renegotiation not yet
1272 * started), we will indulge it.
1274 if (s->s3->in_read_app_data &&
1275 (s->s3->total_renegotiations != 0) &&
1276 (((s->state & SSL_ST_CONNECT) &&
1277 (s->state >= SSL3_ST_CW_CLNT_HELLO_A) &&
1278 (s->state <= SSL3_ST_CR_SRVR_HELLO_A)
1279 ) || ((s->state & SSL_ST_ACCEPT) &&
1280 (s->state <= SSL3_ST_SW_HELLO_REQ_A) &&
1281 (s->state >= SSL3_ST_SR_CLNT_HELLO_A)
1284 s->s3->in_read_app_data = 2;
1287 al = SSL_AD_UNEXPECTED_MESSAGE;
1288 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1295 ssl3_send_alert(s, SSL3_AL_FATAL, al);