doc: add mention about aligning data to cachelines for best performance
[libgcrypt.git] / tests / hashtest.c
1 /* hashtest.c - Check the hash functions
2  * Copyright (C) 2013 g10 Code GmbH
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 #ifdef HAVE_CONFIG_H
21 #include <config.h>
22 #endif
23 #include <stdarg.h>
24 #include <stdio.h>
25 #include <ctype.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <errno.h>
29
30 #include "../src/gcrypt-int.h"
31
32 #include "stopwatch.h"
33
34 #define PGM "hashtest"
35 #include "t-common.h"
36
37 static int missing_test_vectors;
38
39 static struct {
40   int algo;
41   int gigs;
42   int bytes;
43   const char *hex;
44 } testvectors[] = {
45   { GCRY_MD_SHA1, 256, -64, "92fc51850c7b750e6e774b75f294f6979d4059f0" },
46   { GCRY_MD_SHA1, 256,  -1, "4bddeeb4c08683f02d4944d93dbcb02ebab50134" },
47   { GCRY_MD_SHA1, 256,  -0, "71b923afde1c8c040884c723a2e3335b333e64c6" },
48   { GCRY_MD_SHA1, 256,   1, "2d99f9b5b86e9c9c937104f4242bd6b8bc0927ef" },
49   { GCRY_MD_SHA1, 256,  64, "a60dabe8d749f798b7ec3a684cc3eab487451482" },
50
51   { GCRY_MD_SHA224, 256, -64,
52     "b5672b54d2480a5688a2dc727a1ad4db7a81ef31ce8999e0bbaeffdc" },
53   { GCRY_MD_SHA224, 256,  -1,
54     "814ea7159473e6ffc1c64b90026a542e13ac6980f7f3ca3c4582a9b8" },
55   { GCRY_MD_SHA224, 256,   0,
56     "9ec0e1829455db8650ec7a8b06912196f97a7358bc3a73c79911cd4e" },
57   { GCRY_MD_SHA224, 256,   1,
58     "e578d5d523320876565bbbc892511a485427caee6dd754d57e3e58c2" },
59   { GCRY_MD_SHA224, 256,  64,
60     "ff0464df248cd298b63765bc4f87f21e25c93c657fdf3656d3c878e5" },
61
62   { GCRY_MD_SHA256, 256, -64,
63     "87a9828d3de78d55d252341db2a622908c4e0ceaee9961ecf9768700fc799ec8" },
64   { GCRY_MD_SHA256, 256,  -1,
65     "823bf95f64ef04a4a77579c38760b1d401b56bf3a8e664bdf56ca15afb468a03" },
66   { GCRY_MD_SHA256, 256,   0,
67     "2d0723878cb2c3d5c59dfad910cdb857f4430a6ba2a7d687938d7a20e63dde47" },
68   { GCRY_MD_SHA256, 256,   1,
69     "5a2e21b1e79cd866acf53a2a18ca76bd4e02c4b01bf4627354171824c812d95f" },
70   { GCRY_MD_SHA256, 256,  64,
71     "34444808af8e9d995e67f9e155ed94bf55f195a51dc1d8a989e6bcf95511c8a2" },
72
73   { GCRY_MD_SHA512, 256, -64,
74     "e01bf8140874bf240e8426cb2bcbc377cbed2e6037334116637149e1cd8cd462"
75     "96828b71f32b9f002771d4cb51172ce578b73b7939221e4df655ecd08601e655" },
76   { GCRY_MD_SHA512, 256,  -1,
77     "4917ff94514b1757705c289fdc3e7d6ffcce5771b20ae237ebc03d2ec9eb435f"
78     "b7ce9f0e27272be8cced77a5edae1a01a0ad62b0a44169d88bbee45474a17734" },
79   { GCRY_MD_SHA512, 256,   0,
80     "1e28e8b3c79f2f47da11f3c0b7da4e7981e7d932db6d17d528a31e191922edda"
81     "8fc4bb2df10ea876232db5a1c606bc41886e8b2c570a3e721221f60c8c7dc4ab" },
82   { GCRY_MD_SHA512, 256,   1,
83     "027d3324dd1cf127770ceb53681f4c70937c9bca4e3acd5fd76cb266c7d4527d"
84     "58140290a1822e8d60c4d3ae9725fb923183230d6dfd2d7d73c0d74a4757f34a" },
85   { GCRY_MD_SHA512, 256,  64,
86     "49920704ea9d6ee19f0742d6c868110fa3eda8ac09f026e9ef22cc731af53020"
87     "de40eedef66cb1afd94c61e285fa9327e01336e804903740a9145ab1f065c2d5" },
88
89   { GCRY_MD_SHA3_512, 256, -64,
90     "c6e082b3db996dbe5f2c5709818a7f325ef4febd883d7e9c545c06bfa7225198"
91     "1ecf40103788913cd5a5bdf13246b952ded6651043684b24197eb23544882a97" },
92   { GCRY_MD_SHA3_512, 256,  -1,
93     "d7bf28e8216bf7d3d0d3969e34078e94b98598e17b6f21f256379389e4eba8ee"
94     "74eb288774797263fec00bdfd357d132cea9e408be36b982f5a60ab56ad01613" },
95   { GCRY_MD_SHA3_512, 256,  +0,
96     "c1270852ba7b1e1a3eaa777969b8a65be28c3894537c61eb8cd22b1df6af703d"
97     "b59939f6adadeb64317faece8167d4817e73daf73e28a5ccd26bebee0a35c322" },
98   { GCRY_MD_SHA3_512, 256,  +1,
99     "8bdfeb3a1a9a1cdcef21172cbc5bb3b87c0d8f7111df0aaf7f1bc03ad4775bd6"
100     "a03e0a875c4e7d02d2230c213562c6a57be28d92eaf6e4bea4bc24690454c8ef" },
101   { GCRY_MD_SHA3_512, 256, +64,
102     "0c91b91665ceaf7af5102e0ed31aa4f050668ab3c57b1f4763946d567efe66b3"
103     "ab9a2016cf238dee5b44eae9f0cdfbf7b7a6eb1e759986273243dc35894706b6" },
104
105   { GCRY_MD_SM3, 256, -64,
106     "4ceb893abeb43965d4cac7626da9a4be895585b5b2f16f302626801308b1c02a" },
107   { GCRY_MD_SM3, 256, -1,
108     "825f01e4f2b6084136abc356fa1b343a9411d844a4dc1474293aad817cd2a48f" },
109   { GCRY_MD_SM3, 256, +0,
110     "d948a4025ac3ea0aa8989f43203411bd22ad17eaa5fd92ebdf9cabf869f1ba1b" },
111   { GCRY_MD_SM3, 256, +1,
112     "4f6d0e260299c1f286ef1dbb4638a0770979f266b6c007c55410ee6849cba2a8" },
113   { GCRY_MD_SM3, 256, +64,
114     "ed34869dbadd62e3bec1f511004d7bbfc9cafa965477cc48843b248293bbe867" },
115
116   { 0 }
117 };
118
119
120 static void
121 showhex (const void *buffer, size_t buflen, const char *format, ...)
122 {
123   va_list arg_ptr;
124   const unsigned char *s;
125
126   fprintf (stderr, "%s: ", PGM);
127   va_start (arg_ptr, format);
128   vfprintf (stderr, format, arg_ptr);
129   va_end (arg_ptr);
130
131   for (s=buffer; buflen; buflen--, s++)
132     fprintf (stderr, "%02x", *s);
133   putc ('\n', stderr);
134 }
135
136
137 static void
138 show_note (const char *format, ...)
139 {
140   va_list arg_ptr;
141
142   if (!verbose && getenv ("srcdir"))
143     fputs ("      ", stderr);  /* To align above "PASS: ".  */
144   else
145     fprintf (stderr, "%s: ", PGM);
146   va_start (arg_ptr, format);
147   vfprintf (stderr, format, arg_ptr);
148   if (*format && format[strlen(format)-1] != '\n')
149     putc ('\n', stderr);
150   va_end (arg_ptr);
151 }
152
153 /* Convert STRING consisting of hex characters into its binary
154    representation and return it as an allocated buffer. The valid
155    length of the buffer is returned at R_LENGTH.  The string is
156    delimited by end of string.  The function returns NULL on
157    error.  */
158 static void *
159 hex2buffer (const char *string, size_t *r_length)
160 {
161   const char *s;
162   unsigned char *buffer;
163   size_t length;
164
165   buffer = xmalloc (strlen(string)/2+1);
166   length = 0;
167   for (s=string; *s; s +=2 )
168     {
169       if (!hexdigitp (s) || !hexdigitp (s+1))
170         return NULL;           /* Invalid hex digits. */
171       ((unsigned char*)buffer)[length++] = xtoi_2 (s);
172     }
173   *r_length = length;
174   return buffer;
175 }
176
177
178 static void
179 run_selftest (int algo)
180 {
181   gpg_error_t err;
182   size_t n;
183
184   n = 1;
185   err = gcry_md_algo_info (algo, GCRYCTL_SELFTEST, NULL, &n);
186   if (err && gpg_err_code (err) != GPG_ERR_NOT_IMPLEMENTED)
187     fail ("extended selftest for %s (%d) failed: %s",
188           gcry_md_algo_name (algo), algo, gpg_strerror (err));
189   else if (err && verbose)
190     info ("extended selftest for %s (%d) not implemented",
191           gcry_md_algo_name (algo), algo);
192   else if (verbose)
193     info ("extended selftest for %s (%d) passed",
194           gcry_md_algo_name (algo), algo);
195 }
196
197 /* Compare DIGEST of length DIGESTLEN generated using ALGO and GIGS
198    plus BYTES with the test vector and print an error message if the
199    don't match.  Return 0 on match.  */
200 static int
201 cmp_digest (const unsigned char *digest, size_t digestlen,
202             int algo, int gigs, int bytes)
203 {
204   int idx;
205   unsigned char *tv_digest;
206   size_t tv_digestlen = 0;
207
208   for (idx=0; testvectors[idx].algo; idx++)
209     {
210       if (testvectors[idx].algo == algo
211           && testvectors[idx].gigs == gigs
212           && testvectors[idx].bytes == bytes)
213         break;
214     }
215   if (!testvectors[idx].algo)
216     {
217       info ("%d GiB %+3d %-10s warning: %s",
218             gigs, bytes, gcry_md_algo_name (algo), "no test vector");
219       missing_test_vectors++;
220       return 1;
221     }
222
223   tv_digest = hex2buffer (testvectors[idx].hex, &tv_digestlen);
224   if (tv_digestlen != digestlen) /* Ooops.  */
225     {
226       fail ("%d GiB %+3d %-10s error: %s",
227             gigs, bytes, gcry_md_algo_name (algo), "digest length mismatch");
228       xfree (tv_digest);
229       return 1;
230     }
231   if (memcmp (tv_digest, digest, tv_digestlen))
232     {
233       fail ("%d GiB %+3d %-10s error: %s",
234             gigs, bytes, gcry_md_algo_name (algo), "mismatch");
235       xfree (tv_digest);
236       return 1;
237     }
238   xfree (tv_digest);
239
240   return 0;
241 }
242
243
244 static void
245 run_longtest (int algo, int gigs)
246 {
247   gpg_error_t err;
248   gcry_md_hd_t hd;
249   gcry_md_hd_t hd_pre = NULL;
250   gcry_md_hd_t hd_pre2 = NULL;
251   gcry_md_hd_t hd_post = NULL;
252   gcry_md_hd_t hd_post2 = NULL;
253   char pattern[1024];
254   int i, g;
255   const unsigned char *digest;
256   unsigned int digestlen;
257
258   memset (pattern, 'a', sizeof pattern);
259
260   err = gcry_md_open (&hd, algo, 0);
261   if (err)
262     {
263       fail ("gcry_md_open failed for %s (%d): %s",
264             gcry_md_algo_name (algo), algo, gpg_strerror (err));
265       return;
266     }
267
268   digestlen = gcry_md_get_algo_dlen (algo);
269
270
271   for (g=0; g < gigs; g++)
272     {
273       if (g == gigs - 1)
274         {
275           for (i = 0; i < 1024*1023; i++)
276             gcry_md_write (hd, pattern, sizeof pattern);
277           for (i = 0; i < 1023; i++)
278             gcry_md_write (hd, pattern, sizeof pattern);
279           err = gcry_md_copy (&hd_pre, hd);
280           if (!err)
281             err = gcry_md_copy (&hd_pre2, hd);
282           if (err)
283             die ("gcry_md_copy failed for %s (%d): %s",
284                  gcry_md_algo_name (algo), algo, gpg_strerror (err));
285           gcry_md_write (hd, pattern, sizeof pattern);
286         }
287       else
288         {
289           for (i = 0; i < 1024*1024; i++)
290             gcry_md_write (hd, pattern, sizeof pattern);
291         }
292       if (g && !(g % 16))
293         show_note ("%d GiB so far hashed with %s", g, gcry_md_algo_name (algo));
294     }
295   if (g >= 16)
296     show_note ("%d GiB hashed with %s", g, gcry_md_algo_name (algo));
297
298   err = gcry_md_copy (&hd_post, hd);
299   if (err)
300     die ("gcry_md_copy failed for %s (%d): %s",
301          gcry_md_algo_name (algo), algo, gpg_strerror (err));
302   err = gcry_md_copy (&hd_post2, hd);
303   if (err)
304     die ("gcry_md_copy failed for %s (%d): %s",
305          gcry_md_algo_name (algo), algo, gpg_strerror (err));
306
307   gcry_md_write (hd_pre2, pattern, sizeof pattern - 64);
308   gcry_md_write (hd_pre, pattern, sizeof pattern - 1);
309   gcry_md_write (hd_post, pattern, 1);
310   gcry_md_write (hd_post2, pattern, 64);
311
312   digest = gcry_md_read (hd_pre2, algo);
313   if (cmp_digest (digest, digestlen, algo, gigs, -64) || verbose)
314     showhex (digest, digestlen, "%d GiB %+3d %-10s ",
315              gigs, -64, gcry_md_algo_name (algo));
316   digest = gcry_md_read (hd_pre, algo);
317   if (cmp_digest (digest, digestlen, algo, gigs, -1) || verbose)
318     showhex (digest, digestlen, "%d GiB %+3d %-10s ",
319              gigs, -1, gcry_md_algo_name (algo));
320   digest = gcry_md_read (hd, algo);
321   if (cmp_digest (digest, digestlen, algo, gigs, 0) || verbose)
322     showhex (digest, digestlen, "%d GiB %+3d %-10s ",
323              gigs, 0, gcry_md_algo_name (algo));
324   digest = gcry_md_read (hd_post, algo);
325   if (cmp_digest (digest, digestlen, algo, gigs, 1) || verbose)
326     showhex (digest, digestlen, "%d GiB %+3d %-10s ",
327              gigs, 1, gcry_md_algo_name (algo));
328   digest = gcry_md_read (hd_post2, algo);
329   if (cmp_digest (digest, digestlen, algo, gigs, 64) || verbose)
330     showhex (digest, digestlen, "%d GiB %+3d %-10s ",
331              gigs, 64, gcry_md_algo_name (algo));
332
333   gcry_md_close (hd);
334   gcry_md_close (hd_pre);
335   gcry_md_close (hd_pre2);
336   gcry_md_close (hd_post);
337   gcry_md_close (hd_post2);
338 }
339
340
341 int
342 main (int argc, char **argv)
343 {
344   int last_argc = -1;
345   int gigs = 0;
346   int algo = 0;
347   int idx;
348
349   if (argc)
350     { argc--; argv++; }
351
352   while (argc && last_argc != argc )
353     {
354       last_argc = argc;
355       if (!strcmp (*argv, "--"))
356         {
357           argc--; argv++;
358           break;
359         }
360       else if (!strcmp (*argv, "--help"))
361         {
362           fputs ("usage: " PGM " [options] [algos]\n"
363                  "Options:\n"
364                  "  --verbose       print timings etc.\n"
365                  "  --debug         flyswatter\n"
366                  "  --gigs N        Run a test on N GiB\n",
367                  stdout);
368           exit (0);
369         }
370       else if (!strcmp (*argv, "--verbose"))
371         {
372           verbose++;
373           argc--; argv++;
374         }
375       else if (!strcmp (*argv, "--debug"))
376         {
377           verbose += 2;
378           debug++;
379           argc--; argv++;
380         }
381       else if (!strcmp (*argv, "--gigs"))
382         {
383           argc--; argv++;
384           if (argc)
385             {
386               gigs = atoi (*argv);
387               argc--; argv++;
388             }
389         }
390       else if (!strncmp (*argv, "--", 2))
391         die ("unknown option '%s'", *argv);
392     }
393
394   if (gigs < 0 || gigs > 1024*1024)
395     die ("value for --gigs must be in the range 0 to %d", 1024*1024);
396
397   xgcry_control (GCRYCTL_DISABLE_SECMEM, 0);
398   if (!gcry_check_version (GCRYPT_VERSION))
399     die ("version mismatch\n");
400   if (debug)
401     xgcry_control (GCRYCTL_SET_DEBUG_FLAGS, 1u , 0);
402   xgcry_control (GCRYCTL_ENABLE_QUICK_RANDOM, 0);
403   xgcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
404
405   /* A quick check that all given algorithms are valid.  */
406   for (idx=0; idx < argc; idx++)
407     {
408       algo = gcry_md_map_name (argv[idx]);
409       if (!algo)
410         fail ("invalid algorithm '%s'", argv[idx]);
411     }
412   if (error_count)
413     exit (1);
414
415   /* Start checking.  */
416   start_timer ();
417   if (!argc)
418     {
419       for (algo=1; algo < 400; algo++)
420         if (!gcry_md_test_algo (algo))
421           {
422             if (!gigs)
423               run_selftest (algo);
424             else
425               run_longtest (algo, gigs);
426           }
427      }
428   else
429     {
430       for (idx=0; idx < argc; idx++)
431         {
432           algo = gcry_md_map_name (argv[idx]);
433           if (!algo)
434             die ("invalid algorithm '%s'", argv[idx]);
435
436           if (!gigs)
437             run_selftest (algo);
438           else
439             run_longtest (algo, gigs);
440         }
441     }
442   stop_timer ();
443
444   if (missing_test_vectors)
445     fail ("Some test vectors are missing");
446
447   if (verbose)
448     info ("All tests completed in %s.  Errors: %d\n",
449           elapsed_time (1), error_count);
450   return !!error_count;
451 }