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.
25 #include <lib-lib/lib-lib.h>
27 #include <lib-hash/hash.h>
36 short Umask; /* dirty hack because we need Umask in lib.c but don't want globals.h there */
39 #include <lib-crypt/pgplib.h>
40 #include <lib-crypt/pgppacket.h>
42 #define MD5_DIGEST_LENGTH 16
45 #define FGETPOS(fp,pos) fgetpos((fp),&(pos))
46 #define FSETPOS(fp,pos) fsetpos((fp),&(pos))
48 #define FGETPOS(fp,pos) pos=ftello((fp));
49 #define FSETPOS(fp,pos) fseeko((fp),(pos),SEEK_SET)
53 static short dump_signatures = 0;
54 static short dump_fingerprints = 0;
57 static void pgpring_find_candidates (char *ringfile, const char *hints[],
59 static void pgpring_dump_keyblock (pgp_key_t p);
61 int main (int argc, char *const argv[])
68 const char *_kring = NULL;
69 char *env_pgppath, *env_home;
71 char pgppath[_POSIX_PATH_MAX];
72 char kring[_POSIX_PATH_MAX];
74 while ((c = getopt (argc, argv, "f25sk:S")) != EOF) {
84 dump_fingerprints = 1;
110 "usage: %s [-k <key ring> | [-2 | -5] [ -s] [-S] [-f]] [hints]\n",
118 m_strcpy(kring, sizeof(kring), _kring);
120 if ((env_pgppath = getenv ("PGPPATH")))
121 m_strcpy(pgppath, sizeof(pgppath), env_pgppath);
122 else if ((env_home = getenv ("HOME")))
123 snprintf (pgppath, sizeof (pgppath), "%s/.pgp", env_home);
125 fprintf (stderr, "%s: Can't determine your PGPPATH.\n", argv[0]);
130 snprintf (kring, sizeof (kring), "%s/secring.%s", pgppath,
131 version == 2 ? "pgp" : "skr");
133 snprintf (kring, sizeof (kring), "%s/pubring.%s", pgppath,
134 version == 2 ? "pgp" : "pkr");
137 pgpring_find_candidates (kring, (const char **) argv + optind,
144 /* The actual key ring parser */
146 static void pgp_make_pgp2_fingerprint (unsigned char *buff,
147 unsigned char *digest)
151 unsigned int size = 0;
156 size = (buff[0] << 8) + buff[1];
157 size = ((size + 7) / 8);
160 MD5Update (&context, buff, size);
163 size = (buff[0] << 8) + buff[1];
164 size = ((size + 7) / 8);
167 MD5Update (&context, buff, size);
169 MD5Final (digest, &context);
171 } /* pgp_make_pgp2_fingerprint() */
173 static pgp_key_t pgp_parse_pgp2_key (unsigned char *buff, size_t l)
177 unsigned char digest[MD5_DIGEST_LENGTH];
181 unsigned short exp_days = 0;
184 unsigned char scratch[LONG_STRING];
189 p = pgp_new_keyinfo ();
191 for (i = 0, j = 2; i < 4; i++)
192 gen_time = (gen_time << 8) + buff[j++];
194 p->gen_time = gen_time;
196 for (i = 0; i < 2; i++)
197 exp_days = (exp_days << 8) + buff[j++];
199 if (exp_days && time (NULL) > gen_time + exp_days * 24 * 3600)
200 p->flags |= KEYFLAG_EXPIRED;
205 p->algorithm = pgp_pkalgbytype (alg);
206 p->flags |= pgp_get_abilities (alg);
208 if (dump_fingerprints) {
209 /* j now points to the key material, which we need for the fingerprint */
210 p->fp_len = MD5_DIGEST_LENGTH;
211 pgp_make_pgp2_fingerprint (&buff[j], digest);
212 memcpy (p->fingerprint, digest, MD5_DIGEST_LENGTH);
214 else /* just to be usre */
215 p_clear(p->fingerprint, MD5_DIGEST_LENGTH);
218 for (i = 0; i < 2; i++)
219 expl = (expl << 8) + buff[j++];
223 expl = (expl + 7) / 8;
230 for (k = 0; k < 2; k++) {
231 for (id = 0, i = 0; i < 4; i++)
232 id = (id << 8) + buff[j++];
234 snprintf ((char *) scratch + k * 8, sizeof (scratch) - k * 8,
238 p->keyid = m_strdup((char *) scratch);
248 static void pgp_make_pgp3_fingerprint (unsigned char *buff, size_t l,
249 unsigned char *digest)
254 SHA1_Init (&context);
256 dummy = buff[0] & 0x3f;
258 if (dummy == PT_SUBSECKEY || dummy == PT_SUBKEY || dummy == PT_SECKEY)
261 dummy = (dummy << 2) | 0x81;
262 SHA1_Update (&context, &dummy, 1);
263 dummy = ((l - 1) >> 8) & 0xff;
264 SHA1_Update (&context, &dummy, 1);
265 dummy = (l - 1) & 0xff;
266 SHA1_Update (&context, &dummy, 1);
267 SHA1_Update (&context, buff + 1, l - 1);
268 SHA1_Final (digest, &context);
272 static void skip_bignum (unsigned char *buff, size_t l, size_t j,
273 size_t * toff, size_t n)
278 len = (buff[j] << 8) + buff[j + 1];
279 j += (len + 7) / 8 + 2;
281 while (j <= l && --n > 0);
288 static pgp_key_t pgp_parse_pgp3_key (unsigned char *buff, size_t l)
292 unsigned char digest[SHA_DIGEST_LENGTH];
293 unsigned char scratch[LONG_STRING];
300 p = pgp_new_keyinfo ();
303 for (i = 0; i < 4; i++)
304 gen_time = (gen_time << 8) + buff[j++];
306 p->gen_time = gen_time;
311 p->algorithm = pgp_pkalgbytype (alg);
312 p->flags |= pgp_get_abilities (alg);
315 skip_bignum (buff, l, j, &j, 3);
316 else if (alg == 16 || alg == 20)
317 skip_bignum (buff, l, j, &j, 2);
319 len = (buff[j] << 8) + buff[j + 1];
323 if (alg >= 1 && alg <= 3)
324 skip_bignum (buff, l, j, &j, 2);
325 else if (alg == 17 || alg == 16 || alg == 20)
326 skip_bignum (buff, l, j, &j, 1);
328 pgp_make_pgp3_fingerprint (buff, j, digest);
329 p->fp_len = SHA_DIGEST_LENGTH;
331 for (k = 0; k < 2; k++) {
332 for (id = 0, i = SHA_DIGEST_LENGTH - 8 + k * 4;
333 i < SHA_DIGEST_LENGTH + (k - 1) * 4; i++)
334 id = (id << 8) + digest[i];
336 snprintf ((char *) scratch + k * 8, sizeof (scratch) - k * 8, "%08lX",
340 p->keyid = m_strdup((char *) scratch);
345 static pgp_key_t pgp_parse_keyinfo (unsigned char *buff, size_t l)
353 return pgp_parse_pgp2_key (buff, l);
355 return pgp_parse_pgp3_key (buff, l);
361 static int pgp_parse_pgp2_sig (unsigned char *buff, size_t l,
362 pgp_key_t p, pgp_sig_t * s)
364 unsigned char sigtype;
366 unsigned long signerid1;
367 unsigned long signerid2;
378 for (i = 0; i < 4; i++)
379 sig_gen_time = (sig_gen_time << 8) + buff[j++];
381 signerid1 = signerid2 = 0;
382 for (i = 0; i < 4; i++)
383 signerid1 = (signerid1 << 8) + buff[j++];
385 for (i = 0; i < 4; i++)
386 signerid2 = (signerid2 << 8) + buff[j++];
389 if (sigtype == 0x20 || sigtype == 0x28)
390 p->flags |= KEYFLAG_REVOKED;
393 s->sigtype = sigtype;
401 static int pgp_parse_pgp3_sig (unsigned char *buff, size_t l,
402 pgp_key_t p, pgp_sig_t * s)
404 unsigned char sigtype;
406 unsigned char hashalg;
408 time_t sig_gen_time = -1;
410 long key_validity = -1;
411 unsigned long signerid1 = 0;
412 unsigned long signerid2 = 0;
417 short have_critical_spks = 0;
428 for (ii = 0; ii < 2; ii++) {
432 ml = (buff[j] << 8) + buff[j + 1];
446 skl = (skl - 192) * 256 + buff[j++] + 192;
451 if ((int) ml - (int) skl < 0)
458 switch (skt & 0x7f) {
459 case 2: /* creation time */
464 for (i = 0; i < 4; i++)
465 sig_gen_time = (sig_gen_time << 8) + buff[j++];
469 case 3: /* expiration time */
474 for (i = 0; i < 4; i++)
475 validity = (validity << 8) + buff[j++];
478 case 9: /* key expiration time */
483 for (i = 0; i < 4; i++)
484 key_validity = (key_validity << 8) + buff[j++];
487 case 16: /* issuer key ID */
491 signerid2 = signerid1 = 0;
492 for (i = 0; i < 4; i++)
493 signerid1 = (signerid1 << 8) + buff[j++];
494 for (i = 0; i < 4; i++)
495 signerid2 = (signerid2 << 8) + buff[j++];
499 case 10: /* CMR key */
501 case 4: /* exportable */
504 case 7: /* revocable */
505 case 11: /* Pref. symm. alg. */
506 case 12: /* revocation key */
507 case 20: /* notation data */
508 case 21: /* pref. hash */
509 case 22: /* pref. comp.alg. */
510 case 23: /* key server prefs. */
511 case 24: /* pref. key server */
515 have_critical_spks = 1;
522 if (sigtype == 0x20 || sigtype == 0x28)
523 p->flags |= KEYFLAG_REVOKED;
524 if (key_validity != -1 && time (NULL) > p->gen_time + key_validity)
525 p->flags |= KEYFLAG_EXPIRED;
526 if (have_critical_spks)
527 p->flags |= KEYFLAG_CRITICAL;
530 s->sigtype = sigtype;
541 static int pgp_parse_sig (unsigned char *buff, size_t l,
542 pgp_key_t p, pgp_sig_t * sig)
544 if (!buff || l < 2 || !p)
550 return pgp_parse_pgp2_sig (buff, l, p, sig);
552 return pgp_parse_pgp3_sig (buff, l, p, sig);
558 /* parse one key block, including all subkeys. */
560 static pgp_key_t pgp_parse_keyblock (FILE * fp)
563 unsigned char pt = 0;
564 unsigned char last_pt;
574 pgp_key_t root = NULL;
575 pgp_key_t *last = &root;
577 pgp_uid_t *uid = NULL;
578 pgp_uid_t **addr = NULL;
579 pgp_sig_t **lsig = NULL;
583 while (!err && (buff = pgp_read_packet (fp, &l)) != NULL) {
587 /* check if we have read the complete key block. */
589 if ((pt == PT_SECKEY || pt == PT_PUBKEY) && root) {
600 if (!(*last = p = pgp_parse_keyinfo (buff, l))) {
609 if (pt == PT_SUBKEY || pt == PT_SUBSECKEY) {
610 p->flags |= KEYFLAG_SUBKEY;
613 p->address = pgp_copy_uids (root->address, p);
615 addr = &(*addr)->next;
619 if (pt == PT_SECKEY || pt == PT_SUBSECKEY)
620 p->flags |= KEYFLAG_SECRET;
628 pgp_sig_t *signature = p_new(pgp_sig_t, 1);
631 lsig = &signature->next;
633 pgp_parse_sig (buff, l, p, signature);
640 if (p && (last_pt == PT_SECKEY || last_pt == PT_PUBKEY ||
641 last_pt == PT_SUBKEY || last_pt == PT_SUBSECKEY)) {
642 if (buff[1] & 0x20) {
643 p->flags |= KEYFLAG_DISABLED;
646 else if (last_pt == PT_NAME && uid) {
647 uid->trust = buff[1];
659 chr = p_dupstr(buff + 1, l - 1);
661 *addr = uid = p_new(pgp_uid_t, 1); /* XXX */
668 /* the following tags are generated by
672 if (strstr (chr, "ENCR"))
673 p->flags |= KEYFLAG_PREFER_ENCRYPTION;
674 if (strstr (chr, "SIGN"))
675 p->flags |= KEYFLAG_PREFER_SIGNING;
685 pgp_free_key (&root);
690 static int pgpring_string_matches_hint (const char *s, const char *hints[],
695 if (!hints || !nhints)
698 for (i = 0; i < nhints; i++) {
699 if (m_stristr(s, hints[i]) != NULL)
707 * Go through the key ring file and look for keys with
711 static void pgpring_find_candidates (char *ringfile, const char *hints[],
722 unsigned char *buff = NULL;
723 unsigned char pt = 0;
728 if ((rfp = fopen (ringfile, "r")) == NULL) {
730 size_t error_buf_len;
732 error_buf_len = sizeof ("fopen: ") - 1 + m_strlen(ringfile) + 1;
733 error_buf = p_new(char, error_buf_len);
734 snprintf (error_buf, error_buf_len, "fopen: %s", ringfile);
736 p_delete(&error_buf);
741 FGETPOS (rfp, keypos);
743 while (!err && (buff = pgp_read_packet (rfp, &l)) != NULL) {
749 if ((pt == PT_SECKEY) || (pt == PT_PUBKEY)) {
752 else if (pt == PT_NAME) {
753 char *tmp = p_dupstr(buff + 1, l - 1);
755 /* mutt_decode_utf8_string (tmp, chs); */
757 if (pgpring_string_matches_hint (tmp, hints, nhints)) {
760 FSETPOS (rfp, keypos);
762 /* Not bailing out here would lead us into an endless loop. */
764 if ((p = pgp_parse_keyblock (rfp)) == NULL)
767 pgpring_dump_keyblock (p);
779 static void print_userid (const char *id)
781 for (; id && *id; id++) {
782 if (*id >= ' ' && *id <= 'z' && *id != ':')
785 printf ("\\x%02x", (*id) & 0xff);
789 static void print_fingerprint (pgp_key_t p)
793 printf ("fpr:::::::::");
794 for (i = 0; i < p->fp_len; i++)
795 printf ("%02X", p->fingerprint[i]);
798 } /* print_fingerprint() */
801 static void pgpring_dump_signatures (pgp_sig_t * sig)
803 for (; sig; sig = sig->next) {
804 if (sig->sigtype == 0x10 || sig->sigtype == 0x11 ||
805 sig->sigtype == 0x12 || sig->sigtype == 0x13)
806 printf ("sig::::%08lX%08lX::::::%X:\n",
807 sig->sid1, sig->sid2, sig->sigtype);
808 else if (sig->sigtype == 0x20)
809 printf ("rev::::%08lX%08lX::::::%X:\n",
810 sig->sid1, sig->sid2, sig->sigtype);
815 static char gnupg_trustletter (int t)
828 static void pgpring_dump_keyblock (pgp_key_t p)
835 for (; p; p = p->next) {
838 if (p->flags & KEYFLAG_SECRET) {
839 if (p->flags & KEYFLAG_SUBKEY)
845 if (p->flags & KEYFLAG_SUBKEY)
851 if (p->flags & KEYFLAG_REVOKED)
853 if (p->flags & KEYFLAG_EXPIRED)
855 if (p->flags & KEYFLAG_DISABLED)
858 for (uid = p->address; uid; uid = uid->next, first = 0) {
860 printf ("uid:%c::::::::", gnupg_trustletter (uid->trust));
861 print_userid (uid->addr);
865 if (p->flags & KEYFLAG_SECRET)
868 putchar (gnupg_trustletter (uid->trust));
873 printf (":%d:%d:%s:%04d-%02d-%02d::::", p->keylen, p->numalg,
874 p->keyid, 1900 + tp->tm_year, tp->tm_mon + 1, tp->tm_mday);
876 print_userid (uid->addr);
879 if (pgp_canencrypt (p->numalg))
881 if (pgp_cansign (p->numalg))
883 if (p->flags & KEYFLAG_DISABLED)
887 if (dump_fingerprints)
888 print_fingerprint (p);
891 if (dump_signatures) {
893 pgpring_dump_signatures (p->sigs);
894 pgpring_dump_signatures (uid->sigs);