7f89cc0a1cad2e50caf90ca51c3f7d361d5dd8e1
[openssl.git] / ssl / record / ssl3_record.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57 /* ====================================================================
58  * Copyright (c) 1998-2015 The OpenSSL Project.  All rights reserved.
59  *
60  * Redistribution and use in source and binary forms, with or without
61  * modification, are permitted provided that the following conditions
62  * are met:
63  *
64  * 1. Redistributions of source code must retain the above copyright
65  *    notice, this list of conditions and the following disclaimer.
66  *
67  * 2. Redistributions in binary form must reproduce the above copyright
68  *    notice, this list of conditions and the following disclaimer in
69  *    the documentation and/or other materials provided with the
70  *    distribution.
71  *
72  * 3. All advertising materials mentioning features or use of this
73  *    software must display the following acknowledgment:
74  *    "This product includes software developed by the OpenSSL Project
75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76  *
77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78  *    endorse or promote products derived from this software without
79  *    prior written permission. For written permission, please contact
80  *    openssl-core@openssl.org.
81  *
82  * 5. Products derived from this software may not be called "OpenSSL"
83  *    nor may "OpenSSL" appear in their names without prior written
84  *    permission of the OpenSSL Project.
85  *
86  * 6. Redistributions of any form whatsoever must retain the following
87  *    acknowledgment:
88  *    "This product includes software developed by the OpenSSL Project
89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90  *
91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102  * OF THE POSSIBILITY OF SUCH DAMAGE.
103  * ====================================================================
104  *
105  * This product includes cryptographic software written by Eric Young
106  * (eay@cryptsoft.com).  This product includes software written by Tim
107  * Hudson (tjh@cryptsoft.com).
108  *
109  */
110
111 #include "../ssl_locl.h"
112 #include "internal/constant_time_locl.h"
113 #include <openssl/rand.h>
114 #include "record_locl.h"
115
116 static const unsigned char ssl3_pad_1[48] = {
117     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
118     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
119     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
120     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
121     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
122     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36
123 };
124
125 static const unsigned char ssl3_pad_2[48] = {
126     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
127     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
128     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
129     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
130     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
131     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c
132 };
133
134 /*
135  * Clear the contents of an SSL3_RECORD but retain any memory allocated
136  */
137 void SSL3_RECORD_clear(SSL3_RECORD *r)
138 {
139     unsigned char *comp = r->comp;
140
141     memset(r, 0, sizeof(*r));
142     r->comp = comp;
143 }
144
145 void SSL3_RECORD_release(SSL3_RECORD *r)
146 {
147     OPENSSL_free(r->comp);
148     r->comp = NULL;
149 }
150
151 int SSL3_RECORD_setup(SSL3_RECORD *r)
152 {
153     if (r->comp == NULL)
154         r->comp = (unsigned char *)
155             OPENSSL_malloc(SSL3_RT_MAX_ENCRYPTED_LENGTH);
156     if (r->comp == NULL)
157         return 0;
158     return 1;
159 }
160
161 void SSL3_RECORD_set_seq_num(SSL3_RECORD *r, const unsigned char *seq_num)
162 {
163     memcpy(r->seq_num, seq_num, SEQ_NUM_SIZE);
164 }
165
166 /*
167  * MAX_EMPTY_RECORDS defines the number of consecutive, empty records that
168  * will be processed per call to ssl3_get_record. Without this limit an
169  * attacker could send empty records at a faster rate than we can process and
170  * cause ssl3_get_record to loop forever.
171  */
172 #define MAX_EMPTY_RECORDS 32
173
174 #define SSL2_RT_HEADER_LENGTH   2
175 /*-
176  * Call this to get a new input record.
177  * It will return <= 0 if more data is needed, normally due to an error
178  * or non-blocking IO.
179  * When it finishes, one packet has been decoded and can be found in
180  * ssl->s3->rrec.type    - is the type of record
181  * ssl->s3->rrec.data,   - data
182  * ssl->s3->rrec.length, - number of bytes
183  */
184 /* used only by ssl3_read_bytes */
185 int ssl3_get_record(SSL *s)
186 {
187     int ssl_major, ssl_minor, al;
188     int enc_err, n, i, ret = -1;
189     SSL3_RECORD *rr;
190     SSL_SESSION *sess;
191     unsigned char *p;
192     unsigned char md[EVP_MAX_MD_SIZE];
193     short version;
194     unsigned mac_size;
195     unsigned empty_record_count = 0;
196
197     rr = RECORD_LAYER_get_rrec(&s->rlayer);
198     sess = s->session;
199
200  again:
201     /* check if we have the header */
202     if ((RECORD_LAYER_get_rstate(&s->rlayer) != SSL_ST_READ_BODY) ||
203         (RECORD_LAYER_get_packet_length(&s->rlayer) < SSL3_RT_HEADER_LENGTH)) {
204         n = ssl3_read_n(s, SSL3_RT_HEADER_LENGTH,
205             SSL3_BUFFER_get_len(&s->rlayer.rbuf), 0);
206         if (n <= 0)
207             return (n);         /* error or non-blocking */
208         RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_BODY);
209
210         p = RECORD_LAYER_get_packet(&s->rlayer);
211
212         /*
213          * Check whether this is a regular record or an SSLv2 style record. The
214          * latter is only used in an initial ClientHello for old clients. We
215          * check s->read_hash and s->enc_read_ctx to ensure this does not apply
216          * during renegotiation
217          */
218         if (s->first_packet && s->server && !s->read_hash && !s->enc_read_ctx
219                 && (p[0] & 0x80) && (p[2] == SSL2_MT_CLIENT_HELLO)) {
220             /* SSLv2 style record */
221             rr->type = SSL3_RT_HANDSHAKE;
222             rr->rec_version = SSL2_VERSION;
223
224             rr->length = ((p[0] & 0x7f) << 8) | p[1];
225
226             if (rr->length > SSL3_BUFFER_get_len(&s->rlayer.rbuf)
227                                     - SSL2_RT_HEADER_LENGTH) {
228                 al = SSL_AD_RECORD_OVERFLOW;
229                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_PACKET_LENGTH_TOO_LONG);
230                 goto f_err;
231             }
232
233             if (rr->length < MIN_SSL2_RECORD_LEN) {
234                 al = SSL_AD_HANDSHAKE_FAILURE;
235                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_LENGTH_TOO_SHORT);
236                 goto f_err;
237             }
238         } else {
239             /* SSLv3+ style record */
240             if (s->msg_callback)
241                 s->msg_callback(0, 0, SSL3_RT_HEADER, p, 5, s,
242                                 s->msg_callback_arg);
243
244             /* Pull apart the header into the SSL3_RECORD */
245             rr->type = *(p++);
246             ssl_major = *(p++);
247             ssl_minor = *(p++);
248             version = (ssl_major << 8) | ssl_minor;
249             rr->rec_version = version;
250             n2s(p, rr->length);
251
252             /* Lets check version */
253             if (!s->first_packet && version != s->version) {
254                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_WRONG_VERSION_NUMBER);
255                 if ((s->version & 0xFF00) == (version & 0xFF00)
256                     && !s->enc_write_ctx && !s->write_hash) {
257                     if (rr->type == SSL3_RT_ALERT) {
258                         /*
259                          * The record is using an incorrect version number, but
260                          * what we've got appears to be an alert. We haven't
261                          * read the body yet to check whether its a fatal or
262                          * not - but chances are it is. We probably shouldn't
263                          * send a fatal alert back. We'll just end.
264                          */
265                          goto err;
266                     }
267                     /*
268                      * Send back error using their minor version number :-)
269                      */
270                     s->version = (unsigned short)version;
271                 }
272                 al = SSL_AD_PROTOCOL_VERSION;
273                 goto f_err;
274             }
275
276             if ((version >> 8) != SSL3_VERSION_MAJOR) {
277                 if (s->first_packet) {
278                     /* Go back to start of packet, look at the five bytes
279                      * that we have. */
280                     p = RECORD_LAYER_get_packet(&s->rlayer);
281                     if (strncmp((char *)p, "GET ", 4) == 0 ||
282                         strncmp((char *)p, "POST ", 5) == 0 ||
283                         strncmp((char *)p, "HEAD ", 5) == 0 ||
284                         strncmp((char *)p, "PUT ", 4) == 0) {
285                         SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_HTTP_REQUEST);
286                         goto err;
287                     } else if (strncmp((char *)p, "CONNE", 5) == 0) {
288                         SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_HTTPS_PROXY_REQUEST);
289                         goto err;
290                     }
291                 }
292                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_WRONG_VERSION_NUMBER);
293                 goto err;
294             }
295
296             if (rr->length >
297                     SSL3_BUFFER_get_len(&s->rlayer.rbuf)
298                     - SSL3_RT_HEADER_LENGTH) {
299                 al = SSL_AD_RECORD_OVERFLOW;
300                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_PACKET_LENGTH_TOO_LONG);
301                 goto f_err;
302             }
303         }
304
305         /* now s->rlayer.rstate == SSL_ST_READ_BODY */
306     }
307
308     /*
309      * s->rlayer.rstate == SSL_ST_READ_BODY, get and decode the data.
310      * Calculate how much more data we need to read for the rest of the record
311      */
312     if (rr->rec_version == SSL2_VERSION) {
313         i = rr->length + SSL2_RT_HEADER_LENGTH - SSL3_RT_HEADER_LENGTH;
314     } else {
315         i = rr->length;
316     }
317     if (i > 0) {
318         /* now s->packet_length == SSL3_RT_HEADER_LENGTH */
319
320         n = ssl3_read_n(s, i, i, 1);
321         if (n <= 0)
322             return (n);         /* error or non-blocking io */
323     }
324
325     /* set state for later operations */
326     RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_HEADER);
327
328     /*
329      * At this point, s->packet_length == SSL3_RT_HEADER_LENGTH + rr->length,
330      * or s->packet_length == SSL2_RT_HEADER_LENGTH + rr->length
331      * and we have that many bytes in s->packet
332      */
333     if(rr->rec_version == SSL2_VERSION) {
334         rr->input = &(RECORD_LAYER_get_packet(&s->rlayer)[SSL2_RT_HEADER_LENGTH]);
335     } else {
336         rr->input = &(RECORD_LAYER_get_packet(&s->rlayer)[SSL3_RT_HEADER_LENGTH]);
337     }
338
339     /*
340      * ok, we can now read from 's->packet' data into 'rr' rr->input points
341      * at rr->length bytes, which need to be copied into rr->data by either
342      * the decryption or by the decompression When the data is 'copied' into
343      * the rr->data buffer, rr->input will be pointed at the new buffer
344      */
345
346     /*
347      * We now have - encrypted [ MAC [ compressed [ plain ] ] ] rr->length
348      * bytes of encrypted compressed stuff.
349      */
350
351     /* check is not needed I believe */
352     if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH) {
353         al = SSL_AD_RECORD_OVERFLOW;
354         SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
355         goto f_err;
356     }
357
358     /* decrypt in place in 'rr->input' */
359     rr->data = rr->input;
360     rr->orig_len = rr->length;
361     /*
362      * If in encrypt-then-mac mode calculate mac from encrypted record. All
363      * the details below are public so no timing details can leak.
364      */
365     if (SSL_USE_ETM(s) && s->read_hash) {
366         unsigned char *mac;
367         mac_size = EVP_MD_CTX_size(s->read_hash);
368         OPENSSL_assert(mac_size <= EVP_MAX_MD_SIZE);
369         if (rr->length < mac_size) {
370             al = SSL_AD_DECODE_ERROR;
371             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_LENGTH_TOO_SHORT);
372             goto f_err;
373         }
374         rr->length -= mac_size;
375         mac = rr->data + rr->length;
376         i = s->method->ssl3_enc->mac(s, md, 0 /* not send */ );
377         if (i < 0 || CRYPTO_memcmp(md, mac, (size_t)mac_size) != 0) {
378             al = SSL_AD_BAD_RECORD_MAC;
379             SSLerr(SSL_F_SSL3_GET_RECORD,
380                    SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
381             goto f_err;
382         }
383     }
384
385     enc_err = s->method->ssl3_enc->enc(s, 0);
386     /*-
387      * enc_err is:
388      *    0: (in non-constant time) if the record is publically invalid.
389      *    1: if the padding is valid
390      *    -1: if the padding is invalid
391      */
392     if (enc_err == 0) {
393         al = SSL_AD_DECRYPTION_FAILED;
394         SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BLOCK_CIPHER_PAD_IS_WRONG);
395         goto f_err;
396     }
397 #ifdef SSL_DEBUG
398     printf("dec %d\n", rr->length);
399     {
400         unsigned int z;
401         for (z = 0; z < rr->length; z++)
402             printf("%02X%c", rr->data[z], ((z + 1) % 16) ? ' ' : '\n');
403     }
404     printf("\n");
405 #endif
406
407     /* r->length is now the compressed data plus mac */
408     if ((sess != NULL) &&
409         (s->enc_read_ctx != NULL) &&
410         (EVP_MD_CTX_md(s->read_hash) != NULL) && !SSL_USE_ETM(s)) {
411         /* s->read_hash != NULL => mac_size != -1 */
412         unsigned char *mac = NULL;
413         unsigned char mac_tmp[EVP_MAX_MD_SIZE];
414         mac_size = EVP_MD_CTX_size(s->read_hash);
415         OPENSSL_assert(mac_size <= EVP_MAX_MD_SIZE);
416
417         /*
418          * orig_len is the length of the record before any padding was
419          * removed. This is public information, as is the MAC in use,
420          * therefore we can safely process the record in a different amount
421          * of time if it's too short to possibly contain a MAC.
422          */
423         if (rr->orig_len < mac_size ||
424             /* CBC records must have a padding length byte too. */
425             (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
426              rr->orig_len < mac_size + 1)) {
427             al = SSL_AD_DECODE_ERROR;
428             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_LENGTH_TOO_SHORT);
429             goto f_err;
430         }
431
432         if (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE) {
433             /*
434              * We update the length so that the TLS header bytes can be
435              * constructed correctly but we need to extract the MAC in
436              * constant time from within the record, without leaking the
437              * contents of the padding bytes.
438              */
439             mac = mac_tmp;
440             ssl3_cbc_copy_mac(mac_tmp, rr, mac_size);
441             rr->length -= mac_size;
442         } else {
443             /*
444              * In this case there's no padding, so |rec->orig_len| equals
445              * |rec->length| and we checked that there's enough bytes for
446              * |mac_size| above.
447              */
448             rr->length -= mac_size;
449             mac = &rr->data[rr->length];
450         }
451
452         i = s->method->ssl3_enc->mac(s, md, 0 /* not send */ );
453         if (i < 0 || mac == NULL
454             || CRYPTO_memcmp(md, mac, (size_t)mac_size) != 0)
455             enc_err = -1;
456         if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH + mac_size)
457             enc_err = -1;
458     }
459
460     if (enc_err < 0) {
461         /*
462          * A separate 'decryption_failed' alert was introduced with TLS 1.0,
463          * SSL 3.0 only has 'bad_record_mac'.  But unless a decryption
464          * failure is directly visible from the ciphertext anyway, we should
465          * not reveal which kind of error occurred -- this might become
466          * visible to an attacker (e.g. via a logfile)
467          */
468         al = SSL_AD_BAD_RECORD_MAC;
469         SSLerr(SSL_F_SSL3_GET_RECORD,
470                SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
471         goto f_err;
472     }
473
474     /* r->length is now just compressed */
475     if (s->expand != NULL) {
476         if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH) {
477             al = SSL_AD_RECORD_OVERFLOW;
478             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_COMPRESSED_LENGTH_TOO_LONG);
479             goto f_err;
480         }
481         if (!ssl3_do_uncompress(s)) {
482             al = SSL_AD_DECOMPRESSION_FAILURE;
483             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BAD_DECOMPRESSION);
484             goto f_err;
485         }
486     }
487
488     if (rr->length > SSL3_RT_MAX_PLAIN_LENGTH) {
489         al = SSL_AD_RECORD_OVERFLOW;
490         SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_DATA_LENGTH_TOO_LONG);
491         goto f_err;
492     }
493
494     rr->off = 0;
495     /*-
496      * So at this point the following is true
497      * ssl->s3->rrec.type   is the type of record
498      * ssl->s3->rrec.length == number of bytes in record
499      * ssl->s3->rrec.off    == offset to first valid byte
500      * ssl->s3->rrec.data   == where to take bytes from, increment
501      *                         after use :-).
502      */
503
504     /* we have pulled in a full packet so zero things */
505     RECORD_LAYER_reset_packet_length(&s->rlayer);
506
507     /* just read a 0 length packet */
508     if (rr->length == 0) {
509         empty_record_count++;
510         if (empty_record_count > MAX_EMPTY_RECORDS) {
511             al = SSL_AD_UNEXPECTED_MESSAGE;
512             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_RECORD_TOO_SMALL);
513             goto f_err;
514         }
515         goto again;
516     }
517
518     return (1);
519
520  f_err:
521     ssl3_send_alert(s, SSL3_AL_FATAL, al);
522  err:
523     return (ret);
524 }
525
526 int ssl3_do_uncompress(SSL *ssl)
527 {
528 #ifndef OPENSSL_NO_COMP
529     int i;
530     SSL3_RECORD *rr;
531
532     rr = RECORD_LAYER_get_rrec(&ssl->rlayer);
533     i = COMP_expand_block(ssl->expand, rr->comp,
534                           SSL3_RT_MAX_PLAIN_LENGTH, rr->data,
535                           (int)rr->length);
536     if (i < 0)
537         return (0);
538     else
539         rr->length = i;
540     rr->data = rr->comp;
541 #endif
542     return (1);
543 }
544
545 int ssl3_do_compress(SSL *ssl)
546 {
547 #ifndef OPENSSL_NO_COMP
548     int i;
549     SSL3_RECORD *wr;
550
551     wr = RECORD_LAYER_get_wrec(&ssl->rlayer);
552     i = COMP_compress_block(ssl->compress, wr->data,
553                             SSL3_RT_MAX_COMPRESSED_LENGTH,
554                             wr->input, (int)wr->length);
555     if (i < 0)
556         return (0);
557     else
558         wr->length = i;
559
560     wr->input = wr->data;
561 #endif
562     return (1);
563 }
564
565 /*-
566  * ssl3_enc encrypts/decrypts the record in |s->wrec| / |s->rrec|, respectively.
567  *
568  * Returns:
569  *   0: (in non-constant time) if the record is publically invalid (i.e. too
570  *       short etc).
571  *   1: if the record's padding is valid / the encryption was successful.
572  *   -1: if the record's padding is invalid or, if sending, an internal error
573  *       occurred.
574  */
575 int ssl3_enc(SSL *s, int send)
576 {
577     SSL3_RECORD *rec;
578     EVP_CIPHER_CTX *ds;
579     unsigned long l;
580     int bs, i, mac_size = 0;
581     const EVP_CIPHER *enc;
582
583     if (send) {
584         ds = s->enc_write_ctx;
585         rec = RECORD_LAYER_get_wrec(&s->rlayer);
586         if (s->enc_write_ctx == NULL)
587             enc = NULL;
588         else
589             enc = EVP_CIPHER_CTX_cipher(s->enc_write_ctx);
590     } else {
591         ds = s->enc_read_ctx;
592         rec = RECORD_LAYER_get_rrec(&s->rlayer);
593         if (s->enc_read_ctx == NULL)
594             enc = NULL;
595         else
596             enc = EVP_CIPHER_CTX_cipher(s->enc_read_ctx);
597     }
598
599     if ((s->session == NULL) || (ds == NULL) || (enc == NULL)) {
600         memmove(rec->data, rec->input, rec->length);
601         rec->input = rec->data;
602     } else {
603         l = rec->length;
604         bs = EVP_CIPHER_CTX_block_size(ds);
605
606         /* COMPRESS */
607
608         if ((bs != 1) && send) {
609             i = bs - ((int)l % bs);
610
611             /* we need to add 'i-1' padding bytes */
612             l += i;
613             /*
614              * the last of these zero bytes will be overwritten with the
615              * padding length.
616              */
617             memset(&rec->input[rec->length], 0, i);
618             rec->length += i;
619             rec->input[l - 1] = (i - 1);
620         }
621
622         if (!send) {
623             if (l == 0 || l % bs != 0)
624                 return 0;
625             /* otherwise, rec->length >= bs */
626         }
627
628         if (EVP_Cipher(ds, rec->data, rec->input, l) < 1)
629             return -1;
630
631         if (EVP_MD_CTX_md(s->read_hash) != NULL)
632             mac_size = EVP_MD_CTX_size(s->read_hash);
633         if ((bs != 1) && !send)
634             return ssl3_cbc_remove_padding(rec, bs, mac_size);
635     }
636     return (1);
637 }
638
639 /*-
640  * tls1_enc encrypts/decrypts the record in |s->wrec| / |s->rrec|, respectively.
641  *
642  * Returns:
643  *   0: (in non-constant time) if the record is publically invalid (i.e. too
644  *       short etc).
645  *   1: if the record's padding is valid / the encryption was successful.
646  *   -1: if the record's padding/AEAD-authenticator is invalid or, if sending,
647  *       an internal error occurred.
648  */
649 int tls1_enc(SSL *s, int send)
650 {
651     SSL3_RECORD *rec;
652     EVP_CIPHER_CTX *ds;
653     unsigned long l;
654     int bs, i, j, k, pad = 0, ret, mac_size = 0;
655     const EVP_CIPHER *enc;
656
657     if (send) {
658         if (EVP_MD_CTX_md(s->write_hash)) {
659             int n = EVP_MD_CTX_size(s->write_hash);
660             OPENSSL_assert(n >= 0);
661         }
662         ds = s->enc_write_ctx;
663         rec = RECORD_LAYER_get_wrec(&s->rlayer);
664         if (s->enc_write_ctx == NULL)
665             enc = NULL;
666         else {
667             int ivlen;
668             enc = EVP_CIPHER_CTX_cipher(s->enc_write_ctx);
669             /* For TLSv1.1 and later explicit IV */
670             if (SSL_USE_EXPLICIT_IV(s)
671                 && EVP_CIPHER_mode(enc) == EVP_CIPH_CBC_MODE)
672                 ivlen = EVP_CIPHER_iv_length(enc);
673             else
674                 ivlen = 0;
675             if (ivlen > 1) {
676                 if (rec->data != rec->input)
677                     /*
678                      * we can't write into the input stream: Can this ever
679                      * happen?? (steve)
680                      */
681                     fprintf(stderr, "tls1_enc(): rec->data != rec->input\n");
682                 else if (RAND_bytes(rec->input, ivlen) <= 0)
683                     return -1;
684             }
685         }
686     } else {
687         if (EVP_MD_CTX_md(s->read_hash)) {
688             int n = EVP_MD_CTX_size(s->read_hash);
689             OPENSSL_assert(n >= 0);
690         }
691         ds = s->enc_read_ctx;
692         rec = RECORD_LAYER_get_rrec(&s->rlayer);
693         if (s->enc_read_ctx == NULL)
694             enc = NULL;
695         else
696             enc = EVP_CIPHER_CTX_cipher(s->enc_read_ctx);
697     }
698
699     if ((s->session == NULL) || (ds == NULL) || (enc == NULL)) {
700         memmove(rec->data, rec->input, rec->length);
701         rec->input = rec->data;
702         ret = 1;
703     } else {
704         l = rec->length;
705         bs = EVP_CIPHER_CTX_block_size(ds);
706
707         if (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ds)) & EVP_CIPH_FLAG_AEAD_CIPHER) {
708             unsigned char buf[EVP_AEAD_TLS1_AAD_LEN], *seq;
709
710             seq = send ? RECORD_LAYER_get_write_sequence(&s->rlayer)
711                 : RECORD_LAYER_get_read_sequence(&s->rlayer);
712
713             if (SSL_IS_DTLS(s)) {
714                 unsigned char dtlsseq[9], *p = dtlsseq;
715
716                 s2n(send ? DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer) :
717                     DTLS_RECORD_LAYER_get_r_epoch(&s->rlayer), p);
718                 memcpy(p, &seq[2], 6);
719                 memcpy(buf, dtlsseq, 8);
720             } else {
721                 memcpy(buf, seq, 8);
722                 for (i = 7; i >= 0; i--) { /* increment */
723                     ++seq[i];
724                     if (seq[i] != 0)
725                         break;
726                 }
727             }
728
729             buf[8] = rec->type;
730             buf[9] = (unsigned char)(s->version >> 8);
731             buf[10] = (unsigned char)(s->version);
732             buf[11] = rec->length >> 8;
733             buf[12] = rec->length & 0xff;
734             pad = EVP_CIPHER_CTX_ctrl(ds, EVP_CTRL_AEAD_TLS1_AAD,
735                                       EVP_AEAD_TLS1_AAD_LEN, buf);
736             if (pad <= 0)
737                 return -1;
738             if (send) {
739                 l += pad;
740                 rec->length += pad;
741             }
742         } else if ((bs != 1) && send) {
743             i = bs - ((int)l % bs);
744
745             /* Add weird padding of upto 256 bytes */
746
747             /* we need to add 'i' padding bytes of value j */
748             j = i - 1;
749             for (k = (int)l; k < (int)(l + i); k++)
750                 rec->input[k] = j;
751             l += i;
752             rec->length += i;
753         }
754
755         if (!send) {
756             if (l == 0 || l % bs != 0)
757                 return 0;
758         }
759
760         i = EVP_Cipher(ds, rec->data, rec->input, l);
761         if ((EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ds)) & EVP_CIPH_FLAG_CUSTOM_CIPHER)
762             ? (i < 0)
763             : (i == 0))
764             return -1;          /* AEAD can fail to verify MAC */
765         if (send == 0) {
766             if (EVP_CIPHER_mode(enc) == EVP_CIPH_GCM_MODE) {
767                 rec->data += EVP_GCM_TLS_EXPLICIT_IV_LEN;
768                 rec->input += EVP_GCM_TLS_EXPLICIT_IV_LEN;
769                 rec->length -= EVP_GCM_TLS_EXPLICIT_IV_LEN;
770             } else if (EVP_CIPHER_mode(enc) == EVP_CIPH_CCM_MODE) {
771                 rec->data += EVP_CCM_TLS_EXPLICIT_IV_LEN;
772                 rec->input += EVP_CCM_TLS_EXPLICIT_IV_LEN;
773                 rec->length -= EVP_CCM_TLS_EXPLICIT_IV_LEN;
774             }
775         }
776
777         ret = 1;
778         if (!SSL_USE_ETM(s) && EVP_MD_CTX_md(s->read_hash) != NULL)
779             mac_size = EVP_MD_CTX_size(s->read_hash);
780         if ((bs != 1) && !send)
781             ret = tls1_cbc_remove_padding(s, rec, bs, mac_size);
782         if (pad && !send)
783             rec->length -= pad;
784     }
785     return ret;
786 }
787
788 int n_ssl3_mac(SSL *ssl, unsigned char *md, int send)
789 {
790     SSL3_RECORD *rec;
791     unsigned char *mac_sec, *seq;
792     const EVP_MD_CTX *hash;
793     unsigned char *p, rec_char;
794     size_t md_size;
795     int npad;
796     int t;
797
798     if (send) {
799         rec = RECORD_LAYER_get_wrec(&ssl->rlayer);
800         mac_sec = &(ssl->s3->write_mac_secret[0]);
801         seq = RECORD_LAYER_get_write_sequence(&ssl->rlayer);
802         hash = ssl->write_hash;
803     } else {
804         rec = RECORD_LAYER_get_rrec(&ssl->rlayer);
805         mac_sec = &(ssl->s3->read_mac_secret[0]);
806         seq = RECORD_LAYER_get_read_sequence(&ssl->rlayer);
807         hash = ssl->read_hash;
808     }
809
810     t = EVP_MD_CTX_size(hash);
811     if (t < 0)
812         return -1;
813     md_size = t;
814     npad = (48 / md_size) * md_size;
815
816     if (!send &&
817         EVP_CIPHER_CTX_mode(ssl->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
818         ssl3_cbc_record_digest_supported(hash)) {
819         /*
820          * This is a CBC-encrypted record. We must avoid leaking any
821          * timing-side channel information about how many blocks of data we
822          * are hashing because that gives an attacker a timing-oracle.
823          */
824
825         /*-
826          * npad is, at most, 48 bytes and that's with MD5:
827          *   16 + 48 + 8 (sequence bytes) + 1 + 2 = 75.
828          *
829          * With SHA-1 (the largest hash speced for SSLv3) the hash size
830          * goes up 4, but npad goes down by 8, resulting in a smaller
831          * total size.
832          */
833         unsigned char header[75];
834         unsigned j = 0;
835         memcpy(header + j, mac_sec, md_size);
836         j += md_size;
837         memcpy(header + j, ssl3_pad_1, npad);
838         j += npad;
839         memcpy(header + j, seq, 8);
840         j += 8;
841         header[j++] = rec->type;
842         header[j++] = rec->length >> 8;
843         header[j++] = rec->length & 0xff;
844
845         /* Final param == is SSLv3 */
846         if (ssl3_cbc_digest_record(hash,
847                                    md, &md_size,
848                                    header, rec->input,
849                                    rec->length + md_size, rec->orig_len,
850                                    mac_sec, md_size, 1) <= 0)
851             return -1;
852     } else {
853         unsigned int md_size_u;
854         /* Chop the digest off the end :-) */
855         EVP_MD_CTX *md_ctx = EVP_MD_CTX_new();
856
857         if (md_ctx == NULL)
858             return -1;
859
860         rec_char = rec->type;
861         p = md;
862         s2n(rec->length, p);
863         if (EVP_MD_CTX_copy_ex(md_ctx, hash) <= 0
864                 || EVP_DigestUpdate(md_ctx, mac_sec, md_size) <= 0
865                 || EVP_DigestUpdate(md_ctx, ssl3_pad_1, npad) <= 0
866                 || EVP_DigestUpdate(md_ctx, seq, 8) <= 0
867                 || EVP_DigestUpdate(md_ctx, &rec_char, 1) <= 0
868                 || EVP_DigestUpdate(md_ctx, md, 2) <= 0
869                 || EVP_DigestUpdate(md_ctx, rec->input, rec->length) <= 0
870                 || EVP_DigestFinal_ex(md_ctx, md, NULL) <= 0
871                 || EVP_MD_CTX_copy_ex(md_ctx, hash) <= 0
872                 || EVP_DigestUpdate(md_ctx, mac_sec, md_size) <= 0
873                 || EVP_DigestUpdate(md_ctx, ssl3_pad_2, npad) <= 0
874                 || EVP_DigestUpdate(md_ctx, md, md_size) <= 0
875                 || EVP_DigestFinal_ex(md_ctx, md, &md_size_u) <= 0) {
876             EVP_MD_CTX_reset(md_ctx);
877             return -1;
878         }
879         md_size = md_size_u;
880
881         EVP_MD_CTX_free(md_ctx);
882     }
883
884     ssl3_record_sequence_update(seq);
885     return (md_size);
886 }
887
888 int tls1_mac(SSL *ssl, unsigned char *md, int send)
889 {
890     SSL3_RECORD *rec;
891     unsigned char *seq;
892     EVP_MD_CTX *hash;
893     size_t md_size;
894     int i;
895     EVP_MD_CTX *hmac = NULL, *mac_ctx;
896     unsigned char header[13];
897     int stream_mac = (send ? (ssl->mac_flags & SSL_MAC_FLAG_WRITE_MAC_STREAM)
898                       : (ssl->mac_flags & SSL_MAC_FLAG_READ_MAC_STREAM));
899     int t;
900
901     if (send) {
902         rec = RECORD_LAYER_get_wrec(&ssl->rlayer);
903         seq = RECORD_LAYER_get_write_sequence(&ssl->rlayer);
904         hash = ssl->write_hash;
905     } else {
906         rec = RECORD_LAYER_get_rrec(&ssl->rlayer);
907         seq = RECORD_LAYER_get_read_sequence(&ssl->rlayer);
908         hash = ssl->read_hash;
909     }
910
911     t = EVP_MD_CTX_size(hash);
912     OPENSSL_assert(t >= 0);
913     md_size = t;
914
915     /* I should fix this up TLS TLS TLS TLS TLS XXXXXXXX */
916     if (stream_mac) {
917         mac_ctx = hash;
918     } else {
919         hmac = EVP_MD_CTX_new();
920         if (hmac == NULL
921                 || !EVP_MD_CTX_copy(hmac, hash))
922             return -1;
923         mac_ctx = hmac;
924     }
925
926     if (SSL_IS_DTLS(ssl)) {
927         unsigned char dtlsseq[8], *p = dtlsseq;
928
929         s2n(send ? DTLS_RECORD_LAYER_get_w_epoch(&ssl->rlayer) :
930             DTLS_RECORD_LAYER_get_r_epoch(&ssl->rlayer), p);
931         memcpy(p, &seq[2], 6);
932
933         memcpy(header, dtlsseq, 8);
934     } else
935         memcpy(header, seq, 8);
936
937     header[8] = rec->type;
938     header[9] = (unsigned char)(ssl->version >> 8);
939     header[10] = (unsigned char)(ssl->version);
940     header[11] = (rec->length) >> 8;
941     header[12] = (rec->length) & 0xff;
942
943     if (!send && !SSL_USE_ETM(ssl) &&
944         EVP_CIPHER_CTX_mode(ssl->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
945         ssl3_cbc_record_digest_supported(mac_ctx)) {
946         /*
947          * This is a CBC-encrypted record. We must avoid leaking any
948          * timing-side channel information about how many blocks of data we
949          * are hashing because that gives an attacker a timing-oracle.
950          */
951         /* Final param == not SSLv3 */
952         if (ssl3_cbc_digest_record(mac_ctx,
953                                    md, &md_size,
954                                    header, rec->input,
955                                    rec->length + md_size, rec->orig_len,
956                                    ssl->s3->read_mac_secret,
957                                    ssl->s3->read_mac_secret_size, 0) <= 0) {
958             EVP_MD_CTX_free(hmac);
959             return -1;
960         }
961     } else {
962         if (EVP_DigestSignUpdate(mac_ctx, header, sizeof(header)) <= 0
963                 || EVP_DigestSignUpdate(mac_ctx, rec->input, rec->length) <= 0
964                 || EVP_DigestSignFinal(mac_ctx, md, &md_size) <= 0) {
965             EVP_MD_CTX_free(hmac);
966             return -1;
967         }
968         if (!send && !SSL_USE_ETM(ssl) && FIPS_mode())
969             tls_fips_digest_extra(ssl->enc_read_ctx,
970                                   mac_ctx, rec->input,
971                                   rec->length, rec->orig_len);
972     }
973
974     EVP_MD_CTX_free(hmac);
975
976 #ifdef SSL_DEBUG
977     fprintf(stderr, "seq=");
978     {
979         int z;
980         for (z = 0; z < 8; z++)
981             fprintf(stderr, "%02X ", seq[z]);
982         fprintf(stderr, "\n");
983     }
984     fprintf(stderr, "rec=");
985     {
986         unsigned int z;
987         for (z = 0; z < rec->length; z++)
988             fprintf(stderr, "%02X ", rec->data[z]);
989         fprintf(stderr, "\n");
990     }
991 #endif
992
993     if (!SSL_IS_DTLS(ssl)) {
994         for (i = 7; i >= 0; i--) {
995             ++seq[i];
996             if (seq[i] != 0)
997                 break;
998         }
999     }
1000 #ifdef SSL_DEBUG
1001     {
1002         unsigned int z;
1003         for (z = 0; z < md_size; z++)
1004             fprintf(stderr, "%02X ", md[z]);
1005         fprintf(stderr, "\n");
1006     }
1007 #endif
1008     return (md_size);
1009 }
1010
1011 /*-
1012  * ssl3_cbc_remove_padding removes padding from the decrypted, SSLv3, CBC
1013  * record in |rec| by updating |rec->length| in constant time.
1014  *
1015  * block_size: the block size of the cipher used to encrypt the record.
1016  * returns:
1017  *   0: (in non-constant time) if the record is publicly invalid.
1018  *   1: if the padding was valid
1019  *  -1: otherwise.
1020  */
1021 int ssl3_cbc_remove_padding(SSL3_RECORD *rec,
1022                             unsigned block_size, unsigned mac_size)
1023 {
1024     unsigned padding_length, good;
1025     const unsigned overhead = 1 /* padding length byte */  + mac_size;
1026
1027     /*
1028      * These lengths are all public so we can test them in non-constant time.
1029      */
1030     if (overhead > rec->length)
1031         return 0;
1032
1033     padding_length = rec->data[rec->length - 1];
1034     good = constant_time_ge(rec->length, padding_length + overhead);
1035     /* SSLv3 requires that the padding is minimal. */
1036     good &= constant_time_ge(block_size, padding_length + 1);
1037     rec->length -= good & (padding_length + 1);
1038     return constant_time_select_int(good, 1, -1);
1039 }
1040
1041 /*-
1042  * tls1_cbc_remove_padding removes the CBC padding from the decrypted, TLS, CBC
1043  * record in |rec| in constant time and returns 1 if the padding is valid and
1044  * -1 otherwise. It also removes any explicit IV from the start of the record
1045  * without leaking any timing about whether there was enough space after the
1046  * padding was removed.
1047  *
1048  * block_size: the block size of the cipher used to encrypt the record.
1049  * returns:
1050  *   0: (in non-constant time) if the record is publicly invalid.
1051  *   1: if the padding was valid
1052  *  -1: otherwise.
1053  */
1054 int tls1_cbc_remove_padding(const SSL *s,
1055                             SSL3_RECORD *rec,
1056                             unsigned block_size, unsigned mac_size)
1057 {
1058     unsigned padding_length, good, to_check, i;
1059     const unsigned overhead = 1 /* padding length byte */  + mac_size;
1060     /* Check if version requires explicit IV */
1061     if (SSL_USE_EXPLICIT_IV(s)) {
1062         /*
1063          * These lengths are all public so we can test them in non-constant
1064          * time.
1065          */
1066         if (overhead + block_size > rec->length)
1067             return 0;
1068         /* We can now safely skip explicit IV */
1069         rec->data += block_size;
1070         rec->input += block_size;
1071         rec->length -= block_size;
1072         rec->orig_len -= block_size;
1073     } else if (overhead > rec->length)
1074         return 0;
1075
1076     padding_length = rec->data[rec->length - 1];
1077
1078     if (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s->enc_read_ctx)) & EVP_CIPH_FLAG_AEAD_CIPHER) {
1079         /* padding is already verified */
1080         rec->length -= padding_length + 1;
1081         return 1;
1082     }
1083
1084     good = constant_time_ge(rec->length, overhead + padding_length);
1085     /*
1086      * The padding consists of a length byte at the end of the record and
1087      * then that many bytes of padding, all with the same value as the length
1088      * byte. Thus, with the length byte included, there are i+1 bytes of
1089      * padding. We can't check just |padding_length+1| bytes because that
1090      * leaks decrypted information. Therefore we always have to check the
1091      * maximum amount of padding possible. (Again, the length of the record
1092      * is public information so we can use it.)
1093      */
1094     to_check = 255;             /* maximum amount of padding. */
1095     if (to_check > rec->length - 1)
1096         to_check = rec->length - 1;
1097
1098     for (i = 0; i < to_check; i++) {
1099         unsigned char mask = constant_time_ge_8(padding_length, i);
1100         unsigned char b = rec->data[rec->length - 1 - i];
1101         /*
1102          * The final |padding_length+1| bytes should all have the value
1103          * |padding_length|. Therefore the XOR should be zero.
1104          */
1105         good &= ~(mask & (padding_length ^ b));
1106     }
1107
1108     /*
1109      * If any of the final |padding_length+1| bytes had the wrong value, one
1110      * or more of the lower eight bits of |good| will be cleared.
1111      */
1112     good = constant_time_eq(0xff, good & 0xff);
1113     rec->length -= good & (padding_length + 1);
1114
1115     return constant_time_select_int(good, 1, -1);
1116 }
1117
1118 /*-
1119  * ssl3_cbc_copy_mac copies |md_size| bytes from the end of |rec| to |out| in
1120  * constant time (independent of the concrete value of rec->length, which may
1121  * vary within a 256-byte window).
1122  *
1123  * ssl3_cbc_remove_padding or tls1_cbc_remove_padding must be called prior to
1124  * this function.
1125  *
1126  * On entry:
1127  *   rec->orig_len >= md_size
1128  *   md_size <= EVP_MAX_MD_SIZE
1129  *
1130  * If CBC_MAC_ROTATE_IN_PLACE is defined then the rotation is performed with
1131  * variable accesses in a 64-byte-aligned buffer. Assuming that this fits into
1132  * a single or pair of cache-lines, then the variable memory accesses don't
1133  * actually affect the timing. CPUs with smaller cache-lines [if any] are
1134  * not multi-core and are not considered vulnerable to cache-timing attacks.
1135  */
1136 #define CBC_MAC_ROTATE_IN_PLACE
1137
1138 void ssl3_cbc_copy_mac(unsigned char *out,
1139                        const SSL3_RECORD *rec, unsigned md_size)
1140 {
1141 #if defined(CBC_MAC_ROTATE_IN_PLACE)
1142     unsigned char rotated_mac_buf[64 + EVP_MAX_MD_SIZE];
1143     unsigned char *rotated_mac;
1144 #else
1145     unsigned char rotated_mac[EVP_MAX_MD_SIZE];
1146 #endif
1147
1148     /*
1149      * mac_end is the index of |rec->data| just after the end of the MAC.
1150      */
1151     unsigned mac_end = rec->length;
1152     unsigned mac_start = mac_end - md_size;
1153     /*
1154      * scan_start contains the number of bytes that we can ignore because the
1155      * MAC's position can only vary by 255 bytes.
1156      */
1157     unsigned scan_start = 0;
1158     unsigned i, j;
1159     unsigned div_spoiler;
1160     unsigned rotate_offset;
1161
1162     OPENSSL_assert(rec->orig_len >= md_size);
1163     OPENSSL_assert(md_size <= EVP_MAX_MD_SIZE);
1164
1165 #if defined(CBC_MAC_ROTATE_IN_PLACE)
1166     rotated_mac = rotated_mac_buf + ((0 - (size_t)rotated_mac_buf) & 63);
1167 #endif
1168
1169     /* This information is public so it's safe to branch based on it. */
1170     if (rec->orig_len > md_size + 255 + 1)
1171         scan_start = rec->orig_len - (md_size + 255 + 1);
1172     /*
1173      * div_spoiler contains a multiple of md_size that is used to cause the
1174      * modulo operation to be constant time. Without this, the time varies
1175      * based on the amount of padding when running on Intel chips at least.
1176      * The aim of right-shifting md_size is so that the compiler doesn't
1177      * figure out that it can remove div_spoiler as that would require it to
1178      * prove that md_size is always even, which I hope is beyond it.
1179      */
1180     div_spoiler = md_size >> 1;
1181     div_spoiler <<= (sizeof(div_spoiler) - 1) * 8;
1182     rotate_offset = (div_spoiler + mac_start - scan_start) % md_size;
1183
1184     memset(rotated_mac, 0, md_size);
1185     for (i = scan_start, j = 0; i < rec->orig_len; i++) {
1186         unsigned char mac_started = constant_time_ge_8(i, mac_start);
1187         unsigned char mac_ended = constant_time_ge_8(i, mac_end);
1188         unsigned char b = rec->data[i];
1189         rotated_mac[j++] |= b & mac_started & ~mac_ended;
1190         j &= constant_time_lt(j, md_size);
1191     }
1192
1193     /* Now rotate the MAC */
1194 #if defined(CBC_MAC_ROTATE_IN_PLACE)
1195     j = 0;
1196     for (i = 0; i < md_size; i++) {
1197         /* in case cache-line is 32 bytes, touch second line */
1198         ((volatile unsigned char *)rotated_mac)[rotate_offset ^ 32];
1199         out[j++] = rotated_mac[rotate_offset++];
1200         rotate_offset &= constant_time_lt(rotate_offset, md_size);
1201     }
1202 #else
1203     memset(out, 0, md_size);
1204     rotate_offset = md_size - rotate_offset;
1205     rotate_offset &= constant_time_lt(rotate_offset, md_size);
1206     for (i = 0; i < md_size; i++) {
1207         for (j = 0; j < md_size; j++)
1208             out[j] |= rotated_mac[i] & constant_time_eq_8(j, rotate_offset);
1209         rotate_offset++;
1210         rotate_offset &= constant_time_lt(rotate_offset, md_size);
1211     }
1212 #endif
1213 }
1214
1215 int dtls1_process_record(SSL *s)
1216 {
1217     int i, al;
1218     int enc_err;
1219     SSL_SESSION *sess;
1220     SSL3_RECORD *rr;
1221     unsigned int mac_size;
1222     unsigned char md[EVP_MAX_MD_SIZE];
1223
1224     rr = RECORD_LAYER_get_rrec(&s->rlayer);
1225     sess = s->session;
1226
1227     /*
1228      * At this point, s->packet_length == SSL3_RT_HEADER_LNGTH + rr->length,
1229      * and we have that many bytes in s->packet
1230      */
1231     rr->input = &(RECORD_LAYER_get_packet(&s->rlayer)[DTLS1_RT_HEADER_LENGTH]);
1232
1233     /*
1234      * ok, we can now read from 's->packet' data into 'rr' rr->input points
1235      * at rr->length bytes, which need to be copied into rr->data by either
1236      * the decryption or by the decompression When the data is 'copied' into
1237      * the rr->data buffer, rr->input will be pointed at the new buffer
1238      */
1239
1240     /*
1241      * We now have - encrypted [ MAC [ compressed [ plain ] ] ] rr->length
1242      * bytes of encrypted compressed stuff.
1243      */
1244
1245     /* check is not needed I believe */
1246     if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH) {
1247         al = SSL_AD_RECORD_OVERFLOW;
1248         SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
1249         goto f_err;
1250     }
1251
1252     /* decrypt in place in 'rr->input' */
1253     rr->data = rr->input;
1254     rr->orig_len = rr->length;
1255
1256     enc_err = s->method->ssl3_enc->enc(s, 0);
1257     /*-
1258      * enc_err is:
1259      *    0: (in non-constant time) if the record is publically invalid.
1260      *    1: if the padding is valid
1261      *   -1: if the padding is invalid
1262      */
1263     if (enc_err == 0) {
1264         /* For DTLS we simply ignore bad packets. */
1265         rr->length = 0;
1266         RECORD_LAYER_reset_packet_length(&s->rlayer);
1267         goto err;
1268     }
1269 #ifdef SSL_DEBUG
1270     printf("dec %d\n", rr->length);
1271     {
1272         unsigned int z;
1273         for (z = 0; z < rr->length; z++)
1274             printf("%02X%c", rr->data[z], ((z + 1) % 16) ? ' ' : '\n');
1275     }
1276     printf("\n");
1277 #endif
1278
1279     /* r->length is now the compressed data plus mac */
1280     if ((sess != NULL) &&
1281         (s->enc_read_ctx != NULL) && (EVP_MD_CTX_md(s->read_hash) != NULL)) {
1282         /* s->read_hash != NULL => mac_size != -1 */
1283         unsigned char *mac = NULL;
1284         unsigned char mac_tmp[EVP_MAX_MD_SIZE];
1285         mac_size = EVP_MD_CTX_size(s->read_hash);
1286         OPENSSL_assert(mac_size <= EVP_MAX_MD_SIZE);
1287
1288         /*
1289          * orig_len is the length of the record before any padding was
1290          * removed. This is public information, as is the MAC in use,
1291          * therefore we can safely process the record in a different amount
1292          * of time if it's too short to possibly contain a MAC.
1293          */
1294         if (rr->orig_len < mac_size ||
1295             /* CBC records must have a padding length byte too. */
1296             (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
1297              rr->orig_len < mac_size + 1)) {
1298             al = SSL_AD_DECODE_ERROR;
1299             SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_LENGTH_TOO_SHORT);
1300             goto f_err;
1301         }
1302
1303         if (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE) {
1304             /*
1305              * We update the length so that the TLS header bytes can be
1306              * constructed correctly but we need to extract the MAC in
1307              * constant time from within the record, without leaking the
1308              * contents of the padding bytes.
1309              */
1310             mac = mac_tmp;
1311             ssl3_cbc_copy_mac(mac_tmp, rr, mac_size);
1312             rr->length -= mac_size;
1313         } else {
1314             /*
1315              * In this case there's no padding, so |rec->orig_len| equals
1316              * |rec->length| and we checked that there's enough bytes for
1317              * |mac_size| above.
1318              */
1319             rr->length -= mac_size;
1320             mac = &rr->data[rr->length];
1321         }
1322
1323         i = s->method->ssl3_enc->mac(s, md, 0 /* not send */ );
1324         if (i < 0 || mac == NULL
1325             || CRYPTO_memcmp(md, mac, (size_t)mac_size) != 0)
1326             enc_err = -1;
1327         if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH + mac_size)
1328             enc_err = -1;
1329     }
1330
1331     if (enc_err < 0) {
1332         /* decryption failed, silently discard message */
1333         rr->length = 0;
1334         RECORD_LAYER_reset_packet_length(&s->rlayer);
1335         goto err;
1336     }
1337
1338     /* r->length is now just compressed */
1339     if (s->expand != NULL) {
1340         if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH) {
1341             al = SSL_AD_RECORD_OVERFLOW;
1342             SSLerr(SSL_F_DTLS1_PROCESS_RECORD,
1343                    SSL_R_COMPRESSED_LENGTH_TOO_LONG);
1344             goto f_err;
1345         }
1346         if (!ssl3_do_uncompress(s)) {
1347             al = SSL_AD_DECOMPRESSION_FAILURE;
1348             SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_BAD_DECOMPRESSION);
1349             goto f_err;
1350         }
1351     }
1352
1353     if (rr->length > SSL3_RT_MAX_PLAIN_LENGTH) {
1354         al = SSL_AD_RECORD_OVERFLOW;
1355         SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_DATA_LENGTH_TOO_LONG);
1356         goto f_err;
1357     }
1358
1359     rr->off = 0;
1360     /*-
1361      * So at this point the following is true
1362      * ssl->s3->rrec.type   is the type of record
1363      * ssl->s3->rrec.length == number of bytes in record
1364      * ssl->s3->rrec.off    == offset to first valid byte
1365      * ssl->s3->rrec.data   == where to take bytes from, increment
1366      *                         after use :-).
1367      */
1368
1369     /* we have pulled in a full packet so zero things */
1370     RECORD_LAYER_reset_packet_length(&s->rlayer);
1371     return (1);
1372
1373  f_err:
1374     ssl3_send_alert(s, SSL3_AL_FATAL, al);
1375  err:
1376     return (0);
1377 }
1378
1379
1380 /*
1381  * retrieve a buffered record that belongs to the current epoch, ie,
1382  * processed
1383  */
1384 #define dtls1_get_processed_record(s) \
1385                    dtls1_retrieve_buffered_record((s), \
1386                    &(DTLS_RECORD_LAYER_get_processed_rcds(&s->rlayer)))
1387
1388 /*-
1389  * Call this to get a new input record.
1390  * It will return <= 0 if more data is needed, normally due to an error
1391  * or non-blocking IO.
1392  * When it finishes, one packet has been decoded and can be found in
1393  * ssl->s3->rrec.type    - is the type of record
1394  * ssl->s3->rrec.data,   - data
1395  * ssl->s3->rrec.length, - number of bytes
1396  */
1397 /* used only by dtls1_read_bytes */
1398 int dtls1_get_record(SSL *s)
1399 {
1400     int ssl_major, ssl_minor;
1401     int i, n;
1402     SSL3_RECORD *rr;
1403     unsigned char *p = NULL;
1404     unsigned short version;
1405     DTLS1_BITMAP *bitmap;
1406     unsigned int is_next_epoch;
1407
1408     rr = RECORD_LAYER_get_rrec(&s->rlayer);
1409
1410     /*
1411      * The epoch may have changed.  If so, process all the pending records.
1412      * This is a non-blocking operation.
1413      */
1414     if (dtls1_process_buffered_records(s) < 0)
1415         return -1;
1416
1417     /* if we're renegotiating, then there may be buffered records */
1418     if (dtls1_get_processed_record(s))
1419         return 1;
1420
1421     /* get something from the wire */
1422  again:
1423     /* check if we have the header */
1424     if ((RECORD_LAYER_get_rstate(&s->rlayer) != SSL_ST_READ_BODY) ||
1425         (RECORD_LAYER_get_packet_length(&s->rlayer) < DTLS1_RT_HEADER_LENGTH)) {
1426         n = ssl3_read_n(s, DTLS1_RT_HEADER_LENGTH,
1427             SSL3_BUFFER_get_len(&s->rlayer.rbuf), 0);
1428         /* read timeout is handled by dtls1_read_bytes */
1429         if (n <= 0)
1430             return (n);         /* error or non-blocking */
1431
1432         /* this packet contained a partial record, dump it */
1433         if (RECORD_LAYER_get_packet_length(&s->rlayer) != DTLS1_RT_HEADER_LENGTH) {
1434             RECORD_LAYER_reset_packet_length(&s->rlayer);
1435             goto again;
1436         }
1437
1438         RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_BODY);
1439
1440         p = RECORD_LAYER_get_packet(&s->rlayer);
1441
1442         if (s->msg_callback)
1443             s->msg_callback(0, 0, SSL3_RT_HEADER, p, DTLS1_RT_HEADER_LENGTH,
1444                             s, s->msg_callback_arg);
1445
1446         /* Pull apart the header into the DTLS1_RECORD */
1447         rr->type = *(p++);
1448         ssl_major = *(p++);
1449         ssl_minor = *(p++);
1450         version = (ssl_major << 8) | ssl_minor;
1451
1452         /* sequence number is 64 bits, with top 2 bytes = epoch */
1453         n2s(p, rr->epoch);
1454
1455         memcpy(&(RECORD_LAYER_get_read_sequence(&s->rlayer)[2]), p, 6);
1456         p += 6;
1457
1458         n2s(p, rr->length);
1459
1460         /* Lets check version */
1461         if (!s->first_packet) {
1462             if (version != s->version) {
1463                 /* unexpected version, silently discard */
1464                 rr->length = 0;
1465                 RECORD_LAYER_reset_packet_length(&s->rlayer);
1466                 goto again;
1467             }
1468         }
1469
1470         if ((version & 0xff00) != (s->version & 0xff00)) {
1471             /* wrong version, silently discard record */
1472             rr->length = 0;
1473             RECORD_LAYER_reset_packet_length(&s->rlayer);
1474             goto again;
1475         }
1476
1477         if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH) {
1478             /* record too long, silently discard it */
1479             rr->length = 0;
1480             RECORD_LAYER_reset_packet_length(&s->rlayer);
1481             goto again;
1482         }
1483
1484         /* now s->rlayer.rstate == SSL_ST_READ_BODY */
1485     }
1486
1487     /* s->rlayer.rstate == SSL_ST_READ_BODY, get and decode the data */
1488
1489     if (rr->length >
1490         RECORD_LAYER_get_packet_length(&s->rlayer) - DTLS1_RT_HEADER_LENGTH) {
1491         /* now s->packet_length == DTLS1_RT_HEADER_LENGTH */
1492         i = rr->length;
1493         n = ssl3_read_n(s, i, i, 1);
1494         /* this packet contained a partial record, dump it */
1495         if (n != i) {
1496             rr->length = 0;
1497             RECORD_LAYER_reset_packet_length(&s->rlayer);
1498             goto again;
1499         }
1500
1501         /*
1502          * now n == rr->length, and s->packet_length ==
1503          * DTLS1_RT_HEADER_LENGTH + rr->length
1504          */
1505     }
1506     /* set state for later operations */
1507     RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_HEADER);
1508
1509     /* match epochs.  NULL means the packet is dropped on the floor */
1510     bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
1511     if (bitmap == NULL) {
1512         rr->length = 0;
1513         RECORD_LAYER_reset_packet_length(&s->rlayer);   /* dump this record */
1514         goto again;             /* get another record */
1515     }
1516 #ifndef OPENSSL_NO_SCTP
1517     /* Only do replay check if no SCTP bio */
1518     if (!BIO_dgram_is_sctp(SSL_get_rbio(s))) {
1519 #endif
1520         /* Check whether this is a repeat, or aged record. */
1521         if (!dtls1_record_replay_check(s, bitmap)) {
1522             rr->length = 0;
1523             RECORD_LAYER_reset_packet_length(&s->rlayer); /* dump this record */
1524             goto again;         /* get another record */
1525         }
1526 #ifndef OPENSSL_NO_SCTP
1527     }
1528 #endif
1529
1530     /* just read a 0 length packet */
1531     if (rr->length == 0)
1532         goto again;
1533
1534     /*
1535      * If this record is from the next epoch (either HM or ALERT), and a
1536      * handshake is currently in progress, buffer it since it cannot be
1537      * processed at this time.
1538      */
1539     if (is_next_epoch) {
1540         if ((SSL_in_init(s) || ossl_statem_get_in_handshake(s))) {
1541             if (dtls1_buffer_record
1542                 (s, &(DTLS_RECORD_LAYER_get_unprocessed_rcds(&s->rlayer)),
1543                 rr->seq_num) < 0)
1544                 return -1;
1545             /* Mark receipt of record. */
1546             dtls1_record_bitmap_update(s, bitmap);
1547         }
1548         rr->length = 0;
1549         RECORD_LAYER_reset_packet_length(&s->rlayer);
1550         goto again;
1551     }
1552
1553     if (!dtls1_process_record(s)) {
1554         rr->length = 0;
1555         RECORD_LAYER_reset_packet_length(&s->rlayer);   /* dump this record */
1556         goto again;             /* get another record */
1557     }
1558     dtls1_record_bitmap_update(s, bitmap); /* Mark receipt of record. */
1559
1560     return (1);
1561
1562 }