NeoMutt  2024-04-16-36-g75b6fb
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
find_keys()

Find the keyids of the recipients of a message. More...

+ Collaboration diagram for find_keys():

Functions

char * pgp_gpgme_find_keys (const struct AddressList *addrlist, bool oppenc_mode)
 Find the keyids of the recipients of a message - Implements CryptModuleSpecs::find_keys() -.
 
char * smime_gpgme_find_keys (const struct AddressList *addrlist, bool oppenc_mode)
 Find the keyids of the recipients of a message - Implements CryptModuleSpecs::find_keys() -.
 
char * pgp_class_find_keys (const struct AddressList *addrlist, bool oppenc_mode)
 Find the keyids of the recipients of a message - Implements CryptModuleSpecs::find_keys() -.
 
char * smime_class_find_keys (const struct AddressList *al, bool oppenc_mode)
 Find the keyids of the recipients of a message - Implements CryptModuleSpecs::find_keys() -.
 

Detailed Description

Find the keyids of the recipients of a message.

Parameters
addrlistAddress List
oppenc_modeIf true, use opportunistic encryption
Return values
ptrSpace-separated string of keys
NULLAt least one of the keys can't be found

If oppenc_mode is true, only keys that can be determined without prompting will be used.

Function Documentation

◆ pgp_gpgme_find_keys()

char * pgp_gpgme_find_keys ( const struct AddressList *  addrlist,
bool  oppenc_mode 
)

Find the keyids of the recipients of a message - Implements CryptModuleSpecs::find_keys() -.

Definition at line 3617 of file crypt_gpgme.c.

3618{
3619 return find_keys(addrlist, APPLICATION_PGP, oppenc_mode);
3620}
static char * find_keys(const struct AddressList *addrlist, unsigned int app, bool oppenc_mode)
Find keys of the recipients of the message.
Definition: crypt_gpgme.c:3492
#define APPLICATION_PGP
Use PGP to encrypt/sign.
Definition: lib.h:90
+ Here is the call graph for this function:

◆ smime_gpgme_find_keys()

char * smime_gpgme_find_keys ( const struct AddressList *  addrlist,
bool  oppenc_mode 
)

Find the keyids of the recipients of a message - Implements CryptModuleSpecs::find_keys() -.

Definition at line 3625 of file crypt_gpgme.c.

3626{
3627 return find_keys(addrlist, APPLICATION_SMIME, oppenc_mode);
3628}
#define APPLICATION_SMIME
Use SMIME to encrypt/sign.
Definition: lib.h:91
+ Here is the call graph for this function:

◆ pgp_class_find_keys()

char * pgp_class_find_keys ( const struct AddressList *  addrlist,
bool  oppenc_mode 
)

Find the keyids of the recipients of a message - Implements CryptModuleSpecs::find_keys() -.

Definition at line 1466 of file pgp.c.

1467{
1468 struct ListHead crypt_hook_list = STAILQ_HEAD_INITIALIZER(crypt_hook_list);
1469 struct ListNode *crypt_hook = NULL;
1470 const char *keyid = NULL;
1471 char *keylist = NULL;
1472 size_t keylist_size = 0;
1473 size_t keylist_used = 0;
1474 struct Address *p = NULL;
1475 struct PgpKeyInfo *k_info = NULL;
1476 const char *fqdn = mutt_fqdn(true, NeoMutt->sub);
1477 char buf[1024] = { 0 };
1478 bool key_selected;
1479 struct AddressList hookal = TAILQ_HEAD_INITIALIZER(hookal);
1480
1481 struct Address *a = NULL;
1482 const bool c_crypt_confirm_hook = cs_subset_bool(NeoMutt->sub, "crypt_confirm_hook");
1483 TAILQ_FOREACH(a, addrlist, entries)
1484 {
1485 key_selected = false;
1486 mutt_crypt_hook(&crypt_hook_list, a);
1487 crypt_hook = STAILQ_FIRST(&crypt_hook_list);
1488 do
1489 {
1490 p = a;
1491 k_info = NULL;
1492
1493 if (crypt_hook)
1494 {
1495 keyid = crypt_hook->data;
1496 enum QuadOption ans = MUTT_YES;
1497 if (!oppenc_mode && c_crypt_confirm_hook && isatty(STDIN_FILENO))
1498 {
1499 snprintf(buf, sizeof(buf), _("Use keyID = \"%s\" for %s?"), keyid,
1500 buf_string(p->mailbox));
1501 ans = query_yesorno_help(buf, MUTT_YES, NeoMutt->sub, "crypt_confirm_hook");
1502 }
1503 if (ans == MUTT_YES)
1504 {
1505 if (crypt_is_numerical_keyid(keyid))
1506 {
1507 if (mutt_strn_equal(keyid, "0x", 2))
1508 keyid += 2;
1509 goto bypass_selection; /* you don't see this. */
1510 }
1511
1512 /* check for e-mail address */
1513 mutt_addrlist_clear(&hookal);
1514 if (strchr(keyid, '@') && (mutt_addrlist_parse(&hookal, keyid) != 0))
1515 {
1516 mutt_addrlist_qualify(&hookal, fqdn);
1517 p = TAILQ_FIRST(&hookal);
1518 }
1519 else if (!oppenc_mode)
1520 {
1522 }
1523 }
1524 else if (ans == MUTT_NO)
1525 {
1526 if (key_selected || STAILQ_NEXT(crypt_hook, entries))
1527 {
1528 crypt_hook = STAILQ_NEXT(crypt_hook, entries);
1529 continue;
1530 }
1531 }
1532 else if (ans == MUTT_ABORT)
1533 {
1534 FREE(&keylist);
1535 mutt_addrlist_clear(&hookal);
1536 mutt_list_free(&crypt_hook_list);
1537 return NULL;
1538 }
1539 }
1540
1541 if (!k_info)
1542 {
1544 k_info = pgp_getkeybyaddr(p, KEYFLAG_CANENCRYPT, PGP_PUBRING, oppenc_mode);
1545 }
1546
1547 if (!k_info && !oppenc_mode && isatty(STDIN_FILENO))
1548 {
1549 snprintf(buf, sizeof(buf), _("Enter keyID for %s: "), buf_string(p->mailbox));
1551 }
1552
1553 if (!k_info)
1554 {
1555 FREE(&keylist);
1556 mutt_addrlist_clear(&hookal);
1557 mutt_list_free(&crypt_hook_list);
1558 return NULL;
1559 }
1560
1561 keyid = pgp_fpr_or_lkeyid(k_info);
1562
1563 bypass_selection:
1564 keylist_size += mutt_str_len(keyid) + 4;
1565 mutt_mem_realloc(&keylist, keylist_size);
1566 sprintf(keylist + keylist_used, "%s0x%s", keylist_used ? " " : "", keyid);
1567 keylist_used = mutt_str_len(keylist);
1568
1569 key_selected = true;
1570
1571 pgp_key_free(&k_info);
1572 mutt_addrlist_clear(&hookal);
1573
1574 if (crypt_hook)
1575 crypt_hook = STAILQ_NEXT(crypt_hook, entries);
1576
1577 } while (crypt_hook);
1578
1579 mutt_list_free(&crypt_hook_list);
1580 }
1581 return keylist;
1582}
void mutt_addrlist_qualify(struct AddressList *al, const char *host)
Expand local names in an Address list using a hostname.
Definition: address.c:680
void mutt_addrlist_clear(struct AddressList *al)
Unlink and free all Address in an AddressList.
Definition: address.c:1460
int mutt_addrlist_parse(struct AddressList *al, const char *s)
Parse a list of email addresses.
Definition: address.c:480
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:48
bool crypt_is_numerical_keyid(const char *s)
Is this a numerical keyid.
Definition: crypt.c:1364
void pgp_class_invoke_getkeys(struct Address *addr)
Run a command to download a PGP key - Implements CryptModuleSpecs::pgp_invoke_getkeys() -.
Definition: pgpinvoke.c:383
void mutt_crypt_hook(struct ListHead *list, struct Address *addr)
Find crypto hooks for an Address.
Definition: hook.c:870
void mutt_list_free(struct ListHead *h)
Free a List AND its strings.
Definition: list.c:122
void mutt_mem_realloc(void *ptr, size_t size)
Resize a block of memory on the heap.
Definition: memory.c:114
#define FREE(x)
Definition: memory.h:45
#define _(a)
Definition: message.h:28
bool mutt_strn_equal(const char *a, const char *b, size_t num)
Check for equality of two strings (to a maximum), safely.
Definition: string.c:419
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:490
#define KEYFLAG_CANENCRYPT
Key is suitable for encryption.
Definition: lib.h:128
char * pgp_fpr_or_lkeyid(struct PgpKeyInfo *k)
Get the fingerprint or long keyid.
Definition: pgp.c:234
struct PgpKeyInfo * pgp_ask_for_key(char *tag, const char *whatfor, KeyFlags abilities, enum PgpRing keyring)
Ask the user for a PGP key.
Definition: pgpkey.c:198
struct PgpKeyInfo * pgp_getkeybyaddr(struct Address *a, KeyFlags abilities, enum PgpRing keyring, bool oppenc_mode)
Find a PGP key by address.
Definition: pgpkey.c:375
struct PgpKeyInfo * pgp_getkeybystr(const char *cp, KeyFlags abilities, enum PgpRing keyring)
Find a PGP key by string.
Definition: pgpkey.c:514
@ PGP_PUBRING
Public keys.
Definition: pgpkey.h:39
void pgp_key_free(struct PgpKeyInfo **kpp)
Free a PGP key info.
Definition: pgplib.c:201
QuadOption
Possible values for a quad-option.
Definition: quad.h:36
@ MUTT_ABORT
User aborted the question (with Ctrl-G)
Definition: quad.h:37
@ MUTT_NO
User answered 'No', or assume 'No'.
Definition: quad.h:38
@ MUTT_YES
User answered 'Yes', or assume 'Yes'.
Definition: quad.h:39
enum QuadOption query_yesorno_help(const char *prompt, enum QuadOption def, struct ConfigSubset *sub, const char *name)
Ask the user a Yes/No question offering help.
Definition: question.c:342
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:725
#define STAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:324
#define STAILQ_FIRST(head)
Definition: queue.h:350
#define TAILQ_FIRST(head)
Definition: queue.h:723
#define TAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:637
#define STAILQ_NEXT(elm, field)
Definition: queue.h:400
const char * mutt_fqdn(bool may_hide_host, const struct ConfigSubset *sub)
Get the Fully-Qualified Domain Name.
Definition: sendlib.c:706
An email address.
Definition: address.h:36
struct Buffer * mailbox
Mailbox and host address.
Definition: address.h:38
A List node for strings.
Definition: list.h:35
char * data
String.
Definition: list.h:36
Container for Accounts, Notifications.
Definition: neomutt.h:41
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:45
Information about a PGP key.
Definition: pgplib.h:47
+ Here is the call graph for this function:

◆ smime_class_find_keys()

char * smime_class_find_keys ( const struct AddressList *  al,
bool  oppenc_mode 
)

Find the keyids of the recipients of a message - Implements CryptModuleSpecs::find_keys() -.

Definition at line 797 of file smime.c.

798{
799 struct SmimeKey *key = NULL;
800 char *keyid = NULL, *keylist = NULL;
801 size_t keylist_size = 0;
802 size_t keylist_used = 0;
803
804 struct Address *a = NULL;
805 TAILQ_FOREACH(a, al, entries)
806 {
807 key = smime_get_key_by_addr(buf_string(a->mailbox), KEYFLAG_CANENCRYPT, true, oppenc_mode);
808 if (!key && !oppenc_mode && isatty(STDIN_FILENO))
809 {
810 char buf[1024] = { 0 };
811 snprintf(buf, sizeof(buf), _("Enter keyID for %s: "), buf_string(a->mailbox));
812 key = smime_ask_for_key(buf, KEYFLAG_CANENCRYPT, true);
813 }
814 if (!key)
815 {
816 if (!oppenc_mode)
817 mutt_message(_("No (valid) certificate found for %s"), buf_string(a->mailbox));
818 FREE(&keylist);
819 return NULL;
820 }
821
822 keyid = key->hash;
823 keylist_size += mutt_str_len(keyid) + 2;
824 mutt_mem_realloc(&keylist, keylist_size);
825 sprintf(keylist + keylist_used, "%s%s", keylist_used ? " " : "", keyid);
826 keylist_used = mutt_str_len(keylist);
827
828 smime_key_free(&key);
829 }
830 return keylist;
831}
#define mutt_message(...)
Definition: logging2.h:91
static struct SmimeKey * smime_get_key_by_addr(const char *mailbox, KeyFlags abilities, bool only_public_key, bool oppenc_mode)
Find an SIME key by address.
Definition: smime.c:558
static struct SmimeKey * smime_ask_for_key(char *prompt, KeyFlags abilities, bool only_public_key)
Ask the user to select a key.
Definition: smime.c:685
static void smime_key_free(struct SmimeKey **keylist)
Free a list of SMIME keys.
Definition: smime.c:105
An SIME key.
Definition: smime.h:43
char * hash
Definition: smime.h:45
+ Here is the call graph for this function: