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