json: Use gpgrt_argparse instead of argsparse.c
[gpgme.git] / tests / run-keylist.c
1 /* run-keylist.c  - Helper to show a key listing.
2    Copyright (C) 2008, 2009 g10 Code GmbH
3
4    This file is part of GPGME.
5
6    GPGME is free software; you can redistribute it and/or modify it
7    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    GPGME is distributed in the hope that it will be useful, but
12    WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    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 <https://www.gnu.org/licenses/>.
18 */
19
20 /* We need to include config.h so that we know whether we are building
21    with large file system (LFS) support. */
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25
26 #include <stdlib.h>
27 #include <stdio.h>
28 #include <string.h>
29 #include <time.h>
30
31 #include <gpgme.h>
32
33 #define PGM "run-keylist"
34
35 #include "run-support.h"
36
37
38 static int verbose;
39
40
41 static int
42 show_usage (int ex)
43 {
44   fputs ("usage: " PGM " [options] [USERID_or_FILE]\n\n"
45          "Options:\n"
46          "  --verbose        run in verbose mode\n"
47          "  --openpgp        use the OpenPGP protocol (default)\n"
48          "  --cms            use the CMS protocol\n"
49          "  --secret         list only secret keys\n"
50          "  --local          use GPGME_KEYLIST_MODE_LOCAL\n"
51          "  --extern         use GPGME_KEYLIST_MODE_EXTERN\n"
52          "  --sigs           use GPGME_KEYLIST_MODE_SIGS\n"
53          "  --tofu           use GPGME_KEYLIST_MODE_TOFU\n"
54          "  --sig-notations  use GPGME_KEYLIST_MODE_SIG_NOTATIONS\n"
55          "  --ephemeral      use GPGME_KEYLIST_MODE_EPHEMERAL\n"
56          "  --validate       use GPGME_KEYLIST_MODE_VALIDATE\n"
57          "  --import         import all keys\n"
58          "  --offline        use offline mode\n"
59          "  --from-file      list all keys in the given file\n"
60          "  --require-gnupg  required at least the given GnuPG version\n"
61          , stderr);
62   exit (ex);
63 }
64
65
66 static const char *
67 isotimestr (unsigned long value)
68 {
69   time_t t;
70   static char buffer[25+5];
71   struct tm *tp;
72
73   if (!value)
74     return "none";
75   t = value;
76
77   tp = gmtime (&t);
78   snprintf (buffer, sizeof buffer, "%04d-%02d-%02d %02d:%02d:%02d",
79             1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday,
80             tp->tm_hour, tp->tm_min, tp->tm_sec);
81   return buffer;
82 }
83
84
85
86 int
87 main (int argc, char **argv)
88 {
89   int last_argc = -1;
90   gpgme_error_t err;
91   gpgme_ctx_t ctx;
92   gpgme_keylist_mode_t mode = 0;
93   gpgme_key_t key;
94   gpgme_subkey_t subkey;
95   gpgme_keylist_result_t result;
96   int import = 0;
97   gpgme_key_t keyarray[100];
98   int keyidx = 0;
99   gpgme_protocol_t protocol = GPGME_PROTOCOL_OpenPGP;
100   int only_secret = 0;
101   int offline = 0;
102   int from_file = 0;
103   gpgme_data_t data = NULL;
104
105
106   if (argc)
107     { argc--; argv++; }
108
109   while (argc && last_argc != argc )
110     {
111       last_argc = argc;
112       if (!strcmp (*argv, "--"))
113         {
114           argc--; argv++;
115           break;
116         }
117       else if (!strcmp (*argv, "--help"))
118         show_usage (0);
119       else if (!strcmp (*argv, "--verbose"))
120         {
121           verbose = 1;
122           argc--; argv++;
123         }
124       else if (!strcmp (*argv, "--openpgp"))
125         {
126           protocol = GPGME_PROTOCOL_OpenPGP;
127           argc--; argv++;
128         }
129       else if (!strcmp (*argv, "--cms"))
130         {
131           protocol = GPGME_PROTOCOL_CMS;
132           argc--; argv++;
133         }
134       else if (!strcmp (*argv, "--secret"))
135         {
136           only_secret = 1;
137           argc--; argv++;
138         }
139       else if (!strcmp (*argv, "--local"))
140         {
141           mode |= GPGME_KEYLIST_MODE_LOCAL;
142           argc--; argv++;
143         }
144       else if (!strcmp (*argv, "--extern"))
145         {
146           mode |= GPGME_KEYLIST_MODE_EXTERN;
147           argc--; argv++;
148         }
149       else if (!strcmp (*argv, "--tofu"))
150         {
151           mode |= GPGME_KEYLIST_MODE_WITH_TOFU;
152           argc--; argv++;
153         }
154       else if (!strcmp (*argv, "--sigs"))
155         {
156           mode |= GPGME_KEYLIST_MODE_SIGS;
157           argc--; argv++;
158         }
159       else if (!strcmp (*argv, "--sig-notations"))
160         {
161           mode |= GPGME_KEYLIST_MODE_SIG_NOTATIONS;
162           argc--; argv++;
163         }
164       else if (!strcmp (*argv, "--ephemeral"))
165         {
166           mode |= GPGME_KEYLIST_MODE_EPHEMERAL;
167           argc--; argv++;
168         }
169       else if (!strcmp (*argv, "--validate"))
170         {
171           mode |= GPGME_KEYLIST_MODE_VALIDATE;
172           argc--; argv++;
173         }
174       else if (!strcmp (*argv, "--import"))
175         {
176           import = 1;
177           argc--; argv++;
178         }
179       else if (!strcmp (*argv, "--offline"))
180         {
181           offline = 1;
182           argc--; argv++;
183         }
184       else if (!strcmp (*argv, "--from-file"))
185         {
186           from_file = 1;
187           argc--; argv++;
188         }
189       else if (!strcmp (*argv, "--require-gnupg"))
190         {
191           argc--; argv++;
192           if (!argc)
193             show_usage (1);
194           gpgme_set_global_flag ("require-gnupg", *argv);
195           argc--; argv++;
196         }
197       else if (!strncmp (*argv, "--", 2))
198         show_usage (1);
199     }
200
201   if (argc > 1)
202     show_usage (1);
203   else if (from_file && !argc)
204     show_usage (1);
205
206   init_gpgme (protocol);
207
208   err = gpgme_new (&ctx);
209   fail_if_err (err);
210   gpgme_set_protocol (ctx, protocol);
211
212   gpgme_set_keylist_mode (ctx, mode);
213
214   gpgme_set_offline (ctx, offline);
215
216   if (from_file)
217     {
218       err = gpgme_data_new_from_file (&data, *argv, 1);
219       fail_if_err (err);
220
221       err = gpgme_op_keylist_from_data_start (ctx, data, 0);
222     }
223   else
224     err = gpgme_op_keylist_start (ctx, argc? argv[0]:NULL, only_secret);
225   fail_if_err (err);
226
227   while (!(err = gpgme_op_keylist_next (ctx, &key)))
228     {
229       gpgme_user_id_t uid;
230       gpgme_tofu_info_t ti;
231       gpgme_key_sig_t ks;
232       int nuids;
233       int nsub;
234       int nsigs;
235
236       printf ("keyid   : %s\n", key->subkeys?nonnull (key->subkeys->keyid):"?");
237       printf ("fpr     : %s\n", key->subkeys?nonnull (key->subkeys->fpr):"?");
238       if (key->subkeys && key->subkeys->keygrip)
239         printf ("grip    : %s\n", key->subkeys->keygrip);
240       if (key->subkeys && key->subkeys->curve)
241             printf ("curve   : %s\n", key->subkeys->curve);
242       printf ("caps    : %s%s%s%s\n",
243               key->can_encrypt? "e":"",
244               key->can_sign? "s":"",
245               key->can_certify? "c":"",
246               key->can_authenticate? "a":"");
247       printf ("flags   :%s%s%s%s%s%s%s%s\n",
248               key->secret? " secret":"",
249               key->revoked? " revoked":"",
250               key->expired? " expired":"",
251               key->disabled? " disabled":"",
252               key->invalid? " invalid":"",
253               key->is_qualified? " qualified":"",
254               key->subkeys && key->subkeys->is_de_vs? " de-vs":"",
255               key->subkeys && key->subkeys->is_cardkey? " cardkey":"");
256       printf ("upd     : %lu (%u)\n", key->last_update, key->origin);
257
258       subkey = key->subkeys;
259       if (subkey)
260         subkey = subkey->next;
261       for (nsub=1; subkey; subkey = subkey->next, nsub++)
262         {
263           printf ("fpr   %2d: %s\n", nsub, nonnull (subkey->fpr));
264           if (subkey->keygrip)
265             printf ("grip  %2d: %s\n", nsub, subkey->keygrip);
266           if (subkey->curve)
267             printf ("curve %2d: %s\n", nsub, subkey->curve);
268           printf ("caps  %2d: %s%s%s%s\n",
269                   nsub,
270                   subkey->can_encrypt? "e":"",
271                   subkey->can_sign? "s":"",
272                   subkey->can_certify? "c":"",
273                   subkey->can_authenticate? "a":"");
274           printf ("flags %2d:%s%s%s%s%s%s%s%s\n",
275                   nsub,
276                   subkey->secret? " secret":"",
277                   subkey->revoked? " revoked":"",
278                   subkey->expired? " expired":"",
279                   subkey->disabled? " disabled":"",
280                   subkey->invalid? " invalid":"",
281                   subkey->is_qualified? " qualified":"",
282                   subkey->is_de_vs? " de-vs":"",
283                   subkey->is_cardkey? " cardkey":"");
284         }
285       for (nuids=0, uid=key->uids; uid; uid = uid->next, nuids++)
286         {
287           printf ("userid %d: %s\n", nuids, nonnull(uid->uid));
288           printf ("    mbox: %s\n", nonnull(uid->address));
289           if (uid->email && uid->email != uid->address)
290             printf ("   email: %s\n", uid->email);
291           if (uid->name)
292             printf ("    name: %s\n", uid->name);
293           if (uid->comment)
294             printf ("   cmmnt: %s\n", uid->comment);
295           printf ("     upd: %lu (%u)\n", uid->last_update, uid->origin);
296           printf ("   valid: %s\n",
297                   uid->validity == GPGME_VALIDITY_UNKNOWN? "unknown":
298                   uid->validity == GPGME_VALIDITY_UNDEFINED? "undefined":
299                   uid->validity == GPGME_VALIDITY_NEVER? "never":
300                   uid->validity == GPGME_VALIDITY_MARGINAL? "marginal":
301                   uid->validity == GPGME_VALIDITY_FULL? "full":
302                   uid->validity == GPGME_VALIDITY_ULTIMATE? "ultimate": "[?]");
303           if ((ti = uid->tofu))
304             {
305               printf ("    tofu: %u (%s)\n", ti->validity,
306                       ti->validity == 0? "conflict" :
307                       ti->validity == 1? "no history" :
308                       ti->validity == 2? "little history" :
309                       ti->validity == 3? "enough history" :
310                       ti->validity == 4? "lot of history" : "?");
311               printf ("  policy: %u (%s)\n", ti->policy,
312                       ti->policy == GPGME_TOFU_POLICY_NONE? "none" :
313                       ti->policy == GPGME_TOFU_POLICY_AUTO? "auto" :
314                       ti->policy == GPGME_TOFU_POLICY_GOOD? "good" :
315                       ti->policy == GPGME_TOFU_POLICY_UNKNOWN? "unknown" :
316                       ti->policy == GPGME_TOFU_POLICY_BAD? "bad" :
317                       ti->policy == GPGME_TOFU_POLICY_ASK? "ask" : "?");
318               printf ("   nsigs: %hu\n", ti->signcount);
319               printf ("   first: %s\n", isotimestr (ti->signfirst));
320               printf ("    last: %s\n", isotimestr (ti->signlast));
321               printf ("   nencr: %hu\n", ti->encrcount);
322               printf ("   first: %s\n", isotimestr (ti->encrfirst));
323               printf ("    last: %s\n", isotimestr (ti->encrlast));
324             }
325           for (nsigs=0, ks=uid->signatures; ks; ks = ks->next, nsigs++)
326             {
327               printf ("signature %d: %s\n", nsigs, nonnull (ks->uid));
328               printf ("       keyid: %s\n", nonnull (ks->keyid));
329               printf ("     created: %s\n", isotimestr(ks->timestamp));
330               printf ("     expires: %s\n", isotimestr(ks->expires));
331               printf ("       class: %x\n", ks->sig_class);
332             }
333         }
334
335       putchar ('\n');
336
337       if (import)
338         {
339           if (keyidx < DIM (keyarray)-1)
340             keyarray[keyidx++] = key;
341           else
342             {
343               fprintf (stderr, PGM": too many keys in import mode"
344                        "- skipping this key\n");
345               gpgme_key_unref (key);
346             }
347         }
348       else
349         gpgme_key_unref (key);
350     }
351   if (gpgme_err_code (err) != GPG_ERR_EOF)
352     fail_if_err (err);
353   err = gpgme_op_keylist_end (ctx);
354   fail_if_err (err);
355   keyarray[keyidx] = NULL;
356   gpgme_data_release (data);
357
358   result = gpgme_op_keylist_result (ctx);
359   if (result->truncated)
360     {
361       fprintf (stderr, PGM ": key listing unexpectedly truncated\n");
362       exit (1);
363     }
364
365   if (import)
366     {
367       gpgme_import_result_t impres;
368
369       err = gpgme_op_import_keys (ctx, keyarray);
370       fail_if_err (err);
371       impres = gpgme_op_import_result (ctx);
372       if (!impres)
373         {
374           fprintf (stderr, PGM ": no import result returned\n");
375           exit (1);
376         }
377       print_import_result (impres);
378     }
379
380   for (keyidx=0; keyarray[keyidx]; keyidx++)
381     gpgme_key_unref (keyarray[keyidx]);
382
383   gpgme_release (ctx);
384   return 0;
385 }