NeoMutt  2025-12-11-1009-ga75d9e
Teaching an old dog new tricks
 		DOXYGEN
Loading...
Searching...
No Matches
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 1034 of file crypt_gpgme.c.

1035{
1036 return sign_message(b, from, false);
1037}
sign_message
static struct Body * sign_message(struct Body *b, const struct AddressList *from, bool use_smime)
Sign a message.
Definition crypt_gpgme.c:912
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 1042 of file crypt_gpgme.c.

1043{
1044 return sign_message(b, from, true);
1045}
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 1336 of file pgp.c.

1337{
1338 struct NcryptModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_NCRYPT);
1339 struct Body *b_enc = NULL;
1340 struct Body *rv = NULL;
1341 char buf[1024] = { 0 };
1342 FILE *fp_pgp_in = NULL;
1343 FILE *fp_pgp_out = NULL;
1344 FILE *fp_pgp_err = NULL;
1345 FILE *fp_signed = NULL;
1346 bool err = false;
1347 bool empty = true;
1348 pid_t pid;
1349 struct Buffer *sigfile = buf_pool_get();
1350 struct Buffer *signedfile = buf_pool_get();
1351
1352 crypt_convert_to_7bit(b); /* Signed data _must_ be in 7-bit format. */
1353
1354 buf_mktemp(sigfile);
1355 FILE *fp_sig = mutt_file_fopen(buf_string(sigfile), "w");
1356 if (!fp_sig)
1357 {
1358 goto cleanup;
1359 }
1360
1361 buf_mktemp(signedfile);
1362 fp_signed = mutt_file_fopen(buf_string(signedfile), "w");
1363 if (!fp_signed)
1364 {
1365 mutt_perror("%s", buf_string(signedfile));
1366 mutt_file_fclose(&fp_sig);
1367 unlink(buf_string(sigfile));
1368 goto cleanup;
1369 }
1370
1371 mutt_write_mime_header(b, fp_signed, NeoMutt->sub);
1372 fputc('\n', fp_signed);
1373 mutt_write_mime_body(b, fp_signed, NeoMutt->sub);
1374 mutt_file_fclose(&fp_signed);
1375
1376 pid = pgp_invoke_sign(&fp_pgp_in, &fp_pgp_out, &fp_pgp_err, -1, -1, -1,
1377 buf_string(signedfile));
1378 if (pid == -1)
1379 {
1380 mutt_perror(_("Can't open PGP subprocess"));
1381 mutt_file_fclose(&fp_sig);
1382 unlink(buf_string(sigfile));
1383 unlink(buf_string(signedfile));
1384 goto cleanup;
1385 }
1386
1387 if (!pgp_use_gpg_agent())
1388 fputs(mod_data->pgp_pass, fp_pgp_in);
1389 fputc('\n', fp_pgp_in);
1390 mutt_file_fclose(&fp_pgp_in);
1391
1392 /* Read back the PGP signature. Also, change MESSAGE=>SIGNATURE as
1393 * recommended for future releases of PGP. */
1394 while (fgets(buf, sizeof(buf) - 1, fp_pgp_out))
1395 {
1396 if (mutt_str_equal("-----BEGIN PGP MESSAGE-----\n", buf))
1397 fputs("-----BEGIN PGP SIGNATURE-----\n", fp_sig);
1398 else if (mutt_str_equal("-----END PGP MESSAGE-----\n", buf))
1399 fputs("-----END PGP SIGNATURE-----\n", fp_sig);
1400 else
1401 fputs(buf, fp_sig);
1402 empty = false; /* got some output, so we're ok */
1403 }
1404
1405 /* check for errors from PGP */
1406 err = false;
1407 while (fgets(buf, sizeof(buf) - 1, fp_pgp_err))
1408 {
1409 err = true;
1410 fputs(buf, stdout);
1411 }
1412
1413 const bool c_pgp_check_exit = cs_subset_bool(NeoMutt->sub, "pgp_check_exit");
1414 if (filter_wait(pid) && c_pgp_check_exit)
1415 empty = true;
1416
1417 mutt_file_fclose(&fp_pgp_err);
1418 mutt_file_fclose(&fp_pgp_out);
1419 unlink(buf_string(signedfile));
1420
1421 if (mutt_file_fclose(&fp_sig) != 0)
1422 {
1423 mutt_perror("fclose");
1424 unlink(buf_string(sigfile));
1425 goto cleanup;
1426 }
1427
1428 if (err)
1429 mutt_any_key_to_continue(NULL);
1430 if (empty)
1431 {
1432 unlink(buf_string(sigfile));
1433 /* most likely error is a bad passphrase, so automatically forget it */
1434 pgp_class_void_passphrase();
1435 goto cleanup; /* fatal error while signing */
1436 }
1437
1438 b_enc = mutt_body_new();
1439 b_enc->type = TYPE_MULTIPART;
1440 b_enc->subtype = mutt_str_dup("signed");
1441 b_enc->encoding = ENC_7BIT;
1442 b_enc->use_disp = false;
1443 b_enc->disposition = DISP_INLINE;
1444 rv = b_enc;
1445
1446 mutt_generate_boundary(&b_enc->parameter);
1447 mutt_param_set(&b_enc->parameter, "protocol", "application/pgp-signature");
1448 mutt_param_set(&b_enc->parameter, "micalg", pgp_micalg(buf_string(sigfile)));
1449
1450 b_enc->parts = b;
1451
1452 b_enc->parts->next = mutt_body_new();
1453 b_enc = b_enc->parts->next;
1454 b_enc->type = TYPE_APPLICATION;
1455 b_enc->subtype = mutt_str_dup("pgp-signature");
1456 b_enc->filename = buf_strdup(sigfile);
1457 b_enc->use_disp = false;
1458 b_enc->disposition = DISP_NONE;
1459 b_enc->encoding = ENC_7BIT;
1460 b_enc->unlink = true; /* ok to remove this file after sending. */
1461 mutt_param_set(&b_enc->parameter, "name", "signature.asc");
1462
1463cleanup:
1464 buf_pool_release(&sigfile);
1465 buf_pool_release(&signedfile);
1466 return rv;
1467}
buf_strdup
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition buffer.c:577
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:815
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:174
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:144
mutt_file_fopen
#define mutt_file_fopen(PATH, MODE)
Definition file.h:143
pgp_class_void_passphrase
void pgp_class_void_passphrase(void)
Forget the cached passphrase - Implements CryptModuleSpecs::void_passphrase() -.
Definition pgp.c:71
mutt_perror
#define mutt_perror(...)
Definition logging2.h:95
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
MODULE_ID_NCRYPT
@ MODULE_ID_NCRYPT
ModuleNcrypt, Ncrypt
Definition module_api.h:82
mutt_generate_boundary
void mutt_generate_boundary(struct ParameterList *pl)
Create a unique boundary id for a MIME part.
Definition multipart.c:93
filter_wait
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
mutt_str_dup
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition string.c:257
mutt_str_equal
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition string.c:666
neomutt_get_module_data
void * neomutt_get_module_data(struct NeoMutt *n, enum ModuleId id)
Get the private data for a Module.
Definition neomutt.c:666
mutt_param_set
void mutt_param_set(struct ParameterList *pl, const char *attribute, const char *value)
Set a Parameter.
Definition parameter.c:111
pgp_use_gpg_agent
bool pgp_use_gpg_agent(void)
Does the user want to use the gpg agent?
Definition pgp.c:124
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:204
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:91
buf_pool_release
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:111
mutt_write_mime_body
int mutt_write_mime_body(struct Body *b, FILE *fp, struct ConfigSubset *sub)
Write a MIME part.
Definition body.c:304
mutt_write_mime_header
int mutt_write_mime_header(struct Body *b, FILE *fp, struct ConfigSubset *sub)
Create a MIME header.
Definition header.c:763
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:73
Body::unlink
bool unlink
If true, filename should be unlink()ed before free()ing this structure.
Definition body.h:68
Body::parameter
struct ParameterList parameter
Parameters of the content-type.
Definition body.h:63
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:72
Body::subtype
char * subtype
content-type subtype
Definition body.h:61
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:59
Buffer
String manipulation buffer.
Definition buffer.h:36
NcryptModuleData
Ncrypt private Module data.
Definition module_data.h:39
NcryptModuleData::pgp_pass
char pgp_pass[1024]
Cached PGP Passphrase.
Definition module_data.h:51
NeoMutt
Container for Accounts, Notifications.
Definition neomutt.h:41
NeoMutt::sub
struct ConfigSubset * sub
Inherited config items.
Definition neomutt.h:49
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 1365 of file smime.c.

1366{
1367 struct NcryptModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_NCRYPT);
1368 struct Body *b_sign = NULL;
1369 struct Body *rc = NULL;
1370 char buf[1024] = { 0 };
1371 struct Buffer *filetosign = NULL;
1372 struct Buffer *signedfile = NULL;
1373 FILE *fp_smime_in = NULL;
1374 FILE *fp_smime_out = NULL;
1375 FILE *fp_smime_err = NULL;
1376 FILE *fp_sign = NULL;
1377 bool err = false;
1378 int empty = 0;
1379 pid_t pid;
1380 const char *intermediates = NULL;
1381
1382 const char *const c_smime_sign_as = cs_subset_string(NeoMutt->sub, "smime_sign_as");
1383 const char *const c_smime_default_key = cs_subset_string(NeoMutt->sub, "smime_default_key");
1384 const char *signas = c_smime_sign_as ? c_smime_sign_as : c_smime_default_key;
1385 if (!signas || (*signas == '\0'))
1386 {
1387 mutt_error(_("Can't sign: No key specified. Use Sign As."));
1388 return NULL;
1389 }
1390
1391 crypt_convert_to_7bit(b); /* Signed data _must_ be in 7-bit format. */
1392
1393 filetosign = buf_pool_get();
1394 signedfile = buf_pool_get();
1395
1396 buf_mktemp(filetosign);
1397 fp_sign = mutt_file_fopen(buf_string(filetosign), "w+");
1398 if (!fp_sign)
1399 {
1400 mutt_perror("%s", buf_string(filetosign));
1401 goto cleanup;
1402 }
1403
1404 buf_mktemp(signedfile);
1405 fp_smime_out = mutt_file_fopen(buf_string(signedfile), "w+");
1406 if (!fp_smime_out)
1407 {
1408 mutt_perror("%s", buf_string(signedfile));
1409 goto cleanup;
1410 }
1411
1412 mutt_write_mime_header(b, fp_sign, NeoMutt->sub);
1413 fputc('\n', fp_sign);
1414 mutt_write_mime_body(b, fp_sign, NeoMutt->sub);
1415 mutt_file_fclose(&fp_sign);
1416
1417 const char *const c_smime_keys = cs_subset_path(NeoMutt->sub, "smime_keys");
1418 const char *const c_smime_certificates = cs_subset_path(NeoMutt->sub, "smime_certificates");
1419 buf_printf(&mod_data->smime_key_to_use, "%s/%s", NONULL(c_smime_keys), signas);
1420 buf_printf(&mod_data->smime_cert_to_use, "%s/%s", NONULL(c_smime_certificates), signas);
1421
1422 struct SmimeKey *signas_key = smime_get_key_by_hash(signas, 1);
1423 if (!signas_key || mutt_str_equal("?", signas_key->issuer))
1424 intermediates = signas; /* so openssl won't complain in any case */
1425 else
1426 intermediates = signas_key->issuer;
1427
1428 buf_printf(&mod_data->smime_intermediate_to_use, "%s/%s",
1429 NONULL(c_smime_certificates), intermediates);
1430
1431 smime_key_free(&signas_key);
1432
1433 pid = smime_invoke_sign(&fp_smime_in, NULL, &fp_smime_err, -1,
1434 fileno(fp_smime_out), -1, buf_string(filetosign));
1435 if (pid == -1)
1436 {
1437 mutt_perror(_("Can't open OpenSSL subprocess"));
1438 mutt_file_unlink(buf_string(filetosign));
1439 goto cleanup;
1440 }
1441 fputs(mod_data->smime_pass, fp_smime_in);
1442 fputc('\n', fp_smime_in);
1443 mutt_file_fclose(&fp_smime_in);
1444
1445 filter_wait(pid);
1446
1447 /* check for errors from OpenSSL */
1448 err = false;
1449 fflush(fp_smime_err);
1450 rewind(fp_smime_err);
1451 while (fgets(buf, sizeof(buf) - 1, fp_smime_err))
1452 {
1453 err = true;
1454 fputs(buf, stdout);
1455 }
1456 mutt_file_fclose(&fp_smime_err);
1457
1458 fflush(fp_smime_out);
1459 rewind(fp_smime_out);
1460 empty = (fgetc(fp_smime_out) == EOF);
1461 mutt_file_fclose(&fp_smime_out);
1462
1463 mutt_file_unlink(buf_string(filetosign));
1464
1465 if (err)
1466 {
1467 smime_class_void_passphrase();
1468 mutt_any_key_to_continue(NULL);
1469 }
1470
1471 if (empty)
1472 {
1473 mutt_any_key_to_continue(_("No output from OpenSSL..."));
1474 mutt_file_unlink(buf_string(signedfile));
1475 goto cleanup; /* fatal error while signing */
1476 }
1477
1478 b_sign = mutt_body_new();
1479 b_sign->type = TYPE_MULTIPART;
1480 b_sign->subtype = mutt_str_dup("signed");
1481 b_sign->encoding = ENC_7BIT;
1482 b_sign->use_disp = false;
1483 b_sign->disposition = DISP_INLINE;
1484
1485 mutt_generate_boundary(&b_sign->parameter);
1486
1487 const char *const c_smime_sign_digest_alg = cs_subset_string(NeoMutt->sub, "smime_sign_digest_alg");
1488 char *micalg = openssl_md_to_smime_micalg(c_smime_sign_digest_alg);
1489 mutt_param_set(&b_sign->parameter, "micalg", micalg);
1490 FREE(&micalg);
1491
1492 mutt_param_set(&b_sign->parameter, "protocol", "application/pkcs7-signature");
1493
1494 b_sign->parts = b;
1495 rc = b_sign;
1496
1497 b_sign->parts->next = mutt_body_new();
1498 b_sign = b_sign->parts->next;
1499 b_sign->type = TYPE_APPLICATION;
1500 b_sign->subtype = mutt_str_dup("pkcs7-signature");
1501 b_sign->filename = buf_strdup(signedfile);
1502 b_sign->d_filename = mutt_str_dup("smime.p7s");
1503 b_sign->use_disp = true;
1504 b_sign->disposition = DISP_ATTACH;
1505 b_sign->encoding = ENC_BASE64;
1506 b_sign->unlink = true; /* ok to remove this file after sending. */
1507
1508cleanup:
1509 if (fp_sign)
1510 {
1511 mutt_file_fclose(&fp_sign);
1512 mutt_file_unlink(buf_string(filetosign));
1513 }
1514 if (fp_smime_out)
1515 {
1516 mutt_file_fclose(&fp_smime_out);
1517 mutt_file_unlink(buf_string(signedfile));
1518 }
1519 buf_pool_release(&filetosign);
1520 buf_pool_release(&signedfile);
1521 return rc;
1522}
buf_printf
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition buffer.c:168
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:156
smime_class_void_passphrase
void smime_class_void_passphrase(void)
Forget the cached passphrase - Implements CryptModuleSpecs::void_passphrase() -.
Definition smime.c:137
mutt_error
#define mutt_error(...)
Definition logging2.h:94
FREE
#define FREE(x)
Free memory and set the pointer to NULL.
Definition memory.h:68
ENC_BASE64
@ ENC_BASE64
Base-64 encoded text.
Definition mime.h:52
DISP_ATTACH
@ DISP_ATTACH
Content is attached.
Definition mime.h:63
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:382
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:1179
smime_key_free
static void smime_key_free(struct SmimeKey **keylist)
Free a list of SMIME keys.
Definition smime.c:91
openssl_md_to_smime_micalg
static char * openssl_md_to_smime_micalg(const char *md)
Change the algorithm names.
Definition smime.c:1344
NONULL
#define NONULL(x)
Definition string2.h:44
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
NcryptModuleData::smime_cert_to_use
struct Buffer smime_cert_to_use
S/MIME certificate to use.
Definition module_data.h:59
NcryptModuleData::smime_pass
char smime_pass[256]
Cached S/MIME Passphrase.
Definition module_data.h:56
NcryptModuleData::smime_intermediate_to_use
struct Buffer smime_intermediate_to_use
S/MIME intermediate certificate to use.
Definition module_data.h:60
NcryptModuleData::smime_key_to_use
struct Buffer smime_key_to_use
S/MIME key to use.
Definition module_data.h:58
SmimeKey
An SIME key.
Definition smime.h:43
SmimeKey::issuer
char * issuer
Key issuer.
Definition smime.h:47
Here is the call graph for this function: