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