lib-crypt/crypt.h

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 2003 Werner Koch <wk@gnupg.org>
   4  * Copyright (C) 2004 g10code GmbH
   5  *
   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.
   9  */
  10
  11 /*
  12    Common definitions and prototypes for the crypt functions. They are
  13    all defined in crypt.c and cryptglue.c
  14 */
  15
  16 #ifndef MUTT_CRYPT_H
  17 #define MUTT_CRYPT_H
  18
  19 #include <lib-mime/mime.h>
  20 #include "state.h"
  21
  22 /* FIXME: They should be pointer to anonymous structures for better
  23    information hiding. */
  24
  25
  26 #define ENCRYPT    (1 << 0)
  27 #define SIGN       (1 << 1)
  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)
  34
  35 #define APPLICATION_PGP    (1 << 8)
  36 #define APPLICATION_SMIME  (1 << 9)
  37
  38 #define PGP_TRADITIONAL_CHECKED (1 << 10)
  39
  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)
  45
  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)
  51
  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)
  63
  64 #define KEYFLAG_CANTUSE (KEYFLAG_DISABLED|KEYFLAG_REVOKED|KEYFLAG_EXPIRED)
  65 #define KEYFLAG_RESTRICTIONS (KEYFLAG_CANTUSE|KEYFLAG_CRITICAL)
  66
  67 #define KEYFLAG_ABILITIES (KEYFLAG_CANSIGN|KEYFLAG_CANENCRYPT|KEYFLAG_PREFER_ENCRYPTION|KEYFLAG_PREFER_SIGNING)
  68
  69 enum pgp_ring {
  70   PGP_PUBRING,
  71   PGP_SECRING
  72 };
  73 typedef enum pgp_ring pgp_ring_t;
  74
  75
  76 struct pgp_keyinfo;
  77 typedef struct pgp_keyinfo *pgp_key_t;
  78
  79
  80
  81 /* Some prototypes -- old crypt.h. */
  82
  83 int mutt_protect (HEADER *, char *);
  84
  85 int mutt_signed_handler (BODY *, STATE *);
  86
  87 int mutt_parse_crypt_hdr (char *, int);
  88
  89 void convert_to_7bit (BODY *);
  90
  91
  92 /*-- crypt.c --*/
  93
  94 /* Check out the type of encryption used and set the cached status
  95    values if there are any. */
  96 int crypt_query (BODY * m);
  97
  98 /* Fixme: To be documented. */
  99 void crypt_extract_keys_from_messages (HEADER * h);
 100
 101 /* Do a quick check to make sure that we can find all of the
 102    encryption keys if the user has requested this service.
 103    Return the list of keys in KEYLIST. */
 104 int crypt_get_keys (HEADER * msg, char **keylist);
 105
 106 /* Forget a passphrase and display a message. */
 107 void crypt_forget_passphrase (void);
 108
 109 /* Check that we have a usable passphrase, ask if not. */
 110 int crypt_valid_passphrase (int);
 111
 112
 113 /*-- cryptglue.c --*/
 114
 115 /* Show a message that a backend will be invoked. */
 116 void crypt_invoke_message (int type);
 117
 118 /* Decrypt a PGP/MIME message. */
 119 int crypt_pgp_decrypt_mime (FILE * a, FILE ** b, BODY * c, BODY ** d);
 120
 121 /* MIME handler for the application/pgp content-type. */
 122 int crypt_pgp_application_pgp_handler (BODY * m, STATE * s);
 123
 124 /* MIME handler for an PGP/MIME encrypted message. */
 125 int crypt_pgp_encrypted_handler (BODY * a, STATE * s);
 126
 127 /* fixme: needs documentation. */
 128 void crypt_pgp_invoke_getkeys (address_t * addr);
 129
 130 /* Ask for a PGP key. */
 131 pgp_key_t crypt_pgp_ask_for_key (char *tag, char *whatfor,
 132                                  short abilities, pgp_ring_t keyring);
 133
 134 /* Check for a traditional PGP message in body B. */
 135 int crypt_pgp_check_traditional (FILE * fp, BODY * b, int tagged_only);
 136
 137 /* Release the PGP key KPP (note, that we pass a pointer to it). */
 138 void crypt_pgp_free_key (pgp_key_t * kpp);
 139
 140 /* Generate a PGP public key attachment. */
 141 BODY *crypt_pgp_make_key_attachment (char *tempf);
 142
 143 /* This routine attempts to find the keyids of the recipients of a
 144    message.  It returns NULL if any of the keys can not be found.  */
 145 char *crypt_pgp_findkeys (address_t * to, address_t * cc, address_t * bcc);
 146
 147 /* Create a new body with a PGP signed message from A. */
 148 BODY *crypt_pgp_sign_message (BODY * a);
 149
 150 /* Warning: A is no longer freed in this routine, you need to free it
 151    later.  This is necessary for $fcc_attach. */
 152 BODY *crypt_pgp_encrypt_message (BODY * a, char *keylist, int sign);
 153
 154 void crypt_invoke_import(FILE *stream, int smime);
 155
 156 int crypt_pgp_send_menu (HEADER * msg, int *redraw);
 157
 158 /* fixme: needs documentation */
 159 int crypt_pgp_verify_one (BODY * sigbdy, STATE * s, const char *tempf);
 160
 161 /* Access the keyID in K. */
 162 char *crypt_pgp_keyid (pgp_key_t k);
 163
 164 /* fixme: needs documentation */
 165 void crypt_pgp_extract_keys_from_attachment_list (FILE * fp, int tag,
 166                                                   BODY * top);
 167
 168
 169 /* Decrypt an S/MIME message. */
 170 int crypt_smime_decrypt_mime (FILE * a, FILE ** b, BODY * c, BODY ** d);
 171
 172 /* MIME handler for the application/smime content-type. */
 173 int crypt_smime_application_smime_handler (BODY * m, STATE * s);
 174
 175 /* fixme: Needs documentation. */
 176 void crypt_smime_getkeys (ENVELOPE * env);
 177
 178 /* Check that the sender matches. */
 179 int crypt_smime_verify_sender (HEADER * h);
 180
 181 /* Ask for an SMIME key. */
 182 char *crypt_smime_ask_for_key (char *prompt, char *mailbox, short public);
 183
 184 /* This routine attempts to find the keyids of the recipients of a
 185    message.  It returns NULL if any of the keys can not be found.  */
 186 char *crypt_smime_findkeys (address_t * to, address_t * cc, address_t * bcc);
 187
 188 /* fixme: Needs documentation. */
 189 BODY *crypt_smime_sign_message (BODY * a);
 190
 191 /* fixme: needs documentation. */
 192 BODY *crypt_smime_build_smime_entity (BODY * a, char *certlist);
 193
 194 int crypt_smime_send_menu (HEADER * msg, int *redraw);
 195
 196 /* fixme: needs documentation */
 197 int crypt_smime_verify_one (BODY * sigbdy, STATE * s, const char *tempf);
 198
 199 #endif /*MUTT_CRYPT_H */