gpg: Try to use the passphrase from the primary for --quick-addkey.
[gnupg.git] / common / t-private-keys.c
1 /* t-private-keys.c - Module test for private-keys.c
2  *      Copyright (C) 2016 g10 Code GmbH
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG 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 General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <errno.h>
24 #include <assert.h>
25 #include <unistd.h>
26 #include <sys/stat.h>
27
28 #include "util.h"
29 #include "private-keys.h"
30
31 static int verbose;
32
33 void
34 test_getting_values (pkc_t pk)
35 {
36   pke_t e;
37
38   e = pkc_lookup (pk, "Comment:");
39   assert (e);
40
41   /* Names are case-insensitive.  */
42   e = pkc_lookup (pk, "comment:");
43   assert (e);
44   e = pkc_lookup (pk, "COMMENT:");
45   assert (e);
46
47   e = pkc_lookup (pk, "SomeOtherName:");
48   assert (e);
49 }
50
51
52 void
53 test_key_extraction (pkc_t pk)
54 {
55   gpg_error_t err;
56   gcry_sexp_t key;
57
58   err = pkc_get_private_key (pk, &key);
59   assert (err == 0);
60   assert (key);
61
62   if (verbose)
63     gcry_sexp_dump (key);
64
65   gcry_sexp_release (key);
66 }
67
68
69 void
70 test_iteration (pkc_t pk)
71 {
72   int i;
73   pke_t e;
74
75   i = 0;
76   for (e = pkc_first (pk); e; e = pke_next (e))
77     i++;
78   assert (i == 4);
79
80   i = 0;
81   for (e = pkc_lookup (pk, "Comment:");
82        e;
83        e = pke_next_value (e, "Comment:"))
84     i++;
85   assert (i == 3);
86 }
87
88
89 void
90 test_whitespace (pkc_t pk)
91 {
92   pke_t e;
93
94   e = pkc_lookup (pk, "One:");
95   assert (e);
96   assert (strcmp (pke_value (e), "WithoutWhitespace") == 0);
97
98   e = pkc_lookup (pk, "Two:");
99   assert (e);
100   assert (strcmp (pke_value (e), "With Whitespace") == 0);
101
102   e = pkc_lookup (pk, "Three:");
103   assert (e);
104   assert (strcmp (pke_value (e),
105                   "Blank lines in continuations encode newlines.\n"
106                   "Next paragraph.") == 0);
107 }
108
109
110 struct
111 {
112   char *value;
113   void (*test_func) (pkc_t);
114 } tests[] =
115   {
116     {
117       "# This is a comment followed by an empty line\n"
118       "\n",
119       NULL,
120     },
121     {
122       "# This is a comment followed by two empty lines, Windows style\r\n"
123       "\r\n"
124       "\r\n",
125       NULL,
126     },
127     {
128       "# Some name,value pairs\n"
129       "Comment: Some comment.\n"
130       "SomeOtherName: Some value.\n",
131       test_getting_values,
132     },
133     {
134       "  # Whitespace is preserved as much as possible\r\n"
135       "Comment:Some comment.\n"
136       "SomeOtherName: Some value.   \n",
137       test_getting_values,
138     },
139     {
140       "# Values may be continued in the next line as indicated by leading\n"
141       "# space\n"
142       "Comment: Some rather long\n"
143       "  comment that is continued in the next line.\n"
144       "\n"
145       "  Blank lines with or without whitespace are allowed within\n"
146       "  continuations to allow paragraphs.\n"
147       "SomeOtherName: Some value.\n",
148       test_getting_values,
149     },
150     {
151       "# Names may be given multiple times forming an array of values\n"
152       "Comment: Some comment, element 0.\n"
153       "Comment: Some comment, element 1.\n"
154       "Comment: Some comment, element 2.\n"
155       "SomeOtherName: Some value.\n",
156       test_iteration,
157     },
158     {
159       "# One whitespace at the beginning of a continuation is swallowed.\n"
160       "One: Without\n"
161       " Whitespace\n"
162       "Two: With\n"
163       "  Whitespace\n"
164       "Three: Blank lines in continuations encode newlines.\n"
165       "\n"
166       "  Next paragraph.\n",
167       test_whitespace,
168     },
169     {
170       "Description: Key to sign all GnuPG released tarballs.\n"
171       "  The key is actually stored on a smart card.\n"
172       "Use-for-ssh: yes\n"
173       "OpenSSH-cert: long base64 encoded string wrapped so that this\n"
174       "  key file can be easily edited with a standard editor.\n"
175       "Key: (shadowed-private-key\n"
176       "  (rsa\n"
177       "  (n #00AA1AD2A55FD8C8FDE9E1941772D9CC903FA43B268CB1B5A1BAFDC900\n"
178       "  2961D8AEA153424DC851EF13B83AC64FBE365C59DC1BD3E83017C90D4365B4\n"
179       "  83E02859FC13DB5842A00E969480DB96CE6F7D1C03600392B8E08EF0C01FC7\n"
180       "  19F9F9086B25AD39B4F1C2A2DF3E2BE317110CFFF21D4A11455508FE407997\n"
181       "  601260816C8422297C0637BB291C3A079B9CB38A92CE9E551F80AA0EBF4F0E\n"
182       "  72C3F250461E4D31F23A7087857FC8438324A013634563D34EFDDCBF2EA80D\n"
183       "  F9662C9CCD4BEF2522D8BDFED24CEF78DC6B309317407EAC576D889F88ADA0\n"
184       "  8C4FFB480981FB68C5C6CA27503381D41018E6CDC52AAAE46B166BDC10637A\n"
185       "  E186A02BA2497FDC5D1221#)\n"
186       "  (e #00010001#)\n"
187       "  (shadowed t1-v1\n"
188       "   (#D2760001240102000005000011730000# OPENPGP.1)\n"
189       "    )))\n",
190       test_key_extraction,
191     },
192   };
193
194
195 static char *
196 pkc_to_string (pkc_t pk)
197 {
198   gpg_error_t err;
199   char *buf;
200   size_t len;
201   estream_t sink;
202
203   sink = es_fopenmem (0, "rw");
204   assert (sink);
205
206   err = pkc_write (pk, sink);
207   assert (err == 0);
208
209   len = es_ftell (sink);
210   buf = xmalloc (len+1);
211   assert (buf);
212
213   es_fseek (sink, 0, SEEK_SET);
214   es_read (sink, buf, len, NULL);
215   buf[len] = 0;
216
217   es_fclose (sink);
218   return buf;
219 }
220
221
222 void dummy_free (void *p) { (void) p; }
223 void *dummy_realloc (void *p, size_t s) { (void) s; return p; }
224
225 void
226 run_tests (void)
227 {
228   gpg_error_t err;
229   pkc_t pk;
230
231   int i;
232   for (i = 0; i < DIM (tests); i++)
233     {
234       estream_t source;
235       char *buf;
236       size_t len;
237
238       len = strlen (tests[i].value);
239       source = es_mopen (tests[i].value, len, len,
240                          0, dummy_realloc, dummy_free, "r");
241       assert (source);
242
243       err = pkc_parse (&pk, NULL, source);
244       assert (err == 0);
245       assert (pk);
246
247       if (verbose)
248         {
249           err = pkc_write (pk, es_stderr);
250           assert (err == 0);
251         }
252
253       buf = pkc_to_string (pk);
254       assert (memcmp (tests[i].value, buf, len) == 0);
255
256       es_fclose (source);
257       xfree (buf);
258
259       if (tests[i].test_func)
260         tests[i].test_func (pk);
261
262       pkc_release (pk);
263     }
264 }
265
266
267 void
268 run_modification_tests (void)
269 {
270   gpg_error_t err;
271   pkc_t pk;
272   gcry_sexp_t key;
273   char *buf;
274
275   pk = pkc_new ();
276   assert (pk);
277
278   pkc_set (pk, "Foo:", "Bar");
279   buf = pkc_to_string (pk);
280   assert (strcmp (buf, "Foo: Bar\n") == 0);
281   xfree (buf);
282
283   pkc_set (pk, "Foo:", "Baz");
284   buf = pkc_to_string (pk);
285   assert (strcmp (buf, "Foo: Baz\n") == 0);
286   xfree (buf);
287
288   pkc_set (pk, "Bar:", "Bazzel");
289   buf = pkc_to_string (pk);
290   assert (strcmp (buf, "Foo: Baz\nBar: Bazzel\n") == 0);
291   xfree (buf);
292
293   pkc_add (pk, "Foo:", "Bar");
294   buf = pkc_to_string (pk);
295   assert (strcmp (buf, "Foo: Baz\nFoo: Bar\nBar: Bazzel\n") == 0);
296   xfree (buf);
297
298   pkc_add (pk, "DontExistYet:", "Bar");
299   buf = pkc_to_string (pk);
300   assert (strcmp (buf, "Foo: Baz\nFoo: Bar\nBar: Bazzel\nDontExistYet: Bar\n")
301           == 0);
302   xfree (buf);
303
304   pkc_delete (pk, pkc_lookup (pk, "DontExistYet:"));
305   buf = pkc_to_string (pk);
306   assert (strcmp (buf, "Foo: Baz\nFoo: Bar\nBar: Bazzel\n") == 0);
307   xfree (buf);
308
309   pkc_delete (pk, pke_next_value (pkc_lookup (pk, "Foo:"), "Foo:"));
310   buf = pkc_to_string (pk);
311   assert (strcmp (buf, "Foo: Baz\nBar: Bazzel\n") == 0);
312   xfree (buf);
313
314   pkc_delete (pk, pkc_lookup (pk, "Foo:"));
315   buf = pkc_to_string (pk);
316   assert (strcmp (buf, "Bar: Bazzel\n") == 0);
317   xfree (buf);
318
319   pkc_delete (pk, pkc_first (pk));
320   buf = pkc_to_string (pk);
321   assert (strcmp (buf, "") == 0);
322   xfree (buf);
323
324   pkc_set (pk, "Foo:", "A really long value spanning across multiple lines"
325            " that has to be wrapped at a convenient space.");
326   buf = pkc_to_string (pk);
327   assert (strcmp (buf, "Foo: A really long value spanning across multiple"
328                   " lines that has to be\n  wrapped at a convenient space.\n")
329           == 0);
330   xfree (buf);
331
332   pkc_set (pk, "Foo:", "XA really long value spanning across multiple lines"
333            " that has to be wrapped at a convenient space.");
334   buf = pkc_to_string (pk);
335   assert (strcmp (buf, "Foo: XA really long value spanning across multiple"
336                   " lines that has to\n  be wrapped at a convenient space.\n")
337           == 0);
338   xfree (buf);
339
340   pkc_set (pk, "Foo:", "XXXXA really long value spanning across multiple lines"
341            " that has to be wrapped at a convenient space.");
342   buf = pkc_to_string (pk);
343   assert (strcmp (buf, "Foo: XXXXA really long value spanning across multiple"
344                   " lines that has\n  to be wrapped at a convenient space.\n")
345           == 0);
346   xfree (buf);
347
348   pkc_set (pk, "Foo:", "Areallylongvaluespanningacrossmultiplelines"
349            "thathastobewrappedataconvenientspacethatisnotthere.");
350   buf = pkc_to_string (pk);
351   assert (strcmp (buf, "Foo: Areallylongvaluespanningacrossmultiplelinesthat"
352                   "hastobewrappedataco\n nvenientspacethatisnotthere.\n")
353           == 0);
354   xfree (buf);
355   pkc_release (pk);
356
357   pk = pkc_new ();
358   assert (pk);
359
360   err = gcry_sexp_build (&key, NULL, "(hello world)");
361   assert (err == 0);
362   assert (key);
363
364   err = pkc_set_private_key (pk, key);
365   gcry_sexp_release (key);
366   assert (err == 0);
367   buf = pkc_to_string (pk);
368   assert (strcmp (buf, "Key: (hello world)\n") == 0);
369   xfree (buf);
370   pkc_release (pk);
371 }
372
373
374 void
375 convert (const char *fname)
376 {
377   gpg_error_t err;
378   estream_t source;
379   gcry_sexp_t key;
380   char *buf;
381   size_t buflen;
382   struct stat st;
383   pkc_t pk;
384
385   source = es_fopen (fname, "rb");
386   if (source == NULL)
387     goto leave;
388
389   if (fstat (es_fileno (source), &st))
390     goto leave;
391
392   buflen = st.st_size;
393   buf = xtrymalloc (buflen+1);
394   assert (buf);
395
396   if (es_fread (buf, buflen, 1, source) != 1)
397     goto leave;
398
399   err = gcry_sexp_sscan (&key, NULL, buf, buflen);
400   if (err)
401     {
402       fprintf (stderr, "malformed s-expression in %s\n", fname);
403       exit (1);
404     }
405
406   pk = pkc_new ();
407   assert (pk);
408
409   err = pkc_set_private_key (pk, key);
410   assert (err == 0);
411
412   err = pkc_write (pk, es_stdout);
413   assert (err == 0);
414
415   return;
416
417  leave:
418   perror (fname);
419   exit (1);
420 }
421
422
423 void
424 parse (const char *fname)
425 {
426   gpg_error_t err;
427   estream_t source;
428   char *buf;
429   pkc_t pk_a, pk_b;
430   pke_t e;
431   int line;
432
433   source = es_fopen (fname, "rb");
434   if (source == NULL)
435     {
436       perror (fname);
437       exit (1);
438     }
439
440   err = pkc_parse (&pk_a, &line, source);
441   if (err)
442     {
443       fprintf (stderr, "failed to parse %s line %d: %s\n",
444                fname, line, gpg_strerror (err));
445       exit (1);
446     }
447
448   buf = pkc_to_string (pk_a);
449   xfree (buf);
450
451   pk_b = pkc_new ();
452   assert (pk_b);
453
454   for (e = pkc_first (pk_a); e; e = pke_next (e))
455     {
456       gcry_sexp_t key = NULL;
457
458       if (strcasecmp (pke_name (e), "Key:") == 0)
459         {
460           err = pkc_get_private_key (pk_a, &key);
461           if (err)
462             key = NULL;
463         }
464
465       if (key)
466         {
467           err = pkc_set_private_key (pk_b, key);
468           assert (err == 0);
469         }
470       else
471         {
472           err = pkc_add (pk_b, pke_name (e), pke_value (e));
473           assert (err == 0);
474         }
475     }
476
477     buf = pkc_to_string (pk_b);
478     if (verbose)
479       fprintf (stdout, "%s", buf);
480     xfree (buf);
481 }
482
483
484 void
485 print_usage (void)
486 {
487   fprintf (stderr,
488            "usage: t-private-keys [--verbose]"
489            " [--convert <private-key-file>"
490            " || --parse <extended-private-key-file>]\n");
491   exit (2);
492 }
493
494
495 int
496 main (int argc, char **argv)
497 {
498   enum { TEST, CONVERT, PARSE } command = TEST;
499
500   if (argc)
501     { argc--; argv++; }
502   if (argc && !strcmp (argv[0], "--verbose"))
503     {
504       verbose = 1;
505       argc--; argv++;
506     }
507
508   if (argc && !strcmp (argv[0], "--convert"))
509     {
510       command = CONVERT;
511       argc--; argv++;
512       if (argc != 1)
513         print_usage ();
514     }
515
516   if (argc && !strcmp (argv[0], "--parse"))
517     {
518       command = PARSE;
519       argc--; argv++;
520       if (argc != 1)
521         print_usage ();
522     }
523
524   switch (command)
525     {
526     case TEST:
527       run_tests ();
528       run_modification_tests ();
529       break;
530
531     case CONVERT:
532       convert (*argv);
533       break;
534
535     case PARSE:
536       parse (*argv);
537       break;
538     }
539
540   return 0;
541 }