NeoMutt  2024-04-25-85-g27bab4
Teaching an old dog new tricks
 		DOXYGEN
Loading...
Searching...
No Matches
Functions
sign_message()
Crypto API

Cryptographically sign the Body of a message. More...

+ Collaboration diagram for sign_message():

Functions

struct Body * pgp_gpgme_sign_message (struct Body *b, const struct AddressList *from)
 Cryptographically sign the Body of a message - Implements CryptModuleSpecs::sign_message() -.
 
struct Body * smime_gpgme_sign_message (struct Body *b, const struct AddressList *from)
 Cryptographically sign the Body of a message - Implements CryptModuleSpecs::sign_message() -.
 
struct Body * pgp_class_sign_message (struct Body *b, const struct AddressList *from)
 Cryptographically sign the Body of a message - Implements CryptModuleSpecs::sign_message() -.
 
struct Body * smime_class_sign_message (struct Body *b, const struct AddressList *from)
 Cryptographically sign the Body of a message - Implements CryptModuleSpecs::sign_message() -.
 

Detailed Description

Cryptographically sign the Body of a message.

Parameters
bBody of the message
fromFrom line
Return values
ptrNew encrypted Body
NULLError

Function Documentation

◆ pgp_gpgme_sign_message()

struct Body * pgp_gpgme_sign_message ( struct Body *  b,
const struct AddressList *  from 
)

Cryptographically sign the Body of a message - Implements CryptModuleSpecs::sign_message() -.

Definition at line 1027 of file crypt_gpgme.c.

1028{
1029 return sign_message(b, from, false);
1030}
sign_message
static struct Body * sign_message(struct Body *b, const struct AddressList *from, bool use_smime)
Sign a message.
Definition: crypt_gpgme.c:906
+ Here is the call graph for this function:

◆ smime_gpgme_sign_message()

struct Body * smime_gpgme_sign_message ( struct Body *  b,
const struct AddressList *  from 
)

Cryptographically sign the Body of a message - Implements CryptModuleSpecs::sign_message() -.

Definition at line 1035 of file crypt_gpgme.c.

1036{
1037 return sign_message(b, from, true);
1038}
+ Here is the call graph for this function:

◆ pgp_class_sign_message()

struct Body * pgp_class_sign_message ( struct Body *  b,
const struct AddressList *  from 
)

Cryptographically sign the Body of a message - Implements CryptModuleSpecs::sign_message() -.

Definition at line 1332 of file pgp.c.

1333{
1334 struct Body *b_enc = NULL, *rv = NULL;
1335 char buf[1024] = { 0 };
1336 FILE *fp_pgp_in = NULL, *fp_pgp_out = NULL, *fp_pgp_err = NULL, *fp_signed = NULL;
1337 bool err = false;
1338 bool empty = true;
1339 pid_t pid;
1340 struct Buffer *sigfile = buf_pool_get();
1341 struct Buffer *signedfile = buf_pool_get();
1342
1343 crypt_convert_to_7bit(b); /* Signed data _must_ be in 7-bit format. */
1344
1345 buf_mktemp(sigfile);
1346 FILE *fp_sig = mutt_file_fopen(buf_string(sigfile), "w");
1347 if (!fp_sig)
1348 {
1349 goto cleanup;
1350 }
1351
1352 buf_mktemp(signedfile);
1353 fp_signed = mutt_file_fopen(buf_string(signedfile), "w");
1354 if (!fp_signed)
1355 {
1356 mutt_perror("%s", buf_string(signedfile));
1357 mutt_file_fclose(&fp_sig);
1358 unlink(buf_string(sigfile));
1359 goto cleanup;
1360 }
1361
1362 mutt_write_mime_header(b, fp_signed, NeoMutt->sub);
1363 fputc('\n', fp_signed);
1364 mutt_write_mime_body(b, fp_signed, NeoMutt->sub);
1365 mutt_file_fclose(&fp_signed);
1366
1367 pid = pgp_invoke_sign(&fp_pgp_in, &fp_pgp_out, &fp_pgp_err, -1, -1, -1,
1368 buf_string(signedfile));
1369 if (pid == -1)
1370 {
1371 mutt_perror(_("Can't open PGP subprocess"));
1372 mutt_file_fclose(&fp_sig);
1373 unlink(buf_string(sigfile));
1374 unlink(buf_string(signedfile));
1375 goto cleanup;
1376 }
1377
1378 if (!pgp_use_gpg_agent())
1379 fputs(PgpPass, fp_pgp_in);
1380 fputc('\n', fp_pgp_in);
1381 mutt_file_fclose(&fp_pgp_in);
1382
1383 /* Read back the PGP signature. Also, change MESSAGE=>SIGNATURE as
1384 * recommended for future releases of PGP. */
1385 while (fgets(buf, sizeof(buf) - 1, fp_pgp_out))
1386 {
1387 if (mutt_str_equal("-----BEGIN PGP MESSAGE-----\n", buf))
1388 fputs("-----BEGIN PGP SIGNATURE-----\n", fp_sig);
1389 else if (mutt_str_equal("-----END PGP MESSAGE-----\n", buf))
1390 fputs("-----END PGP SIGNATURE-----\n", fp_sig);
1391 else
1392 fputs(buf, fp_sig);
1393 empty = false; /* got some output, so we're ok */
1394 }
1395
1396 /* check for errors from PGP */
1397 err = false;
1398 while (fgets(buf, sizeof(buf) - 1, fp_pgp_err))
1399 {
1400 err = true;
1401 fputs(buf, stdout);
1402 }
1403
1404 const bool c_pgp_check_exit = cs_subset_bool(NeoMutt->sub, "pgp_check_exit");
1405 if (filter_wait(pid) && c_pgp_check_exit)
1406 empty = true;
1407
1408 mutt_file_fclose(&fp_pgp_err);
1409 mutt_file_fclose(&fp_pgp_out);
1410 unlink(buf_string(signedfile));
1411
1412 if (mutt_file_fclose(&fp_sig) != 0)
1413 {
1414 mutt_perror("fclose");
1415 unlink(buf_string(sigfile));
1416 goto cleanup;
1417 }
1418
1419 if (err)
1420 mutt_any_key_to_continue(NULL);
1421 if (empty)
1422 {
1423 unlink(buf_string(sigfile));
1424 /* most likely error is a bad passphrase, so automatically forget it */
1425 pgp_class_void_passphrase();
1426 goto cleanup; /* fatal error while signing */
1427 }
1428
1429 b_enc = mutt_body_new();
1430 b_enc->type = TYPE_MULTIPART;
1431 b_enc->subtype = mutt_str_dup("signed");
1432 b_enc->encoding = ENC_7BIT;
1433 b_enc->use_disp = false;
1434 b_enc->disposition = DISP_INLINE;
1435 rv = b_enc;
1436
1437 mutt_generate_boundary(&b_enc->parameter);
1438 mutt_param_set(&b_enc->parameter, "protocol", "application/pgp-signature");
1439 mutt_param_set(&b_enc->parameter, "micalg", pgp_micalg(buf_string(sigfile)));
1440
1441 b_enc->parts = b;
1442
1443 b_enc->parts->next = mutt_body_new();
1444 b_enc = b_enc->parts->next;
1445 b_enc->type = TYPE_APPLICATION;
1446 b_enc->subtype = mutt_str_dup("pgp-signature");
1447 b_enc->filename = buf_strdup(sigfile);
1448 b_enc->use_disp = false;
1449 b_enc->disposition = DISP_NONE;
1450 b_enc->encoding = ENC_7BIT;
1451 b_enc->unlink = true; /* ok to remove this file after sending. */
1452 mutt_param_set(&b_enc->parameter, "name", "signature.asc");
1453
1454cleanup:
1455 buf_pool_release(&sigfile);
1456 buf_pool_release(&signedfile);
1457 return rv;
1458}
buf_strdup
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition: buffer.c:571
buf_string
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
cs_subset_bool
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
crypt_convert_to_7bit
void crypt_convert_to_7bit(struct Body *b)
Convert an email to 7bit encoding.
Definition: crypt.c:809
mutt_any_key_to_continue
int mutt_any_key_to_continue(const char *s)
Prompt the user to 'press any key' and wait.
Definition: curs_lib.c:173
mutt_body_new
struct Body * mutt_body_new(void)
Create a new Body.
Definition: body.c:44
mutt_file_fclose
#define mutt_file_fclose(FP)
Definition: file.h:149
mutt_file_fopen
#define mutt_file_fopen(PATH, MODE)
Definition: file.h:148
pgp_class_void_passphrase
void pgp_class_void_passphrase(void)
Forget the cached passphrase - Implements CryptModuleSpecs::void_passphrase() -.
Definition: pgp.c:76
mutt_perror
#define mutt_perror(...)
Definition: logging2.h:93
mutt_write_mime_header
int mutt_write_mime_header(struct Body *b, FILE *fp, struct ConfigSubset *sub)
Create a MIME header.
Definition: header.c:756
ENC_7BIT
@ ENC_7BIT
7-bit text
Definition: mime.h:49
TYPE_MULTIPART
@ TYPE_MULTIPART
Type: 'multipart/*'.
Definition: mime.h:37
TYPE_APPLICATION
@ TYPE_APPLICATION
Type: 'application/*'.
Definition: mime.h:33
DISP_INLINE
@ DISP_INLINE
Content is inline.
Definition: mime.h:62
DISP_NONE
@ DISP_NONE
No preferred disposition.
Definition: mime.h:65
mutt_generate_boundary
void mutt_generate_boundary(struct ParameterList *pl)
Create a unique boundary id for a MIME part.
Definition: multipart.c:86
filter_wait
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
mutt_str_dup
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:253
mutt_str_equal
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
mutt_param_set
void mutt_param_set(struct ParameterList *pl, const char *attribute, const char *value)
Set a Parameter.
Definition: parameter.c:111
PgpPass
static char PgpPass[1024]
Cached PGP Passphrase.
Definition: pgp.c:69
pgp_use_gpg_agent
bool pgp_use_gpg_agent(void)
Does the user want to use the gpg agent?
Definition: pgp.c:127
pgp_invoke_sign
pid_t pgp_invoke_sign(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)
Use PGP to sign a file.
Definition: pgpinvoke.c:272
pgp_micalg
const char * pgp_micalg(const char *fname)
Find the hash algorithm of a file.
Definition: pgpmicalg.c:228
buf_pool_get
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
buf_pool_release
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
mutt_write_mime_body
int mutt_write_mime_body(struct Body *b, FILE *fp, struct ConfigSubset *sub)
Write a MIME part.
Definition: body.c:300
Body
The body of an email.
Definition: body.h:36
Body::parts
struct Body * parts
parts of a multipart or message/rfc822
Definition: body.h:72
Body::unlink
bool unlink
If true, filename should be unlink()ed before free()ing this structure.
Definition: body.h:67
Body::parameter
struct ParameterList parameter
Parameters of the content-type.
Definition: body.h:62
Body::use_disp
bool use_disp
Content-Disposition uses filename= ?
Definition: body.h:47
Body::disposition
unsigned int disposition
content-disposition, ContentDisposition
Definition: body.h:42
Body::next
struct Body * next
next attachment in the list
Definition: body.h:71
Body::subtype
char * subtype
content-type subtype
Definition: body.h:60
Body::encoding
unsigned int encoding
content-transfer-encoding, ContentEncoding
Definition: body.h:41
Body::type
unsigned int type
content-type primary type, ContentType
Definition: body.h:40
Body::filename
char * filename
When sending a message, this is the file to which this structure refers.
Definition: body.h:58
Buffer
String manipulation buffer.
Definition: buffer.h:36
NeoMutt
Container for Accounts, Notifications.
Definition: neomutt.h:42
NeoMutt::sub
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:46
buf_mktemp
#define buf_mktemp(buf)
Definition: tmp.h:33
+ Here is the call graph for this function:

◆ smime_class_sign_message()

struct Body * smime_class_sign_message ( struct Body *  b,
const struct AddressList *  from 
)

Cryptographically sign the Body of a message - Implements CryptModuleSpecs::sign_message() -.

Definition at line 1497 of file smime.c.

1498{
1499 struct Body *b_sign = NULL;
1500 struct Body *rc = NULL;
1501 char buf[1024] = { 0 };
1502 struct Buffer *filetosign = NULL, *signedfile = NULL;
1503 FILE *fp_smime_in = NULL, *fp_smime_out = NULL, *fp_smime_err = NULL, *fp_sign = NULL;
1504 bool err = false;
1505 int empty = 0;
1506 pid_t pid;
1507 const char *intermediates = NULL;
1508
1509 const char *const c_smime_sign_as = cs_subset_string(NeoMutt->sub, "smime_sign_as");
1510 const char *const c_smime_default_key = cs_subset_string(NeoMutt->sub, "smime_default_key");
1511 const char *signas = c_smime_sign_as ? c_smime_sign_as : c_smime_default_key;
1512 if (!signas || (*signas == '\0'))
1513 {
1514 mutt_error(_("Can't sign: No key specified. Use Sign As."));
1515 return NULL;
1516 }
1517
1518 crypt_convert_to_7bit(b); /* Signed data _must_ be in 7-bit format. */
1519
1520 filetosign = buf_pool_get();
1521 signedfile = buf_pool_get();
1522
1523 buf_mktemp(filetosign);
1524 fp_sign = mutt_file_fopen(buf_string(filetosign), "w+");
1525 if (!fp_sign)
1526 {
1527 mutt_perror("%s", buf_string(filetosign));
1528 goto cleanup;
1529 }
1530
1531 buf_mktemp(signedfile);
1532 fp_smime_out = mutt_file_fopen(buf_string(signedfile), "w+");
1533 if (!fp_smime_out)
1534 {
1535 mutt_perror("%s", buf_string(signedfile));
1536 goto cleanup;
1537 }
1538
1539 mutt_write_mime_header(b, fp_sign, NeoMutt->sub);
1540 fputc('\n', fp_sign);
1541 mutt_write_mime_body(b, fp_sign, NeoMutt->sub);
1542 mutt_file_fclose(&fp_sign);
1543
1544 const char *const c_smime_keys = cs_subset_path(NeoMutt->sub, "smime_keys");
1545 const char *const c_smime_certificates = cs_subset_path(NeoMutt->sub, "smime_certificates");
1546 buf_printf(&SmimeKeyToUse, "%s/%s", NONULL(c_smime_keys), signas);
1547 buf_printf(&SmimeCertToUse, "%s/%s", NONULL(c_smime_certificates), signas);
1548
1549 struct SmimeKey *signas_key = smime_get_key_by_hash(signas, 1);
1550 if (!signas_key || mutt_str_equal("?", signas_key->issuer))
1551 intermediates = signas; /* so openssl won't complain in any case */
1552 else
1553 intermediates = signas_key->issuer;
1554
1555 buf_printf(&SmimeIntermediateToUse, "%s/%s", NONULL(c_smime_certificates), intermediates);
1556
1557 smime_key_free(&signas_key);
1558
1559 pid = smime_invoke_sign(&fp_smime_in, NULL, &fp_smime_err, -1,
1560 fileno(fp_smime_out), -1, buf_string(filetosign));
1561 if (pid == -1)
1562 {
1563 mutt_perror(_("Can't open OpenSSL subprocess"));
1564 mutt_file_unlink(buf_string(filetosign));
1565 goto cleanup;
1566 }
1567 fputs(SmimePass, fp_smime_in);
1568 fputc('\n', fp_smime_in);
1569 mutt_file_fclose(&fp_smime_in);
1570
1571 filter_wait(pid);
1572
1573 /* check for errors from OpenSSL */
1574 err = false;
1575 fflush(fp_smime_err);
1576 rewind(fp_smime_err);
1577 while (fgets(buf, sizeof(buf) - 1, fp_smime_err))
1578 {
1579 err = true;
1580 fputs(buf, stdout);
1581 }
1582 mutt_file_fclose(&fp_smime_err);
1583
1584 fflush(fp_smime_out);
1585 rewind(fp_smime_out);
1586 empty = (fgetc(fp_smime_out) == EOF);
1587 mutt_file_fclose(&fp_smime_out);
1588
1589 mutt_file_unlink(buf_string(filetosign));
1590
1591 if (err)
1592 mutt_any_key_to_continue(NULL);
1593
1594 if (empty)
1595 {
1596 mutt_any_key_to_continue(_("No output from OpenSSL..."));
1597 mutt_file_unlink(buf_string(signedfile));
1598 goto cleanup; /* fatal error while signing */
1599 }
1600
1601 b_sign = mutt_body_new();
1602 b_sign->type = TYPE_MULTIPART;
1603 b_sign->subtype = mutt_str_dup("signed");
1604 b_sign->encoding = ENC_7BIT;
1605 b_sign->use_disp = false;
1606 b_sign->disposition = DISP_INLINE;
1607
1608 mutt_generate_boundary(&b_sign->parameter);
1609
1610 const char *const c_smime_sign_digest_alg = cs_subset_string(NeoMutt->sub, "smime_sign_digest_alg");
1611 char *micalg = openssl_md_to_smime_micalg(c_smime_sign_digest_alg);
1612 mutt_param_set(&b_sign->parameter, "micalg", micalg);
1613 FREE(&micalg);
1614
1615 mutt_param_set(&b_sign->parameter, "protocol", "application/pkcs7-signature");
1616
1617 b_sign->parts = b;
1618 rc = b_sign;
1619
1620 b_sign->parts->next = mutt_body_new();
1621 b_sign = b_sign->parts->next;
1622 b_sign->type = TYPE_APPLICATION;
1623 b_sign->subtype = mutt_str_dup("pkcs7-signature");
1624 b_sign->filename = buf_strdup(signedfile);
1625 b_sign->d_filename = mutt_str_dup("smime.p7s");
1626 b_sign->use_disp = true;
1627 b_sign->disposition = DISP_ATTACH;
1628 b_sign->encoding = ENC_BASE64;
1629 b_sign->unlink = true; /* ok to remove this file after sending. */
1630
1631cleanup:
1632 if (fp_sign)
1633 {
1634 mutt_file_fclose(&fp_sign);
1635 mutt_file_unlink(buf_string(filetosign));
1636 }
1637 if (fp_smime_out)
1638 {
1639 mutt_file_fclose(&fp_smime_out);
1640 mutt_file_unlink(buf_string(signedfile));
1641 }
1642 buf_pool_release(&filetosign);
1643 buf_pool_release(&signedfile);
1644 return rc;
1645}
buf_printf
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:161
cs_subset_string
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:291
cs_subset_path
const char * cs_subset_path(const struct ConfigSubset *sub, const char *name)
Get a path config item by name.
Definition: helpers.c:168
mutt_file_unlink
void mutt_file_unlink(const char *s)
Delete a file, carefully.
Definition: file.c:221
mutt_error
#define mutt_error(...)
Definition: logging2.h:92
FREE
#define FREE(x)
Definition: memory.h:45
ENC_BASE64
@ ENC_BASE64
Base-64 encoded text.
Definition: mime.h:52
DISP_ATTACH
@ DISP_ATTACH
Content is attached.
Definition: mime.h:63
SmimeIntermediateToUse
static struct Buffer SmimeIntermediateToUse
Smime intermediate certificate to use.
Definition: smime.c:80
smime_get_key_by_hash
static struct SmimeKey * smime_get_key_by_hash(const char *hash, bool only_public_key)
Find a key by its hash.
Definition: smime.c:533
smime_invoke_sign
static pid_t smime_invoke_sign(FILE **fp_smime_in, FILE **fp_smime_out, FILE **fp_smime_err, int fp_smime_infd, int fp_smime_outfd, int fp_smime_errfd, const char *fname)
Use SMIME to sign a file.
Definition: smime.c:1317
SmimePass
static char SmimePass[256]
Cached Smime Passphrase.
Definition: smime.c:71
SmimeKeyToUse
static struct Buffer SmimeKeyToUse
Smime key to use.
Definition: smime.c:76
SmimeCertToUse
static struct Buffer SmimeCertToUse
Smime certificate to use.
Definition: smime.c:78
smime_key_free
static void smime_key_free(struct SmimeKey **keylist)
Free a list of SMIME keys.
Definition: smime.c:106
openssl_md_to_smime_micalg
static char * openssl_md_to_smime_micalg(const char *md)
Change the algorithm names.
Definition: smime.c:1476
NONULL
#define NONULL(x)
Definition: string2.h:37
Body::d_filename
char * d_filename
filename to be used for the content-disposition header If NULL, filename is used instead.
Definition: body.h:56
SmimeKey
An SIME key.
Definition: smime.h:43
SmimeKey::issuer
char * issuer
Definition: smime.h:47
+ Here is the call graph for this function: