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