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