path: root/pgp.h

/* $Id$ */
/*
 * Copyright (C) 1996,1997 Michael R. Elkins <me@cs.hmc.edu>
 * 
 *     This program is free software; you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation; either version 2 of the License, or
 *     (at your option) any later version.
 * 
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 * 
 *     You should have received a copy of the GNU General Public License
 *     along with this program; if not, write to the Free Software
 *     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */ 

#ifdef _PGPPATH

#define PGPENCRYPT 1
#define PGPSIGN    2
#define PGPKEY     4

#define KEYFLAG_CANSIGN (1 << 0)
#define KEYFLAG_CANENCRYPT (1 << 1)
#define KEYFLAG_EXPIRED (1 << 8)
#define KEYFLAG_REVOKED (1 << 9)
#define KEYFLAG_DISABLED (1 << 10)
#define KEYFLAG_SUBKEY (1 << 11)
#define KEYFLAG_CRITICAL (1 << 12)
#define KEYFLAG_PREFER_ENCRYPTION (1 << 13)
#define KEYFLAG_PREFER_SIGNING (1 << 14)

typedef struct keyinfo
{
  char *keyid;
  LIST *address;
  short flags;
  short keylen;
  unsigned long gen_time;
  const char *algorithm;
  struct keyinfo *mainkey;
  struct keyinfo *next;
} KEYINFO;

typedef struct pgp_uid
{
  char *addr;
  short trust;
} PGPUID;

enum pgp_version 
{
  PGP_V2, 
  PGP_V3,
  PGP_GPG,
  PGP_UNKNOWN
};

enum pgp_ops
{
  PGP_DECODE,		/* application/pgp */
  PGP_VERIFY,		/* PGP/MIME, signed */
  PGP_DECRYPT,		/* PGP/MIME, encrypted */
  PGP_SIGN,		/* sign data */
  PGP_ENCRYPT,		/* encrypt data */
  PGP_IMPORT,		/* extract keys from messages */
  PGP_VERIFY_KEY,	/* verify key when selecting */
  PGP_EXPORT,		/* extract keys from key ring */
  PGP_LAST_OP
};

struct pgp_vinfo
{
  
  /* data */
  
  enum pgp_version v;
  char *name;
  char **binary;
  char **pubring;
  char **secring;
  char **language;
  
  /* functions */
  
  KEYINFO * (*read_pubring)(struct pgp_vinfo *);
  KEYINFO * (*read_secring)(struct pgp_vinfo *);
  
  pid_t (*invoke_decode)(struct pgp_vinfo *, FILE **, FILE **, FILE **,
		      int, int, int,
		      const char *, int);
  
  pid_t (*invoke_verify)(struct pgp_vinfo *, FILE **, FILE **, FILE **,
		      int, int, int,
		      const char *, const char *);
  
  pid_t (*invoke_decrypt)(struct pgp_vinfo *, FILE **, FILE **, FILE **,
		       int, int, int,
		       const char *);
  
  pid_t (*invoke_sign)(struct pgp_vinfo *, FILE **, FILE **, FILE **,
		    int, int, int,
		    const char *);

  pid_t (*invoke_encrypt)(struct pgp_vinfo *, FILE **, FILE **, FILE **,
		       int, int, int,
		       const char *, const char *, int);
  
  void (*invoke_import)(struct pgp_vinfo *, const char *);
  
  pid_t (*invoke_export)(struct pgp_vinfo *, FILE **, FILE **, FILE **,
		      int, int, int,
		      const char *);
  
  pid_t (*invoke_verify_key)(struct pgp_vinfo *, FILE **, FILE **, FILE **,
			  int, int, int,
			  const char *);
  
};


WHERE char *PgpV2;
WHERE char *PgpV2Language;
WHERE char *PgpV2Pubring;
WHERE char *PgpV2Secring;

WHERE char *PgpV3;
WHERE char *PgpV3Language;
WHERE char *PgpV3Pubring;
WHERE char *PgpV3Secring;

WHERE char *PgpGpg;
#if 0
WHERE char *PgpGpgLanguage;
WHERE char *PgpGpgPubring;
WHERE char *PgpGpgSecring;
#else
WHERE char *PgpGpgDummy;
#endif

WHERE char *PgpSendVersion;
WHERE char *PgpReceiveVersion;
WHERE char *PgpKeyVersion;
WHERE char *PgpDefaultVersion;

WHERE char *PgpSignAs;
WHERE char *PgpSignMicalg;

WHERE short PgpTimeout;



BODY *pgp_decrypt_part (BODY *, STATE *, FILE *);
BODY *pgp_make_key_attachment (char *);

const char *pgp_pkalg_to_mic(const char *);

char *pgp_ask_for_key (struct pgp_vinfo *, KEYINFO *, char *, char *, short, char **);
char *pgp_keyid(KEYINFO *);
char *_pgp_keyid(KEYINFO *);

struct pgp_vinfo *pgp_get_vinfo(enum pgp_ops);

int mutt_check_pgp (HEADER *h);
int mutt_parse_pgp_hdr (char *, int);

int mutt_is_multipart_encrypted(BODY *);
int mutt_is_multipart_signed(BODY *);
int mutt_is_application_pgp(BODY *);

int pgp_decrypt_mime (FILE *, FILE **, BODY *, BODY **);
int pgp_get_keys (HEADER *, char **);
int pgp_protect (HEADER *, char *);
int pgp_query (BODY *);
int pgp_valid_passphrase (void);

KEYINFO *ki_getkeybyaddr (struct pgp_vinfo *pgp, ADDRESS *, KEYINFO *, short);
KEYINFO *ki_getkeybystr (struct pgp_vinfo *pgp, char *, KEYINFO *, short);
KEYINFO *pgp_read_pubring(struct pgp_vinfo *pgp);
KEYINFO *pgp_read_secring(struct pgp_vinfo *pgp);
KEYINFO *gpg_read_pubring(struct pgp_vinfo *pgp);
KEYINFO *gpg_read_secring(struct pgp_vinfo *pgp);

void application_pgp_handler (BODY *, STATE *);
void mutt_forget_passphrase (void);
void pgp_close_keydb (KEYINFO **);
void pgp_encrypted_handler (BODY *, STATE *);
void pgp_extract_keys_from_attachment_list (FILE *fp, int tag, BODY *top);
void pgp_extract_keys_from_messages(HEADER *hdr);
void pgp_signed_handler (BODY *, STATE *);
void pgp_void_passphrase (void);

short pgp_canencrypt(unsigned char);
short pgp_cansign(unsigned char);
short pgp_get_abilities(unsigned char);
const char *pgp_pkalgbytype(unsigned char);

#define pgp_secring(a) pgp_getring(a, 0)
#define pgp_pubring(a) pgp_getring(a, 1)

/* PGP V2 prototypes */


pid_t pgp_v2_invoke_decode(struct pgp_vinfo *,
				FILE **, FILE **, FILE **,
				int, int, int,
				const char *, int);

pid_t pgp_v2_invoke_verify(struct pgp_vinfo *,
				FILE **, FILE **, FILE **,
				int, int, int,
				const char *, const char *);


pid_t pgp_v2_invoke_decrypt(struct pgp_vinfo *,
				 FILE **, FILE **, FILE **,
				 int, int, int,
				 const char *);

pid_t pgp_v2_invoke_sign(struct pgp_vinfo *, 
			      FILE **, FILE **, FILE **,
			      int, int, int,
			      const char *);

pid_t pgp_v2_invoke_encrypt(struct pgp_vinfo *,
				 FILE **, FILE **, FILE **,
				 int, int, int,
				 const char *, const char *, int);

void pgp_v2_invoke_import(struct pgp_vinfo *, const char *);

pid_t pgp_v2_invoke_export(struct pgp_vinfo*, 
				FILE **, FILE **, FILE **,
				int, int, int,
				const char *);

pid_t pgp_v2_invoke_verify_key(struct pgp_vinfo *,
				    FILE **, FILE **, FILE **,
				    int, int, int,
				    const char *);

/* PGP V3 prototypes */

pid_t pgp_v3_invoke_decode(struct pgp_vinfo *,
				FILE **, FILE **, FILE **,
				int, int, int,
				const char *, int);

pid_t pgp_v3_invoke_verify(struct pgp_vinfo *,
				FILE **, FILE **, FILE **,
				int, int, int,
				const char *, const char *);