NeoMutt  2025-12-11-949-g4870ee
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
pgp_traditional_encryptsign()

Create an inline PGP encrypted, signed email. More...

+ Collaboration diagram for pgp_traditional_encryptsign():

Functions

struct Bodypgp_class_traditional_encryptsign (struct Body *b, SecurityFlags flags, char *keylist)
 Create an inline PGP encrypted, signed email - Implements CryptModuleSpecs::pgp_traditional_encryptsign() -.
 

Detailed Description

Create an inline PGP encrypted, signed email.

Parameters
bBody of the email
flagsFlags, see SecurityFlags
keylistList of keys to encrypt to (space-separated)
Return values
ptrNew encrypted/signed Body
NULLError

Function Documentation

◆ pgp_class_traditional_encryptsign()

struct Body * pgp_class_traditional_encryptsign ( struct Body * b,
SecurityFlags flags,
char * keylist )

Create an inline PGP encrypted, signed email - Implements CryptModuleSpecs::pgp_traditional_encryptsign() -.

Definition at line 1728 of file pgp.c.

1729{
1731 struct Body *b_enc = NULL;
1732 char body_charset[256] = { 0 };
1733 const char *from_charset = NULL;
1734 const char *send_charset = NULL;
1735 bool empty = false;
1736 bool err;
1737 char buf[256] = { 0 };
1738 pid_t pid;
1739 struct Buffer *pgpinfile = buf_pool_get();
1740 struct Buffer *pgpoutfile = buf_pool_get();
1741
1742 if (b->type != TYPE_TEXT)
1743 goto cleanup;
1744 if (!mutt_istr_equal(b->subtype, "plain"))
1745 goto cleanup;
1746
1747 FILE *fp_body = mutt_file_fopen(b->filename, "r");
1748 if (!fp_body)
1749 {
1750 mutt_perror("%s", b->filename);
1751 goto cleanup;
1752 }
1753
1754 buf_mktemp(pgpinfile);
1755 FILE *fp_pgp_in = mutt_file_fopen(buf_string(pgpinfile), "w");
1756 if (!fp_pgp_in)
1757 {
1758 mutt_perror("%s", buf_string(pgpinfile));
1759 mutt_file_fclose(&fp_body);
1760 goto cleanup;
1761 }
1762
1763 /* The following code is really correct: If noconv is set,
1764 * b's charset parameter contains the on-disk character set, and
1765 * we have to convert from that to utf-8. If noconv is not set,
1766 * we have to convert from $charset to utf-8. */
1767
1768 mutt_body_get_charset(b, body_charset, sizeof(body_charset));
1769 if (b->noconv)
1770 from_charset = body_charset;
1771 else
1772 from_charset = cc_charset();
1773
1774 if (mutt_ch_is_us_ascii(body_charset))
1775 {
1776 send_charset = "us-ascii";
1777 mutt_file_copy_stream(fp_body, fp_pgp_in);
1778 }
1779 else
1780 {
1781 int c;
1782 struct FgetConv *fc = NULL;
1783
1784 if (flags & SEC_ENCRYPT)
1785 send_charset = "us-ascii";
1786 else
1787 send_charset = "utf-8";
1788
1789 /* fromcode is assumed to be correct: we set flags to 0 */
1790 fc = mutt_ch_fgetconv_open(fp_body, from_charset, "utf-8", MUTT_ICONV_NONE);
1791 while ((c = mutt_ch_fgetconv(fc)) != EOF)
1792 fputc(c, fp_pgp_in);
1793
1795 }
1796 mutt_file_fclose(&fp_body);
1797 mutt_file_fclose(&fp_pgp_in);
1798
1799 buf_mktemp(pgpoutfile);
1800 FILE *fp_pgp_out = mutt_file_fopen(buf_string(pgpoutfile), "w+");
1801 FILE *fp_pgp_err = mutt_file_mkstemp();
1802 if (!fp_pgp_out || !fp_pgp_err)
1803 {
1804 mutt_perror("%s", fp_pgp_out ? "Can't create temporary file" : buf_string(pgpoutfile));
1805 unlink(buf_string(pgpinfile));
1806 if (fp_pgp_out)
1807 {
1808 mutt_file_fclose(&fp_pgp_out);
1809 unlink(buf_string(pgpoutfile));
1810 }
1811 mutt_file_fclose(&fp_pgp_err);
1812 goto cleanup;
1813 }
1814
1815 pid = pgp_invoke_traditional(&fp_pgp_in, NULL, NULL, -1, fileno(fp_pgp_out),
1816 fileno(fp_pgp_err), buf_string(pgpinfile), keylist, flags);
1817 if (pid == -1)
1818 {
1819 mutt_perror(_("Can't invoke PGP"));
1820 mutt_file_fclose(&fp_pgp_out);
1821 mutt_file_fclose(&fp_pgp_err);
1822 mutt_file_unlink(buf_string(pgpinfile));
1823 unlink(buf_string(pgpoutfile));
1824 goto cleanup;
1825 }
1826
1827 if (pgp_use_gpg_agent())
1828 *mod_data->pgp_pass = '\0';
1829 if (flags & SEC_SIGN)
1830 fprintf(fp_pgp_in, "%s\n", mod_data->pgp_pass);
1831 mutt_file_fclose(&fp_pgp_in);
1832
1833 const bool c_pgp_check_exit = cs_subset_bool(NeoMutt->sub, "pgp_check_exit");
1834 if (filter_wait(pid) && c_pgp_check_exit)
1835 empty = true;
1836
1837 mutt_file_unlink(buf_string(pgpinfile));
1838
1839 fflush(fp_pgp_out);
1840 fflush(fp_pgp_err);
1841
1842 rewind(fp_pgp_out);
1843 rewind(fp_pgp_err);
1844
1845 if (!empty)
1846 empty = (fgetc(fp_pgp_out) == EOF);
1847 mutt_file_fclose(&fp_pgp_out);
1848
1849 err = false;
1850
1851 while (fgets(buf, sizeof(buf), fp_pgp_err))
1852 {
1853 err = true;
1854 fputs(buf, stdout);
1855 }
1856
1857 mutt_file_fclose(&fp_pgp_err);
1858
1859 if (err)
1861
1862 if (empty)
1863 {
1864 if (flags & SEC_SIGN)
1865 pgp_class_void_passphrase(); /* just in case */
1866 unlink(buf_string(pgpoutfile));
1867 goto cleanup;
1868 }
1869
1870 b_enc = mutt_body_new();
1871
1872 b_enc->encoding = ENC_7BIT;
1873
1874 b_enc->type = TYPE_TEXT;
1875 b_enc->subtype = mutt_str_dup("plain");
1876
1877 mutt_param_set(&b_enc->parameter, "x-action",
1878 (flags & SEC_ENCRYPT) ? "pgp-encrypted" : "pgp-signed");
1879 mutt_param_set(&b_enc->parameter, "charset", send_charset);
1880
1881 b_enc->filename = buf_strdup(pgpoutfile);
1882
1883 b_enc->disposition = DISP_NONE;
1884 b_enc->unlink = true;
1885
1886 b_enc->noconv = true;
1887 b_enc->use_disp = false;
1888
1889 if (!(flags & SEC_ENCRYPT))
1890 b_enc->encoding = b->encoding;
1891
1892cleanup:
1893 buf_pool_release(&pgpinfile);
1894 buf_pool_release(&pgpoutfile);
1895 return b_enc;
1896}
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
const char * cc_charset(void)
Get the cached value of $charset.
int mutt_any_key_to_continue(const char *s)
Prompt the user to 'press any key' and wait.
Definition curs_lib.c:174
struct Body * mutt_body_new(void)
Create a new Body.
Definition body.c:44
char * mutt_body_get_charset(struct Body *b, char *buf, size_t buflen)
Get a body's character set.
Definition body.c:133
int mutt_file_copy_stream(FILE *fp_in, FILE *fp_out)
Copy the contents of one file into another.
Definition file.c:224
void mutt_file_unlink(const char *s)
Delete a file, carefully.
Definition file.c:156
#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
@ ENC_7BIT
7-bit text
Definition mime.h:49
@ TYPE_TEXT
Type: 'text/*'.
Definition mime.h:38
@ DISP_NONE
No preferred disposition.
Definition mime.h:65
@ MODULE_ID_NCRYPT
ModuleNcrypt, Ncrypt
Definition module_api.h:82
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_NONE
No flags are set.
Definition charset.h:66
#define mutt_ch_is_us_ascii(str)
Definition charset.h:108
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
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition string.c:677
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition string.c:257
@ SEC_SIGN
Email is signed.
Definition lib.h:93
@ SEC_ENCRYPT
Email is encrypted.
Definition lib.h:92
void * neomutt_get_module_data(struct NeoMutt *n, enum ModuleId id)
Get the private data for a Module.
Definition neomutt.c:666
void mutt_param_set(struct ParameterList *pl, const char *attribute, const char *value)
Set a Parameter.
Definition parameter.c:111
bool pgp_use_gpg_agent(void)
Does the user want to use the gpg agent?
Definition pgp.c:124
pid_t pgp_invoke_traditional(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, SecurityFlags flags)
Use PGP to create in inline-signed message.
Definition pgpinvoke.c:264
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
The body of an email.
Definition body.h:36
bool noconv
Don't do character set conversion.
Definition body.h:46
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
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
String manipulation buffer.
Definition buffer.h:36
Cursor for converting a file's encoding.
Definition charset.h:45
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: