2 * Copyright notice from original mutt:
3 * Copyright (C) 1997-2001 Thomas Roessler <roessler@does-not-exist.org>
5 * This file is part of mutt-ng, see http://www.muttng.org/.
6 * It's licensed under the GNU General Public License,
7 * please see the file GPL in the top level source directory.
11 * This is a "simple" PGP key ring dumper.
13 * The output format is supposed to be compatible to the one GnuPG
14 * emits and Mutt expects.
16 * Note that the code of this program could be considerably less
17 * complex, but most of it was taken from mutt's second generation
20 * You can actually use this to put together some fairly general
21 * PGP key management applications.
42 short Umask; /* dirty hack because we need Umask in lib.c but don't want globals.h there */
48 #include "pgppacket.h"
50 #define MD5_DIGEST_LENGTH 16
53 #define FGETPOS(fp,pos) fgetpos((fp),&(pos))
54 #define FSETPOS(fp,pos) fsetpos((fp),&(pos))
56 #define FGETPOS(fp,pos) pos=ftell((fp));
57 #define FSETPOS(fp,pos) fseek((fp),(pos),SEEK_SET)
61 static short dump_signatures = 0;
62 static short dump_fingerprints = 0;
65 static void pgpring_find_candidates (char *ringfile, const char *hints[],
67 static void pgpring_dump_keyblock (pgp_key_t p);
69 int main (int argc, char *const argv[])
76 const char *_kring = NULL;
77 char *env_pgppath, *env_home;
79 char pgppath[_POSIX_PATH_MAX];
80 char kring[_POSIX_PATH_MAX];
82 while ((c = getopt (argc, argv, "f25sk:S")) != EOF) {
92 dump_fingerprints = 1;
118 "usage: %s [-k <key ring> | [-2 | -5] [ -s] [-S] [-f]] [hints]\n",
126 strfcpy (kring, _kring, sizeof (kring));
128 if ((env_pgppath = getenv ("PGPPATH")))
129 strfcpy (pgppath, env_pgppath, sizeof (pgppath));
130 else if ((env_home = getenv ("HOME")))
131 snprintf (pgppath, sizeof (pgppath), "%s/.pgp", env_home);
133 fprintf (stderr, "%s: Can't determine your PGPPATH.\n", argv[0]);
138 snprintf (kring, sizeof (kring), "%s/secring.%s", pgppath,
139 version == 2 ? "pgp" : "skr");
141 snprintf (kring, sizeof (kring), "%s/pubring.%s", pgppath,
142 version == 2 ? "pgp" : "pkr");
145 pgpring_find_candidates (kring, (const char **) argv + optind,
152 /* The actual key ring parser */
154 static void pgp_make_pgp2_fingerprint (unsigned char *buff,
155 unsigned char *digest)
159 unsigned int size = 0;
164 size = (buff[0] << 8) + buff[1];
165 size = ((size + 7) / 8);
168 MD5Update (&context, buff, size);
171 size = (buff[0] << 8) + buff[1];
172 size = ((size + 7) / 8);
175 MD5Update (&context, buff, size);
177 MD5Final (digest, &context);
179 } /* pgp_make_pgp2_fingerprint() */
181 static pgp_key_t pgp_parse_pgp2_key (unsigned char *buff, size_t l)
185 unsigned char digest[MD5_DIGEST_LENGTH];
189 unsigned short exp_days = 0;
192 unsigned char scratch[LONG_STRING];
197 p = pgp_new_keyinfo ();
199 for (i = 0, j = 2; i < 4; i++)
200 gen_time = (gen_time << 8) + buff[j++];
202 p->gen_time = gen_time;
204 for (i = 0; i < 2; i++)
205 exp_days = (exp_days << 8) + buff[j++];
207 if (exp_days && time (NULL) > gen_time + exp_days * 24 * 3600)
208 p->flags |= KEYFLAG_EXPIRED;
213 p->algorithm = pgp_pkalgbytype (alg);
214 p->flags |= pgp_get_abilities (alg);
216 if (dump_fingerprints) {
217 /* j now points to the key material, which we need for the fingerprint */
218 p->fp_len = MD5_DIGEST_LENGTH;
219 pgp_make_pgp2_fingerprint (&buff[j], digest);
220 memcpy (p->fingerprint, digest, MD5_DIGEST_LENGTH);
222 else /* just to be usre */
223 memset (p->fingerprint, 0, MD5_DIGEST_LENGTH);
226 for (i = 0; i < 2; i++)
227 expl = (expl << 8) + buff[j++];
231 expl = (expl + 7) / 8;
238 for (k = 0; k < 2; k++) {
239 for (id = 0, i = 0; i < 4; i++)
240 id = (id << 8) + buff[j++];
242 snprintf ((char *) scratch + k * 8, sizeof (scratch) - k * 8,
246 p->keyid = safe_strdup ((char *) scratch);
256 static void pgp_make_pgp3_fingerprint (unsigned char *buff, size_t l,
257 unsigned char *digest)
262 SHA1_Init (&context);
264 dummy = buff[0] & 0x3f;
266 if (dummy == PT_SUBSECKEY || dummy == PT_SUBKEY || dummy == PT_SECKEY)
269 dummy = (dummy << 2) | 0x81;
270 SHA1_Update (&context, &dummy, 1);
271 dummy = ((l - 1) >> 8) & 0xff;
272 SHA1_Update (&context, &dummy, 1);
273 dummy = (l - 1) & 0xff;
274 SHA1_Update (&context, &dummy, 1);
275 SHA1_Update (&context, buff + 1, l - 1);
276 SHA1_Final (digest, &context);
280 static void skip_bignum (unsigned char *buff, size_t l, size_t j,
281 size_t * toff, size_t n)
286 len = (buff[j] << 8) + buff[j + 1];
287 j += (len + 7) / 8 + 2;
289 while (j <= l && --n > 0);
296 static pgp_key_t pgp_parse_pgp3_key (unsigned char *buff, size_t l)
300 unsigned char digest[SHA_DIGEST_LENGTH];
301 unsigned char scratch[LONG_STRING];
308 p = pgp_new_keyinfo ();
311 for (i = 0; i < 4; i++)
312 gen_time = (gen_time << 8) + buff[j++];
314 p->gen_time = gen_time;
319 p->algorithm = pgp_pkalgbytype (alg);
320 p->flags |= pgp_get_abilities (alg);
323 skip_bignum (buff, l, j, &j, 3);
324 else if (alg == 16 || alg == 20)
325 skip_bignum (buff, l, j, &j, 2);
327 len = (buff[j] << 8) + buff[j + 1];
331 if (alg >= 1 && alg <= 3)
332 skip_bignum (buff, l, j, &j, 2);
333 else if (alg == 17 || alg == 16 || alg == 20)
334 skip_bignum (buff, l, j, &j, 1);
336 pgp_make_pgp3_fingerprint (buff, j, digest);
337 p->fp_len = SHA_DIGEST_LENGTH;
339 for (k = 0; k < 2; k++) {
340 for (id = 0, i = SHA_DIGEST_LENGTH - 8 + k * 4;
341 i < SHA_DIGEST_LENGTH + (k - 1) * 4; i++)
342 id = (id << 8) + digest[i];
344 snprintf ((char *) scratch + k * 8, sizeof (scratch) - k * 8, "%08lX",
348 p->keyid = safe_strdup ((char *) scratch);
353 static pgp_key_t pgp_parse_keyinfo (unsigned char *buff, size_t l)
361 return pgp_parse_pgp2_key (buff, l);
363 return pgp_parse_pgp3_key (buff, l);
369 static int pgp_parse_pgp2_sig (unsigned char *buff, size_t l,
370 pgp_key_t p, pgp_sig_t * s)
372 unsigned char sigtype;
374 unsigned long signerid1;
375 unsigned long signerid2;
386 for (i = 0; i < 4; i++)
387 sig_gen_time = (sig_gen_time << 8) + buff[j++];
389 signerid1 = signerid2 = 0;
390 for (i = 0; i < 4; i++)
391 signerid1 = (signerid1 << 8) + buff[j++];
393 for (i = 0; i < 4; i++)
394 signerid2 = (signerid2 << 8) + buff[j++];
397 if (sigtype == 0x20 || sigtype == 0x28)
398 p->flags |= KEYFLAG_REVOKED;
401 s->sigtype = sigtype;
409 static int pgp_parse_pgp3_sig (unsigned char *buff, size_t l,
410 pgp_key_t p, pgp_sig_t * s)
412 unsigned char sigtype;
414 unsigned char hashalg;
416 time_t sig_gen_time = -1;
418 long key_validity = -1;
419 unsigned long signerid1 = 0;
420 unsigned long signerid2 = 0;
425 short have_critical_spks = 0;
436 for (ii = 0; ii < 2; ii++) {
440 ml = (buff[j] << 8) + buff[j + 1];
454 skl = (skl - 192) * 256 + buff[j++] + 192;
459 if ((int) ml - (int) skl < 0)
466 switch (skt & 0x7f) {
467 case 2: /* creation time */
472 for (i = 0; i < 4; i++)
473 sig_gen_time = (sig_gen_time << 8) + buff[j++];
477 case 3: /* expiration time */
482 for (i = 0; i < 4; i++)
483 validity = (validity << 8) + buff[j++];
486 case 9: /* key expiration time */
491 for (i = 0; i < 4; i++)
492 key_validity = (key_validity << 8) + buff[j++];
495 case 16: /* issuer key ID */
499 signerid2 = signerid1 = 0;
500 for (i = 0; i < 4; i++)
501 signerid1 = (signerid1 << 8) + buff[j++];
502 for (i = 0; i < 4; i++)
503 signerid2 = (signerid2 << 8) + buff[j++];
507 case 10: /* CMR key */
509 case 4: /* exportable */
512 case 7: /* revocable */
513 case 11: /* Pref. symm. alg. */
514 case 12: /* revocation key */
515 case 20: /* notation data */
516 case 21: /* pref. hash */
517 case 22: /* pref. comp.alg. */
518 case 23: /* key server prefs. */
519 case 24: /* pref. key server */
523 have_critical_spks = 1;
530 if (sigtype == 0x20 || sigtype == 0x28)
531 p->flags |= KEYFLAG_REVOKED;
532 if (key_validity != -1 && time (NULL) > p->gen_time + key_validity)
533 p->flags |= KEYFLAG_EXPIRED;
534 if (have_critical_spks)
535 p->flags |= KEYFLAG_CRITICAL;
538 s->sigtype = sigtype;
549 static int pgp_parse_sig (unsigned char *buff, size_t l,
550 pgp_key_t p, pgp_sig_t * sig)
552 if (!buff || l < 2 || !p)
558 return pgp_parse_pgp2_sig (buff, l, p, sig);
560 return pgp_parse_pgp3_sig (buff, l, p, sig);
566 /* parse one key block, including all subkeys. */
568 static pgp_key_t pgp_parse_keyblock (FILE * fp)
571 unsigned char pt = 0;
572 unsigned char last_pt;
582 pgp_key_t root = NULL;
583 pgp_key_t *last = &root;
585 pgp_uid_t *uid = NULL;
586 pgp_uid_t **addr = NULL;
587 pgp_sig_t **lsig = NULL;
591 while (!err && (buff = pgp_read_packet (fp, &l)) != NULL) {
595 /* check if we have read the complete key block. */
597 if ((pt == PT_SECKEY || pt == PT_PUBKEY) && root) {
608 if (!(*last = p = pgp_parse_keyinfo (buff, l))) {
617 if (pt == PT_SUBKEY || pt == PT_SUBSECKEY) {
618 p->flags |= KEYFLAG_SUBKEY;
621 p->address = pgp_copy_uids (root->address, p);
623 addr = &(*addr)->next;
627 if (pt == PT_SECKEY || pt == PT_SUBSECKEY)
628 p->flags |= KEYFLAG_SECRET;
636 pgp_sig_t *signature = safe_calloc (sizeof (pgp_sig_t), 1);
639 lsig = &signature->next;
641 pgp_parse_sig (buff, l, p, signature);
648 if (p && (last_pt == PT_SECKEY || last_pt == PT_PUBKEY ||
649 last_pt == PT_SUBKEY || last_pt == PT_SUBSECKEY)) {
650 if (buff[1] & 0x20) {
651 p->flags |= KEYFLAG_DISABLED;
654 else if (last_pt == PT_NAME && uid) {
655 uid->trust = buff[1];
667 chr = safe_malloc (l);
668 memcpy (chr, buff + 1, l - 1);
672 *addr = uid = safe_calloc (1, sizeof (pgp_uid_t)); /* XXX */
679 /* the following tags are generated by
683 if (strstr (chr, "ENCR"))
684 p->flags |= KEYFLAG_PREFER_ENCRYPTION;
685 if (strstr (chr, "SIGN"))
686 p->flags |= KEYFLAG_PREFER_SIGNING;
696 pgp_free_key (&root);
701 static int pgpring_string_matches_hint (const char *s, const char *hints[],
706 if (!hints || !nhints)
709 for (i = 0; i < nhints; i++) {
710 if (mutt_stristr (s, hints[i]) != NULL)
718 * Go through the key ring file and look for keys with
722 static void pgpring_find_candidates (char *ringfile, const char *hints[],
733 unsigned char *buff = NULL;
734 unsigned char pt = 0;
739 if ((rfp = fopen (ringfile, "r")) == NULL) {
741 size_t error_buf_len;
743 error_buf_len = sizeof ("fopen: ") - 1 + mutt_strlen (ringfile) + 1;
744 error_buf = safe_malloc (error_buf_len);
745 snprintf (error_buf, error_buf_len, "fopen: %s", ringfile);
752 FGETPOS (rfp, keypos);
754 while (!err && (buff = pgp_read_packet (rfp, &l)) != NULL) {
760 if ((pt == PT_SECKEY) || (pt == PT_PUBKEY)) {
763 else if (pt == PT_NAME) {
764 char *tmp = safe_malloc (l);
766 memcpy (tmp, buff + 1, l - 1);
769 /* mutt_decode_utf8_string (tmp, chs); */
771 if (pgpring_string_matches_hint (tmp, hints, nhints)) {
774 FSETPOS (rfp, keypos);
776 /* Not bailing out here would lead us into an endless loop. */
778 if ((p = pgp_parse_keyblock (rfp)) == NULL)
781 pgpring_dump_keyblock (p);
795 static void print_userid (const char *id)
797 for (; id && *id; id++) {
798 if (*id >= ' ' && *id <= 'z' && *id != ':')
801 printf ("\\x%02x", (*id) & 0xff);
805 static void print_fingerprint (pgp_key_t p)
809 printf ("fpr:::::::::");
810 for (i = 0; i < p->fp_len; i++)
811 printf ("%02X", p->fingerprint[i]);
814 } /* print_fingerprint() */
817 static void pgpring_dump_signatures (pgp_sig_t * sig)
819 for (; sig; sig = sig->next) {
820 if (sig->sigtype == 0x10 || sig->sigtype == 0x11 ||
821 sig->sigtype == 0x12 || sig->sigtype == 0x13)
822 printf ("sig::::%08lX%08lX::::::%X:\n",
823 sig->sid1, sig->sid2, sig->sigtype);
824 else if (sig->sigtype == 0x20)
825 printf ("rev::::%08lX%08lX::::::%X:\n",
826 sig->sid1, sig->sid2, sig->sigtype);
831 static char gnupg_trustletter (int t)
844 static void pgpring_dump_keyblock (pgp_key_t p)
851 for (; p; p = p->next) {
854 if (p->flags & KEYFLAG_SECRET) {
855 if (p->flags & KEYFLAG_SUBKEY)
861 if (p->flags & KEYFLAG_SUBKEY)
867 if (p->flags & KEYFLAG_REVOKED)
869 if (p->flags & KEYFLAG_EXPIRED)
871 if (p->flags & KEYFLAG_DISABLED)
874 for (uid = p->address; uid; uid = uid->next, first = 0) {
876 printf ("uid:%c::::::::", gnupg_trustletter (uid->trust));
877 print_userid (uid->addr);
881 if (p->flags & KEYFLAG_SECRET)
884 putchar (gnupg_trustletter (uid->trust));
889 printf (":%d:%d:%s:%04d-%02d-%02d::::", p->keylen, p->numalg,
890 p->keyid, 1900 + tp->tm_year, tp->tm_mon + 1, tp->tm_mday);
892 print_userid (uid->addr);
895 if (pgp_canencrypt (p->numalg))
897 if (pgp_cansign (p->numalg))
899 if (p->flags & KEYFLAG_DISABLED)
903 if (dump_fingerprints)
904 print_fingerprint (p);
907 if (dump_signatures) {
909 pgpring_dump_signatures (p->sigs);
910 pgpring_dump_signatures (uid->sigs);
917 * The mutt_gettext () defined in gettext.c requires iconv,
918 * so we do without charset conversion here.
921 char *mutt_gettext (const char *message)
923 return (char *) message;