2 * Copyright (C) 1997-2001 Thomas Roessler <roessler@does-not-exist.org>
4 * This program is free software; you can redistribute it
5 * and/or modify it under the terms of the GNU General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later
10 * This program is distributed in the hope that it will be
11 * useful, but WITHOUT ANY WARRANTY; without even the implied
12 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
13 * PURPOSE. See the GNU General Public License for more
16 * You should have received a copy of the GNU General Public
17 * License along with this program; if not, write to the Free
18 * Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111, USA.
23 * This is a "simple" PGP key ring dumper.
25 * The output format is supposed to be compatible to the one GnuPG
26 * emits and Mutt expects.
28 * Note that the code of this program could be considerably less
29 * complex, but most of it was taken from mutt's second generation
32 * You can actually use this to put together some fairly general
33 * PGP key management applications.
57 #include "pgppacket.h"
59 #define MD5_DIGEST_LENGTH 16
62 #define FGETPOS(fp,pos) fgetpos((fp),&(pos))
63 #define FSETPOS(fp,pos) fsetpos((fp),&(pos))
65 #define FGETPOS(fp,pos) pos=ftell((fp));
66 #define FSETPOS(fp,pos) fseek((fp),(pos),SEEK_SET)
70 static short dump_signatures = 0;
71 static short dump_fingerprints = 0;
74 static void pgpring_find_candidates (char *ringfile, const char *hints[], int nhints);
75 static void pgpring_dump_keyblock (pgp_key_t p);
77 int main (int argc, char * const argv[])
84 const char *_kring = NULL;
85 char *env_pgppath, *env_home;
87 char pgppath[_POSIX_PATH_MAX];
88 char kring[_POSIX_PATH_MAX];
90 while ((c = getopt (argc, argv, "f25sk:S")) != EOF)
102 dump_fingerprints = 1;
126 fprintf (stderr, "usage: %s [-k <key ring> | [-2 | -5] [ -s] [-S] [-f]] [hints]\n",
134 strfcpy (kring, _kring, sizeof (kring));
137 if ((env_pgppath = getenv ("PGPPATH")))
138 strfcpy (pgppath, env_pgppath, sizeof (pgppath));
139 else if ((env_home = getenv ("HOME")))
140 snprintf (pgppath, sizeof (pgppath), "%s/.pgp", env_home);
143 fprintf (stderr, "%s: Can't determine your PGPPATH.\n", argv[0]);
148 snprintf (kring, sizeof (kring), "%s/secring.%s", pgppath, version == 2 ? "pgp" : "skr");
150 snprintf (kring, sizeof (kring), "%s/pubring.%s", pgppath, version == 2 ? "pgp" : "pkr");
153 pgpring_find_candidates (kring, (const char**) argv + optind, argc - optind);
159 /* The actual key ring parser */
161 static void pgp_make_pgp2_fingerprint (unsigned char *buff,
162 unsigned char *digest)
166 unsigned int size = 0;
171 size = (buff[0] << 8) + buff[1];
172 size = ((size + 7) / 8);
175 MD5Update (&context, buff, size);
178 size = (buff[0] << 8) + buff[1];
179 size = ((size + 7) / 8);
182 MD5Update (&context, buff, size);
184 MD5Final (digest, &context);
186 } /* pgp_make_pgp2_fingerprint() */
188 static pgp_key_t pgp_parse_pgp2_key (unsigned char *buff, size_t l)
192 unsigned char digest[MD5_DIGEST_LENGTH];
196 unsigned short exp_days = 0;
199 unsigned char scratch[LONG_STRING];
204 p = pgp_new_keyinfo();
206 for (i = 0, j = 2; i < 4; i++)
207 gen_time = (gen_time << 8) + buff[j++];
209 p->gen_time = gen_time;
211 for (i = 0; i < 2; i++)
212 exp_days = (exp_days << 8) + buff[j++];
214 if (exp_days && time (NULL) > gen_time + exp_days * 24 * 3600)
215 p->flags |= KEYFLAG_EXPIRED;
220 p->algorithm = pgp_pkalgbytype (alg);
221 p->flags |= pgp_get_abilities (alg);
223 if (dump_fingerprints)
225 /* j now points to the key material, which we need for the fingerprint */
226 p->fp_len = MD5_DIGEST_LENGTH;
227 pgp_make_pgp2_fingerprint (&buff[j], digest);
228 memcpy (p->fingerprint, digest, MD5_DIGEST_LENGTH);
230 else /* just to be usre */
231 memset (p->fingerprint, 0, MD5_DIGEST_LENGTH);
234 for (i = 0; i < 2; i++)
235 expl = (expl << 8) + buff[j++];
239 expl = (expl + 7) / 8;
246 for (k = 0; k < 2; k++)
248 for (id = 0, i = 0; i < 4; i++)
249 id = (id << 8) + buff[j++];
251 snprintf ((char *) scratch + k * 8, sizeof (scratch) - k * 8,
255 p->keyid = safe_strdup ((char *) scratch);
265 static void pgp_make_pgp3_fingerprint (unsigned char *buff, size_t l,
266 unsigned char *digest)
271 SHA1_Init (&context);
273 dummy = buff[0] & 0x3f;
275 if (dummy == PT_SUBSECKEY || dummy == PT_SUBKEY || dummy == PT_SECKEY)
278 dummy = (dummy << 2) | 0x81;
279 SHA1_Update (&context, &dummy, 1);
280 dummy = ((l - 1) >> 8) & 0xff;
281 SHA1_Update (&context, &dummy, 1);
282 dummy = (l - 1) & 0xff;
283 SHA1_Update (&context, &dummy, 1);
284 SHA1_Update (&context, buff + 1, l - 1);
285 SHA1_Final (digest, &context);
289 static void skip_bignum (unsigned char *buff, size_t l, size_t j,
290 size_t * toff, size_t n)
296 len = (buff[j] << 8) + buff[j + 1];
297 j += (len + 7) / 8 + 2;
299 while (j <= l && --n > 0);
306 static pgp_key_t pgp_parse_pgp3_key (unsigned char *buff, size_t l)
310 unsigned char digest[SHA_DIGEST_LENGTH];
311 unsigned char scratch[LONG_STRING];
318 p = pgp_new_keyinfo ();
321 for (i = 0; i < 4; i++)
322 gen_time = (gen_time << 8) + buff[j++];
324 p->gen_time = gen_time;
329 p->algorithm = pgp_pkalgbytype (alg);
330 p->flags |= pgp_get_abilities (alg);
333 skip_bignum (buff, l, j, &j, 3);
334 else if (alg == 16 || alg == 20)
335 skip_bignum (buff, l, j, &j, 2);
337 len = (buff[j] << 8) + buff[j + 1];
341 if (alg >= 1 && alg <= 3)
342 skip_bignum (buff, l, j, &j, 2);
343 else if (alg == 17 || alg == 16 || alg == 20)
344 skip_bignum (buff, l, j, &j, 1);
346 pgp_make_pgp3_fingerprint (buff, j, digest);
347 p->fp_len = SHA_DIGEST_LENGTH;
349 for (k = 0; k < 2; k++)
351 for (id = 0, i = SHA_DIGEST_LENGTH - 8 + k * 4;
352 i < SHA_DIGEST_LENGTH + (k - 1) * 4; i++)
353 id = (id << 8) + digest[i];
355 snprintf ((char *) scratch + k * 8, sizeof (scratch) - k * 8, "%08lX", id);
358 p->keyid = safe_strdup ((char *) scratch);
363 static pgp_key_t pgp_parse_keyinfo (unsigned char *buff, size_t l)
372 return pgp_parse_pgp2_key (buff, l);
374 return pgp_parse_pgp3_key (buff, l);
380 static int pgp_parse_pgp2_sig (unsigned char *buff, size_t l,
381 pgp_key_t p, pgp_sig_t *s)
383 unsigned char sigtype;
385 unsigned long signerid1;
386 unsigned long signerid2;
397 for (i = 0; i < 4; i++)
398 sig_gen_time = (sig_gen_time << 8) + buff[j++];
400 signerid1 = signerid2 = 0;
401 for (i = 0; i < 4; i++)
402 signerid1 = (signerid1 << 8) + buff[j++];
404 for (i = 0; i < 4; i++)
405 signerid2 = (signerid2 << 8) + buff[j++];
408 if (sigtype == 0x20 || sigtype == 0x28)
409 p->flags |= KEYFLAG_REVOKED;
413 s->sigtype = sigtype;
421 static int pgp_parse_pgp3_sig (unsigned char *buff, size_t l,
422 pgp_key_t p, pgp_sig_t *s)
424 unsigned char sigtype;
426 unsigned char hashalg;
428 time_t sig_gen_time = -1;
430 long key_validity = -1;
431 unsigned long signerid1 = 0;
432 unsigned long signerid2 = 0;
437 short have_critical_spks = 0;
448 for (ii = 0; ii < 2; ii++)
453 ml = (buff[j] << 8) + buff[j + 1];
469 skl = (skl - 192) * 256 + buff[j++] + 192;
474 if ((int) ml - (int) skl < 0)
483 case 2: /* creation time */
488 for (i = 0; i < 4; i++)
489 sig_gen_time = (sig_gen_time << 8) + buff[j++];
493 case 3: /* expiration time */
498 for (i = 0; i < 4; i++)
499 validity = (validity << 8) + buff[j++];
502 case 9: /* key expiration time */
507 for (i = 0; i < 4; i++)
508 key_validity = (key_validity << 8) + buff[j++];
511 case 16: /* issuer key ID */
515 signerid2 = signerid1 = 0;
516 for (i = 0; i < 4; i++)
517 signerid1 = (signerid1 << 8) + buff[j++];
518 for (i = 0; i < 4; i++)
519 signerid2 = (signerid2 << 8) + buff[j++];
523 case 10: /* CMR key */
525 case 4: /* exportable */
528 case 7: /* revocable */
529 case 11: /* Pref. symm. alg. */
530 case 12: /* revocation key */
531 case 20: /* notation data */
532 case 21: /* pref. hash */
533 case 22: /* pref. comp.alg. */
534 case 23: /* key server prefs. */
535 case 24: /* pref. key server */
539 have_critical_spks = 1;
546 if (sigtype == 0x20 || sigtype == 0x28)
547 p->flags |= KEYFLAG_REVOKED;
548 if (key_validity != -1 && time (NULL) > p->gen_time + key_validity)
549 p->flags |= KEYFLAG_EXPIRED;
550 if (have_critical_spks)
551 p->flags |= KEYFLAG_CRITICAL;
555 s->sigtype = sigtype;
566 static int pgp_parse_sig (unsigned char *buff, size_t l,
567 pgp_key_t p, pgp_sig_t *sig)
569 if (!buff || l < 2 || !p)
576 return pgp_parse_pgp2_sig (buff, l, p, sig);
578 return pgp_parse_pgp3_sig (buff, l, p, sig);
584 /* parse one key block, including all subkeys. */
586 static pgp_key_t pgp_parse_keyblock (FILE * fp)
589 unsigned char pt = 0;
590 unsigned char last_pt;
600 pgp_key_t root = NULL;
601 pgp_key_t *last = &root;
603 pgp_uid_t *uid = NULL;
604 pgp_uid_t **addr = NULL;
605 pgp_sig_t **lsig = NULL;
609 while (!err && (buff = pgp_read_packet (fp, &l)) != NULL)
614 /* check if we have read the complete key block. */
616 if ((pt == PT_SECKEY || pt == PT_PUBKEY) && root)
629 if (!(*last = p = pgp_parse_keyinfo (buff, l)))
639 if (pt == PT_SUBKEY || pt == PT_SUBSECKEY)
641 p->flags |= KEYFLAG_SUBKEY;
645 p->address = pgp_copy_uids (root->address, p);
646 while (*addr) addr = &(*addr)->next;
650 if (pt == PT_SECKEY || pt == PT_SUBSECKEY)
651 p->flags |= KEYFLAG_SECRET;
660 pgp_sig_t *signature = safe_calloc (sizeof (pgp_sig_t), 1);
662 lsig = &signature->next;
664 pgp_parse_sig (buff, l, p, signature);
671 if (p && (last_pt == PT_SECKEY || last_pt == PT_PUBKEY ||
672 last_pt == PT_SUBKEY || last_pt == PT_SUBSECKEY))
676 p->flags |= KEYFLAG_DISABLED;
679 else if (last_pt == PT_NAME && uid)
681 uid->trust = buff[1];
693 chr = safe_malloc (l);
694 memcpy (chr, buff + 1, l - 1);
698 *addr = uid = safe_calloc (1, sizeof (pgp_uid_t)); /* XXX */
705 /* the following tags are generated by
709 if (strstr (chr, "ENCR"))
710 p->flags |= KEYFLAG_PREFER_ENCRYPTION;
711 if (strstr (chr, "SIGN"))
712 p->flags |= KEYFLAG_PREFER_SIGNING;
722 pgp_free_key (&root);
727 static int pgpring_string_matches_hint (const char *s, const char *hints[], int nhints)
731 if (!hints || !nhints)
734 for (i = 0; i < nhints; i++)
736 if (mutt_stristr (s, hints[i]) != NULL)
744 * Go through the key ring file and look for keys with
748 static void pgpring_find_candidates (char *ringfile, const char *hints[], int nhints)
757 unsigned char *buff = NULL;
758 unsigned char pt = 0;
763 if ((rfp = fopen (ringfile, "r")) == NULL)
766 size_t error_buf_len;
768 error_buf_len = sizeof ("fopen: ") - 1 + strlen (ringfile) + 1;
769 error_buf = safe_malloc (error_buf_len);
770 snprintf (error_buf, error_buf_len, "fopen: %s", ringfile);
779 while (!err && (buff = pgp_read_packet (rfp, &l)) != NULL)
786 if ((pt == PT_SECKEY) || (pt == PT_PUBKEY))
790 else if (pt == PT_NAME)
792 char *tmp = safe_malloc (l);
794 memcpy (tmp, buff + 1, l - 1);
797 /* mutt_decode_utf8_string (tmp, chs); */
799 if (pgpring_string_matches_hint (tmp, hints, nhints))
803 FSETPOS(rfp, keypos);
805 /* Not bailing out here would lead us into an endless loop. */
807 if ((p = pgp_parse_keyblock (rfp)) == NULL)
810 pgpring_dump_keyblock (p);
824 static void print_userid (const char *id)
826 for (; id && *id; id++)
828 if (*id >= ' ' && *id <= 'z' && *id != ':')
831 printf ("\\x%02x", (*id) & 0xff);
835 static void print_fingerprint (pgp_key_t p)
839 printf ("fpr:::::::::");
840 for (i = 0; i < p->fp_len; i++)
841 printf ("%02X", p->fingerprint[i]);
844 } /* print_fingerprint() */
847 static void pgpring_dump_signatures (pgp_sig_t *sig)
849 for (; sig; sig = sig->next)
851 if (sig->sigtype == 0x10 || sig->sigtype == 0x11 ||
852 sig->sigtype == 0x12 || sig->sigtype == 0x13)
853 printf ("sig::::%08lX%08lX::::::%X:\n",
854 sig->sid1, sig->sid2, sig->sigtype);
855 else if (sig->sigtype == 0x20)
856 printf ("rev::::%08lX%08lX::::::%X:\n",
857 sig->sid1, sig->sid2, sig->sigtype);
862 static char gnupg_trustletter (int t)
873 static void pgpring_dump_keyblock (pgp_key_t p)
880 for (; p; p = p->next)
884 if (p->flags & KEYFLAG_SECRET)
886 if (p->flags & KEYFLAG_SUBKEY)
893 if (p->flags & KEYFLAG_SUBKEY)
899 if (p->flags & KEYFLAG_REVOKED)
901 if (p->flags & KEYFLAG_EXPIRED)
903 if (p->flags & KEYFLAG_DISABLED)
906 for (uid = p->address; uid; uid = uid->next, first = 0)
910 printf ("uid:%c::::::::", gnupg_trustletter (uid->trust));
911 print_userid (uid->addr);
916 if (p->flags & KEYFLAG_SECRET)
919 putchar (gnupg_trustletter (uid->trust));
924 printf (":%d:%d:%s:%04d-%02d-%02d::::", p->keylen, p->numalg, p->keyid,
925 1900 + tp->tm_year, tp->tm_mon + 1, tp->tm_mday);
927 print_userid (uid->addr);
930 if(pgp_canencrypt(p->numalg))
932 if(pgp_cansign(p->numalg))
934 if (p->flags & KEYFLAG_DISABLED)
938 if (dump_fingerprints)
939 print_fingerprint (p);
944 if (first) pgpring_dump_signatures (p->sigs);
945 pgpring_dump_signatures (uid->sigs);
952 * The mutt_gettext () defined in gettext.c requires iconv,
953 * so we do without charset conversion here.
956 char *mutt_gettext (const char *message)
958 return (char *)message;