NeoMutt  2024-11-14-34-g5aaf0d
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 1043 of file crypt_gpgme.c.

1045{
1046 if (sign)
1048 gpgme_data_t plaintext = body_to_data_object(b, false);
1049 if (!plaintext)
1050 return NULL;
1051
1052 char *outfile = encrypt_gpgme_object(plaintext, keylist, false, sign, from);
1053 gpgme_data_release(plaintext);
1054 if (!outfile)
1055 return NULL;
1056
1057 struct Body *b_enc = mutt_body_new();
1058 b_enc->type = TYPE_MULTIPART;
1059 b_enc->subtype = mutt_str_dup("encrypted");
1060 b_enc->encoding = ENC_7BIT;
1061 b_enc->use_disp = false;
1062 b_enc->disposition = DISP_INLINE;
1063
1065 mutt_param_set(&b_enc->parameter, "protocol", "application/pgp-encrypted");
1066
1067 b_enc->parts = mutt_body_new();
1068 b_enc->parts->type = TYPE_APPLICATION;
1069 b_enc->parts->subtype = mutt_str_dup("pgp-encrypted");
1070 b_enc->parts->encoding = ENC_7BIT;
1071
1072 b_enc->parts->next = mutt_body_new();
1073 b_enc->parts->next->type = TYPE_APPLICATION;
1074 b_enc->parts->next->subtype = mutt_str_dup("octet-stream");
1075 b_enc->parts->next->encoding = ENC_7BIT;
1076 b_enc->parts->next->filename = outfile;
1077 b_enc->parts->next->use_disp = true;
1078 b_enc->parts->next->disposition = DISP_ATTACH;
1079 b_enc->parts->next->unlink = true; /* delete after sending the message */
1080 b_enc->parts->next->d_filename = mutt_str_dup("msg.asc"); /* non pgp/mime
1081 can save */
1082
1083 return b_enc;
1084}
void crypt_convert_to_7bit(struct Body *b)
Convert an email to 7bit encoding.
Definition: crypt.c:809
static gpgme_data_t body_to_data_object(struct Body *b, bool convert)
Create GPGME object from the mail body.
Definition: crypt_gpgme.c:419
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.
Definition: crypt_gpgme.c:781
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:86
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:253
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 1587 of file pgp.c.

1589{
1590 char buf[1024] = { 0 };
1591 FILE *fp_pgp_in = NULL, *fp_tmp = NULL;
1592 struct Body *b_enc = NULL;
1593 bool err = false;
1594 bool empty = false;
1595 pid_t pid;
1596 struct Buffer *tempfile = buf_pool_get();
1597 struct Buffer *pgpinfile = buf_pool_get();
1598
1599 buf_mktemp(tempfile);
1600 FILE *fp_out = mutt_file_fopen(buf_string(tempfile), "w+");
1601 if (!fp_out)
1602 {
1603 mutt_perror("%s", buf_string(tempfile));
1604 goto cleanup;
1605 }
1606
1607 FILE *fp_pgp_err = mutt_file_mkstemp();
1608 if (!fp_pgp_err)
1609 {
1610 mutt_perror(_("Can't create temporary file"));
1611 unlink(buf_string(tempfile));
1612 mutt_file_fclose(&fp_out);
1613 goto cleanup;
1614 }
1615
1616 buf_mktemp(pgpinfile);
1617 fp_tmp = mutt_file_fopen(buf_string(pgpinfile), "w");
1618 if (!fp_tmp)
1619 {
1620 mutt_perror("%s", buf_string(pgpinfile));
1621 unlink(buf_string(tempfile));
1622 mutt_file_fclose(&fp_out);
1623 mutt_file_fclose(&fp_pgp_err);
1624 goto cleanup;
1625 }
1626
1627 if (sign)
1629
1630 mutt_write_mime_header(b, fp_tmp, NeoMutt->sub);
1631 fputc('\n', fp_tmp);
1632 mutt_write_mime_body(b, fp_tmp, NeoMutt->sub);
1633 mutt_file_fclose(&fp_tmp);
1634
1635 pid = pgp_invoke_encrypt(&fp_pgp_in, NULL, NULL, -1, fileno(fp_out),
1636 fileno(fp_pgp_err), buf_string(pgpinfile), keylist, sign);
1637 if (pid == -1)
1638 {
1639 mutt_file_fclose(&fp_out);
1640 mutt_file_fclose(&fp_pgp_err);
1641 unlink(buf_string(pgpinfile));
1642 goto cleanup;
1643 }
1644
1645 if (sign)
1646 {
1647 if (!pgp_use_gpg_agent())
1648 fputs(PgpPass, fp_pgp_in);
1649 fputc('\n', fp_pgp_in);
1650 }
1651 mutt_file_fclose(&fp_pgp_in);
1652
1653 const bool c_pgp_check_exit = cs_subset_bool(NeoMutt->sub, "pgp_check_exit");
1654 if (filter_wait(pid) && c_pgp_check_exit)
1655 empty = true;
1656
1657 unlink(buf_string(pgpinfile));
1658
1659 fflush(fp_out);
1660 rewind(fp_out);
1661 if (!empty)
1662 empty = (fgetc(fp_out) == EOF);
1663 mutt_file_fclose(&fp_out);
1664
1665 fflush(fp_pgp_err);
1666 rewind(fp_pgp_err);
1667 while (fgets(buf, sizeof(buf) - 1, fp_pgp_err))
1668 {
1669 err = true;
1670 fputs(buf, stdout);
1671 }
1672 mutt_file_fclose(&fp_pgp_err);
1673
1674 /* pause if there is any error output from PGP */
1675 if (err)
1677
1678 if (empty)
1679 {
1680 /* fatal error while trying to encrypt message */
1681 if (sign)
1682 pgp_class_void_passphrase(); /* just in case */
1683 unlink(buf_string(tempfile));
1684 goto cleanup;
1685 }
1686
1687 b_enc = mutt_body_new();
1688 b_enc->type = TYPE_MULTIPART;
1689 b_enc->subtype = mutt_str_dup("encrypted");
1690 b_enc->encoding = ENC_7BIT;
1691 b_enc->use_disp = false;
1692 b_enc->disposition = DISP_INLINE;
1693
1695 mutt_param_set(&b_enc->parameter, "protocol", "application/pgp-encrypted");
1696
1697 b_enc->parts = mutt_body_new();
1698 b_enc->parts->type = TYPE_APPLICATION;
1699 b_enc->parts->subtype = mutt_str_dup("pgp-encrypted");
1700 b_enc->parts->encoding = ENC_7BIT;
1701
1702 b_enc->parts->next = mutt_body_new();
1703 b_enc->parts->next->type = TYPE_APPLICATION;
1704 b_enc->parts->next->subtype = mutt_str_dup("octet-stream");
1705 b_enc->parts->next->encoding = ENC_7BIT;
1706 b_enc->parts->next->filename = buf_strdup(tempfile);
1707 b_enc->parts->next->use_disp = true;
1708 b_enc->parts->next->disposition = DISP_ATTACH;
1709 b_enc->parts->next->unlink = true; /* delete after sending the message */
1710 b_enc->parts->next->d_filename = mutt_str_dup("msg.asc"); /* non pgp/mime can save */
1711
1712cleanup:
1713 buf_pool_release(&tempfile);
1714 buf_pool_release(&pgpinfile);
1715 return b_enc;
1716}
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:173
#define mutt_file_fclose(FP)
Definition: file.h:138
#define mutt_file_fopen(PATH, MODE)
Definition: file.h:137
void pgp_class_void_passphrase(void)
Forget the cached passphrase - Implements CryptModuleSpecs::void_passphrase() -.
Definition: pgp.c:76
#define mutt_perror(...)
Definition: logging2.h:93
int mutt_write_mime_header(struct Body *b, FILE *fp, struct ConfigSubset *sub)
Create a MIME header.
Definition: header.c:756
int filter_wait(pid_t pid)
Wait for the exit of a process and return its status.
Definition: filter.c:220
#define _(a)
Definition: message.h:28
static char PgpPass[1024]
Cached PGP Passphrase.
Definition: pgp.c:69
bool pgp_use_gpg_agent(void)
Does the user want to use the gpg agent?
Definition: pgp.c:127
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:297
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
int mutt_write_mime_body(struct Body *b, FILE *fp, struct ConfigSubset *sub)
Write a MIME part.
Definition: body.c:300
String manipulation buffer.
Definition: buffer.h:36
Container for Accounts, Notifications.
Definition: neomutt.h:42
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:46
#define buf_mktemp(buf)
Definition: tmp.h:33
#define mutt_file_mkstemp()
Definition: tmp.h:36
+ Here is the call graph for this function: