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