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-2001 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).
115 #include <openssl/evp.h>
116 #include <openssl/buffer.h>
117 #include "ssl_locl.h"
119 static int do_ssl3_write(SSL
*s
, int type
, const unsigned char *buf
,
121 static int ssl3_write_pending(SSL
*s
, int type
, const unsigned char *buf
,
123 static int ssl3_get_record(SSL
*s
);
124 static int do_compress(SSL
*ssl
);
125 static int do_uncompress(SSL
*ssl
);
126 static int do_change_cipher_spec(SSL
*ssl
);
128 /* used only by ssl3_get_record */
129 static int ssl3_read_n(SSL
*s
, int n
, int max
, int extend
)
131 /* If extend == 0, obtain new n-byte packet; if extend == 1, increase
132 * packet by another n bytes.
133 * The packet will be in the sub-array of s->s3->rbuf.buf specified
134 * by s->packet and s->packet_length.
135 * (If s->read_ahead is set, 'max' bytes may be stored in rbuf
136 * [plus s->packet_length bytes if extend == 1].)
142 /* start with empty packet ... */
143 if (s
->s3
->rbuf
.left
== 0)
144 s
->s3
->rbuf
.offset
= 0;
145 s
->packet
= s
->s3
->rbuf
.buf
+ s
->s3
->rbuf
.offset
;
146 s
->packet_length
= 0;
147 /* ... now we can act as if 'extend' was set */
150 /* if there is enough in the buffer from a previous read, take some */
151 if (s
->s3
->rbuf
.left
>= (int)n
)
155 s
->s3
->rbuf
.offset
+=n
;
159 /* else we need to read more data */
164 /* avoid buffer overflow */
165 int max_max
= SSL3_RT_MAX_PACKET_SIZE
- s
->packet_length
;
166 if (s
->options
& SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
)
167 max_max
+= SSL3_RT_MAX_EXTRA
;
171 if (n
> max
) /* does not happen */
173 SSLerr(SSL_F_SSL3_READ_N
,ERR_R_INTERNAL_ERROR
);
177 off
= s
->packet_length
;
178 newb
= s
->s3
->rbuf
.left
;
179 /* Move any available bytes to front of buffer:
180 * 'off' bytes already pointed to by 'packet',
181 * 'newb' extra ones at the end */
182 if (s
->packet
!= s
->s3
->rbuf
.buf
)
185 memmove(s
->s3
->rbuf
.buf
, s
->packet
, off
+newb
);
186 s
->packet
= s
->s3
->rbuf
.buf
;
191 /* Now we have off+newb bytes at the front of s->s3->rbuf.buf and need
192 * to read in more until we have off+n (up to off+max if possible) */
197 s
->rwstate
=SSL_READING
;
198 i
=BIO_read(s
->rbio
, &(s
->s3
->rbuf
.buf
[off
+newb
]), max
-newb
);
202 SSLerr(SSL_F_SSL3_READ_N
,SSL_R_READ_BIO_NOT_SET
);
208 s
->s3
->rbuf
.left
= newb
;
214 /* done reading, now the book-keeping */
215 s
->s3
->rbuf
.offset
= off
+ n
;
216 s
->s3
->rbuf
.left
= newb
- n
;
217 s
->packet_length
+= n
;
218 s
->rwstate
=SSL_NOTHING
;
222 /* Call this to get a new input record.
223 * It will return <= 0 if more data is needed, normally due to an error
224 * or non-blocking IO.
225 * When it finishes, one packet has been decoded and can be found in
226 * ssl->s3->rrec.type - is the type of record
227 * ssl->s3->rrec.data, - data
228 * ssl->s3->rrec.length, - number of bytes
230 /* used only by ssl3_read_bytes */
231 static int ssl3_get_record(SSL
*s
)
233 int ssl_major
,ssl_minor
,al
;
234 int enc_err
,n
,i
,ret
= -1;
238 unsigned char md
[EVP_MAX_MD_SIZE
];
240 unsigned int mac_size
;
246 if (s
->options
& SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER
)
247 extra
=SSL3_RT_MAX_EXTRA
;
252 /* check if we have the header */
253 if ( (s
->rstate
!= SSL_ST_READ_BODY
) ||
254 (s
->packet_length
< SSL3_RT_HEADER_LENGTH
))
256 n
=ssl3_read_n(s
,SSL3_RT_HEADER_LENGTH
,
257 SSL3_RT_MAX_PACKET_SIZE
,0);
258 if (n
<= 0) return(n
); /* error or non-blocking */
259 s
->rstate
=SSL_ST_READ_BODY
;
263 /* Pull apart the header into the SSL3_RECORD */
267 version
=(ssl_major
<<8)|ssl_minor
;
270 /* Lets check version */
277 if (version
!= s
->version
)
279 SSLerr(SSL_F_SSL3_GET_RECORD
,SSL_R_WRONG_VERSION_NUMBER
);
280 /* Send back error using their
281 * version number :-) */
283 al
=SSL_AD_PROTOCOL_VERSION
;
288 if ((version
>>8) != SSL3_VERSION_MAJOR
)
290 SSLerr(SSL_F_SSL3_GET_RECORD
,SSL_R_WRONG_VERSION_NUMBER
);
295 (unsigned int)SSL3_RT_MAX_ENCRYPTED_LENGTH
+extra
)
297 al
=SSL_AD_RECORD_OVERFLOW
;
298 SSLerr(SSL_F_SSL3_GET_RECORD
,SSL_R_PACKET_LENGTH_TOO_LONG
);
302 /* now s->rstate == SSL_ST_READ_BODY */
305 /* s->rstate == SSL_ST_READ_BODY, get and decode the data */
307 if (rr
->length
> (s
->packet_length
-SSL3_RT_HEADER_LENGTH
))
309 /* now s->packet_length == SSL3_RT_HEADER_LENGTH */
311 n
=ssl3_read_n(s
,i
,i
,1);
312 if (n
<= 0) return(n
); /* error or non-blocking io */
313 /* now n == rr->length,
314 * and s->packet_length == SSL3_RT_HEADER_LENGTH + rr->length */
317 s
->rstate
=SSL_ST_READ_HEADER
; /* set state for later operations */
319 /* At this point, s->packet_length == SSL3_RT_HEADER_LNGTH + rr->length,
320 * and we have that many bytes in s->packet
322 rr
->input
= &(s
->packet
[SSL3_RT_HEADER_LENGTH
]);
324 /* ok, we can now read from 's->packet' data into 'rr'
325 * rr->input points at rr->length bytes, which
326 * need to be copied into rr->data by either
327 * the decryption or by the decompression
328 * When the data is 'copied' into the rr->data buffer,
329 * rr->input will be pointed at the new buffer */
331 /* We now have - encrypted [ MAC [ compressed [ plain ] ] ]
332 * rr->length bytes of encrypted compressed stuff. */
334 /* check is not needed I believe */
335 if (rr
->length
> (unsigned int)SSL3_RT_MAX_ENCRYPTED_LENGTH
+extra
)
337 al
=SSL_AD_RECORD_OVERFLOW
;
338 SSLerr(SSL_F_SSL3_GET_RECORD
,SSL_R_ENCRYPTED_LENGTH_TOO_LONG
);
342 /* decrypt in place in 'rr->input' */
345 enc_err
= s
->method
->ssl3_enc
->enc(s
,0);
349 /* SSLerr() and ssl3_send_alert() have been called */
352 /* otherwise enc_err == -1 */
353 goto decryption_failed_or_bad_record_mac
;
357 printf("dec %d\n",rr
->length
);
358 { unsigned int z
; for (z
=0; z
<rr
->length
; z
++) printf("%02X%c",rr
->data
[z
],((z
+1)%16)?' ':'\n'); }
362 /* r->length is now the compressed data plus mac */
363 if ( (sess
== NULL
) ||
364 (s
->enc_read_ctx
== NULL
) ||
365 (s
->read_hash
== NULL
))
370 mac_size
=EVP_MD_size(s
->read_hash
);
372 if (rr
->length
> SSL3_RT_MAX_COMPRESSED_LENGTH
+extra
+mac_size
)
374 #if 0 /* OK only for stream ciphers (then rr->length is visible from ciphertext anyway) */
375 al
=SSL_AD_RECORD_OVERFLOW
;
376 SSLerr(SSL_F_SSL3_GET_RECORD
,SSL_R_PRE_MAC_LENGTH_TOO_LONG
);
379 goto decryption_failed_or_bad_record_mac
;
382 /* check the MAC for rr->input (it's in mac_size bytes at the tail) */
383 if (rr
->length
< mac_size
)
385 #if 0 /* OK only for stream ciphers */
386 al
=SSL_AD_DECODE_ERROR
;
387 SSLerr(SSL_F_SSL3_GET_RECORD
,SSL_R_LENGTH_TOO_SHORT
);
390 goto decryption_failed_or_bad_record_mac
;
393 rr
->length
-=mac_size
;
394 i
=s
->method
->ssl3_enc
->mac(s
,md
,0);
395 if (memcmp(md
,&(rr
->data
[rr
->length
]),mac_size
) != 0)
397 goto decryption_failed_or_bad_record_mac
;
401 /* r->length is now just compressed */
402 if (s
->expand
!= NULL
)
405 (unsigned int)SSL3_RT_MAX_COMPRESSED_LENGTH
+extra
)
407 al
=SSL_AD_RECORD_OVERFLOW
;
408 SSLerr(SSL_F_SSL3_GET_RECORD
,SSL_R_COMPRESSED_LENGTH_TOO_LONG
);
411 if (!do_uncompress(s
))
413 al
=SSL_AD_DECOMPRESSION_FAILURE
;
414 SSLerr(SSL_F_SSL3_GET_RECORD
,SSL_R_BAD_DECOMPRESSION
);
419 if (rr
->length
> (unsigned int)SSL3_RT_MAX_PLAIN_LENGTH
+extra
)
421 al
=SSL_AD_RECORD_OVERFLOW
;
422 SSLerr(SSL_F_SSL3_GET_RECORD
,SSL_R_DATA_LENGTH_TOO_LONG
);
427 /* So at this point the following is true
428 * ssl->s3->rrec.type is the type of record
429 * ssl->s3->rrec.length == number of bytes in record
430 * ssl->s3->rrec.off == offset to first valid byte
431 * ssl->s3->rrec.data == where to take bytes from, increment
435 /* we have pulled in a full packet so zero things */
438 /* just read a 0 length packet */
439 if (rr
->length
== 0) goto again
;
443 decryption_failed_or_bad_record_mac
:
444 /* Separate 'decryption_failed' alert was introduced with TLS 1.0,
445 * SSL 3.0 only has 'bad_record_mac'. But unless a decryption
446 * failure is directly visible from the ciphertext anyway,
447 * we should not reveal which kind of error occured -- this
448 * might become visible to an attacker (e.g. via logfile) */
449 al
=SSL_AD_BAD_RECORD_MAC
;
450 SSLerr(SSL_F_SSL3_GET_RECORD
,SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC
);
452 ssl3_send_alert(s
,SSL3_AL_FATAL
,al
);
457 static int do_uncompress(SSL
*ssl
)
462 rr
= &(ssl
->s3
->rrec
);
463 i
=COMP_expand_block(ssl
->expand
,rr
->comp
,
464 SSL3_RT_MAX_PLAIN_LENGTH
,rr
->data
,(int)rr
->length
);
474 static int do_compress(SSL
*ssl
)
479 wr
= &(ssl
->s3
->wrec
);
480 i
=COMP_compress_block(ssl
->compress
,wr
->data
,
481 SSL3_RT_MAX_COMPRESSED_LENGTH
,
482 wr
->input
,(int)wr
->length
);
492 /* Call this to write data in records of type 'type'
493 * It will return <= 0 if not all data has been sent or non-blocking IO.
495 int ssl3_write_bytes(SSL
*s
, int type
, const void *buf_
, int len
)
497 const unsigned char *buf
=buf_
;
498 unsigned int tot
,n
,nw
;
501 s
->rwstate
=SSL_NOTHING
;
505 if (SSL_in_init(s
) && !s
->in_handshake
)
507 i
=s
->handshake_func(s
);
508 if (i
< 0) return(i
);
511 SSLerr(SSL_F_SSL3_WRITE_BYTES
,SSL_R_SSL_HANDSHAKE_FAILURE
);
519 if (n
> SSL3_RT_MAX_PLAIN_LENGTH
)
520 nw
=SSL3_RT_MAX_PLAIN_LENGTH
;
524 i
=do_ssl3_write(s
,type
,&(buf
[tot
]),nw
);
532 (type
== SSL3_RT_APPLICATION_DATA
&&
533 (s
->mode
& SSL_MODE_ENABLE_PARTIAL_WRITE
)))
543 static int do_ssl3_write(SSL
*s
, int type
, const unsigned char *buf
,
546 unsigned char *p
,*plen
;
547 int i
,mac_size
,clear
=0;
552 /* first check is there is a SSL3_RECORD still being written
553 * out. This will happen with non blocking IO */
554 if (s
->s3
->wbuf
.left
!= 0)
555 return(ssl3_write_pending(s
,type
,buf
,len
));
557 /* If we have an alert to send, lets send it */
558 if (s
->s3
->alert_dispatch
)
560 i
=ssl3_dispatch_alert(s
);
563 /* if it went, fall through and send more stuff */
566 if (len
== 0) return(len
);
572 if ( (sess
== NULL
) ||
573 (s
->enc_write_ctx
== NULL
) ||
574 (s
->write_hash
== NULL
))
580 mac_size
=EVP_MD_size(s
->write_hash
);
584 /* write the header */
588 *(p
++)=(s
->version
>>8);
589 *(p
++)=s
->version
&0xff;
591 /* record where we are to write out packet length */
595 /* lets setup the record stuff. */
598 wr
->input
=(unsigned char *)buf
;
600 /* we now 'read' from wr->input, wr->length bytes into
603 /* first we compress */
604 if (s
->compress
!= NULL
)
608 SSLerr(SSL_F_DO_SSL3_WRITE
,SSL_R_COMPRESSION_FAILURE
);
614 memcpy(wr
->data
,wr
->input
,wr
->length
);
618 /* we should still have the output to wr->data and the input
619 * from wr->input. Length should be wr->length.
620 * wr->data still points in the wb->buf */
624 s
->method
->ssl3_enc
->mac(s
,&(p
[wr
->length
]),1);
625 wr
->length
+=mac_size
;
630 /* ssl3_enc can only have an error on read */
631 s
->method
->ssl3_enc
->enc(s
,1);
633 /* record length after mac and block padding */
634 s2n(wr
->length
,plen
);
636 /* we should now have
637 * wr->data pointing to the encrypted data, which is
639 wr
->type
=type
; /* not needed but helps for debugging */
640 wr
->length
+=SSL3_RT_HEADER_LENGTH
;
642 /* Now lets setup wb */
646 s
->s3
->wpend_tot
=len
;
647 s
->s3
->wpend_buf
=buf
;
648 s
->s3
->wpend_type
=type
;
649 s
->s3
->wpend_ret
=len
;
651 /* we now just need to write the buffer */
652 return(ssl3_write_pending(s
,type
,buf
,len
));
657 /* if s->s3->wbuf.left != 0, we need to call this */
658 static int ssl3_write_pending(SSL
*s
, int type
, const unsigned char *buf
,
664 if ((s
->s3
->wpend_tot
> (int)len
)
665 || ((s
->s3
->wpend_buf
!= buf
) &&
666 !(s
->mode
& SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER
))
667 || (s
->s3
->wpend_type
!= type
))
669 SSLerr(SSL_F_SSL3_WRITE_PENDING
,SSL_R_BAD_WRITE_RETRY
);
678 s
->rwstate
=SSL_WRITING
;
680 (char *)&(s
->s3
->wbuf
.buf
[s
->s3
->wbuf
.offset
]),
681 (unsigned int)s
->s3
->wbuf
.left
);
685 SSLerr(SSL_F_SSL3_WRITE_PENDING
,SSL_R_BIO_NOT_SET
);
688 if (i
== s
->s3
->wbuf
.left
)
691 s
->rwstate
=SSL_NOTHING
;
692 return(s
->s3
->wpend_ret
);
696 s
->s3
->wbuf
.offset
+=i
;
701 /* Return up to 'len' payload bytes received in 'type' records.
702 * 'type' is one of the following:
704 * - SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
705 * - SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
706 * - 0 (during a shutdown, no data has to be returned)
708 * If we don't have stored data to work from, read a SSL/TLS record first
709 * (possibly multiple records if we still don't have anything to return).
711 * This function must handle any surprises the peer may have for us, such as
712 * Alert records (e.g. close_notify), ChangeCipherSpec records (not really
713 * a surprise, but handled as if it were), or renegotiation requests.
714 * Also if record payloads contain fragments too small to process, we store
715 * them until there is enough for the respective protocol (the record protocol
716 * may use arbitrary fragmentation and even interleaving):
717 * Change cipher spec protocol
718 * just 1 byte needed, no need for keeping anything stored
720 * 2 bytes needed (AlertLevel, AlertDescription)
722 * 4 bytes needed (HandshakeType, uint24 length) -- we just have
723 * to detect unexpected Client Hello and Hello Request messages
724 * here, anything else is handled by higher layers
725 * Application data protocol
726 * none of our business
728 int ssl3_read_bytes(SSL
*s
, int type
, unsigned char *buf
, int len
, int peek
)
735 if (s
->s3
->rbuf
.buf
== NULL
) /* Not initialized yet */
736 if (!ssl3_setup_buffers(s
))
739 if ((type
&& (type
!= SSL3_RT_APPLICATION_DATA
) && (type
!= SSL3_RT_HANDSHAKE
) && type
) ||
740 (peek
&& (type
!= SSL3_RT_APPLICATION_DATA
)))
742 SSLerr(SSL_F_SSL3_READ_BYTES
, ERR_R_INTERNAL_ERROR
);
746 if ((type
== SSL3_RT_HANDSHAKE
) && (s
->s3
->handshake_fragment_len
> 0))
747 /* (partially) satisfy request from storage */
749 unsigned char *src
= s
->s3
->handshake_fragment
;
750 unsigned char *dst
= buf
;
755 while ((len
> 0) && (s
->s3
->handshake_fragment_len
> 0))
758 len
--; s
->s3
->handshake_fragment_len
--;
761 /* move any remaining fragment bytes: */
762 for (k
= 0; k
< s
->s3
->handshake_fragment_len
; k
++)
763 s
->s3
->handshake_fragment
[k
] = *src
++;
767 /* Now s->s3->handshake_fragment_len == 0 if type == SSL3_RT_HANDSHAKE. */
769 if (!s
->in_handshake
&& SSL_in_init(s
))
771 /* type == SSL3_RT_APPLICATION_DATA */
772 i
=s
->handshake_func(s
);
773 if (i
< 0) return(i
);
776 SSLerr(SSL_F_SSL3_READ_BYTES
,SSL_R_SSL_HANDSHAKE_FAILURE
);
781 s
->rwstate
=SSL_NOTHING
;
783 /* s->s3->rrec.type - is the type of record
784 * s->s3->rrec.data, - data
785 * s->s3->rrec.off, - offset into 'data' for next read
786 * s->s3->rrec.length, - number of bytes. */
789 /* get new packet if necessary */
790 if ((rr
->length
== 0) || (s
->rstate
== SSL_ST_READ_BODY
))
792 ret
=ssl3_get_record(s
);
793 if (ret
<= 0) return(ret
);
796 /* we now have a packet which can be read and processed */
798 if (s
->s3
->change_cipher_spec
/* set when we receive ChangeCipherSpec,
799 * reset by ssl3_get_finished */
800 && (rr
->type
!= SSL3_RT_HANDSHAKE
))
802 al
=SSL_AD_UNEXPECTED_MESSAGE
;
803 SSLerr(SSL_F_SSL3_READ_BYTES
,SSL_R_DATA_BETWEEN_CCS_AND_FINISHED
);
807 /* If the other end has shut down, throw anything we read away
808 * (even in 'peek' mode) */
809 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
)
812 s
->rwstate
=SSL_NOTHING
;
817 if (type
== rr
->type
) /* SSL3_RT_APPLICATION_DATA or SSL3_RT_HANDSHAKE */
819 /* make sure that we are not getting application data when we
820 * are doing a handshake for the first time */
821 if (SSL_in_init(s
) && (type
== SSL3_RT_APPLICATION_DATA
) &&
822 (s
->enc_read_ctx
== NULL
))
824 al
=SSL_AD_UNEXPECTED_MESSAGE
;
825 SSLerr(SSL_F_SSL3_READ_BYTES
,SSL_R_APP_DATA_IN_HANDSHAKE
);
829 if (len
<= 0) return(len
);
831 if ((unsigned int)len
> rr
->length
)
834 n
= (unsigned int)len
;
836 memcpy(buf
,&(rr
->data
[rr
->off
]),n
);
843 s
->rstate
=SSL_ST_READ_HEADER
;
851 /* If we get here, then type != rr->type; if we have a handshake
852 * message, then it was unexpected (Hello Request or Client Hello). */
854 /* In case of record types for which we have 'fragment' storage,
855 * fill that so that we can process the data at a fixed place.
858 unsigned int dest_maxlen
= 0;
859 unsigned char *dest
= NULL
;
860 unsigned int *dest_len
= NULL
;
862 if (rr
->type
== SSL3_RT_HANDSHAKE
)
864 dest_maxlen
= sizeof s
->s3
->handshake_fragment
;
865 dest
= s
->s3
->handshake_fragment
;
866 dest_len
= &s
->s3
->handshake_fragment_len
;
868 else if (rr
->type
== SSL3_RT_ALERT
)
870 dest_maxlen
= sizeof s
->s3
->alert_fragment
;
871 dest
= s
->s3
->alert_fragment
;
872 dest_len
= &s
->s3
->alert_fragment_len
;
877 n
= dest_maxlen
- *dest_len
; /* available space in 'dest' */
879 n
= rr
->length
; /* available bytes */
881 /* now move 'n' bytes: */
884 dest
[(*dest_len
)++] = rr
->data
[rr
->off
++];
888 if (*dest_len
< dest_maxlen
)
889 goto start
; /* fragment was too small */
893 /* s->s3->handshake_fragment_len == 4 iff rr->type == SSL3_RT_HANDSHAKE;
894 * s->s3->alert_fragment_len == 2 iff rr->type == SSL3_RT_ALERT.
895 * (Possibly rr is 'empty' now, i.e. rr->length may be 0.) */
897 /* If we are a client, check for an incoming 'Hello Request': */
899 (s
->s3
->handshake_fragment_len
>= 4) &&
900 (s
->s3
->handshake_fragment
[0] == SSL3_MT_HELLO_REQUEST
) &&
901 (s
->session
!= NULL
) && (s
->session
->cipher
!= NULL
))
903 s
->s3
->handshake_fragment_len
= 0;
905 if ((s
->s3
->handshake_fragment
[1] != 0) ||
906 (s
->s3
->handshake_fragment
[2] != 0) ||
907 (s
->s3
->handshake_fragment
[3] != 0))
909 al
=SSL_AD_DECODE_ERROR
;
910 SSLerr(SSL_F_SSL3_READ_BYTES
,SSL_R_BAD_HELLO_REQUEST
);
915 s
->msg_callback(0, s
->version
, SSL3_RT_HANDSHAKE
, s
->s3
->handshake_fragment
, 4, s
, s
->msg_callback_arg
);
917 if (SSL_is_init_finished(s
) &&
918 !(s
->s3
->flags
& SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS
) &&
922 if (ssl3_renegotiate_check(s
))
924 i
=s
->handshake_func(s
);
925 if (i
< 0) return(i
);
928 SSLerr(SSL_F_SSL3_READ_BYTES
,SSL_R_SSL_HANDSHAKE_FAILURE
);
932 if (!(s
->mode
& SSL_MODE_AUTO_RETRY
))
934 if (s
->s3
->rbuf
.left
== 0) /* no read-ahead left? */
937 /* In the case where we try to read application data,
938 * but we trigger an SSL handshake, we return -1 with
939 * the retry option set. Otherwise renegotiation may
940 * cause nasty problems in the blocking world */
941 s
->rwstate
=SSL_READING
;
943 BIO_clear_retry_flags(bio
);
944 BIO_set_retry_read(bio
);
950 /* we either finished a handshake or ignored the request,
951 * now try again to obtain the (application) data we were asked for */
955 if (s
->s3
->alert_fragment_len
>= 2)
957 int alert_level
= s
->s3
->alert_fragment
[0];
958 int alert_descr
= s
->s3
->alert_fragment
[1];
960 s
->s3
->alert_fragment_len
= 0;
963 s
->msg_callback(0, s
->version
, SSL3_RT_ALERT
, s
->s3
->alert_fragment
, 2, s
, s
->msg_callback_arg
);
965 if (s
->info_callback
!= NULL
)
967 else if (s
->ctx
->info_callback
!= NULL
)
968 cb
=s
->ctx
->info_callback
;
972 j
= (alert_level
<< 8) | alert_descr
;
973 cb(s
, SSL_CB_READ_ALERT
, j
);
976 if (alert_level
== 1) /* warning */
978 s
->s3
->warn_alert
= alert_descr
;
979 if (alert_descr
== SSL_AD_CLOSE_NOTIFY
)
981 s
->shutdown
|= SSL_RECEIVED_SHUTDOWN
;
985 else if (alert_level
== 2) /* fatal */
989 s
->rwstate
=SSL_NOTHING
;
990 s
->s3
->fatal_alert
= alert_descr
;
991 SSLerr(SSL_F_SSL3_READ_BYTES
, SSL_AD_REASON_OFFSET
+ alert_descr
);
992 BIO_snprintf(tmp
,sizeof tmp
,"%d",alert_descr
);
993 ERR_add_error_data(2,"SSL alert number ",tmp
);
994 s
->shutdown
|=SSL_RECEIVED_SHUTDOWN
;
995 SSL_CTX_remove_session(s
->ctx
,s
->session
);
1000 al
=SSL_AD_ILLEGAL_PARAMETER
;
1001 SSLerr(SSL_F_SSL3_READ_BYTES
,SSL_R_UNKNOWN_ALERT_TYPE
);
1008 if (s
->shutdown
& SSL_SENT_SHUTDOWN
) /* but we have not received a shutdown */
1010 s
->rwstate
=SSL_NOTHING
;
1015 if (rr
->type
== SSL3_RT_CHANGE_CIPHER_SPEC
)
1017 /* 'Change Cipher Spec' is just a single byte, so we know
1018 * exactly what the record payload has to look like */
1019 if ( (rr
->length
!= 1) || (rr
->off
!= 0) ||
1020 (rr
->data
[0] != SSL3_MT_CCS
))
1022 i
=SSL_AD_ILLEGAL_PARAMETER
;
1023 SSLerr(SSL_F_SSL3_READ_BYTES
,SSL_R_BAD_CHANGE_CIPHER_SPEC
);
1029 if (s
->msg_callback
)
1030 s
->msg_callback(0, s
->version
, SSL3_RT_CHANGE_CIPHER_SPEC
, rr
->data
, 1, s
, s
->msg_callback_arg
);
1032 s
->s3
->change_cipher_spec
=1;
1033 if (!do_change_cipher_spec(s
))
1039 /* Unexpected handshake message (Client Hello, or protocol violation) */
1040 if ((s
->s3
->handshake_fragment_len
>= 4) && !s
->in_handshake
)
1042 if (((s
->state
&SSL_ST_MASK
) == SSL_ST_OK
) &&
1043 !(s
->s3
->flags
& SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS
))
1045 #if 0 /* worked only because C operator preferences are not as expected (and
1046 * because this is not really needed for clients except for detecting
1047 * protocol violations): */
1048 s
->state
=SSL_ST_BEFORE
|(s
->server
)
1052 s
->state
= s
->server
? SSL_ST_ACCEPT
: SSL_ST_CONNECT
;
1056 i
=s
->handshake_func(s
);
1057 if (i
< 0) return(i
);
1060 SSLerr(SSL_F_SSL3_READ_BYTES
,SSL_R_SSL_HANDSHAKE_FAILURE
);
1064 if (!(s
->mode
& SSL_MODE_AUTO_RETRY
))
1066 if (s
->s3
->rbuf
.left
== 0) /* no read-ahead left? */
1069 /* In the case where we try to read application data,
1070 * but we trigger an SSL handshake, we return -1 with
1071 * the retry option set. Otherwise renegotiation may
1072 * cause nasty problems in the blocking world */
1073 s
->rwstate
=SSL_READING
;
1074 bio
=SSL_get_rbio(s
);
1075 BIO_clear_retry_flags(bio
);
1076 BIO_set_retry_read(bio
);
1086 #ifndef OPENSSL_NO_TLS
1087 /* TLS just ignores unknown message types */
1088 if (s
->version
== TLS1_VERSION
)
1093 al
=SSL_AD_UNEXPECTED_MESSAGE
;
1094 SSLerr(SSL_F_SSL3_READ_BYTES
,SSL_R_UNEXPECTED_RECORD
);
1096 case SSL3_RT_CHANGE_CIPHER_SPEC
:
1098 case SSL3_RT_HANDSHAKE
:
1099 /* we already handled all of these, with the possible exception
1100 * of SSL3_RT_HANDSHAKE when s->in_handshake is set, but that
1101 * should not happen when type != rr->type */
1102 al
=SSL_AD_UNEXPECTED_MESSAGE
;
1103 SSLerr(SSL_F_SSL3_READ_BYTES
,ERR_R_INTERNAL_ERROR
);
1105 case SSL3_RT_APPLICATION_DATA
:
1106 /* At this point, we were expecting handshake data,
1107 * but have application data. If the library was
1108 * running inside ssl3_read() (i.e. in_read_app_data
1109 * is set) and it makes sense to read application data
1110 * at this point (session renegotiation not yet started),
1111 * we will indulge it.
1113 if (s
->s3
->in_read_app_data
&&
1114 (s
->s3
->total_renegotiations
!= 0) &&
1116 (s
->state
& SSL_ST_CONNECT
) &&
1117 (s
->state
>= SSL3_ST_CW_CLNT_HELLO_A
) &&
1118 (s
->state
<= SSL3_ST_CR_SRVR_HELLO_A
)
1120 (s
->state
& SSL_ST_ACCEPT
) &&
1121 (s
->state
<= SSL3_ST_SW_HELLO_REQ_A
) &&
1122 (s
->state
>= SSL3_ST_SR_CLNT_HELLO_A
)
1126 s
->s3
->in_read_app_data
=0;
1131 al
=SSL_AD_UNEXPECTED_MESSAGE
;
1132 SSLerr(SSL_F_SSL3_READ_BYTES
,SSL_R_UNEXPECTED_RECORD
);
1139 ssl3_send_alert(s
,SSL3_AL_FATAL
,al
);
1144 static int do_change_cipher_spec(SSL
*s
)
1150 if (s
->state
& SSL_ST_ACCEPT
)
1151 i
=SSL3_CHANGE_CIPHER_SERVER_READ
;
1153 i
=SSL3_CHANGE_CIPHER_CLIENT_READ
;
1155 if (s
->s3
->tmp
.key_block
== NULL
)
1157 s
->session
->cipher
=s
->s3
->tmp
.new_cipher
;
1158 if (!s
->method
->ssl3_enc
->setup_key_block(s
)) return(0);
1161 if (!s
->method
->ssl3_enc
->change_cipher_state(s
,i
))
1164 /* we have to record the message digest at
1165 * this point so we can get it before we read
1166 * the finished message */
1167 if (s
->state
& SSL_ST_CONNECT
)
1169 sender
=s
->method
->ssl3_enc
->server_finished_label
;
1170 slen
=s
->method
->ssl3_enc
->server_finished_label_len
;
1174 sender
=s
->method
->ssl3_enc
->client_finished_label
;
1175 slen
=s
->method
->ssl3_enc
->client_finished_label_len
;
1178 s
->s3
->tmp
.peer_finish_md_len
= s
->method
->ssl3_enc
->final_finish_mac(s
,
1179 &(s
->s3
->finish_dgst1
),
1180 &(s
->s3
->finish_dgst2
),
1181 sender
,slen
,s
->s3
->tmp
.peer_finish_md
);
1186 void ssl3_send_alert(SSL
*s
, int level
, int desc
)
1188 /* Map tls/ssl alert value to correct one */
1189 desc
=s
->method
->ssl3_enc
->alert_value(desc
);
1190 if (s
->version
== SSL3_VERSION
&& desc
== SSL_AD_PROTOCOL_VERSION
)
1191 desc
= SSL_AD_HANDSHAKE_FAILURE
; /* SSL 3.0 does not have protocol_version alerts */
1192 if (desc
< 0) return;
1193 /* If a fatal one, remove from cache */
1194 if ((level
== 2) && (s
->session
!= NULL
))
1195 SSL_CTX_remove_session(s
->ctx
,s
->session
);
1197 s
->s3
->alert_dispatch
=1;
1198 s
->s3
->send_alert
[0]=level
;
1199 s
->s3
->send_alert
[1]=desc
;
1200 if (s
->s3
->wbuf
.left
== 0) /* data still being written out? */
1201 ssl3_dispatch_alert(s
);
1202 /* else data is still being written out, we will get written
1203 * some time in the future */
1206 int ssl3_dispatch_alert(SSL
*s
)
1211 s
->s3
->alert_dispatch
=0;
1212 i
=do_ssl3_write(s
,SSL3_RT_ALERT
,&s
->s3
->send_alert
[0],2);
1215 s
->s3
->alert_dispatch
=1;
1219 /* Alert sent to BIO. If it is important, flush it now.
1220 * If the message does not get sent due to non-blocking IO,
1221 * we will not worry too much. */
1222 if (s
->s3
->send_alert
[0] == SSL3_AL_FATAL
)
1223 (void)BIO_flush(s
->wbio
);
1225 if (s
->msg_callback
)
1226 s
->msg_callback(1, s
->version
, SSL3_RT_ALERT
, s
->s3
->send_alert
, 2, s
, s
->msg_callback_arg
);
1228 if (s
->info_callback
!= NULL
)
1229 cb
=s
->info_callback
;
1230 else if (s
->ctx
->info_callback
!= NULL
)
1231 cb
=s
->ctx
->info_callback
;
1235 j
=(s
->s3
->send_alert
[0]<<8)|s
->s3
->send_alert
[1];
1236 cb(s
,SSL_CB_WRITE_ALERT
,j
);