tests/gpg/pgp-keylist.c

   1 /* pgp-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 <http://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
  30 #include <gpgme.h>
  31
  32 #define PGM "pgp-keylist"
  33
  34 #include "t-support.h"
  35
  36
  37 static int verbose;
  38
  39
  40 static const char *
  41 nonnull (const char *s)
  42 {
  43   return s? s :"[none]";
  44 }
  45
  46
  47 static void
  48 print_import_result (gpgme_import_result_t r)
  49 {
  50   gpgme_import_status_t st;
  51
  52   printf ("key import results:\n"
  53           "        considered: %d\n"
  54           "        no user id: %d\n"
  55           "          imported: %d\n"
  56           "      imported_rsa: %d\n"
  57           "         unchanged: %d\n"
  58           "      new user ids: %d\n"
  59           "       new subkeys: %d\n"
  60           "    new signatures: %d\n"
  61           "   new revocations: %d\n"
  62           "       secret read: %d\n"
  63           "   secret imported: %d\n"
  64           "  secret unchanged: %d\n"
  65           "  skipped new keys: %d\n"
  66           "      not imported: %d\n",
  67           r->considered,
  68           r->no_user_id,
  69           r->imported,
  70           r->imported_rsa,
  71           r->unchanged,
  72           r->new_user_ids,
  73           r->new_sub_keys,
  74           r->new_signatures,
  75           r->new_revocations,
  76           r->secret_read,
  77           r->secret_imported,
  78           r->secret_unchanged,
  79           r->skipped_new_keys,
  80           r->not_imported);
  81
  82   for (st=r->imports; st; st = st->next)
  83     {
  84       printf ("  fpr: %s err: %d (%s) status:", nonnull (st->fpr),
  85               st->result, gpg_strerror (st->result));
  86       if (st->status & GPGME_IMPORT_NEW)
  87         fputs (" new", stdout);
  88       if (st->status & GPGME_IMPORT_UID)
  89         fputs (" uid", stdout);
  90       if (st->status & GPGME_IMPORT_SIG)
  91         fputs (" sig", stdout);
  92       if (st->status & GPGME_IMPORT_SUBKEY)
  93         fputs (" subkey", stdout);
  94       if (st->status & GPGME_IMPORT_SECRET)
  95         fputs (" secret", stdout);
  96       putchar ('\n');
  97     }
  98 }
  99
 100
 101 static int
 102 show_usage (int ex)
 103 {
 104   fputs ("usage: " PGM " [options] [USERID]\n\n"
 105          "Options:\n"
 106          "  --verbose        run in verbose mode\n"
 107          "  --local          use GPGME_KEYLIST_MODE_LOCAL\n"
 108          "  --extern         use GPGME_KEYLIST_MODE_EXTERN\n"
 109          "  --sigs           use GPGME_KEYLIST_MODE_SIGS\n"
 110          "  --sig-notations  use GPGME_KEYLIST_MODE_SIG_NOTATIONS\n"
 111          "  --ephemeral      use GPGME_KEYLIST_MODE_EPHEMERAL\n"
 112          "  --validate       use GPGME_KEYLIST_MODE_VALIDATE\n"
 113          "  --import         import all keys\n"
 114          , stderr);
 115   exit (ex);
 116 }
 117
 118 int
 119 main (int argc, char **argv)
 120 {
 121   int last_argc = -1;
 122   gpgme_error_t err;
 123   gpgme_ctx_t ctx;
 124   gpgme_keylist_mode_t mode = 0;
 125   gpgme_key_t key;
 126   gpgme_keylist_result_t result;
 127   int import = 0;
 128   gpgme_key_t keyarray[100];
 129   int keyidx = 0;
 130
 131   if (argc)
 132     { argc--; argv++; }
 133
 134   while (argc && last_argc != argc )
 135     {
 136       last_argc = argc;
 137       if (!strcmp (*argv, "--"))
 138         {
 139           argc--; argv++;
 140           break;
 141         }
 142       else if (!strcmp (*argv, "--help"))
 143         show_usage (0);
 144       else if (!strcmp (*argv, "--verbose"))
 145         {
 146           verbose = 1;
 147           argc--; argv++;
 148         }
 149       else if (!strcmp (*argv, "--local"))
 150         {
 151           mode |= GPGME_KEYLIST_MODE_LOCAL;
 152           argc--; argv++;
 153         }
 154       else if (!strcmp (*argv, "--extern"))
 155         {
 156           mode |= GPGME_KEYLIST_MODE_EXTERN;
 157           argc--; argv++;
 158         }
 159       else if (!strcmp (*argv, "--sigs"))
 160         {
 161           mode |= GPGME_KEYLIST_MODE_SIGS;
 162           argc--; argv++;
 163         }
 164       else if (!strcmp (*argv, "--sig-notations"))
 165         {
 166           mode |= GPGME_KEYLIST_MODE_SIG_NOTATIONS;
 167           argc--; argv++;
 168         }
 169       else if (!strcmp (*argv, "--ephemeral"))
 170         {
 171           mode |= GPGME_KEYLIST_MODE_EPHEMERAL;
 172           argc--; argv++;
 173         }
 174       else if (!strcmp (*argv, "--validate"))
 175         {
 176           mode |= GPGME_KEYLIST_MODE_VALIDATE;
 177           argc--; argv++;
 178         }
 179       else if (!strcmp (*argv, "--import"))
 180         {
 181           import = 1;
 182           argc--; argv++;
 183         }
 184       else if (!strncmp (*argv, "--", 2))
 185         show_usage (1);
 186
 187     }
 188
 189   if (argc > 1)
 190     show_usage (1);
 191
 192   init_gpgme (GPGME_PROTOCOL_OpenPGP);
 193
 194   err = gpgme_new (&ctx);
 195   fail_if_err (err);
 196   gpgme_set_protocol (ctx, GPGME_PROTOCOL_OpenPGP);
 197
 198   gpgme_set_keylist_mode (ctx, mode);
 199
 200   err = gpgme_op_keylist_start (ctx, argc? argv[0]:NULL, 0);
 201   fail_if_err (err);
 202
 203   while (!(err = gpgme_op_keylist_next (ctx, &key)))
 204     {
 205       gpgme_user_id_t uid;
 206       int nuids;
 207
 208
 209       printf ("keyid   : %s\n", key->subkeys?nonnull (key->subkeys->keyid):"?");
 210       printf ("fpr     : %s\n", key->subkeys?nonnull (key->subkeys->fpr):"?");
 211       printf ("caps    : %s%s%s%s\n",
 212               key->can_encrypt? "e":"",
 213               key->can_sign? "s":"",
 214               key->can_certify? "c":"",
 215               key->can_authenticate? "a":"");
 216       printf ("flags   :%s%s%s%s%s%s\n",
 217               key->secret? " secret":"",
 218               key->revoked? " revoked":"",
 219               key->expired? " expired":"",
 220               key->disabled? " disabled":"",
 221               key->invalid? " invalid":"",
 222               key->is_qualified? " qualifid":"");
 223       for (nuids=0, uid=key->uids; uid; uid = uid->next, nuids++)
 224         {
 225           printf ("userid %d: %s\n", nuids, nonnull(uid->uid));
 226           printf ("valid  %d: %s\n", nuids,
 227                   uid->validity == GPGME_VALIDITY_UNKNOWN? "unknown":
 228                   uid->validity == GPGME_VALIDITY_UNDEFINED? "undefined":
 229                   uid->validity == GPGME_VALIDITY_NEVER? "never":
 230                   uid->validity == GPGME_VALIDITY_MARGINAL? "marginal":
 231                   uid->validity == GPGME_VALIDITY_FULL? "full":
 232                   uid->validity == GPGME_VALIDITY_ULTIMATE? "ultimate": "[?]");
 233         }
 234
 235       putchar ('\n');
 236
 237       if (import)
 238         {
 239           if (keyidx < DIM (keyarray)-1)
 240             keyarray[keyidx++] = key;
 241           else
 242             {
 243               fprintf (stderr, PGM": too many keys in import mode"
 244                        "- skipping this key\n");
 245               gpgme_key_unref (key);
 246             }
 247         }
 248       else
 249         gpgme_key_unref (key);
 250     }
 251   if (gpg_err_code (err) != GPG_ERR_EOF)
 252     fail_if_err (err);
 253   err = gpgme_op_keylist_end (ctx);
 254   fail_if_err (err);
 255   keyarray[keyidx] = NULL;
 256
 257   result = gpgme_op_keylist_result (ctx);
 258   if (result->truncated)
 259     {
 260       fprintf (stderr, PGM ": key listing unexpectedly truncated\n");
 261       exit (1);
 262     }
 263
 264   if (import)
 265     {
 266       gpgme_import_result_t impres;
 267
 268       err = gpgme_op_import_keys (ctx, keyarray);
 269       fail_if_err (err);
 270       impres = gpgme_op_import_result (ctx);
 271       if (!impres)
 272         {
 273           fprintf (stderr, PGM ": no import result returned\n");
 274           exit (1);
 275         }
 276       print_import_result (impres);
 277     }
 278
 279   for (keyidx=0; keyarray[keyidx]; keyidx++)
 280     gpgme_key_unref (keyarray[keyidx]);
 281
 282   gpgme_release (ctx);
 283   return 0;
 284 }