Blame tests/run-keylist.c

Packit d7e8d0
/* run-keylist.c  - Helper to show a key listing.
Packit Service 30b792
 * Copyright (C) 2008, 2009 g10 Code GmbH
Packit Service 30b792
 *
Packit Service 30b792
 * This file is part of GPGME.
Packit Service 30b792
 *
Packit Service 30b792
 * GPGME is free software; you can redistribute it and/or modify it
Packit Service 30b792
 * under the terms of the GNU Lesser General Public License as
Packit Service 30b792
 * published by the Free Software Foundation; either version 2.1 of
Packit Service 30b792
 * the License, or (at your option) any later version.
Packit Service 30b792
 *
Packit Service 30b792
 * GPGME is distributed in the hope that it will be useful, but
Packit Service 30b792
 * WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 30b792
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit Service 30b792
 * Lesser General Public License for more details.
Packit Service 30b792
 *
Packit Service 30b792
 * You should have received a copy of the GNU Lesser General Public
Packit Service 30b792
 * License along with this program; if not, see <https://gnu.org/licenses/>.
Packit Service 30b792
 * SPDX-License-Identifier: LGPL-2.1-or-later
Packit Service 30b792
 */
Packit d7e8d0
Packit d7e8d0
/* We need to include config.h so that we know whether we are building
Packit d7e8d0
   with large file system (LFS) support. */
Packit d7e8d0
#ifdef HAVE_CONFIG_H
Packit d7e8d0
#include <config.h>
Packit d7e8d0
#endif
Packit d7e8d0
Packit d7e8d0
#include <stdlib.h>
Packit d7e8d0
#include <stdio.h>
Packit d7e8d0
#include <string.h>
Packit d7e8d0
#include <time.h>
Packit d7e8d0
Packit d7e8d0
#include <gpgme.h>
Packit d7e8d0
Packit d7e8d0
#define PGM "run-keylist"
Packit d7e8d0
Packit d7e8d0
#include "run-support.h"
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
static int verbose;
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
static int
Packit d7e8d0
show_usage (int ex)
Packit d7e8d0
{
Packit d7e8d0
  fputs ("usage: " PGM " [options] [USERID_or_FILE]\n\n"
Packit d7e8d0
         "Options:\n"
Packit d7e8d0
         "  --verbose        run in verbose mode\n"
Packit d7e8d0
         "  --openpgp        use the OpenPGP protocol (default)\n"
Packit d7e8d0
         "  --cms            use the CMS protocol\n"
Packit d7e8d0
         "  --secret         list only secret keys\n"
Packit Service 30b792
         "  --with-secret    list pubkeys with secret info filled\n"
Packit d7e8d0
         "  --local          use GPGME_KEYLIST_MODE_LOCAL\n"
Packit d7e8d0
         "  --extern         use GPGME_KEYLIST_MODE_EXTERN\n"
Packit d7e8d0
         "  --sigs           use GPGME_KEYLIST_MODE_SIGS\n"
Packit d7e8d0
         "  --tofu           use GPGME_KEYLIST_MODE_TOFU\n"
Packit d7e8d0
         "  --sig-notations  use GPGME_KEYLIST_MODE_SIG_NOTATIONS\n"
Packit d7e8d0
         "  --ephemeral      use GPGME_KEYLIST_MODE_EPHEMERAL\n"
Packit d7e8d0
         "  --validate       use GPGME_KEYLIST_MODE_VALIDATE\n"
Packit d7e8d0
         "  --import         import all keys\n"
Packit d7e8d0
         "  --offline        use offline mode\n"
Packit d7e8d0
         "  --from-file      list all keys in the given file\n"
Packit Service 30b792
         "  --from-wkd       list key from a web key directory\n"
Packit d7e8d0
         "  --require-gnupg  required at least the given GnuPG version\n"
Packit Service 30b792
         "  --trust-model    use the specified trust-model\n"
Packit d7e8d0
         , stderr);
Packit d7e8d0
  exit (ex);
Packit d7e8d0
}
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
static const char *
Packit d7e8d0
isotimestr (unsigned long value)
Packit d7e8d0
{
Packit d7e8d0
  time_t t;
Packit d7e8d0
  static char buffer[25+5];
Packit d7e8d0
  struct tm *tp;
Packit d7e8d0
Packit d7e8d0
  if (!value)
Packit d7e8d0
    return "none";
Packit d7e8d0
  t = value;
Packit d7e8d0
Packit d7e8d0
  tp = gmtime (&t);
Packit d7e8d0
  snprintf (buffer, sizeof buffer, "%04d-%02d-%02d %02d:%02d:%02d",
Packit d7e8d0
            1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday,
Packit d7e8d0
            tp->tm_hour, tp->tm_min, tp->tm_sec);
Packit d7e8d0
  return buffer;
Packit d7e8d0
}
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
int
Packit d7e8d0
main (int argc, char **argv)
Packit d7e8d0
{
Packit d7e8d0
  int last_argc = -1;
Packit d7e8d0
  gpgme_error_t err;
Packit d7e8d0
  gpgme_ctx_t ctx;
Packit d7e8d0
  gpgme_keylist_mode_t mode = 0;
Packit d7e8d0
  gpgme_key_t key;
Packit d7e8d0
  gpgme_subkey_t subkey;
Packit d7e8d0
  gpgme_keylist_result_t result;
Packit d7e8d0
  int import = 0;
Packit d7e8d0
  gpgme_key_t keyarray[100];
Packit d7e8d0
  int keyidx = 0;
Packit d7e8d0
  gpgme_protocol_t protocol = GPGME_PROTOCOL_OpenPGP;
Packit d7e8d0
  int only_secret = 0;
Packit d7e8d0
  int offline = 0;
Packit d7e8d0
  int from_file = 0;
Packit Service 30b792
  int from_wkd = 0;
Packit d7e8d0
  gpgme_data_t data = NULL;
Packit Service 30b792
  char *trust_model = NULL;
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
  if (argc)
Packit d7e8d0
    { argc--; argv++; }
Packit d7e8d0
Packit d7e8d0
  while (argc && last_argc != argc )
Packit d7e8d0
    {
Packit d7e8d0
      last_argc = argc;
Packit d7e8d0
      if (!strcmp (*argv, "--"))
Packit d7e8d0
        {
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
          break;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--help"))
Packit d7e8d0
        show_usage (0);
Packit d7e8d0
      else if (!strcmp (*argv, "--verbose"))
Packit d7e8d0
        {
Packit d7e8d0
          verbose = 1;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--openpgp"))
Packit d7e8d0
        {
Packit d7e8d0
          protocol = GPGME_PROTOCOL_OpenPGP;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--cms"))
Packit d7e8d0
        {
Packit d7e8d0
          protocol = GPGME_PROTOCOL_CMS;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--secret"))
Packit d7e8d0
        {
Packit d7e8d0
          only_secret = 1;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--local"))
Packit d7e8d0
        {
Packit d7e8d0
          mode |= GPGME_KEYLIST_MODE_LOCAL;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--extern"))
Packit d7e8d0
        {
Packit d7e8d0
          mode |= GPGME_KEYLIST_MODE_EXTERN;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--tofu"))
Packit d7e8d0
        {
Packit d7e8d0
          mode |= GPGME_KEYLIST_MODE_WITH_TOFU;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--sigs"))
Packit d7e8d0
        {
Packit d7e8d0
          mode |= GPGME_KEYLIST_MODE_SIGS;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--sig-notations"))
Packit d7e8d0
        {
Packit d7e8d0
          mode |= GPGME_KEYLIST_MODE_SIG_NOTATIONS;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--ephemeral"))
Packit d7e8d0
        {
Packit d7e8d0
          mode |= GPGME_KEYLIST_MODE_EPHEMERAL;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--validate"))
Packit d7e8d0
        {
Packit d7e8d0
          mode |= GPGME_KEYLIST_MODE_VALIDATE;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit Service 30b792
      else if (!strcmp (*argv, "--with-secret"))
Packit Service 30b792
        {
Packit Service 30b792
          mode |= GPGME_KEYLIST_MODE_WITH_SECRET;
Packit Service 30b792
          argc--; argv++;
Packit Service 30b792
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--import"))
Packit d7e8d0
        {
Packit d7e8d0
          import = 1;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--offline"))
Packit d7e8d0
        {
Packit d7e8d0
          offline = 1;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--from-file"))
Packit d7e8d0
        {
Packit d7e8d0
          from_file = 1;
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit d7e8d0
      else if (!strcmp (*argv, "--require-gnupg"))
Packit d7e8d0
        {
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
          if (!argc)
Packit d7e8d0
            show_usage (1);
Packit d7e8d0
          gpgme_set_global_flag ("require-gnupg", *argv);
Packit d7e8d0
          argc--; argv++;
Packit d7e8d0
        }
Packit Service 30b792
      else if (!strcmp (*argv, "--from-wkd"))
Packit Service 30b792
        {
Packit Service 30b792
          argc--; argv++;
Packit Service 30b792
          mode |= GPGME_KEYLIST_MODE_LOCATE;
Packit Service 30b792
          from_wkd = 1;
Packit Service 30b792
        }
Packit Service 30b792
      else if (!strcmp (*argv, "--trust-model"))
Packit Service 30b792
        {
Packit Service 30b792
          argc--; argv++;
Packit Service 30b792
          if (!argc)
Packit Service 30b792
            show_usage (1);
Packit Service 30b792
          trust_model = strdup (*argv);
Packit Service 30b792
          argc--; argv++;
Packit Service 30b792
        }
Packit d7e8d0
      else if (!strncmp (*argv, "--", 2))
Packit d7e8d0
        show_usage (1);
Packit d7e8d0
    }
Packit d7e8d0
Packit d7e8d0
  if (argc > 1)
Packit d7e8d0
    show_usage (1);
Packit d7e8d0
  else if (from_file && !argc)
Packit d7e8d0
    show_usage (1);
Packit d7e8d0
Packit d7e8d0
  init_gpgme (protocol);
Packit d7e8d0
Packit d7e8d0
  err = gpgme_new (&ctx;;
Packit d7e8d0
  fail_if_err (err);
Packit d7e8d0
  gpgme_set_protocol (ctx, protocol);
Packit d7e8d0
Packit d7e8d0
  gpgme_set_keylist_mode (ctx, mode);
Packit d7e8d0
Packit d7e8d0
  gpgme_set_offline (ctx, offline);
Packit d7e8d0
Packit Service 30b792
  if (trust_model)
Packit Service 30b792
    {
Packit Service 30b792
      err = gpgme_set_ctx_flag (ctx, "trust-model", trust_model);
Packit Service 30b792
      fail_if_err (err);
Packit Service 30b792
    }
Packit Service 30b792
Packit Service 30b792
  if (from_wkd)
Packit Service 30b792
    {
Packit Service 30b792
      err = gpgme_set_ctx_flag (ctx, "auto-key-locate",
Packit Service 30b792
                                "clear,nodefault,wkd");
Packit Service 30b792
      fail_if_err (err);
Packit Service 30b792
    }
Packit Service 30b792
Packit d7e8d0
  if (from_file)
Packit d7e8d0
    {
Packit d7e8d0
      err = gpgme_data_new_from_file (&data, *argv, 1);
Packit d7e8d0
      fail_if_err (err);
Packit d7e8d0
Packit d7e8d0
      err = gpgme_op_keylist_from_data_start (ctx, data, 0);
Packit d7e8d0
    }
Packit d7e8d0
  else
Packit d7e8d0
    err = gpgme_op_keylist_start (ctx, argc? argv[0]:NULL, only_secret);
Packit d7e8d0
  fail_if_err (err);
Packit d7e8d0
Packit d7e8d0
  while (!(err = gpgme_op_keylist_next (ctx, &key)))
Packit d7e8d0
    {
Packit d7e8d0
      gpgme_user_id_t uid;
Packit d7e8d0
      gpgme_tofu_info_t ti;
Packit d7e8d0
      gpgme_key_sig_t ks;
Packit d7e8d0
      int nuids;
Packit d7e8d0
      int nsub;
Packit d7e8d0
      int nsigs;
Packit d7e8d0
Packit d7e8d0
      printf ("keyid   : %s\n", key->subkeys?nonnull (key->subkeys->keyid):"?");
Packit d7e8d0
      printf ("fpr     : %s\n", key->subkeys?nonnull (key->subkeys->fpr):"?");
Packit d7e8d0
      if (key->subkeys && key->subkeys->keygrip)
Packit d7e8d0
        printf ("grip    : %s\n", key->subkeys->keygrip);
Packit d7e8d0
      if (key->subkeys && key->subkeys->curve)
Packit d7e8d0
            printf ("curve   : %s\n", key->subkeys->curve);
Packit d7e8d0
      printf ("caps    : %s%s%s%s\n",
Packit d7e8d0
              key->can_encrypt? "e":"",
Packit d7e8d0
              key->can_sign? "s":"",
Packit d7e8d0
              key->can_certify? "c":"",
Packit d7e8d0
              key->can_authenticate? "a":"");
Packit d7e8d0
      printf ("flags   :%s%s%s%s%s%s%s%s\n",
Packit d7e8d0
              key->secret? " secret":"",
Packit d7e8d0
              key->revoked? " revoked":"",
Packit d7e8d0
              key->expired? " expired":"",
Packit d7e8d0
              key->disabled? " disabled":"",
Packit d7e8d0
              key->invalid? " invalid":"",
Packit d7e8d0
              key->is_qualified? " qualified":"",
Packit d7e8d0
              key->subkeys && key->subkeys->is_de_vs? " de-vs":"",
Packit d7e8d0
              key->subkeys && key->subkeys->is_cardkey? " cardkey":"");
Packit d7e8d0
      printf ("upd     : %lu (%u)\n", key->last_update, key->origin);
Packit d7e8d0
Packit d7e8d0
      subkey = key->subkeys;
Packit d7e8d0
      if (subkey)
Packit d7e8d0
        subkey = subkey->next;
Packit d7e8d0
      for (nsub=1; subkey; subkey = subkey->next, nsub++)
Packit d7e8d0
        {
Packit d7e8d0
          printf ("fpr   %2d: %s\n", nsub, nonnull (subkey->fpr));
Packit d7e8d0
          if (subkey->keygrip)
Packit d7e8d0
            printf ("grip  %2d: %s\n", nsub, subkey->keygrip);
Packit d7e8d0
          if (subkey->curve)
Packit d7e8d0
            printf ("curve %2d: %s\n", nsub, subkey->curve);
Packit d7e8d0
          printf ("caps  %2d: %s%s%s%s\n",
Packit d7e8d0
                  nsub,
Packit d7e8d0
                  subkey->can_encrypt? "e":"",
Packit d7e8d0
                  subkey->can_sign? "s":"",
Packit d7e8d0
                  subkey->can_certify? "c":"",
Packit d7e8d0
                  subkey->can_authenticate? "a":"");
Packit d7e8d0
          printf ("flags %2d:%s%s%s%s%s%s%s%s\n",
Packit d7e8d0
                  nsub,
Packit d7e8d0
                  subkey->secret? " secret":"",
Packit d7e8d0
                  subkey->revoked? " revoked":"",
Packit d7e8d0
                  subkey->expired? " expired":"",
Packit d7e8d0
                  subkey->disabled? " disabled":"",
Packit d7e8d0
                  subkey->invalid? " invalid":"",
Packit d7e8d0
                  subkey->is_qualified? " qualified":"",
Packit d7e8d0
                  subkey->is_de_vs? " de-vs":"",
Packit d7e8d0
                  subkey->is_cardkey? " cardkey":"");
Packit d7e8d0
        }
Packit d7e8d0
      for (nuids=0, uid=key->uids; uid; uid = uid->next, nuids++)
Packit d7e8d0
        {
Packit d7e8d0
          printf ("userid %d: %s\n", nuids, nonnull(uid->uid));
Packit d7e8d0
          printf ("    mbox: %s\n", nonnull(uid->address));
Packit d7e8d0
          if (uid->email && uid->email != uid->address)
Packit d7e8d0
            printf ("   email: %s\n", uid->email);
Packit d7e8d0
          if (uid->name)
Packit d7e8d0
            printf ("    name: %s\n", uid->name);
Packit d7e8d0
          if (uid->comment)
Packit d7e8d0
            printf ("   cmmnt: %s\n", uid->comment);
Packit d7e8d0
          printf ("     upd: %lu (%u)\n", uid->last_update, uid->origin);
Packit d7e8d0
          printf ("   valid: %s\n",
Packit d7e8d0
                  uid->validity == GPGME_VALIDITY_UNKNOWN? "unknown":
Packit d7e8d0
                  uid->validity == GPGME_VALIDITY_UNDEFINED? "undefined":
Packit d7e8d0
                  uid->validity == GPGME_VALIDITY_NEVER? "never":
Packit d7e8d0
                  uid->validity == GPGME_VALIDITY_MARGINAL? "marginal":
Packit d7e8d0
                  uid->validity == GPGME_VALIDITY_FULL? "full":
Packit d7e8d0
                  uid->validity == GPGME_VALIDITY_ULTIMATE? "ultimate": "[?]");
Packit d7e8d0
          if ((ti = uid->tofu))
Packit d7e8d0
            {
Packit d7e8d0
              printf ("    tofu: %u (%s)\n", ti->validity,
Packit d7e8d0
                      ti->validity == 0? "conflict" :
Packit d7e8d0
                      ti->validity == 1? "no history" :
Packit d7e8d0
                      ti->validity == 2? "little history" :
Packit d7e8d0
                      ti->validity == 3? "enough history" :
Packit d7e8d0
                      ti->validity == 4? "lot of history" : "?");
Packit d7e8d0
              printf ("  policy: %u (%s)\n", ti->policy,
Packit d7e8d0
                      ti->policy == GPGME_TOFU_POLICY_NONE? "none" :
Packit d7e8d0
                      ti->policy == GPGME_TOFU_POLICY_AUTO? "auto" :
Packit d7e8d0
                      ti->policy == GPGME_TOFU_POLICY_GOOD? "good" :
Packit d7e8d0
                      ti->policy == GPGME_TOFU_POLICY_UNKNOWN? "unknown" :
Packit d7e8d0
                      ti->policy == GPGME_TOFU_POLICY_BAD? "bad" :
Packit d7e8d0
                      ti->policy == GPGME_TOFU_POLICY_ASK? "ask" : "?");
Packit d7e8d0
              printf ("   nsigs: %hu\n", ti->signcount);
Packit d7e8d0
              printf ("   first: %s\n", isotimestr (ti->signfirst));
Packit d7e8d0
              printf ("    last: %s\n", isotimestr (ti->signlast));
Packit d7e8d0
              printf ("   nencr: %hu\n", ti->encrcount);
Packit d7e8d0
              printf ("   first: %s\n", isotimestr (ti->encrfirst));
Packit d7e8d0
              printf ("    last: %s\n", isotimestr (ti->encrlast));
Packit d7e8d0
            }
Packit d7e8d0
          for (nsigs=0, ks=uid->signatures; ks; ks = ks->next, nsigs++)
Packit d7e8d0
            {
Packit d7e8d0
              printf ("signature %d: %s\n", nsigs, nonnull (ks->uid));
Packit d7e8d0
              printf ("       keyid: %s\n", nonnull (ks->keyid));
Packit d7e8d0
              printf ("     created: %s\n", isotimestr(ks->timestamp));
Packit d7e8d0
              printf ("     expires: %s\n", isotimestr(ks->expires));
Packit d7e8d0
              printf ("       class: %x\n", ks->sig_class);
Packit d7e8d0
            }
Packit d7e8d0
        }
Packit d7e8d0
Packit d7e8d0
      putchar ('\n');
Packit d7e8d0
Packit d7e8d0
      if (import)
Packit d7e8d0
        {
Packit d7e8d0
          if (keyidx < DIM (keyarray)-1)
Packit d7e8d0
            keyarray[keyidx++] = key;
Packit d7e8d0
          else
Packit d7e8d0
            {
Packit d7e8d0
              fprintf (stderr, PGM": too many keys in import mode"
Packit d7e8d0
                       "- skipping this key\n");
Packit d7e8d0
              gpgme_key_unref (key);
Packit d7e8d0
            }
Packit d7e8d0
        }
Packit d7e8d0
      else
Packit d7e8d0
        gpgme_key_unref (key);
Packit d7e8d0
    }
Packit d7e8d0
  if (gpgme_err_code (err) != GPG_ERR_EOF)
Packit d7e8d0
    fail_if_err (err);
Packit d7e8d0
  err = gpgme_op_keylist_end (ctx);
Packit d7e8d0
  fail_if_err (err);
Packit d7e8d0
  keyarray[keyidx] = NULL;
Packit d7e8d0
  gpgme_data_release (data);
Packit d7e8d0
Packit d7e8d0
  result = gpgme_op_keylist_result (ctx);
Packit d7e8d0
  if (result->truncated)
Packit d7e8d0
    {
Packit d7e8d0
      fprintf (stderr, PGM ": key listing unexpectedly truncated\n");
Packit d7e8d0
      exit (1);
Packit d7e8d0
    }
Packit d7e8d0
Packit d7e8d0
  if (import)
Packit d7e8d0
    {
Packit d7e8d0
      gpgme_import_result_t impres;
Packit d7e8d0
Packit d7e8d0
      err = gpgme_op_import_keys (ctx, keyarray);
Packit d7e8d0
      fail_if_err (err);
Packit d7e8d0
      impres = gpgme_op_import_result (ctx);
Packit d7e8d0
      if (!impres)
Packit d7e8d0
        {
Packit d7e8d0
          fprintf (stderr, PGM ": no import result returned\n");
Packit d7e8d0
          exit (1);
Packit d7e8d0
        }
Packit d7e8d0
      print_import_result (impres);
Packit d7e8d0
    }
Packit d7e8d0
Packit d7e8d0
  for (keyidx=0; keyarray[keyidx]; keyidx++)
Packit d7e8d0
    gpgme_key_unref (keyarray[keyidx]);
Packit d7e8d0
Packit Service 30b792
  free (trust_model);
Packit Service 30b792
Packit d7e8d0
  gpgme_release (ctx);
Packit d7e8d0
  return 0;
Packit d7e8d0
}