gpg: Use the proper type.
[gnupg.git] / g10 / options.h
1 /* options.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
3  *               2007, 2010, 2011 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 #include "tofu.h"
28 #include "../common/session-env.h"
29
30 #ifndef EXTERN_UNLESS_MAIN_MODULE
31 /* Norcraft can't cope with common symbols */
32 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
33 #define EXTERN_UNLESS_MAIN_MODULE extern
34 #else
35 #define EXTERN_UNLESS_MAIN_MODULE
36 #endif
37 #endif
38
39 /* Declaration of a keyserver spec type.  The definition is found in
40    ../common/keyserver.h.  */
41 struct keyserver_spec;
42 typedef struct keyserver_spec *keyserver_spec_t;
43
44
45 /* Global options for GPG.  */
46 EXTERN_UNLESS_MAIN_MODULE
47 struct
48 {
49   int verbose;
50   int quiet;
51   unsigned debug;
52   int armor;
53   char *outfile;
54   estream_t outfp;  /* Hack, sometimes used in place of outfile.  */
55   off_t max_output;
56   int dry_run;
57   int autostart;
58   int list_only;
59   int textmode;
60   int expert;
61   const char *def_sig_expire;
62   int ask_sig_expire;
63   const char *def_cert_expire;
64   int ask_cert_expire;
65   int batch;        /* run in batch mode */
66   int answer_yes; /* answer yes on most questions */
67   int answer_no;  /* answer no on most questions */
68   int check_sigs; /* check key signatures */
69   int with_colons;
70   int with_key_data;
71   int with_icao_spelling; /* Print ICAO spelling with fingerprints.  */
72   int with_fingerprint; /* Option --with-fingerprint active.  */
73   int with_keygrip;     /* Option --with-keygrip active.  */
74   int with_secret;      /* Option --with-secret active.  */
75   int fingerprint; /* list fingerprints */
76   int list_sigs;   /* list signatures */
77   int print_pka_records;
78   int print_dane_records;
79   int no_armor;
80   int list_packets; /* list-packets mode: 1=normal, 2=invoked by command*/
81   int def_cipher_algo;
82   int force_mdc;
83   int disable_mdc;
84   int def_digest_algo;
85   int cert_digest_algo;
86   int compress_algo;
87   int compress_level;
88   int bz2_compress_level;
89   int bz2_decompress_lowmem;
90   const char *def_secret_key;
91   char *def_recipient;
92   int def_recipient_self;
93   strlist_t secret_keys_to_try;
94
95   int def_cert_level;
96   int min_cert_level;
97   int ask_cert_level;
98   int emit_version;       /* 0 = none,
99                              1 = major only,
100                              2 = major and minor,
101                              3 = full version,
102                              4 = full version plus OS string. */
103   int marginals_needed;
104   int completes_needed;
105   int max_cert_depth;
106   const char *homedir;
107   const char *agent_program;
108   const char *dirmngr_program;
109
110   /* Options to be passed to the gpg-agent */
111   session_env_t session_env;
112   char *lc_ctype;
113   char *lc_messages;
114
115   int skip_verify;
116   int skip_hidden_recipients;
117
118   /* TM_CLASSIC must be zero to accomodate trustdbs generated before
119      we started storing the trust model inside the trustdb. */
120   enum
121     {
122       TM_CLASSIC=0, TM_PGP=1, TM_EXTERNAL=2,
123       TM_ALWAYS, TM_DIRECT, TM_AUTO, TM_TOFU, TM_TOFU_PGP
124     } trust_model;
125   enum
126     {
127       TOFU_DB_AUTO=0, TOFU_DB_SPLIT, TOFU_DB_FLAT
128     } tofu_db_format;
129   enum tofu_policy tofu_default_policy;
130   int force_ownertrust;
131   enum
132     {
133       CO_GNUPG, CO_RFC4880, CO_RFC2440,
134       CO_PGP6, CO_PGP7, CO_PGP8
135     } compliance;
136   enum
137     {
138       KF_SHORT, KF_LONG, KF_0xSHORT, KF_0xLONG
139     } keyid_format;
140   int shm_coprocess;
141   const char *set_filename;
142   strlist_t comments;
143   int throw_keyids;
144   const char *photo_viewer;
145   int s2k_mode;
146   int s2k_digest_algo;
147   int s2k_cipher_algo;
148   unsigned char s2k_count; /* This is the encoded form, not the raw
149                               count */
150   int not_dash_escaped;
151   int escape_from;
152   int lock_once;
153   keyserver_spec_t keyserver;  /* The list of configured keyservers.  */
154   struct
155   {
156     unsigned int options;
157     unsigned int import_options;
158     unsigned int export_options;
159     char *http_proxy;
160   } keyserver_options;
161   int exec_disable;
162   int exec_path_set;
163   unsigned int import_options;
164   unsigned int export_options;
165   unsigned int list_options;
166   unsigned int verify_options;
167   const char *def_preference_list;
168   const char *def_keyserver_url;
169   prefitem_t *personal_cipher_prefs;
170   prefitem_t *personal_digest_prefs;
171   prefitem_t *personal_compress_prefs;
172   struct weakhash *additional_weak_digests;
173   int no_perm_warn;
174   int no_mdc_warn;
175   char *temp_dir;
176   int no_encrypt_to;
177   int interactive;
178   struct notation *sig_notations;
179   struct notation *cert_notations;
180   strlist_t sig_policy_url;
181   strlist_t cert_policy_url;
182   strlist_t sig_keyserver_url;
183   strlist_t cert_subpackets;
184   strlist_t sig_subpackets;
185   int allow_non_selfsigned_uid;
186   int allow_freeform_uid;
187   int no_literal;
188   ulong set_filesize;
189   int fast_list_mode;
190   int legacy_list_mode;
191   int ignore_time_conflict;
192   int ignore_valid_from;
193   int ignore_crc_error;
194   int ignore_mdc_error;
195   int command_fd;
196   const char *override_session_key;
197   int show_session_key;
198
199   const char *gpg_agent_info;
200   int try_all_secrets;
201   int no_expensive_trust_checks;
202   int no_sig_cache;
203   int no_auto_check_trustdb;
204   int preserve_permissions;
205   int no_homedir_creation;
206   struct groupitem *grouplist;
207   int mangle_dos_filenames;
208   int enable_progress_filter;
209   unsigned int screen_columns;
210   unsigned int screen_lines;
211   byte *show_subpackets;
212   int rfc2440_text;
213
214   /* If true, let write failures on the status-fd exit the process. */
215   int exit_on_status_write_error;
216
217   /* If > 0, limit the number of card insertion prompts to this
218      value. */
219   int limit_card_insert_tries;
220
221 #ifdef ENABLE_CARD_SUPPORT
222   /* FIXME: We don't needs this here as it is done in scdaemon. */
223   const char *ctapi_driver; /* Library to access the ctAPI. */
224   const char *pcsc_driver;  /* Library to access the PC/SC system. */
225   int disable_ccid;    /* Disable the use of the internal CCID driver. */
226 #endif /*ENABLE_CARD_SUPPORT*/
227
228   struct
229   {
230     /* If set, require an 0x19 backsig to be present on signatures
231        made by signing subkeys.  If not set, a missing backsig is not
232        an error (but an invalid backsig still is). */
233     unsigned int require_cross_cert:1;
234
235     unsigned int use_embedded_filename:1;
236     unsigned int utf8_filename:1;
237     unsigned int dsa2:1;
238     unsigned int allow_multiple_messages:1;
239     unsigned int allow_weak_digest_algos:1;
240     unsigned int large_rsa:1;
241   } flags;
242
243   /* Linked list of ways to find a key if the key isn't on the local
244      keyring. */
245   struct akl
246   {
247     enum {
248       AKL_NODEFAULT,
249       AKL_LOCAL,
250       AKL_CERT,
251       AKL_PKA,
252       AKL_DANE,
253       AKL_LDAP,
254       AKL_KEYSERVER,
255       AKL_SPEC
256     } type;
257     keyserver_spec_t spec;
258     struct akl *next;
259   } *auto_key_locate;
260
261   int passphrase_repeat;
262   int pinentry_mode;
263 } opt;
264
265 /* CTRL is used to keep some global variables we currently can't
266    avoid.  Future concurrent versions of gpg will put it into a per
267    request structure CTRL. */
268 EXTERN_UNLESS_MAIN_MODULE
269 struct {
270   int in_auto_key_retrieve; /* True if we are doing an
271                                auto_key_retrieve. */
272   /* Hack to store the last error.  We currently need it because the
273      proc_packet machinery is not able to reliabale return error
274      codes.  Thus for the --server purposes we store some of the error
275      codes here.  FIXME! */
276   gpg_error_t lasterr;
277 } glo_ctrl;
278
279 #define DBG_PACKET_VALUE  1     /* debug packet reading/writing */
280 #define DBG_MPI_VALUE     2     /* debug mpi details */
281 #define DBG_CRYPTO_VALUE  4     /* debug crypto handling */
282                                 /* (may reveal sensitive data) */
283 #define DBG_FILTER_VALUE  8     /* debug internal filter handling */
284 #define DBG_IOBUF_VALUE   16    /* debug iobuf stuff */
285 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
286 #define DBG_CACHE_VALUE   64    /* debug the caching */
287 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
288 #define DBG_TRUST_VALUE   256   /* debug the trustdb */
289 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
290 #define DBG_IPC_VALUE     1024  /* debug assuan communication */
291 #define DBG_CARD_IO_VALUE 2048  /* debug smart card I/O.  */
292 #define DBG_CLOCK_VALUE   4096
293 #define DBG_LOOKUP_VALUE  8192  /* debug the kety lookup */
294 #define DBG_EXTPROG_VALUE 16384 /* debug external program calls */
295
296 /* Tests for the debugging flags.  */
297 #define DBG_PACKET (opt.debug & DBG_PACKET_VALUE)
298 #define DBG_CRYPTO (opt.debug & DBG_CRYPTO_VALUE)
299 #define DBG_FILTER (opt.debug & DBG_FILTER_VALUE)
300 #define DBG_CACHE  (opt.debug & DBG_CACHE_VALUE)
301 #define DBG_TRUST  (opt.debug & DBG_TRUST_VALUE)
302 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
303 #define DBG_IPC     (opt.debug & DBG_IPC_VALUE)
304 #define DBG_CARD_IO (opt.debug & DBG_CARD_IO_VALUE)
305 #define DBG_IPC     (opt.debug & DBG_IPC_VALUE)
306 #define DBG_CLOCK   (opt.debug & DBG_CLOCK_VALUE)
307 #define DBG_LOOKUP  (opt.debug & DBG_LOOKUP_VALUE)
308 #define DBG_EXTPROG (opt.debug & DBG_EXTPROG_VALUE)
309
310 /* FIXME: We need to check whey we did not put this into opt. */
311 #define DBG_MEMORY    memory_debug_mode
312 #define DBG_MEMSTAT   memory_stat_debug_mode
313
314 EXTERN_UNLESS_MAIN_MODULE int memory_debug_mode;
315 EXTERN_UNLESS_MAIN_MODULE int memory_stat_debug_mode;
316
317
318 /* Compatibility flags.  */
319 #define GNUPG   (opt.compliance==CO_GNUPG)
320 #define RFC2440 (opt.compliance==CO_RFC2440)
321 #define RFC4880 (opt.compliance==CO_RFC4880)
322 #define PGP6    (opt.compliance==CO_PGP6)
323 #define PGP7    (opt.compliance==CO_PGP7)
324 #define PGP8    (opt.compliance==CO_PGP8)
325 #define PGPX    (PGP6 || PGP7 || PGP8)
326
327 /* Various option flags.  Note that there should be no common string
328    names between the IMPORT_ and EXPORT_ flags as they can be mixed in
329    the keyserver-options option. */
330
331 #define IMPORT_LOCAL_SIGS                (1<<0)
332 #define IMPORT_REPAIR_PKS_SUBKEY_BUG     (1<<1)
333 #define IMPORT_FAST                      (1<<2)
334 #define IMPORT_MERGE_ONLY                (1<<4)
335 #define IMPORT_MINIMAL                   (1<<5)
336 #define IMPORT_CLEAN                     (1<<6)
337 #define IMPORT_NO_SECKEY                 (1<<7)
338 #define IMPORT_KEEP_OWNERTTRUST          (1<<8)
339
340 #define EXPORT_LOCAL_SIGS                (1<<0)
341 #define EXPORT_ATTRIBUTES                (1<<1)
342 #define EXPORT_SENSITIVE_REVKEYS         (1<<2)
343 #define EXPORT_RESET_SUBKEY_PASSWD       (1<<3)
344 #define EXPORT_MINIMAL                   (1<<4)
345 #define EXPORT_CLEAN                     (1<<5)
346 #define EXPORT_DANE_FORMAT               (1<<6)
347
348 #define LIST_SHOW_PHOTOS                 (1<<0)
349 #define LIST_SHOW_POLICY_URLS            (1<<1)
350 #define LIST_SHOW_STD_NOTATIONS          (1<<2)
351 #define LIST_SHOW_USER_NOTATIONS         (1<<3)
352 #define LIST_SHOW_NOTATIONS (LIST_SHOW_STD_NOTATIONS|LIST_SHOW_USER_NOTATIONS)
353 #define LIST_SHOW_KEYSERVER_URLS         (1<<4)
354 #define LIST_SHOW_UID_VALIDITY           (1<<5)
355 #define LIST_SHOW_UNUSABLE_UIDS          (1<<6)
356 #define LIST_SHOW_UNUSABLE_SUBKEYS       (1<<7)
357 #define LIST_SHOW_KEYRING                (1<<8)
358 #define LIST_SHOW_SIG_EXPIRE             (1<<9)
359 #define LIST_SHOW_SIG_SUBPACKETS         (1<<10)
360 #define LIST_SHOW_USAGE                  (1<<11)
361
362 #define VERIFY_SHOW_PHOTOS               (1<<0)
363 #define VERIFY_SHOW_POLICY_URLS          (1<<1)
364 #define VERIFY_SHOW_STD_NOTATIONS        (1<<2)
365 #define VERIFY_SHOW_USER_NOTATIONS       (1<<3)
366 #define VERIFY_SHOW_NOTATIONS (VERIFY_SHOW_STD_NOTATIONS|VERIFY_SHOW_USER_NOTATIONS)
367 #define VERIFY_SHOW_KEYSERVER_URLS       (1<<4)
368 #define VERIFY_SHOW_UID_VALIDITY         (1<<5)
369 #define VERIFY_SHOW_UNUSABLE_UIDS        (1<<6)
370 #define VERIFY_PKA_LOOKUPS               (1<<7)
371 #define VERIFY_PKA_TRUST_INCREASE        (1<<8)
372 #define VERIFY_SHOW_PRIMARY_UID_ONLY     (1<<9)
373
374 #define KEYSERVER_HTTP_PROXY             (1<<0)
375 #define KEYSERVER_TIMEOUT                (1<<1)
376 #define KEYSERVER_ADD_FAKE_V3            (1<<2)
377 #define KEYSERVER_AUTO_KEY_RETRIEVE      (1<<3)
378 #define KEYSERVER_HONOR_KEYSERVER_URL    (1<<4)
379 #define KEYSERVER_HONOR_PKA_RECORD       (1<<5)
380
381
382 #endif /*G10_OPTIONS_H*/