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