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