NeoMutt  2025-12-11-1009-ga75d9e
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
application_handler()

Manage the MIME type "application/pgp" or "application/smime". More...

Collaboration diagram for application_handler():

Functions

int pgp_gpgme_application_handler (struct Body *b, struct State *state)
 Manage the MIME type "application/pgp" or "application/smime" - Implements CryptModuleSpecs::application_handler() -.
int smime_gpgme_application_handler (struct Body *b, struct State *state)
 Manage the MIME type "application/pgp" or "application/smime" - Implements CryptModuleSpecs::application_handler() -.
int pgp_class_application_handler (struct Body *b, struct State *state)
 Manage the MIME type "application/pgp" or "application/smime" - Implements CryptModuleSpecs::application_handler() -.
int smime_class_application_handler (struct Body *b, struct State *state)
 Manage the MIME type "application/pgp" or "application/smime" - Implements CryptModuleSpecs::application_handler() -.

Detailed Description

Manage the MIME type "application/pgp" or "application/smime".

Parameters
bBody of the email
stateState of text being processed
Return values
0Success
-1Error

Function Documentation

◆ pgp_gpgme_application_handler()

int pgp_gpgme_application_handler ( struct Body * b,
struct State * state )

Manage the MIME type "application/pgp" or "application/smime" - Implements CryptModuleSpecs::application_handler() -.

Definition at line 2483 of file crypt_gpgme.c.

2484{
2485 int needpass = -1;
2486 bool pgp_keyblock = false;
2487 bool clearsign = false;
2488 long bytes;
2489 LOFF_T last_pos;
2490 LOFF_T block_begin;
2491 LOFF_T block_end;
2492 char buf[8192] = { 0 };
2493 FILE *fp_out = NULL;
2494
2495 gpgme_error_t err = GPG_ERR_NO_ERROR;
2496 gpgme_data_t armored_data = NULL;
2497
2498 bool maybe_goodsig = true;
2499 bool have_any_sigs = false;
2500
2501 char body_charset[256] = { 0 }; /* Only used for clearsigned messages. */
2502 char *gpgcharset = NULL;
2503
2504 mutt_debug(LL_DEBUG2, "Entering handler\n");
2505
2506 /* For clearsigned messages we won't be able to get a character set
2507 * but we know that this may only be text thus we assume Latin-1 here. */
2508 if (!mutt_body_get_charset(b, body_charset, sizeof(body_charset)))
2509 mutt_str_copy(body_charset, "iso-8859-1", sizeof(body_charset));
2510
2511 if (!mutt_file_seek(state->fp_in, b->offset, SEEK_SET))
2512 {
2513 return -1;
2514 }
2515 last_pos = b->offset;
2516
2517 for (bytes = b->length; bytes > 0;)
2518 {
2519 // record before the fgets in case it is a BEGIN block
2520 block_begin = last_pos;
2521
2522 if (!fgets(buf, sizeof(buf), state->fp_in))
2523 break;
2524
2525 LOFF_T offset = ftello(state->fp_in);
2526 if (offset < 0)
2527 {
2528 mutt_debug(LL_DEBUG1, "ftello() failed on fd %d\n", fileno(state->fp_in));
2529 offset = 0;
2530 }
2531 bytes -= (offset - last_pos); /* don't rely on mutt_str_len(buf) */
2532 last_pos = offset;
2533
2534 size_t plen = mutt_str_startswith(buf, "-----BEGIN PGP ");
2535 if (plen != 0)
2536 {
2537 needpass = 0;
2538 clearsign = false;
2539 pgp_keyblock = false;
2540
2541 if (MESSAGE(buf + plen))
2542 {
2543 needpass = 1;
2544 }
2545 else if (SIGNED_MESSAGE(buf + plen))
2546 {
2547 clearsign = true;
2548 }
2549 else if (PUBLIC_KEY_BLOCK(buf + plen))
2550 {
2551 pgp_keyblock = true;
2552 }
2553 else
2554 {
2555 /* XXX we may wish to recode here */
2556 if (state->prefix)
2557 state_puts(state, state->prefix);
2558 state_puts(state, buf);
2559 continue;
2560 }
2561
2562 /* Find the end of armored block. */
2563 while ((bytes > 0) && (fgets(buf, sizeof(buf) - 1, state->fp_in) != NULL))
2564 {
2565 offset = ftello(state->fp_in);
2566 if (offset < 0)
2567 {
2568 mutt_debug(LL_DEBUG1, "ftello() failed on fd %d\n", fileno(state->fp_in));
2569 offset = 0;
2570 }
2571 bytes -= (offset - last_pos); /* don't rely on mutt_strlen(buf) */
2572 last_pos = offset;
2573
2574 if (needpass && mutt_str_equal("-----END PGP MESSAGE-----\n", buf))
2575 {
2576 break;
2577 }
2578
2579 if (!needpass && (mutt_str_equal("-----END PGP SIGNATURE-----\n", buf) ||
2580 mutt_str_equal("-----END PGP PUBLIC KEY BLOCK-----\n", buf)))
2581 {
2582 break;
2583 }
2584
2585 // remember optional Charset: armor header as defined by rfc4880
2586 if (mutt_strn_equal("Charset: ", buf, 9))
2587 {
2588 size_t l = 0;
2589 FREE(&gpgcharset);
2590 gpgcharset = mutt_str_dup(buf + 9);
2591 if ((l = mutt_str_len(gpgcharset)) > 0 && gpgcharset[l - 1] == '\n')
2592 gpgcharset[l - 1] = 0;
2593 if (!mutt_ch_check_charset(gpgcharset, 0))
2594 mutt_str_replace(&gpgcharset, "UTF-8");
2595 }
2596 }
2597 block_end = ftello(state->fp_in);
2598 if (block_end < 0)
2599 {
2600 mutt_debug(LL_DEBUG1, "ftello() failed on fd %d\n", fileno(state->fp_in));
2601 block_end = 0;
2602 }
2603
2604 have_any_sigs = (have_any_sigs || (clearsign && (state->flags & STATE_VERIFY)));
2605
2606 /* Copy PGP material to an data container */
2607 armored_data = file_to_data_object(state->fp_in, block_begin, block_end - block_begin);
2608 fseeko(state->fp_in, block_end, 0);
2609
2610 /* Invoke PGP if needed */
2611 if (pgp_keyblock)
2612 {
2613 pgp_gpgme_extract_keys(armored_data, &fp_out);
2614 }
2615 else if (!clearsign || (state->flags & STATE_VERIFY))
2616 {
2617 gpgme_data_t plaintext = create_gpgme_data();
2618 gpgme_ctx_t ctx = create_gpgme_context(false);
2619
2620 if (clearsign)
2621 {
2622 err = gpgme_op_verify(ctx, armored_data, NULL, plaintext);
2623 }
2624 else
2625 {
2626 err = gpgme_op_decrypt_verify(ctx, armored_data, plaintext);
2627 if (gpg_err_code(err) == GPG_ERR_NO_DATA)
2628 {
2629 /* Decrypt verify can't handle signed only messages. */
2630 gpgme_data_seek(armored_data, 0, SEEK_SET);
2631 /* Must release plaintext so that we supply an uninitialized object. */
2632 gpgme_data_release(plaintext);
2633 plaintext = create_gpgme_data();
2634 err = gpgme_op_verify(ctx, armored_data, NULL, plaintext);
2635 }
2636 }
2637 redraw_if_needed(ctx);
2638
2639 gpgme_decrypt_result_t result = gpgme_op_decrypt_result(ctx);
2640 if (result && (state->flags & STATE_DISPLAY))
2641 show_encryption_info(state, result);
2642
2643 if (err != GPG_ERR_NO_ERROR)
2644 {
2645 char errbuf[200] = { 0 };
2646
2647 snprintf(errbuf, sizeof(errbuf) - 1,
2648 _("Error: decryption/verification failed: %s\n"), gpgme_strerror(err));
2649 state_puts(state, errbuf);
2650 }
2651 else
2652 {
2653 /* Decryption/Verification succeeded */
2654
2655 mutt_message(_("PGP message successfully decrypted"));
2656
2657 bool sig_stat = false;
2658 char *tmpfname = NULL;
2659
2660 /* Check whether signatures have been verified. */
2661 gpgme_verify_result_t verify_result = gpgme_op_verify_result(ctx);
2662 if (verify_result->signatures)
2663 sig_stat = true;
2664
2665 have_any_sigs = false;
2666 maybe_goodsig = false;
2667 if ((state->flags & STATE_DISPLAY) && sig_stat)
2668 {
2669 int res;
2670 int idx;
2671 bool anybad = false;
2672
2673 state_attach_puts(state, _("[-- Begin signature information --]\n"));
2674 have_any_sigs = true;
2675 for (idx = 0; (res = show_one_sig_status(ctx, idx, state)) != -1; idx++)
2676 {
2677 if (res == 1)
2678 anybad = true;
2679 }
2680 if (!anybad && idx)
2681 maybe_goodsig = true;
2682
2683 state_attach_puts(state, _("[-- End signature information --]\n\n"));
2684 }
2685
2686 tmpfname = data_object_to_tempfile(plaintext, &fp_out);
2687 if (tmpfname)
2688 {
2689 unlink(tmpfname);
2690 FREE(&tmpfname);
2691 }
2692 else
2693 {
2694 mutt_file_fclose(&fp_out);
2695 state_puts(state, _("Error: copy data failed\n"));
2696 }
2697 }
2698 gpgme_data_release(plaintext);
2699 gpgme_release(ctx);
2700 }
2701
2702 /* Now, copy cleartext to the screen. NOTE - we expect that PGP
2703 * outputs utf-8 cleartext. This may not always be true, but it
2704 * seems to be a reasonable guess. */
2705 if (state->flags & STATE_DISPLAY)
2706 {
2707 if (needpass)
2708 state_attach_puts(state, _("[-- BEGIN PGP MESSAGE --]\n\n"));
2709 else if (pgp_keyblock)
2710 state_attach_puts(state, _("[-- BEGIN PGP PUBLIC KEY BLOCK --]\n"));
2711 else
2712 state_attach_puts(state, _("[-- BEGIN PGP SIGNED MESSAGE --]\n\n"));
2713 }
2714
2715 if (clearsign)
2716 {
2717 copy_clearsigned(armored_data, state, body_charset);
2718 }
2719 else if (fp_out)
2720 {
2721 int c;
2722 char *expected_charset = gpgcharset && *gpgcharset ? gpgcharset : "utf-8";
2723 rewind(fp_out);
2724 struct FgetConv *fc = mutt_ch_fgetconv_open(fp_out, expected_charset,
2726 while ((c = mutt_ch_fgetconv(fc)) != EOF)
2727 {
2728 state_putc(state, c);
2729 if ((c == '\n') && state->prefix)
2730 state_puts(state, state->prefix);
2731 }
2733 }
2734
2735 if (state->flags & STATE_DISPLAY)
2736 {
2737 state_putc(state, '\n');
2738 if (needpass)
2739 state_attach_puts(state, _("[-- END PGP MESSAGE --]\n"));
2740 else if (pgp_keyblock)
2741 state_attach_puts(state, _("[-- END PGP PUBLIC KEY BLOCK --]\n"));
2742 else
2743 state_attach_puts(state, _("[-- END PGP SIGNED MESSAGE --]\n"));
2744 }
2745
2746 // Multiple PGP blocks can exist, so clean these up in each loop
2747 gpgme_data_release(armored_data);
2748 mutt_file_fclose(&fp_out);
2749 }
2750 else
2751 {
2752 /* A traditional PGP part may mix signed and unsigned content */
2753 /* XXX we may wish to recode here */
2754 if (state->prefix)
2755 state_puts(state, state->prefix);
2756 state_puts(state, buf);
2757 }
2758 }
2759 FREE(&gpgcharset);
2760
2761 b->goodsig = (maybe_goodsig && have_any_sigs);
2762
2763 if (needpass == -1)
2764 {
2765 state_attach_puts(state, _("[-- Error: could not find beginning of PGP message --]\n\n"));
2766 return 1;
2767 }
2768 mutt_debug(LL_DEBUG2, "Leaving handler\n");
2769
2770 return err;
2771}
const char * cc_charset(void)
Get the cached value of $charset.
static void show_encryption_info(struct State *state, gpgme_decrypt_result_t result)
Show encryption information.
static gpgme_data_t create_gpgme_data(void)
Create a new GPGME data object.
gpgme_ctx_t create_gpgme_context(bool for_smime)
Create a new GPGME context.
#define SIGNED_MESSAGE(_y)
Definition crypt_gpgme.c:96
static gpgme_data_t file_to_data_object(FILE *fp, long offset, size_t length)
Create GPGME data object from file.
#define PUBLIC_KEY_BLOCK(_y)
Definition crypt_gpgme.c:97
static char * data_object_to_tempfile(gpgme_data_t data, FILE **fp_ret)
Copy a data object to a temporary file.
static void redraw_if_needed(gpgme_ctx_t ctx)
Accommodate for a redraw if needed.
static int pgp_gpgme_extract_keys(gpgme_data_t keydata, FILE **fp)
Write PGP keys to a file.
static void copy_clearsigned(gpgme_data_t data, struct State *state, char *charset)
Copy a clearsigned message.
static int show_one_sig_status(gpgme_ctx_t ctx, int idx, struct State *state)
Show information about one signature.
#define MESSAGE(_y)
Definition crypt_gpgme.c:95
char * mutt_body_get_charset(struct Body *b, char *buf, size_t buflen)
Get a body's character set.
Definition body.c:134
bool mutt_file_seek(FILE *fp, LOFF_T offset, int whence)
Wrapper for fseeko with error handling.
Definition file.c:648
#define mutt_file_fclose(FP)
Definition file.h:144
#define mutt_message(...)
Definition logging2.h:93
#define mutt_debug(LEVEL,...)
Definition logging2.h:91
@ LL_DEBUG2
Log at debug level 2.
Definition logging2.h:46
@ LL_DEBUG1
Log at debug level 1.
Definition logging2.h:45
#define FREE(x)
Free memory and set the pointer to NULL.
Definition memory.h:68
bool mutt_ch_check_charset(const char *cs, bool strict)
Does iconv understand a character set?
Definition charset.c:882
int mutt_ch_fgetconv(struct FgetConv *fc)
Convert a file's character set.
Definition charset.c:968
struct FgetConv * mutt_ch_fgetconv_open(FILE *fp, const char *from, const char *to, uint8_t flags)
Prepare a file for charset conversion.
Definition charset.c:921
void mutt_ch_fgetconv_close(struct FgetConv **ptr)
Close an fgetconv handle.
Definition charset.c:950
#define MUTT_ICONV_HOOK_FROM
apply charset-hooks to fromcode
Definition charset.h:67
#define _(a)
Definition message.h:28
void state_attach_puts(struct State *state, const char *t)
Write a string to the state.
Definition state.c:104
#define state_puts(STATE, STR)
Definition state.h:64
#define state_putc(STATE, STR)
Definition state.h:65
@ STATE_VERIFY
Perform signature verification.
Definition state.h:38
@ STATE_DISPLAY
Output is displayed to the user.
Definition state.h:37
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition string.c:257
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition string.c:666
bool mutt_strn_equal(const char *a, const char *b, size_t num)
Check for equality of two strings (to a maximum), safely.
Definition string.c:429
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition string.c:234
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition string.c:503
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination).
Definition string.c:587
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition string.c:284
LOFF_T offset
offset where the actual data begins
Definition body.h:52
LOFF_T length
length (in bytes) of attachment
Definition body.h:53
bool goodsig
Good cryptographic signature.
Definition body.h:45
Cursor for converting a file's encoding.
Definition charset.h:45
StateFlags flags
Flags, e.g. STATE_DISPLAY.
Definition state.h:58
FILE * fp_in
File to read from.
Definition state.h:55
const char * prefix
String to add to the beginning of each output line.
Definition state.h:57
Here is the call graph for this function:

◆ smime_gpgme_application_handler()

int smime_gpgme_application_handler ( struct Body * b,
struct State * state )

Manage the MIME type "application/pgp" or "application/smime" - Implements CryptModuleSpecs::application_handler() -.

Definition at line 2869 of file crypt_gpgme.c.

2870{
2871 int is_signed = 0;
2872 int rc = 0;
2873
2874 mutt_debug(LL_DEBUG2, "Entering handler\n");
2875
2876 /* clear out any mime headers before the handler, so they can't be spoofed. */
2878 b->warnsig = false;
2879 FILE *fp_out = mutt_file_mkstemp();
2880 if (!fp_out)
2881 {
2882 mutt_perror(_("Can't create temporary file"));
2883 if (state->flags & STATE_DISPLAY)
2884 {
2885 state_attach_puts(state, _("[-- Error: could not create temporary file --]\n"));
2886 }
2887 return -1;
2888 }
2889
2890 struct Body *tattach = decrypt_part(b, state, fp_out, true, &is_signed);
2891 if (tattach)
2892 {
2893 tattach->goodsig = is_signed > 0;
2894
2895 if (state->flags & STATE_DISPLAY)
2896 {
2897 state_attach_puts(state, is_signed ?
2898 _("[-- The following data is S/MIME signed --]\n") :
2899 _("[-- The following data is S/MIME encrypted --]\n"));
2900 mutt_protected_headers_handler(tattach, state);
2901 }
2902
2903 /* Store any protected headers in the parent so they can be
2904 * accessed for index updates after the handler recursion is done.
2905 * This is done before the handler to prevent a nested encrypted
2906 * handler from freeing the headers. */
2908 b->mime_headers = tattach->mime_headers;
2909 tattach->mime_headers = NULL;
2910
2911 FILE *fp_save = state->fp_in;
2912 state->fp_in = fp_out;
2913 rc = mutt_body_handler(tattach, state);
2914 state->fp_in = fp_save;
2915
2916 /* Embedded multipart signed protected headers override the
2917 * encrypted headers. We need to do this after the handler so
2918 * they can be printed in the pager. */
2919 if (mutt_is_multipart_signed(tattach) && tattach->parts && tattach->parts->mime_headers)
2920 {
2922 b->mime_headers = tattach->parts->mime_headers;
2923 tattach->parts->mime_headers = NULL;
2924 }
2925
2926 /* if a multipart/signed is the _only_ sub-part of a multipart/encrypted,
2927 * cache signature verification status. */
2928 if (mutt_is_multipart_signed(tattach) && !tattach->next)
2929 {
2930 b->goodsig = tattach->goodsig;
2931 if (!b->goodsig)
2932 b->warnsig = tattach->warnsig;
2933 }
2934 else if (tattach->goodsig)
2935 {
2936 b->goodsig = true;
2937 b->warnsig = tattach->warnsig;
2938 }
2939
2940 if (state->flags & STATE_DISPLAY)
2941 {
2942 state_attach_puts(state, is_signed ? _("[-- End of S/MIME signed data --]\n") :
2943 _("[-- End of S/MIME encrypted data --]\n"));
2944 }
2945
2946 mutt_body_free(&tattach);
2947 }
2948
2949 mutt_file_fclose(&fp_out);
2950 mutt_debug(LL_DEBUG2, "Leaving handler\n");
2951
2952 return rc;
2953}
SecurityFlags mutt_is_multipart_signed(struct Body *b)
Is a message signed?
Definition crypt.c:409
static struct Body * decrypt_part(struct Body *b, struct State *state, FILE *fp_out, bool is_smime, int *r_is_signed)
Decrypt a PGP or SMIME message.
void mutt_body_free(struct Body **ptr)
Free a Body.
Definition body.c:58
void mutt_env_free(struct Envelope **ptr)
Free an Envelope.
Definition envelope.c:125
int mutt_protected_headers_handler(struct Body *b_email, struct State *state)
Handler for protected headers - Implements handler_t -.
Definition crypt.c:1123
#define mutt_perror(...)
Definition logging2.h:95
int mutt_body_handler(struct Body *b, struct State *state)
Handler for the Body of an email.
Definition handler.c:1668
The body of an email.
Definition body.h:36
struct Body * parts
parts of a multipart or message/rfc822
Definition body.h:73
struct Envelope * mime_headers
Memory hole protected headers.
Definition body.h:76
struct Body * next
next attachment in the list
Definition body.h:72
bool warnsig
Maybe good signature.
Definition body.h:48
#define mutt_file_mkstemp()
Definition tmp.h:36
Here is the call graph for this function:

◆ pgp_class_application_handler()

int pgp_class_application_handler ( struct Body * b,
struct State * state )

Manage the MIME type "application/pgp" or "application/smime" - Implements CryptModuleSpecs::application_handler() -.

Definition at line 470 of file pgp.c.

471{
473 bool could_not_decrypt = false;
474 int decrypt_okay_rc = 0;
475 int needpass = -1;
476 bool pgp_keyblock = false;
477 bool clearsign = false;
478 int rc = -1;
479 int c = 1;
480 long bytes;
481 LOFF_T last_pos;
482 LOFF_T offset;
483 char buf[8192] = { 0 };
484 FILE *fp_pgp_out = NULL;
485 FILE *fp_pgp_in = NULL;
486 FILE *fp_pgp_err = NULL;
487 FILE *fp_tmp = NULL;
488 pid_t pid;
489 struct Buffer *tempfile = buf_pool_get();
490
491 bool maybe_goodsig = true;
492 bool have_any_sigs = false;
493
494 char *gpgcharset = NULL;
495 char body_charset[256] = { 0 };
496 mutt_body_get_charset(b, body_charset, sizeof(body_charset));
497
498 if (!mutt_file_seek(state->fp_in, b->offset, SEEK_SET))
499 {
500 return -1;
501 }
502 last_pos = b->offset;
503
504 for (bytes = b->length; bytes > 0;)
505 {
506 if (!fgets(buf, sizeof(buf), state->fp_in))
507 break;
508
509 offset = ftello(state->fp_in);
510 bytes -= (offset - last_pos); /* don't rely on mutt_str_len(buf) */
511 last_pos = offset;
512
513 size_t plen = mutt_str_startswith(buf, "-----BEGIN PGP ");
514 if (plen != 0)
515 {
516 needpass = false;
517 clearsign = false;
518 could_not_decrypt = false;
519 decrypt_okay_rc = 0;
520
521 if (mutt_str_startswith(buf + plen, "MESSAGE-----\n"))
522 {
523 needpass = 1;
524 }
525 else if (mutt_str_startswith(buf + plen, "SIGNED MESSAGE-----\n"))
526 {
527 clearsign = true;
528 }
529 else if (mutt_str_startswith(buf + plen, "PUBLIC KEY BLOCK-----\n"))
530 {
531 pgp_keyblock = true;
532 }
533 else
534 {
535 /* XXX we may wish to recode here */
536 if (state->prefix)
537 state_puts(state, state->prefix);
538 state_puts(state, buf);
539 continue;
540 }
541
542 have_any_sigs = have_any_sigs || (clearsign && (state->flags & STATE_VERIFY));
543
544 /* Copy PGP material to temporary file */
545 buf_mktemp(tempfile);
546 fp_tmp = mutt_file_fopen(buf_string(tempfile), "w+");
547 if (!fp_tmp)
548 {
549 mutt_perror("%s", buf_string(tempfile));
550 FREE(&gpgcharset);
551 goto out;
552 }
553
554 fputs(buf, fp_tmp);
555 while ((bytes > 0) && fgets(buf, sizeof(buf) - 1, state->fp_in))
556 {
557 offset = ftello(state->fp_in);
558 bytes -= (offset - last_pos); /* don't rely on mutt_str_len(buf) */
559 last_pos = offset;
560
561 fputs(buf, fp_tmp);
562
563 if ((needpass && mutt_str_equal("-----END PGP MESSAGE-----\n", buf)) ||
564 (!needpass && (mutt_str_equal("-----END PGP SIGNATURE-----\n", buf) ||
565 mutt_str_equal("-----END PGP PUBLIC KEY BLOCK-----\n", buf))))
566 {
567 break;
568 }
569 /* remember optional Charset: armor header as defined by RFC4880 */
570 if (mutt_str_startswith(buf, "Charset: "))
571 {
572 size_t l = 0;
573 FREE(&gpgcharset);
574 gpgcharset = mutt_str_dup(buf + 9);
575 l = mutt_str_len(gpgcharset);
576 if ((l > 0) && (gpgcharset[l - 1] == '\n'))
577 gpgcharset[l - 1] = 0;
578 if (!mutt_ch_check_charset(gpgcharset, false))
579 mutt_str_replace(&gpgcharset, "UTF-8");
580 }
581 }
582
583 /* leave fp_tmp open in case we still need it - but flush it! */
584 fflush(fp_tmp);
585
586 /* Invoke PGP if needed */
587 if (!clearsign || (state->flags & STATE_VERIFY))
588 {
589 fp_pgp_out = mutt_file_mkstemp();
590 if (!fp_pgp_out)
591 {
592 mutt_perror(_("Can't create temporary file"));
593 goto out;
594 }
595
596 fp_pgp_err = mutt_file_mkstemp();
597 if (!fp_pgp_err)
598 {
599 mutt_perror(_("Can't create temporary file"));
600 goto out;
601 }
602
603 pid = pgp_invoke_decode(&fp_pgp_in, NULL, NULL, -1, fileno(fp_pgp_out),
604 fileno(fp_pgp_err), buf_string(tempfile),
605 (needpass != 0));
606 if (pid == -1)
607 {
608 mutt_file_fclose(&fp_pgp_out);
609 maybe_goodsig = false;
610 fp_pgp_in = NULL;
611 state_attach_puts(state, _("[-- Error: unable to create PGP subprocess --]\n"));
612 }
613 else /* PGP started successfully */
614 {
615 if (needpass)
616 {
619 if (pgp_use_gpg_agent())
620 *mod_data->pgp_pass = '\0';
621 fprintf(fp_pgp_in, "%s\n", mod_data->pgp_pass);
622 }
623
624 mutt_file_fclose(&fp_pgp_in);
625
626 int wait_filter_rc = filter_wait(pid);
627
628 fflush(fp_pgp_err);
629 /* If we are expecting an encrypted message, verify status fd output.
630 * Note that BEGIN PGP MESSAGE does not guarantee the content is encrypted,
631 * so we need to be more selective about the value of decrypt_okay_rc.
632 *
633 * -3 indicates we actively found a DECRYPTION_FAILED.
634 * -2 and -1 indicate part or all of the content was plaintext. */
635 if (needpass)
636 {
637 rewind(fp_pgp_err);
638 decrypt_okay_rc = pgp_check_decryption_okay(fp_pgp_err);
639 if (decrypt_okay_rc <= -3)
640 mutt_file_fclose(&fp_pgp_out);
641 }
642
643 if (state->flags & STATE_DISPLAY)
644 {
645 rewind(fp_pgp_err);
646 crypt_current_time(state, "PGP");
647 int checksig_rc = pgp_copy_checksig(fp_pgp_err, state->fp_out);
648
649 if (checksig_rc == 0)
650 have_any_sigs = true;
651 /* Sig is bad if
652 * gpg_good_sign-pattern did not match || pgp_decode_command returned not 0
653 * Sig _is_ correct if
654 * gpg_good_sign="" && pgp_decode_command returned 0 */
655 if (checksig_rc == -1 || (wait_filter_rc != 0))
656 maybe_goodsig = false;
657
658 state_attach_puts(state, _("[-- End of PGP output --]\n\n"));
659 }
660 if (pgp_use_gpg_agent())
661 {
663 }
664 }
665
666 /* treat empty result as sign of failure */
667 /* TODO: maybe on failure neomutt should include the original undecoded text. */
668 if (fp_pgp_out)
669 {
670 rewind(fp_pgp_out);
671 c = fgetc(fp_pgp_out);
672 ungetc(c, fp_pgp_out);
673 }
674 if (!clearsign && (!fp_pgp_out || (c == EOF)))
675 {
676 could_not_decrypt = true;
678 }
679
680 if ((could_not_decrypt || (decrypt_okay_rc <= -3)) && !(state->flags & STATE_DISPLAY))
681 {
682 mutt_error(_("Could not decrypt PGP message"));
683 goto out;
684 }
685 }
686
687 /* Now, copy cleartext to the screen. */
688 if (state->flags & STATE_DISPLAY)
689 {
690 if (needpass)
691 state_attach_puts(state, _("[-- BEGIN PGP MESSAGE --]\n\n"));
692 else if (pgp_keyblock)
693 state_attach_puts(state, _("[-- BEGIN PGP PUBLIC KEY BLOCK --]\n"));
694 else
695 state_attach_puts(state, _("[-- BEGIN PGP SIGNED MESSAGE --]\n\n"));
696 }
697
698 if (clearsign)
699 {
700 rewind(fp_tmp);
701 pgp_copy_clearsigned(fp_tmp, state, body_charset);
702 }
703 else if (fp_pgp_out)
704 {
705 struct FgetConv *fc = NULL;
706 int ch;
707 char *expected_charset = (gpgcharset && *gpgcharset) ? gpgcharset : "utf-8";
708
709 mutt_debug(LL_DEBUG3, "pgp: recoding inline from [%s] to [%s]\n",
710 expected_charset, cc_charset());
711
712 rewind(fp_pgp_out);
713 state_set_prefix(state);
714 fc = mutt_ch_fgetconv_open(fp_pgp_out, expected_charset, cc_charset(),
716 while ((ch = mutt_ch_fgetconv(fc)) != EOF)
717 state_prefix_putc(state, ch);
719 }
720
721 /* Multiple PGP blocks can exist, so these need to be closed and
722 * unlinked inside the loop. */
723 mutt_file_fclose(&fp_tmp);
724 mutt_file_unlink(buf_string(tempfile));
725 mutt_file_fclose(&fp_pgp_out);
726 mutt_file_fclose(&fp_pgp_err);
727
728 if (state->flags & STATE_DISPLAY)
729 {
730 state_putc(state, '\n');
731 if (needpass)
732 {
733 state_attach_puts(state, _("[-- END PGP MESSAGE --]\n"));
734 if (could_not_decrypt || (decrypt_okay_rc <= -3))
735 {
736 mutt_error(_("Could not decrypt PGP message"));
737 }
738 else if (decrypt_okay_rc < 0)
739 {
740 /* L10N: You will see this error message if (1) you are decrypting
741 (not encrypting) something and (2) it is a plaintext. So the
742 message does not mean "You failed to encrypt the message." */
743 mutt_error(_("PGP message is not encrypted"));
744 }
745 else
746 {
747 mutt_message(_("PGP message successfully decrypted"));
748 }
749 }
750 else if (pgp_keyblock)
751 {
752 state_attach_puts(state, _("[-- END PGP PUBLIC KEY BLOCK --]\n"));
753 }
754 else
755 {
756 state_attach_puts(state, _("[-- END PGP SIGNED MESSAGE --]\n"));
757 }
758 }
759 }
760 else
761 {
762 /* A traditional PGP part may mix signed and unsigned content */
763 /* XXX we may wish to recode here */
764 if (state->prefix)
765 state_puts(state, state->prefix);
766 state_puts(state, buf);
767 }
768 }
769
770 rc = 0;
771
772out:
773 b->goodsig = (maybe_goodsig && have_any_sigs);
774
775 if (fp_tmp)
776 {
777 mutt_file_fclose(&fp_tmp);
778 mutt_file_unlink(buf_string(tempfile));
779 }
780 mutt_file_fclose(&fp_pgp_out);
781 mutt_file_fclose(&fp_pgp_err);
782
783 buf_pool_release(&tempfile);
784
785 FREE(&gpgcharset);
786
787 if (needpass == -1)
788 {
789 state_attach_puts(state, _("[-- Error: could not find beginning of PGP message --]\n\n"));
790 return -1;
791 }
792
793 return rc;
794}
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:96
void crypt_current_time(struct State *state, const char *app_name)
Print the current time.
Definition crypt.c:64
void mutt_need_hard_redraw(void)
Force a hard refresh.
Definition curs_lib.c:101
void mutt_file_unlink(const char *s)
Delete a file, carefully.
Definition file.c:156
#define mutt_file_fopen(PATH, MODE)
Definition file.h:143
bool pgp_class_valid_passphrase(void)
Ensure we have a valid passphrase - Implements CryptModuleSpecs::valid_passphrase() -.
Definition pgp.c:81
void pgp_class_void_passphrase(void)
Forget the cached passphrase - Implements CryptModuleSpecs::void_passphrase() -.
Definition pgp.c:71
#define mutt_error(...)
Definition logging2.h:94
@ LL_DEBUG3
Log at debug level 3.
Definition logging2.h:47
@ MODULE_ID_NCRYPT
ModuleNcrypt, Ncrypt
Definition module_api.h:82
int filter_wait(pid_t pid)
Wait for the exit of a process and return its status.
Definition filter.c:231
void state_prefix_putc(struct State *state, char c)
Write a prefixed character to the state.
Definition state.c:168
#define state_set_prefix(state)
Definition state.h:62
void * neomutt_get_module_data(struct NeoMutt *n, enum ModuleId id)
Get the private data for a Module.
Definition neomutt.c:666
static int pgp_copy_checksig(FILE *fp_in, FILE *fp_out)
Copy PGP output and look for signs of a good signature.
Definition pgp.c:248
static void pgp_copy_clearsigned(FILE *fp_in, struct State *state, char *charset)
Copy a clearsigned message, stripping the signature.
Definition pgp.c:422
bool pgp_use_gpg_agent(void)
Does the user want to use the gpg agent?
Definition pgp.c:124
static int pgp_check_decryption_okay(FILE *fp_in)
Check GPG output for status codes.
Definition pgp.c:354
pid_t pgp_invoke_decode(FILE **fp_pgp_in, FILE **fp_pgp_out, FILE **fp_pgp_err, int fd_pgp_in, int fd_pgp_out, int fd_pgp_err, const char *fname, bool need_passphrase)
Use PGP to decode a message.
Definition pgpinvoke.c:132
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:91
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:111
String manipulation buffer.
Definition buffer.h:36
Ncrypt private Module data.
Definition module_data.h:39
char pgp_pass[1024]
Cached PGP Passphrase.
Definition module_data.h:51
Container for Accounts, Notifications.
Definition neomutt.h:41
FILE * fp_out
File to write to.
Definition state.h:56
#define buf_mktemp(buf)
Definition tmp.h:33
Here is the call graph for this function:

◆ smime_class_application_handler()

int smime_class_application_handler ( struct Body * b,
struct State * state )

Manage the MIME type "application/pgp" or "application/smime" - Implements CryptModuleSpecs::application_handler() -.

Definition at line 2006 of file smime.c.

2007{
2008 int rc = -1;
2009
2010 /* clear out any mime headers before the handler, so they can't be spoofed. */
2012
2013 struct Body *tattach = smime_handle_entity(b, state, NULL);
2014 if (tattach)
2015 {
2016 rc = 0;
2017 mutt_body_free(&tattach);
2018 }
2019 return rc;
2020}
static struct Body * smime_handle_entity(struct Body *b, struct State *state, FILE *fp_out_file)
Handle type application/pkcs7-mime.
Definition smime.c:1701
Here is the call graph for this function: