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