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.
54 short Umask; /* dirty hack because we need Umask in lib.c but don't want globals.h there */
60 #include "pgppacket.h"
62 #define MD5_DIGEST_LENGTH 16
65 #define FGETPOS(fp,pos) fgetpos((fp),&(pos))
66 #define FSETPOS(fp,pos) fsetpos((fp),&(pos))
68 #define FGETPOS(fp,pos) pos=ftell((fp));
69 #define FSETPOS(fp,pos) fseek((fp),(pos),SEEK_SET)
73 static short dump_signatures = 0;
74 static short dump_fingerprints = 0;
77 static void pgpring_find_candidates (char *ringfile, const char *hints[],
79 static void pgpring_dump_keyblock (pgp_key_t p);
81 int main (int argc, char *const argv[])
88 const char *_kring = NULL;
89 char *env_pgppath, *env_home;
91 char pgppath[_POSIX_PATH_MAX];
92 char kring[_POSIX_PATH_MAX];
94 while ((c = getopt (argc, argv, "f25sk:S")) != EOF) {
104 dump_fingerprints = 1;
130 "usage: %s [-k <key ring> | [-2 | -5] [ -s] [-S] [-f]] [hints]\n",
138 strfcpy (kring, _kring, sizeof (kring));
140 if ((env_pgppath = getenv ("PGPPATH")))
141 strfcpy (pgppath, env_pgppath, sizeof (pgppath));
142 else if ((env_home = getenv ("HOME")))
143 snprintf (pgppath, sizeof (pgppath), "%s/.pgp", env_home);
145 fprintf (stderr, "%s: Can't determine your PGPPATH.\n", argv[0]);
150 snprintf (kring, sizeof (kring), "%s/secring.%s", pgppath,
151 version == 2 ? "pgp" : "skr");
153 snprintf (kring, sizeof (kring), "%s/pubring.%s", pgppath,
154 version == 2 ? "pgp" : "pkr");
157 pgpring_find_candidates (kring, (const char **) argv + optind,
164 /* The actual key ring parser */
166 static void pgp_make_pgp2_fingerprint (unsigned char *buff,
167 unsigned char *digest)
171 unsigned int size = 0;
176 size = (buff[0] << 8) + buff[1];
177 size = ((size + 7) / 8);
180 MD5Update (&context, buff, size);
183 size = (buff[0] << 8) + buff[1];
184 size = ((size + 7) / 8);
187 MD5Update (&context, buff, size);
189 MD5Final (digest, &context);
191 } /* pgp_make_pgp2_fingerprint() */
193 static pgp_key_t pgp_parse_pgp2_key (unsigned char *buff, size_t l)
197 unsigned char digest[MD5_DIGEST_LENGTH];
201 unsigned short exp_days = 0;
204 unsigned char scratch[LONG_STRING];
209 p = pgp_new_keyinfo ();
211 for (i = 0, j = 2; i < 4; i++)
212 gen_time = (gen_time << 8) + buff[j++];
214 p->gen_time = gen_time;
216 for (i = 0; i < 2; i++)
217 exp_days = (exp_days << 8) + buff[j++];
219 if (exp_days && time (NULL) > gen_time + exp_days * 24 * 3600)
220 p->flags |= KEYFLAG_EXPIRED;
225 p->algorithm = pgp_pkalgbytype (alg);
226 p->flags |= pgp_get_abilities (alg);
228 if (dump_fingerprints) {
229 /* j now points to the key material, which we need for the fingerprint */
230 p->fp_len = MD5_DIGEST_LENGTH;
231 pgp_make_pgp2_fingerprint (&buff[j], digest);
232 memcpy (p->fingerprint, digest, MD5_DIGEST_LENGTH);
234 else /* just to be usre */
235 memset (p->fingerprint, 0, MD5_DIGEST_LENGTH);
238 for (i = 0; i < 2; i++)
239 expl = (expl << 8) + buff[j++];
243 expl = (expl + 7) / 8;
250 for (k = 0; k < 2; k++) {
251 for (id = 0, i = 0; i < 4; i++)
252 id = (id << 8) + buff[j++];
254 snprintf ((char *) scratch + k * 8, sizeof (scratch) - k * 8,
258 p->keyid = safe_strdup ((char *) scratch);
268 static void pgp_make_pgp3_fingerprint (unsigned char *buff, size_t l,
269 unsigned char *digest)
274 SHA1_Init (&context);
276 dummy = buff[0] & 0x3f;
278 if (dummy == PT_SUBSECKEY || dummy == PT_SUBKEY || dummy == PT_SECKEY)
281 dummy = (dummy << 2) | 0x81;
282 SHA1_Update (&context, &dummy, 1);
283 dummy = ((l - 1) >> 8) & 0xff;
284 SHA1_Update (&context, &dummy, 1);
285 dummy = (l - 1) & 0xff;
286 SHA1_Update (&context, &dummy, 1);
287 SHA1_Update (&context, buff + 1, l - 1);
288 SHA1_Final (digest, &context);
292 static void skip_bignum (unsigned char *buff, size_t l, size_t j,
293 size_t * toff, size_t n)
298 len = (buff[j] << 8) + buff[j + 1];
299 j += (len + 7) / 8 + 2;
301 while (j <= l && --n > 0);
308 static pgp_key_t pgp_parse_pgp3_key (unsigned char *buff, size_t l)
312 unsigned char digest[SHA_DIGEST_LENGTH];
313 unsigned char scratch[LONG_STRING];
320 p = pgp_new_keyinfo ();
323 for (i = 0; i < 4; i++)
324 gen_time = (gen_time << 8) + buff[j++];
326 p->gen_time = gen_time;
331 p->algorithm = pgp_pkalgbytype (alg);
332 p->flags |= pgp_get_abilities (alg);
335 skip_bignum (buff, l, j, &j, 3);
336 else if (alg == 16 || alg == 20)
337 skip_bignum (buff, l, j, &j, 2);
339 len = (buff[j] << 8) + buff[j + 1];
343 if (alg >= 1 && alg <= 3)
344 skip_bignum (buff, l, j, &j, 2);
345 else if (alg == 17 || alg == 16 || alg == 20)
346 skip_bignum (buff, l, j, &j, 1);
348 pgp_make_pgp3_fingerprint (buff, j, digest);
349 p->fp_len = SHA_DIGEST_LENGTH;
351 for (k = 0; k < 2; k++) {
352 for (id = 0, i = SHA_DIGEST_LENGTH - 8 + k * 4;
353 i < SHA_DIGEST_LENGTH + (k - 1) * 4; i++)
354 id = (id << 8) + digest[i];
356 snprintf ((char *) scratch + k * 8, sizeof (scratch) - k * 8, "%08lX",
360 p->keyid = safe_strdup ((char *) scratch);
365 static pgp_key_t pgp_parse_keyinfo (unsigned char *buff, size_t l)
373 return pgp_parse_pgp2_key (buff, l);
375 return pgp_parse_pgp3_key (buff, l);
381 static int pgp_parse_pgp2_sig (unsigned char *buff, size_t l,
382 pgp_key_t p, pgp_sig_t * s)
384 unsigned char sigtype;
386 unsigned long signerid1;
387 unsigned long signerid2;
398 for (i = 0; i < 4; i++)
399 sig_gen_time = (sig_gen_time << 8) + buff[j++];
401 signerid1 = signerid2 = 0;
402 for (i = 0; i < 4; i++)
403 signerid1 = (signerid1 << 8) + buff[j++];
405 for (i = 0; i < 4; i++)
406 signerid2 = (signerid2 << 8) + buff[j++];
409 if (sigtype == 0x20 || sigtype == 0x28)
410 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++) {
452 ml = (buff[j] << 8) + buff[j + 1];
466 skl = (skl - 192) * 256 + buff[j++] + 192;
471 if ((int) ml - (int) skl < 0)
478 switch (skt & 0x7f) {
479 case 2: /* creation time */
484 for (i = 0; i < 4; i++)
485 sig_gen_time = (sig_gen_time << 8) + buff[j++];
489 case 3: /* expiration time */
494 for (i = 0; i < 4; i++)
495 validity = (validity << 8) + buff[j++];
498 case 9: /* key expiration time */
503 for (i = 0; i < 4; i++)
504 key_validity = (key_validity << 8) + buff[j++];
507 case 16: /* issuer key ID */
511 signerid2 = signerid1 = 0;
512 for (i = 0; i < 4; i++)
513 signerid1 = (signerid1 << 8) + buff[j++];
514 for (i = 0; i < 4; i++)
515 signerid2 = (signerid2 << 8) + buff[j++];
519 case 10: /* CMR key */
521 case 4: /* exportable */
524 case 7: /* revocable */
525 case 11: /* Pref. symm. alg. */
526 case 12: /* revocation key */
527 case 20: /* notation data */
528 case 21: /* pref. hash */
529 case 22: /* pref. comp.alg. */
530 case 23: /* key server prefs. */
531 case 24: /* pref. key server */
535 have_critical_spks = 1;
542 if (sigtype == 0x20 || sigtype == 0x28)
543 p->flags |= KEYFLAG_REVOKED;
544 if (key_validity != -1 && time (NULL) > p->gen_time + key_validity)
545 p->flags |= KEYFLAG_EXPIRED;
546 if (have_critical_spks)
547 p->flags |= KEYFLAG_CRITICAL;
550 s->sigtype = sigtype;
561 static int pgp_parse_sig (unsigned char *buff, size_t l,
562 pgp_key_t p, pgp_sig_t * sig)
564 if (!buff || l < 2 || !p)
570 return pgp_parse_pgp2_sig (buff, l, p, sig);
572 return pgp_parse_pgp3_sig (buff, l, p, sig);
578 /* parse one key block, including all subkeys. */
580 static pgp_key_t pgp_parse_keyblock (FILE * fp)
583 unsigned char pt = 0;
584 unsigned char last_pt;
594 pgp_key_t root = NULL;
595 pgp_key_t *last = &root;
597 pgp_uid_t *uid = NULL;
598 pgp_uid_t **addr = NULL;
599 pgp_sig_t **lsig = NULL;
603 while (!err && (buff = pgp_read_packet (fp, &l)) != NULL) {
607 /* check if we have read the complete key block. */
609 if ((pt == PT_SECKEY || pt == PT_PUBKEY) && root) {
620 if (!(*last = p = pgp_parse_keyinfo (buff, l))) {
629 if (pt == PT_SUBKEY || pt == PT_SUBSECKEY) {
630 p->flags |= KEYFLAG_SUBKEY;
633 p->address = pgp_copy_uids (root->address, p);
635 addr = &(*addr)->next;
639 if (pt == PT_SECKEY || pt == PT_SUBSECKEY)
640 p->flags |= KEYFLAG_SECRET;
648 pgp_sig_t *signature = safe_calloc (sizeof (pgp_sig_t), 1);
651 lsig = &signature->next;
653 pgp_parse_sig (buff, l, p, signature);
660 if (p && (last_pt == PT_SECKEY || last_pt == PT_PUBKEY ||
661 last_pt == PT_SUBKEY || last_pt == PT_SUBSECKEY)) {
662 if (buff[1] & 0x20) {
663 p->flags |= KEYFLAG_DISABLED;
666 else if (last_pt == PT_NAME && uid) {
667 uid->trust = buff[1];
679 chr = safe_malloc (l);
680 memcpy (chr, buff + 1, l - 1);
684 *addr = uid = safe_calloc (1, sizeof (pgp_uid_t)); /* XXX */
691 /* the following tags are generated by
695 if (strstr (chr, "ENCR"))
696 p->flags |= KEYFLAG_PREFER_ENCRYPTION;
697 if (strstr (chr, "SIGN"))
698 p->flags |= KEYFLAG_PREFER_SIGNING;
708 pgp_free_key (&root);
713 static int pgpring_string_matches_hint (const char *s, const char *hints[],
718 if (!hints || !nhints)
721 for (i = 0; i < nhints; i++) {
722 if (mutt_stristr (s, hints[i]) != NULL)
730 * Go through the key ring file and look for keys with
734 static void pgpring_find_candidates (char *ringfile, const char *hints[],
745 unsigned char *buff = NULL;
746 unsigned char pt = 0;
751 if ((rfp = fopen (ringfile, "r")) == NULL) {
753 size_t error_buf_len;
755 error_buf_len = sizeof ("fopen: ") - 1 + strlen (ringfile) + 1;
756 error_buf = safe_malloc (error_buf_len);
757 snprintf (error_buf, error_buf_len, "fopen: %s", ringfile);
764 FGETPOS (rfp, keypos);
766 while (!err && (buff = pgp_read_packet (rfp, &l)) != NULL) {
772 if ((pt == PT_SECKEY) || (pt == PT_PUBKEY)) {
775 else if (pt == PT_NAME) {
776 char *tmp = safe_malloc (l);
778 memcpy (tmp, buff + 1, l - 1);
781 /* mutt_decode_utf8_string (tmp, chs); */
783 if (pgpring_string_matches_hint (tmp, hints, nhints)) {
786 FSETPOS (rfp, keypos);
788 /* Not bailing out here would lead us into an endless loop. */
790 if ((p = pgp_parse_keyblock (rfp)) == NULL)
793 pgpring_dump_keyblock (p);
807 static void print_userid (const char *id)
809 for (; id && *id; id++) {
810 if (*id >= ' ' && *id <= 'z' && *id != ':')
813 printf ("\\x%02x", (*id) & 0xff);
817 static void print_fingerprint (pgp_key_t p)
821 printf ("fpr:::::::::");
822 for (i = 0; i < p->fp_len; i++)
823 printf ("%02X", p->fingerprint[i]);
826 } /* print_fingerprint() */
829 static void pgpring_dump_signatures (pgp_sig_t * sig)
831 for (; sig; sig = sig->next) {
832 if (sig->sigtype == 0x10 || sig->sigtype == 0x11 ||
833 sig->sigtype == 0x12 || sig->sigtype == 0x13)
834 printf ("sig::::%08lX%08lX::::::%X:\n",
835 sig->sid1, sig->sid2, sig->sigtype);
836 else if (sig->sigtype == 0x20)
837 printf ("rev::::%08lX%08lX::::::%X:\n",
838 sig->sid1, sig->sid2, sig->sigtype);
843 static char gnupg_trustletter (int t)
856 static void pgpring_dump_keyblock (pgp_key_t p)
863 for (; p; p = p->next) {
866 if (p->flags & KEYFLAG_SECRET) {
867 if (p->flags & KEYFLAG_SUBKEY)
873 if (p->flags & KEYFLAG_SUBKEY)
879 if (p->flags & KEYFLAG_REVOKED)
881 if (p->flags & KEYFLAG_EXPIRED)
883 if (p->flags & KEYFLAG_DISABLED)
886 for (uid = p->address; uid; uid = uid->next, first = 0) {
888 printf ("uid:%c::::::::", gnupg_trustletter (uid->trust));
889 print_userid (uid->addr);
893 if (p->flags & KEYFLAG_SECRET)
896 putchar (gnupg_trustletter (uid->trust));
901 printf (":%d:%d:%s:%04d-%02d-%02d::::", p->keylen, p->numalg,
902 p->keyid, 1900 + tp->tm_year, tp->tm_mon + 1, tp->tm_mday);
904 print_userid (uid->addr);
907 if (pgp_canencrypt (p->numalg))
909 if (pgp_cansign (p->numalg))
911 if (p->flags & KEYFLAG_DISABLED)
915 if (dump_fingerprints)
916 print_fingerprint (p);
919 if (dump_signatures) {
921 pgpring_dump_signatures (p->sigs);
922 pgpring_dump_signatures (uid->sigs);
929 * The mutt_gettext () defined in gettext.c requires iconv,
930 * so we do without charset conversion here.
933 char *mutt_gettext (const char *message)
935 return (char *) message;