2 * Copyright notice from original mutt:
3 * Copyright (C) 2003 Werner Koch <wk@gnupg.org>
4 * Copyright (C) 2004 g10code GmbH
6 * This file is part of mutt-ng, see http://www.muttng.org/.
7 * It's licensed under the GNU General Public License,
8 * please see the file GPL in the top level source directory.
12 Common definitions and prototypes for the crypt functions. They are
13 all defined in crypt.c and cryptglue.c
19 #include "mutt.h" /* Need this to declare BODY, ADDRESS. STATE etc. */
22 /* FIXME: They should be pointer to anonymous structures for better
23 information hiding. */
27 #define ENCRYPT (1 << 0)
29 #define GOODSIGN (1 << 2)
30 #define BADSIGN (1 << 3)
31 #define PARTSIGN (1 << 4)
32 #define SIGNOPAQUE (1 << 5)
33 #define KEYBLOCK (1 << 6) /* KEY too generic? */
34 #define INLINE (1 << 7)
36 #define APPLICATION_PGP (1 << 8)
37 #define APPLICATION_SMIME (1 << 9)
39 #define PGP_TRADITIONAL_CHECKED (1 << 10)
41 #define PGPENCRYPT (APPLICATION_PGP | ENCRYPT)
42 #define PGPSIGN (APPLICATION_PGP | SIGN)
43 #define PGPGOODSIGN (APPLICATION_PGP | GOODSIGN)
44 #define PGPKEY (APPLICATION_PGP | KEYBLOCK)
45 #define PGPINLINE (APPLICATION_PGP | INLINE)
47 #define SMIMEENCRYPT (APPLICATION_SMIME | ENCRYPT)
48 #define SMIMESIGN (APPLICATION_SMIME | SIGN)
49 #define SMIMEGOODSIGN (APPLICATION_SMIME | GOODSIGN)
50 #define SMIMEBADSIGN (APPLICATION_SMIME | BADSIGN)
51 #define SMIMEOPAQUE (APPLICATION_SMIME | SIGNOPAQUE)
54 /* WITHCRYPTO actually replaces ifdefs so make the code more readable.
55 Because it is defined as a constant and known at compile time, the
56 compiler can do dead code elimination and thus it behaves
57 effectively as a conditional compile directive. It is set to false
58 if no crypto backend is configures or to a bit vector denoting the
59 configured backends. */
60 #if (defined(CRYPT_BACKEND_CLASSIC_PGP) && defined(CRYPT_BACKEND_CLASSIC_SMIME)) || defined (CRYPT_BACKEND_GPGME)
61 # define WithCrypto (APPLICATION_PGP | APPLICATION_SMIME)
62 #elif defined(CRYPT_BACKEND_CLASSIC_PGP)
63 # define WithCrypto APPLICATION_PGP
64 #elif defined(CRYPT_BACKEND_CLASSIC_SMIME)
65 # define WithCrypto APPLICATION_SMIME
71 #define KEYFLAG_CANSIGN (1 << 0)
72 #define KEYFLAG_CANENCRYPT (1 << 1)
73 #define KEYFLAG_ISX509 (1 << 2)
74 #define KEYFLAG_SECRET (1 << 7)
75 #define KEYFLAG_EXPIRED (1 << 8)
76 #define KEYFLAG_REVOKED (1 << 9)
77 #define KEYFLAG_DISABLED (1 << 10)
78 #define KEYFLAG_SUBKEY (1 << 11)
79 #define KEYFLAG_CRITICAL (1 << 12)
80 #define KEYFLAG_PREFER_ENCRYPTION (1 << 13)
81 #define KEYFLAG_PREFER_SIGNING (1 << 14)
83 #define KEYFLAG_CANTUSE (KEYFLAG_DISABLED|KEYFLAG_REVOKED|KEYFLAG_EXPIRED)
84 #define KEYFLAG_RESTRICTIONS (KEYFLAG_CANTUSE|KEYFLAG_CRITICAL)
86 #define KEYFLAG_ABILITIES (KEYFLAG_CANSIGN|KEYFLAG_CANENCRYPT|KEYFLAG_PREFER_ENCRYPTION|KEYFLAG_PREFER_SIGNING)
92 typedef enum pgp_ring pgp_ring_t;
96 typedef struct pgp_keyinfo *pgp_key_t;
100 /* Some prototypes -- old crypt.h. */
102 int mutt_protect (HEADER *, char *);
104 int mutt_is_multipart_encrypted (BODY *);
106 int mutt_is_multipart_signed (BODY *);
108 int mutt_is_application_pgp (BODY *);
110 int mutt_is_application_smime (BODY *);
112 int mutt_signed_handler (BODY *, STATE *);
114 int mutt_parse_crypt_hdr (char *, int);
117 void convert_to_7bit (BODY *);
123 /* Print the current time. */
124 void crypt_current_time (STATE * s, const char *app_name);
126 /* Check out the type of encryption used and set the cached status
127 values if there are any. */
128 int crypt_query (BODY * m);
130 /* Fixme: To be documented. */
131 void crypt_extract_keys_from_messages (HEADER * h);
133 /* Do a quick check to make sure that we can find all of the
134 encryption keys if the user has requested this service.
135 Return the list of keys in KEYLIST. */
136 int crypt_get_keys (HEADER * msg, char **keylist);
138 /* Forget a passphrase and display a message. */
139 void crypt_forget_passphrase (void);
141 /* Check that we have a usable passphrase, ask if not. */
142 int crypt_valid_passphrase (int);
144 /* Write the message body/part A described by state S to a the given
146 int crypt_write_signed (BODY * a, STATE * s, const char *tempf);
150 /*-- cryptglue.c --*/
152 /* Show a message that a backend will be invoked. */
153 void crypt_invoke_message (int type);
156 /* Silently forget about a passphrase. */
157 void crypt_pgp_void_passphrase (void);
159 int crypt_pgp_valid_passphrase (void);
162 /* Decrypt a PGP/MIME message. */
163 int crypt_pgp_decrypt_mime (FILE * a, FILE ** b, BODY * c, BODY ** d);
165 /* MIME handler for the application/pgp content-type. */
166 int crypt_pgp_application_pgp_handler (BODY * m, STATE * s);
168 /* MIME handler for an PGP/MIME encrypted message. */
169 int crypt_pgp_encrypted_handler (BODY * a, STATE * s);
171 /* fixme: needs documentation. */
172 void crypt_pgp_invoke_getkeys (ADDRESS * addr);
174 /* Ask for a PGP key. */
175 pgp_key_t crypt_pgp_ask_for_key (char *tag, char *whatfor,
176 short abilities, pgp_ring_t keyring);
178 /* Check for a traditional PGP message in body B. */
179 int crypt_pgp_check_traditional (FILE * fp, BODY * b, int tagged_only);
181 /* fixme: needs documentation. */
182 BODY *crypt_pgp_traditional_encryptsign (BODY * a, int flags, char *keylist);
184 /* Release the PGP key KPP (note, that we pass a pointer to it). */
185 void crypt_pgp_free_key (pgp_key_t * kpp);
187 /* Generate a PGP public key attachment. */
188 BODY *crypt_pgp_make_key_attachment (char *tempf);
190 /* This routine attempts to find the keyids of the recipients of a
191 message. It returns NULL if any of the keys can not be found. */
192 char *crypt_pgp_findkeys (ADDRESS * to, ADDRESS * cc, ADDRESS * bcc);
194 /* Create a new body with a PGP signed message from A. */
195 BODY *crypt_pgp_sign_message (BODY * a);
197 /* Warning: A is no longer freed in this routine, you need to free it
198 later. This is necessary for $fcc_attach. */
199 BODY *crypt_pgp_encrypt_message (BODY * a, char *keylist, int sign);
201 /* Invoke the PGP command to import a key. */
202 void crypt_pgp_invoke_import (const char *fname);
204 int crypt_pgp_send_menu (HEADER * msg, int *redraw);
206 /* fixme: needs documentation */
207 int crypt_pgp_verify_one (BODY * sigbdy, STATE * s, const char *tempf);
209 /* Access the keyID in K. */
210 char *crypt_pgp_keyid (pgp_key_t k);
212 /* fixme: needs documentation */
213 void crypt_pgp_extract_keys_from_attachment_list (FILE * fp, int tag,
220 /* Silently forget about a passphrase. */
221 void crypt_smime_void_passphrase (void);
223 int crypt_smime_valid_passphrase (void);
225 /* Decrypt an S/MIME message. */
226 int crypt_smime_decrypt_mime (FILE * a, FILE ** b, BODY * c, BODY ** d);
228 /* MIME handler for the application/smime content-type. */
229 int crypt_smime_application_smime_handler (BODY * m, STATE * s);
231 /* fixme: Needs documentation. */
232 void crypt_smime_getkeys (ENVELOPE * env);
234 /* Check that the sender matches. */
235 int crypt_smime_verify_sender (HEADER * h);
237 /* Ask for an SMIME key. */
238 char *crypt_smime_ask_for_key (char *prompt, char *mailbox, short public);
240 /* This routine attempts to find the keyids of the recipients of a
241 message. It returns NULL if any of the keys can not be found. */
242 char *crypt_smime_findkeys (ADDRESS * to, ADDRESS * cc, ADDRESS * bcc);
244 /* fixme: Needs documentation. */
245 BODY *crypt_smime_sign_message (BODY * a);
247 /* fixme: needs documentation. */
248 BODY *crypt_smime_build_smime_entity (BODY * a, char *certlist);
250 /* Add a certificate and update index file (externally). */
251 void crypt_smime_invoke_import (char *infile, char *mailbox);
253 int crypt_smime_send_menu (HEADER * msg, int *redraw);
255 /* fixme: needs documentation */
256 int crypt_smime_verify_one (BODY * sigbdy, STATE * s, const char *tempf);
258 void crypt_init (void);
260 #endif /*MUTT_CRYPT_H */