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