ebc69fa61735cd9241c8e9b4cc5183140ec5bc15
[gnupg.git] / kbx / kbxutil.c
1 /* kbxutil.c - The Keybox utility
2  *      Copyright (C) 2000, 2001, 2004 Free Software Foundation, Inc.
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 2 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #include <config.h>
23 #include <errno.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <ctype.h>
28 #include <sys/stat.h>
29 #include <unistd.h>
30 #include <assert.h>
31
32 #define JNLIB_NEED_LOG_LOGV
33 #include "../jnlib/logging.h"
34 #include "../jnlib/argparse.h"
35 #include "../jnlib/stringhelp.h"
36 #include "../jnlib/utf8conv.h"
37 #include "../common/i18n.h"
38 #include "keybox-defs.h"
39
40 #include <gcrypt.h>
41
42
43 enum cmd_and_opt_values {
44   aNull = 0,
45   oArmor          = 'a',
46   oDryRun         = 'n',
47   oOutput         = 'o',
48   oQuiet          = 'q',
49   oVerbose        = 'v',
50   
51   aNoSuchCmd    = 500,   /* force other values not to be a letter */
52   aFindByFpr,
53   aFindByKid,
54   aFindByUid,
55   aStats,
56   aImportOpenPGP,
57
58   oDebug,
59   oDebugAll,
60
61   oNoArmor,
62   
63
64   aTest
65 };
66
67
68 static ARGPARSE_OPTS opts[] = {
69   { 300, NULL, 0, N_("@Commands:\n ") },
70
71 /*   { aFindByFpr,  "find-by-fpr", 0, "|FPR| find key using it's fingerprnt" }, */
72 /*   { aFindByKid,  "find-by-kid", 0, "|KID| find key using it's keyid" }, */
73 /*   { aFindByUid,  "find-by-uid", 0, "|NAME| find key by user name" }, */
74   { aStats,      "stats",       0, "show key statistics" }, 
75   { aImportOpenPGP, "import-openpgp", 0, "import OpenPGP keyblocks"},
76   
77   { 301, NULL, 0, N_("@\nOptions:\n ") },
78   
79 /*   { oArmor, "armor",     0, N_("create ascii armored output")}, */
80 /*   { oArmor, "armour",     0, "@" }, */
81 /*   { oOutput, "output",    2, N_("use as output file")}, */
82   { oVerbose, "verbose",   0, N_("verbose") },
83   { oQuiet,     "quiet",   0, N_("be somewhat more quiet") },
84   { oDryRun, "dry-run",   0, N_("do not make any changes") },
85   
86   { oDebug, "debug"     ,4|16, N_("set debugging flags")},
87   { oDebugAll, "debug-all" ,0, N_("enable full debugging")},
88
89   {0} /* end of list */
90 };
91
92
93 void myexit (int rc);
94
95 int keybox_errors_seen = 0;
96
97
98 static const char *
99 my_strusage( int level )
100 {
101     const char *p;
102     switch( level ) {
103       case 11: p = "kbxutil (GnuPG)";
104         break;
105       case 13: p = VERSION; break;
106       case 17: p = PRINTABLE_OS_NAME; break;
107       case 19: p =
108             _("Please report bugs to " PACKAGE_BUGREPORT ".\n");
109         break;
110       case 1:
111       case 40:  p =
112             _("Usage: kbxutil [options] [files] (-h for help)");
113         break;
114       case 41:  p =
115             _("Syntax: kbxutil [options] [files]\n"
116               "list, export, import Keybox data\n");
117         break;
118
119
120       default:  p = NULL;
121     }
122     return p;
123 }
124
125
126 /* Used by gcry for logging */
127 static void
128 my_gcry_logger (void *dummy, int level, const char *fmt, va_list arg_ptr)
129 {
130   /* Map the log levels.  */
131   switch (level)
132     {
133     case GCRY_LOG_CONT: level = JNLIB_LOG_CONT; break;
134     case GCRY_LOG_INFO: level = JNLIB_LOG_INFO; break;
135     case GCRY_LOG_WARN: level = JNLIB_LOG_WARN; break;
136     case GCRY_LOG_ERROR:level = JNLIB_LOG_ERROR; break;
137     case GCRY_LOG_FATAL:level = JNLIB_LOG_FATAL; break;
138     case GCRY_LOG_BUG:  level = JNLIB_LOG_BUG; break;
139     case GCRY_LOG_DEBUG:level = JNLIB_LOG_DEBUG; break;
140     default:            level = JNLIB_LOG_ERROR; break;  
141     }
142   log_logv (level, fmt, arg_ptr);
143 }
144
145
146
147 /*  static void */
148 /*  wrong_args( const char *text ) */
149 /*  { */
150 /*      log_error("usage: kbxutil %s\n", text); */
151 /*      myexit ( 1 ); */
152 /*  } */
153
154
155 #if 0
156 static int
157 hextobyte( const byte *s )
158 {
159     int c;
160
161     if( *s >= '0' && *s <= '9' )
162         c = 16 * (*s - '0');
163     else if( *s >= 'A' && *s <= 'F' )
164         c = 16 * (10 + *s - 'A');
165     else if( *s >= 'a' && *s <= 'f' )
166         c = 16 * (10 + *s - 'a');
167     else
168         return -1;
169     s++;
170     if( *s >= '0' && *s <= '9' )
171         c += *s - '0';
172     else if( *s >= 'A' && *s <= 'F' )
173         c += 10 + *s - 'A';
174     else if( *s >= 'a' && *s <= 'f' )
175         c += 10 + *s - 'a';
176     else
177         return -1;
178     return c;
179 }
180 #endif
181
182 #if 0
183 static char *
184 format_fingerprint ( const char *s )
185 {
186     int i, c;
187     byte fpr[20];
188
189     for (i=0; i < 20 && *s; ) {
190         if ( *s == ' ' || *s == '\t' ) {
191             s++;
192             continue;
193         }
194         c = hextobyte(s);
195         if (c == -1) {
196             return NULL;
197         }
198         fpr[i++] = c;
199         s += 2;
200     }
201     return gcry_xstrdup ( fpr );
202 }
203 #endif
204
205 #if 0
206 static int
207 format_keyid ( const char *s, u32 *kid )
208 {
209     char helpbuf[9];
210     switch ( strlen ( s ) ) {
211       case 8:
212         kid[0] = 0;
213         kid[1] = strtoul( s, NULL, 16 );
214         return 10;
215
216       case 16:
217         mem2str( helpbuf, s, 9 );
218         kid[0] = strtoul( helpbuf, NULL, 16 );
219         kid[1] = strtoul( s+8, NULL, 16 );
220         return 11;
221     }
222     return 0; /* error */
223 }
224 #endif
225
226 static char *
227 read_file (const char *fname, size_t *r_length)
228 {
229   FILE *fp;
230   char *buf;
231   size_t buflen;
232   
233   if (!strcmp (fname, "-"))
234     {
235       size_t nread, bufsize = 0;
236
237       fp = stdin;
238       buf = NULL;
239       buflen = 0;
240 #define NCHUNK 8192
241       do 
242         {
243           bufsize += NCHUNK;
244           if (!buf)
245             buf = xtrymalloc (bufsize);
246           else
247             buf = xtryrealloc (buf, bufsize);
248           if (!buf)
249             log_fatal ("can't allocate buffer: %s\n", strerror (errno));
250
251           nread = fread (buf+buflen, 1, NCHUNK, fp);
252           if (nread < NCHUNK && ferror (fp))
253             {
254               log_error ("error reading `[stdin]': %s\n", strerror (errno));
255               xfree (buf);
256               return NULL;
257             }
258           buflen += nread;
259         }
260       while (nread == NCHUNK);
261 #undef NCHUNK
262
263     }
264   else
265     {
266       struct stat st;
267
268       fp = fopen (fname, "rb");
269       if (!fp)
270         {
271           log_error ("can't open `%s': %s\n", fname, strerror (errno));
272           return NULL;
273         }
274   
275       if (fstat (fileno(fp), &st))
276         {
277           log_error ("can't stat `%s': %s\n", fname, strerror (errno));
278           fclose (fp);
279           return NULL;
280         }
281       
282       buflen = st.st_size;
283       buf = xtrymalloc (buflen+1);
284       if (!buf)
285         log_fatal ("can't allocate buffer: %s\n", strerror (errno));
286       if (fread (buf, buflen, 1, fp) != 1)
287         {
288           log_error ("error reading `%s': %s\n", fname, strerror (errno));
289           fclose (fp);
290           xfree (buf);
291           return NULL;
292         }
293       fclose (fp);
294     }
295
296   *r_length = buflen;
297   return buf;
298 }
299
300
301 static void
302 dump_fpr (const unsigned char *buffer, size_t len)
303 {
304   int i;
305
306   for (i=0; i < len; i++, buffer++)
307     {
308       if (len == 20)
309         {
310           if (i == 10)
311             putchar (' ');
312           printf (" %02X%02X", buffer[0], buffer[1]);
313           i++; buffer++;
314         }
315       else
316         {
317           if (i && !(i % 8))
318             putchar (' ');
319           printf (" %02X", buffer[0]);
320         }
321     }
322 }
323
324
325 static void
326 dump_openpgp_key (keybox_openpgp_info_t info, const unsigned char *image)
327 {
328   printf ("pub %02X%02X%02X%02X",
329           info->primary.keyid[4], info->primary.keyid[5],
330           info->primary.keyid[6], info->primary.keyid[7] );
331   dump_fpr (info->primary.fpr, info->primary.fprlen);
332   putchar ('\n');
333   if (info->nsubkeys)
334     {
335       struct _keybox_openpgp_key_info *k;
336
337       k = &info->subkeys;
338       do 
339         {
340           printf ("sub %02X%02X%02X%02X",
341                   k->keyid[4], k->keyid[5],
342                   k->keyid[6], k->keyid[7] );
343           dump_fpr (k->fpr, k->fprlen);
344           putchar ('\n');
345           k = k->next;
346         }
347       while (k);
348     }
349   if (info->nuids)
350     {
351       struct _keybox_openpgp_uid_info *u;
352
353       u = &info->uids;
354       do 
355         {
356           printf ("uid\t\t%.*s\n", (int)u->len, image + u->off);
357           u = u->next;
358         }
359       while (u);
360     }
361 }
362
363
364 static void
365 import_openpgp (const char *filename)
366 {
367   gpg_error_t err;
368   char *buffer;
369   size_t buflen, nparsed;
370   unsigned char *p;
371   struct _keybox_openpgp_info info;
372
373   buffer = read_file (filename, &buflen);
374   if (!buffer)
375     return;
376   p = (unsigned char *)buffer;
377   for (;;)
378     {
379       err = _keybox_parse_openpgp (p, buflen, &nparsed, &info);
380       assert (nparsed <= buflen);
381       if (err)
382         {
383           if (gpg_err_code (err) == GPG_ERR_NO_DATA)
384             break;
385           log_info ("%s: failed to parse OpenPGP keyblock: %s\n",
386                     filename, gpg_strerror (err));
387         }
388       else
389         {
390           dump_openpgp_key (&info, p);
391           _keybox_destroy_openpgp_info (&info);
392         }
393       p += nparsed;
394       buflen -= nparsed;
395     }
396   xfree (buffer);
397 }
398
399
400
401
402 int
403 main( int argc, char **argv )
404 {
405   ARGPARSE_ARGS pargs;
406   enum cmd_and_opt_values cmd = 0;
407   
408   set_strusage( my_strusage );
409   gcry_control (GCRYCTL_DISABLE_SECMEM);
410   log_set_prefix ("kbxutil", 1); 
411   set_native_charset (NULL); 
412   i18n_init ();
413
414   /* Check that the libraries are suitable.  Do it here because
415      the option parsing may need services of the library.  */
416   if (!gcry_check_version (NEED_LIBGCRYPT_VERSION) )
417     {
418       log_fatal (_("%s is too old (need %s, have %s)\n"), "libgcrypt",
419                  NEED_LIBGCRYPT_VERSION, gcry_check_version (NULL) );
420     }
421
422   gcry_set_log_handler (my_gcry_logger, NULL);
423
424   /*create_dotlock(NULL); register locking cleanup */
425
426   /* We need to use the gcry malloc function because jnlib does use them */
427   keybox_set_malloc_hooks (gcry_malloc, gcry_realloc, gcry_free);
428   ksba_set_malloc_hooks (gcry_malloc, gcry_realloc, gcry_free );
429
430
431   pargs.argc = &argc;
432   pargs.argv = &argv;
433   pargs.flags=  1;  /* do not remove the args */
434   while (arg_parse( &pargs, opts) )
435     {
436       switch (pargs.r_opt)
437         {
438         case oVerbose:
439           /*opt.verbose++;*/
440           /*gcry_control( GCRYCTL_SET_VERBOSITY, (int)opt.verbose );*/
441           break;
442         case oDebug:
443           /*opt.debug |= pargs.r.ret_ulong; */
444           break;
445         case oDebugAll:
446           /*opt.debug = ~0;*/
447           break;
448
449         case aFindByFpr:
450         case aFindByKid:
451         case aFindByUid:
452         case aStats:
453         case aImportOpenPGP:
454           cmd = pargs.r_opt;
455           break;
456
457         default:
458           pargs.err = 2;
459           break;
460         }
461     }
462   if (log_get_errorcount(0) )
463     myexit(2);
464   
465   if (!cmd)
466     { /* Default is to list a KBX file */
467       if (!argc) 
468         _keybox_dump_file (NULL, 0, stdout);
469       else
470         {
471           for (; argc; argc--, argv++) 
472             _keybox_dump_file (*argv, 0, stdout);
473         }
474     }
475   else if (cmd == aStats )
476     {
477       if (!argc) 
478         _keybox_dump_file (NULL, 1, stdout);
479       else
480         {
481           for (; argc; argc--, argv++) 
482             _keybox_dump_file (*argv, 1, stdout);
483         }
484     }
485   else if (cmd == aImportOpenPGP)
486     {
487       if (!argc)
488         import_openpgp ("-");
489       else
490         {
491           for (; argc; argc--, argv++) 
492             import_openpgp (*argv);
493         }
494     }
495 #if 0
496   else if ( cmd == aFindByFpr ) 
497     {
498       char *fpr;
499       if ( argc != 2 )
500         wrong_args ("kbxfile foingerprint");
501       fpr = format_fingerprint ( argv[1] );
502       if ( !fpr )
503         log_error ("invalid formatted fingerprint\n");
504       else 
505         {
506           kbxfile_search_by_fpr ( argv[0], fpr );
507           gcry_free ( fpr );
508         }
509     }
510   else if ( cmd == aFindByKid ) 
511     {
512       u32 kid[2];
513       int mode;
514       
515       if ( argc != 2 )
516         wrong_args ("kbxfile short-or-long-keyid");
517       mode = format_keyid ( argv[1], kid );
518       if ( !mode )
519         log_error ("invalid formatted keyID\n");
520       else
521         {
522           kbxfile_search_by_kid ( argv[0], kid, mode );
523         }
524     }
525   else if ( cmd == aFindByUid ) 
526     {
527       if ( argc != 2 )
528         wrong_args ("kbxfile userID");
529       kbxfile_search_by_uid ( argv[0], argv[1] );
530     }
531 #endif
532   else
533       log_error ("unsupported action\n");
534   
535   myexit(0);
536   return 8; /*NEVER REACHED*/
537 }
538
539
540 void
541 myexit( int rc )
542 {
543   /*    if( opt.debug & DBG_MEMSTAT_VALUE ) {*/
544 /*      gcry_control( GCRYCTL_DUMP_MEMORY_STATS ); */
545 /*      gcry_control( GCRYCTL_DUMP_RANDOM_STATS ); */
546   /*    }*/
547 /*      if( opt.debug ) */
548 /*      gcry_control( GCRYCTL_DUMP_SECMEM_STATS ); */
549     rc = rc? rc : log_get_errorcount(0)? 2 :
550                         keybox_errors_seen? 1 : 0;
551     exit(rc );
552 }
553
554