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