Implemented gcry_mpi_lshift.
[libgcrypt.git] / tests / t-mpi-bit.c
1 /* t-mpi-bit.c  - Tests for bit level functions
2  * Copyright (C) 2006 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
19  * MA 02110-1301, USA.
20  */
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <assert.h>
29 #include <stdarg.h>
30
31 #include "../src/gcrypt.h"
32
33 #define PGM "t-mpi-bit"
34
35 static const char *wherestr;
36 static int verbose;
37 static int error_count;
38
39 #define xmalloc(a)    gcry_xmalloc ((a))
40 #define xcalloc(a,b)  gcry_xcalloc ((a),(b))
41 #define xfree(a)      gcry_free ((a))
42 #define pass() do { ; } while (0)
43
44 static void
45 show (const char *format, ...)
46 {
47   va_list arg_ptr;
48
49   if (!verbose)
50     return;
51   fprintf (stderr, "%s: ", PGM);
52   va_start (arg_ptr, format);
53   vfprintf (stderr, format, arg_ptr);
54   va_end (arg_ptr);
55 }
56
57 static void
58 fail (const char *format, ...)
59 {
60   va_list arg_ptr;
61
62   fflush (stdout);
63   fprintf (stderr, "%s: ", PGM);
64   if (wherestr)
65     fprintf (stderr, "%s: ", wherestr);
66   va_start (arg_ptr, format);
67   vfprintf (stderr, format, arg_ptr);
68   va_end (arg_ptr);
69   error_count++;
70 }
71
72 static void
73 die (const char *format, ...)
74 {
75   va_list arg_ptr;
76
77   fflush (stdout);
78   fprintf (stderr, "%s: ", PGM);
79   if (wherestr)
80     fprintf (stderr, "%s: ", wherestr);
81   va_start (arg_ptr, format);
82   vfprintf (stderr, format, arg_ptr);
83   va_end (arg_ptr);
84   exit (1);
85 }
86
87 /* Allocate a bit string consisting of '0' and '1' from the MPI
88    A. Return the LENGTH least significant bits. Caller needs to xfree
89    the result. */
90 static char *
91 mpi2bitstr (gcry_mpi_t a, size_t length)
92 {
93   char *p, *buf;
94   
95   buf = p = xmalloc (length+1);
96   while (length--)
97     *p++ = gcry_mpi_test_bit (a, length) ? '1':'0';
98   *p = 0;
99
100   return buf;
101 }
102
103 /* Allocate a bit string consisting of '0' and '1' from the MPI A.  Do
104    not return any leading zero bits. Caller needs to xfree the
105    result. */
106 static char *
107 mpi2bitstr_nlz (gcry_mpi_t a)
108 {
109   char *p, *buf;
110   size_t length = gcry_mpi_get_nbits (a);
111   
112   buf = p = xmalloc (length + 1);
113   while (length-- > 1)
114     *p++ = gcry_mpi_test_bit (a, length) ? '1':'0';
115   *p++ = gcry_mpi_test_bit (a, 0) ? '1':'0';
116   *p = 0;
117
118   return buf;
119 }
120
121 /* Shift a bit string to the right. */
122 static void
123 rshiftbitstring (char *string, size_t n)
124 {
125   size_t len = strlen (string);
126
127   if (n > len)
128     n = len;
129
130   memmove (string+n, string, len-n);
131   memset (string, '0', n);
132 }
133
134 /* Shift a bit string to the left. Caller needs to free the result. */
135 static char *
136 lshiftbitstring (const char *string, size_t n)
137 {
138   size_t len = strlen (string);
139   char *result;
140
141   if (len+n+1 < len)
142     die ("internal overflow\n");
143   /* Allocate enough space. */ 
144   result = xmalloc (len+n+1);
145   for (; *string == '0' && string[1]; string++, len--)
146     ;
147   memcpy (result, string, len);
148   if (*string == '0' && !string[1])
149     n = 0; /* Avoid extra nulls for an only 0 string.  */
150   else
151     memset (result+len, '0', n);
152   result[len+n] = 0;
153   return result;
154 }
155
156
157 /* This is to check a bug reported by bpgcrypt at itaparica.org on
158    2006-07-31 against libgcrypt 1.2.2.  */
159 static void
160 one_bit_only (int highbit)
161 {
162   gcry_mpi_t a;
163   char *result;
164   int i;
165
166   wherestr = "one_bit_only";
167   show ("checking that set_%sbit does only set one bit\n", highbit?"high":"");
168
169   a = gcry_mpi_new (0);
170   gcry_mpi_randomize (a, 70, GCRY_WEAK_RANDOM);
171   gcry_mpi_set_ui (a, 0);
172
173   if (highbit)
174     gcry_mpi_set_highbit (a, 42);
175   else
176     gcry_mpi_set_bit (a, 42);
177   if (!gcry_mpi_test_bit (a, 42))
178     fail ("failed to set a bit\n");
179   gcry_mpi_clear_bit (a, 42);
180   if (gcry_mpi_test_bit (a, 42))
181     fail ("failed to clear a bit\n");
182   result = mpi2bitstr (a, 70);
183   assert (strlen (result) == 70);
184   for (i=0; result[i]; i++)
185     if ( result[i] != '0' )
186       break;
187   if (result[i])
188     fail ("spurious bits detected\n");
189   xfree (result);
190   gcry_mpi_release (a);
191 }
192
193 /* Check that the shifting actually works for an amount larger than
194    the number of bits per limb. */
195 static void
196 test_rshift (int pass)
197 {
198   gcry_mpi_t a, b;
199   char *result, *result2;
200   int i;
201
202   wherestr = "test_rshift";
203   show ("checking that rshift works as expected (pass %d)\n", pass);
204
205   a = gcry_mpi_new (0);
206   b = gcry_mpi_new (0);
207   gcry_mpi_randomize (a, 70, GCRY_WEAK_RANDOM);
208
209   for (i=0; i < 75; i++)
210     {
211       gcry_mpi_rshift (b, a, i);
212
213       result = mpi2bitstr (b, 72);
214       result2 = mpi2bitstr (a, 72);
215       rshiftbitstring (result2, i);
216       if (strcmp (result, result2))
217         {
218           show ("got =%s\n", result);
219           show ("want=%s\n", result2);
220           fail ("rshift by %d failed\n", i);
221         }
222       xfree (result);
223       xfree (result2);
224     }
225
226   /* Again. This time using in-place operation. */
227   gcry_mpi_randomize (a, 70, GCRY_WEAK_RANDOM);
228
229   for (i=0; i < 75; i++)
230     {
231       gcry_mpi_release (b);
232       b = gcry_mpi_copy (a);
233       gcry_mpi_rshift (b, b, i);
234
235       result = mpi2bitstr (b, 72);
236       result2 = mpi2bitstr (a, 72);
237       rshiftbitstring (result2, i);
238       if (strcmp (result, result2))
239         {
240           show ("got =%s\n", result);
241           show ("want=%s\n", result2);
242           fail ("in-place rshift by %d failed\n", i);
243         }
244       xfree (result2);
245       xfree (result);
246     }
247
248   gcry_mpi_release (b);
249   gcry_mpi_release (a);
250 }
251
252 /* Check that the left shifting.  */
253 static void
254 test_lshift (int pass)
255 {
256   static int size_list[] = {1, 31, 32, 63, 64, 65, 70, 0};
257   int size_idx;
258   gcry_mpi_t a, b;
259   char *tmpstr, *result, *result2;
260   int i;
261
262   wherestr = "test_lshift";
263   show ("checking that lshift works as expected (pass %d)\n", pass);
264
265   for (size_idx=0; size_list[size_idx]; size_idx++)
266     {
267       a = gcry_mpi_new (0);
268       b = gcry_mpi_new (0);
269
270       /* gcry_mpi_randomize rounds up to full bytes, thus we need to
271          use gcry_mpi_clear_highbit to fix that.  */
272       gcry_mpi_randomize (a, size_list[size_idx], GCRY_WEAK_RANDOM);
273       gcry_mpi_clear_highbit (a, size_list[size_idx]);
274
275       for (i=0; i < 75; i++)
276         {
277           gcry_mpi_lshift (b, a, i);
278           
279           result = mpi2bitstr_nlz (b);
280           tmpstr = mpi2bitstr_nlz (a);
281           result2 = lshiftbitstring (tmpstr, i);
282           xfree (tmpstr);
283           if (strcmp (result, result2))
284             {
285               show ("got =%s\n", result);
286               show ("want=%s\n", result2);
287               fail ("lshift by %d failed\n", i);
288             }
289           xfree (result);
290           xfree (result2);
291         }
292       
293       /* Again. This time using in-place operation. */
294       gcry_mpi_randomize (a, size_list[size_idx], GCRY_WEAK_RANDOM);
295       gcry_mpi_clear_highbit (a, size_list[size_idx]);
296       
297       for (i=0; i < 75; i++)
298         {
299           gcry_mpi_release (b);
300           b = gcry_mpi_copy (a);
301           gcry_mpi_lshift (b, b, i);
302
303           result = mpi2bitstr_nlz (b);
304           tmpstr = mpi2bitstr_nlz (a);
305           result2 = lshiftbitstring (tmpstr, i);
306           xfree (tmpstr);
307           if (strcmp (result, result2))
308             {
309               show ("got =%s\n", result);
310               show ("want=%s\n", result2);
311               fail ("in-place lshift by %d failed\n", i);
312             }
313           xfree (result2);
314           xfree (result);
315         }
316
317       gcry_mpi_release (b);
318       gcry_mpi_release (a);
319     }
320 }
321
322
323 int
324 main (int argc, char **argv)
325 {
326   int debug = 0;
327   int i;
328
329   if (argc > 1 && !strcmp (argv[1], "--verbose"))
330     verbose = 1;
331   else if (argc > 1 && !strcmp (argv[1], "--debug"))
332     verbose = debug = 1;
333
334   if (!gcry_check_version (GCRYPT_VERSION))
335     die ("version mismatch\n");
336
337   gcry_control (GCRYCTL_DISABLE_SECMEM, 0);
338   gcry_control (GCRYCTL_ENABLE_QUICK_RANDOM, 0);
339   if (debug)
340     gcry_control (GCRYCTL_SET_DEBUG_FLAGS, 1u, 0);
341
342   gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
343
344   one_bit_only (0);
345   one_bit_only (1);
346   for (i=0; i < 5; i++)
347     test_rshift (i); /* Run several times due to random initializations. */
348
349   for (i=0; i < 5; i++)
350     test_lshift (i); /* Run several times due to random initializations. */
351   
352   show ("All tests completed. Errors: %d\n", error_count);
353   return error_count ? 1 : 0;
354 }