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 <lib-mime/mime.h>
22 /* FIXME: They should be pointer to anonymous structures for better
23 information hiding. */
26 #define ENCRYPT (1 << 0)
28 #define GOODSIGN (1 << 2)
29 #define BADSIGN (1 << 3)
30 #define PARTSIGN (1 << 4)
31 #define SIGNOPAQUE (1 << 5)
32 #define KEYBLOCK (1 << 6) /* KEY too generic? */
33 #define INLINE (1 << 7)
35 #define APPLICATION_PGP (1 << 8)
36 #define APPLICATION_SMIME (1 << 9)
38 #define PGP_TRADITIONAL_CHECKED (1 << 10)
40 #define PGPENCRYPT (APPLICATION_PGP | ENCRYPT)
41 #define PGPSIGN (APPLICATION_PGP | SIGN)
42 #define PGPGOODSIGN (APPLICATION_PGP | GOODSIGN)
43 #define PGPKEY (APPLICATION_PGP | KEYBLOCK)
44 #define PGPINLINE (APPLICATION_PGP | INLINE)
46 #define SMIMEENCRYPT (APPLICATION_SMIME | ENCRYPT)
47 #define SMIMESIGN (APPLICATION_SMIME | SIGN)
48 #define SMIMEGOODSIGN (APPLICATION_SMIME | GOODSIGN)
49 #define SMIMEBADSIGN (APPLICATION_SMIME | BADSIGN)
50 #define SMIMEOPAQUE (APPLICATION_SMIME | SIGNOPAQUE)
52 #define KEYFLAG_CANSIGN (1 << 0)
53 #define KEYFLAG_CANENCRYPT (1 << 1)
54 #define KEYFLAG_ISX509 (1 << 2)
55 #define KEYFLAG_SECRET (1 << 7)
56 #define KEYFLAG_EXPIRED (1 << 8)
57 #define KEYFLAG_REVOKED (1 << 9)
58 #define KEYFLAG_DISABLED (1 << 10)
59 #define KEYFLAG_SUBKEY (1 << 11)
60 #define KEYFLAG_CRITICAL (1 << 12)
61 #define KEYFLAG_PREFER_ENCRYPTION (1 << 13)
62 #define KEYFLAG_PREFER_SIGNING (1 << 14)
64 #define KEYFLAG_CANTUSE (KEYFLAG_DISABLED|KEYFLAG_REVOKED|KEYFLAG_EXPIRED)
65 #define KEYFLAG_RESTRICTIONS (KEYFLAG_CANTUSE|KEYFLAG_CRITICAL)
67 #define KEYFLAG_ABILITIES (KEYFLAG_CANSIGN|KEYFLAG_CANENCRYPT|KEYFLAG_PREFER_ENCRYPTION|KEYFLAG_PREFER_SIGNING)
73 typedef enum pgp_ring pgp_ring_t;
77 typedef struct pgp_keyinfo *pgp_key_t;
81 /* Some prototypes -- old crypt.h. */
83 int mutt_protect (HEADER *, char *);
85 int mutt_signed_handler (BODY *, STATE *);
87 int mutt_parse_crypt_hdr (char *, int);
89 void convert_to_7bit (BODY *);
94 /* Print the current time. */
95 void crypt_current_time (STATE * s, const char *app_name);
97 /* Check out the type of encryption used and set the cached status
98 values if there are any. */
99 int crypt_query (BODY * m);
101 /* Fixme: To be documented. */
102 void crypt_extract_keys_from_messages (HEADER * h);
104 /* Do a quick check to make sure that we can find all of the
105 encryption keys if the user has requested this service.
106 Return the list of keys in KEYLIST. */
107 int crypt_get_keys (HEADER * msg, char **keylist);
109 /* Forget a passphrase and display a message. */
110 void crypt_forget_passphrase (void);
112 /* Check that we have a usable passphrase, ask if not. */
113 int crypt_valid_passphrase (int);
116 /*-- cryptglue.c --*/
118 /* Show a message that a backend will be invoked. */
119 void crypt_invoke_message (int type);
122 /* Silently forget about a passphrase. */
123 void crypt_pgp_void_passphrase (void);
125 int crypt_pgp_valid_passphrase (void);
128 /* Decrypt a PGP/MIME message. */
129 int crypt_pgp_decrypt_mime (FILE * a, FILE ** b, BODY * c, BODY ** d);
131 /* MIME handler for the application/pgp content-type. */
132 int crypt_pgp_application_pgp_handler (BODY * m, STATE * s);
134 /* MIME handler for an PGP/MIME encrypted message. */
135 int crypt_pgp_encrypted_handler (BODY * a, STATE * s);
137 /* fixme: needs documentation. */
138 void crypt_pgp_invoke_getkeys (address_t * addr);
140 /* Ask for a PGP key. */
141 pgp_key_t crypt_pgp_ask_for_key (char *tag, char *whatfor,
142 short abilities, pgp_ring_t keyring);
144 /* Check for a traditional PGP message in body B. */
145 int crypt_pgp_check_traditional (FILE * fp, BODY * b, int tagged_only);
147 /* fixme: needs documentation. */
148 BODY *crypt_pgp_traditional_encryptsign (BODY * a, int flags, char *keylist);
150 /* Release the PGP key KPP (note, that we pass a pointer to it). */
151 void crypt_pgp_free_key (pgp_key_t * kpp);
153 /* Generate a PGP public key attachment. */
154 BODY *crypt_pgp_make_key_attachment (char *tempf);
156 /* This routine attempts to find the keyids of the recipients of a
157 message. It returns NULL if any of the keys can not be found. */
158 char *crypt_pgp_findkeys (address_t * to, address_t * cc, address_t * bcc);
160 /* Create a new body with a PGP signed message from A. */
161 BODY *crypt_pgp_sign_message (BODY * a);
163 /* Warning: A is no longer freed in this routine, you need to free it
164 later. This is necessary for $fcc_attach. */
165 BODY *crypt_pgp_encrypt_message (BODY * a, char *keylist, int sign);
167 /* Invoke the PGP command to import a key. */
168 void crypt_pgp_invoke_import (const char *fname);
170 int crypt_pgp_send_menu (HEADER * msg, int *redraw);
172 /* fixme: needs documentation */
173 int crypt_pgp_verify_one (BODY * sigbdy, STATE * s, const char *tempf);
175 /* Access the keyID in K. */
176 char *crypt_pgp_keyid (pgp_key_t k);
178 /* fixme: needs documentation */
179 void crypt_pgp_extract_keys_from_attachment_list (FILE * fp, int tag,
186 /* Silently forget about a passphrase. */
187 void crypt_smime_void_passphrase (void);
189 int crypt_smime_valid_passphrase (void);
191 /* Decrypt an S/MIME message. */
192 int crypt_smime_decrypt_mime (FILE * a, FILE ** b, BODY * c, BODY ** d);
194 /* MIME handler for the application/smime content-type. */
195 int crypt_smime_application_smime_handler (BODY * m, STATE * s);
197 /* fixme: Needs documentation. */
198 void crypt_smime_getkeys (ENVELOPE * env);
200 /* Check that the sender matches. */
201 int crypt_smime_verify_sender (HEADER * h);
203 /* Ask for an SMIME key. */
204 char *crypt_smime_ask_for_key (char *prompt, char *mailbox, short public);
206 /* This routine attempts to find the keyids of the recipients of a
207 message. It returns NULL if any of the keys can not be found. */
208 char *crypt_smime_findkeys (address_t * to, address_t * cc, address_t * bcc);
210 /* fixme: Needs documentation. */
211 BODY *crypt_smime_sign_message (BODY * a);
213 /* fixme: needs documentation. */
214 BODY *crypt_smime_build_smime_entity (BODY * a, char *certlist);
216 /* Add a certificate and update index file (externally). */
217 void crypt_smime_invoke_import (char *infile, char *mailbox);
219 int crypt_smime_send_menu (HEADER * msg, int *redraw);
221 /* fixme: needs documentation */
222 int crypt_smime_verify_one (BODY * sigbdy, STATE * s, const char *tempf);
224 void crypt_init (void);
226 #endif /*MUTT_CRYPT_H */