appveyor.yml: streamline pull requests.
[openssl.git] / ssl / record / ssl3_record.c
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <assert.h>
11 #include "../ssl_locl.h"
12 #include "internal/constant_time_locl.h"
13 #include <openssl/rand.h>
14 #include "record_locl.h"
15
16 static const unsigned char ssl3_pad_1[48] = {
17     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
18     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
19     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
20     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
21     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36,
22     0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36, 0x36
23 };
24
25 static const unsigned char ssl3_pad_2[48] = {
26     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
27     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
28     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
29     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
30     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c,
31     0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c, 0x5c
32 };
33
34 /*
35  * Clear the contents of an SSL3_RECORD but retain any memory allocated
36  */
37 void SSL3_RECORD_clear(SSL3_RECORD *r, size_t num_recs)
38 {
39     unsigned char *comp;
40     size_t i;
41
42     for (i = 0; i < num_recs; i++) {
43         comp = r[i].comp;
44
45         memset(&r[i], 0, sizeof(*r));
46         r[i].comp = comp;
47     }
48 }
49
50 void SSL3_RECORD_release(SSL3_RECORD *r, size_t num_recs)
51 {
52     size_t i;
53
54     for (i = 0; i < num_recs; i++) {
55         OPENSSL_free(r[i].comp);
56         r[i].comp = NULL;
57     }
58 }
59
60 void SSL3_RECORD_set_seq_num(SSL3_RECORD *r, const unsigned char *seq_num)
61 {
62     memcpy(r->seq_num, seq_num, SEQ_NUM_SIZE);
63 }
64
65 /*
66  * Peeks ahead into "read_ahead" data to see if we have a whole record waiting
67  * for us in the buffer.
68  */
69 static int ssl3_record_app_data_waiting(SSL *s)
70 {
71     SSL3_BUFFER *rbuf;
72     size_t left, len;
73     unsigned char *p;
74
75     rbuf = RECORD_LAYER_get_rbuf(&s->rlayer);
76
77     p = SSL3_BUFFER_get_buf(rbuf);
78     if (p == NULL)
79         return 0;
80
81     left = SSL3_BUFFER_get_left(rbuf);
82
83     if (left < SSL3_RT_HEADER_LENGTH)
84         return 0;
85
86     p += SSL3_BUFFER_get_offset(rbuf);
87
88     /*
89      * We only check the type and record length, we will sanity check version
90      * etc later
91      */
92     if (*p != SSL3_RT_APPLICATION_DATA)
93         return 0;
94
95     p += 3;
96     n2s(p, len);
97
98     if (left < SSL3_RT_HEADER_LENGTH + len)
99         return 0;
100
101     return 1;
102 }
103
104 /*
105  * MAX_EMPTY_RECORDS defines the number of consecutive, empty records that
106  * will be processed per call to ssl3_get_record. Without this limit an
107  * attacker could send empty records at a faster rate than we can process and
108  * cause ssl3_get_record to loop forever.
109  */
110 #define MAX_EMPTY_RECORDS 32
111
112 #define SSL2_RT_HEADER_LENGTH   2
113 /*-
114  * Call this to get new input records.
115  * It will return <= 0 if more data is needed, normally due to an error
116  * or non-blocking IO.
117  * When it finishes, |numrpipes| records have been decoded. For each record 'i':
118  * rr[i].type    - is the type of record
119  * rr[i].data,   - data
120  * rr[i].length, - number of bytes
121  * Multiple records will only be returned if the record types are all
122  * SSL3_RT_APPLICATION_DATA. The number of records returned will always be <=
123  * |max_pipelines|
124  */
125 /* used only by ssl3_read_bytes */
126 int ssl3_get_record(SSL *s)
127 {
128     int al;
129     int enc_err, rret, ret = -1;
130     int i;
131     size_t more, n;
132     SSL3_RECORD *rr, *thisrr;
133     SSL3_BUFFER *rbuf;
134     SSL_SESSION *sess;
135     unsigned char *p;
136     unsigned char md[EVP_MAX_MD_SIZE];
137     unsigned int version;
138     size_t mac_size;
139     int imac_size;
140     size_t num_recs = 0, max_recs, j;
141     PACKET pkt, sslv2pkt;
142
143     rr = RECORD_LAYER_get_rrec(&s->rlayer);
144     rbuf = RECORD_LAYER_get_rbuf(&s->rlayer);
145     max_recs = s->max_pipelines;
146     if (max_recs == 0)
147         max_recs = 1;
148     sess = s->session;
149
150     do {
151         thisrr = &rr[num_recs];
152
153         /* check if we have the header */
154         if ((RECORD_LAYER_get_rstate(&s->rlayer) != SSL_ST_READ_BODY) ||
155             (RECORD_LAYER_get_packet_length(&s->rlayer)
156              < SSL3_RT_HEADER_LENGTH)) {
157             size_t sslv2len;
158             unsigned int type;
159
160             rret = ssl3_read_n(s, SSL3_RT_HEADER_LENGTH,
161                                SSL3_BUFFER_get_len(rbuf), 0,
162                                num_recs == 0 ? 1 : 0, &n);
163             if (rret <= 0)
164                 return rret;     /* error or non-blocking */
165             RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_BODY);
166
167             p = RECORD_LAYER_get_packet(&s->rlayer);
168             if (!PACKET_buf_init(&pkt, RECORD_LAYER_get_packet(&s->rlayer),
169                                  RECORD_LAYER_get_packet_length(&s->rlayer))) {
170                 al = SSL_AD_INTERNAL_ERROR;
171                 SSLerr(SSL_F_SSL3_GET_RECORD, ERR_R_INTERNAL_ERROR);
172                 goto f_err;
173             }
174             sslv2pkt = pkt;
175             if (!PACKET_get_net_2_len(&sslv2pkt, &sslv2len)
176                     || !PACKET_get_1(&sslv2pkt, &type)) {
177                 al = SSL_AD_INTERNAL_ERROR;
178                 SSLerr(SSL_F_SSL3_GET_RECORD, ERR_R_INTERNAL_ERROR);
179                 goto f_err;
180             }
181             /*
182              * The first record received by the server may be a V2ClientHello.
183              */
184             if (s->server && RECORD_LAYER_is_first_record(&s->rlayer)
185                     && (sslv2len & 0x8000) != 0
186                     && (type == SSL2_MT_CLIENT_HELLO)) {
187                 /*
188                  *  SSLv2 style record
189                  *
190                  * |num_recs| here will actually always be 0 because
191                  * |num_recs > 0| only ever occurs when we are processing
192                  * multiple app data records - which we know isn't the case here
193                  * because it is an SSLv2ClientHello. We keep it using
194                  * |num_recs| for the sake of consistency
195                  */
196                 thisrr->type = SSL3_RT_HANDSHAKE;
197                 thisrr->rec_version = SSL2_VERSION;
198
199                 thisrr->length = sslv2len & 0x7fff;
200
201                 if (thisrr->length > SSL3_BUFFER_get_len(rbuf)
202                     - SSL2_RT_HEADER_LENGTH) {
203                     al = SSL_AD_RECORD_OVERFLOW;
204                     SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_PACKET_LENGTH_TOO_LONG);
205                     goto f_err;
206                 }
207
208                 if (thisrr->length < MIN_SSL2_RECORD_LEN) {
209                     al = SSL_AD_HANDSHAKE_FAILURE;
210                     SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_LENGTH_TOO_SHORT);
211                     goto f_err;
212                 }
213             } else {
214                 /* SSLv3+ style record */
215                 /*
216                  * TODO(TLS1.3): This callback only provides the "outer" record
217                  * type to the callback. Somehow we need to pass the "inner"
218                  * record type
219                  */
220                 if (s->msg_callback)
221                     s->msg_callback(0, 0, SSL3_RT_HEADER, p, 5, s,
222                                     s->msg_callback_arg);
223
224                 /* Pull apart the header into the SSL3_RECORD */
225                 if (!PACKET_get_1(&pkt, &type)
226                         || !PACKET_get_net_2(&pkt, &version)
227                         || !PACKET_get_net_2_len(&pkt, &thisrr->length)) {
228                     al = SSL_AD_INTERNAL_ERROR;
229                     SSLerr(SSL_F_SSL3_GET_RECORD, ERR_R_INTERNAL_ERROR);
230                     goto f_err;
231                 }
232                 thisrr->type = type;
233                 thisrr->rec_version = version;
234
235                 /* Lets check version. In TLSv1.3 we ignore this field */
236                 if (!s->first_packet && !SSL_IS_TLS13(s)
237                         && version != (unsigned int)s->version) {
238                     SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_WRONG_VERSION_NUMBER);
239                     if ((s->version & 0xFF00) == (version & 0xFF00)
240                         && !s->enc_write_ctx && !s->write_hash) {
241                         if (thisrr->type == SSL3_RT_ALERT) {
242                             /*
243                              * The record is using an incorrect version number,
244                              * but what we've got appears to be an alert. We
245                              * haven't read the body yet to check whether its a
246                              * fatal or not - but chances are it is. We probably
247                              * shouldn't send a fatal alert back. We'll just
248                              * end.
249                              */
250                             goto err;
251                         }
252                         /*
253                          * Send back error using their minor version number :-)
254                          */
255                         s->version = (unsigned short)version;
256                     }
257                     al = SSL_AD_PROTOCOL_VERSION;
258                     goto f_err;
259                 }
260
261                 if ((version >> 8) != SSL3_VERSION_MAJOR) {
262                     if (RECORD_LAYER_is_first_record(&s->rlayer)) {
263                         /* Go back to start of packet, look at the five bytes
264                          * that we have. */
265                         p = RECORD_LAYER_get_packet(&s->rlayer);
266                         if (strncmp((char *)p, "GET ", 4) == 0 ||
267                             strncmp((char *)p, "POST ", 5) == 0 ||
268                             strncmp((char *)p, "HEAD ", 5) == 0 ||
269                             strncmp((char *)p, "PUT ", 4) == 0) {
270                             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_HTTP_REQUEST);
271                             goto err;
272                         } else if (strncmp((char *)p, "CONNE", 5) == 0) {
273                             SSLerr(SSL_F_SSL3_GET_RECORD,
274                                    SSL_R_HTTPS_PROXY_REQUEST);
275                             goto err;
276                         }
277
278                         /* Doesn't look like TLS - don't send an alert */
279                         SSLerr(SSL_F_SSL3_GET_RECORD,
280                                SSL_R_WRONG_VERSION_NUMBER);
281                         goto err;
282                     } else {
283                         SSLerr(SSL_F_SSL3_GET_RECORD,
284                                SSL_R_WRONG_VERSION_NUMBER);
285                         al = SSL_AD_PROTOCOL_VERSION;
286                         goto f_err;
287                     }
288                 }
289
290                 if (SSL_IS_TLS13(s) && s->enc_read_ctx != NULL
291                         && thisrr->type != SSL3_RT_APPLICATION_DATA) {
292                     SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BAD_RECORD_TYPE);
293                     al = SSL_AD_UNEXPECTED_MESSAGE;
294                     goto f_err;
295                 }
296
297                 if (thisrr->length >
298                     SSL3_BUFFER_get_len(rbuf) - 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
311          * record
312          */
313         if (thisrr->rec_version == SSL2_VERSION) {
314             more = thisrr->length + SSL2_RT_HEADER_LENGTH
315                 - SSL3_RT_HEADER_LENGTH;
316         } else {
317             more = thisrr->length;
318         }
319         if (more > 0) {
320             /* now s->packet_length == SSL3_RT_HEADER_LENGTH */
321
322             rret = ssl3_read_n(s, more, more, 1, 0, &n);
323             if (rret <= 0)
324                 return rret;     /* error or non-blocking io */
325         }
326
327         /* set state for later operations */
328         RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_HEADER);
329
330         /*
331          * At this point, s->packet_length == SSL3_RT_HEADER_LENGTH
332          * + thisrr->length, or s->packet_length == SSL2_RT_HEADER_LENGTH
333          * + thisrr->length and we have that many bytes in s->packet
334          */
335         if (thisrr->rec_version == SSL2_VERSION) {
336             thisrr->input =
337                 &(RECORD_LAYER_get_packet(&s->rlayer)[SSL2_RT_HEADER_LENGTH]);
338         } else {
339             thisrr->input =
340                 &(RECORD_LAYER_get_packet(&s->rlayer)[SSL3_RT_HEADER_LENGTH]);
341         }
342
343         /*
344          * ok, we can now read from 's->packet' data into 'thisrr' thisrr->input
345          * points at thisrr->length bytes, which need to be copied into
346          * thisrr->data by either the decryption or by the decompression When
347          * the data is 'copied' into the thisrr->data buffer, thisrr->input will
348          * be pointed at the new buffer
349          */
350
351         /*
352          * We now have - encrypted [ MAC [ compressed [ plain ] ] ]
353          * thisrr->length bytes of encrypted compressed stuff.
354          */
355
356         /* check is not needed I believe */
357         if (thisrr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH) {
358             al = SSL_AD_RECORD_OVERFLOW;
359             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
360             goto f_err;
361         }
362
363         /* decrypt in place in 'thisrr->input' */
364         thisrr->data = thisrr->input;
365         thisrr->orig_len = thisrr->length;
366
367         /* Mark this record as not read by upper layers yet */
368         thisrr->read = 0;
369
370         num_recs++;
371
372         /* we have pulled in a full packet so zero things */
373         RECORD_LAYER_reset_packet_length(&s->rlayer);
374         RECORD_LAYER_clear_first_record(&s->rlayer);
375     } while (num_recs < max_recs
376              && thisrr->type == SSL3_RT_APPLICATION_DATA
377              && SSL_USE_EXPLICIT_IV(s)
378              && s->enc_read_ctx != NULL
379              && (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s->enc_read_ctx))
380                  & EVP_CIPH_FLAG_PIPELINE)
381              && ssl3_record_app_data_waiting(s));
382
383     /*
384      * If in encrypt-then-mac mode calculate mac from encrypted record. All
385      * the details below are public so no timing details can leak.
386      */
387     if (SSL_READ_ETM(s) && s->read_hash) {
388         unsigned char *mac;
389         /* TODO(size_t): convert this to do size_t properly */
390         imac_size = EVP_MD_CTX_size(s->read_hash);
391         assert(imac_size >= 0 && imac_size <= EVP_MAX_MD_SIZE);
392         if (imac_size < 0 || imac_size > EVP_MAX_MD_SIZE) {
393                 al = SSL_AD_INTERNAL_ERROR;
394                 SSLerr(SSL_F_SSL3_GET_RECORD, ERR_LIB_EVP);
395                 goto f_err;
396         }
397         mac_size = (size_t)imac_size;
398         for (j = 0; j < num_recs; j++) {
399             thisrr = &rr[j];
400
401             if (thisrr->length < mac_size) {
402                 al = SSL_AD_DECODE_ERROR;
403                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_LENGTH_TOO_SHORT);
404                 goto f_err;
405             }
406             thisrr->length -= mac_size;
407             mac = thisrr->data + thisrr->length;
408             i = s->method->ssl3_enc->mac(s, thisrr, md, 0 /* not send */ );
409             if (i == 0 || CRYPTO_memcmp(md, mac, mac_size) != 0) {
410                 al = SSL_AD_BAD_RECORD_MAC;
411                 SSLerr(SSL_F_SSL3_GET_RECORD,
412                        SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
413                 goto f_err;
414             }
415         }
416     }
417
418     enc_err = s->method->ssl3_enc->enc(s, rr, num_recs, 0);
419
420     /*-
421      * enc_err is:
422      *    0: (in non-constant time) if the record is publically invalid.
423      *    1: if the padding is valid
424      *    -1: if the padding is invalid
425      */
426     if (enc_err == 0) {
427         al = SSL_AD_DECRYPTION_FAILED;
428         SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BLOCK_CIPHER_PAD_IS_WRONG);
429         goto f_err;
430     }
431 #ifdef SSL_DEBUG
432     printf("dec %"OSSLzu"\n", rr[0].length);
433     {
434         size_t z;
435         for (z = 0; z < rr[0].length; z++)
436             printf("%02X%c", rr[0].data[z], ((z + 1) % 16) ? ' ' : '\n');
437     }
438     printf("\n");
439 #endif
440
441     /* r->length is now the compressed data plus mac */
442     if ((sess != NULL) &&
443         (s->enc_read_ctx != NULL) &&
444         (!SSL_READ_ETM(s) && EVP_MD_CTX_md(s->read_hash) != NULL)) {
445         /* s->read_hash != NULL => mac_size != -1 */
446         unsigned char *mac = NULL;
447         unsigned char mac_tmp[EVP_MAX_MD_SIZE];
448
449         mac_size = EVP_MD_CTX_size(s->read_hash);
450         OPENSSL_assert(mac_size <= EVP_MAX_MD_SIZE);
451
452         for (j = 0; j < num_recs; j++) {
453             thisrr = &rr[j];
454             /*
455              * orig_len is the length of the record before any padding was
456              * removed. This is public information, as is the MAC in use,
457              * therefore we can safely process the record in a different amount
458              * of time if it's too short to possibly contain a MAC.
459              */
460             if (thisrr->orig_len < mac_size ||
461                 /* CBC records must have a padding length byte too. */
462                 (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
463                  thisrr->orig_len < mac_size + 1)) {
464                 al = SSL_AD_DECODE_ERROR;
465                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_LENGTH_TOO_SHORT);
466                 goto f_err;
467             }
468
469             if (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE) {
470                 /*
471                  * We update the length so that the TLS header bytes can be
472                  * constructed correctly but we need to extract the MAC in
473                  * constant time from within the record, without leaking the
474                  * contents of the padding bytes.
475                  */
476                 mac = mac_tmp;
477                 ssl3_cbc_copy_mac(mac_tmp, thisrr, mac_size);
478                 thisrr->length -= mac_size;
479             } else {
480                 /*
481                  * In this case there's no padding, so |rec->orig_len| equals
482                  * |rec->length| and we checked that there's enough bytes for
483                  * |mac_size| above.
484                  */
485                 thisrr->length -= mac_size;
486                 mac = &thisrr->data[thisrr->length];
487             }
488
489             i = s->method->ssl3_enc->mac(s, thisrr, md, 0 /* not send */ );
490             if (i == 0 || mac == NULL
491                 || CRYPTO_memcmp(md, mac, (size_t)mac_size) != 0)
492                 enc_err = -1;
493             if (thisrr->length > SSL3_RT_MAX_COMPRESSED_LENGTH + mac_size)
494                 enc_err = -1;
495         }
496     }
497
498     if (enc_err < 0) {
499         /*
500          * A separate 'decryption_failed' alert was introduced with TLS 1.0,
501          * SSL 3.0 only has 'bad_record_mac'.  But unless a decryption
502          * failure is directly visible from the ciphertext anyway, we should
503          * not reveal which kind of error occurred -- this might become
504          * visible to an attacker (e.g. via a logfile)
505          */
506         al = SSL_AD_BAD_RECORD_MAC;
507         SSLerr(SSL_F_SSL3_GET_RECORD,
508                SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
509         goto f_err;
510     }
511
512     for (j = 0; j < num_recs; j++) {
513         thisrr = &rr[j];
514
515         /* thisrr->length is now just compressed */
516         if (s->expand != NULL) {
517             if (thisrr->length > SSL3_RT_MAX_COMPRESSED_LENGTH) {
518                 al = SSL_AD_RECORD_OVERFLOW;
519                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_COMPRESSED_LENGTH_TOO_LONG);
520                 goto f_err;
521             }
522             if (!ssl3_do_uncompress(s, thisrr)) {
523                 al = SSL_AD_DECOMPRESSION_FAILURE;
524                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BAD_DECOMPRESSION);
525                 goto f_err;
526             }
527         }
528
529         if (SSL_IS_TLS13(s) && s->enc_read_ctx != NULL) {
530             size_t end;
531
532             if (thisrr->length == 0) {
533                 al = SSL_AD_UNEXPECTED_MESSAGE;
534                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BAD_RECORD_TYPE);
535                 goto f_err;
536             }
537
538             /* Strip trailing padding */
539             for (end = thisrr->length - 1; end > 0 && thisrr->data[end] == 0;
540                  end--)
541                 continue;
542
543             thisrr->length = end;
544             thisrr->type = thisrr->data[end];
545             if (thisrr->type != SSL3_RT_APPLICATION_DATA
546                     && thisrr->type != SSL3_RT_ALERT
547                     && thisrr->type != SSL3_RT_HANDSHAKE) {
548                 al = SSL_AD_UNEXPECTED_MESSAGE;
549                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_BAD_RECORD_TYPE);
550                 goto f_err;
551             }
552         }
553
554         if (thisrr->length > SSL3_RT_MAX_PLAIN_LENGTH) {
555             al = SSL_AD_RECORD_OVERFLOW;
556             SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_DATA_LENGTH_TOO_LONG);
557             goto f_err;
558         }
559
560         thisrr->off = 0;
561         /*-
562          * So at this point the following is true
563          * thisrr->type   is the type of record
564          * thisrr->length == number of bytes in record
565          * thisrr->off    == offset to first valid byte
566          * thisrr->data   == where to take bytes from, increment after use :-).
567          */
568
569         /* just read a 0 length packet */
570         if (thisrr->length == 0) {
571             RECORD_LAYER_inc_empty_record_count(&s->rlayer);
572             if (RECORD_LAYER_get_empty_record_count(&s->rlayer)
573                 > MAX_EMPTY_RECORDS) {
574                 al = SSL_AD_UNEXPECTED_MESSAGE;
575                 SSLerr(SSL_F_SSL3_GET_RECORD, SSL_R_RECORD_TOO_SMALL);
576                 goto f_err;
577             }
578         } else {
579             RECORD_LAYER_reset_empty_record_count(&s->rlayer);
580         }
581     }
582
583     RECORD_LAYER_set_numrpipes(&s->rlayer, num_recs);
584     return 1;
585
586  f_err:
587     ssl3_send_alert(s, SSL3_AL_FATAL, al);
588  err:
589     return ret;
590 }
591
592 int ssl3_do_uncompress(SSL *ssl, SSL3_RECORD *rr)
593 {
594 #ifndef OPENSSL_NO_COMP
595     int i;
596
597     if (rr->comp == NULL) {
598         rr->comp = (unsigned char *)
599             OPENSSL_malloc(SSL3_RT_MAX_ENCRYPTED_LENGTH);
600     }
601     if (rr->comp == NULL)
602         return 0;
603
604     /* TODO(size_t): Convert this call */
605     i = COMP_expand_block(ssl->expand, rr->comp,
606                           SSL3_RT_MAX_PLAIN_LENGTH, rr->data, (int)rr->length);
607     if (i < 0)
608         return 0;
609     else
610         rr->length = i;
611     rr->data = rr->comp;
612 #endif
613     return 1;
614 }
615
616 int ssl3_do_compress(SSL *ssl, SSL3_RECORD *wr)
617 {
618 #ifndef OPENSSL_NO_COMP
619     int i;
620
621     /* TODO(size_t): Convert this call */
622     i = COMP_compress_block(ssl->compress, wr->data,
623                             (int)(wr->length + SSL3_RT_MAX_COMPRESSED_OVERHEAD),
624                             wr->input, (int)wr->length);
625     if (i < 0)
626         return (0);
627     else
628         wr->length = i;
629
630     wr->input = wr->data;
631 #endif
632     return (1);
633 }
634
635 /*-
636  * ssl3_enc encrypts/decrypts |n_recs| records in |inrecs|
637  *
638  * Returns:
639  *   0: (in non-constant time) if the record is publically invalid (i.e. too
640  *       short etc).
641  *   1: if the record's padding is valid / the encryption was successful.
642  *   -1: if the record's padding is invalid or, if sending, an internal error
643  *       occurred.
644  */
645 int ssl3_enc(SSL *s, SSL3_RECORD *inrecs, size_t n_recs, int send)
646 {
647     SSL3_RECORD *rec;
648     EVP_CIPHER_CTX *ds;
649     size_t l, i;
650     size_t bs, mac_size = 0;
651     int imac_size;
652     const EVP_CIPHER *enc;
653
654     rec = inrecs;
655     /*
656      * We shouldn't ever be called with more than one record in the SSLv3 case
657      */
658     if (n_recs != 1)
659         return 0;
660     if (send) {
661         ds = s->enc_write_ctx;
662         if (s->enc_write_ctx == NULL)
663             enc = NULL;
664         else
665             enc = EVP_CIPHER_CTX_cipher(s->enc_write_ctx);
666     } else {
667         ds = s->enc_read_ctx;
668         if (s->enc_read_ctx == NULL)
669             enc = NULL;
670         else
671             enc = EVP_CIPHER_CTX_cipher(s->enc_read_ctx);
672     }
673
674     if ((s->session == NULL) || (ds == NULL) || (enc == NULL)) {
675         memmove(rec->data, rec->input, rec->length);
676         rec->input = rec->data;
677     } else {
678         l = rec->length;
679         /* TODO(size_t): Convert this call */
680         bs = EVP_CIPHER_CTX_block_size(ds);
681
682         /* COMPRESS */
683
684         if ((bs != 1) && send) {
685             i = bs - (l % bs);
686
687             /* we need to add 'i-1' padding bytes */
688             l += i;
689             /*
690              * the last of these zero bytes will be overwritten with the
691              * padding length.
692              */
693             memset(&rec->input[rec->length], 0, i);
694             rec->length += i;
695             rec->input[l - 1] = (unsigned char)(i - 1);
696         }
697
698         if (!send) {
699             if (l == 0 || l % bs != 0)
700                 return 0;
701             /* otherwise, rec->length >= bs */
702         }
703
704         /* TODO(size_t): Convert this call */
705         if (EVP_Cipher(ds, rec->data, rec->input, (unsigned int)l) < 1)
706             return -1;
707
708         if (EVP_MD_CTX_md(s->read_hash) != NULL) {
709             /* TODO(size_t): convert me */
710             imac_size = EVP_MD_CTX_size(s->read_hash);
711             if (imac_size < 0)
712                 return -1;
713             mac_size = (size_t)imac_size;
714         }
715         if ((bs != 1) && !send)
716             return ssl3_cbc_remove_padding(rec, bs, mac_size);
717     }
718     return (1);
719 }
720
721 #define MAX_PADDING 256
722 /*-
723  * tls1_enc encrypts/decrypts |n_recs| in |recs|.
724  *
725  * Returns:
726  *   0: (in non-constant time) if the record is publically invalid (i.e. too
727  *       short etc).
728  *   1: if the record's padding is valid / the encryption was successful.
729  *   -1: if the record's padding/AEAD-authenticator is invalid or, if sending,
730  *       an internal error occurred.
731  */
732 int tls1_enc(SSL *s, SSL3_RECORD *recs, size_t n_recs, int send)
733 {
734     EVP_CIPHER_CTX *ds;
735     size_t reclen[SSL_MAX_PIPELINES];
736     unsigned char buf[SSL_MAX_PIPELINES][EVP_AEAD_TLS1_AAD_LEN];
737     int i, pad = 0, ret, tmpr;
738     size_t bs, mac_size = 0, ctr, padnum, loop;
739     unsigned char padval;
740     int imac_size;
741     const EVP_CIPHER *enc;
742
743     if (send) {
744         if (EVP_MD_CTX_md(s->write_hash)) {
745             int n = EVP_MD_CTX_size(s->write_hash);
746             OPENSSL_assert(n >= 0);
747         }
748         ds = s->enc_write_ctx;
749         if (s->enc_write_ctx == NULL)
750             enc = NULL;
751         else {
752             int ivlen;
753             enc = EVP_CIPHER_CTX_cipher(s->enc_write_ctx);
754             /* For TLSv1.1 and later explicit IV */
755             if (SSL_USE_EXPLICIT_IV(s)
756                 && EVP_CIPHER_mode(enc) == EVP_CIPH_CBC_MODE)
757                 ivlen = EVP_CIPHER_iv_length(enc);
758             else
759                 ivlen = 0;
760             if (ivlen > 1) {
761                 for (ctr = 0; ctr < n_recs; ctr++) {
762                     if (recs[ctr].data != recs[ctr].input) {
763                         /*
764                          * we can't write into the input stream: Can this ever
765                          * happen?? (steve)
766                          */
767                         SSLerr(SSL_F_TLS1_ENC, ERR_R_INTERNAL_ERROR);
768                         return -1;
769                     } else if (RAND_bytes(recs[ctr].input, ivlen) <= 0) {
770                         SSLerr(SSL_F_TLS1_ENC, ERR_R_INTERNAL_ERROR);
771                         return -1;
772                     }
773                 }
774             }
775         }
776     } else {
777         if (EVP_MD_CTX_md(s->read_hash)) {
778             int n = EVP_MD_CTX_size(s->read_hash);
779             OPENSSL_assert(n >= 0);
780         }
781         ds = s->enc_read_ctx;
782         if (s->enc_read_ctx == NULL)
783             enc = NULL;
784         else
785             enc = EVP_CIPHER_CTX_cipher(s->enc_read_ctx);
786     }
787
788     if ((s->session == NULL) || (ds == NULL) || (enc == NULL)) {
789         for (ctr = 0; ctr < n_recs; ctr++) {
790             memmove(recs[ctr].data, recs[ctr].input, recs[ctr].length);
791             recs[ctr].input = recs[ctr].data;
792         }
793         ret = 1;
794     } else {
795         bs = EVP_CIPHER_block_size(EVP_CIPHER_CTX_cipher(ds));
796
797         if (n_recs > 1) {
798             if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ds))
799                   & EVP_CIPH_FLAG_PIPELINE)) {
800                 /*
801                  * We shouldn't have been called with pipeline data if the
802                  * cipher doesn't support pipelining
803                  */
804                 SSLerr(SSL_F_TLS1_ENC, SSL_R_PIPELINE_FAILURE);
805                 return -1;
806             }
807         }
808         for (ctr = 0; ctr < n_recs; ctr++) {
809             reclen[ctr] = recs[ctr].length;
810
811             if (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ds))
812                 & EVP_CIPH_FLAG_AEAD_CIPHER) {
813                 unsigned char *seq;
814
815                 seq = send ? RECORD_LAYER_get_write_sequence(&s->rlayer)
816                     : RECORD_LAYER_get_read_sequence(&s->rlayer);
817
818                 if (SSL_IS_DTLS(s)) {
819                     /* DTLS does not support pipelining */
820                     unsigned char dtlsseq[9], *p = dtlsseq;
821
822                     s2n(send ? DTLS_RECORD_LAYER_get_w_epoch(&s->rlayer) :
823                         DTLS_RECORD_LAYER_get_r_epoch(&s->rlayer), p);
824                     memcpy(p, &seq[2], 6);
825                     memcpy(buf[ctr], dtlsseq, 8);
826                 } else {
827                     memcpy(buf[ctr], seq, 8);
828                     for (i = 7; i >= 0; i--) { /* increment */
829                         ++seq[i];
830                         if (seq[i] != 0)
831                             break;
832                     }
833                 }
834
835                 buf[ctr][8] = recs[ctr].type;
836                 buf[ctr][9] = (unsigned char)(s->version >> 8);
837                 buf[ctr][10] = (unsigned char)(s->version);
838                 buf[ctr][11] = (unsigned char)(recs[ctr].length >> 8);
839                 buf[ctr][12] = (unsigned char)(recs[ctr].length & 0xff);
840                 pad = EVP_CIPHER_CTX_ctrl(ds, EVP_CTRL_AEAD_TLS1_AAD,
841                                           EVP_AEAD_TLS1_AAD_LEN, buf[ctr]);
842                 if (pad <= 0)
843                     return -1;
844
845                 if (send) {
846                     reclen[ctr] += pad;
847                     recs[ctr].length += pad;
848                 }
849
850             } else if ((bs != 1) && send) {
851                 padnum = bs - (reclen[ctr] % bs);
852
853                 /* Add weird padding of upto 256 bytes */
854
855                 if (padnum > MAX_PADDING)
856                     return -1;
857                 /* we need to add 'padnum' padding bytes of value padval */
858                 padval = (unsigned char)(padnum - 1);
859                 for (loop = reclen[ctr]; loop < reclen[ctr] + padnum; loop++)
860                     recs[ctr].input[loop] = padval;
861                 reclen[ctr] += padnum;
862                 recs[ctr].length += padnum;
863             }
864
865             if (!send) {
866                 if (reclen[ctr] == 0 || reclen[ctr] % bs != 0)
867                     return 0;
868             }
869         }
870         if (n_recs > 1) {
871             unsigned char *data[SSL_MAX_PIPELINES];
872
873             /* Set the output buffers */
874             for (ctr = 0; ctr < n_recs; ctr++) {
875                 data[ctr] = recs[ctr].data;
876             }
877             if (EVP_CIPHER_CTX_ctrl(ds, EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS,
878                                     (int)n_recs, data) <= 0) {
879                 SSLerr(SSL_F_TLS1_ENC, SSL_R_PIPELINE_FAILURE);
880             }
881             /* Set the input buffers */
882             for (ctr = 0; ctr < n_recs; ctr++) {
883                 data[ctr] = recs[ctr].input;
884             }
885             if (EVP_CIPHER_CTX_ctrl(ds, EVP_CTRL_SET_PIPELINE_INPUT_BUFS,
886                                     (int)n_recs, data) <= 0
887                 || EVP_CIPHER_CTX_ctrl(ds, EVP_CTRL_SET_PIPELINE_INPUT_LENS,
888                                        (int)n_recs, reclen) <= 0) {
889                 SSLerr(SSL_F_TLS1_ENC, SSL_R_PIPELINE_FAILURE);
890                 return -1;
891             }
892         }
893
894         /* TODO(size_t): Convert this call */
895         tmpr = EVP_Cipher(ds, recs[0].data, recs[0].input,
896                           (unsigned int)reclen[0]);
897         if ((EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ds))
898              & EVP_CIPH_FLAG_CUSTOM_CIPHER)
899             ? (tmpr < 0)
900             : (tmpr == 0))
901             return -1;          /* AEAD can fail to verify MAC */
902         if (send == 0) {
903             if (EVP_CIPHER_mode(enc) == EVP_CIPH_GCM_MODE) {
904                 for (ctr = 0; ctr < n_recs; ctr++) {
905                     recs[ctr].data += EVP_GCM_TLS_EXPLICIT_IV_LEN;
906                     recs[ctr].input += EVP_GCM_TLS_EXPLICIT_IV_LEN;
907                     recs[ctr].length -= EVP_GCM_TLS_EXPLICIT_IV_LEN;
908                 }
909             } else if (EVP_CIPHER_mode(enc) == EVP_CIPH_CCM_MODE) {
910                 for (ctr = 0; ctr < n_recs; ctr++) {
911                     recs[ctr].data += EVP_CCM_TLS_EXPLICIT_IV_LEN;
912                     recs[ctr].input += EVP_CCM_TLS_EXPLICIT_IV_LEN;
913                     recs[ctr].length -= EVP_CCM_TLS_EXPLICIT_IV_LEN;
914                 }
915             }
916         }
917
918         ret = 1;
919         if (!SSL_READ_ETM(s) && EVP_MD_CTX_md(s->read_hash) != NULL) {
920             imac_size = EVP_MD_CTX_size(s->read_hash);
921             if (imac_size < 0)
922                 return -1;
923             mac_size = (size_t)imac_size;
924         }
925         if ((bs != 1) && !send) {
926             int tmpret;
927             for (ctr = 0; ctr < n_recs; ctr++) {
928                 tmpret = tls1_cbc_remove_padding(s, &recs[ctr], bs, mac_size);
929                 /*
930                  * If tmpret == 0 then this means publicly invalid so we can
931                  * short circuit things here. Otherwise we must respect constant
932                  * time behaviour.
933                  */
934                 if (tmpret == 0)
935                     return 0;
936                 ret = constant_time_select_int(constant_time_eq_int(tmpret, 1),
937                                                ret, -1);
938             }
939         }
940         if (pad && !send) {
941             for (ctr = 0; ctr < n_recs; ctr++) {
942                 recs[ctr].length -= pad;
943             }
944         }
945     }
946     return ret;
947 }
948
949 int n_ssl3_mac(SSL *ssl, SSL3_RECORD *rec, unsigned char *md, int send)
950 {
951     unsigned char *mac_sec, *seq;
952     const EVP_MD_CTX *hash;
953     unsigned char *p, rec_char;
954     size_t md_size;
955     size_t npad;
956     int t;
957
958     if (send) {
959         mac_sec = &(ssl->s3->write_mac_secret[0]);
960         seq = RECORD_LAYER_get_write_sequence(&ssl->rlayer);
961         hash = ssl->write_hash;
962     } else {
963         mac_sec = &(ssl->s3->read_mac_secret[0]);
964         seq = RECORD_LAYER_get_read_sequence(&ssl->rlayer);
965         hash = ssl->read_hash;
966     }
967
968     t = EVP_MD_CTX_size(hash);
969     if (t < 0)
970         return 0;
971     md_size = t;
972     npad = (48 / md_size) * md_size;
973
974     if (!send &&
975         EVP_CIPHER_CTX_mode(ssl->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
976         ssl3_cbc_record_digest_supported(hash)) {
977         /*
978          * This is a CBC-encrypted record. We must avoid leaking any
979          * timing-side channel information about how many blocks of data we
980          * are hashing because that gives an attacker a timing-oracle.
981          */
982
983         /*-
984          * npad is, at most, 48 bytes and that's with MD5:
985          *   16 + 48 + 8 (sequence bytes) + 1 + 2 = 75.
986          *
987          * With SHA-1 (the largest hash speced for SSLv3) the hash size
988          * goes up 4, but npad goes down by 8, resulting in a smaller
989          * total size.
990          */
991         unsigned char header[75];
992         size_t j = 0;
993         memcpy(header + j, mac_sec, md_size);
994         j += md_size;
995         memcpy(header + j, ssl3_pad_1, npad);
996         j += npad;
997         memcpy(header + j, seq, 8);
998         j += 8;
999         header[j++] = rec->type;
1000         header[j++] = (unsigned char)(rec->length >> 8);
1001         header[j++] = (unsigned char)(rec->length & 0xff);
1002
1003         /* Final param == is SSLv3 */
1004         if (ssl3_cbc_digest_record(hash,
1005                                    md, &md_size,
1006                                    header, rec->input,
1007                                    rec->length + md_size, rec->orig_len,
1008                                    mac_sec, md_size, 1) <= 0)
1009             return 0;
1010     } else {
1011         unsigned int md_size_u;
1012         /* Chop the digest off the end :-) */
1013         EVP_MD_CTX *md_ctx = EVP_MD_CTX_new();
1014
1015         if (md_ctx == NULL)
1016             return 0;
1017
1018         rec_char = rec->type;
1019         p = md;
1020         s2n(rec->length, p);
1021         if (EVP_MD_CTX_copy_ex(md_ctx, hash) <= 0
1022             || EVP_DigestUpdate(md_ctx, mac_sec, md_size) <= 0
1023             || EVP_DigestUpdate(md_ctx, ssl3_pad_1, npad) <= 0
1024             || EVP_DigestUpdate(md_ctx, seq, 8) <= 0
1025             || EVP_DigestUpdate(md_ctx, &rec_char, 1) <= 0
1026             || EVP_DigestUpdate(md_ctx, md, 2) <= 0
1027             || EVP_DigestUpdate(md_ctx, rec->input, rec->length) <= 0
1028             || EVP_DigestFinal_ex(md_ctx, md, NULL) <= 0
1029             || EVP_MD_CTX_copy_ex(md_ctx, hash) <= 0
1030             || EVP_DigestUpdate(md_ctx, mac_sec, md_size) <= 0
1031             || EVP_DigestUpdate(md_ctx, ssl3_pad_2, npad) <= 0
1032             || EVP_DigestUpdate(md_ctx, md, md_size) <= 0
1033             || EVP_DigestFinal_ex(md_ctx, md, &md_size_u) <= 0) {
1034             EVP_MD_CTX_reset(md_ctx);
1035             return 0;
1036         }
1037
1038         EVP_MD_CTX_free(md_ctx);
1039     }
1040
1041     ssl3_record_sequence_update(seq);
1042     return 1;
1043 }
1044
1045 int tls1_mac(SSL *ssl, SSL3_RECORD *rec, unsigned char *md, int send)
1046 {
1047     unsigned char *seq;
1048     EVP_MD_CTX *hash;
1049     size_t md_size;
1050     int i;
1051     EVP_MD_CTX *hmac = NULL, *mac_ctx;
1052     unsigned char header[13];
1053     int stream_mac = (send ? (ssl->mac_flags & SSL_MAC_FLAG_WRITE_MAC_STREAM)
1054                       : (ssl->mac_flags & SSL_MAC_FLAG_READ_MAC_STREAM));
1055     int t;
1056
1057     if (send) {
1058         seq = RECORD_LAYER_get_write_sequence(&ssl->rlayer);
1059         hash = ssl->write_hash;
1060     } else {
1061         seq = RECORD_LAYER_get_read_sequence(&ssl->rlayer);
1062         hash = ssl->read_hash;
1063     }
1064
1065     t = EVP_MD_CTX_size(hash);
1066     OPENSSL_assert(t >= 0);
1067     md_size = t;
1068
1069     /* I should fix this up TLS TLS TLS TLS TLS XXXXXXXX */
1070     if (stream_mac) {
1071         mac_ctx = hash;
1072     } else {
1073         hmac = EVP_MD_CTX_new();
1074         if (hmac == NULL || !EVP_MD_CTX_copy(hmac, hash))
1075             return 0;
1076         mac_ctx = hmac;
1077     }
1078
1079     if (SSL_IS_DTLS(ssl)) {
1080         unsigned char dtlsseq[8], *p = dtlsseq;
1081
1082         s2n(send ? DTLS_RECORD_LAYER_get_w_epoch(&ssl->rlayer) :
1083             DTLS_RECORD_LAYER_get_r_epoch(&ssl->rlayer), p);
1084         memcpy(p, &seq[2], 6);
1085
1086         memcpy(header, dtlsseq, 8);
1087     } else
1088         memcpy(header, seq, 8);
1089
1090     header[8] = rec->type;
1091     header[9] = (unsigned char)(ssl->version >> 8);
1092     header[10] = (unsigned char)(ssl->version);
1093     header[11] = (unsigned char)(rec->length >> 8);
1094     header[12] = (unsigned char)(rec->length & 0xff);
1095
1096     if (!send && !SSL_READ_ETM(ssl) &&
1097         EVP_CIPHER_CTX_mode(ssl->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
1098         ssl3_cbc_record_digest_supported(mac_ctx)) {
1099         /*
1100          * This is a CBC-encrypted record. We must avoid leaking any
1101          * timing-side channel information about how many blocks of data we
1102          * are hashing because that gives an attacker a timing-oracle.
1103          */
1104         /* Final param == not SSLv3 */
1105         if (ssl3_cbc_digest_record(mac_ctx,
1106                                    md, &md_size,
1107                                    header, rec->input,
1108                                    rec->length + md_size, rec->orig_len,
1109                                    ssl->s3->read_mac_secret,
1110                                    ssl->s3->read_mac_secret_size, 0) <= 0) {
1111             EVP_MD_CTX_free(hmac);
1112             return -1;
1113         }
1114     } else {
1115         /* TODO(size_t): Convert these calls */
1116         if (EVP_DigestSignUpdate(mac_ctx, header, sizeof(header)) <= 0
1117             || EVP_DigestSignUpdate(mac_ctx, rec->input, rec->length) <= 0
1118             || EVP_DigestSignFinal(mac_ctx, md, &md_size) <= 0) {
1119             EVP_MD_CTX_free(hmac);
1120             return 0;
1121         }
1122     }
1123
1124     EVP_MD_CTX_free(hmac);
1125
1126 #ifdef SSL_DEBUG
1127     fprintf(stderr, "seq=");
1128     {
1129         int z;
1130         for (z = 0; z < 8; z++)
1131             fprintf(stderr, "%02X ", seq[z]);
1132         fprintf(stderr, "\n");
1133     }
1134     fprintf(stderr, "rec=");
1135     {
1136         size_t z;
1137         for (z = 0; z < rec->length; z++)
1138             fprintf(stderr, "%02X ", rec->data[z]);
1139         fprintf(stderr, "\n");
1140     }
1141 #endif
1142
1143     if (!SSL_IS_DTLS(ssl)) {
1144         for (i = 7; i >= 0; i--) {
1145             ++seq[i];
1146             if (seq[i] != 0)
1147                 break;
1148         }
1149     }
1150 #ifdef SSL_DEBUG
1151     {
1152         unsigned int z;
1153         for (z = 0; z < md_size; z++)
1154             fprintf(stderr, "%02X ", md[z]);
1155         fprintf(stderr, "\n");
1156     }
1157 #endif
1158     return 1;
1159 }
1160
1161 /*-
1162  * ssl3_cbc_remove_padding removes padding from the decrypted, SSLv3, CBC
1163  * record in |rec| by updating |rec->length| in constant time.
1164  *
1165  * block_size: the block size of the cipher used to encrypt the record.
1166  * returns:
1167  *   0: (in non-constant time) if the record is publicly invalid.
1168  *   1: if the padding was valid
1169  *  -1: otherwise.
1170  */
1171 int ssl3_cbc_remove_padding(SSL3_RECORD *rec,
1172                             size_t block_size, size_t mac_size)
1173 {
1174     size_t padding_length;
1175     size_t good;
1176     const size_t overhead = 1 /* padding length byte */  + mac_size;
1177
1178     /*
1179      * These lengths are all public so we can test them in non-constant time.
1180      */
1181     if (overhead > rec->length)
1182         return 0;
1183
1184     padding_length = rec->data[rec->length - 1];
1185     good = constant_time_ge_s(rec->length, padding_length + overhead);
1186     /* SSLv3 requires that the padding is minimal. */
1187     good &= constant_time_ge_s(block_size, padding_length + 1);
1188     rec->length -= good & (padding_length + 1);
1189     return constant_time_select_int_s(good, 1, -1);
1190 }
1191
1192 /*-
1193  * tls1_cbc_remove_padding removes the CBC padding from the decrypted, TLS, CBC
1194  * record in |rec| in constant time and returns 1 if the padding is valid and
1195  * -1 otherwise. It also removes any explicit IV from the start of the record
1196  * without leaking any timing about whether there was enough space after the
1197  * padding was removed.
1198  *
1199  * block_size: the block size of the cipher used to encrypt the record.
1200  * returns:
1201  *   0: (in non-constant time) if the record is publicly invalid.
1202  *   1: if the padding was valid
1203  *  -1: otherwise.
1204  */
1205 int tls1_cbc_remove_padding(const SSL *s,
1206                             SSL3_RECORD *rec,
1207                             size_t block_size, size_t mac_size)
1208 {
1209     size_t good;
1210     size_t padding_length, to_check, i;
1211     const size_t overhead = 1 /* padding length byte */  + mac_size;
1212     /* Check if version requires explicit IV */
1213     if (SSL_USE_EXPLICIT_IV(s)) {
1214         /*
1215          * These lengths are all public so we can test them in non-constant
1216          * time.
1217          */
1218         if (overhead + block_size > rec->length)
1219             return 0;
1220         /* We can now safely skip explicit IV */
1221         rec->data += block_size;
1222         rec->input += block_size;
1223         rec->length -= block_size;
1224         rec->orig_len -= block_size;
1225     } else if (overhead > rec->length)
1226         return 0;
1227
1228     padding_length = rec->data[rec->length - 1];
1229
1230     if (EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s->enc_read_ctx)) &
1231         EVP_CIPH_FLAG_AEAD_CIPHER) {
1232         /* padding is already verified */
1233         rec->length -= padding_length + 1;
1234         return 1;
1235     }
1236
1237     good = constant_time_ge_s(rec->length, overhead + padding_length);
1238     /*
1239      * The padding consists of a length byte at the end of the record and
1240      * then that many bytes of padding, all with the same value as the length
1241      * byte. Thus, with the length byte included, there are i+1 bytes of
1242      * padding. We can't check just |padding_length+1| bytes because that
1243      * leaks decrypted information. Therefore we always have to check the
1244      * maximum amount of padding possible. (Again, the length of the record
1245      * is public information so we can use it.)
1246      */
1247     to_check = 256;            /* maximum amount of padding, inc length byte. */
1248     if (to_check > rec->length)
1249         to_check = rec->length;
1250
1251     for (i = 0; i < to_check; i++) {
1252         unsigned char mask = constant_time_ge_8_s(padding_length, i);
1253         unsigned char b = rec->data[rec->length - 1 - i];
1254         /*
1255          * The final |padding_length+1| bytes should all have the value
1256          * |padding_length|. Therefore the XOR should be zero.
1257          */
1258         good &= ~(mask & (padding_length ^ b));
1259     }
1260
1261     /*
1262      * If any of the final |padding_length+1| bytes had the wrong value, one
1263      * or more of the lower eight bits of |good| will be cleared.
1264      */
1265     good = constant_time_eq_s(0xff, good & 0xff);
1266     rec->length -= good & (padding_length + 1);
1267
1268     return constant_time_select_int_s(good, 1, -1);
1269 }
1270
1271 /*-
1272  * ssl3_cbc_copy_mac copies |md_size| bytes from the end of |rec| to |out| in
1273  * constant time (independent of the concrete value of rec->length, which may
1274  * vary within a 256-byte window).
1275  *
1276  * ssl3_cbc_remove_padding or tls1_cbc_remove_padding must be called prior to
1277  * this function.
1278  *
1279  * On entry:
1280  *   rec->orig_len >= md_size
1281  *   md_size <= EVP_MAX_MD_SIZE
1282  *
1283  * If CBC_MAC_ROTATE_IN_PLACE is defined then the rotation is performed with
1284  * variable accesses in a 64-byte-aligned buffer. Assuming that this fits into
1285  * a single or pair of cache-lines, then the variable memory accesses don't
1286  * actually affect the timing. CPUs with smaller cache-lines [if any] are
1287  * not multi-core and are not considered vulnerable to cache-timing attacks.
1288  */
1289 #define CBC_MAC_ROTATE_IN_PLACE
1290
1291 void ssl3_cbc_copy_mac(unsigned char *out,
1292                        const SSL3_RECORD *rec, size_t md_size)
1293 {
1294 #if defined(CBC_MAC_ROTATE_IN_PLACE)
1295     unsigned char rotated_mac_buf[64 + EVP_MAX_MD_SIZE];
1296     unsigned char *rotated_mac;
1297 #else
1298     unsigned char rotated_mac[EVP_MAX_MD_SIZE];
1299 #endif
1300
1301     /*
1302      * mac_end is the index of |rec->data| just after the end of the MAC.
1303      */
1304     size_t mac_end = rec->length;
1305     size_t mac_start = mac_end - md_size;
1306     size_t in_mac;
1307     /*
1308      * scan_start contains the number of bytes that we can ignore because the
1309      * MAC's position can only vary by 255 bytes.
1310      */
1311     size_t scan_start = 0;
1312     size_t i, j;
1313     size_t rotate_offset;
1314
1315     OPENSSL_assert(rec->orig_len >= md_size);
1316     OPENSSL_assert(md_size <= EVP_MAX_MD_SIZE);
1317
1318 #if defined(CBC_MAC_ROTATE_IN_PLACE)
1319     rotated_mac = rotated_mac_buf + ((0 - (size_t)rotated_mac_buf) & 63);
1320 #endif
1321
1322     /* This information is public so it's safe to branch based on it. */
1323     if (rec->orig_len > md_size + 255 + 1)
1324         scan_start = rec->orig_len - (md_size + 255 + 1);
1325
1326     in_mac = 0;
1327     rotate_offset = 0;
1328     memset(rotated_mac, 0, md_size);
1329     for (i = scan_start, j = 0; i < rec->orig_len; i++) {
1330         size_t mac_started = constant_time_eq_s(i, mac_start);
1331         size_t mac_ended = constant_time_lt_s(i, mac_end);
1332         unsigned char b = rec->data[i];
1333
1334         in_mac |= mac_started;
1335         in_mac &= mac_ended;
1336         rotate_offset |= j & mac_started;
1337         rotated_mac[j++] |= b & in_mac;
1338         j &= constant_time_lt_s(j, md_size);
1339     }
1340
1341     /* Now rotate the MAC */
1342 #if defined(CBC_MAC_ROTATE_IN_PLACE)
1343     j = 0;
1344     for (i = 0; i < md_size; i++) {
1345         /* in case cache-line is 32 bytes, touch second line */
1346         ((volatile unsigned char *)rotated_mac)[rotate_offset ^ 32];
1347         out[j++] = rotated_mac[rotate_offset++];
1348         rotate_offset &= constant_time_lt_s(rotate_offset, md_size);
1349     }
1350 #else
1351     memset(out, 0, md_size);
1352     rotate_offset = md_size - rotate_offset;
1353     rotate_offset &= constant_time_lt_s(rotate_offset, md_size);
1354     for (i = 0; i < md_size; i++) {
1355         for (j = 0; j < md_size; j++)
1356             out[j] |= rotated_mac[i] & constant_time_eq_8_s(j, rotate_offset);
1357         rotate_offset++;
1358         rotate_offset &= constant_time_lt_s(rotate_offset, md_size);
1359     }
1360 #endif
1361 }
1362
1363 int dtls1_process_record(SSL *s, DTLS1_BITMAP *bitmap)
1364 {
1365     int i, al;
1366     int enc_err;
1367     SSL_SESSION *sess;
1368     SSL3_RECORD *rr;
1369     int imac_size;
1370     size_t mac_size;
1371     unsigned char md[EVP_MAX_MD_SIZE];
1372
1373     rr = RECORD_LAYER_get_rrec(&s->rlayer);
1374     sess = s->session;
1375
1376     /*
1377      * At this point, s->packet_length == SSL3_RT_HEADER_LNGTH + rr->length,
1378      * and we have that many bytes in s->packet
1379      */
1380     rr->input = &(RECORD_LAYER_get_packet(&s->rlayer)[DTLS1_RT_HEADER_LENGTH]);
1381
1382     /*
1383      * ok, we can now read from 's->packet' data into 'rr' rr->input points
1384      * at rr->length bytes, which need to be copied into rr->data by either
1385      * the decryption or by the decompression When the data is 'copied' into
1386      * the rr->data buffer, rr->input will be pointed at the new buffer
1387      */
1388
1389     /*
1390      * We now have - encrypted [ MAC [ compressed [ plain ] ] ] rr->length
1391      * bytes of encrypted compressed stuff.
1392      */
1393
1394     /* check is not needed I believe */
1395     if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH) {
1396         al = SSL_AD_RECORD_OVERFLOW;
1397         SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
1398         goto f_err;
1399     }
1400
1401     /* decrypt in place in 'rr->input' */
1402     rr->data = rr->input;
1403     rr->orig_len = rr->length;
1404
1405     if (SSL_READ_ETM(s) && s->read_hash) {
1406         unsigned char *mac;
1407         mac_size = EVP_MD_CTX_size(s->read_hash);
1408         OPENSSL_assert(mac_size <= EVP_MAX_MD_SIZE);
1409         if (rr->orig_len < mac_size) {
1410             al = SSL_AD_DECODE_ERROR;
1411             SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_LENGTH_TOO_SHORT);
1412             goto f_err;
1413         }
1414         rr->length -= mac_size;
1415         mac = rr->data + rr->length;
1416         i = s->method->ssl3_enc->mac(s, rr, md, 0 /* not send */ );
1417         if (i == 0 || CRYPTO_memcmp(md, mac, (size_t)mac_size) != 0) {
1418             al = SSL_AD_BAD_RECORD_MAC;
1419             SSLerr(SSL_F_DTLS1_PROCESS_RECORD,
1420                    SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
1421             goto f_err;
1422         }
1423     }
1424
1425     enc_err = s->method->ssl3_enc->enc(s, rr, 1, 0);
1426     /*-
1427      * enc_err is:
1428      *    0: (in non-constant time) if the record is publically invalid.
1429      *    1: if the padding is valid
1430      *   -1: if the padding is invalid
1431      */
1432     if (enc_err == 0) {
1433         /* For DTLS we simply ignore bad packets. */
1434         rr->length = 0;
1435         RECORD_LAYER_reset_packet_length(&s->rlayer);
1436         goto err;
1437     }
1438 #ifdef SSL_DEBUG
1439     printf("dec %ld\n", rr->length);
1440     {
1441         size_t z;
1442         for (z = 0; z < rr->length; z++)
1443             printf("%02X%c", rr->data[z], ((z + 1) % 16) ? ' ' : '\n');
1444     }
1445     printf("\n");
1446 #endif
1447
1448     /* r->length is now the compressed data plus mac */
1449     if ((sess != NULL) && !SSL_READ_ETM(s) &&
1450         (s->enc_read_ctx != NULL) && (EVP_MD_CTX_md(s->read_hash) != NULL)) {
1451         /* s->read_hash != NULL => mac_size != -1 */
1452         unsigned char *mac = NULL;
1453         unsigned char mac_tmp[EVP_MAX_MD_SIZE];
1454
1455         /* TODO(size_t): Convert this to do size_t properly */
1456         imac_size = EVP_MD_CTX_size(s->read_hash);
1457         if (imac_size < 0) {
1458             al = SSL_AD_INTERNAL_ERROR;
1459             SSLerr(SSL_F_DTLS1_PROCESS_RECORD, ERR_LIB_EVP);
1460             goto f_err;
1461         }
1462         mac_size = (size_t)imac_size;
1463         OPENSSL_assert(mac_size <= EVP_MAX_MD_SIZE);
1464
1465         /*
1466          * orig_len is the length of the record before any padding was
1467          * removed. This is public information, as is the MAC in use,
1468          * therefore we can safely process the record in a different amount
1469          * of time if it's too short to possibly contain a MAC.
1470          */
1471         if (rr->orig_len < mac_size ||
1472             /* CBC records must have a padding length byte too. */
1473             (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE &&
1474              rr->orig_len < mac_size + 1)) {
1475             al = SSL_AD_DECODE_ERROR;
1476             SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_LENGTH_TOO_SHORT);
1477             goto f_err;
1478         }
1479
1480         if (EVP_CIPHER_CTX_mode(s->enc_read_ctx) == EVP_CIPH_CBC_MODE) {
1481             /*
1482              * We update the length so that the TLS header bytes can be
1483              * constructed correctly but we need to extract the MAC in
1484              * constant time from within the record, without leaking the
1485              * contents of the padding bytes.
1486              */
1487             mac = mac_tmp;
1488             ssl3_cbc_copy_mac(mac_tmp, rr, mac_size);
1489             rr->length -= mac_size;
1490         } else {
1491             /*
1492              * In this case there's no padding, so |rec->orig_len| equals
1493              * |rec->length| and we checked that there's enough bytes for
1494              * |mac_size| above.
1495              */
1496             rr->length -= mac_size;
1497             mac = &rr->data[rr->length];
1498         }
1499
1500         i = s->method->ssl3_enc->mac(s, rr, md, 0 /* not send */ );
1501         if (i == 0 || mac == NULL
1502             || CRYPTO_memcmp(md, mac, mac_size) != 0)
1503             enc_err = -1;
1504         if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH + mac_size)
1505             enc_err = -1;
1506     }
1507
1508     if (enc_err < 0) {
1509         /* decryption failed, silently discard message */
1510         rr->length = 0;
1511         RECORD_LAYER_reset_packet_length(&s->rlayer);
1512         goto err;
1513     }
1514
1515     /* r->length is now just compressed */
1516     if (s->expand != NULL) {
1517         if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH) {
1518             al = SSL_AD_RECORD_OVERFLOW;
1519             SSLerr(SSL_F_DTLS1_PROCESS_RECORD,
1520                    SSL_R_COMPRESSED_LENGTH_TOO_LONG);
1521             goto f_err;
1522         }
1523         if (!ssl3_do_uncompress(s, rr)) {
1524             al = SSL_AD_DECOMPRESSION_FAILURE;
1525             SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_BAD_DECOMPRESSION);
1526             goto f_err;
1527         }
1528     }
1529
1530     if (rr->length > SSL3_RT_MAX_PLAIN_LENGTH) {
1531         al = SSL_AD_RECORD_OVERFLOW;
1532         SSLerr(SSL_F_DTLS1_PROCESS_RECORD, SSL_R_DATA_LENGTH_TOO_LONG);
1533         goto f_err;
1534     }
1535
1536     rr->off = 0;
1537     /*-
1538      * So at this point the following is true
1539      * ssl->s3->rrec.type   is the type of record
1540      * ssl->s3->rrec.length == number of bytes in record
1541      * ssl->s3->rrec.off    == offset to first valid byte
1542      * ssl->s3->rrec.data   == where to take bytes from, increment
1543      *                         after use :-).
1544      */
1545
1546     /* we have pulled in a full packet so zero things */
1547     RECORD_LAYER_reset_packet_length(&s->rlayer);
1548
1549     /* Mark receipt of record. */
1550     dtls1_record_bitmap_update(s, bitmap);
1551
1552     return (1);
1553
1554  f_err:
1555     ssl3_send_alert(s, SSL3_AL_FATAL, al);
1556  err:
1557     return (0);
1558 }
1559
1560 /*
1561  * retrieve a buffered record that belongs to the current epoch, ie,
1562  * processed
1563  */
1564 #define dtls1_get_processed_record(s) \
1565                    dtls1_retrieve_buffered_record((s), \
1566                    &(DTLS_RECORD_LAYER_get_processed_rcds(&s->rlayer)))
1567
1568 /*-
1569  * Call this to get a new input record.
1570  * It will return <= 0 if more data is needed, normally due to an error
1571  * or non-blocking IO.
1572  * When it finishes, one packet has been decoded and can be found in
1573  * ssl->s3->rrec.type    - is the type of record
1574  * ssl->s3->rrec.data,   - data
1575  * ssl->s3->rrec.length, - number of bytes
1576  */
1577 /* used only by dtls1_read_bytes */
1578 int dtls1_get_record(SSL *s)
1579 {
1580     int ssl_major, ssl_minor;
1581     int rret;
1582     size_t more, n;
1583     SSL3_RECORD *rr;
1584     unsigned char *p = NULL;
1585     unsigned short version;
1586     DTLS1_BITMAP *bitmap;
1587     unsigned int is_next_epoch;
1588
1589     rr = RECORD_LAYER_get_rrec(&s->rlayer);
1590
1591  again:
1592     /*
1593      * The epoch may have changed.  If so, process all the pending records.
1594      * This is a non-blocking operation.
1595      */
1596     if (!dtls1_process_buffered_records(s))
1597         return -1;
1598
1599     /* if we're renegotiating, then there may be buffered records */
1600     if (dtls1_get_processed_record(s))
1601         return 1;
1602
1603     /* get something from the wire */
1604
1605     /* check if we have the header */
1606     if ((RECORD_LAYER_get_rstate(&s->rlayer) != SSL_ST_READ_BODY) ||
1607         (RECORD_LAYER_get_packet_length(&s->rlayer) < DTLS1_RT_HEADER_LENGTH)) {
1608         rret = ssl3_read_n(s, DTLS1_RT_HEADER_LENGTH,
1609                            SSL3_BUFFER_get_len(&s->rlayer.rbuf), 0, 1, &n);
1610         /* read timeout is handled by dtls1_read_bytes */
1611         if (rret <= 0)
1612             return rret;         /* error or non-blocking */
1613
1614         /* this packet contained a partial record, dump it */
1615         if (RECORD_LAYER_get_packet_length(&s->rlayer) !=
1616             DTLS1_RT_HEADER_LENGTH) {
1617             RECORD_LAYER_reset_packet_length(&s->rlayer);
1618             goto again;
1619         }
1620
1621         RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_BODY);
1622
1623         p = RECORD_LAYER_get_packet(&s->rlayer);
1624
1625         if (s->msg_callback)
1626             s->msg_callback(0, 0, SSL3_RT_HEADER, p, DTLS1_RT_HEADER_LENGTH,
1627                             s, s->msg_callback_arg);
1628
1629         /* Pull apart the header into the DTLS1_RECORD */
1630         rr->type = *(p++);
1631         ssl_major = *(p++);
1632         ssl_minor = *(p++);
1633         version = (ssl_major << 8) | ssl_minor;
1634
1635         /* sequence number is 64 bits, with top 2 bytes = epoch */
1636         n2s(p, rr->epoch);
1637
1638         memcpy(&(RECORD_LAYER_get_read_sequence(&s->rlayer)[2]), p, 6);
1639         p += 6;
1640
1641         n2s(p, rr->length);
1642
1643         /* Lets check version */
1644         if (!s->first_packet) {
1645             if (version != s->version) {
1646                 /* unexpected version, silently discard */
1647                 rr->length = 0;
1648                 RECORD_LAYER_reset_packet_length(&s->rlayer);
1649                 goto again;
1650             }
1651         }
1652
1653         if ((version & 0xff00) != (s->version & 0xff00)) {
1654             /* wrong version, silently discard record */
1655             rr->length = 0;
1656             RECORD_LAYER_reset_packet_length(&s->rlayer);
1657             goto again;
1658         }
1659
1660         if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH) {
1661             /* record too long, silently discard it */
1662             rr->length = 0;
1663             RECORD_LAYER_reset_packet_length(&s->rlayer);
1664             goto again;
1665         }
1666
1667         /* now s->rlayer.rstate == SSL_ST_READ_BODY */
1668     }
1669
1670     /* s->rlayer.rstate == SSL_ST_READ_BODY, get and decode the data */
1671
1672     if (rr->length >
1673         RECORD_LAYER_get_packet_length(&s->rlayer) - DTLS1_RT_HEADER_LENGTH) {
1674         /* now s->packet_length == DTLS1_RT_HEADER_LENGTH */
1675         more = rr->length;
1676         rret = ssl3_read_n(s, more, more, 1, 1, &n);
1677         /* this packet contained a partial record, dump it */
1678         if (rret <= 0 || n != more) {
1679             rr->length = 0;
1680             RECORD_LAYER_reset_packet_length(&s->rlayer);
1681             goto again;
1682         }
1683
1684         /*
1685          * now n == rr->length, and s->packet_length ==
1686          * DTLS1_RT_HEADER_LENGTH + rr->length
1687          */
1688     }
1689     /* set state for later operations */
1690     RECORD_LAYER_set_rstate(&s->rlayer, SSL_ST_READ_HEADER);
1691
1692     /* match epochs.  NULL means the packet is dropped on the floor */
1693     bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
1694     if (bitmap == NULL) {
1695         rr->length = 0;
1696         RECORD_LAYER_reset_packet_length(&s->rlayer); /* dump this record */
1697         goto again;             /* get another record */
1698     }
1699 #ifndef OPENSSL_NO_SCTP
1700     /* Only do replay check if no SCTP bio */
1701     if (!BIO_dgram_is_sctp(SSL_get_rbio(s))) {
1702 #endif
1703         /* Check whether this is a repeat, or aged record. */
1704         /*
1705          * TODO: Does it make sense to have replay protection in epoch 0 where
1706          * we have no integrity negotiated yet?
1707          */
1708         if (!dtls1_record_replay_check(s, bitmap)) {
1709             rr->length = 0;
1710             RECORD_LAYER_reset_packet_length(&s->rlayer); /* dump this record */
1711             goto again;         /* get another record */
1712         }
1713 #ifndef OPENSSL_NO_SCTP
1714     }
1715 #endif
1716
1717     /* just read a 0 length packet */
1718     if (rr->length == 0)
1719         goto again;
1720
1721     /*
1722      * If this record is from the next epoch (either HM or ALERT), and a
1723      * handshake is currently in progress, buffer it since it cannot be
1724      * processed at this time.
1725      */
1726     if (is_next_epoch) {
1727         if ((SSL_in_init(s) || ossl_statem_get_in_handshake(s))) {
1728             if (dtls1_buffer_record
1729                 (s, &(DTLS_RECORD_LAYER_get_unprocessed_rcds(&s->rlayer)),
1730                  rr->seq_num) < 0)
1731                 return -1;
1732         }
1733         rr->length = 0;
1734         RECORD_LAYER_reset_packet_length(&s->rlayer);
1735         goto again;
1736     }
1737
1738     if (!dtls1_process_record(s, bitmap)) {
1739         rr->length = 0;
1740         RECORD_LAYER_reset_packet_length(&s->rlayer); /* dump this record */
1741         goto again;             /* get another record */
1742     }
1743
1744     return (1);
1745
1746 }