7ec81af3656db5308d483aa66374152fc953ceab
[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 autostart;
57   int list_only;
58   int textmode;
59   int expert;
60   const char *def_sig_expire;
61   int ask_sig_expire;
62   const char *def_cert_expire;
63   int ask_cert_expire;
64   int batch;        /* run in batch mode */
65   int answer_yes; /* answer yes on most questions */
66   int answer_no;  /* answer no on most questions */
67   int check_sigs; /* check key signatures */
68   int with_colons;
69   int with_key_data;
70   int with_fingerprint; /* Option --with-fingerprint active.  */
71   int with_keygrip;     /* Option --with-keygrip active.  */
72   int with_secret;      /* Option --with-secret active.  */
73   int fingerprint; /* list fingerprints */
74   int list_sigs;   /* list signatures */
75   int no_armor;
76   int list_packets; /* list-packets mode: 1=normal, 2=invoked by command*/
77   int def_cipher_algo;
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   const char *dirmngr_program;
105
106   /* Options to be passed to the gpg-agent */
107   session_env_t session_env;
108   char *lc_ctype;
109   char *lc_messages;
110
111   int skip_verify;
112   int skip_hidden_recipients;
113
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,
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 shm_coprocess;
131   const char *set_filename;
132   strlist_t comments;
133   int throw_keyid;
134   const char *photo_viewer;
135   int s2k_mode;
136   int s2k_digest_algo;
137   int s2k_cipher_algo;
138   unsigned char s2k_count; /* This is the encoded form, not the raw
139                               count */
140   int not_dash_escaped;
141   int escape_from;
142   int lock_once;
143   keyserver_spec_t keyserver;  /* The list of configured keyservers.  */
144   struct
145   {
146     unsigned int options;
147     unsigned int import_options;
148     unsigned int export_options;
149     strlist_t other;
150   } keyserver_options;
151   int exec_disable;
152   int exec_path_set;
153   unsigned int import_options;
154   unsigned int export_options;
155   unsigned int list_options;
156   unsigned int verify_options;
157   const char *def_preference_list;
158   const char *def_keyserver_url;
159   prefitem_t *personal_cipher_prefs;
160   prefitem_t *personal_digest_prefs;
161   prefitem_t *personal_compress_prefs;
162   int no_perm_warn;
163   int no_mdc_warn;
164   char *temp_dir;
165   int no_encrypt_to;
166   int interactive;
167   struct notation *sig_notations;
168   struct notation *cert_notations;
169   strlist_t sig_policy_url;
170   strlist_t cert_policy_url;
171   strlist_t sig_keyserver_url;
172   strlist_t cert_subpackets;
173   strlist_t sig_subpackets;
174   int allow_non_selfsigned_uid;
175   int allow_freeform_uid;
176   int no_literal;
177   ulong set_filesize;
178   int fast_list_mode;
179   int legacy_list_mode;
180   int ignore_time_conflict;
181   int ignore_valid_from;
182   int ignore_crc_error;
183   int ignore_mdc_error;
184   int command_fd;
185   const char *override_session_key;
186   int show_session_key;
187
188   const char *gpg_agent_info;
189   int try_all_secrets;
190   int no_expensive_trust_checks;
191   int no_sig_cache;
192   int no_sig_create_check;
193   int no_auto_check_trustdb;
194   int preserve_permissions;
195   int no_homedir_creation;
196   struct groupitem *grouplist;
197   int mangle_dos_filenames;
198   int enable_progress_filter;
199   unsigned int screen_columns;
200   unsigned int screen_lines;
201   byte *show_subpackets;
202   int rfc2440_text;
203
204   /* If true, let write failures on the status-fd exit the process. */
205   int exit_on_status_write_error;
206
207   /* If > 0, limit the number of card insertion prompts to this
208      value. */
209   int limit_card_insert_tries;
210
211 #ifdef ENABLE_CARD_SUPPORT
212   /* FIXME: We don't needs this here as it is done in scdaemon. */
213   const char *ctapi_driver; /* Library to access the ctAPI. */
214   const char *pcsc_driver;  /* Library to access the PC/SC system. */
215   int disable_ccid;    /* Disable the use of the internal CCID driver. */
216 #endif /*ENABLE_CARD_SUPPORT*/
217
218   struct
219   {
220     /* If set, require an 0x19 backsig to be present on signatures
221        made by signing subkeys.  If not set, a missing backsig is not
222        an error (but an invalid backsig still is). */
223     unsigned int require_cross_cert:1;
224
225     unsigned int use_embedded_filename:1;
226     unsigned int utf8_filename:1;
227     unsigned int dsa2:1;
228     unsigned int allow_multiple_messages:1;
229     unsigned int allow_weak_digest_algos:1;
230     unsigned int large_rsa:1;
231   } flags;
232
233   /* Linked list of ways to find a key if the key isn't on the local
234      keyring. */
235   struct akl
236   {
237     enum {
238       AKL_NODEFAULT,
239       AKL_LOCAL,
240       AKL_CERT,
241       AKL_PKA,
242       AKL_LDAP,
243       AKL_KEYSERVER,
244       AKL_SPEC
245     } type;
246     keyserver_spec_t spec;
247     struct akl *next;
248   } *auto_key_locate;
249
250   int passphrase_repeat;
251   int pinentry_mode;
252 } opt;
253
254 /* CTRL is used to keep some global variables we currently can't
255    avoid.  Future concurrent versions of gpg will put it into a per
256    request structure CTRL. */
257 EXTERN_UNLESS_MAIN_MODULE
258 struct {
259   int in_auto_key_retrieve; /* True if we are doing an
260                                auto_key_retrieve. */
261   /* Hack to store the last error.  We currently need it because the
262      proc_packet machinery is not able to reliabale return error
263      codes.  Thus for the --server purposes we store some of the error
264      codes here.  FIXME! */
265   gpg_error_t lasterr;
266 } glo_ctrl;
267
268 #define DBG_PACKET_VALUE  1     /* debug packet reading/writing */
269 #define DBG_MPI_VALUE     2     /* debug mpi details */
270 #define DBG_CIPHER_VALUE  4     /* debug cipher handling */
271                                 /* (may reveal sensitive data) */
272 #define DBG_FILTER_VALUE  8     /* debug internal filter handling */
273 #define DBG_IOBUF_VALUE   16    /* debug iobuf stuff */
274 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
275 #define DBG_CACHE_VALUE   64    /* debug the cacheing */
276 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
277 #define DBG_TRUST_VALUE   256   /* debug the trustdb */
278 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
279 #define DBG_EXTPROG_VALUE 1024  /* debug external program calls */
280 #define DBG_CARD_IO_VALUE 2048  /* debug smart card I/O.  */
281 #define DBG_CLOCK_VALUE   4096
282
283 /* Fixme: For now alias this value.  */
284 #define DBG_ASSUAN_VALUE  DBG_EXTPROG_VALUE
285
286
287 /* Tests for the debugging flags.  */
288 #define DBG_PACKET (opt.debug & DBG_PACKET_VALUE)
289 #define DBG_CIPHER (opt.debug & DBG_CIPHER_VALUE)
290 #define DBG_FILTER (opt.debug & DBG_FILTER_VALUE)
291 #define DBG_CACHE  (opt.debug & DBG_CACHE_VALUE)
292 #define DBG_TRUST  (opt.debug & DBG_TRUST_VALUE)
293 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
294 #define DBG_EXTPROG (opt.debug & DBG_EXTPROG_VALUE)
295 #define DBG_CARD_IO (opt.debug & DBG_CARD_IO_VALUE)
296 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
297 #define DBG_CLOCK   (opt.debug & DBG_CLOCK_VALUE)
298
299 /* FIXME: We need to check whey we did not put this into opt. */
300 #define DBG_MEMORY    memory_debug_mode
301 #define DBG_MEMSTAT   memory_stat_debug_mode
302
303 EXTERN_UNLESS_MAIN_MODULE int memory_debug_mode;
304 EXTERN_UNLESS_MAIN_MODULE int memory_stat_debug_mode;
305
306
307 /* Compatibility flags.  */
308 #define GNUPG   (opt.compliance==CO_GNUPG)
309 #define RFC2440 (opt.compliance==CO_RFC2440)
310 #define RFC4880 (opt.compliance==CO_RFC4880)
311 #define PGP6    (opt.compliance==CO_PGP6)
312 #define PGP7    (opt.compliance==CO_PGP7)
313 #define PGP8    (opt.compliance==CO_PGP8)
314 #define PGPX    (PGP6 || PGP7 || PGP8)
315
316 /* Various option flags.  Note that there should be no common string
317    names between the IMPORT_ and EXPORT_ flags as they can be mixed in
318    the keyserver-options option. */
319
320 #define IMPORT_LOCAL_SIGS                (1<<0)
321 #define IMPORT_REPAIR_PKS_SUBKEY_BUG     (1<<1)
322 #define IMPORT_FAST                      (1<<2)
323 #define IMPORT_MERGE_ONLY                (1<<4)
324 #define IMPORT_MINIMAL                   (1<<5)
325 #define IMPORT_CLEAN                     (1<<6)
326 #define IMPORT_NO_SECKEY                 (1<<7)
327 #define IMPORT_KEEP_OWNERTTRUST          (1<<8)
328
329 #define EXPORT_LOCAL_SIGS                (1<<0)
330 #define EXPORT_ATTRIBUTES                (1<<1)
331 #define EXPORT_SENSITIVE_REVKEYS         (1<<2)
332 #define EXPORT_RESET_SUBKEY_PASSWD       (1<<3)
333 #define EXPORT_MINIMAL                   (1<<4)
334 #define EXPORT_CLEAN                     (1<<5)
335 #define EXPORT_SEXP_FORMAT               (1<<6)
336
337 #define LIST_SHOW_PHOTOS                 (1<<0)
338 #define LIST_SHOW_POLICY_URLS            (1<<1)
339 #define LIST_SHOW_STD_NOTATIONS          (1<<2)
340 #define LIST_SHOW_USER_NOTATIONS         (1<<3)
341 #define LIST_SHOW_NOTATIONS (LIST_SHOW_STD_NOTATIONS|LIST_SHOW_USER_NOTATIONS)
342 #define LIST_SHOW_KEYSERVER_URLS         (1<<4)
343 #define LIST_SHOW_UID_VALIDITY           (1<<5)
344 #define LIST_SHOW_UNUSABLE_UIDS          (1<<6)
345 #define LIST_SHOW_UNUSABLE_SUBKEYS       (1<<7)
346 #define LIST_SHOW_KEYRING                (1<<8)
347 #define LIST_SHOW_SIG_EXPIRE             (1<<9)
348 #define LIST_SHOW_SIG_SUBPACKETS         (1<<10)
349 #define LIST_SHOW_USAGE                  (1<<11)
350
351 #define VERIFY_SHOW_PHOTOS               (1<<0)
352 #define VERIFY_SHOW_POLICY_URLS          (1<<1)
353 #define VERIFY_SHOW_STD_NOTATIONS        (1<<2)
354 #define VERIFY_SHOW_USER_NOTATIONS       (1<<3)
355 #define VERIFY_SHOW_NOTATIONS (VERIFY_SHOW_STD_NOTATIONS|VERIFY_SHOW_USER_NOTATIONS)
356 #define VERIFY_SHOW_KEYSERVER_URLS       (1<<4)
357 #define VERIFY_SHOW_UID_VALIDITY         (1<<5)
358 #define VERIFY_SHOW_UNUSABLE_UIDS        (1<<6)
359 #define VERIFY_PKA_LOOKUPS               (1<<7)
360 #define VERIFY_PKA_TRUST_INCREASE        (1<<8)
361 #define VERIFY_SHOW_PRIMARY_UID_ONLY     (1<<9)
362
363 #define KEYSERVER_USE_TEMP_FILES         (1<<0)
364 #define KEYSERVER_KEEP_TEMP_FILES        (1<<1)
365 #define KEYSERVER_ADD_FAKE_V3            (1<<2)
366 #define KEYSERVER_AUTO_KEY_RETRIEVE      (1<<3)
367 #define KEYSERVER_HONOR_KEYSERVER_URL    (1<<4)
368 #define KEYSERVER_HONOR_PKA_RECORD       (1<<5)
369
370
371 #endif /*G10_OPTIONS_H*/