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