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