2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2012 the Claws Mail team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "claws-features.h"
29 #include <glib/gi18n.h>
40 #include <plugins/pgpcore/sgpgme.h>
41 #include <plugins/pgpcore/prefs_gpg.h>
42 #include <plugins/pgpcore/passphrase.h>
44 #include "prefs_common.h"
46 typedef struct _PrivacyDataPGP PrivacyDataPGP;
48 struct _PrivacyDataPGP
52 gboolean done_sigtest;
54 gpgme_verify_result_t sigstatus;
58 static PrivacySystem pgpmime_system;
60 static gint pgpmime_check_signature(MimeInfo *mimeinfo);
62 static PrivacyDataPGP *pgpmime_new_privacydata()
67 data = g_new0(PrivacyDataPGP, 1);
68 data->data.system = &pgpmime_system;
69 data->done_sigtest = FALSE;
70 data->is_signed = FALSE;
71 data->sigstatus = NULL;
72 if ((err = gpgme_new(&data->ctx)) != GPG_ERR_NO_ERROR) {
73 g_warning(_("Couldn't initialize GPG context, %s"), gpgme_strerror(err));
80 static void pgpmime_free_privacydata(PrivacyData *_data)
82 PrivacyDataPGP *data = (PrivacyDataPGP *) _data;
83 gpgme_release(data->ctx);
87 static gboolean pgpmime_is_signed(MimeInfo *mimeinfo)
91 const gchar *protocol;
92 PrivacyDataPGP *data = NULL;
94 cm_return_val_if_fail(mimeinfo != NULL, FALSE);
95 if (mimeinfo->privacy != NULL) {
96 data = (PrivacyDataPGP *) mimeinfo->privacy;
97 if (data->done_sigtest)
98 return data->is_signed;
102 parent = procmime_mimeinfo_parent(mimeinfo);
105 if ((parent->type != MIMETYPE_MULTIPART) ||
106 g_ascii_strcasecmp(parent->subtype, "signed"))
108 protocol = procmime_mimeinfo_get_parameter(parent, "protocol");
109 if ((protocol == NULL) ||
110 (g_ascii_strcasecmp(protocol, "application/pgp-signature")))
113 /* check if mimeinfo is the first child */
114 if (parent->node->children->data != mimeinfo)
117 /* check signature */
118 signature = parent->node->children->next != NULL ?
119 (MimeInfo *) parent->node->children->next->data : NULL;
120 if (signature == NULL)
122 if ((signature->type != MIMETYPE_APPLICATION) ||
123 (g_ascii_strcasecmp(signature->subtype, "pgp-signature")))
127 data = pgpmime_new_privacydata();
128 mimeinfo->privacy = (PrivacyData *) data;
131 data->done_sigtest = TRUE;
132 data->is_signed = TRUE;
137 static gchar *get_canonical_content(FILE *fp, const gchar *boundary)
144 boundary_len = strlen(boundary);
145 while (fgets(buf, sizeof(buf), fp) != NULL)
146 if (IS_BOUNDARY(buf, boundary, boundary_len))
149 textbuffer = g_string_new("");
150 while (fgets(buf, sizeof(buf), fp) != NULL) {
153 if (IS_BOUNDARY(buf, boundary, boundary_len))
156 buf2 = canonicalize_str(buf);
157 g_string_append(textbuffer, buf2);
160 g_string_truncate(textbuffer, textbuffer->len - 2);
162 ret = textbuffer->str;
163 g_string_free(textbuffer, FALSE);
168 static gint pgpmime_check_signature(MimeInfo *mimeinfo)
170 PrivacyDataPGP *data;
171 MimeInfo *parent, *signature;
175 gpgme_data_t sigdata = NULL, textdata = NULL;
177 cm_return_val_if_fail(mimeinfo != NULL, -1);
178 cm_return_val_if_fail(mimeinfo->privacy != NULL, -1);
179 data = (PrivacyDataPGP *) mimeinfo->privacy;
180 if ((err = gpgme_new(&data->ctx)) != GPG_ERR_NO_ERROR) {
181 debug_print(("Couldn't initialize GPG context, %s"), gpgme_strerror(err));
182 privacy_set_error(_("Couldn't initialize GPG context, %s"), gpgme_strerror(err));
187 debug_print("Checking PGP/MIME signature\n");
189 err = gpgme_set_protocol(data->ctx, GPGME_PROTOCOL_OpenPGP);
192 debug_print ("gpgme_set_protocol failed: %s\n",
193 gpgme_strerror (err));
195 parent = procmime_mimeinfo_parent(mimeinfo);
197 fp = g_fopen(parent->data.filename, "rb");
198 cm_return_val_if_fail(fp != NULL, SIGNATURE_INVALID);
200 boundary = g_hash_table_lookup(parent->typeparameters, "boundary");
202 privacy_set_error(_("Signature boundary not found."));
206 textstr = get_canonical_content(fp, boundary);
208 err = gpgme_data_new_from_mem(&textdata, textstr, (size_t)strlen(textstr), 0);
210 debug_print ("gpgme_data_new_from_mem failed: %s\n",
211 gpgme_strerror (err));
213 signature = (MimeInfo *) mimeinfo->node->next->data;
214 sigdata = sgpgme_data_from_mimeinfo(signature);
217 if (signature->encoding_type == ENC_BASE64) {
218 err = gpgme_data_set_encoding (sigdata, GPGME_DATA_ENCODING_BASE64);
222 debug_print ("gpgme_data_set_encoding failed: %s\n",
223 gpgme_strerror (err));
227 sgpgme_verify_signature (data->ctx, sigdata, textdata, NULL);
229 gpgme_data_release(sigdata);
230 gpgme_data_release(textdata);
237 static SignatureStatus pgpmime_get_sig_status(MimeInfo *mimeinfo)
239 PrivacyDataPGP *data = (PrivacyDataPGP *) mimeinfo->privacy;
241 cm_return_val_if_fail(data != NULL, SIGNATURE_INVALID);
243 if (data->sigstatus == NULL &&
244 prefs_gpg_get_config()->auto_check_signatures)
245 pgpmime_check_signature(mimeinfo);
247 return sgpgme_sigstat_gpgme_to_privacy(data->ctx, data->sigstatus);
250 static gchar *pgpmime_get_sig_info_short(MimeInfo *mimeinfo)
252 PrivacyDataPGP *data = (PrivacyDataPGP *) mimeinfo->privacy;
254 cm_return_val_if_fail(data != NULL, g_strdup("Error"));
256 if (data->sigstatus == NULL &&
257 prefs_gpg_get_config()->auto_check_signatures)
258 pgpmime_check_signature(mimeinfo);
260 return sgpgme_sigstat_info_short(data->ctx, data->sigstatus);
263 static gchar *pgpmime_get_sig_info_full(MimeInfo *mimeinfo)
265 PrivacyDataPGP *data = (PrivacyDataPGP *) mimeinfo->privacy;
267 cm_return_val_if_fail(data != NULL, g_strdup("Error"));
269 if (data->sigstatus == NULL &&
270 prefs_gpg_get_config()->auto_check_signatures)
271 pgpmime_check_signature(mimeinfo);
273 return sgpgme_sigstat_info_full(data->ctx, data->sigstatus);
276 static gboolean pgpmime_is_encrypted(MimeInfo *mimeinfo)
281 if (mimeinfo->type != MIMETYPE_MULTIPART)
283 if (g_ascii_strcasecmp(mimeinfo->subtype, "encrypted"))
285 tmpstr = procmime_mimeinfo_get_parameter(mimeinfo, "protocol");
286 if ((tmpstr == NULL) || g_ascii_strcasecmp(tmpstr, "application/pgp-encrypted"))
288 if (g_node_n_children(mimeinfo->node) != 2)
291 tmpinfo = (MimeInfo *) g_node_nth_child(mimeinfo->node, 0)->data;
292 if (tmpinfo->type != MIMETYPE_APPLICATION)
294 if (g_ascii_strcasecmp(tmpinfo->subtype, "pgp-encrypted"))
297 tmpinfo = (MimeInfo *) g_node_nth_child(mimeinfo->node, 1)->data;
298 if (tmpinfo->type != MIMETYPE_APPLICATION)
300 if (g_ascii_strcasecmp(tmpinfo->subtype, "octet-stream"))
306 static MimeInfo *pgpmime_decrypt(MimeInfo *mimeinfo)
308 MimeInfo *encinfo, *decinfo, *parseinfo;
309 gpgme_data_t cipher = NULL, plain = NULL;
313 gpgme_verify_result_t sigstat = NULL;
314 PrivacyDataPGP *data = NULL;
320 if ((err = gpgme_new(&ctx)) != GPG_ERR_NO_ERROR) {
321 debug_print(("Couldn't initialize GPG context, %s"), gpgme_strerror(err));
322 privacy_set_error(_("Couldn't initialize GPG context, %s"), gpgme_strerror(err));
326 cm_return_val_if_fail(pgpmime_is_encrypted(mimeinfo), NULL);
328 encinfo = (MimeInfo *) g_node_nth_child(mimeinfo->node, 1)->data;
330 cipher = sgpgme_data_from_mimeinfo(encinfo);
331 plain = sgpgme_decrypt_verify(cipher, &sigstat, ctx);
333 gpgme_data_release(cipher);
335 debug_print("plain is null!\n");
340 fname = g_strdup_printf("%s%cplaintext.%08x",
341 get_mime_tmp_dir(), G_DIR_SEPARATOR, ++id);
343 if ((dstfp = g_fopen(fname, "wb")) == NULL) {
344 FILE_OP_ERROR(fname, "fopen");
345 privacy_set_error(_("Couldn't open decrypted file %s"), fname);
347 gpgme_data_release(plain);
349 debug_print("can't open!\n");
353 if (fprintf(dstfp, "MIME-Version: 1.0\n") < 0) {
354 FILE_OP_ERROR(fname, "fprintf");
356 privacy_set_error(_("Couldn't write to decrypted file %s"), fname);
358 gpgme_data_release(plain);
360 debug_print("can't open!\n");
364 chars = sgpgme_data_release_and_get_mem(plain, &len);
366 if (fwrite(chars, 1, len, dstfp) < len) {
367 FILE_OP_ERROR(fname, "fwrite");
370 privacy_set_error(_("Couldn't write to decrypted file %s"), fname);
372 gpgme_data_release(plain);
374 debug_print("can't open!\n");
380 if (fclose(dstfp) == EOF) {
381 FILE_OP_ERROR(fname, "fclose");
382 privacy_set_error(_("Couldn't close decrypted file %s"), fname);
384 gpgme_data_release(plain);
386 debug_print("can't open!\n");
390 parseinfo = procmime_scan_file(fname);
392 if (parseinfo == NULL) {
394 privacy_set_error(_("Couldn't parse decrypted file."));
397 decinfo = g_node_first_child(parseinfo->node) != NULL ?
398 g_node_first_child(parseinfo->node)->data : NULL;
399 if (decinfo == NULL) {
400 privacy_set_error(_("Couldn't parse decrypted file parts."));
405 g_node_unlink(decinfo->node);
406 procmime_mimeinfo_free_all(parseinfo);
410 if (sigstat != NULL && sigstat->signatures != NULL) {
411 if (decinfo->privacy != NULL) {
412 data = (PrivacyDataPGP *) decinfo->privacy;
414 data = pgpmime_new_privacydata();
415 decinfo->privacy = (PrivacyData *) data;
417 data->done_sigtest = TRUE;
418 data->is_signed = TRUE;
419 data->sigstatus = sigstat;
421 gpgme_release(data->ctx);
429 gboolean pgpmime_sign(MimeInfo *mimeinfo, PrefsAccount *account, const gchar *from_addr)
431 MimeInfo *msgcontent, *sigmultipart, *newinfo;
432 gchar *textstr, *micalg = NULL;
434 gchar *boundary = NULL;
437 gpgme_data_t gpgtext, gpgsig;
440 struct passphrase_cb_info_s info;
441 gpgme_sign_result_t result = NULL;
446 privacy_set_error(_("Couldn't create temporary file: %s"), strerror(errno));
449 procmime_write_mimeinfo(mimeinfo, fp);
452 /* read temporary file into memory */
453 test_msg = file_read_stream_to_str(fp);
456 memset (&info, 0, sizeof info);
458 /* remove content node from message */
459 msgcontent = (MimeInfo *) mimeinfo->node->children->data;
460 g_node_unlink(msgcontent->node);
462 /* create temporary multipart for content */
463 sigmultipart = procmime_mimeinfo_new();
464 sigmultipart->type = MIMETYPE_MULTIPART;
465 sigmultipart->subtype = g_strdup("signed");
469 boundary = generate_mime_boundary("Sig");
470 } while (strstr(test_msg, boundary) != NULL);
474 g_hash_table_insert(sigmultipart->typeparameters, g_strdup("boundary"),
476 g_hash_table_insert(sigmultipart->typeparameters, g_strdup("protocol"),
477 g_strdup("application/pgp-signature"));
478 g_node_append(sigmultipart->node, msgcontent->node);
479 g_node_append(mimeinfo->node, sigmultipart->node);
481 /* write message content to temporary file */
484 perror("my_tmpfile");
485 privacy_set_error(_("Couldn't create temporary file: %s"), strerror(errno));
488 procmime_write_mimeinfo(sigmultipart, fp);
491 /* read temporary file into memory */
492 textstr = get_canonical_content(fp, boundary);
496 gpgme_data_new_from_mem(&gpgtext, textstr, (size_t)strlen(textstr), 0);
497 gpgme_data_new(&gpgsig);
498 if ((err = gpgme_new(&ctx)) != GPG_ERR_NO_ERROR) {
499 debug_print(("Couldn't initialize GPG context, %s"), gpgme_strerror(err));
500 privacy_set_error(_("Couldn't initialize GPG context, %s"), gpgme_strerror(err));
503 gpgme_set_textmode(ctx, 1);
504 gpgme_set_armor(ctx, 1);
505 gpgme_signers_clear (ctx);
507 if (!sgpgme_setup_signers(ctx, account, from_addr)) {
512 prefs_gpg_enable_agent(prefs_gpg_get_config()->use_gpg_agent);
513 if (getenv("GPG_AGENT_INFO") && prefs_gpg_get_config()->use_gpg_agent) {
514 debug_print("GPG_AGENT_INFO environment defined, running without passphrase callback\n");
517 gpgme_set_passphrase_cb (ctx, gpgmegtk_passphrase_cb, &info);
520 err = gpgme_op_sign(ctx, gpgtext, gpgsig, GPGME_SIG_MODE_DETACH);
521 if (err != GPG_ERR_NO_ERROR) {
522 if (err == GPG_ERR_CANCELED) {
523 /* ignore cancelled signing */
524 privacy_reset_error();
525 debug_print("gpgme_op_sign cancelled\n");
527 privacy_set_error(_("Data signing failed, %s"), gpgme_strerror(err));
528 debug_print("gpgme_op_sign error : %x\n", err);
533 result = gpgme_op_sign_result(ctx);
534 if (result && result->signatures) {
535 gpgme_new_signature_t sig = result->signatures;
536 if (gpgme_get_protocol(ctx) == GPGME_PROTOCOL_OpenPGP) {
537 micalg = g_strdup_printf("PGP-%s", gpgme_hash_algo_name(
538 result->signatures->hash_algo));
540 micalg = g_strdup(gpgme_hash_algo_name(
541 result->signatures->hash_algo));
544 debug_print("valid signature: %s\n", sig->fpr);
547 } else if (result && result->invalid_signers) {
548 gpgme_invalid_key_t invalid = result->invalid_signers;
550 g_warning("invalid signer: %s (%s)", invalid->fpr,
551 gpgme_strerror(invalid->reason));
552 privacy_set_error(_("Data signing failed due to invalid signer: %s"),
553 gpgme_strerror(invalid->reason));
554 invalid = invalid->next;
559 /* can't get result (maybe no signing key?) */
560 debug_print("gpgme_op_sign_result error\n");
561 privacy_set_error(_("Data signing failed, no results."));
566 sigcontent = sgpgme_data_release_and_get_mem(gpgsig, &len);
567 gpgme_data_release(gpgtext);
570 if (sigcontent == NULL || len <= 0) {
571 g_warning("sgpgme_data_release_and_get_mem failed");
572 privacy_set_error(_("Data signing failed, no contents."));
578 g_hash_table_insert(sigmultipart->typeparameters, g_strdup("micalg"),
581 newinfo = procmime_mimeinfo_new();
582 newinfo->type = MIMETYPE_APPLICATION;
583 newinfo->subtype = g_strdup("pgp-signature");
584 g_hash_table_insert(newinfo->typeparameters, g_strdup("name"),
585 g_strdup("signature.asc"));
586 newinfo->content = MIMECONTENT_MEM;
587 newinfo->disposition = DISPOSITIONTYPE_ATTACHMENT;
588 g_hash_table_insert(newinfo->dispositionparameters, g_strdup("filename"),
589 g_strdup("signature.asc"));
590 newinfo->data.mem = g_malloc(len + 1);
591 g_memmove(newinfo->data.mem, sigcontent, len);
592 newinfo->data.mem[len] = '\0';
593 g_node_append(sigmultipart->node, newinfo->node);
600 gchar *pgpmime_get_encrypt_data(GSList *recp_names)
602 return sgpgme_get_encrypt_data(recp_names, GPGME_PROTOCOL_OpenPGP);
605 static const gchar *pgpmime_get_encrypt_warning(void)
607 if (prefs_gpg_should_skip_encryption_warning(pgpmime_system.id))
610 return _("Please note that email headers, like Subject, "
611 "are not encrypted by the PGP/Mime system.");
614 static void pgpmime_inhibit_encrypt_warning(gboolean inhibit)
617 prefs_gpg_add_skip_encryption_warning(pgpmime_system.id);
619 prefs_gpg_remove_skip_encryption_warning(pgpmime_system.id);
622 gboolean pgpmime_encrypt(MimeInfo *mimeinfo, const gchar *encrypt_data)
624 MimeInfo *msgcontent, *encmultipart, *newinfo;
626 gchar *boundary, *enccontent;
629 gpgme_data_t gpgtext = NULL, gpgenc = NULL;
630 gpgme_ctx_t ctx = NULL;
631 gpgme_key_t *kset = NULL;
632 gchar **fprs = g_strsplit(encrypt_data, " ", -1);
636 while (fprs[i] && strlen(fprs[i])) {
640 kset = g_malloc(sizeof(gpgme_key_t)*(i+1));
641 memset(kset, 0, sizeof(gpgme_key_t)*(i+1));
642 if ((err = gpgme_new(&ctx)) != GPG_ERR_NO_ERROR) {
643 debug_print(("Couldn't initialize GPG context, %s"), gpgme_strerror(err));
644 privacy_set_error(_("Couldn't initialize GPG context, %s"), gpgme_strerror(err));
649 while (fprs[i] && strlen(fprs[i])) {
651 err = gpgme_get_key(ctx, fprs[i], &key, 0);
653 debug_print("can't add key '%s'[%d] (%s)\n", fprs[i],i, gpgme_strerror(err));
654 privacy_set_error(_("Couldn't add GPG key %s, %s"), fprs[i], gpgme_strerror(err));
658 debug_print("found %s at %d\n", fprs[i], i);
663 debug_print("Encrypting message content\n");
665 /* remove content node from message */
666 msgcontent = (MimeInfo *) mimeinfo->node->children->data;
667 g_node_unlink(msgcontent->node);
669 /* create temporary multipart for content */
670 encmultipart = procmime_mimeinfo_new();
671 encmultipart->type = MIMETYPE_MULTIPART;
672 encmultipart->subtype = g_strdup("encrypted");
673 boundary = generate_mime_boundary("Encrypt");
674 g_hash_table_insert(encmultipart->typeparameters, g_strdup("boundary"),
676 g_hash_table_insert(encmultipart->typeparameters, g_strdup("protocol"),
677 g_strdup("application/pgp-encrypted"));
678 g_node_append(encmultipart->node, msgcontent->node);
680 /* write message content to temporary file */
683 privacy_set_error(_("Couldn't create temporary file, %s"), strerror(errno));
687 procmime_write_mimeinfo(encmultipart, fp);
690 /* read temporary file into memory */
691 textstr = get_canonical_content(fp, boundary);
696 gpgme_data_new_from_mem(&gpgtext, textstr, (size_t)strlen(textstr), 0);
697 gpgme_data_new(&gpgenc);
698 gpgme_set_armor(ctx, 1);
699 cm_gpgme_data_rewind(gpgtext);
701 err = gpgme_op_encrypt(ctx, kset, GPGME_ENCRYPT_ALWAYS_TRUST, gpgtext, gpgenc);
703 enccontent = sgpgme_data_release_and_get_mem(gpgenc, &len);
704 gpgme_data_release(gpgtext);
708 if (enccontent == NULL || len <= 0) {
709 g_warning("sgpgme_data_release_and_get_mem failed");
710 privacy_set_error(_("Encryption failed, %s"), gpgme_strerror(err));
715 /* create encrypted multipart */
716 g_node_unlink(msgcontent->node);
717 procmime_mimeinfo_free_all(msgcontent);
718 g_node_append(mimeinfo->node, encmultipart->node);
720 newinfo = procmime_mimeinfo_new();
721 newinfo->type = MIMETYPE_APPLICATION;
722 newinfo->subtype = g_strdup("pgp-encrypted");
723 newinfo->content = MIMECONTENT_MEM;
724 newinfo->data.mem = g_strdup("Version: 1\n");
725 g_node_append(encmultipart->node, newinfo->node);
727 newinfo = procmime_mimeinfo_new();
728 newinfo->type = MIMETYPE_APPLICATION;
729 newinfo->subtype = g_strdup("octet-stream");
730 newinfo->content = MIMECONTENT_MEM;
731 newinfo->data.mem = g_malloc(len + 1);
732 g_memmove(newinfo->data.mem, enccontent, len);
733 newinfo->data.mem[len] = '\0';
734 g_node_append(encmultipart->node, newinfo->node);
742 static PrivacySystem pgpmime_system = {
744 "PGP MIME", /* name */
746 pgpmime_free_privacydata, /* free_privacydata */
748 pgpmime_is_signed, /* is_signed(MimeInfo *) */
749 pgpmime_check_signature, /* check_signature(MimeInfo *) */
750 pgpmime_get_sig_status, /* get_sig_status(MimeInfo *) */
751 pgpmime_get_sig_info_short, /* get_sig_info_short(MimeInfo *) */
752 pgpmime_get_sig_info_full, /* get_sig_info_full(MimeInfo *) */
754 pgpmime_is_encrypted, /* is_encrypted(MimeInfo *) */
755 pgpmime_decrypt, /* decrypt(MimeInfo *) */
761 pgpmime_get_encrypt_data,
763 pgpmime_get_encrypt_warning,
764 pgpmime_inhibit_encrypt_warning,
769 privacy_register_system(&pgpmime_system);
774 privacy_unregister_system(&pgpmime_system);
777 struct PluginFeature *plugin_provides(void)
779 static struct PluginFeature features[] =
780 { {PLUGIN_PRIVACY, N_("PGP/Mime")},
781 {PLUGIN_NOTHING, NULL}};
784 #endif /* USE_GPGME */