Changed to GPLv3.
[gnupg.git] / g10 / options.h
1 /* options.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
3  *               2006 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG 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
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20 #ifndef G10_OPTIONS_H
21 #define G10_OPTIONS_H
22
23 #include <sys/types.h>
24 #include <types.h>
25 #include "main.h"
26 #include "packet.h"
27
28 #ifndef EXTERN_UNLESS_MAIN_MODULE
29 /* Norcraft can't cope with common symbols */
30 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
31 #define EXTERN_UNLESS_MAIN_MODULE extern
32 #else
33 #define EXTERN_UNLESS_MAIN_MODULE 
34 #endif
35 #endif
36
37 EXTERN_UNLESS_MAIN_MODULE
38 struct
39 {
40   int verbose;
41   int quiet;
42   unsigned debug;
43   int armor;
44   char *outfile;
45   off_t max_output;
46   int dry_run;
47   int list_only;
48   int textmode;
49   int expert;
50   const char *def_sig_expire;
51   int ask_sig_expire;
52   const char *def_cert_expire;
53   int ask_cert_expire;
54   int batch;        /* run in batch mode */
55   int answer_yes; /* answer yes on most questions */
56   int answer_no;  /* answer no on most questions */
57   int check_sigs; /* check key signatures */
58   int with_colons;
59   int with_key_data;
60   int with_fingerprint; /* opt --with-fingerprint active */
61   int fingerprint; /* list fingerprints */
62   int list_sigs;   /* list signatures */
63   int no_armor;
64   int list_packets; /* list-packets mode: 1=normal, 2=invoked by command*/
65   int def_cipher_algo;
66   int force_v3_sigs;
67   int force_v4_certs;
68   int force_mdc;
69   int disable_mdc;
70   int def_digest_algo;
71   int cert_digest_algo;
72   int compress_algo;
73   int compress_level;
74   int bz2_compress_level;
75   int bz2_decompress_lowmem;
76   const char *def_secret_key;
77   char *def_recipient;
78   int def_recipient_self;
79   int def_cert_level;
80   int min_cert_level;
81   int ask_cert_level;
82   int no_version;
83   int marginals_needed;
84   int completes_needed;
85   int max_cert_depth;
86   const char *homedir;
87   const char *agent_program; 
88   char *display;      /* 5 options to be passed to the gpg-agent */
89   char *ttyname;     
90   char *ttytype;
91   char *lc_ctype;
92   char *lc_messages;
93
94   int skip_verify;
95   int compress_keys;
96   int compress_sigs;
97   /* TM_CLASSIC must be zero to accomodate trustdbs generated before
98      we started storing the trust model inside the trustdb. */
99   enum
100     {
101       TM_CLASSIC=0, TM_PGP=1, TM_EXTERNAL=2, TM_ALWAYS, TM_DIRECT, TM_AUTO
102     } trust_model;
103   int force_ownertrust;
104   enum
105     {
106       CO_GNUPG=0, CO_RFC2440, CO_RFC1991, CO_PGP2, CO_PGP6, CO_PGP7, CO_PGP8
107     } compliance;
108   enum
109     {
110       KF_SHORT, KF_LONG, KF_0xSHORT, KF_0xLONG
111     } keyid_format;
112   int pgp2_workarounds;
113   int shm_coprocess;
114   const char *set_filename;
115   strlist_t comments;
116   int throw_keyid;
117   const char *photo_viewer;
118   int s2k_mode;
119   int s2k_digest_algo;
120   int s2k_cipher_algo;
121   unsigned char s2k_count; /* This is the encoded form, not the raw
122                               count */
123   int simple_sk_checksum; /* create the deprecated rfc2440 secret key
124                              protection */
125   int not_dash_escaped;
126   int escape_from;
127   int lock_once;
128   struct keyserver_spec
129   {
130     char *uri;
131     char *scheme;
132     char *auth;
133     char *host;
134     char *port;
135     char *path;
136     char *opaque;
137     strlist_t options;
138     struct
139     {
140       unsigned int direct_uri:1;
141     } flags;
142     struct keyserver_spec *next;
143   } *keyserver;
144   struct
145   {
146     unsigned int options;
147     unsigned int import_options;
148     unsigned int export_options;
149     strlist_t other;
150   } keyserver_options;
151   int exec_disable;
152   int exec_path_set;
153   unsigned int import_options;
154   unsigned int export_options;
155   unsigned int list_options;
156   unsigned int verify_options;
157   const char *def_preference_list;
158   const char *def_keyserver_url;
159   prefitem_t *personal_cipher_prefs;
160   prefitem_t *personal_digest_prefs;
161   prefitem_t *personal_compress_prefs;
162   int no_perm_warn;
163   int no_mdc_warn;
164   char *temp_dir;
165   int no_encrypt_to;
166   int interactive;
167   struct notation *sig_notations;
168   struct notation *cert_notations;
169   strlist_t sig_policy_url;
170   strlist_t cert_policy_url;
171   strlist_t sig_keyserver_url;
172   strlist_t cert_subpackets;
173   strlist_t sig_subpackets;
174   int allow_non_selfsigned_uid;
175   int allow_freeform_uid;
176   int no_literal;
177   ulong set_filesize;
178   int fast_list_mode;
179   int fixed_list_mode;
180   int ignore_time_conflict;
181   int ignore_valid_from;
182   int ignore_crc_error;
183   int ignore_mdc_error;
184   int command_fd;
185   const char *override_session_key;
186   int show_session_key;
187
188   const char *gpg_agent_info;
189   int try_all_secrets;
190   int no_expensive_trust_checks;
191   int no_sig_cache;
192   int no_sig_create_check;
193   int no_auto_check_trustdb;
194   int preserve_permissions;
195   int no_homedir_creation;
196   struct groupitem *grouplist;
197   int mangle_dos_filenames;
198   int enable_progress_filter;
199   unsigned int screen_columns;
200   unsigned int screen_lines;
201   byte *show_subpackets;
202   int rfc2440_text;
203
204   /* If true, let write failures on the status-fd exit the process. */
205   int exit_on_status_write_error;
206
207   /* If > 0, limit the number of card insertion prompts to this
208      value. */
209   int limit_card_insert_tries; 
210
211 #ifdef ENABLE_CARD_SUPPORT
212   /* FIXME: We don't needs this here as it is done in scdaemon. */
213   const char *ctapi_driver; /* Library to access the ctAPI. */
214   const char *pcsc_driver;  /* Library to access the PC/SC system. */
215   int disable_ccid;    /* Disable the use of the internal CCID driver. */
216 #endif /*ENABLE_CARD_SUPPORT*/
217
218   struct
219   {
220     /* If set, require an 0x19 backsig to be present on signatures
221        made by signing subkeys.  If not set, a missing backsig is not
222        an error (but an invalid backsig still is). */
223     unsigned int require_cross_cert:1;
224
225     unsigned int use_embedded_filename:1;
226     unsigned int utf8_filename:1;
227     unsigned int dsa2:1;
228     unsigned int allow_multiple_messages:1;
229   } flags;
230
231   /* Linked list of ways to find a key if the key isn't on the local
232      keyring. */
233   struct akl
234   {
235     enum {AKL_CERT, AKL_PKA, AKL_LDAP, AKL_KEYSERVER, AKL_SPEC} type;
236     struct keyserver_spec *spec;
237     struct akl *next;
238   } *auto_key_locate;
239
240   int passwd_repeat;
241 } opt;
242
243 /* CTRL is used to keep some global variables we currently can't
244    avoid.  Future concurrent versions of gpg will put it into a per
245    request structure CTRL. */
246 EXTERN_UNLESS_MAIN_MODULE
247 struct {
248   int in_auto_key_retrieve; /* True if we are doing an
249                                auto_key_retrieve. */
250 } glo_ctrl;
251
252 #define DBG_PACKET_VALUE  1     /* debug packet reading/writing */
253 #define DBG_MPI_VALUE     2     /* debug mpi details */
254 #define DBG_CIPHER_VALUE  4     /* debug cipher handling */
255                                 /* (may reveal sensitive data) */
256 #define DBG_FILTER_VALUE  8     /* debug internal filter handling */
257 #define DBG_IOBUF_VALUE   16    /* debug iobuf stuff */
258 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
259 #define DBG_CACHE_VALUE   64    /* debug the cacheing */
260 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
261 #define DBG_TRUST_VALUE   256   /* debug the trustdb */
262 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
263 #define DBG_EXTPROG_VALUE 1024  /* debug external program calls */
264 #define DBG_CARD_IO_VALUE 2048  /* debug smart card I/O.  */
265
266 /* Fixme: For now alias this value.  */
267 #define DBG_ASSUAN_VALUE  DBG_EXTPROG_VALUE
268
269
270 /* Tests for the debugging flags.  */
271 #define DBG_PACKET (opt.debug & DBG_PACKET_VALUE)
272 #define DBG_CIPHER (opt.debug & DBG_CIPHER_VALUE)
273 #define DBG_FILTER (opt.debug & DBG_FILTER_VALUE)
274 #define DBG_CACHE  (opt.debug & DBG_CACHE_VALUE)
275 #define DBG_TRUST  (opt.debug & DBG_TRUST_VALUE)
276 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
277 #define DBG_EXTPROG (opt.debug & DBG_EXTPROG_VALUE)
278 #define DBG_CARD_IO (opt.debug & DBG_CARD_IO_VALUE)
279 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
280
281 /* FIXME: We need to check whey we did not put this into opt. */
282 #define DBG_MEMORY    memory_debug_mode
283 #define DBG_MEMSTAT   memory_stat_debug_mode
284
285 EXTERN_UNLESS_MAIN_MODULE int memory_debug_mode;
286 EXTERN_UNLESS_MAIN_MODULE int memory_stat_debug_mode;
287
288
289
290 #define GNUPG   (opt.compliance==CO_GNUPG)
291 #define RFC1991 (opt.compliance==CO_RFC1991 || opt.compliance==CO_PGP2)
292 #define RFC2440 (opt.compliance==CO_RFC2440)
293 #define PGP2    (opt.compliance==CO_PGP2)
294 #define PGP6    (opt.compliance==CO_PGP6)
295 #define PGP7    (opt.compliance==CO_PGP7)
296 #define PGP8    (opt.compliance==CO_PGP8)
297
298 /* Various option flags.  Note that there should be no common string
299    names between the IMPORT_ and EXPORT_ flags as they can be mixed in
300    the keyserver-options option. */
301
302 #define IMPORT_LOCAL_SIGS                (1<<0)
303 #define IMPORT_REPAIR_PKS_SUBKEY_BUG     (1<<1)
304 #define IMPORT_FAST                      (1<<2)
305 #define IMPORT_SK2PK                     (1<<3)
306 #define IMPORT_MERGE_ONLY                (1<<4)
307 #define IMPORT_MINIMAL                   (1<<5)
308 #define IMPORT_CLEAN                     (1<<6)
309
310 #define EXPORT_LOCAL_SIGS                (1<<0)
311 #define EXPORT_ATTRIBUTES                (1<<1)
312 #define EXPORT_SENSITIVE_REVKEYS         (1<<2)
313 #define EXPORT_RESET_SUBKEY_PASSWD       (1<<3)
314 #define EXPORT_MINIMAL                   (1<<4)
315 #define EXPORT_CLEAN                     (1<<5)
316 #define EXPORT_SEXP_FORMAT               (1<<6)
317
318 #define LIST_SHOW_PHOTOS                 (1<<0)
319 #define LIST_SHOW_POLICY_URLS            (1<<1)
320 #define LIST_SHOW_STD_NOTATIONS          (1<<2)
321 #define LIST_SHOW_USER_NOTATIONS         (1<<3)
322 #define LIST_SHOW_NOTATIONS (LIST_SHOW_STD_NOTATIONS|LIST_SHOW_USER_NOTATIONS)
323 #define LIST_SHOW_KEYSERVER_URLS         (1<<4)
324 #define LIST_SHOW_UID_VALIDITY           (1<<5)
325 #define LIST_SHOW_UNUSABLE_UIDS          (1<<6)
326 #define LIST_SHOW_UNUSABLE_SUBKEYS       (1<<7)
327 #define LIST_SHOW_KEYRING                (1<<8)
328 #define LIST_SHOW_SIG_EXPIRE             (1<<9)
329 #define LIST_SHOW_SIG_SUBPACKETS         (1<<10)
330
331 #define VERIFY_SHOW_PHOTOS               (1<<0)
332 #define VERIFY_SHOW_POLICY_URLS          (1<<1)
333 #define VERIFY_SHOW_STD_NOTATIONS        (1<<2)
334 #define VERIFY_SHOW_USER_NOTATIONS       (1<<3)
335 #define VERIFY_SHOW_NOTATIONS (VERIFY_SHOW_STD_NOTATIONS|VERIFY_SHOW_USER_NOTATIONS)
336 #define VERIFY_SHOW_KEYSERVER_URLS       (1<<4)
337 #define VERIFY_SHOW_UID_VALIDITY         (1<<5)
338 #define VERIFY_SHOW_UNUSABLE_UIDS        (1<<6)
339 #define VERIFY_PKA_LOOKUPS               (1<<7)
340 #define VERIFY_PKA_TRUST_INCREASE        (1<<8)
341 #define VERIFY_SHOW_PRIMARY_UID_ONLY     (1<<9)
342
343 #define KEYSERVER_USE_TEMP_FILES         (1<<0)
344 #define KEYSERVER_KEEP_TEMP_FILES        (1<<1)
345 #define KEYSERVER_ADD_FAKE_V3            (1<<2)
346 #define KEYSERVER_AUTO_KEY_RETRIEVE      (1<<3)
347 #define KEYSERVER_HONOR_KEYSERVER_URL    (1<<4)
348 #define KEYSERVER_HONOR_PKA_RECORD       (1<<5)
349
350 #endif /*G10_OPTIONS_H*/