2 * Copyright notice from original mutt:
3 * crypt-gpgme.c - GPGME based crypto operations
4 * Copyright (C) 1996,1997 Michael R. Elkins <me@cs.hmc.edu>
5 * Copyright (C) 1998,1999,2000 Thomas Roessler <roessler@guug.de>
6 * Copyright (C) 2001 Thomas Roessler <roessler@guug.de>
7 * Oliver Ehli <elmy@acm.org>
8 * Copyright (C) 2002, 2003, 2004 g10 Code GmbH
10 * This file is part of mutt-ng, see http://www.muttng.org/.
11 * It's licensed under the GNU General Public License,
12 * please see the file GPL in the top level source directory.
15 #include <lib-lib/lib-lib.h>
17 #ifdef CRYPT_BACKEND_GPGME
22 #ifdef HAVE_LANGINFO_D_T_FMT
23 # include <langinfo.h>
25 #ifdef HAVE_SYS_RESOURCE_H
26 # include <sys/resource.h>
31 #include <lib-mime/mime.h>
33 #include <lib-ui/curses.h>
34 #include <lib-ui/enter.h>
35 #include <lib-ui/menu.h>
39 #include <lib-crypt/crypt.h>
43 #include "recvattach.h"
45 #include "crypt-gpgme.h"
50 #define digitp(p) (*(p) >= '0' && *(p) <= '9')
51 #define hexdigitp(a) (digitp (a) \
52 || (*(a) >= 'A' && *(a) <= 'F') \
53 || (*(a) >= 'a' && *(a) <= 'f'))
54 #define xtoi_1(p) (*(p) <= '9'? (*(p)- '0'): \
55 *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
56 #define xtoi_2(p) ((xtoi_1(p) * 16) + xtoi_1((p)+1))
58 /* Values used for comparing addresses. */
59 #define CRYPT_KV_VALID 1
60 #define CRYPT_KV_ADDR 2
61 #define CRYPT_KV_STRING 4
62 #define CRYPT_KV_STRONGID 8
63 #define CRYPT_KV_MATCH (CRYPT_KV_ADDR|CRYPT_KV_STRING)
72 struct crypt_cache *next;
80 /* We work based on user IDs, getting from a user ID to the key is
81 check and does not need any memory (gpgme uses reference counting). */
82 typedef struct crypt_keyinfo {
83 struct crypt_keyinfo *next;
85 int idx; /* and the user ID at this index */
86 const char *uid; /* and for convenience point to this user ID */
87 unsigned int flags; /* global and per uid flags (for convenience) */
90 typedef struct crypt_entry {
96 static struct crypt_cache *id_defaults = NULL;
97 static gpgme_key_t signature_key = NULL;
100 * General helper functions.
103 /* return true when S points to a didgit or letter. */
104 static int digit_or_letter (const unsigned char *s)
106 return ((*s >= '0' && *s <= '9')
107 || (*s >= 'A' && *s <= 'Z')
108 || (*s >= 'a' && *s <= 'z'));
112 /* Print the utf-8 encoded string BUF of length LEN bytes to stream
113 FP. Convert the character set. */
114 static void print_utf8 (FILE * fp, const char *buf, ssize_t len)
118 tstr = p_dupstr(buf, len);
119 mutt_convert_string (&tstr, "utf-8", Charset, M_ICONV_HOOK_FROM);
129 /* Return the keyID for the key K. Note that this string is valid as
130 long as K is valid */
131 static const char *crypt_keyid (crypt_key_t * k)
133 const char *s = "????????";
135 if (k->kobj && k->kobj->subkeys) {
136 s = k->kobj->subkeys->keyid;
137 if ((!option (OPTPGPLONGIDS)) && (m_strlen(s) == 16))
138 /* Return only the short keyID. */
145 /* Return the hexstring fingerprint from the key K. */
146 static const char *crypt_fpr (crypt_key_t * k)
150 if (k->kobj && k->kobj->subkeys)
151 s = k->kobj->subkeys->fpr;
156 /* Parse FLAGS and return a statically allocated(!) string with them. */
157 static char *crypt_key_abilities (int flags)
161 if (!(flags & KEYFLAG_CANENCRYPT))
163 else if (flags & KEYFLAG_PREFER_SIGNING)
168 if (!(flags & KEYFLAG_CANSIGN))
170 else if (flags & KEYFLAG_PREFER_ENCRYPTION)
180 /* Parse FLAGS and return a character describing the most important flag. */
181 static char crypt_flags (int flags)
183 if (flags & KEYFLAG_REVOKED)
185 else if (flags & KEYFLAG_EXPIRED)
187 else if (flags & KEYFLAG_DISABLED)
189 else if (flags & KEYFLAG_CRITICAL)
195 /* Return a copy of KEY. */
196 static crypt_key_t *crypt_copy_key (crypt_key_t *key)
200 k = p_new(crypt_key_t, 1);
202 gpgme_key_ref (key->kobj);
205 k->flags = key->flags;
210 /* Release all the keys at the address of KEYLIST and set the address
212 static void crypt_free_key (crypt_key_t ** keylist)
215 crypt_key_t *k = (*keylist)->next;
222 /* Return trute when key K is valid. */
223 static int crypt_key_is_valid (crypt_key_t * k)
225 if (k->flags & KEYFLAG_CANTUSE)
230 /* Return true whe validity of KEY is sufficient. */
231 static int crypt_id_is_strong (crypt_key_t * key)
233 gpgme_validity_t val = GPGME_VALIDITY_UNKNOWN;
234 gpgme_user_id_t uid = NULL;
238 if ((key->flags & KEYFLAG_ISX509))
241 for (i = 0, uid = key->kobj->uids; (i < key->idx) && uid;
242 i++, uid = uid->next);
247 case GPGME_VALIDITY_UNKNOWN:
248 case GPGME_VALIDITY_UNDEFINED:
249 case GPGME_VALIDITY_NEVER:
250 case GPGME_VALIDITY_MARGINAL:
254 case GPGME_VALIDITY_FULL:
255 case GPGME_VALIDITY_ULTIMATE:
263 /* Return true when the KEY is valid, i.e. not marked as unusable. */
264 static int crypt_id_is_valid (crypt_key_t * key)
266 return !(key->flags & KEYFLAG_CANTUSE);
269 /* Return a bit vector describing how well the addresses ADDR and
270 U_ADDR match and whether KEY is valid. */
271 static int crypt_id_matches_addr (address_t * addr, address_t * u_addr,
276 if (crypt_id_is_valid (key))
277 rv |= CRYPT_KV_VALID;
279 if (crypt_id_is_strong (key))
280 rv |= CRYPT_KV_STRONGID;
282 if (addr->mailbox && u_addr->mailbox
283 && m_strcasecmp(addr->mailbox, u_addr->mailbox) == 0)
286 if (addr->personal && u_addr->personal
287 && m_strcasecmp(addr->personal, u_addr->personal) == 0)
288 rv |= CRYPT_KV_STRING;
295 * GPGME convenient functions.
298 /* Create a new gpgme context and return it. With FOR_SMIME set to
299 true, the protocol of the context is set to CMS. */
300 static gpgme_ctx_t create_gpgme_context (int for_smime)
305 err = gpgme_new (&ctx);
307 mutt_error (_("error creating gpgme context: %s\n"), gpgme_strerror (err));
313 err = gpgme_set_protocol (ctx, GPGME_PROTOCOL_CMS);
315 mutt_error (_("error enabling CMS protocol: %s\n"), gpgme_strerror (err));
324 /* Create a new gpgme data object. This is a wrapper to die on
326 static gpgme_data_t create_gpgme_data (void)
331 err = gpgme_data_new (&data);
333 mutt_error (_("error creating gpgme data object: %s\n"),
334 gpgme_strerror (err));
341 /* Create a new GPGME Data object from the mail body A. With CONVERT
342 passed as true, the lines are converted to CR,LF if required.
343 Return NULL on error or the gpgme_data_t object on success. */
344 static gpgme_data_t body_to_data_object (BODY * a, int convert)
346 char tempfile[_POSIX_PATH_MAX];
351 fptmp = m_tempfile(tempfile, sizeof(tempfile), NONULL(Tempdir), NULL);
353 mutt_perror (_("Can't create temporary file"));
357 mutt_write_mime_header (a, fptmp);
359 mutt_write_mime_body (a, fptmp);
363 unsigned char buf[1];
365 data = create_gpgme_data ();
367 while ((c = fgetc (fptmp)) != EOF) {
371 if (c == '\n' && !hadcr) {
373 gpgme_data_write (data, buf, 1);
378 /* FIXME: This is quite suboptimal */
380 gpgme_data_write (data, buf, 1);
382 gpgme_data_seek (data, 0, SEEK_SET);
384 err = gpgme_data_new_from_file (&data, tempfile, 1);
389 mutt_error (_("error allocating data object: %s\n"), gpgme_strerror (err));
396 /* Create a GPGME data object from the stream FP but limit the object
397 to LENGTH bytes starting at OFFSET bytes from the beginning of the
399 static gpgme_data_t file_to_data_object (FILE * fp, long offset, long length)
404 err = gpgme_data_new_from_filepart (&data, NULL, fp, offset, length);
406 mutt_error (_("error allocating data object: %s\n"), gpgme_strerror (err));
413 /* Write a GPGME data object to the stream FP. */
414 static int data_object_to_stream (gpgme_data_t data, FILE * fp)
420 err = ((gpgme_data_seek (data, 0, SEEK_SET) == -1)
421 ? gpgme_error_from_errno (errno) : 0);
423 mutt_error (_("error rewinding data object: %s\n"), gpgme_strerror (err));
427 while ((nread = gpgme_data_read (data, buf, sizeof (buf)))) {
428 /* fixme: we are not really converting CRLF to LF but just
429 skipping CR. Doing it correctly needs a more complex logic */
430 for (p = buf; nread; p++, nread--) {
436 mutt_perror ("[tempfile]");
441 mutt_error (_("error reading data object: %s\n"), strerror (errno));
447 /* Copy a data object to a newly created temporay file and return that
448 filename. Caller must free. With RET_FP not NULL, don't close the
449 stream but return it there. */
450 static char *data_object_to_tempfile (gpgme_data_t data, FILE ** ret_fp)
453 char tempfile[_POSIX_PATH_MAX];
457 fp = m_tempfile(tempfile, sizeof(tempfile), NONULL(Tempdir), NULL);
459 mutt_perror (_("Can't create temporary file"));
463 err = ((gpgme_data_seek (data, 0, SEEK_SET) == -1)
464 ? gpgme_error_from_errno (errno) : 0);
468 while ((nread = gpgme_data_read (data, buf, sizeof (buf)))) {
469 if (fwrite (buf, nread, 1, fp) != 1) {
470 mutt_perror (tempfile);
482 mutt_error (_("error reading data object: %s\n"), gpgme_strerror (err));
489 return m_strdup(tempfile);
493 /* Create a GpgmeRecipientSet from the keys in the string KEYLIST.
494 The keys must be space delimited. */
495 static gpgme_key_t *create_recipient_set (const char *keylist,
496 gpgme_protocol_t protocol)
502 gpgme_key_t *rset = NULL;
503 unsigned int rset_n = 0;
504 gpgme_key_t key = NULL;
505 gpgme_ctx_t context = NULL;
507 err = gpgme_new (&context);
509 err = gpgme_set_protocol (context, protocol);
516 for (i = 0; *s && *s != ' ' && i < ssizeof(buf) - 1;)
520 if (i > 1 && buf[i - 1] == '!') {
521 /* The user selected to override the valididy of that
525 err = gpgme_get_key (context, buf, &key, 0);
527 key->uids->validity = GPGME_VALIDITY_FULL;
531 err = gpgme_get_key (context, buf, &key, 0);
534 p_realloc(&rset, rset_n + 1);
535 rset[rset_n++] = key;
538 mutt_error (_("error adding recipient `%s': %s\n"),
539 buf, gpgme_strerror (err));
547 /* NULL terminate. */
548 p_realloc(&rset, rset_n + 1);
549 rset[rset_n++] = NULL;
552 gpgme_release (context);
558 /* Make sure that the correct signer is set. Returns 0 on success. */
559 static int set_signer (gpgme_ctx_t ctx, int for_smime)
561 char *signid = for_smime ? SmimeDefaultKey : PgpSignAs;
564 gpgme_key_t key, key2;
566 if (!signid || !*signid)
569 listctx = create_gpgme_context (for_smime);
570 err = gpgme_op_keylist_start (listctx, signid, 1);
572 err = gpgme_op_keylist_next (listctx, &key);
574 gpgme_release (listctx);
575 mutt_error (_("secret key `%s' not found: %s\n"),
576 signid, gpgme_strerror (err));
579 err = gpgme_op_keylist_next (listctx, &key2);
581 gpgme_key_release (key);
582 gpgme_key_release (key2);
583 gpgme_release (listctx);
584 mutt_error (_("ambiguous specification of secret key `%s'\n"), signid);
587 gpgme_op_keylist_end (listctx);
588 gpgme_release (listctx);
590 gpgme_signers_clear (ctx);
591 err = gpgme_signers_add (ctx, key);
592 gpgme_key_release (key);
594 mutt_error (_("error setting secret key `%s': %s\n"),
595 signid, gpgme_strerror (err));
602 /* Encrypt the gpgme data object PLAINTEXT to the recipients in RSET
603 and return an allocated filename to a temporary file containing the
604 enciphered text. With USE_SMIME set to true, the smime backend is
605 used. With COMBINED_SIGNED a PGP message is signed and
606 encrypted. Returns NULL in case of error */
607 static char *encrypt_gpgme_object (gpgme_data_t plaintext, gpgme_key_t * rset,
608 int use_smime, int combined_signed)
612 gpgme_data_t ciphertext;
615 ctx = create_gpgme_context (use_smime);
617 gpgme_set_armor (ctx, 1);
619 ciphertext = create_gpgme_data ();
621 if (combined_signed) {
622 if (set_signer (ctx, use_smime)) {
623 gpgme_data_release (ciphertext);
627 err = gpgme_op_encrypt_sign (ctx, rset, GPGME_ENCRYPT_ALWAYS_TRUST,
628 plaintext, ciphertext);
631 err = gpgme_op_encrypt (ctx, rset, GPGME_ENCRYPT_ALWAYS_TRUST,
632 plaintext, ciphertext);
633 mutt_need_hard_redraw ();
635 mutt_error (_("error encrypting data: %s\n"), gpgme_strerror (err));
636 gpgme_data_release (ciphertext);
643 outfile = data_object_to_tempfile (ciphertext, NULL);
644 gpgme_data_release (ciphertext);
648 /* Find the "micalg" parameter from the last Gpgme operation on
649 context CTX. It is expected that this operation was a sign
650 operation. Return the algorithm name as a C string in buffer BUF
651 which must have been allocated by the caller with size BUFLEN.
652 Returns 0 on success or -1 in case of an error. The return string
653 is truncted to BUFLEN - 1. */
654 static int get_micalg (gpgme_ctx_t ctx, char *buf, ssize_t buflen)
656 gpgme_sign_result_t result = NULL;
657 const char *algorithm_name = NULL;
663 result = gpgme_op_sign_result (ctx);
665 algorithm_name = gpgme_hash_algo_name (result->signatures->hash_algo);
666 if (algorithm_name) {
667 m_strcpy(buf, buflen, algorithm_name);
671 return *buf ? 0 : -1;
674 static void print_time (time_t t, STATE * s)
678 setlocale (LC_TIME, "");
679 #ifdef HAVE_LANGINFO_D_T_FMT
680 strftime (p, sizeof (p), nl_langinfo (D_T_FMT), localtime (&t));
682 strftime (p, sizeof (p), "%c", localtime (&t));
684 setlocale (LC_TIME, "C");
685 state_attach_puts (p, s);
689 * Implementation of `sign_message'.
692 /* Sign the MESSAGE in body A either using OpenPGP or S/MIME when
693 USE_SMIME is passed as true. Returns the new body or NULL on
695 static BODY *sign_message (BODY * a, int use_smime)
702 gpgme_data_t message, signature;
704 convert_to_7bit (a); /* Signed data _must_ be in 7-bit format. */
706 message = body_to_data_object (a, 1);
709 signature = create_gpgme_data ();
711 ctx = create_gpgme_context (use_smime);
713 gpgme_set_armor (ctx, 1);
715 if (set_signer (ctx, use_smime)) {
716 gpgme_data_release (signature);
721 err = gpgme_op_sign (ctx, message, signature, GPGME_SIG_MODE_DETACH);
722 mutt_need_hard_redraw ();
723 gpgme_data_release (message);
725 gpgme_data_release (signature);
727 mutt_error (_("error signing data: %s\n"), gpgme_strerror (err));
731 sigfile = data_object_to_tempfile (signature, NULL);
732 gpgme_data_release (signature);
739 t->type = TYPEMULTIPART;
740 t->subtype = m_strdup("signed");
741 t->encoding = ENC7BIT;
743 t->disposition = DISPINLINE;
745 parameter_set_boundary(&t->parameter);
746 parameter_setval(&t->parameter, "protocol",
747 use_smime ? "application/pkcs7-signature"
748 : "application/pgp-signature");
749 /* Get the micalg from gpgme. Old gpgme versions don't support this
750 for S/MIME so we assume sha-1 in this case. */
751 if (!get_micalg (ctx, buf, sizeof buf))
752 parameter_setval(&t->parameter, "micalg", buf);
754 parameter_setval(&t->parameter, "micalg", "sha1");
760 t->parts->next = body_new();
762 t->type = TYPEAPPLICATION;
764 t->subtype = m_strdup("pkcs7-signature");
765 parameter_setval(&t->parameter, "name", "smime.p7s");
766 t->encoding = ENCBASE64;
768 t->disposition = DISPATTACH;
769 t->d_filename = m_strdup("smime.p7s");
772 t->subtype = m_strdup("pgp-signature");
774 t->disposition = DISPINLINE;
775 t->encoding = ENC7BIT;
777 t->filename = sigfile;
778 t->unlink = 1; /* ok to remove this file after sending. */
784 BODY *pgp_gpgme_sign_message (BODY * a)
786 return sign_message (a, 0);
789 BODY *smime_gpgme_sign_message (BODY * a)
791 return sign_message (a, 1);
795 * Implementation of `encrypt_message'.
798 /* Encrypt the mail body A to all keys given as space separated keyids
799 or fingerprints in KEYLIST and return the encrypted body. */
800 BODY *pgp_gpgme_encrypt_message (BODY * a, char *keylist, int sign)
802 char *outfile = NULL;
804 gpgme_key_t *rset = NULL;
805 gpgme_data_t plaintext;
807 rset = create_recipient_set (keylist, GPGME_PROTOCOL_OpenPGP);
813 plaintext = body_to_data_object (a, 0);
819 outfile = encrypt_gpgme_object (plaintext, rset, 0, sign);
820 gpgme_data_release (plaintext);
826 t->type = TYPEMULTIPART;
827 t->subtype = m_strdup("encrypted");
828 t->encoding = ENC7BIT;
830 t->disposition = DISPINLINE;
832 parameter_set_boundary(&t->parameter);
833 parameter_setval(&t->parameter, "protocol", "application/pgp-encrypted");
835 t->parts = body_new();
836 t->parts->type = TYPEAPPLICATION;
837 t->parts->subtype = m_strdup("pgp-encrypted");
838 t->parts->encoding = ENC7BIT;
840 t->parts->next = body_new();
841 t->parts->next->type = TYPEAPPLICATION;
842 t->parts->next->subtype = m_strdup("octet-stream");
843 t->parts->next->encoding = ENC7BIT;
844 t->parts->next->filename = outfile;
845 t->parts->next->use_disp = 1;
846 t->parts->next->disposition = DISPINLINE;
847 t->parts->next->unlink = 1; /* delete after sending the message */
848 t->parts->next->d_filename = m_strdup("msg.asc"); /* non pgp/mime
855 * Implementation of `smime_build_smime_entity'.
858 /* Encrypt the mail body A to all keys given as space separated
859 fingerprints in KEYLIST and return the S/MIME encrypted body. */
860 BODY *smime_gpgme_build_smime_entity (BODY * a, char *keylist)
862 char *outfile = NULL;
864 gpgme_key_t *rset = NULL;
865 gpgme_data_t plaintext;
867 rset = create_recipient_set (keylist, GPGME_PROTOCOL_CMS);
871 plaintext = body_to_data_object (a, 0);
877 outfile = encrypt_gpgme_object (plaintext, rset, 1, 0);
878 gpgme_data_release (plaintext);
884 t->type = TYPEAPPLICATION;
885 t->subtype = m_strdup("pkcs7-mime");
886 parameter_setval(&t->parameter, "name", "smime.p7m");
887 parameter_setval(&t->parameter, "smime-type", "enveloped-data");
888 t->encoding = ENCBASE64; /* The output of OpenSSL SHOULD be binary */
890 t->disposition = DISPATTACH;
891 t->d_filename = m_strdup("smime.p7m");
892 t->filename = outfile;
893 t->unlink = 1; /*delete after sending the message */
902 * Implementation of `verify_one'.
905 /* Display the common attributes of the signature summary SUM.
906 Return 1 if there is is a severe warning.
908 static int show_sig_summary (unsigned long sum,
909 gpgme_ctx_t ctx, gpgme_key_t key, int idx,
914 if ((sum & GPGME_SIGSUM_KEY_REVOKED)) {
915 state_attach_puts (_("Warning: One of the keys has been revoked\n"), s);
919 if ((sum & GPGME_SIGSUM_KEY_EXPIRED)) {
920 time_t at = key->subkeys->expires ? key->subkeys->expires : 0;
923 state_attach_puts (_("Warning: The key used to create the "
924 "signature expired at: "), s);
926 state_attach_puts ("\n", s);
929 state_attach_puts (_("Warning: At least one certification key "
930 "has expired\n"), s);
933 if ((sum & GPGME_SIGSUM_SIG_EXPIRED)) {
934 gpgme_verify_result_t result;
935 gpgme_signature_t sig;
938 result = gpgme_op_verify_result (ctx);
940 for (sig = result->signatures, i = 0; sig && (i < idx);
941 sig = sig->next, i++);
943 state_attach_puts (_("Warning: The signature expired at: "), s);
944 print_time (sig ? sig->exp_timestamp : 0, s);
945 state_attach_puts ("\n", s);
948 if ((sum & GPGME_SIGSUM_KEY_MISSING))
949 state_attach_puts (_("Can't verify due to a missing "
950 "key or certificate\n"), s);
952 if ((sum & GPGME_SIGSUM_CRL_MISSING)) {
953 state_attach_puts (_("The CRL is not available\n"), s);
957 if ((sum & GPGME_SIGSUM_CRL_TOO_OLD)) {
958 state_attach_puts (_("Available CRL is too old\n"), s);
962 if ((sum & GPGME_SIGSUM_BAD_POLICY))
963 state_attach_puts (_("A policy requirement was not met\n"), s);
965 if ((sum & GPGME_SIGSUM_SYS_ERROR)) {
966 const char *t0 = NULL, *t1 = NULL;
967 gpgme_verify_result_t result;
968 gpgme_signature_t sig;
971 state_attach_puts (_("A system error occurred"), s);
973 /* Try to figure out some more detailed system error information. */
974 result = gpgme_op_verify_result (ctx);
975 for (sig = result->signatures, i = 0; sig && (i < idx);
976 sig = sig->next, i++);
979 t1 = sig->wrong_key_usage ? "Wrong_Key_Usage" : "";
983 state_attach_puts (": ", s);
985 state_attach_puts (t0, s);
986 if (t1 && !(t0 && !m_strcmp(t0, t1))) {
988 state_attach_puts (",", s);
989 state_attach_puts (t1, s);
992 state_attach_puts ("\n", s);
999 static void show_fingerprint (gpgme_key_t key, STATE * state)
1004 const char *prefix = _("Fingerprint: ");
1008 s = key->subkeys ? key->subkeys->fpr : NULL;
1011 is_pgp = (key->protocol == GPGME_PROTOCOL_OpenPGP);
1013 buf = xmalloc(m_strlen(prefix) + m_strlen(s) * 4 + 2);
1014 strcpy (buf, prefix); /* __STRCPY_CHECKED__ */
1015 p = buf + m_strlen(buf);
1016 if (is_pgp && m_strlen(s) == 40) { /* PGP v4 style formatted. */
1017 for (i = 0; *s && s[1] && s[2] && s[3] && s[4]; s += 4, i++) {
1028 for (i = 0; *s && s[1] && s[2]; s += 2, i++) {
1031 *p++ = is_pgp ? ' ' : ':';
1032 if (is_pgp && i == 7)
1037 /* just in case print remaining odd digits */
1042 state_attach_puts (buf, state);
1046 /* Show the valididy of a key used for one signature. */
1047 static void show_one_sig_validity (gpgme_ctx_t ctx, int idx, STATE * s)
1049 gpgme_verify_result_t result = NULL;
1050 gpgme_signature_t sig = NULL;
1051 const char *txt = NULL;
1053 result = gpgme_op_verify_result (ctx);
1055 for (sig = result->signatures; sig && (idx > 0); sig = sig->next, idx--);
1057 switch (sig ? sig->validity : 0) {
1058 case GPGME_VALIDITY_UNKNOWN:
1059 txt = _("WARNING: We have NO indication whether "
1060 "the key belongs to the person named " "as shown above\n");
1062 case GPGME_VALIDITY_UNDEFINED:
1064 case GPGME_VALIDITY_NEVER:
1065 txt = _("WARNING: The key does NOT BELONG to "
1066 "the person named as shown above\n");
1068 case GPGME_VALIDITY_MARGINAL:
1069 txt = _("WARNING: It is NOT certain that the key "
1070 "belongs to the person named as shown above\n");
1072 case GPGME_VALIDITY_FULL:
1073 case GPGME_VALIDITY_ULTIMATE:
1078 state_attach_puts (txt, s);
1081 /* Show information about one signature. This fucntion is called with
1082 the context CTX of a sucessful verification operation and the
1083 enumerator IDX which should start at 0 and incremete for each
1086 Return values are: 0 for normal procession, 1 for a bad signature,
1087 2 for a signature with a warning or -1 for no more signature. */
1088 static int show_one_sig_status (gpgme_ctx_t ctx, int idx, STATE * s)
1091 const char *fpr, *uid;
1092 gpgme_key_t key = NULL;
1093 int i, anybad = 0, anywarn = 0;
1095 gpgme_user_id_t uids = NULL;
1096 gpgme_verify_result_t result;
1097 gpgme_signature_t sig;
1098 gpgme_error_t err = GPG_ERR_NO_ERROR;
1100 result = gpgme_op_verify_result (ctx);
1102 /* FIXME: this code should use a static variable and remember
1103 the current position in the list of signatures, IMHO.
1106 for (i = 0, sig = result->signatures; sig && (i < idx);
1107 i++, sig = sig->next);
1109 return -1; /* Signature not found. */
1111 if (signature_key) {
1112 gpgme_key_release (signature_key);
1113 signature_key = NULL;
1116 created = sig->timestamp;
1120 if (gpg_err_code (sig->status) != GPG_ERR_NO_ERROR)
1123 err = gpgme_get_key (ctx, fpr, &key, 0); /* secret key? */
1125 uid = (key->uids && key->uids->uid) ? key->uids->uid : "[?]";
1127 signature_key = key;
1130 key = NULL; /* Old gpgme versions did not set KEY to NULL on
1131 error. Do it here to avoid a double free. */
1135 if (!s || !s->fpout || !(s->flags & M_DISPLAY)); /* No state information so no way to print anything. */
1137 state_attach_puts (_("Error getting key information: "), s);
1138 state_attach_puts (gpg_strerror (err), s);
1139 state_attach_puts ("\n", s);
1142 else if ((sum & GPGME_SIGSUM_GREEN)) {
1143 state_attach_puts (_("Good signature from: "), s);
1144 state_attach_puts (uid, s);
1145 state_attach_puts ("\n", s);
1146 for (i = 1, uids = key->uids; uids; i++, uids = uids->next) {
1148 /* Skip primary UID. */
1152 state_attach_puts (_(" aka: "), s);
1153 state_attach_puts (uids->uid, s);
1154 state_attach_puts ("\n", s);
1156 state_attach_puts (_(" created: "), s);
1157 print_time (created, s);
1158 state_attach_puts ("\n", s);
1159 if (show_sig_summary (sum, ctx, key, idx, s))
1161 show_one_sig_validity (ctx, idx, s);
1163 else if ((sum & GPGME_SIGSUM_RED)) {
1164 state_attach_puts (_("*BAD* signature claimed to be from: "), s);
1165 state_attach_puts (uid, s);
1166 state_attach_puts ("\n", s);
1167 show_sig_summary (sum, ctx, key, idx, s);
1169 else if (!anybad && key && (key->protocol == GPGME_PROTOCOL_OpenPGP)) { /* We can't decide (yellow) but this is a PGP key with a good
1170 signature, so we display what a PGP user expects: The name,
1171 fingerprint and the key validity (which is neither fully or
1173 state_attach_puts (_("Good signature from: "), s);
1174 state_attach_puts (uid, s);
1175 state_attach_puts ("\n", s);
1176 state_attach_puts (_(" created: "), s);
1177 print_time (created, s);
1178 state_attach_puts ("\n", s);
1179 show_one_sig_validity (ctx, idx, s);
1180 show_fingerprint (key, s);
1181 if (show_sig_summary (sum, ctx, key, idx, s))
1184 else { /* can't decide (yellow) */
1186 state_attach_puts (_("Error checking signature"), s);
1187 state_attach_puts ("\n", s);
1188 show_sig_summary (sum, ctx, key, idx, s);
1191 if (key != signature_key)
1192 gpgme_key_release (key);
1195 return anybad ? 1 : anywarn ? 2 : 0;
1198 /* Do the actual verification step. With IS_SMIME set to true we
1199 assume S/MIME (surprise!) */
1200 static int verify_one (BODY * sigbdy, STATE * s,
1201 const char *tempfile, int is_smime)
1207 gpgme_data_t signature, message;
1209 signature = file_to_data_object (s->fpin, sigbdy->offset, sigbdy->length);
1213 /* We need to tell gpgme about the encoding because the backend can't
1214 auto-detect plain base-64 encoding which is used by S/MIME. */
1216 gpgme_data_set_encoding (signature, GPGME_DATA_ENCODING_BASE64);
1218 err = gpgme_data_new_from_file (&message, tempfile, 1);
1220 gpgme_data_release (signature);
1221 mutt_error (_("error allocating data object: %s\n"), gpgme_strerror (err));
1224 ctx = create_gpgme_context (is_smime);
1226 /* Note: We don't need a current time output because GPGME avoids
1227 such an attack by separating the meta information from the
1229 state_attach_puts (_("[-- Begin signature information --]\n"), s);
1231 err = gpgme_op_verify (ctx, signature, message, NULL);
1232 mutt_need_hard_redraw ();
1236 snprintf (buf, sizeof (buf) - 1,
1237 _("Error: verification failed: %s\n"), gpgme_strerror (err));
1238 state_attach_puts (buf, s);
1240 else { /* Verification succeeded, see what the result is. */
1244 if (signature_key) {
1245 gpgme_key_release (signature_key);
1246 signature_key = NULL;
1249 for (idx = 0; (res = show_one_sig_status (ctx, idx, s)) != -1; idx++) {
1260 gpgme_verify_result_t result;
1261 gpgme_sig_notation_t notation;
1262 gpgme_signature_t sig;
1264 result = gpgme_op_verify_result (ctx);
1266 for (sig = result->signatures; sig; sig = sig->next) {
1267 if (sig->notations) {
1268 state_attach_puts ("*** Begin Notation (signature by: ", s);
1269 state_attach_puts (sig->fpr, s);
1270 state_attach_puts (") ***\n", s);
1271 for (notation = sig->notations; notation; notation = notation->next)
1273 if (notation->name) {
1274 state_attach_puts (notation->name, s);
1275 state_attach_puts ("=", s);
1277 if (notation->value) {
1278 state_attach_puts (notation->value, s);
1279 if (!(*notation->value
1280 && (notation->value[m_strlen(notation->value) - 1] ==
1282 state_attach_puts ("\n", s);
1285 state_attach_puts ("*** End Notation ***\n", s);
1291 gpgme_release (ctx);
1293 state_attach_puts (_("[-- End signature information --]\n\n"), s);
1295 return badsig ? 1 : anywarn ? 2 : 0;
1298 int pgp_gpgme_verify_one (BODY * sigbdy, STATE * s, const char *tempfile)
1300 return verify_one (sigbdy, s, tempfile, 0);
1303 int smime_gpgme_verify_one (BODY * sigbdy, STATE * s, const char *tempfile)
1305 return verify_one (sigbdy, s, tempfile, 1);
1309 * Implementation of `decrypt_part'.
1312 /* Decrypt a PGP or SMIME message (depending on the boolean flag
1313 IS_SMIME) with body A described further by state S. Write
1314 plaintext out to file FPOUT and return a new body. For PGP returns
1315 a flag in R_IS_SIGNED to indicate whether this is a combined
1316 encrypted and signed message, for S/MIME it returns true when it is
1317 not a encrypted but a signed message. */
1318 static BODY *decrypt_part (BODY * a, STATE * s, FILE * fpout, int is_smime,
1325 gpgme_data_t ciphertext, plaintext;
1326 int maybe_signed = 0;
1333 ctx = create_gpgme_context (is_smime);
1336 /* Make a data object from the body, create context etc. */
1337 ciphertext = file_to_data_object (s->fpin, a->offset, a->length);
1340 plaintext = create_gpgme_data ();
1342 /* Do the decryption or the verification in case of the S/MIME hack. */
1343 if ((!is_smime) || maybe_signed) {
1345 err = gpgme_op_decrypt_verify (ctx, ciphertext, plaintext);
1346 else if (maybe_signed)
1347 err = gpgme_op_verify (ctx, ciphertext, NULL, plaintext);
1350 /* Check wether signatures have been verified. */
1351 gpgme_verify_result_t verify_result = gpgme_op_verify_result (ctx);
1353 if (verify_result->signatures)
1358 err = gpgme_op_decrypt (ctx, ciphertext, plaintext);
1359 gpgme_data_release (ciphertext);
1361 if (is_smime && !maybe_signed && gpg_err_code (err) == GPG_ERR_NO_DATA) {
1362 /* Check whether this might be a signed message despite what
1363 the mime header told us. Retry then. gpgsm returns the
1364 error information "unsupported Algorithm '?'" but gpgme
1365 will not store this unknown algorithm, thus we test that
1366 it has not been set. */
1367 gpgme_decrypt_result_t result;
1369 result = gpgme_op_decrypt_result (ctx);
1370 if (!result->unsupported_algorithm) {
1372 gpgme_data_release (plaintext);
1376 mutt_need_hard_redraw ();
1377 if ((s->flags & M_DISPLAY)) {
1380 snprintf (buf, sizeof (buf) - 1,
1381 _("[-- Error: decryption failed: %s --]\n\n"),
1382 gpgme_strerror (err));
1383 state_attach_puts (buf, s);
1385 gpgme_data_release (plaintext);
1386 gpgme_release (ctx);
1389 mutt_need_hard_redraw ();
1391 /* Read the output from GPGME, and make sure to change CRLF to LF,
1392 otherwise read_mime_header has a hard time parsing the message. */
1393 if (data_object_to_stream (plaintext, fpout)) {
1394 gpgme_data_release (plaintext);
1395 gpgme_release (ctx);
1398 gpgme_data_release (plaintext);
1400 a->is_signed_data = 0;
1406 a->is_signed_data = 1;
1408 *r_is_signed = -1; /* A signature exists. */
1410 if ((s->flags & M_DISPLAY))
1411 state_attach_puts (_("[-- Begin signature " "information --]\n"), s);
1412 for (idx = 0; (res = show_one_sig_status (ctx, idx, s)) != -1; idx++) {
1418 if (!anybad && idx && r_is_signed && *r_is_signed)
1419 *r_is_signed = anywarn ? 2 : 1; /* Good signature. */
1421 if ((s->flags & M_DISPLAY))
1422 state_attach_puts (_("[-- End signature " "information --]\n\n"), s);
1424 gpgme_release (ctx);
1429 tattach = mutt_read_mime_header (fpout, 0);
1432 * Need to set the length of this body part.
1434 fstat (fileno (fpout), &info);
1435 tattach->length = info.st_size - tattach->offset;
1437 tattach->warnsig = anywarn;
1439 /* See if we need to recurse on this MIME part. */
1440 mutt_parse_part (fpout, tattach);
1446 /* Decrypt a PGP/MIME message in FPIN and B and return a new body and
1447 the stream in CUR and FPOUT. Returns 0 on success. */
1448 int pgp_gpgme_decrypt_mime (FILE * fpin, FILE ** fpout, BODY * b, BODY ** cur)
1450 char tempfile[_POSIX_PATH_MAX];
1452 BODY *first_part = b;
1455 first_part->goodsig = 0;
1456 first_part->warnsig = 0;
1458 if (!mutt_is_multipart_encrypted (b))
1461 if (!b->parts || !b->parts->next)
1468 *fpout = m_tempfile(tempfile, sizeof(tempfile), NONULL(Tempdir), NULL);
1470 mutt_perror (_("Can't create temporary file"));
1475 *cur = decrypt_part (b, &s, *fpout, 0, &is_signed);
1478 first_part->goodsig = 1;
1480 return *cur ? 0 : -1;
1484 /* Decrypt a S/MIME message in FPIN and B and return a new body and
1485 the stream in CUR and FPOUT. Returns 0 on success. */
1486 int smime_gpgme_decrypt_mime (FILE * fpin, FILE ** fpout, BODY * b,
1489 char tempfile[_POSIX_PATH_MAX];
1493 long saved_b_offset;
1494 ssize_t saved_b_length;
1497 if (!mutt_is_application_smime (b))
1503 /* Decode the body - we need to pass binary CMS to the
1504 backend. The backend allows for Base64 encoded data but it does
1505 not allow for QP which I have seen in some messages. So better
1507 saved_b_type = b->type;
1508 saved_b_offset = b->offset;
1509 saved_b_length = b->length;
1512 fseeko (s.fpin, b->offset, 0);
1513 tmpfp = m_tempfile (tempfile, sizeof(tempfile), NONULL(Tempdir), NULL);
1515 mutt_perror (_("Can't create temporary file"));
1518 mutt_unlink (tempfile);
1521 mutt_decode_attachment (b, &s);
1523 b->length = ftello (s.fpout);
1530 *fpout = m_tempfile(tempfile, sizeof(tempfile), NONULL(Tempdir), NULL);
1532 mutt_perror (_("Can't create temporary file"));
1535 mutt_unlink (tempfile);
1537 *cur = decrypt_part (b, &s, *fpout, 1, &is_signed);
1539 (*cur)->goodsig = is_signed > 0;
1540 b->type = saved_b_type;
1541 b->length = saved_b_length;
1542 b->offset = saved_b_offset;
1545 if (*cur && !is_signed && !(*cur)->parts
1546 && mutt_is_application_smime (*cur)) {
1547 /* Assume that this is a opaque signed s/mime message. This is
1548 an ugly way of doing it but we have anyway a problem with
1549 arbitrary encoded S/MIME messages: Only the outer part may be
1550 encrypted. The entire mime parsing should be revamped,
1551 probably by keeping the temportary files so that we don't
1552 need to decrypt them all the time. Inner parts of an
1553 encrypted part can then pint into this file and tehre won't
1554 never be a need to decrypt again. This needs a partial
1555 rewrite of the MIME engine. */
1559 saved_b_type = bb->type;
1560 saved_b_offset = bb->offset;
1561 saved_b_length = bb->length;
1564 fseeko (s.fpin, bb->offset, 0);
1565 tmpfp = m_tempfile (tempfile, sizeof(tempfile), NONULL(Tempdir), NULL);
1567 mutt_perror (_("Can't create temporary file"));
1570 mutt_unlink (tempfile);
1573 mutt_decode_attachment (bb, &s);
1575 bb->length = ftello (s.fpout);
1583 *fpout = m_tempfile(tempfile, sizeof(tempfile), NONULL(Tempdir), NULL);
1585 mutt_perror (_("Can't create temporary file"));
1588 mutt_unlink (tempfile);
1590 tmp_b = decrypt_part (bb, &s, *fpout, 1, &is_signed);
1592 tmp_b->goodsig = is_signed > 0;
1593 bb->type = saved_b_type;
1594 bb->length = saved_b_length;
1595 bb->offset = saved_b_offset;
1598 body_list_wipe(cur);
1601 return *cur ? 0 : -1;
1606 * Implementation of `pgp_check_traditional'.
1609 static int pgp_check_traditional_one_body (FILE * fp, BODY * b,
1612 char tempfile[_POSIX_PATH_MAX];
1613 char buf[HUGE_STRING];
1619 if (b->type != TYPETEXT)
1622 if (tagged_only && !b->tagged)
1625 mutt_mktemp (tempfile);
1626 if (mutt_decode_save_attachment (fp, b, tempfile, 0, 0) != 0) {
1631 if ((tfp = fopen (tempfile, "r")) == NULL) {
1636 while (fgets (buf, sizeof (buf), tfp)) {
1637 if (!m_strncmp("-----BEGIN PGP ", buf, 15)) {
1638 if (!m_strcmp("MESSAGE-----\n", buf + 15))
1640 else if (!m_strcmp("SIGNED MESSAGE-----\n", buf + 15))
1650 /* fix the content type */
1652 parameter_setval(&b->parameter, "format", "fixed");
1653 parameter_setval(&b->parameter, "x-action",
1654 enc ? "pgp-encrypted" : "pgp-signed");
1658 int pgp_gpgme_check_traditional (FILE * fp, BODY * b, int tagged_only)
1663 for (; b; b = b->next) {
1664 if (is_multipart (b))
1665 rv = (pgp_gpgme_check_traditional (fp, b->parts, tagged_only) || rv);
1666 else if (b->type == TYPETEXT) {
1667 if ((r = mutt_is_application_pgp (b)))
1670 rv = (pgp_check_traditional_one_body (fp, b, tagged_only) || rv);
1678 * Implementation of `application_handler'.
1682 Copy a clearsigned message, and strip the signature and PGP's
1685 XXX - charset handling: We assume that it is safe to do
1686 character set decoding first, dash decoding second here, while
1687 we do it the other way around in the main handler.
1689 (Note that we aren't worse than Outlook & Cie in this, and also
1690 note that we can successfully handle anything produced by any
1691 existing versions of mutt.) */
1693 static void copy_clearsigned (gpgme_data_t data, STATE * s, char *charset)
1695 char buf[HUGE_STRING];
1696 short complete, armor_header;
1701 fname = data_object_to_tempfile (data, &fp);
1707 fc = fgetconv_open (fp, charset, Charset, M_ICONV_HOOK_FROM);
1709 for (complete = 1, armor_header = 1;
1710 fgetconvs (buf, sizeof (buf), fc) != NULL;
1711 complete = strchr (buf, '\n') != NULL) {
1714 state_puts (buf, s);
1718 if (!m_strcmp(buf, "-----BEGIN PGP SIGNATURE-----\n"))
1728 state_puts (s->prefix, s);
1730 if (buf[0] == '-' && buf[1] == ' ')
1731 state_puts (buf + 2, s);
1733 state_puts (buf, s);
1736 fgetconv_close (&fc);
1741 /* Support for classic_application/pgp */
1742 int pgp_gpgme_application_handler (BODY * m, STATE * s)
1744 int needpass = -1, pgp_keyblock = 0;
1748 off_t last_pos, offset;
1749 char buf[HUGE_STRING];
1750 FILE *pgpout = NULL;
1752 gpgme_error_t err = 0;
1753 gpgme_data_t armored_data = NULL;
1755 short maybe_goodsig = 1;
1756 short have_any_sigs = 0;
1758 char body_charset[STRING]; /* Only used for clearsigned messages. */
1760 /* For clearsigned messages we won't be able to get a character set
1761 but we know that this may only be text thus we assume Latin-1
1763 if (!mutt_get_body_charset (body_charset, sizeof (body_charset), m))
1764 m_strcpy(body_charset, sizeof(body_charset), "iso-8859-1");
1766 fseeko (s->fpin, m->offset, 0);
1767 last_pos = m->offset;
1769 for (bytes = m->length; bytes > 0;) {
1770 if (fgets (buf, sizeof (buf), s->fpin) == NULL)
1773 offset = ftello (s->fpin);
1774 bytes -= (offset - last_pos); /* don't rely on m_strlen(buf) */
1777 if (!m_strncmp("-----BEGIN PGP ", buf, 15)) {
1779 start_pos = last_pos;
1781 if (!m_strcmp("MESSAGE-----\n", buf + 15))
1783 else if (!m_strcmp("SIGNED MESSAGE-----\n", buf + 15)) {
1787 else if (!option (OPTDONTHANDLEPGPKEYS) &&
1788 !m_strcmp("PUBLIC KEY BLOCK-----\n", buf + 15)) {
1793 /* XXX - we may wish to recode here */
1795 state_puts (s->prefix, s);
1796 state_puts (buf, s);
1800 have_any_sigs = (have_any_sigs || (clearsign && (s->flags & M_VERIFY)));
1802 /* Copy PGP material to an data container */
1803 armored_data = create_gpgme_data ();
1804 gpgme_data_write (armored_data, buf, m_strlen(buf));
1805 while (bytes > 0 && fgets (buf, sizeof (buf) - 1, s->fpin) != NULL) {
1806 offset = ftello (s->fpin);
1807 bytes -= (offset - last_pos); /* don't rely on m_strlen(buf) */
1810 gpgme_data_write (armored_data, buf, m_strlen(buf));
1812 if ((needpass && !m_strcmp("-----END PGP MESSAGE-----\n", buf))
1814 && (!m_strcmp("-----END PGP SIGNATURE-----\n", buf)
1815 || !m_strcmp("-----END PGP PUBLIC KEY BLOCK-----\n",
1820 /* Invoke PGP if needed */
1821 if (!clearsign || (s->flags & M_VERIFY)) {
1822 unsigned int sig_stat = 0;
1823 gpgme_data_t plaintext;
1826 plaintext = create_gpgme_data ();
1827 ctx = create_gpgme_context (0);
1830 err = gpgme_op_verify (ctx, armored_data, NULL, plaintext);
1832 err = gpgme_op_decrypt_verify (ctx, armored_data, plaintext);
1833 if (gpg_err_code (err) == GPG_ERR_NO_DATA) {
1834 /* Decrypt verify can't handle signed only messages. */
1835 err = (gpgme_data_seek (armored_data, 0, SEEK_SET) == -1)
1836 ? gpgme_error_from_errno (errno) : 0;
1837 /* Must release plaintext so that we supply an
1838 uninitialized object. */
1839 gpgme_data_release (plaintext);
1840 plaintext = create_gpgme_data ();
1841 err = gpgme_op_verify (ctx, armored_data, NULL, plaintext);
1848 snprintf (errbuf, sizeof (errbuf) - 1,
1849 _("Error: decryption/verification failed: %s\n"),
1850 gpgme_strerror (err));
1851 state_attach_puts (errbuf, s);
1853 else { /* Decryption/Verification succeeded */
1857 /* Check wether signatures have been verified. */
1858 gpgme_verify_result_t verify_result;
1860 verify_result = gpgme_op_verify_result (ctx);
1861 if (verify_result->signatures)
1867 if ((s->flags & M_DISPLAY) && sig_stat) {
1872 state_attach_puts (_("[-- Begin signature "
1873 "information --]\n"), s);
1876 (res = show_one_sig_status (ctx, idx, s)) != -1; idx++) {
1885 state_attach_puts (_("[-- End signature "
1886 "information --]\n\n"), s);
1889 tmpfname = data_object_to_tempfile (plaintext, &pgpout);
1892 state_attach_puts (_("Error: copy data failed\n"), s);
1896 p_delete(&tmpfname);
1899 gpgme_release (ctx);
1903 * Now, copy cleartext to the screen. NOTE - we expect that PGP
1904 * outputs utf-8 cleartext. This may not always be true, but it
1905 * seems to be a reasonable guess.
1908 if (s->flags & M_DISPLAY) {
1910 state_attach_puts (_("[-- BEGIN PGP MESSAGE --]\n\n"), s);
1911 else if (pgp_keyblock)
1912 state_attach_puts (_("[-- BEGIN PGP PUBLIC KEY BLOCK --]\n"), s);
1914 state_attach_puts (_("[-- BEGIN PGP SIGNED MESSAGE --]\n\n"), s);
1918 copy_clearsigned (armored_data, s, body_charset);
1925 fc = fgetconv_open (pgpout, "utf-8", Charset, 0);
1926 while ((c = fgetconv (fc)) != EOF) {
1928 if (c == '\n' && s->prefix)
1929 state_puts (s->prefix, s);
1931 fgetconv_close (&fc);
1934 if (s->flags & M_DISPLAY) {
1935 state_putc ('\n', s);
1937 state_attach_puts (_("[-- END PGP MESSAGE --]\n"), s);
1938 else if (pgp_keyblock)
1939 state_attach_puts (_("[-- END PGP PUBLIC KEY BLOCK --]\n"), s);
1941 state_attach_puts (_("[-- END PGP SIGNED MESSAGE --]\n"), s);
1949 /* XXX - we may wish to recode here */
1951 state_puts (s->prefix, s);
1952 state_puts (buf, s);
1956 m->goodsig = (maybe_goodsig && have_any_sigs);
1958 if (needpass == -1) {
1959 state_attach_puts (_("[-- Error: could not find beginning"
1960 " of PGP message! --]\n\n"), s);
1967 * Implementation of `encrypted_handler'.
1970 /* MIME handler for pgp/mime encrypted messages. */
1971 int pgp_gpgme_encrypted_handler (BODY * a, STATE * s)
1973 char tempfile[_POSIX_PATH_MAX];
1976 BODY *orig_body = a;
1981 if (!a || a->type != TYPEAPPLICATION || !a->subtype
1982 || ascii_strcasecmp ("pgp-encrypted", a->subtype)
1983 || !a->next || a->next->type != TYPEAPPLICATION || !a->next->subtype
1984 || ascii_strcasecmp ("octet-stream", a->next->subtype)) {
1985 if (s->flags & M_DISPLAY)
1986 state_attach_puts (_("[-- Error: malformed PGP/MIME message! --]\n\n"),
1991 /* Move forward to the application/pgp-encrypted body. */
1994 fpout = m_tempfile(tempfile, sizeof(tempfile), NONULL(Tempdir), NULL);
1996 if (s->flags & M_DISPLAY)
1997 state_attach_puts (_("[-- Error: could not create temporary file! "
2002 tattach = decrypt_part (a, s, fpout, 0, &is_signed);
2004 tattach->goodsig = is_signed > 0;
2006 if (s->flags & M_DISPLAY)
2007 state_attach_puts (is_signed ?
2009 ("[-- The following data is PGP/MIME signed and encrypted --]\n\n") :
2010 _("[-- The following data is PGP/MIME encrypted --]\n\n"), s);
2013 FILE *savefp = s->fpin;
2016 rc = mutt_body_handler (tattach, s);
2021 * if a multipart/signed is the _only_ sub-part of a
2022 * multipart/encrypted, cache signature verification
2025 if (mutt_is_multipart_signed (tattach) && !tattach->next)
2026 orig_body->goodsig |= tattach->goodsig;
2028 if (s->flags & M_DISPLAY) {
2029 state_puts ("\n", s);
2030 state_attach_puts (is_signed ?
2032 ("[-- End of PGP/MIME signed and encrypted data --]\n")
2033 : _("[-- End of PGP/MIME encrypted data --]\n"), s);
2036 body_list_wipe(&tattach);
2040 mutt_unlink (tempfile);
2044 /* Support for application/smime */
2045 int smime_gpgme_application_handler (BODY * a, STATE * s)
2047 char tempfile[_POSIX_PATH_MAX];
2054 fpout = m_tempfile(tempfile, sizeof(tempfile), NONULL(Tempdir), NULL);
2056 if (s->flags & M_DISPLAY)
2057 state_attach_puts (_("[-- Error: could not create temporary file! "
2062 tattach = decrypt_part (a, s, fpout, 1, &is_signed);
2064 tattach->goodsig = is_signed > 0;
2066 if (s->flags & M_DISPLAY)
2067 state_attach_puts (is_signed ?
2068 _("[-- The following data is S/MIME signed --]\n\n") :
2069 _("[-- The following data is S/MIME encrypted --]\n\n"), s);
2072 FILE *savefp = s->fpin;
2075 rc = mutt_body_handler (tattach, s);
2080 * if a multipart/signed is the _only_ sub-part of a
2081 * multipart/encrypted, cache signature verification
2084 if (mutt_is_multipart_signed (tattach) && !tattach->next) {
2085 if (!(a->goodsig = tattach->goodsig))
2086 a->warnsig = tattach->warnsig;
2088 else if (tattach->goodsig) {
2090 a->warnsig = tattach->warnsig;
2093 if (s->flags & M_DISPLAY) {
2094 state_puts ("\n", s);
2095 state_attach_puts (is_signed ?
2096 _("[-- End of S/MIME signed data --]\n") :
2097 _("[-- End of S/MIME encrypted data --]\n"), s);
2100 body_list_wipe(&tattach);
2104 mutt_unlink (tempfile);
2110 * Format an entry on the CRYPT key selection menu.
2113 * %k key id %K key id of the principal key
2115 * %a algorithm %A algorithm of the princ. key
2116 * %l length %L length of the princ. key
2117 * %f flags %F flags of the princ. key
2118 * %c capabilities %C capabilities of the princ. key
2119 * %t trust/validity of the key-uid association
2121 * %[...] date of key using strftime(3)
2125 crypt_entry_fmt (char *dest, ssize_t destlen, char op,
2126 const char *src, const char *prefix,
2127 const char *ifstring, const char *elsestring,
2128 unsigned long data, format_flag flags)
2131 crypt_entry_t *entry;
2134 int optional = (flags & M_FORMAT_OPTIONAL);
2135 const char *s = NULL;
2138 entry = (crypt_entry_t *) data;
2141 /* if (isupper ((unsigned char) op)) */
2144 kflags = (key->flags /*| (pkey->flags & KEYFLAG_RESTRICTIONS)
2147 switch (ascii_tolower (op)) {
2151 char buf2[SHORT_STRING], *p;
2167 while (len > 0 && *cp != ']') {
2176 break; /* not enough space */
2186 if (do_locales && Locale)
2187 setlocale (LC_TIME, Locale);
2192 if (key->kobj->subkeys && (key->kobj->subkeys->timestamp > 0))
2193 tt = key->kobj->subkeys->timestamp;
2195 tm = localtime (&tt);
2197 strftime (buf2, sizeof (buf2), dest, tm);
2200 setlocale (LC_TIME, "C");
2202 snprintf (fmt, sizeof (fmt), "%%%ss", prefix);
2203 snprintf (dest, destlen, fmt, buf2);
2210 snprintf (fmt, sizeof (fmt), "%%%sd", prefix);
2211 snprintf (dest, destlen, fmt, entry->num);
2216 /* fixme: we need a way to distinguish between main and subkeys.
2217 Store the idx in entry? */
2218 snprintf (fmt, sizeof (fmt), "%%%ss", prefix);
2219 snprintf (dest, destlen, fmt, crypt_keyid (key));
2224 snprintf (fmt, sizeof (fmt), "%%%ss", prefix);
2225 snprintf (dest, destlen, fmt, key->uid);
2230 snprintf (fmt, sizeof (fmt), "%%%s.3s", prefix);
2231 if (key->kobj->subkeys)
2232 s = gpgme_pubkey_algo_name (key->kobj->subkeys->pubkey_algo);
2235 snprintf (dest, destlen, fmt, s);
2240 snprintf (fmt, sizeof (fmt), "%%%slu", prefix);
2241 if (key->kobj->subkeys)
2242 val = key->kobj->subkeys->length;
2245 snprintf (dest, destlen, fmt, val);
2250 snprintf (fmt, sizeof (fmt), "%%%sc", prefix);
2251 snprintf (dest, destlen, fmt, crypt_flags (kflags));
2253 else if (!(kflags & (KEYFLAG_RESTRICTIONS)))
2258 snprintf (fmt, sizeof (fmt), "%%%ss", prefix);
2259 snprintf (dest, destlen, fmt, crypt_key_abilities (kflags));
2261 else if (!(kflags & (KEYFLAG_ABILITIES)))
2265 if ((kflags & KEYFLAG_ISX509))
2268 gpgme_user_id_t uid = NULL;
2271 for (i = 0, uid = key->kobj->uids; uid && (i < key->idx);
2272 i++, uid = uid->next);
2274 switch (uid->validity) {
2275 case GPGME_VALIDITY_UNDEFINED:
2278 case GPGME_VALIDITY_NEVER:
2281 case GPGME_VALIDITY_MARGINAL:
2284 case GPGME_VALIDITY_FULL:
2287 case GPGME_VALIDITY_ULTIMATE:
2290 case GPGME_VALIDITY_UNKNOWN:
2296 snprintf (fmt, sizeof (fmt), "%%%sc", prefix);
2297 snprintf (dest, destlen, fmt, s ? *s : 'B');
2300 snprintf (fmt, sizeof (fmt), "%%%ss", prefix);
2301 snprintf (dest, destlen, fmt,
2302 gpgme_get_protocol_name (key->kobj->protocol));
2310 mutt_FormatString (dest, destlen, ifstring, mutt_attach_fmt, data, 0);
2311 else if (flags & M_FORMAT_OPTIONAL)
2312 mutt_FormatString (dest, destlen, elsestring, mutt_attach_fmt, data, 0);
2316 /* Used by the display fucntion to format a line. */
2317 static void crypt_entry (char *s, ssize_t l, MUTTMENU * menu, int num)
2319 crypt_key_t **key_table = (crypt_key_t **) menu->data;
2320 crypt_entry_t entry;
2322 entry.key = key_table[num];
2323 entry.num = num + 1;
2325 mutt_FormatString (s, l, NONULL (PgpEntryFormat), crypt_entry_fmt,
2326 (unsigned long) &entry, M_FORMAT_ARROWCURSOR);
2329 /* Compare two addresses and the keyid to be used for sorting. */
2330 static int _crypt_compare_address (const void *a, const void *b)
2332 crypt_key_t **s = (crypt_key_t **) a;
2333 crypt_key_t **t = (crypt_key_t **) b;
2336 if ((r = m_strcasecmp((*s)->uid, (*t)->uid)))
2339 return m_strcasecmp(crypt_keyid (*s), crypt_keyid (*t)) > 0;
2342 static int crypt_compare_address (const void *a, const void *b)
2344 return ((PgpSortKeys & SORT_REVERSE) ? !_crypt_compare_address (a, b)
2345 : _crypt_compare_address (a, b));
2349 /* Compare two key IDs and the addresses to be used for sorting. */
2350 static int _crypt_compare_keyid (const void *a, const void *b)
2352 crypt_key_t **s = (crypt_key_t **) a;
2353 crypt_key_t **t = (crypt_key_t **) b;
2356 if ((r = m_strcasecmp(crypt_keyid (*s), crypt_keyid (*t))))
2359 return m_strcasecmp((*s)->uid, (*t)->uid) > 0;
2362 static int crypt_compare_keyid (const void *a, const void *b)
2364 return ((PgpSortKeys & SORT_REVERSE) ? !_crypt_compare_keyid (a, b)
2365 : _crypt_compare_keyid (a, b));
2368 /* Compare 2 creation dates and the addresses. For sorting. */
2369 static int _crypt_compare_date (const void *a, const void *b)
2371 crypt_key_t **s = (crypt_key_t **) a;
2372 crypt_key_t **t = (crypt_key_t **) b;
2373 unsigned long ts = 0, tt = 0;
2375 if ((*s)->kobj->subkeys && ((*s)->kobj->subkeys->timestamp > 0))
2376 ts = (*s)->kobj->subkeys->timestamp;
2377 if ((*t)->kobj->subkeys && ((*t)->kobj->subkeys->timestamp > 0))
2378 tt = (*t)->kobj->subkeys->timestamp;
2385 return m_strcasecmp((*s)->uid, (*t)->uid) > 0;
2388 static int crypt_compare_date (const void *a, const void *b)
2390 return ((PgpSortKeys & SORT_REVERSE) ? !_crypt_compare_date (a, b)
2391 : _crypt_compare_date (a, b));
2394 /* Compare two trust values, the key length, the creation dates. the
2395 addresses and the key IDs. For sorting. */
2396 static int _crypt_compare_trust (const void *a, const void *b)
2398 crypt_key_t **s = (crypt_key_t **) a;
2399 crypt_key_t **t = (crypt_key_t **) b;
2400 unsigned long ts = 0, tt = 0;
2403 if ((r = (((*s)->flags & (KEYFLAG_RESTRICTIONS))
2404 - ((*t)->flags & (KEYFLAG_RESTRICTIONS)))))
2407 if ((*s)->kobj->uids)
2408 ts = (*s)->kobj->uids->validity;
2409 if ((*t)->kobj->uids)
2410 tt = (*t)->kobj->uids->validity;
2411 if ((r = (tt - ts)))
2414 if ((*s)->kobj->subkeys)
2415 ts = (*s)->kobj->subkeys->length;
2416 if ((*t)->kobj->subkeys)
2417 tt = (*t)->kobj->subkeys->length;
2421 if ((*s)->kobj->subkeys && ((*s)->kobj->subkeys->timestamp > 0))
2422 ts = (*s)->kobj->subkeys->timestamp;
2423 if ((*t)->kobj->subkeys && ((*t)->kobj->subkeys->timestamp > 0))
2424 tt = (*t)->kobj->subkeys->timestamp;
2430 if ((r = m_strcasecmp((*s)->uid, (*t)->uid)))
2432 return (m_strcasecmp(crypt_keyid ((*s)), crypt_keyid ((*t)))) > 0;
2435 static int crypt_compare_trust (const void *a, const void *b)
2437 return ((PgpSortKeys & SORT_REVERSE) ? !_crypt_compare_trust (a, b)
2438 : _crypt_compare_trust (a, b));
2441 /* Print the X.500 Distinguished Name part KEY from the array of parts
2443 static int print_dn_part (FILE * fp, struct dn_array_s *dn, const char *key)
2447 for (; dn->key; dn++) {
2448 if (!m_strcmp(dn->key, key)) {
2451 print_utf8 (fp, dn->value, m_strlen(dn->value));
2458 /* Print all parts of a DN in a standard sequence. */
2459 static void print_dn_parts (FILE * fp, struct dn_array_s *dn)
2461 const char *stdpart[] = {
2462 "CN", "OU", "O", "STREET", "L", "ST", "C", NULL
2464 int any = 0, any2 = 0, i;
2466 for (i = 0; stdpart[i]; i++) {
2469 any = print_dn_part (fp, dn, stdpart[i]);
2471 /* now print the rest without any specific ordering */
2472 for (; dn->key; dn++) {
2473 for (i = 0; stdpart[i]; i++) {
2474 if (!m_strcmp(dn->key, stdpart[i]))
2482 any = print_dn_part (fp, dn, dn->key);
2491 /* Parse an RDN; this is a helper to parse_dn(). */
2492 static const unsigned char *parse_dn_part (struct dn_array_s *array,
2493 const unsigned char *string)
2495 const unsigned char *s, *s1;
2499 /* parse attributeType */
2500 for (s = string + 1; *s && *s != '='; s++);
2502 return NULL; /* error */
2505 return NULL; /* empty key */
2506 array->key = p_dupstr(string, n );
2507 p = (unsigned char *) array->key;
2510 if (*string == '#') { /* hexstring */
2512 for (s = string; hexdigitp (s); s++)
2516 return NULL; /* empty or odd number of digits */
2519 array->value = (char *) p;
2520 for (s1 = string; n; s1 += 2, n--)
2524 else { /* regular v3 quoted string */
2525 for (n = 0, s = string; *s; s++) {
2526 if (*s == '\\') { /* pair */
2528 if (*s == ',' || *s == '=' || *s == '+'
2529 || *s == '<' || *s == '>' || *s == '#' || *s == ';'
2530 || *s == '\\' || *s == '\"' || *s == ' ')
2532 else if (hexdigitp (s) && hexdigitp (s + 1)) {
2537 return NULL; /* invalid escape sequence */
2539 else if (*s == '\"')
2540 return NULL; /* invalid encoding */
2541 else if (*s == ',' || *s == '=' || *s == '+'
2542 || *s == '<' || *s == '>' || *s == '#' || *s == ';')
2549 array->value = (char *) p;
2550 for (s = string; n; s++, n--) {
2553 if (hexdigitp (s)) {
2569 /* Parse a DN and return an array-ized one. This is not a validating
2570 parser and it does not support any old-stylish syntax; gpgme is
2571 expected to return only rfc2253 compatible strings. */
2572 static struct dn_array_s *parse_dn (const unsigned char *string)
2574 struct dn_array_s *array;
2575 ssize_t arrayidx, arraysize;
2578 arraysize = 7; /* C,ST,L,O,OU,CN,email */
2579 array = p_new(struct dn_array_s, arraysize + 1);
2582 while (*string == ' ')
2586 if (arrayidx >= arraysize) { /* mutt lacks a real safe_realoc - so we need to copy */
2587 struct dn_array_s *a2;
2590 a2 = p_new(struct dn_array_s, arraysize + 1);
2591 for (i = 0; i < arrayidx; i++) {
2592 a2[i].key = array[i].key;
2593 a2[i].value = array[i].value;
2598 array[arrayidx].key = NULL;
2599 array[arrayidx].value = NULL;
2600 string = parse_dn_part (array + arrayidx, string);
2604 while (*string == ' ')
2606 if (*string && *string != ',' && *string != ';' && *string != '+')
2607 goto failure; /* invalid delimiter */
2611 array[arrayidx].key = NULL;
2612 array[arrayidx].value = NULL;
2616 for (i = 0; i < arrayidx; i++) {
2617 p_delete(&array[i].key);
2618 p_delete(&array[i].value);
2625 /* Print a nice representation of the USERID and make sure it is
2626 displayed in a proper way, which does mean to reorder some parts
2627 for S/MIME's DNs. USERID is a string as returned by the gpgme key
2628 functions. It is utf-8 encoded. */
2629 static void parse_and_print_user_id (FILE * fp, const char *userid)
2634 if (*userid == '<') {
2635 s = strchr (userid + 1, '>');
2637 print_utf8 (fp, userid + 1, s - userid - 1);
2639 else if (*userid == '(')
2640 fputs (_("[Can't display this user ID (unknown encoding)]"), fp);
2641 else if (!digit_or_letter ((const unsigned char *) userid))
2642 fputs (_("[Can't display this user ID (invalid encoding)]"), fp);
2644 struct dn_array_s *dn = parse_dn ((const unsigned char *) userid);
2647 fputs (_("[Can't display this user ID (invalid DN)]"), fp);
2649 print_dn_parts (fp, dn);
2650 for (i = 0; dn[i].key; i++) {
2651 p_delete(&dn[i].key);
2652 p_delete(&dn[i].value);
2660 KEY_CAP_CAN_ENCRYPT,
2665 static unsigned int key_check_cap (gpgme_key_t key, key_cap_t cap)
2667 gpgme_subkey_t subkey = NULL;
2668 unsigned int ret = 0;
2671 case KEY_CAP_CAN_ENCRYPT:
2672 if (!(ret = key->can_encrypt))
2673 for (subkey = key->subkeys; subkey; subkey = subkey->next)
2674 if ((ret = subkey->can_encrypt))
2677 case KEY_CAP_CAN_SIGN:
2678 if (!(ret = key->can_sign))
2679 for (subkey = key->subkeys; subkey; subkey = subkey->next)
2680 if ((ret = subkey->can_sign))
2683 case KEY_CAP_CAN_CERTIFY:
2684 if (!(ret = key->can_certify))
2685 for (subkey = key->subkeys; subkey; subkey = subkey->next)
2686 if ((ret = subkey->can_certify))
2695 /* Print verbose information about a key or certificate to FP. */
2696 static void print_key_info (gpgme_key_t key, FILE * fp)
2699 const char *s = NULL, *s2 = NULL;
2702 char shortbuf[SHORT_STRING];
2703 unsigned long aval = 0;
2707 gpgme_user_id_t uid = NULL;
2710 setlocale (LC_TIME, Locale);
2712 is_pgp = key->protocol == GPGME_PROTOCOL_OpenPGP;
2714 for (idx = 0, uid = key->uids; uid; idx++, uid = uid->next) {
2719 fputs (idx ? _(" aka ......: ") :_("Name ......: "), fp);
2722 fputs (_("[Invalid]"), fp);
2726 print_utf8 (fp, s, m_strlen(s));
2728 parse_and_print_user_id (fp, s);
2732 if (key->subkeys && (key->subkeys->timestamp > 0)) {
2733 tt = key->subkeys->timestamp;
2735 tm = localtime (&tt);
2736 #ifdef HAVE_LANGINFO_D_T_FMT
2737 strftime (shortbuf, sizeof shortbuf, nl_langinfo (D_T_FMT), tm);
2739 strftime (shortbuf, sizeof shortbuf, "%c", tm);
2741 fprintf (fp, _("Valid From : %s\n"), shortbuf);
2744 if (key->subkeys && (key->subkeys->expires > 0)) {
2745 tt = key->subkeys->expires;
2747 tm = localtime (&tt);
2748 #ifdef HAVE_LANGINFO_D_T_FMT
2749 strftime (shortbuf, sizeof shortbuf, nl_langinfo (D_T_FMT), tm);
2751 strftime (shortbuf, sizeof shortbuf, "%c", tm);
2753 fprintf (fp, _("Valid To ..: %s\n"), shortbuf);
2757 s = gpgme_pubkey_algo_name (key->subkeys->pubkey_algo);
2761 s2 = is_pgp ? "PGP" : "X.509";
2764 aval = key->subkeys->length;
2766 fprintf (fp, _("Key Type ..: %s, %lu bit %s\n"), s2, aval, s);
2768 fprintf (fp, _("Key Usage .: "));
2771 if (key_check_cap (key, KEY_CAP_CAN_ENCRYPT)) {
2772 fprintf (fp, "%s%s", delim, _("encryption"));
2775 if (key_check_cap (key, KEY_CAP_CAN_SIGN)) {
2776 fprintf (fp, "%s%s", delim, _("signing"));
2779 if (key_check_cap (key, KEY_CAP_CAN_CERTIFY)) {
2780 fprintf (fp, "%s%s", delim, _("certification"));
2786 s = key->subkeys->fpr;
2787 fputs (_("Fingerprint: "), fp);
2788 if (is_pgp && m_strlen(s) == 40) {
2789 for (i = 0; *s && s[1] && s[2] && s[3] && s[4]; s += 4, i++) {
2794 putc (is_pgp ? ' ' : ':', fp);
2795 if (is_pgp && i == 4)
2800 for (i = 0; *s && s[1] && s[2]; s += 2, i++) {
2803 putc (is_pgp ? ' ' : ':', fp);
2804 if (is_pgp && i == 7)
2808 fprintf (fp, "%s\n", s);
2811 if (key->issuer_serial) {
2812 s = key->issuer_serial;
2814 fprintf (fp, _("Serial-No .: 0x%s\n"), s);
2817 if (key->issuer_name) {
2818 s = key->issuer_name;
2820 fprintf (fp, _("Issued By .: "));
2821 parse_and_print_user_id (fp, s);
2826 /* For PGP we list all subkeys. */
2828 gpgme_subkey_t subkey = NULL;
2830 for (idx = 1, subkey = key->subkeys; subkey; idx++, subkey = subkey->next) {
2834 if (m_strlen(s) == 16)
2835 s += 8; /* display only the short keyID */
2836 fprintf (fp, _("Subkey ....: 0x%s"), s);
2837 if (subkey->revoked) {
2839 fputs (_("[Revoked]"), fp);
2841 if (subkey->invalid) {
2843 fputs (_("[Invalid]"), fp);
2845 if (subkey->expired) {
2847 fputs (_("[Expired]"), fp);
2849 if (subkey->disabled) {
2851 fputs (_("[Disabled]"), fp);
2855 if (subkey->timestamp > 0) {
2856 tt = subkey->timestamp;
2858 tm = localtime (&tt);
2859 #ifdef HAVE_LANGINFO_D_T_FMT
2860 strftime (shortbuf, sizeof shortbuf, nl_langinfo (D_T_FMT), tm);
2862 strftime (shortbuf, sizeof shortbuf, "%c", tm);
2864 fprintf (fp, _("Valid From : %s\n"), shortbuf);
2867 if (subkey->expires > 0) {
2868 tt = subkey->expires;
2870 tm = localtime (&tt);
2871 #ifdef HAVE_LANGINFO_D_T_FMT
2872 strftime (shortbuf, sizeof shortbuf, nl_langinfo (D_T_FMT), tm);
2874 strftime (shortbuf, sizeof shortbuf, "%c", tm);
2876 fprintf (fp, _("Valid To ..: %s\n"), shortbuf);
2880 s = gpgme_pubkey_algo_name (subkey->pubkey_algo);
2885 aval = subkey->length;
2889 fprintf (fp, _("Key Type ..: %s, %lu bit %s\n"), "PGP", aval, s);
2891 fprintf (fp, _("Key Usage .: "));
2894 if (subkey->can_encrypt) {
2895 fprintf (fp, "%s%s", delim, _("encryption"));
2898 if (subkey->can_sign) {
2899 fprintf (fp, "%s%s", delim, _("signing"));
2902 if (subkey->can_certify) {
2903 fprintf (fp, "%s%s", delim, _("certification"));
2911 setlocale (LC_TIME, "C");
2915 /* Show detailed information about the selected key */
2916 static void verify_key (crypt_key_t * key)
2919 char cmd[LONG_STRING], tempfile[_POSIX_PATH_MAX];
2921 gpgme_ctx_t listctx = NULL;
2923 gpgme_key_t k = NULL;
2926 fp = m_tempfile (tempfile, sizeof(tempfile), NONULL(Tempdir), NULL);
2928 mutt_perror (_("Can't create temporary file"));
2931 mutt_message _("Collecting data...");
2933 print_key_info (key->kobj, fp);
2935 err = gpgme_new (&listctx);
2937 fprintf (fp, "Internal error: can't create gpgme context: %s\n",
2938 gpgme_strerror (err));
2941 if ((key->flags & KEYFLAG_ISX509))
2942 gpgme_set_protocol (listctx, GPGME_PROTOCOL_CMS);
2946 while ((s = k->chain_id) && k->subkeys && m_strcmp(s, k->subkeys->fpr)) {
2948 err = gpgme_op_keylist_start (listctx, s, 0);
2949 gpgme_key_release (k);
2952 err = gpgme_op_keylist_next (listctx, &k);
2954 fprintf (fp, _("Error finding issuer key: %s\n"), gpgme_strerror (err));
2957 gpgme_op_keylist_end (listctx);
2959 print_key_info (k, fp);
2962 fputs (_("Error: certification chain to long - stopping here\n"), fp);
2968 gpgme_key_release (k);
2969 gpgme_release (listctx);
2971 mutt_clear_error ();
2972 snprintf (cmd, sizeof (cmd), _("Key ID: 0x%s"), crypt_keyid (key));
2973 mutt_do_pager (cmd, tempfile, 0, NULL);
2977 * Implementation of `findkeys'.
2981 /* Convert string_list_t into a pattern string suitable to be passed to GPGME.
2982 We need to convert spaces in an item into a '+' and '%' into
2984 static char *list_to_pattern (string_list_t * list)
2992 for (l = list; l; l = l->next) {
2993 for (s = l->data; *s; s++) {
2998 n++; /* delimiter or end of string */
3000 n++; /* make sure to allocate at least one byte */
3001 pattern = p = p_new(char, n);
3002 for (l = list; l; l = l->next) {
3007 for (s = l->data; *s; s++) {
3013 else if (*s == '+') {
3029 /* Return a list of keys which are candidates for the selection.
3030 Select by looking at the HINTS list. */
3031 static crypt_key_t *get_candidates (string_list_t * hints, unsigned int app,
3034 crypt_key_t *db, *k, **kend;
3040 gpgme_user_id_t uid = NULL;
3042 pattern = list_to_pattern (hints);
3046 err = gpgme_new (&ctx);
3048 mutt_error (_("gpgme_new failed: %s"), gpgme_strerror (err));
3056 if ((app & APPLICATION_PGP)) {
3057 /* Its all a mess. That old GPGME expects different things
3058 depending on the protocol. For gpg we don' t need percent
3059 escaped pappert but simple strings passed in an array to the
3060 keylist_ext_start function. */
3065 for (l = hints, n = 0; l; l = l->next) {
3066 if (l->data && *l->data)
3072 patarr = p_new(char *, n + 1);
3073 for (l = hints, n = 0; l; l = l->next) {
3074 if (l->data && *l->data)
3075 patarr[n++] = m_strdup(l->data);
3078 err = gpgme_op_keylist_ext_start (ctx, (const char **) patarr, secret, 0);
3079 for (n = 0; patarr[n]; n++)
3080 p_delete(&patarr[n]);
3083 mutt_error (_("gpgme_op_keylist_start failed: %s"), gpgme_strerror (err));
3084 gpgme_release (ctx);
3089 while (!(err = gpgme_op_keylist_next (ctx, &key))) {
3090 unsigned int flags = 0;
3092 if (key_check_cap (key, KEY_CAP_CAN_ENCRYPT))
3093 flags |= KEYFLAG_CANENCRYPT;
3094 if (key_check_cap (key, KEY_CAP_CAN_SIGN))
3095 flags |= KEYFLAG_CANSIGN;
3097 #if 0 /* DISABLED code */
3099 /* Bug in gpg. Capabilities are not listed for secret
3100 keys. Try to deduce them from the algorithm. */
3102 switch (key->subkeys[0].pubkey_algo) {
3104 flags |= KEYFLAG_CANENCRYPT;
3105 flags |= KEYFLAG_CANSIGN;
3107 case GPGME_PK_ELG_E:
3108 flags |= KEYFLAG_CANENCRYPT;
3111 flags |= KEYFLAG_CANSIGN;
3115 #endif /* DISABLED code */
3117 for (idx = 0, uid = key->uids; uid; idx++, uid = uid->next) {
3118 k = p_new(crypt_key_t, 1);
3127 if (gpg_err_code (err) != GPG_ERR_EOF)
3128 mutt_error (_("gpgme_op_keylist_next failed: %s"), gpgme_strerror (err));
3129 gpgme_op_keylist_end (ctx);
3134 if ((app & APPLICATION_SMIME)) {
3135 /* and now look for x509 certificates */
3136 gpgme_set_protocol (ctx, GPGME_PROTOCOL_CMS);
3137 err = gpgme_op_keylist_start (ctx, pattern, 0);
3139 mutt_error (_("gpgme_op_keylist_start failed: %s"), gpgme_strerror (err));
3140 gpgme_release (ctx);
3145 while (!(err = gpgme_op_keylist_next (ctx, &key))) {
3146 unsigned int flags = KEYFLAG_ISX509;
3148 if (key_check_cap (key, KEY_CAP_CAN_ENCRYPT))
3149 flags |= KEYFLAG_CANENCRYPT;
3150 if (key_check_cap (key, KEY_CAP_CAN_SIGN))
3151 flags |= KEYFLAG_CANSIGN;
3153 for (idx = 0, uid = key->uids; uid; idx++, uid = uid->next) {
3154 k = p_new(crypt_key_t, 1);
3163 if (gpg_err_code (err) != GPG_ERR_EOF)
3164 mutt_error (_("gpgme_op_keylist_next failed: %s"), gpgme_strerror (err));
3165 gpgme_op_keylist_end (ctx);
3168 gpgme_release (ctx);
3173 /* Add the string STR to the list HINTS. This list is later used to
3175 static string_list_t *crypt_add_string_to_hints (string_list_t * hints, const char *str)
3180 if ((scratch = m_strdup(str)) == NULL)
3183 for (t = strtok (scratch, " ,.:\"()<>\n"); t;
3184 t = strtok (NULL, " ,.:\"()<>\n")) {
3185 if (m_strlen(t) > 3)
3186 hints = mutt_add_list(hints, t);
3193 /* Display a menu to select a key from the array KEYS. FORCED_VALID
3194 will be set to true on return if the user did override the the
3196 static crypt_key_t *crypt_select_key (crypt_key_t * keys,
3197 address_t * p, const char *s,
3198 unsigned int app, int *forced_valid)
3201 crypt_key_t **key_table;
3204 char helpstr[SHORT_STRING], buf[LONG_STRING];
3206 int (*f) (const void *, const void *);
3207 int menu_to_use = 0;
3212 /* build the key table */
3215 for (k = keys; k; k = k->next) {
3216 if (!option (OPTPGPSHOWUNUSABLE) && (k->flags & KEYFLAG_CANTUSE)) {
3223 p_realloc(&key_table, keymax);
3229 if (!i && unusable) {
3230 mutt_error _("All matching keys are marked expired/revoked.");
3236 switch (PgpSortKeys & SORT_MASK) {
3238 f = crypt_compare_date;
3241 f = crypt_compare_keyid;
3244 f = crypt_compare_address;
3248 f = crypt_compare_trust;
3251 qsort (key_table, i, sizeof (crypt_key_t *), f);
3253 if (app & APPLICATION_PGP)
3254 menu_to_use = MENU_KEY_SELECT_PGP;
3255 else if (app & APPLICATION_SMIME)
3256 menu_to_use = MENU_KEY_SELECT_SMIME;
3259 mutt_make_help (buf, sizeof (buf), _("Exit "), menu_to_use, OP_EXIT);
3260 strcat (helpstr, buf); /* __STRCAT_CHECKED__ */
3261 mutt_make_help (buf, sizeof (buf), _("Select "), menu_to_use,
3262 OP_GENERIC_SELECT_ENTRY);
3263 strcat (helpstr, buf); /* __STRCAT_CHECKED__ */
3264 mutt_make_help (buf, sizeof (buf), _("Check key "),
3265 menu_to_use, OP_VERIFY_KEY);
3266 strcat (helpstr, buf); /* __STRCAT_CHECKED__ */
3267 mutt_make_help (buf, sizeof (buf), _("Help"), menu_to_use, OP_HELP);
3268 strcat (helpstr, buf); /* __STRCAT_CHECKED__ */
3270 menu = mutt_new_menu ();
3272 menu->make_entry = crypt_entry;
3273 menu->menu = menu_to_use;
3274 menu->help = helpstr;
3275 menu->data = key_table;
3280 if ((app & APPLICATION_PGP) && (app & APPLICATION_SMIME))
3281 ts = _("PGP and S/MIME keys matching");
3282 else if ((app & APPLICATION_PGP))
3283 ts = _("PGP keys matching");
3284 else if ((app & APPLICATION_SMIME))
3285 ts = _("S/MIME keys matching");
3287 ts = _("keys matching");
3290 snprintf (buf, sizeof (buf), _("%s <%s>."), ts, p->mailbox);
3292 snprintf (buf, sizeof (buf), _("%s \"%s\"."), ts, s);
3296 mutt_clear_error ();
3300 switch (mutt_menuLoop (menu)) {
3302 verify_key (key_table[menu->current]);
3303 menu->redraw = REDRAW_FULL;
3307 mutt_message ("%s", key_table[menu->current]->uid);
3310 case OP_GENERIC_SELECT_ENTRY:
3311 /* FIXME make error reporting more verbose - this should be
3312 easy because gpgme provides more information */
3313 if (option (OPTPGPCHECKTRUST)) {
3314 if (!crypt_key_is_valid (key_table[menu->current])) {
3315 mutt_error _("This key can't be used: "
3316 "expired/disabled/revoked.");
3321 if (option (OPTPGPCHECKTRUST) &&
3322 (!crypt_id_is_valid (key_table[menu->current])
3323 || !crypt_id_is_strong (key_table[menu->current]))) {
3325 char buff[LONG_STRING];
3327 if (key_table[menu->current]->flags & KEYFLAG_CANTUSE)
3328 s = N_("ID is expired/disabled/revoked.");
3330 gpgme_validity_t val = GPGME_VALIDITY_UNKNOWN;
3331 gpgme_user_id_t uid = NULL;
3336 uid = key_table[menu->current]->kobj->uids;
3337 for (j = 0; (j < key_table[menu->current]->idx) && uid;
3338 j++, uid = uid->next);
3340 val = uid->validity;
3343 case GPGME_VALIDITY_UNKNOWN:
3344 case GPGME_VALIDITY_UNDEFINED:
3345 warn_s = N_("ID has undefined validity.");
3347 case GPGME_VALIDITY_NEVER:
3348 warn_s = N_("ID is not valid.");
3350 case GPGME_VALIDITY_MARGINAL:
3351 warn_s = N_("ID is only marginally valid.");
3353 case GPGME_VALIDITY_FULL:
3354 case GPGME_VALIDITY_ULTIMATE:
3358 snprintf (buff, sizeof (buff),
3359 _("%s Do you really want to use the key?"), _(warn_s));
3361 if (mutt_yesorno (buff, 0) != 1) {
3362 mutt_clear_error ();
3369 k = crypt_copy_key (key_table[menu->current]);
3380 mutt_menuDestroy (&menu);
3381 p_delete(&key_table);
3383 set_option (OPTNEEDREDRAW);
3388 static crypt_key_t *crypt_getkeybyaddr (address_t * a, short abilities,
3389 unsigned int app, int *forced_valid)
3392 string_list_t *hints = NULL;
3397 int this_key_has_strong;
3398 int this_key_has_weak;
3399 int this_key_has_invalid;
3402 crypt_key_t *keys, *k;
3403 crypt_key_t *the_valid_key = NULL;
3404 crypt_key_t *matches = NULL;
3405 crypt_key_t **matches_endp = &matches;
3409 if (a && a->mailbox)
3410 hints = crypt_add_string_to_hints (hints, a->mailbox);
3411 if (a && a->personal)
3412 hints = crypt_add_string_to_hints (hints, a->personal);
3414 mutt_message (_("Looking for keys matching \"%s\"..."), a->mailbox);
3415 keys = get_candidates (hints, app, (abilities & KEYFLAG_CANSIGN));
3417 string_list_wipe(&hints);
3422 for (k = keys; k; k = k->next) {
3423 if (abilities && !(k->flags & abilities)) {
3427 this_key_has_weak = 0; /* weak but valid match */
3428 this_key_has_invalid = 0; /* invalid match */
3429 this_key_has_strong = 0; /* strong and valid match */
3430 match = 0; /* any match */
3432 r = rfc822_parse_adrlist (NULL, k->uid);
3433 for (p = r; p; p = p->next) {
3434 int validity = crypt_id_matches_addr (a, p, k);
3436 if (validity & CRYPT_KV_MATCH) /* something matches */
3439 /* is this key a strong candidate? */
3440 if ((validity & CRYPT_KV_VALID)
3441 && (validity & CRYPT_KV_STRONGID)
3442 && (validity & CRYPT_KV_ADDR)) {
3443 if (the_valid_key && the_valid_key != k)
3446 this_key_has_strong = 1;
3448 else if ((validity & CRYPT_KV_MATCH)
3449 && !(validity & CRYPT_KV_VALID))
3450 this_key_has_invalid = 1;
3451 else if ((validity & CRYPT_KV_MATCH)
3452 && (!(validity & CRYPT_KV_STRONGID)
3453 || !(validity & CRYPT_KV_ADDR)))
3454 this_key_has_weak = 1;
3456 address_list_wipe(&r);
3461 if (!this_key_has_strong && this_key_has_invalid)
3463 if (!this_key_has_strong && this_key_has_weak)
3466 *matches_endp = tmp = crypt_copy_key (k);
3467 matches_endp = &tmp->next;
3468 the_valid_key = tmp;
3472 crypt_free_key (&keys);
3475 if (the_valid_key && !multi && !weak
3476 && !(invalid && option (OPTPGPSHOWUNUSABLE))) {
3478 * There was precisely one strong match on a valid ID, there
3479 * were no valid keys with weak matches, and we aren't
3480 * interested in seeing invalid keys.
3482 * Proceed without asking the user.
3484 k = crypt_copy_key (the_valid_key);
3488 * Else: Ask the user.
3490 k = crypt_select_key (matches, a, NULL, app, forced_valid);
3492 crypt_free_key (&matches);
3501 static crypt_key_t *crypt_getkeybystr (const char *p, short abilities,
3502 unsigned int app, int *forced_valid)
3504 string_list_t *hints = NULL;
3506 crypt_key_t *matches = NULL;
3507 crypt_key_t **matches_endp = &matches;
3511 mutt_message (_("Looking for keys matching \"%s\"..."), p);
3515 hints = crypt_add_string_to_hints (hints, p);
3516 keys = get_candidates (hints, app, (abilities & KEYFLAG_CANSIGN));
3517 string_list_wipe(&hints);
3522 for (k = keys; k; k = k->next) {
3523 if (abilities && !(k->flags & abilities))
3528 if (!*p || !m_strcasecmp(p, crypt_keyid (k))
3529 || (!m_strncasecmp(p, "0x", 2)
3530 && !m_strcasecmp(p + 2, crypt_keyid (k)))
3531 || (option (OPTPGPLONGIDS)
3532 && !m_strncasecmp(p, "0x", 2)
3533 && !m_strcasecmp(p + 2, crypt_keyid (k) + 8))
3534 || m_stristr(k->uid, p)) {
3537 *matches_endp = tmp = crypt_copy_key (k);
3538 matches_endp = &tmp->next;
3542 crypt_free_key (&keys);
3545 k = crypt_select_key (matches, NULL, p, app, forced_valid);
3546 crypt_free_key (&matches);
3553 /* Display TAG as a prompt to ask for a key. If WHATFOR is not null
3554 use it as default and store it under that label as the next
3555 default. ABILITIES describe the required key abilities (sign,
3556 encrypt) and APP the type of the requested key; ether S/MIME or
3557 PGP. Return a copy of the key or NULL if not found. */
3558 static crypt_key_t *crypt_ask_for_key (char *tag,
3561 unsigned int app, int *forced_valid)
3564 char resp[SHORT_STRING];
3565 struct crypt_cache *l = NULL;
3569 forced_valid = &dummy;
3571 mutt_clear_error ();
3577 for (l = id_defaults; l; l = l->next)
3578 if (!m_strcasecmp(whatfor, l->what)) {
3579 m_strcpy(resp, sizeof(resp), NONULL(l->dflt));
3587 if (mutt_get_field (tag, resp, sizeof (resp), M_CLEAR) != 0)
3592 m_strreplace(&l->dflt, resp);
3594 l = p_new(struct crypt_cache, 1);
3595 l->next = id_defaults;
3597 l->what = m_strdup(whatfor);
3598 l->dflt = m_strdup(resp);
3602 if ((key = crypt_getkeybystr (resp, abilities, app, forced_valid)))
3610 /* This routine attempts to find the keyids of the recipients of a
3611 message. It returns NULL if any of the keys can not be found. */
3612 static char *find_keys (address_t * to, address_t * cc, address_t * bcc,
3615 char *keylist = NULL, *t;
3617 ssize_t keylist_size = 0;
3618 ssize_t keylist_used = 0;
3619 address_t *tmp = NULL, *addr = NULL;
3620 address_t **last = &tmp;
3623 crypt_key_t *k_info, *key;
3624 const char *fqdn = mutt_fqdn (1);
3627 *r_application = APPLICATION_PGP | APPLICATION_SMIME;
3630 for (i = 0; i < 3; i++) {
3645 *last = address_list_dup (p);
3647 last = &((*last)->next);
3651 rfc822_qualify (tmp, fqdn);
3653 address_list_uniq(tmp);
3655 for (p = tmp; p; p = p->next) {
3656 char buf[LONG_STRING];
3657 int forced_valid = 0;
3662 if ((keyID = mutt_crypt_hook (p)) != NULL) {
3665 snprintf (buf, sizeof (buf), _("Use keyID = \"%s\" for %s?"),
3667 if ((r = mutt_yesorno (buf, M_YES)) == M_YES) {
3668 /* check for e-mail address */
3669 if ((t = strchr (keyID, '@')) &&
3670 (addr = rfc822_parse_adrlist (NULL, keyID))) {
3672 rfc822_qualify (addr, fqdn);
3676 k_info = crypt_getkeybystr (keyID, KEYFLAG_CANENCRYPT,
3677 app, &forced_valid);
3682 address_list_wipe(&tmp);
3683 address_list_wipe(&addr);
3689 && (k_info = crypt_getkeybyaddr (q, KEYFLAG_CANENCRYPT,
3690 app, &forced_valid)) == NULL) {
3691 snprintf (buf, sizeof (buf), _("Enter keyID for %s: "), q->mailbox);
3693 if ((key = crypt_ask_for_key (buf, q->mailbox, KEYFLAG_CANENCRYPT,
3695 &forced_valid)) == NULL) {
3697 address_list_wipe(&tmp);
3698 address_list_wipe(&addr);
3706 const char *s = crypt_fpr (key);
3708 keylist_size += m_strlen(s) + 4 + 1;
3709 p_realloc(&keylist, keylist_size);
3710 sprintf (keylist + keylist_used, "%s0x%s%s", /* __SPRINTF_CHECKED__ */
3711 keylist_used ? " " : "", s, forced_valid ? "!" : "");
3713 keylist_used = m_strlen(keylist);
3715 crypt_free_key (&key);
3716 address_list_wipe(&addr);
3718 address_list_wipe(&tmp);
3722 char *pgp_gpgme_findkeys (address_t * to, address_t * cc, address_t * bcc)
3724 return find_keys (to, cc, bcc, APPLICATION_PGP);
3727 char *smime_gpgme_findkeys (address_t * to, address_t * cc, address_t * bcc)
3729 return find_keys (to, cc, bcc, APPLICATION_SMIME);
3733 * Implementation of `init'.
3736 /* Initialization. */
3737 static void init_gpgme (void)
3739 /* Make sure that gpg-agent is running. */
3740 if (!getenv ("GPG_AGENT_INFO")) {
3741 mutt_error ("\nUsing GPGME backend, although no gpg-agent is running");
3742 if (mutt_any_key_to_continue (NULL) == -1)
3747 void pgp_gpgme_init (void)
3752 void smime_gpgme_init (void)
3756 static int gpgme_send_menu (HEADER * msg, int *redraw, int is_smime)
3759 char input_signas[SHORT_STRING];
3762 if (msg->security & APPLICATION_PGP)
3764 else if (msg->security & APPLICATION_SMIME)
3769 mutt_multi_choice (_
3770 ("S/MIME (e)ncrypt, (s)ign, sign (a)s, (b)oth, (p)gp or (c)lear?"),
3774 mutt_multi_choice (_
3775 ("PGP (e)ncrypt, (s)ign, sign (a)s, (b)oth, s/(m)ime or (c)lear?"),
3779 case 1: /* (e)ncrypt */
3780 msg->security |= (is_smime ? SMIMEENCRYPT : PGPENCRYPT);
3781 msg->security &= ~(is_smime ? SMIMESIGN : PGPSIGN);
3784 case 2: /* (s)ign */
3785 msg->security |= (is_smime ? SMIMESIGN : PGPSIGN);
3786 msg->security &= ~(is_smime ? SMIMEENCRYPT : PGPENCRYPT);
3789 case 3: /* sign (a)s */
3790 /* unset_option(OPTCRYPTCHECKTRUST); */
3791 if ((p = crypt_ask_for_key (_("Sign as: "), NULL, KEYFLAG_CANSIGN,
3792 is_smime ? APPLICATION_SMIME :
3793 APPLICATION_PGP, NULL))) {
3794 snprintf (input_signas, sizeof (input_signas), "0x%s", crypt_keyid (p));
3795 m_strreplace(is_smime ? &SmimeDefaultKey : &PgpSignAs,
3797 crypt_free_key (&p);
3799 msg->security |= (is_smime ? SMIMESIGN : PGPSIGN);
3801 *redraw = REDRAW_FULL;
3804 case 4: /* (b)oth */
3806 (is_smime ? (SMIMEENCRYPT | SMIMESIGN) : (PGPENCRYPT | PGPSIGN));
3809 case 5: /* (p)gp or s/(m)ime */
3810 is_smime = !is_smime;
3813 case 6: /* (c)lear */
3818 if (choice == 6 || choice == 7);
3819 else if (is_smime) {
3820 msg->security &= ~APPLICATION_PGP;
3821 msg->security |= APPLICATION_SMIME;
3824 msg->security &= ~APPLICATION_SMIME;
3825 msg->security |= APPLICATION_PGP;
3828 return (msg->security);
3831 int pgp_gpgme_send_menu (HEADER * msg, int *redraw)
3833 return gpgme_send_menu (msg, redraw, 0);
3836 int smime_gpgme_send_menu (HEADER * msg, int *redraw)
3838 return gpgme_send_menu (msg, redraw, 1);
3841 static int verify_sender (HEADER * h, gpgme_protocol_t protocol __attribute__((unused)))
3843 address_t *sender = NULL;
3844 unsigned int ret = 1;
3847 h->env->from = mutt_expand_aliases (h->env->from);
3848 sender = h->env->from;
3850 else if (h->env->sender) {
3851 h->env->sender = mutt_expand_aliases (h->env->sender);
3852 sender = h->env->sender;
3856 if (signature_key) {
3857 gpgme_key_t key = signature_key;
3858 gpgme_user_id_t uid = NULL;
3859 int sender_length = 0;
3862 sender_length = m_strlen(sender->mailbox);
3863 for (uid = key->uids; uid && ret; uid = uid->next) {
3864 uid_length = m_strlen(uid->email);
3865 if (1 && (uid->email[0] == '<')
3866 && (uid->email[uid_length - 1] == '>')
3867 && (uid_length == sender_length + 2)
3868 && (!strncmp (uid->email + 1, sender->mailbox, sender_length)))
3873 mutt_any_key_to_continue ("Failed to verify sender");
3876 mutt_any_key_to_continue ("Failed to figure out sender");
3878 if (signature_key) {
3879 gpgme_key_release (signature_key);
3880 signature_key = NULL;
3886 int smime_gpgme_verify_sender (HEADER * h)
3888 return verify_sender (h, GPGME_PROTOCOL_CMS);