trunk/Include/wptGPG.h

/* wptGPG.h - GnuPG interface
 *      Copyright (C) 2000-2005 Timo Schulz
 *
 * This file is part of WinPT.
 *
 * WinPT 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.
 *  
 * WinPT 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 WinPT; if not, write to the Free Software Foundation, 
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 */

#ifndef WPT_GPG_H
#define WPT_GPG_H

#include "w32gpgme.h"
#include "wptNLS.h"


#define NO_STRICT 0

#define key_is_useable(key) (!(key)->revoked && !(key)->expired && !(key)->disabled)

enum {
    SETUP_KEYGEN    = 1,
    SETUP_IMPORT    = 2,
    SETUP_EXISTING  = 3
};

enum {
    GPG_CMD_DECRYPT = 0,
    GPG_CMD_SIGN    = 1
};

enum {
    KEYCACHE_PRV = 0,
    KEYCACHE_PUB = 1
};

enum {
    ENTRY_OPAQUE = 1,
    ENTRY_SINGLE = 2,
    ENTRY_MULTI  = 3,
    ENTRY_GROUP  = 4,
};

struct gpg_card_s;
typedef struct gpg_card_s * gpg_card_t;

/* GPG file association context. */
struct gpg_filetype {    
    const char *descr;
    const char *ext;
    int nicon;
};

/* Keycache refresh context. */
struct refresh_cache_s {
    int kr_reload;
    int kr_update;
    int tr_update;
};

struct gpg_option_s {
    struct gpg_option_s * next;
    char * name;
    char * val;
    unsigned int used:1;
    int type;  
};
typedef struct gpg_option_s * gpg_option_t;

struct gpg_member_s {
    struct gpg_member_s * next;
    char * name;
    unsigned int used:1;  
};
typedef struct gpg_member_s * gpg_member_t;

struct gpg_group_s {
    struct gpg_group_s * next;
    struct gpg_member_s * list;
    char * name;
    unsigned int used:1;  
};
typedef struct gpg_group_s * gpg_group_t;

struct gpg_optfile_s {
    struct gpg_option_s * list;
    struct gpg_group_s * grp;
};
typedef struct gpg_optfile_s * gpg_optfile_t;

static gpg_filetype gpg_filetypes[] = {
    {"GPG Detached Signature", ".sig", 1},
    {"GPG Encrypted Data",     ".gpg", 2},
    {"GPG Armored Data",       ".asc", 2},
    {0}
};

struct passphrase_cb_s {
    int gpg_cmd;
    int pwd_init;
    char *pwd;
    char info[1024]; /* hold up the info message */
    char *title;
    char keyid[16+1];
    HWND hwnd;
    int cancel;
    int is_card;
    gpgme_ctx_t gpg;
    struct {
        int sym_algo;
        int s2k_mode;
        int s2k_hash;
    } sym;
};


static const char * gpg_sigstat[] = {
    _("Error during verification process."),
    _("The signature is good."),
    _("The signature is BAD!"),
    _("The signature could not be checked due to a missing key."),
    _("No valid OpenPGP signature."),
    _("Signature Error"),
    _("Good Signature (Expired Key)"),
    _("Good Signature (Revoked Key)"),
    NULL
};

int sigsum_to_index (gpgme_sigsum_t sum);
#define SIGSTAT_MASK 8
#define get_gpg_sigstat(sum) gpg_sigstat[sigsum_to_index ((sum)) % SIGSTAT_MASK]

/* This variable is 1 if IDEA is available. */
extern int idea_available;

/*-- wptGPG.cpp --*/
char* get_gnupg_default_key( void );
int set_gnupg_default_key( const char *key );
char* get_gnupg_config (void);
char* get_gnupg_keyring_from_options( const char *fname, int pub );
int check_gnupg_config (const char *fname, int *secrings, int *pubrings);
char* get_gnupg_path( void );
int check_gnupg_prog( void );
int gnupg_access_files (void);
char* get_gnupg_prog( void );
char* get_gnupg_keyring (int pub, int strict);
char* get_gnupg_cfgfile (void);
int set_gnupg_options( const char *buf, size_t buflen );

int check_gnupg_options (const char *buf);
void init_gnupg_table (void);
void free_gnupg_table (void);
int keyring_check_last_access (void);
const char* gnupg_check_file_ext (const char * fname);
int gpg_check_permissions (int showmsg);
int gnupg_check_homedir (void);
int gnupg_access_keyring (int _pub);
void gnupg_backup_options ();
void gnupg_backup_keyrings (void);
void gnupg_display_error (void);
int gnupg_copy_keyrings (void);
int check_gnupg_engine (int *r_major, int *r_minor, int *r_patch);

gpg_card_t smartcard_init (void);

/*-- wptGPGME.cpp --*/
const char * get_signature_status( gpgme_sigsum_t sigstat );
void keycache_reload( HWND dlg );

int get_pubkey (const char *keyid, gpgme_key_t *ret_key);
int winpt_get_pubkey (const char *keyid, struct winpt_key_s *k);
int get_seckey (const char *keyid, gpgme_key_t *ret_skey);
int winpt_get_seckey (const char *keyid, struct winpt_key_s *k);

void keycache_reload( HWND dlg );
void keycache_release (int cleanup);
gpgme_error_t keycache_update (int is_sec, const char *keyid);
gpgme_error_t keycache_init( const char *pubring, const char * secring );
void keycache_set_reload( int yes );
int keycache_get_reload( void );
gpg_keycache_t keycache_get_ctx( int _pub );

int count_insecure_elgkeys (void);

int gpg_encrypt_symmetric (void);


/*-- wptGPGParser.cpp --*/
/* find */
gpg_group_t find_group( gpg_optfile_t opt, const char *str );
gpg_option_t find_option( gpg_optfile_t opt, const char *str );
gpg_member_t find_member( gpg_optfile_t opt, const char *grp, const char *str );
/* delete */
int delete_group( gpg_optfile_t opt, const char *str );
int delete_member( gpg_optfile_t opt, const char *grp, const char *str );
int delete_option( gpg_optfile_t opt, const char *str );
/* add */
int modify_entry( gpg_optfile_t opt, int type, const char *name, const char *val );
int add_entry( gpg_optfile_t opt, int type, const char *name, const char *val );
int add_member( gpg_optfile_t opt, const char *grp, const char *str );
int add_group( gpg_optfile_t opt, const char *str );
/* high-level */
int parse_gpg_options( const char *file, gpg_optfile_t *r_opt );
int commit_gpg_options( const char *file, gpg_optfile_t opt );
void release_gpg_options( gpg_optfile_t opt );
/* memory */
void release_group( gpg_group_t grp );

/*-- wptPassphraseCB.cpp --*/
enum {
    PASSDLG_REPEAT = 0,
    PASSDLG_INIT = 1,  
    PASSDLG_STRICT = 2
};

void set_gpg_passphrase_cb (passphrase_cb_s *cb, gpgme_ctx_t ctx,
                            int cmd, HWND hwnd, const char *title);
void release_gpg_passphrase_cb (passphrase_cb_s *cb);

char * request_passphrase (const char *title, int flags, int *ret_cancel);
char * request_passphrase2 (const char *title, int flags, int *ret_cancel);
const char * passphrase_cb (void *opaque, const char * desc, void *r_hd);
char * get_key_userid (const char *keyid);
int check_passwd_quality (const char *pass, int strict);

/*-- wptGPGUtil.cpp --*/
gpgme_error_t gpg_rebuild_cache (char **r_inf);
gpgme_error_t gpg_get_version (char **r_inf);
void          gpg_set_debug_mode (int val);
gpgme_error_t gpg_export_seckey (const char *keyid, const char *outfile);
gpgme_error_t gpg_manage_ownertrust (char **data, int export);

char*  generate_revoc_input (int code, const char *cmt, const char *pass);
gpgme_error_t gpg_revoke_key (const char *inp_data, 
                              const char *keyid,
                              char **r_revcert);
gpgme_error_t gpg_decode_c_string (const char *src, char **destp, size_t len);
gpgme_error_t gpg_import_key_list (const char *fname, char **r_out);

#endif /* WPT_GPG_H */
1	/* wptGPG.h - GnuPG interface
2	* Copyright (C) 2000-2005 Timo Schulz
3	*
4	* This file is part of WinPT.
5	*
6	* WinPT is free software; you can redistribute it and/or
7	* modify it under the terms of the GNU General Public License
8	* as published by the Free Software Foundation; either version 2
9	* of the License, or (at your option) any later version.
10	*
11	* WinPT is distributed in the hope that it will be useful,
12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14	* General Public License for more details.
15	*
16	* You should have received a copy of the GNU General Public License
17	* along with WinPT; if not, write to the Free Software Foundation,
18	* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19	*/
20
21	#ifndef WPT_GPG_H
22	#define WPT_GPG_H
23
24	#include "w32gpgme.h"
25	#include "wptNLS.h"
26
27
28	#define NO_STRICT 0
29
30	#define key_is_useable(key) (!(key)->revoked && !(key)->expired && !(key)->disabled)
31
32	enum {
33	SETUP_KEYGEN = 1,
34	SETUP_IMPORT = 2,
35	SETUP_EXISTING = 3
36	};
37
38	enum {
39	GPG_CMD_DECRYPT = 0,
40	GPG_CMD_SIGN = 1
41	};
42
43	enum {
44	KEYCACHE_PRV = 0,
45	KEYCACHE_PUB = 1
46	};
47
48	enum {
49	ENTRY_OPAQUE = 1,
50	ENTRY_SINGLE = 2,
51	ENTRY_MULTI = 3,
52	ENTRY_GROUP = 4,
53	};
54
55	struct gpg_card_s;
56	typedef struct gpg_card_s * gpg_card_t;
57
58	/* GPG file association context. */
59	struct gpg_filetype {
60	const char *descr;
61	const char *ext;
62	int nicon;
63	};
64
65	/* Keycache refresh context. */
66	struct refresh_cache_s {
67	int kr_reload;
68	int kr_update;
69	int tr_update;
70	};
71
72	struct gpg_option_s {
73	struct gpg_option_s * next;
74	char * name;
75	char * val;
76	unsigned int used:1;
77	int type;
78	};
79	typedef struct gpg_option_s * gpg_option_t;
80
81	struct gpg_member_s {
82	struct gpg_member_s * next;
83	char * name;
84	unsigned int used:1;
85	};
86	typedef struct gpg_member_s * gpg_member_t;
87
88	struct gpg_group_s {
89	struct gpg_group_s * next;
90	struct gpg_member_s * list;
91	char * name;
92	unsigned int used:1;
93	};
94	typedef struct gpg_group_s * gpg_group_t;
95
96	struct gpg_optfile_s {
97	struct gpg_option_s * list;
98	struct gpg_group_s * grp;
99	};
100	typedef struct gpg_optfile_s * gpg_optfile_t;
101
102	static gpg_filetype gpg_filetypes[] = {
103	{"GPG Detached Signature", ".sig", 1},
104	{"GPG Encrypted Data", ".gpg", 2},
105	{"GPG Armored Data", ".asc", 2},
106	{0}
107	};
108
109	struct passphrase_cb_s {
110	int gpg_cmd;
111	int pwd_init;
112	char *pwd;
113	char info[1024]; /* hold up the info message */
114	char *title;
115	char keyid[16+1];
116	HWND hwnd;
117	int cancel;
118	int is_card;
119	gpgme_ctx_t gpg;
120	struct {
121	int sym_algo;
122	int s2k_mode;
123	int s2k_hash;
124	} sym;
125	};
126
127
128	static const char * gpg_sigstat[] = {
129	_("Error during verification process."),
130	_("The signature is good."),
131	_("The signature is BAD!"),
132	_("The signature could not be checked due to a missing key."),
133	_("No valid OpenPGP signature."),
134	_("Signature Error"),
135	_("Good Signature (Expired Key)"),
136	_("Good Signature (Revoked Key)"),
137	NULL
138	};
139
140	int sigsum_to_index (gpgme_sigsum_t sum);
141	#define SIGSTAT_MASK 8
142	#define get_gpg_sigstat(sum) gpg_sigstat[sigsum_to_index ((sum)) % SIGSTAT_MASK]
143
144	/* This variable is 1 if IDEA is available. */
145	extern int idea_available;
146
147	/-- wptGPG.cpp --/
148	char* get_gnupg_default_key( void );
149	int set_gnupg_default_key( const char *key );
150	char* get_gnupg_config (void);
151	char* get_gnupg_keyring_from_options( const char *fname, int pub );
152	int check_gnupg_config (const char fname, int secrings, int *pubrings);
153	char* get_gnupg_path( void );
154	int check_gnupg_prog( void );
155	int gnupg_access_files (void);
156	char* get_gnupg_prog( void );
157	char* get_gnupg_keyring (int pub, int strict);
158	char* get_gnupg_cfgfile (void);
159	int set_gnupg_options( const char *buf, size_t buflen );
160
161	int check_gnupg_options (const char *buf);
162	void init_gnupg_table (void);
163	void free_gnupg_table (void);
164	int keyring_check_last_access (void);
165	const char* gnupg_check_file_ext (const char * fname);
166	int gpg_check_permissions (int showmsg);
167	int gnupg_check_homedir (void);
168	int gnupg_access_keyring (int _pub);
169	void gnupg_backup_options ();
170	void gnupg_backup_keyrings (void);
171	void gnupg_display_error (void);
172	int gnupg_copy_keyrings (void);
173	int check_gnupg_engine (int r_major, int r_minor, int *r_patch);
174
175	gpg_card_t smartcard_init (void);
176
177	/-- wptGPGME.cpp --/
178	const char * get_signature_status( gpgme_sigsum_t sigstat );
179	void keycache_reload( HWND dlg );
180
181	int get_pubkey (const char keyid, gpgme_key_t ret_key);
182	int winpt_get_pubkey (const char keyid, struct winpt_key_s k);
183	int get_seckey (const char keyid, gpgme_key_t ret_skey);
184	int winpt_get_seckey (const char keyid, struct winpt_key_s k);
185
186	void keycache_reload( HWND dlg );
187	void keycache_release (int cleanup);
188	gpgme_error_t keycache_update (int is_sec, const char *keyid);
189	gpgme_error_t keycache_init( const char pubring, const char secring );
190	void keycache_set_reload( int yes );
191	int keycache_get_reload( void );
192	gpg_keycache_t keycache_get_ctx( int _pub );
193
194	int count_insecure_elgkeys (void);
195
196	int gpg_encrypt_symmetric (void);
197
198
199	/-- wptGPGParser.cpp --/
200	/* find */
201	gpg_group_t find_group( gpg_optfile_t opt, const char *str );
202	gpg_option_t find_option( gpg_optfile_t opt, const char *str );
203	gpg_member_t find_member( gpg_optfile_t opt, const char grp, const char str );
204	/* delete */
205	int delete_group( gpg_optfile_t opt, const char *str );
206	int delete_member( gpg_optfile_t opt, const char grp, const char str );
207	int delete_option( gpg_optfile_t opt, const char *str );
208	/* add */
209	int modify_entry( gpg_optfile_t opt, int type, const char name, const char val );
210	int add_entry( gpg_optfile_t opt, int type, const char name, const char val );
211	int add_member( gpg_optfile_t opt, const char grp, const char str );
212	int add_group( gpg_optfile_t opt, const char *str );
213	/* high-level */
214	int parse_gpg_options( const char file, gpg_optfile_t r_opt );
215	int commit_gpg_options( const char *file, gpg_optfile_t opt );
216	void release_gpg_options( gpg_optfile_t opt );
217	/* memory */
218	void release_group( gpg_group_t grp );
219
220	/-- wptPassphraseCB.cpp --/
221	enum {
222	PASSDLG_REPEAT = 0,
223	PASSDLG_INIT = 1,
224	PASSDLG_STRICT = 2
225	};
226
227	void set_gpg_passphrase_cb (passphrase_cb_s *cb, gpgme_ctx_t ctx,
228	int cmd, HWND hwnd, const char *title);
229	void release_gpg_passphrase_cb (passphrase_cb_s *cb);
230
231	char * request_passphrase (const char title, int flags, int ret_cancel);
232	char * request_passphrase2 (const char title, int flags, int ret_cancel);
233	const char * passphrase_cb (void opaque, const char desc, void *r_hd);
234	char * get_key_userid (const char *keyid);
235	int check_passwd_quality (const char *pass, int strict);
236
237	/-- wptGPGUtil.cpp --/
238	gpgme_error_t gpg_rebuild_cache (char **r_inf);
239	gpgme_error_t gpg_get_version (char **r_inf);
240	void gpg_set_debug_mode (int val);
241	gpgme_error_t gpg_export_seckey (const char keyid, const char outfile);
242	gpgme_error_t gpg_manage_ownertrust (char **data, int export);
243
244	char* generate_revoc_input (int code, const char cmt, const char pass);
245	gpgme_error_t gpg_revoke_key (const char *inp_data,
246	const char *keyid,
247	char **r_revcert);
248	gpgme_error_t gpg_decode_c_string (const char src, char *destp, size_t len);
249	gpgme_error_t gpg_import_key_list (const char fname, char *r_out);
250
251	#endif /* WPT_GPG_H */