Add ctx flag for auto-key-locate
[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          "  --from-wkd       list key from a web key directory\n"
61          "  --require-gnupg  required at least the given GnuPG version\n"
62          , stderr);
63   exit (ex);
64 }
65
66
67 static const char *
68 isotimestr (unsigned long value)
69 {
70   time_t t;
71   static char buffer[25+5];
72   struct tm *tp;
73
74   if (!value)
75     return "none";
76   t = value;
77
78   tp = gmtime (&t);
79   snprintf (buffer, sizeof buffer, "%04d-%02d-%02d %02d:%02d:%02d",
80             1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday,
81             tp->tm_hour, tp->tm_min, tp->tm_sec);
82   return buffer;
83 }
84
85
86
87 int
88 main (int argc, char **argv)
89 {
90   int last_argc = -1;
91   gpgme_error_t err;
92   gpgme_ctx_t ctx;
93   gpgme_keylist_mode_t mode = 0;
94   gpgme_key_t key;
95   gpgme_subkey_t subkey;
96   gpgme_keylist_result_t result;
97   int import = 0;
98   gpgme_key_t keyarray[100];
99   int keyidx = 0;
100   gpgme_protocol_t protocol = GPGME_PROTOCOL_OpenPGP;
101   int only_secret = 0;
102   int offline = 0;
103   int from_file = 0;
104   int from_wkd = 0;
105   gpgme_data_t data = NULL;
106
107
108   if (argc)
109     { argc--; argv++; }
110
111   while (argc && last_argc != argc )
112     {
113       last_argc = argc;
114       if (!strcmp (*argv, "--"))
115         {
116           argc--; argv++;
117           break;
118         }
119       else if (!strcmp (*argv, "--help"))
120         show_usage (0);
121       else if (!strcmp (*argv, "--verbose"))
122         {
123           verbose = 1;
124           argc--; argv++;
125         }
126       else if (!strcmp (*argv, "--openpgp"))
127         {
128           protocol = GPGME_PROTOCOL_OpenPGP;
129           argc--; argv++;
130         }
131       else if (!strcmp (*argv, "--cms"))
132         {
133           protocol = GPGME_PROTOCOL_CMS;
134           argc--; argv++;
135         }
136       else if (!strcmp (*argv, "--secret"))
137         {
138           only_secret = 1;
139           argc--; argv++;
140         }
141       else if (!strcmp (*argv, "--local"))
142         {
143           mode |= GPGME_KEYLIST_MODE_LOCAL;
144           argc--; argv++;
145         }
146       else if (!strcmp (*argv, "--extern"))
147         {
148           mode |= GPGME_KEYLIST_MODE_EXTERN;
149           argc--; argv++;
150         }
151       else if (!strcmp (*argv, "--tofu"))
152         {
153           mode |= GPGME_KEYLIST_MODE_WITH_TOFU;
154           argc--; argv++;
155         }
156       else if (!strcmp (*argv, "--sigs"))
157         {
158           mode |= GPGME_KEYLIST_MODE_SIGS;
159           argc--; argv++;
160         }
161       else if (!strcmp (*argv, "--sig-notations"))
162         {
163           mode |= GPGME_KEYLIST_MODE_SIG_NOTATIONS;
164           argc--; argv++;
165         }
166       else if (!strcmp (*argv, "--ephemeral"))
167         {
168           mode |= GPGME_KEYLIST_MODE_EPHEMERAL;
169           argc--; argv++;
170         }
171       else if (!strcmp (*argv, "--validate"))
172         {
173           mode |= GPGME_KEYLIST_MODE_VALIDATE;
174           argc--; argv++;
175         }
176       else if (!strcmp (*argv, "--import"))
177         {
178           import = 1;
179           argc--; argv++;
180         }
181       else if (!strcmp (*argv, "--offline"))
182         {
183           offline = 1;
184           argc--; argv++;
185         }
186       else if (!strcmp (*argv, "--from-file"))
187         {
188           from_file = 1;
189           argc--; argv++;
190         }
191       else if (!strcmp (*argv, "--require-gnupg"))
192         {
193           argc--; argv++;
194           if (!argc)
195             show_usage (1);
196           gpgme_set_global_flag ("require-gnupg", *argv);
197           argc--; argv++;
198         }
199       else if (!strcmp (*argv, "--from-wkd"))
200         {
201           argc--; argv++;
202           mode |= GPGME_KEYLIST_MODE_LOCATE;
203           from_wkd = 1;
204         }
205       else if (!strncmp (*argv, "--", 2))
206         show_usage (1);
207     }
208
209   if (argc > 1)
210     show_usage (1);
211   else if (from_file && !argc)
212     show_usage (1);
213
214   init_gpgme (protocol);
215
216   err = gpgme_new (&ctx);
217   fail_if_err (err);
218   gpgme_set_protocol (ctx, protocol);
219
220   gpgme_set_keylist_mode (ctx, mode);
221
222   gpgme_set_offline (ctx, offline);
223
224   if (from_wkd)
225     {
226       err = gpgme_set_ctx_flag (ctx, "auto-key-locate",
227                                 "clear,nodefault,wkd");
228       fail_if_err (err);
229     }
230
231   if (from_file)
232     {
233       err = gpgme_data_new_from_file (&data, *argv, 1);
234       fail_if_err (err);
235
236       err = gpgme_op_keylist_from_data_start (ctx, data, 0);
237     }
238   else
239     err = gpgme_op_keylist_start (ctx, argc? argv[0]:NULL, only_secret);
240   fail_if_err (err);
241
242   while (!(err = gpgme_op_keylist_next (ctx, &key)))
243     {
244       gpgme_user_id_t uid;
245       gpgme_tofu_info_t ti;
246       gpgme_key_sig_t ks;
247       int nuids;
248       int nsub;
249       int nsigs;
250
251       printf ("keyid   : %s\n", key->subkeys?nonnull (key->subkeys->keyid):"?");
252       printf ("fpr     : %s\n", key->subkeys?nonnull (key->subkeys->fpr):"?");
253       if (key->subkeys && key->subkeys->keygrip)
254         printf ("grip    : %s\n", key->subkeys->keygrip);
255       if (key->subkeys && key->subkeys->curve)
256             printf ("curve   : %s\n", key->subkeys->curve);
257       printf ("caps    : %s%s%s%s\n",
258               key->can_encrypt? "e":"",
259               key->can_sign? "s":"",
260               key->can_certify? "c":"",
261               key->can_authenticate? "a":"");
262       printf ("flags   :%s%s%s%s%s%s%s%s\n",
263               key->secret? " secret":"",
264               key->revoked? " revoked":"",
265               key->expired? " expired":"",
266               key->disabled? " disabled":"",
267               key->invalid? " invalid":"",
268               key->is_qualified? " qualified":"",
269               key->subkeys && key->subkeys->is_de_vs? " de-vs":"",
270               key->subkeys && key->subkeys->is_cardkey? " cardkey":"");
271       printf ("upd     : %lu (%u)\n", key->last_update, key->origin);
272
273       subkey = key->subkeys;
274       if (subkey)
275         subkey = subkey->next;
276       for (nsub=1; subkey; subkey = subkey->next, nsub++)
277         {
278           printf ("fpr   %2d: %s\n", nsub, nonnull (subkey->fpr));
279           if (subkey->keygrip)
280             printf ("grip  %2d: %s\n", nsub, subkey->keygrip);
281           if (subkey->curve)
282             printf ("curve %2d: %s\n", nsub, subkey->curve);
283           printf ("caps  %2d: %s%s%s%s\n",
284                   nsub,
285                   subkey->can_encrypt? "e":"",
286                   subkey->can_sign? "s":"",
287                   subkey->can_certify? "c":"",
288                   subkey->can_authenticate? "a":"");
289           printf ("flags %2d:%s%s%s%s%s%s%s%s\n",
290                   nsub,
291                   subkey->secret? " secret":"",
292                   subkey->revoked? " revoked":"",
293                   subkey->expired? " expired":"",
294                   subkey->disabled? " disabled":"",
295                   subkey->invalid? " invalid":"",
296                   subkey->is_qualified? " qualified":"",
297                   subkey->is_de_vs? " de-vs":"",
298                   subkey->is_cardkey? " cardkey":"");
299         }
300       for (nuids=0, uid=key->uids; uid; uid = uid->next, nuids++)
301         {
302           printf ("userid %d: %s\n", nuids, nonnull(uid->uid));
303           printf ("    mbox: %s\n", nonnull(uid->address));
304           if (uid->email && uid->email != uid->address)
305             printf ("   email: %s\n", uid->email);
306           if (uid->name)
307             printf ("    name: %s\n", uid->name);
308           if (uid->comment)
309             printf ("   cmmnt: %s\n", uid->comment);
310           printf ("     upd: %lu (%u)\n", uid->last_update, uid->origin);
311           printf ("   valid: %s\n",
312                   uid->validity == GPGME_VALIDITY_UNKNOWN? "unknown":
313                   uid->validity == GPGME_VALIDITY_UNDEFINED? "undefined":
314                   uid->validity == GPGME_VALIDITY_NEVER? "never":
315                   uid->validity == GPGME_VALIDITY_MARGINAL? "marginal":
316                   uid->validity == GPGME_VALIDITY_FULL? "full":
317                   uid->validity == GPGME_VALIDITY_ULTIMATE? "ultimate": "[?]");
318           if ((ti = uid->tofu))
319             {
320               printf ("    tofu: %u (%s)\n", ti->validity,
321                       ti->validity == 0? "conflict" :
322                       ti->validity == 1? "no history" :
323                       ti->validity == 2? "little history" :
324                       ti->validity == 3? "enough history" :
325                       ti->validity == 4? "lot of history" : "?");
326               printf ("  policy: %u (%s)\n", ti->policy,
327                       ti->policy == GPGME_TOFU_POLICY_NONE? "none" :
328                       ti->policy == GPGME_TOFU_POLICY_AUTO? "auto" :
329                       ti->policy == GPGME_TOFU_POLICY_GOOD? "good" :
330                       ti->policy == GPGME_TOFU_POLICY_UNKNOWN? "unknown" :
331                       ti->policy == GPGME_TOFU_POLICY_BAD? "bad" :
332                       ti->policy == GPGME_TOFU_POLICY_ASK? "ask" : "?");
333               printf ("   nsigs: %hu\n", ti->signcount);
334               printf ("   first: %s\n", isotimestr (ti->signfirst));
335               printf ("    last: %s\n", isotimestr (ti->signlast));
336               printf ("   nencr: %hu\n", ti->encrcount);
337               printf ("   first: %s\n", isotimestr (ti->encrfirst));
338               printf ("    last: %s\n", isotimestr (ti->encrlast));
339             }
340           for (nsigs=0, ks=uid->signatures; ks; ks = ks->next, nsigs++)
341             {
342               printf ("signature %d: %s\n", nsigs, nonnull (ks->uid));
343               printf ("       keyid: %s\n", nonnull (ks->keyid));
344               printf ("     created: %s\n", isotimestr(ks->timestamp));
345               printf ("     expires: %s\n", isotimestr(ks->expires));
346               printf ("       class: %x\n", ks->sig_class);
347             }
348         }
349
350       putchar ('\n');
351
352       if (import)
353         {
354           if (keyidx < DIM (keyarray)-1)
355             keyarray[keyidx++] = key;
356           else
357             {
358               fprintf (stderr, PGM": too many keys in import mode"
359                        "- skipping this key\n");
360               gpgme_key_unref (key);
361             }
362         }
363       else
364         gpgme_key_unref (key);
365     }
366   if (gpgme_err_code (err) != GPG_ERR_EOF)
367     fail_if_err (err);
368   err = gpgme_op_keylist_end (ctx);
369   fail_if_err (err);
370   keyarray[keyidx] = NULL;
371   gpgme_data_release (data);
372
373   result = gpgme_op_keylist_result (ctx);
374   if (result->truncated)
375     {
376       fprintf (stderr, PGM ": key listing unexpectedly truncated\n");
377       exit (1);
378     }
379
380   if (import)
381     {
382       gpgme_import_result_t impres;
383
384       err = gpgme_op_import_keys (ctx, keyarray);
385       fail_if_err (err);
386       impres = gpgme_op_import_result (ctx);
387       if (!impres)
388         {
389           fprintf (stderr, PGM ": no import result returned\n");
390           exit (1);
391         }
392       print_import_result (impres);
393     }
394
395   for (keyidx=0; keyarray[keyidx]; keyidx++)
396     gpgme_key_unref (keyarray[keyidx]);
397
398   gpgme_release (ctx);
399   return 0;
400 }