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