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

PGP encrypt an email. More...

Collaboration diagram for pgp_encrypt_message():

Functions

struct Bodypgp_gpgme_encrypt_message (struct Body *b, char *keylist, bool sign, const struct AddressList *from)
 PGP encrypt an email - Implements CryptModuleSpecs::pgp_encrypt_message() -.
struct Bodypgp_class_encrypt_message (struct Body *b, char *keylist, bool sign, const struct AddressList *from)
 PGP encrypt an email - Implements CryptModuleSpecs::pgp_encrypt_message() -.

Detailed Description

PGP encrypt an email.

Parameters
bBody of email to encrypt
keylistList of keys, or fingerprints (space separated)
signIf true, sign the message too
fromFrom line, to choose the key to sign
Return values
ptrEncrypted Body
NULLError

Encrypt the mail body to all the given keys.

Function Documentation

◆ pgp_gpgme_encrypt_message()

struct Body * pgp_gpgme_encrypt_message ( struct Body * b,
char * keylist,
bool sign,
const struct AddressList * from )

PGP encrypt an email - Implements CryptModuleSpecs::pgp_encrypt_message() -.

Definition at line 1050 of file crypt_gpgme.c.

1052{
1053 if (sign)
1055 gpgme_data_t plaintext = body_to_data_object(b, false);
1056 if (!plaintext)
1057 return NULL;
1058
1059 char *outfile = encrypt_gpgme_object(plaintext, keylist, false, sign, from);
1060 gpgme_data_release(plaintext);
1061 if (!outfile)
1062 return NULL;
1063
1064 struct Body *b_enc = mutt_body_new();
1065 b_enc->type = TYPE_MULTIPART;
1066 b_enc->subtype = mutt_str_dup("encrypted");
1067 b_enc->encoding = ENC_7BIT;
1068 b_enc->use_disp = false;
1069 b_enc->disposition = DISP_INLINE;
1070
1072 mutt_param_set(&b_enc->parameter, "protocol", "application/pgp-encrypted");
1073
1074 b_enc->parts = mutt_body_new();
1075 b_enc->parts->type = TYPE_APPLICATION;
1076 b_enc->parts->subtype = mutt_str_dup("pgp-encrypted");
1077 b_enc->parts->encoding = ENC_7BIT;
1078
1079 b_enc->parts->next = mutt_body_new();
1080 b_enc->parts->next->type = TYPE_APPLICATION;
1081 b_enc->parts->next->subtype = mutt_str_dup("octet-stream");
1082 b_enc->parts->next->encoding = ENC_7BIT;
1083 b_enc->parts->next->filename = outfile;
1084 b_enc->parts->next->use_disp = true;
1085 b_enc->parts->next->disposition = DISP_ATTACH;
1086 b_enc->parts->next->unlink = true; /* delete after sending the message */
1087 b_enc->parts->next->d_filename = mutt_str_dup("msg.asc"); /* non pgp/mime
1088 can save */
1089
1090 return b_enc;
1091}
void crypt_convert_to_7bit(struct Body *b)
Convert an email to 7bit encoding.
Definition crypt.c:815
static gpgme_data_t body_to_data_object(struct Body *b, bool convert)
Create GPGME object from the mail body.
static char * encrypt_gpgme_object(gpgme_data_t plaintext, char *keylist, bool use_smime, bool combined_signed, const struct AddressList *from)
Encrypt the GPGPME data object.
struct Body * mutt_body_new(void)
Create a new Body.
Definition body.c:44
@ ENC_7BIT
7-bit text
Definition mime.h:49
@ TYPE_MULTIPART
Type: 'multipart/*'.
Definition mime.h:37
@ TYPE_APPLICATION
Type: 'application/*'.
Definition mime.h:33
@ DISP_ATTACH
Content is attached.
Definition mime.h:63
@ DISP_INLINE
Content is inline.
Definition mime.h:62
void mutt_generate_boundary(struct ParameterList *pl)
Create a unique boundary id for a MIME part.
Definition multipart.c:93
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition string.c:257
void mutt_param_set(struct ParameterList *pl, const char *attribute, const char *value)
Set a Parameter.
Definition parameter.c:111
The body of an email.
Definition body.h:36
char * d_filename
filename to be used for the content-disposition header If NULL, filename is used instead.
Definition body.h:56
struct Body * parts
parts of a multipart or message/rfc822
Definition body.h:73
bool unlink
If true, filename should be unlink()ed before free()ing this structure.
Definition body.h:68
struct ParameterList parameter
Parameters of the content-type.
Definition body.h:63
bool use_disp
Content-Disposition uses filename= ?
Definition body.h:47
unsigned int disposition
content-disposition, ContentDisposition
Definition body.h:42
struct Body * next
next attachment in the list
Definition body.h:72
char * subtype
content-type subtype
Definition body.h:61
unsigned int encoding
content-transfer-encoding, ContentEncoding
Definition body.h:41
unsigned int type
content-type primary type, ContentType
Definition body.h:40
char * filename
When sending a message, this is the file to which this structure refers.
Definition body.h:59
Here is the call graph for this function:
Here is the caller graph for this function:

◆ pgp_class_encrypt_message()

struct Body * pgp_class_encrypt_message ( struct Body * b,
char * keylist,
bool sign,
const struct AddressList * from )

PGP encrypt an email - Implements CryptModuleSpecs::pgp_encrypt_message() -.

Warning
"b" is no longer freed in this routine, you need to free it later. This is necessary for $fcc_attach.

Definition at line 1603 of file pgp.c.

1605{
1607 char buf[1024] = { 0 };
1608 FILE *fp_pgp_in = NULL;
1609 FILE *fp_tmp = NULL;
1610 struct Body *b_enc = NULL;
1611 bool err = false;
1612 bool empty = false;
1613 pid_t pid;
1614 struct Buffer *tempfile = buf_pool_get();
1615 struct Buffer *pgpinfile = buf_pool_get();
1616
1617 buf_mktemp(tempfile);
1618 FILE *fp_out = mutt_file_fopen(buf_string(tempfile), "w+");
1619 if (!fp_out)
1620 {
1621 mutt_perror("%s", buf_string(tempfile));
1622 goto cleanup;
1623 }
1624
1625 FILE *fp_pgp_err = mutt_file_mkstemp();
1626 if (!fp_pgp_err)
1627 {
1628 mutt_perror(_("Can't create temporary file"));
1629 unlink(buf_string(tempfile));
1630 mutt_file_fclose(&fp_out);
1631 goto cleanup;
1632 }
1633
1634 buf_mktemp(pgpinfile);
1635 fp_tmp = mutt_file_fopen(buf_string(pgpinfile), "w");
1636 if (!fp_tmp)
1637 {
1638 mutt_perror("%s", buf_string(pgpinfile));
1639 unlink(buf_string(tempfile));
1640 mutt_file_fclose(&fp_out);
1641 mutt_file_fclose(&fp_pgp_err);
1642 goto cleanup;
1643 }
1644
1645 if (sign)
1647
1648 mutt_write_mime_header(b, fp_tmp, NeoMutt->sub);
1649 fputc('\n', fp_tmp);
1650 mutt_write_mime_body(b, fp_tmp, NeoMutt->sub);
1651 mutt_file_fclose(&fp_tmp);
1652
1653 pid = pgp_invoke_encrypt(&fp_pgp_in, NULL, NULL, -1, fileno(fp_out),
1654 fileno(fp_pgp_err), buf_string(pgpinfile), keylist, sign);
1655 if (pid == -1)
1656 {
1657 mutt_file_fclose(&fp_out);
1658 mutt_file_fclose(&fp_pgp_err);
1659 unlink(buf_string(pgpinfile));
1660 goto cleanup;
1661 }
1662
1663 if (sign)
1664 {
1665 if (!pgp_use_gpg_agent())
1666 fputs(mod_data->pgp_pass, fp_pgp_in);
1667 fputc('\n', fp_pgp_in);
1668 }
1669 mutt_file_fclose(&fp_pgp_in);
1670
1671 const bool c_pgp_check_exit = cs_subset_bool(NeoMutt->sub, "pgp_check_exit");
1672 if (filter_wait(pid) && c_pgp_check_exit)
1673 empty = true;
1674
1675 unlink(buf_string(pgpinfile));
1676
1677 fflush(fp_out);
1678 rewind(fp_out);
1679 if (!empty)
1680 empty = (fgetc(fp_out) == EOF);
1681 mutt_file_fclose(&fp_out);
1682
1683 fflush(fp_pgp_err);
1684 rewind(fp_pgp_err);
1685 while (fgets(buf, sizeof(buf) - 1, fp_pgp_err))
1686 {
1687 err = true;
1688 fputs(buf, stdout);
1689 }
1690 mutt_file_fclose(&fp_pgp_err);
1691
1692 /* pause if there is any error output from PGP */
1693 if (err)
1695
1696 if (empty)
1697 {
1698 /* fatal error while trying to encrypt message */
1699 if (sign)
1700 pgp_class_void_passphrase(); /* just in case */
1701 unlink(buf_string(tempfile));
1702 goto cleanup;
1703 }
1704
1705 b_enc = mutt_body_new();
1706 b_enc->type = TYPE_MULTIPART;
1707 b_enc->subtype = mutt_str_dup("encrypted");
1708 b_enc->encoding = ENC_7BIT;
1709 b_enc->use_disp = false;
1710 b_enc->disposition = DISP_INLINE;
1711
1713 mutt_param_set(&b_enc->parameter, "protocol", "application/pgp-encrypted");
1714
1715 b_enc->parts = mutt_body_new();
1716 b_enc->parts->type = TYPE_APPLICATION;
1717 b_enc->parts->subtype = mutt_str_dup("pgp-encrypted");
1718 b_enc->parts->encoding = ENC_7BIT;
1719
1720 b_enc->parts->next = mutt_body_new();
1721 b_enc->parts->next->type = TYPE_APPLICATION;
1722 b_enc->parts->next->subtype = mutt_str_dup("octet-stream");
1723 b_enc->parts->next->encoding = ENC_7BIT;
1724 b_enc->parts->next->filename = buf_strdup(tempfile);
1725 b_enc->parts->next->use_disp = true;
1726 b_enc->parts->next->disposition = DISP_ATTACH;
1727 b_enc->parts->next->unlink = true; /* delete after sending the message */
1728 b_enc->parts->next->d_filename = mutt_str_dup("msg.asc"); /* non pgp/mime can save */
1729
1730cleanup:
1731 buf_pool_release(&tempfile);
1732 buf_pool_release(&pgpinfile);
1733 return b_enc;
1734}
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition buffer.c:577
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:96
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition helpers.c:47
int mutt_any_key_to_continue(const char *s)
Prompt the user to 'press any key' and wait.
Definition curs_lib.c:174
#define mutt_file_fclose(FP)
Definition file.h:144
#define mutt_file_fopen(PATH, MODE)
Definition file.h:143
void pgp_class_void_passphrase(void)
Forget the cached passphrase - Implements CryptModuleSpecs::void_passphrase() -.
Definition pgp.c:71
#define mutt_perror(...)
Definition logging2.h:95
@ 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
#define _(a)
Definition message.h:28
void * neomutt_get_module_data(struct NeoMutt *n, enum ModuleId id)
Get the private data for a Module.
Definition neomutt.c:666
bool pgp_use_gpg_agent(void)
Does the user want to use the gpg agent?
Definition pgp.c:124
pid_t pgp_invoke_encrypt(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, const char *uids, bool sign)
Use PGP to encrypt a file.
Definition pgpinvoke.c:229
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
int mutt_write_mime_body(struct Body *b, FILE *fp, struct ConfigSubset *sub)
Write a MIME part.
Definition body.c:304
int mutt_write_mime_header(struct Body *b, FILE *fp, struct ConfigSubset *sub)
Create a MIME header.
Definition header.c:763
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
struct ConfigSubset * sub
Inherited config items.
Definition neomutt.h:49
#define buf_mktemp(buf)
Definition tmp.h:33
#define mutt_file_mkstemp()
Definition tmp.h:36
Here is the call graph for this function: