NeoMutt  2025-12-11-949-g4870ee
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 2478 of file crypt_gpgme.c.

2479{
2480 int needpass = -1;
2481 bool pgp_keyblock = false;
2482 bool clearsign = false;
2483 long bytes;
2484 LOFF_T last_pos;
2485 LOFF_T block_begin;
2486 LOFF_T block_end;
2487 char buf[8192] = { 0 };
2488 FILE *fp_out = NULL;
2489
2490 gpgme_error_t err = GPG_ERR_NO_ERROR;
2491 gpgme_data_t armored_data = NULL;
2492
2493 bool maybe_goodsig = true;
2494 bool have_any_sigs = false;
2495
2496 char body_charset[256] = { 0 }; /* Only used for clearsigned messages. */
2497 char *gpgcharset = NULL;
2498
2499 mutt_debug(LL_DEBUG2, "Entering handler\n");
2500
2501 /* For clearsigned messages we won't be able to get a character set
2502 * but we know that this may only be text thus we assume Latin-1 here. */
2503 if (!mutt_body_get_charset(b, body_charset, sizeof(body_charset)))
2504 mutt_str_copy(body_charset, "iso-8859-1", sizeof(body_charset));
2505
2506 if (!mutt_file_seek(state->fp_in, b->offset, SEEK_SET))
2507 {
2508 return -1;
2509 }
2510 last_pos = b->offset;
2511
2512 for (bytes = b->length; bytes > 0;)
2513 {
2514 // record before the fgets in case it is a BEGIN block
2515 block_begin = last_pos;
2516
2517 if (!fgets(buf, sizeof(buf), state->fp_in))
2518 break;
2519
2520 LOFF_T offset = ftello(state->fp_in);
2521 if (offset < 0)
2522 {
2523 mutt_debug(LL_DEBUG1, "ftello() failed on fd %d\n", fileno(state->fp_in));
2524 offset = 0;
2525 }
2526 bytes -= (offset - last_pos); /* don't rely on mutt_str_len(buf) */
2527 last_pos = offset;
2528
2529 size_t plen = mutt_str_startswith(buf, "-----BEGIN PGP ");
2530 if (plen != 0)
2531 {
2532 needpass = 0;
2533 clearsign = false;
2534 pgp_keyblock = false;
2535
2536 if (MESSAGE(buf + plen))
2537 {
2538 needpass = 1;
2539 }
2540 else if (SIGNED_MESSAGE(buf + plen))
2541 {
2542 clearsign = true;
2543 }
2544 else if (PUBLIC_KEY_BLOCK(buf + plen))
2545 {
2546 pgp_keyblock = true;
2547 }
2548 else
2549 {
2550 /* XXX we may wish to recode here */
2551 if (state->prefix)
2552 state_puts(state, state->prefix);
2553 state_puts(state, buf);
2554 continue;
2555 }
2556
2557 /* Find the end of armored block. */
2558 while ((bytes > 0) && (fgets(buf, sizeof(buf) - 1, state->fp_in) != NULL))
2559 {
2560 offset = ftello(state->fp_in);
2561 if (offset < 0)
2562 {
2563 mutt_debug(LL_DEBUG1, "ftello() failed on fd %d\n", fileno(state->fp_in));
2564 offset = 0;
2565 }
2566 bytes -= (offset - last_pos); /* don't rely on mutt_strlen(buf) */
2567 last_pos = offset;
2568
2569 if (needpass && mutt_str_equal("-----END PGP MESSAGE-----\n", buf))
2570 {
2571 break;
2572 }
2573
2574 if (!needpass && (mutt_str_equal("-----END PGP SIGNATURE-----\n", buf) ||
2575 mutt_str_equal("-----END PGP PUBLIC KEY BLOCK-----\n", buf)))
2576 {
2577 break;
2578 }
2579
2580 // remember optional Charset: armor header as defined by rfc4880
2581 if (mutt_strn_equal("Charset: ", buf, 9))
2582 {
2583 size_t l = 0;
2584 FREE(&gpgcharset);
2585 gpgcharset = mutt_str_dup(buf + 9);
2586 if ((l = mutt_str_len(gpgcharset)) > 0 && gpgcharset[l - 1] == '\n')
2587 gpgcharset[l - 1] = 0;
2588 if (!mutt_ch_check_charset(gpgcharset, 0))
2589 mutt_str_replace(&gpgcharset, "UTF-8");
2590 }
2591 }
2592 block_end = ftello(state->fp_in);
2593 if (block_end < 0)
2594 {
2595 mutt_debug(LL_DEBUG1, "ftello() failed on fd %d\n", fileno(state->fp_in));
2596 block_end = 0;
2597 }
2598
2599 have_any_sigs = (have_any_sigs || (clearsign && (state->flags & STATE_VERIFY)));
2600
2601 /* Copy PGP material to an data container */
2602 armored_data = file_to_data_object(state->fp_in, block_begin, block_end - block_begin);
2603 fseeko(state->fp_in, block_end, 0);
2604
2605 /* Invoke PGP if needed */
2606 if (pgp_keyblock)
2607 {
2608 pgp_gpgme_extract_keys(armored_data, &fp_out);
2609 }
2610 else if (!clearsign || (state->flags & STATE_VERIFY))
2611 {
2612 gpgme_data_t plaintext = create_gpgme_data();
2613 gpgme_ctx_t ctx = create_gpgme_context(false);
2614
2615 if (clearsign)
2616 {
2617 err = gpgme_op_verify(ctx, armored_data, NULL, plaintext);
2618 }
2619 else
2620 {
2621 err = gpgme_op_decrypt_verify(ctx, armored_data, plaintext);
2622 if (gpg_err_code(err) == GPG_ERR_NO_DATA)
2623 {
2624 /* Decrypt verify can't handle signed only messages. */
2625 gpgme_data_seek(armored_data, 0, SEEK_SET);
2626 /* Must release plaintext so that we supply an uninitialized object. */
2627 gpgme_data_release(plaintext);
2628 plaintext = create_gpgme_data();
2629 err = gpgme_op_verify(ctx, armored_data, NULL, plaintext);
2630 }
2631 }
2632 redraw_if_needed(ctx);
2633
2634 gpgme_decrypt_result_t result = gpgme_op_decrypt_result(ctx);
2635 if (result && (state->flags & STATE_DISPLAY))
2636 show_encryption_info(state, result);
2637
2638 if (err != GPG_ERR_NO_ERROR)
2639 {
2640 char errbuf[200] = { 0 };
2641
2642 snprintf(errbuf, sizeof(errbuf) - 1,
2643 _("Error: decryption/verification failed: %s\n"), gpgme_strerror(err));
2644 state_puts(state, errbuf);
2645 }
2646 else
2647 {
2648 /* Decryption/Verification succeeded */
2649
2650 mutt_message(_("PGP message successfully decrypted"));
2651
2652 bool sig_stat = false;
2653 char *tmpfname = NULL;
2654
2655 /* Check whether signatures have been verified. */
2656 gpgme_verify_result_t verify_result = gpgme_op_verify_result(ctx);
2657 if (verify_result->signatures)
2658 sig_stat = true;
2659
2660 have_any_sigs = false;
2661 maybe_goodsig = false;
2662 if ((state->flags & STATE_DISPLAY) && sig_stat)
2663 {
2664 int res, idx;
2665 bool anybad = false;
2666
2667 state_attach_puts(state, _("[-- Begin signature information --]\n"));
2668 have_any_sigs = true;
2669 for (idx = 0; (res = show_one_sig_status(ctx, idx, state)) != -1; idx++)
2670 {
2671 if (res == 1)
2672 anybad = true;
2673 }
2674 if (!anybad && idx)
2675 maybe_goodsig = true;
2676
2677 state_attach_puts(state, _("[-- End signature information --]\n\n"));
2678 }
2679
2680 tmpfname = data_object_to_tempfile(plaintext, &fp_out);
2681 if (tmpfname)
2682 {
2683 unlink(tmpfname);
2684 FREE(&tmpfname);
2685 }
2686 else
2687 {
2688 mutt_file_fclose(&fp_out);
2689 state_puts(state, _("Error: copy data failed\n"));
2690 }
2691 }
2692 gpgme_data_release(plaintext);
2693 gpgme_release(ctx);
2694 }
2695
2696 /* Now, copy cleartext to the screen. NOTE - we expect that PGP
2697 * outputs utf-8 cleartext. This may not always be true, but it
2698 * seems to be a reasonable guess. */
2699 if (state->flags & STATE_DISPLAY)
2700 {
2701 if (needpass)
2702 state_attach_puts(state, _("[-- BEGIN PGP MESSAGE --]\n\n"));
2703 else if (pgp_keyblock)
2704 state_attach_puts(state, _("[-- BEGIN PGP PUBLIC KEY BLOCK --]\n"));
2705 else
2706 state_attach_puts(state, _("[-- BEGIN PGP SIGNED MESSAGE --]\n\n"));
2707 }
2708
2709 if (clearsign)
2710 {
2711 copy_clearsigned(armored_data, state, body_charset);
2712 }
2713 else if (fp_out)
2714 {
2715 int c;
2716 char *expected_charset = gpgcharset && *gpgcharset ? gpgcharset : "utf-8";
2717 rewind(fp_out);
2718 struct FgetConv *fc = mutt_ch_fgetconv_open(fp_out, expected_charset,
2720 while ((c = mutt_ch_fgetconv(fc)) != EOF)
2721 {
2722 state_putc(state, c);
2723 if ((c == '\n') && state->prefix)
2724 state_puts(state, state->prefix);
2725 }
2727 }
2728
2729 if (state->flags & STATE_DISPLAY)
2730 {
2731 state_putc(state, '\n');
2732 if (needpass)
2733 state_attach_puts(state, _("[-- END PGP MESSAGE --]\n"));
2734 else if (pgp_keyblock)
2735 state_attach_puts(state, _("[-- END PGP PUBLIC KEY BLOCK --]\n"));
2736 else
2737 state_attach_puts(state, _("[-- END PGP SIGNED MESSAGE --]\n"));
2738 }
2739
2740 // Multiple PGP blocks can exist, so clean these up in each loop
2741 gpgme_data_release(armored_data);
2742 mutt_file_fclose(&fp_out);
2743 }
2744 else
2745 {
2746 /* A traditional PGP part may mix signed and unsigned content */
2747 /* XXX we may wish to recode here */
2748 if (state->prefix)
2749 state_puts(state, state->prefix);
2750 state_puts(state, buf);
2751 }
2752 }
2753 FREE(&gpgcharset);
2754
2755 b->goodsig = (maybe_goodsig && have_any_sigs);
2756
2757 if (needpass == -1)
2758 {
2759 state_attach_puts(state, _("[-- Error: could not find beginning of PGP message --]\n\n"));
2760 return 1;
2761 }
2762 mutt_debug(LL_DEBUG2, "Leaving handler\n");
2763
2764 return err;
2765}
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:133
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:880
int mutt_ch_fgetconv(struct FgetConv *fc)
Convert a file's character set.
Definition charset.c:966
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:919
void mutt_ch_fgetconv_close(struct FgetConv **ptr)
Close an fgetconv handle.
Definition charset.c:948
#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:665
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:586
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 2863 of file crypt_gpgme.c.

2864{
2865 int is_signed = 0;
2866 int rc = 0;
2867
2868 mutt_debug(LL_DEBUG2, "Entering handler\n");
2869
2870 /* clear out any mime headers before the handler, so they can't be spoofed. */
2872 b->warnsig = false;
2873 FILE *fp_out = mutt_file_mkstemp();
2874 if (!fp_out)
2875 {
2876 mutt_perror(_("Can't create temporary file"));
2877 if (state->flags & STATE_DISPLAY)
2878 {
2879 state_attach_puts(state, _("[-- Error: could not create temporary file --]\n"));
2880 }
2881 return -1;
2882 }
2883
2884 struct Body *tattach = decrypt_part(b, state, fp_out, true, &is_signed);
2885 if (tattach)
2886 {
2887 tattach->goodsig = is_signed > 0;
2888
2889 if (state->flags & STATE_DISPLAY)
2890 {
2891 state_attach_puts(state, is_signed ?
2892 _("[-- The following data is S/MIME signed --]\n") :
2893 _("[-- The following data is S/MIME encrypted --]\n"));
2894 mutt_protected_headers_handler(tattach, state);
2895 }
2896
2897 /* Store any protected headers in the parent so they can be
2898 * accessed for index updates after the handler recursion is done.
2899 * This is done before the handler to prevent a nested encrypted
2900 * handler from freeing the headers. */
2902 b->mime_headers = tattach->mime_headers;
2903 tattach->mime_headers = NULL;
2904
2905 FILE *fp_save = state->fp_in;
2906 state->fp_in = fp_out;
2907 rc = mutt_body_handler(tattach, state);
2908 state->fp_in = fp_save;
2909
2910 /* Embedded multipart signed protected headers override the
2911 * encrypted headers. We need to do this after the handler so
2912 * they can be printed in the pager. */
2913 if (mutt_is_multipart_signed(tattach) && tattach->parts && tattach->parts->mime_headers)
2914 {
2916 b->mime_headers = tattach->parts->mime_headers;
2917 tattach->parts->mime_headers = NULL;
2918 }
2919
2920 /* if a multipart/signed is the _only_ sub-part of a multipart/encrypted,
2921 * cache signature verification status. */
2922 if (mutt_is_multipart_signed(tattach) && !tattach->next)
2923 {
2924 b->goodsig = tattach->goodsig;
2925 if (!b->goodsig)
2926 b->warnsig = tattach->warnsig;
2927 }
2928 else if (tattach->goodsig)
2929 {
2930 b->goodsig = true;
2931 b->warnsig = tattach->warnsig;
2932 }
2933
2934 if (state->flags & STATE_DISPLAY)
2935 {
2936 state_attach_puts(state, is_signed ? _("[-- End of S/MIME signed data --]\n") :
2937 _("[-- End of S/MIME encrypted data --]\n"));
2938 }
2939
2940 mutt_body_free(&tattach);
2941 }
2942
2943 mutt_file_fclose(&fp_out);
2944 mutt_debug(LL_DEBUG2, "Leaving handler\n");
2945
2946 return rc;
2947}
SecurityFlags mutt_is_multipart_signed(struct Body *b)
Is a message signed?
Definition crypt.c:408
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:1122
#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:1664
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 469 of file pgp.c.

470{
472 bool could_not_decrypt = false;
473 int decrypt_okay_rc = 0;
474 int needpass = -1;
475 bool pgp_keyblock = false;
476 bool clearsign = false;
477 int rc = -1;
478 int c = 1;
479 long bytes;
480 LOFF_T last_pos, offset;
481 char buf[8192] = { 0 };
482 FILE *fp_pgp_out = NULL, *fp_pgp_in = NULL, *fp_pgp_err = NULL;
483 FILE *fp_tmp = NULL;
484 pid_t pid;
485 struct Buffer *tempfile = buf_pool_get();
486
487 bool maybe_goodsig = true;
488 bool have_any_sigs = false;
489
490 char *gpgcharset = NULL;
491 char body_charset[256] = { 0 };
492 mutt_body_get_charset(b, body_charset, sizeof(body_charset));
493
494 if (!mutt_file_seek(state->fp_in, b->offset, SEEK_SET))
495 {
496 return -1;
497 }
498 last_pos = b->offset;
499
500 for (bytes = b->length; bytes > 0;)
501 {
502 if (!fgets(buf, sizeof(buf), state->fp_in))
503 break;
504
505 offset = ftello(state->fp_in);
506 bytes -= (offset - last_pos); /* don't rely on mutt_str_len(buf) */
507 last_pos = offset;
508
509 size_t plen = mutt_str_startswith(buf, "-----BEGIN PGP ");
510 if (plen != 0)
511 {
512 needpass = false;
513 clearsign = false;
514 could_not_decrypt = false;
515 decrypt_okay_rc = 0;
516
517 if (mutt_str_startswith(buf + plen, "MESSAGE-----\n"))
518 {
519 needpass = 1;
520 }
521 else if (mutt_str_startswith(buf + plen, "SIGNED MESSAGE-----\n"))
522 {
523 clearsign = true;
524 }
525 else if (mutt_str_startswith(buf + plen, "PUBLIC KEY BLOCK-----\n"))
526 {
527 pgp_keyblock = true;
528 }
529 else
530 {
531 /* XXX we may wish to recode here */
532 if (state->prefix)
533 state_puts(state, state->prefix);
534 state_puts(state, buf);
535 continue;
536 }
537
538 have_any_sigs = have_any_sigs || (clearsign && (state->flags & STATE_VERIFY));
539
540 /* Copy PGP material to temporary file */
541 buf_mktemp(tempfile);
542 fp_tmp = mutt_file_fopen(buf_string(tempfile), "w+");
543 if (!fp_tmp)
544 {
545 mutt_perror("%s", buf_string(tempfile));
546 FREE(&gpgcharset);
547 goto out;
548 }
549
550 fputs(buf, fp_tmp);
551 while ((bytes > 0) && fgets(buf, sizeof(buf) - 1, state->fp_in))
552 {
553 offset = ftello(state->fp_in);
554 bytes -= (offset - last_pos); /* don't rely on mutt_str_len(buf) */
555 last_pos = offset;
556
557 fputs(buf, fp_tmp);
558
559 if ((needpass && mutt_str_equal("-----END PGP MESSAGE-----\n", buf)) ||
560 (!needpass && (mutt_str_equal("-----END PGP SIGNATURE-----\n", buf) ||
561 mutt_str_equal("-----END PGP PUBLIC KEY BLOCK-----\n", buf))))
562 {
563 break;
564 }
565 /* remember optional Charset: armor header as defined by RFC4880 */
566 if (mutt_str_startswith(buf, "Charset: "))
567 {
568 size_t l = 0;
569 FREE(&gpgcharset);
570 gpgcharset = mutt_str_dup(buf + 9);
571 l = mutt_str_len(gpgcharset);
572 if ((l > 0) && (gpgcharset[l - 1] == '\n'))
573 gpgcharset[l - 1] = 0;
574 if (!mutt_ch_check_charset(gpgcharset, false))
575 mutt_str_replace(&gpgcharset, "UTF-8");
576 }
577 }
578
579 /* leave fp_tmp open in case we still need it - but flush it! */
580 fflush(fp_tmp);
581
582 /* Invoke PGP if needed */
583 if (!clearsign || (state->flags & STATE_VERIFY))
584 {
585 fp_pgp_out = mutt_file_mkstemp();
586 if (!fp_pgp_out)
587 {
588 mutt_perror(_("Can't create temporary file"));
589 goto out;
590 }
591
592 fp_pgp_err = mutt_file_mkstemp();
593 if (!fp_pgp_err)
594 {
595 mutt_perror(_("Can't create temporary file"));
596 goto out;
597 }
598
599 pid = pgp_invoke_decode(&fp_pgp_in, NULL, NULL, -1, fileno(fp_pgp_out),
600 fileno(fp_pgp_err), buf_string(tempfile),
601 (needpass != 0));
602 if (pid == -1)
603 {
604 mutt_file_fclose(&fp_pgp_out);
605 maybe_goodsig = false;
606 fp_pgp_in = NULL;
607 state_attach_puts(state, _("[-- Error: unable to create PGP subprocess --]\n"));
608 }
609 else /* PGP started successfully */
610 {
611 if (needpass)
612 {
615 if (pgp_use_gpg_agent())
616 *mod_data->pgp_pass = '\0';
617 fprintf(fp_pgp_in, "%s\n", mod_data->pgp_pass);
618 }
619
620 mutt_file_fclose(&fp_pgp_in);
621
622 int wait_filter_rc = filter_wait(pid);
623
624 fflush(fp_pgp_err);
625 /* If we are expecting an encrypted message, verify status fd output.
626 * Note that BEGIN PGP MESSAGE does not guarantee the content is encrypted,
627 * so we need to be more selective about the value of decrypt_okay_rc.
628 *
629 * -3 indicates we actively found a DECRYPTION_FAILED.
630 * -2 and -1 indicate part or all of the content was plaintext. */
631 if (needpass)
632 {
633 rewind(fp_pgp_err);
634 decrypt_okay_rc = pgp_check_decryption_okay(fp_pgp_err);
635 if (decrypt_okay_rc <= -3)
636 mutt_file_fclose(&fp_pgp_out);
637 }
638
639 if (state->flags & STATE_DISPLAY)
640 {
641 rewind(fp_pgp_err);
642 crypt_current_time(state, "PGP");
643 int checksig_rc = pgp_copy_checksig(fp_pgp_err, state->fp_out);
644
645 if (checksig_rc == 0)
646 have_any_sigs = true;
647 /* Sig is bad if
648 * gpg_good_sign-pattern did not match || pgp_decode_command returned not 0
649 * Sig _is_ correct if
650 * gpg_good_sign="" && pgp_decode_command returned 0 */
651 if (checksig_rc == -1 || (wait_filter_rc != 0))
652 maybe_goodsig = false;
653
654 state_attach_puts(state, _("[-- End of PGP output --]\n\n"));
655 }
656 if (pgp_use_gpg_agent())
657 {
659 }
660 }
661
662 /* treat empty result as sign of failure */
663 /* TODO: maybe on failure neomutt should include the original undecoded text. */
664 if (fp_pgp_out)
665 {
666 rewind(fp_pgp_out);
667 c = fgetc(fp_pgp_out);
668 ungetc(c, fp_pgp_out);
669 }
670 if (!clearsign && (!fp_pgp_out || (c == EOF)))
671 {
672 could_not_decrypt = true;
674 }
675
676 if ((could_not_decrypt || (decrypt_okay_rc <= -3)) && !(state->flags & STATE_DISPLAY))
677 {
678 mutt_error(_("Could not decrypt PGP message"));
679 goto out;
680 }
681 }
682
683 /* Now, copy cleartext to the screen. */
684 if (state->flags & STATE_DISPLAY)
685 {
686 if (needpass)
687 state_attach_puts(state, _("[-- BEGIN PGP MESSAGE --]\n\n"));
688 else if (pgp_keyblock)
689 state_attach_puts(state, _("[-- BEGIN PGP PUBLIC KEY BLOCK --]\n"));
690 else
691 state_attach_puts(state, _("[-- BEGIN PGP SIGNED MESSAGE --]\n\n"));
692 }
693
694 if (clearsign)
695 {
696 rewind(fp_tmp);
697 pgp_copy_clearsigned(fp_tmp, state, body_charset);
698 }
699 else if (fp_pgp_out)
700 {
701 struct FgetConv *fc = NULL;
702 int ch;
703 char *expected_charset = (gpgcharset && *gpgcharset) ? gpgcharset : "utf-8";
704
705 mutt_debug(LL_DEBUG3, "pgp: recoding inline from [%s] to [%s]\n",
706 expected_charset, cc_charset());
707
708 rewind(fp_pgp_out);
709 state_set_prefix(state);
710 fc = mutt_ch_fgetconv_open(fp_pgp_out, expected_charset, cc_charset(),
712 while ((ch = mutt_ch_fgetconv(fc)) != EOF)
713 state_prefix_putc(state, ch);
715 }
716
717 /* Multiple PGP blocks can exist, so these need to be closed and
718 * unlinked inside the loop. */
719 mutt_file_fclose(&fp_tmp);
720 mutt_file_unlink(buf_string(tempfile));
721 mutt_file_fclose(&fp_pgp_out);
722 mutt_file_fclose(&fp_pgp_err);
723
724 if (state->flags & STATE_DISPLAY)
725 {
726 state_putc(state, '\n');
727 if (needpass)
728 {
729 state_attach_puts(state, _("[-- END PGP MESSAGE --]\n"));
730 if (could_not_decrypt || (decrypt_okay_rc <= -3))
731 {
732 mutt_error(_("Could not decrypt PGP message"));
733 }
734 else if (decrypt_okay_rc < 0)
735 {
736 /* L10N: You will see this error message if (1) you are decrypting
737 (not encrypting) something and (2) it is a plaintext. So the
738 message does not mean "You failed to encrypt the message." */
739 mutt_error(_("PGP message is not encrypted"));
740 }
741 else
742 {
743 mutt_message(_("PGP message successfully decrypted"));
744 }
745 }
746 else if (pgp_keyblock)
747 {
748 state_attach_puts(state, _("[-- END PGP PUBLIC KEY BLOCK --]\n"));
749 }
750 else
751 {
752 state_attach_puts(state, _("[-- END PGP SIGNED MESSAGE --]\n"));
753 }
754 }
755 }
756 else
757 {
758 /* A traditional PGP part may mix signed and unsigned content */
759 /* XXX we may wish to recode here */
760 if (state->prefix)
761 state_puts(state, state->prefix);
762 state_puts(state, buf);
763 }
764 }
765
766 rc = 0;
767
768out:
769 b->goodsig = (maybe_goodsig && have_any_sigs);
770
771 if (fp_tmp)
772 {
773 mutt_file_fclose(&fp_tmp);
774 mutt_file_unlink(buf_string(tempfile));
775 }
776 mutt_file_fclose(&fp_pgp_out);
777 mutt_file_fclose(&fp_pgp_err);
778
779 buf_pool_release(&tempfile);
780
781 FREE(&gpgcharset);
782
783 if (needpass == -1)
784 {
785 state_attach_puts(state, _("[-- Error: could not find beginning of PGP message --]\n\n"));
786 return -1;
787 }
788
789 return rc;
790}
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:228
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:421
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 1983 of file smime.c.

1984{
1985 int rc = -1;
1986
1987 /* clear out any mime headers before the handler, so they can't be spoofed. */
1989
1990 struct Body *tattach = smime_handle_entity(b, state, NULL);
1991 if (tattach)
1992 {
1993 rc = 0;
1994 mutt_body_free(&tattach);
1995 }
1996 return rc;
1997}
static struct Body * smime_handle_entity(struct Body *b, struct State *state, FILE *fp_out_file)
Handle type application/pkcs7-mime.
Definition smime.c:1681
+ Here is the call graph for this function: