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