NeoMutt  2025-12-11-769-g906513
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 1048 of file crypt_gpgme.c.

1050{
1051 if (sign)
1053 gpgme_data_t plaintext = body_to_data_object(b, false);
1054 if (!plaintext)
1055 return NULL;
1056
1057 char *outfile = encrypt_gpgme_object(plaintext, keylist, false, sign, from);
1058 gpgme_data_release(plaintext);
1059 if (!outfile)
1060 return NULL;
1061
1062 struct Body *b_enc = mutt_body_new();
1063 b_enc->type = TYPE_MULTIPART;
1064 b_enc->subtype = mutt_str_dup("encrypted");
1065 b_enc->encoding = ENC_7BIT;
1066 b_enc->use_disp = false;
1067 b_enc->disposition = DISP_INLINE;
1068
1070 mutt_param_set(&b_enc->parameter, "protocol", "application/pgp-encrypted");
1071
1072 b_enc->parts = mutt_body_new();
1073 b_enc->parts->type = TYPE_APPLICATION;
1074 b_enc->parts->subtype = mutt_str_dup("pgp-encrypted");
1075 b_enc->parts->encoding = ENC_7BIT;
1076
1077 b_enc->parts->next = mutt_body_new();
1078 b_enc->parts->next->type = TYPE_APPLICATION;
1079 b_enc->parts->next->subtype = mutt_str_dup("octet-stream");
1080 b_enc->parts->next->encoding = ENC_7BIT;
1081 b_enc->parts->next->filename = outfile;
1082 b_enc->parts->next->use_disp = true;
1083 b_enc->parts->next->disposition = DISP_ATTACH;
1084 b_enc->parts->next->unlink = true; /* delete after sending the message */
1085 b_enc->parts->next->d_filename = mutt_str_dup("msg.asc"); /* non pgp/mime
1086 can save */
1087
1088 return b_enc;
1089}
void crypt_convert_to_7bit(struct Body *b)
Convert an email to 7bit encoding.
Definition crypt.c:814
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 1594 of file pgp.c.

1596{
1598 char buf[1024] = { 0 };
1599 FILE *fp_pgp_in = NULL, *fp_tmp = NULL;
1600 struct Body *b_enc = NULL;
1601 bool err = false;
1602 bool empty = false;
1603 pid_t pid;
1604 struct Buffer *tempfile = buf_pool_get();
1605 struct Buffer *pgpinfile = buf_pool_get();
1606
1607 buf_mktemp(tempfile);
1608 FILE *fp_out = mutt_file_fopen(buf_string(tempfile), "w+");
1609 if (!fp_out)
1610 {
1611 mutt_perror("%s", buf_string(tempfile));
1612 goto cleanup;
1613 }
1614
1615 FILE *fp_pgp_err = mutt_file_mkstemp();
1616 if (!fp_pgp_err)
1617 {
1618 mutt_perror(_("Can't create temporary file"));
1619 unlink(buf_string(tempfile));
1620 mutt_file_fclose(&fp_out);
1621 goto cleanup;
1622 }
1623
1624 buf_mktemp(pgpinfile);
1625 fp_tmp = mutt_file_fopen(buf_string(pgpinfile), "w");
1626 if (!fp_tmp)
1627 {
1628 mutt_perror("%s", buf_string(pgpinfile));
1629 unlink(buf_string(tempfile));
1630 mutt_file_fclose(&fp_out);
1631 mutt_file_fclose(&fp_pgp_err);
1632 goto cleanup;
1633 }
1634
1635 if (sign)
1637
1638 mutt_write_mime_header(b, fp_tmp, NeoMutt->sub);
1639 fputc('\n', fp_tmp);
1640 mutt_write_mime_body(b, fp_tmp, NeoMutt->sub);
1641 mutt_file_fclose(&fp_tmp);
1642
1643 pid = pgp_invoke_encrypt(&fp_pgp_in, NULL, NULL, -1, fileno(fp_out),
1644 fileno(fp_pgp_err), buf_string(pgpinfile), keylist, sign);
1645 if (pid == -1)
1646 {
1647 mutt_file_fclose(&fp_out);
1648 mutt_file_fclose(&fp_pgp_err);
1649 unlink(buf_string(pgpinfile));
1650 goto cleanup;
1651 }
1652
1653 if (sign)
1654 {
1655 if (!pgp_use_gpg_agent())
1656 fputs(mod_data->pgp_pass, fp_pgp_in);
1657 fputc('\n', fp_pgp_in);
1658 }
1659 mutt_file_fclose(&fp_pgp_in);
1660
1661 const bool c_pgp_check_exit = cs_subset_bool(NeoMutt->sub, "pgp_check_exit");
1662 if (filter_wait(pid) && c_pgp_check_exit)
1663 empty = true;
1664
1665 unlink(buf_string(pgpinfile));
1666
1667 fflush(fp_out);
1668 rewind(fp_out);
1669 if (!empty)
1670 empty = (fgetc(fp_out) == EOF);
1671 mutt_file_fclose(&fp_out);
1672
1673 fflush(fp_pgp_err);
1674 rewind(fp_pgp_err);
1675 while (fgets(buf, sizeof(buf) - 1, fp_pgp_err))
1676 {
1677 err = true;
1678 fputs(buf, stdout);
1679 }
1680 mutt_file_fclose(&fp_pgp_err);
1681
1682 /* pause if there is any error output from PGP */
1683 if (err)
1685
1686 if (empty)
1687 {
1688 /* fatal error while trying to encrypt message */
1689 if (sign)
1690 pgp_class_void_passphrase(); /* just in case */
1691 unlink(buf_string(tempfile));
1692 goto cleanup;
1693 }
1694
1695 b_enc = mutt_body_new();
1696 b_enc->type = TYPE_MULTIPART;
1697 b_enc->subtype = mutt_str_dup("encrypted");
1698 b_enc->encoding = ENC_7BIT;
1699 b_enc->use_disp = false;
1700 b_enc->disposition = DISP_INLINE;
1701
1703 mutt_param_set(&b_enc->parameter, "protocol", "application/pgp-encrypted");
1704
1705 b_enc->parts = mutt_body_new();
1706 b_enc->parts->type = TYPE_APPLICATION;
1707 b_enc->parts->subtype = mutt_str_dup("pgp-encrypted");
1708 b_enc->parts->encoding = ENC_7BIT;
1709
1710 b_enc->parts->next = mutt_body_new();
1711 b_enc->parts->next->type = TYPE_APPLICATION;
1712 b_enc->parts->next->subtype = mutt_str_dup("octet-stream");
1713 b_enc->parts->next->encoding = ENC_7BIT;
1714 b_enc->parts->next->filename = buf_strdup(tempfile);
1715 b_enc->parts->next->use_disp = true;
1716 b_enc->parts->next->disposition = DISP_ATTACH;
1717 b_enc->parts->next->unlink = true; /* delete after sending the message */
1718 b_enc->parts->next->d_filename = mutt_str_dup("msg.asc"); /* non pgp/mime can save */
1719
1720cleanup:
1721 buf_pool_release(&tempfile);
1722 buf_pool_release(&pgpinfile);
1723 return b_enc;
1724}
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition buffer.c:571
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:175
#define mutt_file_fclose(FP)
Definition file.h:139
#define mutt_file_fopen(PATH, MODE)
Definition file.h:138
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:80
int filter_wait(pid_t pid)
Wait for the exit of a process and return its status.
Definition filter.c:228
#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:665
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:302
int mutt_write_mime_header(struct Body *b, FILE *fp, struct ConfigSubset *sub)
Create a MIME header.
Definition header.c:757
String manipulation buffer.
Definition buffer.h:36
Ncrypt private Module data.
Definition module_data.h:38
char pgp_pass[1024]
Cached PGP Passphrase.
Definition module_data.h:50
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: