/[winpt]/trunk/Include/wptGPG.h
ViewVC logotype

Diff of /trunk/Include/wptGPG.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 26 by twoaday, Mon Oct 17 08:49:30 2005 UTC revision 217 by twoaday, Mon May 22 14:21:39 2006 UTC
# Line 1  Line 1 
 /* 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;  
     unsigned int is_card:1;  
     unsigned int bad_pwd:1;  
     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);  
   
 /*-- 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-2006 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 <gpgme.h>
25    #include "wptKeyCache.h"
26    #include "wptNLS.h"
27    
28    
29    #define NO_STRICT 0
30    
31    #define key_is_useable(key) (!(key)->revoked && \
32                                 !(key)->expired && \
33                                 !(key)->disabled)
34    
35    enum setup_t {
36        SETUP_KEYGEN    = 1,
37        SETUP_IMPORT    = 2,
38        SETUP_EXISTING  = 3
39    };
40    
41    enum gpg_cmd_t {
42        GPG_CMD_DECRYPT = 0,
43        GPG_CMD_SIGN    = 1
44    };
45    
46    enum keycache_t {
47        KEYCACHE_PRV = 0,
48        KEYCACHE_PUB = 1
49    };
50    
51    enum entry_t {
52        ENTRY_OPAQUE = 1,
53        ENTRY_SINGLE = 2,
54        ENTRY_MULTI  = 3,
55        ENTRY_GROUP  = 4,
56    };
57    
58    struct gpg_card_s;
59    typedef struct gpg_card_s *gpg_card_t;
60    
61    /* Keycache refresh context. */
62    struct refresh_cache_s {
63        int kr_reload;
64        int kr_update;
65        int tr_update;
66    };
67    
68    struct gpg_option_s {
69        struct gpg_option_s *next;
70        char *name;
71        char *val;
72        unsigned int used:1;
73        int type;  
74    };
75    typedef struct gpg_option_s *gpg_option_t;
76    
77    struct gpg_member_s {
78        struct gpg_member_s * next;
79        char *name;
80        unsigned int used:1;  
81    };
82    typedef struct gpg_member_s *gpg_member_t;
83    
84    struct gpg_group_s {
85        struct gpg_group_s *next;
86        struct gpg_member_s *list;
87        char *name;
88        unsigned int used:1;  
89    };
90    typedef struct gpg_group_s *gpg_group_t;
91    
92    struct gpg_optfile_s {
93        struct gpg_option_s *list;
94        struct gpg_group_s *grp;
95    };
96    typedef struct gpg_optfile_s *gpg_optfile_t;
97    
98    
99    struct passphrase_cb_s {
100        int gpg_cmd;        /* sign or decrypt. */
101        int pwd_init;       /* 1 = passphrase request via dialog. */
102        char *pwd;          /* actual passphrase. */
103        char info[1024];    /* hold up the info message */
104        char *title;        /* dialog title. */
105        char keyid[16+1];   /* keyid of the secret key the pwd can be used for. */
106        HWND hwnd;          /* handle of the dialog window. */
107        int cancel;         /* 1 = user cancelled passphrase request. */
108        unsigned int is_card:1; /* 1 = key stored on a smart card. */
109        unsigned int bad_pwd:1; /* 1 = last passphrase was bad. */
110        gpgme_ctx_t gpg;
111        gpgme_recipient_t recipients;
112        struct {
113            int sym_algo;
114            int s2k_mode;
115            int s2k_hash;
116        } sym;
117    };
118    
119    
120    /* This variable is 1 if IDEA is available. */
121    extern int idea_available;
122    
123    /*-- wptGPG.cpp --*/
124    char* get_gnupg_default_key( void );
125    int set_gnupg_default_key( const char *key );
126    char* get_gnupg_config (void);
127    char* get_gnupg_keyring_from_options( const char *fname, int pub );
128    int check_gnupg_config (const char *fname, int *secrings, int *pubrings);
129    char* get_gnupg_path( void );
130    int check_gnupg_prog( void );
131    int gnupg_access_files (void);
132    char* get_gnupg_prog( void );
133    char* get_gnupg_keyring (int pub, int strict);
134    char* get_gnupg_cfgfile (void);
135    int set_gnupg_options( const char *buf, size_t buflen );
136    int gnupg_load_config (void);
137    char* multi_gnupg_path (int strict);
138    
139    int check_gnupg_options (const char *buf);
140    void init_gnupg_table (void);
141    void free_gnupg_table (void);
142    int keyring_check_last_access (void);
143    const char* gnupg_check_file_ext (const char *fname, int *r_type);
144    int gpg_check_permissions (int showmsg);
145    int gnupg_check_homedir (void);
146    int gnupg_access_keyring (int _pub);
147    void gnupg_backup_options ();
148    void gnupg_backup_keyrings (int auto_backup, int backup_mode);
149    void gnupg_display_error (void);
150    int gnupg_copy_keyrings (void);
151    int check_gnupg_engine (const char *need_gpg_ver,
152                            int *r_major, int *r_minor, int *r_patch);
153    
154    /*-- wptGPGME.cpp --*/
155    const char * get_signature_status( gpgme_sigsum_t sigstat );
156    
157    gpgme_error_t get_pubkey (const char *keyid, gpgme_key_t *ret_key);
158    gpgme_error_t winpt_get_pubkey (const char *keyid, struct winpt_key_s *k);
159    void          winpt_release_pubkey (winpt_key_s *k);
160    gpgme_error_t get_seckey (const char *keyid, gpgme_key_t *ret_skey);
161    gpgme_error_t winpt_get_seckey (const char *keyid, struct winpt_key_s *k);
162    
163    void keycache_release (int cleanup);
164    gpgme_error_t keycache_update (int is_sec, const char *keyid);
165    gpgme_error_t keycache_init (const char *pubring, const char * secring);
166    gpg_keycache_t keycache_get_ctx (int _pub);
167    
168    int gpg_encrypt_symmetric (void);
169    const char *get_gpg_sigstat (gpgme_sigsum_t sum);
170    int check_ultimate_trusted_key (void);
171    bool secret_key_available (void);
172    
173    /*-- wptGPGParser.cpp --*/
174    /* find */
175    gpg_group_t find_group( gpg_optfile_t opt, const char *str );
176    gpg_option_t find_option( gpg_optfile_t opt, const char *str );
177    gpg_member_t find_member( gpg_optfile_t opt, const char *grp, const char *str );
178    /* delete */
179    int delete_group( gpg_optfile_t opt, const char *str );
180    int delete_member( gpg_optfile_t opt, const char *grp, const char *str );
181    int delete_option( gpg_optfile_t opt, const char *str );
182    /* add */
183    int modify_entry( gpg_optfile_t opt, int type, const char *name, const char *val );
184    int add_entry( gpg_optfile_t opt, int type, const char *name, const char *val );
185    int add_member( gpg_optfile_t opt, const char *grp, const char *str );
186    int add_group( gpg_optfile_t opt, const char *str );
187    /* high-level */
188    int parse_gpg_options( const char *file, gpg_optfile_t *r_opt );
189    int commit_gpg_options( const char *file, gpg_optfile_t opt );
190    void release_gpg_options( gpg_optfile_t opt );
191    /* memory */
192    void release_group( gpg_group_t grp );
193    
194    /*-- wptPassphraseCB.cpp --*/
195    enum passdlg_t {
196        PASSDLG_REPEAT  = 0,
197        PASSDLG_INIT    = 1,  
198        PASSDLG_STRICT  = 2,
199        PASSDLG_NOTEMPTY= 4
200    };
201    
202    void set_gpg_passphrase_cb (passphrase_cb_s *cb, gpgme_ctx_t ctx,
203                                int cmd, HWND hwnd, const char *title);
204    void release_gpg_passphrase_cb (passphrase_cb_s *cb);
205    void release_gpg_recipients (gpgme_recipient_t *recipients);
206    
207    char * request_passphrase (const char *title, int flags, int *ret_cancel);
208    char * request_passphrase2 (const char *title, int flags, int *ret_cancel);
209    const char * passphrase_cb (void *opaque, const char * desc, void *r_hd);
210    char * get_key_userid (const char *keyid);
211    int check_passwd_quality (const char *pass, int strict);
212    
213    /*-- wptClipboard.cpp --*/
214    gpgme_error_t gpg_clip_istext_avail (int *r_val);
215    gpgme_error_t gpg_clip_is_secured (int *r_type, int *r_val);
216    gpgme_error_t gpg_clip_get_pgptype (int *r_type);
217    gpgme_error_t gpg_clip_parse_pgpid (const char *data, int *r_type);
218    
219    /* wptGPGMEData.cpp --*/
220    gpgme_error_t gpg_data_new_from_clipboard (gpgme_data_t *r_dh, int wraplen);
221    void         gpg_data_release_and_set_clipboard (gpgme_data_t dh, int chg_ver);
222    size_t       gpg_data_readline (gpgme_data_t dh, char *line, size_t nbytes);
223    
224    gpgme_error_t gpg_data_release_and_set_file (gpgme_data_t dh, const char *fname);
225    gpgme_error_t  gpg_data_mail_quote (gpgme_data_t *r_dh);
226    gpgme_error_t  gpg_data_extract_plaintext (gpgme_data_t sig, gpgme_data_t *r_plain);
227    void          gpg_data_putc (gpgme_data_t hd, int c);
228    
229    /*-- wptGPGUtil.cpp --*/
230    gpgme_error_t gpg_rebuild_cache (char **r_inf);
231    gpgme_error_t gpg_get_version (char **r_inf);
232    void          gpg_set_debug_mode (int val);
233    gpgme_error_t gpg_export_seckey (const char *keyid, const char *outfile);
234    gpgme_error_t gpg_manage_ownertrust (char **data, int do_export);
235    gpgme_error_t gpg_get_photoid_data (const char *keyid, char **r_status_data,
236                                        unsigned char **r_data,
237                                        unsigned long *ndata);
238    gpgme_error_t gpg_revoke_cert (int desig_revoke, const char *inp_data,
239                                   const char *keyid, char **r_revcert);
240    gpgme_error_t gpg_decode_c_string (const char *src, char **destp, size_t len);
241    gpgme_error_t gpg_import_key_list (const char *fname, char **r_out);
242    gpgme_error_t gpg_extract_keys (const char *keyfile, const char **keys, DWORD nkeys,
243                                    char **new_keyfile);
244    gpgme_error_t get_uat_validity (const char *keyid, gpgme_validity_t *r_valid);
245    gpgme_error_t gpg_get_recipients (const char *file, gpgme_recipient_t *r_list);
246    gpgme_error_t gpg_find_key_subpacket (const char *key, int subpktid,
247                                          char **value);
248    
249    #endif /* WPT_GPG_H */
Legend:
Removed from v.26  
changed lines
  Added in v.217
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26