cipher: Move sha1 context definition to a separate file.
[libgcrypt.git] / cipher / sha1.c
1 /* sha1.c - SHA1 hash function
2  * Copyright (C) 1998, 2001, 2002, 2003, 2008 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20
21 /*  Test vectors:
22  *
23  *  "abc"
24  *  A999 3E36 4706 816A BA3E  2571 7850 C26C 9CD0 D89D
25  *
26  *  "abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"
27  *  8498 3E44 1C3B D26E BAAE  4AA1 F951 29E5 E546 70F1
28  */
29
30
31 #include <config.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #ifdef HAVE_STDINT_H
36 # include <stdint.h>
37 #endif
38
39 #include "g10lib.h"
40 #include "bithelp.h"
41 #include "bufhelp.h"
42 #include "cipher.h"
43 #include "sha1.h"
44
45
46 /* USE_SSSE3 indicates whether to compile with Intel SSSE3 code. */
47 #undef USE_SSSE3
48 #if defined(__x86_64__) && defined(HAVE_GCC_INLINE_ASM_SSSE3) && \
49     (defined(HAVE_COMPATIBLE_GCC_AMD64_PLATFORM_AS) || \
50      defined(HAVE_COMPATIBLE_GCC_WIN64_PLATFORM_AS))
51 # define USE_SSSE3 1
52 #endif
53
54 /* USE_AVX indicates whether to compile with Intel AVX code. */
55 #undef USE_AVX
56 #if defined(__x86_64__) && defined(HAVE_GCC_INLINE_ASM_AVX) && \
57     (defined(HAVE_COMPATIBLE_GCC_AMD64_PLATFORM_AS) || \
58      defined(HAVE_COMPATIBLE_GCC_WIN64_PLATFORM_AS))
59 # define USE_AVX 1
60 #endif
61
62 /* USE_BMI2 indicates whether to compile with Intel AVX/BMI2 code. */
63 #undef USE_BMI2
64 #if defined(__x86_64__) && defined(HAVE_GCC_INLINE_ASM_AVX) && \
65     defined(HAVE_GCC_INLINE_ASM_BMI2) && \
66     (defined(HAVE_COMPATIBLE_GCC_AMD64_PLATFORM_AS) || \
67      defined(HAVE_COMPATIBLE_GCC_WIN64_PLATFORM_AS))
68 # define USE_BMI2 1
69 #endif
70
71 /* USE_NEON indicates whether to enable ARM NEON assembly code. */
72 #undef USE_NEON
73 #ifdef ENABLE_NEON_SUPPORT
74 # if defined(HAVE_ARM_ARCH_V6) && defined(__ARMEL__) \
75      && defined(HAVE_COMPATIBLE_GCC_ARM_PLATFORM_AS) \
76      && defined(HAVE_GCC_INLINE_ASM_NEON)
77 #  define USE_NEON 1
78 # endif
79 #endif /*ENABLE_NEON_SUPPORT*/
80
81
82 /* A macro to test whether P is properly aligned for an u32 type.
83    Note that config.h provides a suitable replacement for uintptr_t if
84    it does not exist in stdint.h.  */
85 /* #if __GNUC__ >= 2 */
86 /* # define U32_ALIGNED_P(p) (!(((uintptr_t)p) % __alignof__ (u32))) */
87 /* #else */
88 /* # define U32_ALIGNED_P(p) (!(((uintptr_t)p) % sizeof (u32))) */
89 /* #endif */
90
91
92 static unsigned int
93 transform (void *c, const unsigned char *data, size_t nblks);
94
95
96 static void
97 sha1_init (void *context, unsigned int flags)
98 {
99   SHA1_CONTEXT *hd = context;
100   unsigned int features = _gcry_get_hw_features ();
101
102   (void)flags;
103
104   hd->h0 = 0x67452301;
105   hd->h1 = 0xefcdab89;
106   hd->h2 = 0x98badcfe;
107   hd->h3 = 0x10325476;
108   hd->h4 = 0xc3d2e1f0;
109
110   hd->bctx.nblocks = 0;
111   hd->bctx.nblocks_high = 0;
112   hd->bctx.count = 0;
113   hd->bctx.blocksize = 64;
114   hd->bctx.bwrite = transform;
115
116 #ifdef USE_SSSE3
117   hd->use_ssse3 = (features & HWF_INTEL_SSSE3) != 0;
118 #endif
119 #ifdef USE_AVX
120   /* AVX implementation uses SHLD which is known to be slow on non-Intel CPUs.
121    * Therefore use this implementation on Intel CPUs only. */
122   hd->use_avx = (features & HWF_INTEL_AVX) && (features & HWF_INTEL_FAST_SHLD);
123 #endif
124 #ifdef USE_BMI2
125   hd->use_bmi2 = (features & HWF_INTEL_AVX) && (features & HWF_INTEL_BMI2);
126 #endif
127 #ifdef USE_NEON
128   hd->use_neon = (features & HWF_ARM_NEON) != 0;
129 #endif
130   (void)features;
131 }
132
133
134 /* Round function macros. */
135 #define K1  0x5A827999L
136 #define K2  0x6ED9EBA1L
137 #define K3  0x8F1BBCDCL
138 #define K4  0xCA62C1D6L
139 #define F1(x,y,z)   ( z ^ ( x & ( y ^ z ) ) )
140 #define F2(x,y,z)   ( x ^ y ^ z )
141 #define F3(x,y,z)   ( ( x & y ) | ( z & ( x | y ) ) )
142 #define F4(x,y,z)   ( x ^ y ^ z )
143 #define M(i) ( tm =    x[ i    &0x0f]  \
144                      ^ x[(i-14)&0x0f]  \
145                      ^ x[(i-8) &0x0f]  \
146                      ^ x[(i-3) &0x0f], \
147                      (x[i&0x0f] = rol(tm, 1)))
148 #define R(a,b,c,d,e,f,k,m)  do { e += rol( a, 5 )     \
149                                       + f( b, c, d )  \
150                                       + k             \
151                                       + m;            \
152                                  b = rol( b, 30 );    \
153                                } while(0)
154
155
156
157 #ifdef USE_NEON
158 unsigned int
159 _gcry_sha1_transform_armv7_neon (void *state, const unsigned char *data,
160                                  size_t nblks);
161 #endif
162
163 /*
164  * Transform NBLOCKS of each 64 bytes (16 32-bit words) at DATA.
165  */
166 static unsigned int
167 transform_blk (void *ctx, const unsigned char *data)
168 {
169   SHA1_CONTEXT *hd = ctx;
170   const u32 *idata = (const void *)data;
171   register u32 a, b, c, d, e; /* Local copies of the chaining variables.  */
172   register u32 tm;            /* Helper.  */
173   u32 x[16];                  /* The array we work on. */
174
175 #define I(i) (x[i] = buf_get_be32(idata + i))
176
177       /* Get the values of the chaining variables. */
178       a = hd->h0;
179       b = hd->h1;
180       c = hd->h2;
181       d = hd->h3;
182       e = hd->h4;
183
184       /* Transform. */
185       R( a, b, c, d, e, F1, K1, I( 0) );
186       R( e, a, b, c, d, F1, K1, I( 1) );
187       R( d, e, a, b, c, F1, K1, I( 2) );
188       R( c, d, e, a, b, F1, K1, I( 3) );
189       R( b, c, d, e, a, F1, K1, I( 4) );
190       R( a, b, c, d, e, F1, K1, I( 5) );
191       R( e, a, b, c, d, F1, K1, I( 6) );
192       R( d, e, a, b, c, F1, K1, I( 7) );
193       R( c, d, e, a, b, F1, K1, I( 8) );
194       R( b, c, d, e, a, F1, K1, I( 9) );
195       R( a, b, c, d, e, F1, K1, I(10) );
196       R( e, a, b, c, d, F1, K1, I(11) );
197       R( d, e, a, b, c, F1, K1, I(12) );
198       R( c, d, e, a, b, F1, K1, I(13) );
199       R( b, c, d, e, a, F1, K1, I(14) );
200       R( a, b, c, d, e, F1, K1, I(15) );
201       R( e, a, b, c, d, F1, K1, M(16) );
202       R( d, e, a, b, c, F1, K1, M(17) );
203       R( c, d, e, a, b, F1, K1, M(18) );
204       R( b, c, d, e, a, F1, K1, M(19) );
205       R( a, b, c, d, e, F2, K2, M(20) );
206       R( e, a, b, c, d, F2, K2, M(21) );
207       R( d, e, a, b, c, F2, K2, M(22) );
208       R( c, d, e, a, b, F2, K2, M(23) );
209       R( b, c, d, e, a, F2, K2, M(24) );
210       R( a, b, c, d, e, F2, K2, M(25) );
211       R( e, a, b, c, d, F2, K2, M(26) );
212       R( d, e, a, b, c, F2, K2, M(27) );
213       R( c, d, e, a, b, F2, K2, M(28) );
214       R( b, c, d, e, a, F2, K2, M(29) );
215       R( a, b, c, d, e, F2, K2, M(30) );
216       R( e, a, b, c, d, F2, K2, M(31) );
217       R( d, e, a, b, c, F2, K2, M(32) );
218       R( c, d, e, a, b, F2, K2, M(33) );
219       R( b, c, d, e, a, F2, K2, M(34) );
220       R( a, b, c, d, e, F2, K2, M(35) );
221       R( e, a, b, c, d, F2, K2, M(36) );
222       R( d, e, a, b, c, F2, K2, M(37) );
223       R( c, d, e, a, b, F2, K2, M(38) );
224       R( b, c, d, e, a, F2, K2, M(39) );
225       R( a, b, c, d, e, F3, K3, M(40) );
226       R( e, a, b, c, d, F3, K3, M(41) );
227       R( d, e, a, b, c, F3, K3, M(42) );
228       R( c, d, e, a, b, F3, K3, M(43) );
229       R( b, c, d, e, a, F3, K3, M(44) );
230       R( a, b, c, d, e, F3, K3, M(45) );
231       R( e, a, b, c, d, F3, K3, M(46) );
232       R( d, e, a, b, c, F3, K3, M(47) );
233       R( c, d, e, a, b, F3, K3, M(48) );
234       R( b, c, d, e, a, F3, K3, M(49) );
235       R( a, b, c, d, e, F3, K3, M(50) );
236       R( e, a, b, c, d, F3, K3, M(51) );
237       R( d, e, a, b, c, F3, K3, M(52) );
238       R( c, d, e, a, b, F3, K3, M(53) );
239       R( b, c, d, e, a, F3, K3, M(54) );
240       R( a, b, c, d, e, F3, K3, M(55) );
241       R( e, a, b, c, d, F3, K3, M(56) );
242       R( d, e, a, b, c, F3, K3, M(57) );
243       R( c, d, e, a, b, F3, K3, M(58) );
244       R( b, c, d, e, a, F3, K3, M(59) );
245       R( a, b, c, d, e, F4, K4, M(60) );
246       R( e, a, b, c, d, F4, K4, M(61) );
247       R( d, e, a, b, c, F4, K4, M(62) );
248       R( c, d, e, a, b, F4, K4, M(63) );
249       R( b, c, d, e, a, F4, K4, M(64) );
250       R( a, b, c, d, e, F4, K4, M(65) );
251       R( e, a, b, c, d, F4, K4, M(66) );
252       R( d, e, a, b, c, F4, K4, M(67) );
253       R( c, d, e, a, b, F4, K4, M(68) );
254       R( b, c, d, e, a, F4, K4, M(69) );
255       R( a, b, c, d, e, F4, K4, M(70) );
256       R( e, a, b, c, d, F4, K4, M(71) );
257       R( d, e, a, b, c, F4, K4, M(72) );
258       R( c, d, e, a, b, F4, K4, M(73) );
259       R( b, c, d, e, a, F4, K4, M(74) );
260       R( a, b, c, d, e, F4, K4, M(75) );
261       R( e, a, b, c, d, F4, K4, M(76) );
262       R( d, e, a, b, c, F4, K4, M(77) );
263       R( c, d, e, a, b, F4, K4, M(78) );
264       R( b, c, d, e, a, F4, K4, M(79) );
265
266       /* Update the chaining variables. */
267       hd->h0 += a;
268       hd->h1 += b;
269       hd->h2 += c;
270       hd->h3 += d;
271       hd->h4 += e;
272
273   return /* burn_stack */ 88+4*sizeof(void*);
274 }
275
276
277 /* Assembly implementations use SystemV ABI, ABI conversion and additional
278  * stack to store XMM6-XMM15 needed on Win64. */
279 #undef ASM_FUNC_ABI
280 #undef ASM_EXTRA_STACK
281 #if defined(USE_SSSE3) || defined(USE_AVX) || defined(USE_BMI2)
282 # ifdef HAVE_COMPATIBLE_GCC_WIN64_PLATFORM_AS
283 #  define ASM_FUNC_ABI __attribute__((sysv_abi))
284 #  define ASM_EXTRA_STACK (10 * 16)
285 # else
286 #  define ASM_FUNC_ABI
287 #  define ASM_EXTRA_STACK 0
288 # endif
289 #endif
290
291
292 #ifdef USE_SSSE3
293 unsigned int
294 _gcry_sha1_transform_amd64_ssse3 (void *state, const unsigned char *data,
295                                   size_t nblks) ASM_FUNC_ABI;
296 #endif
297
298 #ifdef USE_AVX
299 unsigned int
300 _gcry_sha1_transform_amd64_avx (void *state, const unsigned char *data,
301                                  size_t nblks) ASM_FUNC_ABI;
302 #endif
303
304 #ifdef USE_BMI2
305 unsigned int
306 _gcry_sha1_transform_amd64_avx_bmi2 (void *state, const unsigned char *data,
307                                      size_t nblks) ASM_FUNC_ABI;
308 #endif
309
310
311 static unsigned int
312 transform (void *ctx, const unsigned char *data, size_t nblks)
313 {
314   SHA1_CONTEXT *hd = ctx;
315   unsigned int burn;
316
317 #ifdef USE_BMI2
318   if (hd->use_bmi2)
319     return _gcry_sha1_transform_amd64_avx_bmi2 (&hd->h0, data, nblks)
320            + 4 * sizeof(void*) + ASM_EXTRA_STACK;
321 #endif
322 #ifdef USE_AVX
323   if (hd->use_avx)
324     return _gcry_sha1_transform_amd64_avx (&hd->h0, data, nblks)
325            + 4 * sizeof(void*) + ASM_EXTRA_STACK;
326 #endif
327 #ifdef USE_SSSE3
328   if (hd->use_ssse3)
329     return _gcry_sha1_transform_amd64_ssse3 (&hd->h0, data, nblks)
330            + 4 * sizeof(void*) + ASM_EXTRA_STACK;
331 #endif
332 #ifdef USE_NEON
333   if (hd->use_neon)
334     return _gcry_sha1_transform_armv7_neon (&hd->h0, data, nblks)
335            + 4 * sizeof(void*);
336 #endif
337
338   do
339     {
340       burn = transform_blk (hd, data);
341       data += 64;
342     }
343   while (--nblks);
344
345 #ifdef ASM_EXTRA_STACK
346   /* 'transform_blk' is typically inlined and XMM6-XMM15 are stored at
347    *  the prologue of this function. Therefore need to add ASM_EXTRA_STACK to
348    *  here too.
349    */
350   burn += ASM_EXTRA_STACK;
351 #endif
352
353   return burn;
354 }
355
356
357 /* The routine final terminates the computation and
358  * returns the digest.
359  * The handle is prepared for a new cycle, but adding bytes to the
360  * handle will the destroy the returned buffer.
361  * Returns: 20 bytes representing the digest.
362  */
363
364 static void
365 sha1_final(void *context)
366 {
367   SHA1_CONTEXT *hd = context;
368   u32 t, th, msb, lsb;
369   unsigned char *p;
370   unsigned int burn;
371
372   _gcry_md_block_write (hd, NULL, 0); /* flush */;
373
374   t = hd->bctx.nblocks;
375   if (sizeof t == sizeof hd->bctx.nblocks)
376     th = hd->bctx.nblocks_high;
377   else
378     th = hd->bctx.nblocks >> 32;
379
380   /* multiply by 64 to make a byte count */
381   lsb = t << 6;
382   msb = (th << 6) | (t >> 26);
383   /* add the count */
384   t = lsb;
385   if( (lsb += hd->bctx.count) < t )
386     msb++;
387   /* multiply by 8 to make a bit count */
388   t = lsb;
389   lsb <<= 3;
390   msb <<= 3;
391   msb |= t >> 29;
392
393   if( hd->bctx.count < 56 )  /* enough room */
394     {
395       hd->bctx.buf[hd->bctx.count++] = 0x80; /* pad */
396       while( hd->bctx.count < 56 )
397         hd->bctx.buf[hd->bctx.count++] = 0;  /* pad */
398     }
399   else  /* need one extra block */
400     {
401       hd->bctx.buf[hd->bctx.count++] = 0x80; /* pad character */
402       while( hd->bctx.count < 64 )
403         hd->bctx.buf[hd->bctx.count++] = 0;
404       _gcry_md_block_write(hd, NULL, 0);  /* flush */;
405       memset(hd->bctx.buf, 0, 56 ); /* fill next block with zeroes */
406     }
407   /* append the 64 bit count */
408   buf_put_be32(hd->bctx.buf + 56, msb);
409   buf_put_be32(hd->bctx.buf + 60, lsb);
410   burn = transform( hd, hd->bctx.buf, 1 );
411   _gcry_burn_stack (burn);
412
413   p = hd->bctx.buf;
414 #define X(a) do { buf_put_be32(p, hd->h##a); p += 4; } while(0)
415   X(0);
416   X(1);
417   X(2);
418   X(3);
419   X(4);
420 #undef X
421
422 }
423
424 static unsigned char *
425 sha1_read( void *context )
426 {
427   SHA1_CONTEXT *hd = context;
428
429   return hd->bctx.buf;
430 }
431
432 /****************
433  * Shortcut functions which puts the hash value of the supplied buffer
434  * into outbuf which must have a size of 20 bytes.
435  */
436 void
437 _gcry_sha1_hash_buffer (void *outbuf, const void *buffer, size_t length)
438 {
439   SHA1_CONTEXT hd;
440
441   sha1_init (&hd, 0);
442   _gcry_md_block_write (&hd, buffer, length);
443   sha1_final (&hd);
444   memcpy (outbuf, hd.bctx.buf, 20);
445 }
446
447
448 /* Variant of the above shortcut function using a multiple buffers.  */
449 void
450 _gcry_sha1_hash_buffers (void *outbuf, const gcry_buffer_t *iov, int iovcnt)
451 {
452   SHA1_CONTEXT hd;
453
454   sha1_init (&hd, 0);
455   for (;iovcnt > 0; iov++, iovcnt--)
456     _gcry_md_block_write (&hd,
457                           (const char*)iov[0].data + iov[0].off, iov[0].len);
458   sha1_final (&hd);
459   memcpy (outbuf, hd.bctx.buf, 20);
460 }
461
462
463 \f
464 /*
465      Self-test section.
466  */
467
468
469 static gpg_err_code_t
470 selftests_sha1 (int extended, selftest_report_func_t report)
471 {
472   const char *what;
473   const char *errtxt;
474
475   what = "short string";
476   errtxt = _gcry_hash_selftest_check_one
477     (GCRY_MD_SHA1, 0,
478      "abc", 3,
479      "\xA9\x99\x3E\x36\x47\x06\x81\x6A\xBA\x3E"
480      "\x25\x71\x78\x50\xC2\x6C\x9C\xD0\xD8\x9D", 20);
481   if (errtxt)
482     goto failed;
483
484   if (extended)
485     {
486       what = "long string";
487       errtxt = _gcry_hash_selftest_check_one
488         (GCRY_MD_SHA1, 0,
489          "abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq", 56,
490          "\x84\x98\x3E\x44\x1C\x3B\xD2\x6E\xBA\xAE"
491          "\x4A\xA1\xF9\x51\x29\xE5\xE5\x46\x70\xF1", 20);
492       if (errtxt)
493         goto failed;
494
495       what = "one million \"a\"";
496       errtxt = _gcry_hash_selftest_check_one
497         (GCRY_MD_SHA1, 1,
498          NULL, 0,
499          "\x34\xAA\x97\x3C\xD4\xC4\xDA\xA4\xF6\x1E"
500          "\xEB\x2B\xDB\xAD\x27\x31\x65\x34\x01\x6F", 20);
501       if (errtxt)
502         goto failed;
503     }
504
505   return 0; /* Succeeded. */
506
507  failed:
508   if (report)
509     report ("digest", GCRY_MD_SHA1, what, errtxt);
510   return GPG_ERR_SELFTEST_FAILED;
511 }
512
513
514 /* Run a full self-test for ALGO and return 0 on success.  */
515 static gpg_err_code_t
516 run_selftests (int algo, int extended, selftest_report_func_t report)
517 {
518   gpg_err_code_t ec;
519
520   switch (algo)
521     {
522     case GCRY_MD_SHA1:
523       ec = selftests_sha1 (extended, report);
524       break;
525     default:
526       ec = GPG_ERR_DIGEST_ALGO;
527       break;
528
529     }
530   return ec;
531 }
532
533
534
535 \f
536 static unsigned char asn[15] = /* Object ID is 1.3.14.3.2.26 */
537   { 0x30, 0x21, 0x30, 0x09, 0x06, 0x05, 0x2b, 0x0e, 0x03,
538     0x02, 0x1a, 0x05, 0x00, 0x04, 0x14 };
539
540 static gcry_md_oid_spec_t oid_spec_sha1[] =
541   {
542     /* iso.member-body.us.rsadsi.pkcs.pkcs-1.5 (sha1WithRSAEncryption) */
543     { "1.2.840.113549.1.1.5" },
544     /* iso.member-body.us.x9-57.x9cm.3 (dsaWithSha1)*/
545     { "1.2.840.10040.4.3" },
546     /* from NIST's OIW  (sha1) */
547     { "1.3.14.3.2.26" },
548     /* from NIST OIW (sha-1WithRSAEncryption) */
549     { "1.3.14.3.2.29" },
550     /* iso.member-body.us.ansi-x9-62.signatures.ecdsa-with-sha1 */
551     { "1.2.840.10045.4.1" },
552     { NULL },
553   };
554
555 gcry_md_spec_t _gcry_digest_spec_sha1 =
556   {
557     GCRY_MD_SHA1, {0, 1},
558     "SHA1", asn, DIM (asn), oid_spec_sha1, 20,
559     sha1_init, _gcry_md_block_write, sha1_final, sha1_read, NULL,
560     sizeof (SHA1_CONTEXT),
561     run_selftests
562   };