Don't try and parse boolean type.
[openssl.git] / ssl / s3_cbc.c
1 /* ssl/s3_cbc.c */
2 /* ====================================================================
3  * Copyright (c) 2012 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in
14  *    the documentation and/or other materials provided with the
15  *    distribution.
16  *
17  * 3. All advertising materials mentioning features or use of this
18  *    software must display the following acknowledgment:
19  *    "This product includes software developed by the OpenSSL Project
20  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21  *
22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23  *    endorse or promote products derived from this software without
24  *    prior written permission. For written permission, please contact
25  *    openssl-core@openssl.org.
26  *
27  * 5. Products derived from this software may not be called "OpenSSL"
28  *    nor may "OpenSSL" appear in their names without prior written
29  *    permission of the OpenSSL Project.
30  *
31  * 6. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47  * OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This product includes cryptographic software written by Eric Young
51  * (eay@cryptsoft.com).  This product includes software written by Tim
52  * Hudson (tjh@cryptsoft.com).
53  *
54  */
55
56 #include "../crypto/constant_time_locl.h"
57 #include "ssl_locl.h"
58
59 #include <openssl/md5.h>
60 #include <openssl/sha.h>
61
62 /*
63  * MAX_HASH_BIT_COUNT_BYTES is the maximum number of bytes in the hash's
64  * length field. (SHA-384/512 have 128-bit length.)
65  */
66 #define MAX_HASH_BIT_COUNT_BYTES 16
67
68 /*
69  * MAX_HASH_BLOCK_SIZE is the maximum hash block size that we'll support.
70  * Currently SHA-384/512 has a 128-byte block size and that's the largest
71  * supported by TLS.)
72  */
73 #define MAX_HASH_BLOCK_SIZE 128
74
75 /*-
76  * ssl3_cbc_remove_padding removes padding from the decrypted, SSLv3, CBC
77  * record in |rec| by updating |rec->length| in constant time.
78  *
79  * block_size: the block size of the cipher used to encrypt the record.
80  * returns:
81  *   0: (in non-constant time) if the record is publicly invalid.
82  *   1: if the padding was valid
83  *  -1: otherwise.
84  */
85 int ssl3_cbc_remove_padding(const SSL *s,
86                             SSL3_RECORD *rec,
87                             unsigned block_size, unsigned mac_size)
88 {
89     unsigned padding_length, good;
90     const unsigned overhead = 1 /* padding length byte */  + mac_size;
91
92     /*
93      * These lengths are all public so we can test them in non-constant time.
94      */
95     if (overhead > rec->length)
96         return 0;
97
98     padding_length = rec->data[rec->length - 1];
99     good = constant_time_ge(rec->length, padding_length + overhead);
100     /* SSLv3 requires that the padding is minimal. */
101     good &= constant_time_ge(block_size, padding_length + 1);
102     padding_length = good & (padding_length + 1);
103     rec->length -= padding_length;
104     rec->type |= padding_length << 8; /* kludge: pass padding length */
105     return constant_time_select_int(good, 1, -1);
106 }
107
108 /*-
109  * tls1_cbc_remove_padding removes the CBC padding from the decrypted, TLS, CBC
110  * record in |rec| in constant time and returns 1 if the padding is valid and
111  * -1 otherwise. It also removes any explicit IV from the start of the record
112  * without leaking any timing about whether there was enough space after the
113  * padding was removed.
114  *
115  * block_size: the block size of the cipher used to encrypt the record.
116  * returns:
117  *   0: (in non-constant time) if the record is publicly invalid.
118  *   1: if the padding was valid
119  *  -1: otherwise.
120  */
121 int tls1_cbc_remove_padding(const SSL *s,
122                             SSL3_RECORD *rec,
123                             unsigned block_size, unsigned mac_size)
124 {
125     unsigned padding_length, good, to_check, i;
126     const unsigned overhead = 1 /* padding length byte */  + mac_size;
127     /* Check if version requires explicit IV */
128     if (s->version == DTLS1_VERSION || s->version == DTLS1_BAD_VER) {
129         /*
130          * These lengths are all public so we can test them in non-constant
131          * time.
132          */
133         if (overhead + block_size > rec->length)
134             return 0;
135         /* We can now safely skip explicit IV */
136         rec->data += block_size;
137         rec->input += block_size;
138         rec->length -= block_size;
139     } else if (overhead > rec->length)
140         return 0;
141
142     padding_length = rec->data[rec->length - 1];
143
144     /*
145      * NB: if compression is in operation the first packet may not be of even
146      * length so the padding bug check cannot be performed. This bug
147      * workaround has been around since SSLeay so hopefully it is either
148      * fixed now or no buggy implementation supports compression [steve]
149      */
150     if ((s->options & SSL_OP_TLS_BLOCK_PADDING_BUG) && !s->expand) {
151         /* First packet is even in size, so check */
152         if ((memcmp(s->s3->read_sequence, "\0\0\0\0\0\0\0\0", 8) == 0) &&
153             !(padding_length & 1)) {
154             s->s3->flags |= TLS1_FLAGS_TLS_PADDING_BUG;
155         }
156         if ((s->s3->flags & TLS1_FLAGS_TLS_PADDING_BUG) && padding_length > 0) {
157             padding_length--;
158         }
159     }
160
161     good = constant_time_ge(rec->length, overhead + padding_length);
162     /*
163      * The padding consists of a length byte at the end of the record and
164      * then that many bytes of padding, all with the same value as the length
165      * byte. Thus, with the length byte included, there are i+1 bytes of
166      * padding. We can't check just |padding_length+1| bytes because that
167      * leaks decrypted information. Therefore we always have to check the
168      * maximum amount of padding possible. (Again, the length of the record
169      * is public information so we can use it.)
170      */
171     to_check = 255;             /* maximum amount of padding. */
172     if (to_check > rec->length - 1)
173         to_check = rec->length - 1;
174
175     for (i = 0; i < to_check; i++) {
176         unsigned char mask = constant_time_ge_8(padding_length, i);
177         unsigned char b = rec->data[rec->length - 1 - i];
178         /*
179          * The final |padding_length+1| bytes should all have the value
180          * |padding_length|. Therefore the XOR should be zero.
181          */
182         good &= ~(mask & (padding_length ^ b));
183     }
184
185     /*
186      * If any of the final |padding_length+1| bytes had the wrong value, one
187      * or more of the lower eight bits of |good| will be cleared.
188      */
189     good = constant_time_eq(0xff, good & 0xff);
190     padding_length = good & (padding_length + 1);
191     rec->length -= padding_length;
192     rec->type |= padding_length << 8; /* kludge: pass padding length */
193
194     return constant_time_select_int(good, 1, -1);
195 }
196
197 /*-
198  * ssl3_cbc_copy_mac copies |md_size| bytes from the end of |rec| to |out| in
199  * constant time (independent of the concrete value of rec->length, which may
200  * vary within a 256-byte window).
201  *
202  * ssl3_cbc_remove_padding or tls1_cbc_remove_padding must be called prior to
203  * this function.
204  *
205  * On entry:
206  *   rec->orig_len >= md_size
207  *   md_size <= EVP_MAX_MD_SIZE
208  *
209  * If CBC_MAC_ROTATE_IN_PLACE is defined then the rotation is performed with
210  * variable accesses in a 64-byte-aligned buffer. Assuming that this fits into
211  * a single or pair of cache-lines, then the variable memory accesses don't
212  * actually affect the timing. CPUs with smaller cache-lines [if any] are
213  * not multi-core and are not considered vulnerable to cache-timing attacks.
214  */
215 #define CBC_MAC_ROTATE_IN_PLACE
216
217 void ssl3_cbc_copy_mac(unsigned char *out,
218                        const SSL3_RECORD *rec,
219                        unsigned md_size, unsigned orig_len)
220 {
221 #if defined(CBC_MAC_ROTATE_IN_PLACE)
222     unsigned char rotated_mac_buf[64 + EVP_MAX_MD_SIZE];
223     unsigned char *rotated_mac;
224 #else
225     unsigned char rotated_mac[EVP_MAX_MD_SIZE];
226 #endif
227
228     /*
229      * mac_end is the index of |rec->data| just after the end of the MAC.
230      */
231     unsigned mac_end = rec->length;
232     unsigned mac_start = mac_end - md_size;
233     /*
234      * scan_start contains the number of bytes that we can ignore because the
235      * MAC's position can only vary by 255 bytes.
236      */
237     unsigned scan_start = 0;
238     unsigned i, j;
239     unsigned div_spoiler;
240     unsigned rotate_offset;
241
242     OPENSSL_assert(orig_len >= md_size);
243     OPENSSL_assert(md_size <= EVP_MAX_MD_SIZE);
244
245 #if defined(CBC_MAC_ROTATE_IN_PLACE)
246     rotated_mac = rotated_mac_buf + ((0 - (size_t)rotated_mac_buf) & 63);
247 #endif
248
249     /* This information is public so it's safe to branch based on it. */
250     if (orig_len > md_size + 255 + 1)
251         scan_start = orig_len - (md_size + 255 + 1);
252     /*
253      * div_spoiler contains a multiple of md_size that is used to cause the
254      * modulo operation to be constant time. Without this, the time varies
255      * based on the amount of padding when running on Intel chips at least.
256      * The aim of right-shifting md_size is so that the compiler doesn't
257      * figure out that it can remove div_spoiler as that would require it to
258      * prove that md_size is always even, which I hope is beyond it.
259      */
260     div_spoiler = md_size >> 1;
261     div_spoiler <<= (sizeof(div_spoiler) - 1) * 8;
262     rotate_offset = (div_spoiler + mac_start - scan_start) % md_size;
263
264     memset(rotated_mac, 0, md_size);
265     for (i = scan_start, j = 0; i < orig_len; i++) {
266         unsigned char mac_started = constant_time_ge_8(i, mac_start);
267         unsigned char mac_ended = constant_time_ge_8(i, mac_end);
268         unsigned char b = rec->data[i];
269         rotated_mac[j++] |= b & mac_started & ~mac_ended;
270         j &= constant_time_lt(j, md_size);
271     }
272
273     /* Now rotate the MAC */
274 #if defined(CBC_MAC_ROTATE_IN_PLACE)
275     j = 0;
276     for (i = 0; i < md_size; i++) {
277         /* in case cache-line is 32 bytes, touch second line */
278         ((volatile unsigned char *)rotated_mac)[rotate_offset ^ 32];
279         out[j++] = rotated_mac[rotate_offset++];
280         rotate_offset &= constant_time_lt(rotate_offset, md_size);
281     }
282 #else
283     memset(out, 0, md_size);
284     rotate_offset = md_size - rotate_offset;
285     rotate_offset &= constant_time_lt(rotate_offset, md_size);
286     for (i = 0; i < md_size; i++) {
287         for (j = 0; j < md_size; j++)
288             out[j] |= rotated_mac[i] & constant_time_eq_8(j, rotate_offset);
289         rotate_offset++;
290         rotate_offset &= constant_time_lt(rotate_offset, md_size);
291     }
292 #endif
293 }
294
295 /*
296  * u32toLE serialises an unsigned, 32-bit number (n) as four bytes at (p) in
297  * little-endian order. The value of p is advanced by four.
298  */
299 #define u32toLE(n, p) \
300         (*((p)++)=(unsigned char)(n), \
301          *((p)++)=(unsigned char)(n>>8), \
302          *((p)++)=(unsigned char)(n>>16), \
303          *((p)++)=(unsigned char)(n>>24))
304
305 /*
306  * These functions serialize the state of a hash and thus perform the
307  * standard "final" operation without adding the padding and length that such
308  * a function typically does.
309  */
310 static void tls1_md5_final_raw(void *ctx, unsigned char *md_out)
311 {
312     MD5_CTX *md5 = ctx;
313     u32toLE(md5->A, md_out);
314     u32toLE(md5->B, md_out);
315     u32toLE(md5->C, md_out);
316     u32toLE(md5->D, md_out);
317 }
318
319 static void tls1_sha1_final_raw(void *ctx, unsigned char *md_out)
320 {
321     SHA_CTX *sha1 = ctx;
322     l2n(sha1->h0, md_out);
323     l2n(sha1->h1, md_out);
324     l2n(sha1->h2, md_out);
325     l2n(sha1->h3, md_out);
326     l2n(sha1->h4, md_out);
327 }
328
329 #define LARGEST_DIGEST_CTX SHA_CTX
330
331 #ifndef OPENSSL_NO_SHA256
332 static void tls1_sha256_final_raw(void *ctx, unsigned char *md_out)
333 {
334     SHA256_CTX *sha256 = ctx;
335     unsigned i;
336
337     for (i = 0; i < 8; i++) {
338         l2n(sha256->h[i], md_out);
339     }
340 }
341
342 # undef  LARGEST_DIGEST_CTX
343 # define LARGEST_DIGEST_CTX SHA256_CTX
344 #endif
345
346 #ifndef OPENSSL_NO_SHA512
347 static void tls1_sha512_final_raw(void *ctx, unsigned char *md_out)
348 {
349     SHA512_CTX *sha512 = ctx;
350     unsigned i;
351
352     for (i = 0; i < 8; i++) {
353         l2n8(sha512->h[i], md_out);
354     }
355 }
356
357 # undef  LARGEST_DIGEST_CTX
358 # define LARGEST_DIGEST_CTX SHA512_CTX
359 #endif
360
361 /*
362  * ssl3_cbc_record_digest_supported returns 1 iff |ctx| uses a hash function
363  * which ssl3_cbc_digest_record supports.
364  */
365 char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx)
366 {
367     switch (ctx->digest->type) {
368     case NID_md5:
369     case NID_sha1:
370 #ifndef OPENSSL_NO_SHA256
371     case NID_sha224:
372     case NID_sha256:
373 #endif
374 #ifndef OPENSSL_NO_SHA512
375     case NID_sha384:
376     case NID_sha512:
377 #endif
378         return 1;
379     default:
380         return 0;
381     }
382 }
383
384 /*-
385  * ssl3_cbc_digest_record computes the MAC of a decrypted, padded SSLv3/TLS
386  * record.
387  *
388  *   ctx: the EVP_MD_CTX from which we take the hash function.
389  *     ssl3_cbc_record_digest_supported must return true for this EVP_MD_CTX.
390  *   md_out: the digest output. At most EVP_MAX_MD_SIZE bytes will be written.
391  *   md_out_size: if non-NULL, the number of output bytes is written here.
392  *   header: the 13-byte, TLS record header.
393  *   data: the record data itself, less any preceeding explicit IV.
394  *   data_plus_mac_size: the secret, reported length of the data and MAC
395  *     once the padding has been removed.
396  *   data_plus_mac_plus_padding_size: the public length of the whole
397  *     record, including padding.
398  *   is_sslv3: non-zero if we are to use SSLv3. Otherwise, TLS.
399  *
400  * On entry: by virtue of having been through one of the remove_padding
401  * functions, above, we know that data_plus_mac_size is large enough to contain
402  * a padding byte and MAC. (If the padding was invalid, it might contain the
403  * padding too. )
404  */
405 void ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
406                             unsigned char *md_out,
407                             size_t *md_out_size,
408                             const unsigned char header[13],
409                             const unsigned char *data,
410                             size_t data_plus_mac_size,
411                             size_t data_plus_mac_plus_padding_size,
412                             const unsigned char *mac_secret,
413                             unsigned mac_secret_length, char is_sslv3)
414 {
415     union {
416         double align;
417         unsigned char c[sizeof(LARGEST_DIGEST_CTX)];
418     } md_state;
419     void (*md_final_raw) (void *ctx, unsigned char *md_out);
420     void (*md_transform) (void *ctx, const unsigned char *block);
421     unsigned md_size, md_block_size = 64;
422     unsigned sslv3_pad_length = 40, header_length, variance_blocks,
423         len, max_mac_bytes, num_blocks,
424         num_starting_blocks, k, mac_end_offset, c, index_a, index_b;
425     unsigned int bits;          /* at most 18 bits */
426     unsigned char length_bytes[MAX_HASH_BIT_COUNT_BYTES];
427     /* hmac_pad is the masked HMAC key. */
428     unsigned char hmac_pad[MAX_HASH_BLOCK_SIZE];
429     unsigned char first_block[MAX_HASH_BLOCK_SIZE];
430     unsigned char mac_out[EVP_MAX_MD_SIZE];
431     unsigned i, j, md_out_size_u;
432     EVP_MD_CTX md_ctx;
433     /*
434      * mdLengthSize is the number of bytes in the length field that
435      * terminates * the hash.
436      */
437     unsigned md_length_size = 8;
438     char length_is_big_endian = 1;
439
440     /*
441      * This is a, hopefully redundant, check that allows us to forget about
442      * many possible overflows later in this function.
443      */
444     OPENSSL_assert(data_plus_mac_plus_padding_size < 1024 * 1024);
445
446     switch (ctx->digest->type) {
447     case NID_md5:
448         MD5_Init((MD5_CTX *)md_state.c);
449         md_final_raw = tls1_md5_final_raw;
450         md_transform =
451             (void (*)(void *ctx, const unsigned char *block))MD5_Transform;
452         md_size = 16;
453         sslv3_pad_length = 48;
454         length_is_big_endian = 0;
455         break;
456     case NID_sha1:
457         SHA1_Init((SHA_CTX *)md_state.c);
458         md_final_raw = tls1_sha1_final_raw;
459         md_transform =
460             (void (*)(void *ctx, const unsigned char *block))SHA1_Transform;
461         md_size = 20;
462         break;
463 #ifndef OPENSSL_NO_SHA256
464     case NID_sha224:
465         SHA224_Init((SHA256_CTX *)md_state.c);
466         md_final_raw = tls1_sha256_final_raw;
467         md_transform =
468             (void (*)(void *ctx, const unsigned char *block))SHA256_Transform;
469         md_size = 224 / 8;
470         break;
471     case NID_sha256:
472         SHA256_Init((SHA256_CTX *)md_state.c);
473         md_final_raw = tls1_sha256_final_raw;
474         md_transform =
475             (void (*)(void *ctx, const unsigned char *block))SHA256_Transform;
476         md_size = 32;
477         break;
478 #endif
479 #ifndef OPENSSL_NO_SHA512
480     case NID_sha384:
481         SHA384_Init((SHA512_CTX *)md_state.c);
482         md_final_raw = tls1_sha512_final_raw;
483         md_transform =
484             (void (*)(void *ctx, const unsigned char *block))SHA512_Transform;
485         md_size = 384 / 8;
486         md_block_size = 128;
487         md_length_size = 16;
488         break;
489     case NID_sha512:
490         SHA512_Init((SHA512_CTX *)md_state.c);
491         md_final_raw = tls1_sha512_final_raw;
492         md_transform =
493             (void (*)(void *ctx, const unsigned char *block))SHA512_Transform;
494         md_size = 64;
495         md_block_size = 128;
496         md_length_size = 16;
497         break;
498 #endif
499     default:
500         /*
501          * ssl3_cbc_record_digest_supported should have been called first to
502          * check that the hash function is supported.
503          */
504         OPENSSL_assert(0);
505         if (md_out_size)
506             *md_out_size = -1;
507         return;
508     }
509
510     OPENSSL_assert(md_length_size <= MAX_HASH_BIT_COUNT_BYTES);
511     OPENSSL_assert(md_block_size <= MAX_HASH_BLOCK_SIZE);
512     OPENSSL_assert(md_size <= EVP_MAX_MD_SIZE);
513
514     header_length = 13;
515     if (is_sslv3) {
516         header_length = mac_secret_length + sslv3_pad_length + 8 /* sequence
517                                                                   * number */  +
518             1 /* record type */  +
519             2 /* record length */ ;
520     }
521
522     /*
523      * variance_blocks is the number of blocks of the hash that we have to
524      * calculate in constant time because they could be altered by the
525      * padding value. In SSLv3, the padding must be minimal so the end of
526      * the plaintext varies by, at most, 15+20 = 35 bytes. (We conservatively
527      * assume that the MAC size varies from 0..20 bytes.) In case the 9 bytes
528      * of hash termination (0x80 + 64-bit length) don't fit in the final
529      * block, we say that the final two blocks can vary based on the padding.
530      * TLSv1 has MACs up to 48 bytes long (SHA-384) and the padding is not
531      * required to be minimal. Therefore we say that the final six blocks can
532      * vary based on the padding. Later in the function, if the message is
533      * short and there obviously cannot be this many blocks then
534      * variance_blocks can be reduced.
535      */
536     variance_blocks = is_sslv3 ? 2 : 6;
537     /*
538      * From now on we're dealing with the MAC, which conceptually has 13
539      * bytes of `header' before the start of the data (TLS) or 71/75 bytes
540      * (SSLv3)
541      */
542     len = data_plus_mac_plus_padding_size + header_length;
543     /*
544      * max_mac_bytes contains the maximum bytes of bytes in the MAC,
545      * including * |header|, assuming that there's no padding.
546      */
547     max_mac_bytes = len - md_size - 1;
548     /* num_blocks is the maximum number of hash blocks. */
549     num_blocks =
550         (max_mac_bytes + 1 + md_length_size + md_block_size -
551          1) / md_block_size;
552     /*
553      * In order to calculate the MAC in constant time we have to handle the
554      * final blocks specially because the padding value could cause the end
555      * to appear somewhere in the final |variance_blocks| blocks and we can't
556      * leak where. However, |num_starting_blocks| worth of data can be hashed
557      * right away because no padding value can affect whether they are
558      * plaintext.
559      */
560     num_starting_blocks = 0;
561     /*
562      * k is the starting byte offset into the conceptual header||data where
563      * we start processing.
564      */
565     k = 0;
566     /*
567      * mac_end_offset is the index just past the end of the data to be MACed.
568      */
569     mac_end_offset = data_plus_mac_size + header_length - md_size;
570     /*
571      * c is the index of the 0x80 byte in the final hash block that contains
572      * application data.
573      */
574     c = mac_end_offset % md_block_size;
575     /*
576      * index_a is the hash block number that contains the 0x80 terminating
577      * value.
578      */
579     index_a = mac_end_offset / md_block_size;
580     /*
581      * index_b is the hash block number that contains the 64-bit hash length,
582      * in bits.
583      */
584     index_b = (mac_end_offset + md_length_size) / md_block_size;
585     /*
586      * bits is the hash-length in bits. It includes the additional hash block
587      * for the masked HMAC key, or whole of |header| in the case of SSLv3.
588      */
589
590     /*
591      * For SSLv3, if we're going to have any starting blocks then we need at
592      * least two because the header is larger than a single block.
593      */
594     if (num_blocks > variance_blocks + (is_sslv3 ? 1 : 0)) {
595         num_starting_blocks = num_blocks - variance_blocks;
596         k = md_block_size * num_starting_blocks;
597     }
598
599     bits = 8 * mac_end_offset;
600     if (!is_sslv3) {
601         /*
602          * Compute the initial HMAC block. For SSLv3, the padding and secret
603          * bytes are included in |header| because they take more than a
604          * single block.
605          */
606         bits += 8 * md_block_size;
607         memset(hmac_pad, 0, md_block_size);
608         OPENSSL_assert(mac_secret_length <= sizeof(hmac_pad));
609         memcpy(hmac_pad, mac_secret, mac_secret_length);
610         for (i = 0; i < md_block_size; i++)
611             hmac_pad[i] ^= 0x36;
612
613         md_transform(md_state.c, hmac_pad);
614     }
615
616     if (length_is_big_endian) {
617         memset(length_bytes, 0, md_length_size - 4);
618         length_bytes[md_length_size - 4] = (unsigned char)(bits >> 24);
619         length_bytes[md_length_size - 3] = (unsigned char)(bits >> 16);
620         length_bytes[md_length_size - 2] = (unsigned char)(bits >> 8);
621         length_bytes[md_length_size - 1] = (unsigned char)bits;
622     } else {
623         memset(length_bytes, 0, md_length_size);
624         length_bytes[md_length_size - 5] = (unsigned char)(bits >> 24);
625         length_bytes[md_length_size - 6] = (unsigned char)(bits >> 16);
626         length_bytes[md_length_size - 7] = (unsigned char)(bits >> 8);
627         length_bytes[md_length_size - 8] = (unsigned char)bits;
628     }
629
630     if (k > 0) {
631         if (is_sslv3) {
632             /*
633              * The SSLv3 header is larger than a single block. overhang is
634              * the number of bytes beyond a single block that the header
635              * consumes: either 7 bytes (SHA1) or 11 bytes (MD5).
636              */
637             unsigned overhang = header_length - md_block_size;
638             md_transform(md_state.c, header);
639             memcpy(first_block, header + md_block_size, overhang);
640             memcpy(first_block + overhang, data, md_block_size - overhang);
641             md_transform(md_state.c, first_block);
642             for (i = 1; i < k / md_block_size - 1; i++)
643                 md_transform(md_state.c, data + md_block_size * i - overhang);
644         } else {
645             /* k is a multiple of md_block_size. */
646             memcpy(first_block, header, 13);
647             memcpy(first_block + 13, data, md_block_size - 13);
648             md_transform(md_state.c, first_block);
649             for (i = 1; i < k / md_block_size; i++)
650                 md_transform(md_state.c, data + md_block_size * i - 13);
651         }
652     }
653
654     memset(mac_out, 0, sizeof(mac_out));
655
656     /*
657      * We now process the final hash blocks. For each block, we construct it
658      * in constant time. If the |i==index_a| then we'll include the 0x80
659      * bytes and zero pad etc. For each block we selectively copy it, in
660      * constant time, to |mac_out|.
661      */
662     for (i = num_starting_blocks; i <= num_starting_blocks + variance_blocks;
663          i++) {
664         unsigned char block[MAX_HASH_BLOCK_SIZE];
665         unsigned char is_block_a = constant_time_eq_8(i, index_a);
666         unsigned char is_block_b = constant_time_eq_8(i, index_b);
667         for (j = 0; j < md_block_size; j++) {
668             unsigned char b = 0, is_past_c, is_past_cp1;
669             if (k < header_length)
670                 b = header[k];
671             else if (k < data_plus_mac_plus_padding_size + header_length)
672                 b = data[k - header_length];
673             k++;
674
675             is_past_c = is_block_a & constant_time_ge_8(j, c);
676             is_past_cp1 = is_block_a & constant_time_ge_8(j, c + 1);
677             /*
678              * If this is the block containing the end of the application
679              * data, and we are at the offset for the 0x80 value, then
680              * overwrite b with 0x80.
681              */
682             b = constant_time_select_8(is_past_c, 0x80, b);
683             /*
684              * If this the the block containing the end of the application
685              * data and we're past the 0x80 value then just write zero.
686              */
687             b = b & ~is_past_cp1;
688             /*
689              * If this is index_b (the final block), but not index_a (the end
690              * of the data), then the 64-bit length didn't fit into index_a
691              * and we're having to add an extra block of zeros.
692              */
693             b &= ~is_block_b | is_block_a;
694
695             /*
696              * The final bytes of one of the blocks contains the length.
697              */
698             if (j >= md_block_size - md_length_size) {
699                 /* If this is index_b, write a length byte. */
700                 b = constant_time_select_8(is_block_b,
701                                            length_bytes[j -
702                                                         (md_block_size -
703                                                          md_length_size)], b);
704             }
705             block[j] = b;
706         }
707
708         md_transform(md_state.c, block);
709         md_final_raw(md_state.c, block);
710         /* If this is index_b, copy the hash value to |mac_out|. */
711         for (j = 0; j < md_size; j++)
712             mac_out[j] |= block[j] & is_block_b;
713     }
714
715     EVP_MD_CTX_init(&md_ctx);
716     EVP_DigestInit_ex(&md_ctx, ctx->digest, NULL /* engine */ );
717     if (is_sslv3) {
718         /* We repurpose |hmac_pad| to contain the SSLv3 pad2 block. */
719         memset(hmac_pad, 0x5c, sslv3_pad_length);
720
721         EVP_DigestUpdate(&md_ctx, mac_secret, mac_secret_length);
722         EVP_DigestUpdate(&md_ctx, hmac_pad, sslv3_pad_length);
723         EVP_DigestUpdate(&md_ctx, mac_out, md_size);
724     } else {
725         /* Complete the HMAC in the standard manner. */
726         for (i = 0; i < md_block_size; i++)
727             hmac_pad[i] ^= 0x6a;
728
729         EVP_DigestUpdate(&md_ctx, hmac_pad, md_block_size);
730         EVP_DigestUpdate(&md_ctx, mac_out, md_size);
731     }
732     EVP_DigestFinal(&md_ctx, md_out, &md_out_size_u);
733     if (md_out_size)
734         *md_out_size = md_out_size_u;
735     EVP_MD_CTX_cleanup(&md_ctx);
736 }