lib.h

Go to the documentation of this file.

 
#ifndef MUTT_NCRYPT_LIB_H
#define MUTT_NCRYPT_LIB_H
 
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
 
struct Address;
struct Body;
#ifdef USE_AUTOCRYPT
struct Buffer;
#endif
struct Email;
struct EmailArray;
struct Envelope;
struct Mailbox;
struct Message;
struct NcryptModuleData;
struct NeoMutt;
struct State;
struct SubMenu;

enum SecurityFlag
{
  SEC_NONE               =       0,  
  SEC_ENCRYPT            = 1U << 0,  
  SEC_SIGN               = 1U << 1,  
  SEC_GOODSIGN           = 1U << 2,  
  SEC_BADSIGN            = 1U << 3,  
  SEC_PARTSIGN           = 1U << 4,  
  SEC_SIGNOPAQUE         = 1U << 5,  
  SEC_KEYBLOCK           = 1U << 6,  
  SEC_INLINE             = 1U << 7,  
  SEC_OPPENCRYPT         = 1U << 8,  
  SEC_AUTOCRYPT          = 1U << 9,  
  SEC_AUTOCRYPT_OVERRIDE = 1U << 10, 
};
typedef uint16_t SecurityFlags;
 
#define APPLICATION_PGP         (1 << 11) 
#define APPLICATION_SMIME       (1 << 12) 
#define PGP_TRADITIONAL_CHECKED (1 << 13) 
 
#define SEC_ALL_FLAGS          ((1 << 14) - 1)              
 
#define PGP_ENCRYPT  (APPLICATION_PGP | SEC_ENCRYPT)        
#define PGP_SIGN     (APPLICATION_PGP | SEC_SIGN)           
#define PGP_GOODSIGN (APPLICATION_PGP | SEC_GOODSIGN)       
#define PGP_KEY      (APPLICATION_PGP | SEC_KEYBLOCK)       
#define PGP_INLINE   (APPLICATION_PGP | SEC_INLINE)         
 
#define SMIME_ENCRYPT  (APPLICATION_SMIME | SEC_ENCRYPT)    
#define SMIME_SIGN     (APPLICATION_SMIME | SEC_SIGN)       
#define SMIME_GOODSIGN (APPLICATION_SMIME | SEC_GOODSIGN)   
#define SMIME_BADSIGN  (APPLICATION_SMIME | SEC_BADSIGN)    
#define SMIME_OPAQUE   (APPLICATION_SMIME | SEC_SIGNOPAQUE) 
 
/* WITHCRYPTO actually replaces ifdefs to make the code more readable.
 * Because it is defined as a constant and known at compile time, the
 * compiler can do dead code elimination and thus it behaves
 * effectively as a conditional compile directive. It is set to false
 * if no crypto backend is configured or to a bit vector denoting the
 * configured backends. */
#if (defined(CRYPT_BACKEND_CLASSIC_PGP) && defined(CRYPT_BACKEND_CLASSIC_SMIME)) || \
    defined(CRYPT_BACKEND_GPGME)
#define WithCrypto (APPLICATION_PGP | APPLICATION_SMIME)
#elif defined(CRYPT_BACKEND_CLASSIC_PGP)
#define WithCrypto APPLICATION_PGP
#elif defined(CRYPT_BACKEND_CLASSIC_SMIME)
#define WithCrypto APPLICATION_SMIME
#else
#define WithCrypto 0
#endif

enum KeyFlag
{
  KEYFLAG_NONE              =        0,  
  KEYFLAG_CANSIGN           = 1U <<  0,  
  KEYFLAG_CANENCRYPT        = 1U <<  1,  
  KEYFLAG_ISX509            = 1U <<  2,  
  KEYFLAG_SECRET            = 1U <<  7,  
  KEYFLAG_EXPIRED           = 1U <<  8,  
  KEYFLAG_REVOKED           = 1U <<  9,  
  KEYFLAG_DISABLED          = 1U << 10,  
  KEYFLAG_SUBKEY            = 1U << 11,  
  KEYFLAG_CRITICAL          = 1U << 12,  
  KEYFLAG_PREFER_ENCRYPTION = 1U << 13,  
  KEYFLAG_PREFER_SIGNING    = 1U << 14,  
};
typedef uint16_t KeyFlags;
 
#define KEYFLAG_CANTUSE (KEYFLAG_DISABLED | KEYFLAG_REVOKED | KEYFLAG_EXPIRED)
#define KEYFLAG_RESTRICTIONS (KEYFLAG_CANTUSE | KEYFLAG_CRITICAL)
 
#define KEYFLAG_ABILITIES (KEYFLAG_CANSIGN | KEYFLAG_CANENCRYPT | KEYFLAG_PREFER_ENCRYPTION | KEYFLAG_PREFER_SIGNING)
 
void pgp_init_keys(struct NeoMutt *n, struct SubMenu *sm_generic);
 
/* crypt.c */
void          crypt_extract_keys_from_messages         (struct Mailbox *m, struct EmailArray *ea);
void          crypt_forget_passphrase                  (void);
int           crypt_get_keys                           (struct Email *e, char **keylist, bool oppenc_mode);
void          crypt_opportunistic_encrypt              (struct Email *e);
SecurityFlags crypt_query                              (struct Body *b);
bool          crypt_valid_passphrase                   (SecurityFlags flags);
SecurityFlags mutt_is_application_pgp                  (const struct Body *b);
SecurityFlags mutt_is_application_smime                (struct Body *b);
SecurityFlags mutt_is_malformed_multipart_pgp_encrypted(struct Body *b);
SecurityFlags mutt_is_multipart_encrypted              (struct Body *b);
SecurityFlags mutt_is_multipart_signed                 (struct Body *b);
int           mutt_is_valid_multipart_pgp_encrypted    (struct Body *b);
int           mutt_protected_headers_handler           (struct Body *b, struct State *state);
int           mutt_protect                             (struct Email *e, char *keylist, bool postpone);
bool          mutt_should_hide_protected_subject       (struct Email *e);
int           mutt_signed_handler                      (struct Body *b, struct State *state);
 
/* cryptglue.c */
void          crypt_cleanup                            (struct NcryptModuleData *mod_data);
bool          crypt_has_module_backend                 (SecurityFlags type);
void          crypt_init                               (void);
void          crypt_invoke_message                     (SecurityFlags type);
int           crypt_pgp_application_handler            (struct Body *b_email, struct State *state);
bool          crypt_pgp_check_traditional              (FILE *fp, struct Body *b, bool just_one);
int           crypt_pgp_decrypt_mime                   (FILE *fp_in, FILE **fp_out, struct Body *b, struct Body **b_dec);
int           crypt_pgp_encrypted_handler              (struct Body *b_email, struct State *state);
void          crypt_pgp_extract_key_from_attachment    (FILE *fp, struct Body *b);
void          crypt_pgp_invoke_getkeys                 (struct Address *addr);
struct Body * crypt_pgp_make_key_attachment            (void);
SecurityFlags crypt_pgp_send_menu                      (struct Email *e);
int           crypt_smime_application_handler          (struct Body *b_email, struct State *state);
int           crypt_smime_decrypt_mime                 (FILE *fp_in, FILE **fp_out, struct Body *b, struct Body **b_dec);
void          crypt_smime_getkeys                      (struct Envelope *env);
SecurityFlags crypt_smime_send_menu                    (struct Email *e);
int           crypt_smime_verify_sender                (struct Email *e, struct Message *msg);
 
/* crypt_mod.c */
void          crypto_module_cleanup                    (struct NcryptModuleData *mod_data);
 
#ifdef CRYPT_BACKEND_GPGME
/* crypt_gpgme.c */
void          pgp_gpgme_init                           (void);
#ifdef USE_AUTOCRYPT
int          mutt_gpgme_select_secret_key              (struct Buffer *keyid);
#endif
const char  * mutt_gpgme_print_version                 (void);
#endif
 
#endif /* MUTT_NCRYPT_LIB_H */