Made debugging configurable.
[gpgol.git] / src / common.h
1 /* common.h - Common declarations for GpgOL
2  *      Copyright (C) 2004 Timo Schulz
3  *      Copyright (C) 2005, 2006, 2007 g10 Code GmbH
4  *
5  * This file is part of GpgOL.
6  *
7  * GpgOL is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public License
9  * as published by the Free Software Foundation; either version 2.1
10  * of the License, or (at your option) any later version.
11  *  
12  * GpgOL is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef GPGOL_COMMON_H
22 #define GPGOL_COMMON_H
23
24 #include <gpgme.h>
25
26 #include "util.h"
27  
28
29 #ifdef __cplusplus
30 extern "C" {
31 #if 0
32 }
33 #endif
34 #endif
35
36 /* The Registry key used by GnuPg and closley related software.  */
37 #define GNUPG_REGKEY  "Software\\GNU\\GnuPG"
38
39
40 /* Identifiers for the protocol.  We use different one than those use
41    by gpgme.  FIXME: We might want to define an unknown protocol to
42    non-null and define such a value also in gpgme. */
43 typedef enum
44   {
45     PROTOCOL_UNKNOWN = 0,
46     PROTOCOL_OPENPGP = 1000,
47     PROTOCOL_SMIME   = 1001
48   }
49 protocol_t;
50
51
52 /* Possible options for the recipient dialog. */
53 enum
54   {
55     OPT_FLAG_TEXT     =  2,
56     OPT_FLAG_FORCE    =  4,
57     OPT_FLAG_CANCEL   =  8
58   };
59
60
61 typedef enum
62   {
63     GPG_FMT_NONE = 0,       /* do not encrypt attachments */
64     GPG_FMT_CLASSIC = 1,    /* encrypt attachments without any encoding */
65     GPG_FMT_PGP_PEF = 2     /* use the PGP partioned encoding format (PEF) */
66   } 
67 gpgol_format_t;
68
69 /* Type of a message. */
70 typedef enum 
71   {
72     OPENPGP_NONE = 0,
73     OPENPGP_MSG,
74     OPENPGP_SIG,
75     OPENPGP_CLEARSIG,
76     OPENPGP_PUBKEY,   /* Note, that this type is only partly supported */
77     OPENPGP_SECKEY    /* Note, that this type is only partly supported */
78   }
79 openpgp_t;
80
81
82 extern HINSTANCE glob_hinst;
83 extern UINT      this_dll;
84
85
86 /* Passphrase callback structure. */
87 struct passphrase_cb_s
88 {
89   gpgme_key_t signer;
90   gpgme_ctx_t ctx;
91   char keyid[16+1];
92   char *user_id;
93   char *pass;    
94   int opts;
95   int ttl;  /* TTL of the passphrase. */
96   unsigned int decrypt_cmd:1; /* 1 = show decrypt dialog, otherwise secret key
97                                  selection. */
98   unsigned int hide_pwd:1;
99   unsigned int last_was_bad:1;
100 };
101
102 /* Global options - initialized to default by main.c. */
103 #ifdef __cplusplus
104 extern
105 #endif
106 struct 
107 {
108   int enable_debug;          /* Enable extra debug options.  Values
109                                 larger than 1 increases the debug log
110                                 verbosity.  */
111   int enable_smime;          /* Enable S/MIME support. */
112   int passwd_ttl;            /* Time in seconds the passphrase is stored. */
113   protocol_t default_protocol;/* The default protocol. */
114   int encrypt_default;       /* Encrypt by default. */
115   int sign_default;          /* Sign by default. */
116   int enc_format;            /* Encryption format for attachments. */
117   char *default_key;         /* The key we want to always encrypt to. */
118   int enable_default_key;    /* Enable the use of DEFAULT_KEY. */
119   int preview_decrypt;       /* Decrypt in preview window. */
120   int prefer_html;           /* Prefer html in html/text alternatives. */
121
122   /* The compatibility flags. */
123   struct 
124   {
125     unsigned int no_msgcache:1;
126     unsigned int no_pgpmime:1;
127     unsigned int no_oom_write:1; /* Don't write using Outlooks object model. */
128     unsigned int no_preview_info:1; /* No preview info about PGP/MIME. */
129     unsigned int old_reply_hack: 1; /* See gpgmsg.cpp:decrypt. */
130     unsigned int auto_decrypt: 1;   /* Try to decrypt when clicked. */
131     unsigned int no_attestation: 1; /* Don't create an attestation. */
132   } compat; 
133 } opt;
134
135
136 /* The state object used by b64_decode.  */
137 struct b64_state_s
138 {
139   int idx;
140   unsigned char val;
141   int stop_seen;
142   int invalid_encoding;
143 };
144 typedef struct b64_state_s b64_state_t;
145
146 /* Bit values used for extra log file verbosity.  Value 1 is reserved
147    to enable debug menu options.  */
148 #define DBG_IOWORKER        2
149 #define DBG_IOWORKER_EXTRA  4
150 #define DBG_FILTER          8
151 #define DBG_FILTER_EXTRA   16 
152
153 /*-- common.c --*/
154 void set_global_hinstance (HINSTANCE hinst);
155 void center_window (HWND childwnd, HWND style);
156 HBITMAP get_system_check_bitmap (int checked);
157 char *get_save_filename (HWND root, const char *srcname);
158 char *utf8_to_wincp (const char *string);
159
160 const char *default_homedir (void);
161
162 size_t qp_decode (char *buffer, size_t length);
163 void b64_init (b64_state_t *state);
164 size_t b64_decode (b64_state_t *state, char *buffer, size_t length);
165
166 /* The length of the boundary - the buffer needs to be allocated one
167    byte larger. */
168 #define BOUNDARYSIZE 20
169 char *generate_boundary (char *buffer);
170
171 int gpgol_spawn_detached (const char *cmdline);
172
173
174 /*-- recipient-dialog.c --*/
175 unsigned int recipient_dialog_box (gpgme_key_t **ret_rset);
176 unsigned int recipient_dialog_box2 (gpgme_key_t *fnd, char **unknown,
177                                     gpgme_key_t **ret_rset);
178
179 /*-- passphrase-dialog.c --*/
180 int signer_dialog_box (gpgme_key_t *r_key, char **r_passwd, int encrypting);
181 gpgme_error_t passphrase_callback_box (void *opaque, const char *uid_hint, 
182                              const char *pass_info,
183                              int prev_was_bad, int fd);
184 void free_decrypt_key (struct passphrase_cb_s *ctx);
185 const char *get_pubkey_algo_str (gpgme_pubkey_algo_t id);
186
187 /*-- config-dialog.c --*/
188 void config_dialog_box (HWND parent);
189 int start_key_manager (void);
190 int store_extension_value (const char *key, const char *val);
191 int load_extension_value (const char *key, char **val);
192
193 /*-- verify-dialog.c --*/
194 int verify_dialog_box (gpgme_protocol_t protocol, 
195                        gpgme_verify_result_t res, 
196                        const char *filename);
197
198
199 #ifdef __cplusplus
200 }
201 #endif
202 #endif /*GPGOL_COMMON_H*/