NeoMutt  2023-11-03-107-g582dc1
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
lib.h
Go to the documentation of this file.
1
58#ifndef MUTT_NCRYPT_LIB_H
59#define MUTT_NCRYPT_LIB_H
60
61#include <stdbool.h>
62#include <stdint.h>
63#include <stdio.h>
64
65struct Address;
66struct Body;
67#ifdef USE_AUTOCRYPT
68struct Buffer;
69#endif
70struct Email;
71struct EmailArray;
72struct Envelope;
73struct Mailbox;
74struct Message;
75struct State;
76
77typedef uint16_t SecurityFlags;
78#define SEC_NO_FLAGS 0
79#define SEC_ENCRYPT (1 << 0)
80#define SEC_SIGN (1 << 1)
81#define SEC_GOODSIGN (1 << 2)
82#define SEC_BADSIGN (1 << 3)
83#define SEC_PARTSIGN (1 << 4)
84#define SEC_SIGNOPAQUE (1 << 5)
85#define SEC_KEYBLOCK (1 << 6)
86#define SEC_INLINE (1 << 7)
87#define SEC_OPPENCRYPT (1 << 8)
88#define SEC_AUTOCRYPT (1 << 9)
89#define SEC_AUTOCRYPT_OVERRIDE (1 << 10)
90
91#define APPLICATION_PGP (1 << 11)
92#define APPLICATION_SMIME (1 << 12)
93#define PGP_TRADITIONAL_CHECKED (1 << 13)
94
95#define SEC_ALL_FLAGS ((1 << 14) - 1)
96
97#define PGP_ENCRYPT (APPLICATION_PGP | SEC_ENCRYPT)
98#define PGP_SIGN (APPLICATION_PGP | SEC_SIGN)
99#define PGP_GOODSIGN (APPLICATION_PGP | SEC_GOODSIGN)
100#define PGP_KEY (APPLICATION_PGP | SEC_KEYBLOCK)
101#define PGP_INLINE (APPLICATION_PGP | SEC_INLINE)
102
103#define SMIME_ENCRYPT (APPLICATION_SMIME | SEC_ENCRYPT)
104#define SMIME_SIGN (APPLICATION_SMIME | SEC_SIGN)
105#define SMIME_GOODSIGN (APPLICATION_SMIME | SEC_GOODSIGN)
106#define SMIME_BADSIGN (APPLICATION_SMIME | SEC_BADSIGN)
107#define SMIME_OPAQUE (APPLICATION_SMIME | SEC_SIGNOPAQUE)
108
109/* WITHCRYPTO actually replaces ifdefs to make the code more readable.
110 * Because it is defined as a constant and known at compile time, the
111 * compiler can do dead code elimination and thus it behaves
112 * effectively as a conditional compile directive. It is set to false
113 * if no crypto backend is configured or to a bit vector denoting the
114 * configured backends. */
115#if (defined(CRYPT_BACKEND_CLASSIC_PGP) && defined(CRYPT_BACKEND_CLASSIC_SMIME)) || \
116 defined(CRYPT_BACKEND_GPGME)
117#define WithCrypto (APPLICATION_PGP | APPLICATION_SMIME)
118#elif defined(CRYPT_BACKEND_CLASSIC_PGP)
119#define WithCrypto APPLICATION_PGP
120#elif defined(CRYPT_BACKEND_CLASSIC_SMIME)
121#define WithCrypto APPLICATION_SMIME
122#else
123#define WithCrypto 0
124#endif
125
126typedef uint16_t KeyFlags;
127#define KEYFLAG_NO_FLAGS 0
128#define KEYFLAG_CANSIGN (1 << 0)
129#define KEYFLAG_CANENCRYPT (1 << 1)
130#define KEYFLAG_ISX509 (1 << 2)
131#define KEYFLAG_SECRET (1 << 7)
132#define KEYFLAG_EXPIRED (1 << 8)
133#define KEYFLAG_REVOKED (1 << 9)
134#define KEYFLAG_DISABLED (1 << 10)
135#define KEYFLAG_SUBKEY (1 << 11)
136#define KEYFLAG_CRITICAL (1 << 12)
137#define KEYFLAG_PREFER_ENCRYPTION (1 << 13)
138#define KEYFLAG_PREFER_SIGNING (1 << 14)
139
140#define KEYFLAG_CANTUSE (KEYFLAG_DISABLED | KEYFLAG_REVOKED | KEYFLAG_EXPIRED)
141#define KEYFLAG_RESTRICTIONS (KEYFLAG_CANTUSE | KEYFLAG_CRITICAL)
142
143#define KEYFLAG_ABILITIES (KEYFLAG_CANSIGN | KEYFLAG_CANENCRYPT | KEYFLAG_PREFER_ENCRYPTION | KEYFLAG_PREFER_SIGNING)
144
145/* crypt.c */
146void crypt_extract_keys_from_messages (struct Mailbox *m, struct EmailArray *ea);
147void crypt_forget_passphrase (void);
148int crypt_get_keys (struct Email *e, char **keylist, bool oppenc_mode);
149void crypt_opportunistic_encrypt (struct Email *e);
150SecurityFlags crypt_query (struct Body *b);
158int mutt_protected_headers_handler (struct Body *b, struct State *state);
159int mutt_protect (struct Email *e, char *keylist, bool postpone);
161int mutt_signed_handler (struct Body *b, struct State *state);
162
163/* cryptglue.c */
164void crypt_cleanup (void);
166void crypt_init (void);
168int crypt_pgp_application_handler (struct Body *b_email, struct State *state);
169bool crypt_pgp_check_traditional (FILE *fp, struct Body *b, bool just_one);
170int crypt_pgp_decrypt_mime (FILE *fp_in, FILE **fp_out, struct Body *b, struct Body **b_dec);
171int crypt_pgp_encrypted_handler (struct Body *b_email, struct State *state);
172void crypt_pgp_extract_key_from_attachment (FILE *fp, struct Body *b);
173void crypt_pgp_invoke_getkeys (struct Address *addr);
174struct Body * crypt_pgp_make_key_attachment (void);
176int crypt_smime_application_handler (struct Body *b_email, struct State *state);
177int crypt_smime_decrypt_mime (FILE *fp_in, FILE **fp_out, struct Body *b, struct Body **b_dec);
178void crypt_smime_getkeys (struct Envelope *env);
180int crypt_smime_verify_sender (struct Email *e, struct Message *msg);
181
182/* crypt_mod.c */
183void crypto_module_cleanup (void);
184
185#ifdef CRYPT_BACKEND_GPGME
186/* crypt_gpgme.c */
187void pgp_gpgme_init (void);
188#ifdef USE_AUTOCRYPT
189int mutt_gpgme_select_secret_key (struct Buffer *keyid);
190#endif
191const char * mutt_gpgme_print_version (void);
192#endif
193
194#endif /* MUTT_NCRYPT_LIB_H */
void pgp_gpgme_init(void)
Initialise the crypto module - Implements CryptModuleSpecs::init() -.
Definition: crypt_gpgme.c:3749
int crypt_pgp_application_handler(struct Body *b_email, struct State *state)
Wrapper for CryptModuleSpecs::application_handler() - Implements handler_t -.
Definition: cryptglue.c:237
int crypt_smime_application_handler(struct Body *b_email, struct State *state)
Wrapper for CryptModuleSpecs::application_handler() - Implements handler_t -.
Definition: cryptglue.c:444
int crypt_pgp_encrypted_handler(struct Body *b_email, struct State *state)
Wrapper for CryptModuleSpecs::encrypted_handler() - Implements handler_t -.
Definition: cryptglue.c:248
int mutt_protected_headers_handler(struct Body *b, struct State *state)
Handler for protected headers - Implements handler_t -.
Definition: crypt.c:1106
int mutt_signed_handler(struct Body *b, struct State *state)
Handler for "multipart/signed" - Implements handler_t -.
Definition: crypt.c:1136
bool crypt_has_module_backend(SecurityFlags type)
Is there a crypto backend for a given type?
Definition: cryptglue.c:171
SecurityFlags mutt_is_application_pgp(struct Body *b)
Does the message use PGP?
Definition: crypt.c:537
void crypt_invoke_message(SecurityFlags type)
Display an informative message.
Definition: cryptglue.c:157
uint16_t SecurityFlags
Flags, e.g. SEC_ENCRYPT.
Definition: lib.h:77
int crypt_pgp_decrypt_mime(FILE *fp_in, FILE **fp_out, struct Body *b, struct Body **b_dec)
Wrapper for CryptModuleSpecs::decrypt_mime()
Definition: cryptglue.c:211
void crypt_opportunistic_encrypt(struct Email *e)
Can all recipients be determined.
Definition: crypt.c:1034
int mutt_gpgme_select_secret_key(struct Buffer *keyid)
Select a private Autocrypt key for a new account.
Definition: crypt_gpgme.c:3568
const char * mutt_gpgme_print_version(void)
Get version of GPGME.
Definition: crypt_gpgme.c:4047
SecurityFlags mutt_is_multipart_signed(struct Body *b)
Is a message signed?
Definition: crypt.c:397
void crypt_cleanup(void)
Clean up backend.
Definition: cryptglue.c:142
void crypt_smime_getkeys(struct Envelope *env)
Wrapper for CryptModuleSpecs::smime_getkeys()
Definition: cryptglue.c:455
SecurityFlags mutt_is_application_smime(struct Body *b)
Does the message use S/MIME?
Definition: crypt.c:598
bool crypt_valid_passphrase(SecurityFlags flags)
Check that we have a usable passphrase, ask if not.
Definition: crypt.c:135
int mutt_is_valid_multipart_pgp_encrypted(struct Body *b)
Is this a valid multi-part encrypted message?
Definition: crypt.c:456
bool mutt_should_hide_protected_subject(struct Email *e)
Should NeoMutt hide the protected subject?
Definition: crypt.c:1089
uint16_t KeyFlags
Flags describing PGP/SMIME keys, e.g. KEYFLAG_CANSIGN.
Definition: lib.h:126
bool crypt_pgp_check_traditional(FILE *fp, struct Body *b, bool just_one)
Wrapper for CryptModuleSpecs::pgp_check_traditional()
Definition: cryptglue.c:283
void crypto_module_cleanup(void)
Clean up the crypto modules.
Definition: crypt_mod.c:83
struct Body * crypt_pgp_make_key_attachment(void)
Wrapper for CryptModuleSpecs::pgp_make_key_attachment()
Definition: cryptglue.c:305
SecurityFlags crypt_smime_send_menu(struct Email *e)
Wrapper for CryptModuleSpecs::send_menu()
Definition: cryptglue.c:528
void crypt_extract_keys_from_messages(struct Mailbox *m, struct EmailArray *ea)
Extract keys from a message.
Definition: crypt.c:847
SecurityFlags crypt_pgp_send_menu(struct Email *e)
Wrapper for CryptModuleSpecs::send_menu()
Definition: cryptglue.c:384
void crypt_pgp_invoke_getkeys(struct Address *addr)
Wrapper for CryptModuleSpecs::pgp_invoke_getkeys()
Definition: cryptglue.c:274
SecurityFlags mutt_is_multipart_encrypted(struct Body *b)
Does the message have encrypted parts?
Definition: crypt.c:432
int mutt_protect(struct Email *e, char *keylist, bool postpone)
Encrypt and/or sign a message.
Definition: crypt.c:160
void crypt_forget_passphrase(void)
Forget a passphrase and display a message.
Definition: crypt.c:93
void crypt_pgp_extract_key_from_attachment(FILE *fp, struct Body *b)
Wrapper for CryptModuleSpecs::pgp_extract_key_from_attachment()
Definition: cryptglue.c:395
int crypt_smime_verify_sender(struct Email *e, struct Message *msg)
Wrapper for CryptModuleSpecs::smime_verify_sender()
Definition: cryptglue.c:464
SecurityFlags mutt_is_malformed_multipart_pgp_encrypted(struct Body *b)
Check for malformed layout.
Definition: crypt.c:493
int crypt_smime_decrypt_mime(FILE *fp_in, FILE **fp_out, struct Body *b, struct Body **b_dec)
Wrapper for CryptModuleSpecs::decrypt_mime()
Definition: cryptglue.c:433
void crypt_init(void)
Initialise the crypto backends.
Definition: cryptglue.c:94
int crypt_get_keys(struct Email *e, char **keylist, bool oppenc_mode)
Check we have all the keys we need.
Definition: crypt.c:950
SecurityFlags crypt_query(struct Body *b)
Check out the type of encryption used.
Definition: crypt.c:676
An email address.
Definition: address.h:36
The body of an email.
Definition: body.h:36
String manipulation buffer.
Definition: buffer.h:34
The envelope/body of an email.
Definition: email.h:37
The header of an Email.
Definition: envelope.h:57
A mailbox.
Definition: mailbox.h:79
A local copy of an email.
Definition: message.h:34
Keep track when processing files.
Definition: state.h:47
StateFlags flags
Flags, e.g. STATE_DISPLAY.
Definition: state.h:51
FILE * fp_out
File to write to.
Definition: state.h:49
FILE * fp_in
File to read from.
Definition: state.h:48