gpg: Consider that gcry_mpi_get_opaque may return NULL.
[gnupg.git] / g10 / options.h
1 /* options.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
3  *               2007 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 EXTERN_UNLESS_MAIN_MODULE
39 struct
40 {
41   int verbose;
42   int quiet;
43   unsigned debug;
44   int armor;
45   char *outfile;
46   off_t max_output;
47   int dry_run;
48   int list_only;
49   int textmode;
50   int expert;
51   const char *def_sig_expire;
52   int ask_sig_expire;
53   const char *def_cert_expire;
54   int ask_cert_expire;
55   int batch;        /* run in batch mode */
56   int answer_yes; /* answer yes on most questions */
57   int answer_no;  /* answer no on most questions */
58   int check_sigs; /* check key signatures */
59   int with_colons;
60   int with_key_data;
61   int with_fingerprint; /* opt --with-fingerprint active */
62   int fingerprint; /* list fingerprints */
63   int list_sigs;   /* list signatures */
64   int no_armor;
65   int list_packets; /* list-packets mode: 1=normal, 2=invoked by command*/
66   int def_cipher_algo;
67   int force_v3_sigs;
68   int force_v4_certs;
69   int force_mdc;
70   int disable_mdc;
71   int def_digest_algo;
72   int cert_digest_algo;
73   int compress_algo;
74   int compress_level;
75   int bz2_compress_level;
76   int bz2_decompress_lowmem;
77   const char *def_secret_key;
78   char *def_recipient;
79   int def_recipient_self;
80   int def_cert_level;
81   int min_cert_level;
82   int ask_cert_level;
83   int emit_version;       /* 0 = none,
84                              1 = major only,
85                              2 = major and minor,
86                              3 = full version,
87                              4 = full version plus OS string. */
88   int marginals_needed;
89   int completes_needed;
90   int max_cert_depth;
91   const char *homedir;
92   const char *agent_program;
93
94   /* Options to be passed to the gpg-agent */
95   session_env_t session_env;
96   char *lc_ctype;
97   char *lc_messages;
98
99   int skip_verify;
100   int compress_keys;
101   int compress_sigs;
102   /* TM_CLASSIC must be zero to accomodate trustdbs generated before
103      we started storing the trust model inside the trustdb. */
104   enum
105     {
106       TM_CLASSIC=0, TM_PGP=1, TM_EXTERNAL=2, TM_ALWAYS, TM_DIRECT, TM_AUTO
107     } trust_model;
108   int force_ownertrust;
109   enum
110     {
111       CO_GNUPG, CO_RFC4880, CO_RFC2440, CO_RFC1991, CO_PGP2,
112       CO_PGP6, CO_PGP7, CO_PGP8
113     } compliance;
114   enum
115     {
116       KF_SHORT, KF_LONG, KF_0xSHORT, KF_0xLONG
117     } keyid_format;
118   int pgp2_workarounds;
119   int shm_coprocess;
120   const char *set_filename;
121   strlist_t comments;
122   int throw_keyid;
123   const char *photo_viewer;
124   int s2k_mode;
125   int s2k_digest_algo;
126   int s2k_cipher_algo;
127   unsigned char s2k_count; /* This is the encoded form, not the raw
128                               count */
129   int simple_sk_checksum; /* create the deprecated rfc2440 secret key
130                              protection */
131   int not_dash_escaped;
132   int escape_from;
133   int lock_once;
134   struct keyserver_spec
135   {
136     char *uri;
137     char *scheme;
138     char *auth;
139     char *host;
140     char *port;
141     char *path;
142     char *opaque;
143     strlist_t options;
144     struct
145     {
146       unsigned int direct_uri:1;
147     } flags;
148     struct keyserver_spec *next;
149   } *keyserver;
150   struct
151   {
152     unsigned int options;
153     unsigned int import_options;
154     unsigned int export_options;
155     strlist_t other;
156   } keyserver_options;
157   int exec_disable;
158   int exec_path_set;
159   unsigned int import_options;
160   unsigned int export_options;
161   unsigned int list_options;
162   unsigned int verify_options;
163   const char *def_preference_list;
164   const char *def_keyserver_url;
165   prefitem_t *personal_cipher_prefs;
166   prefitem_t *personal_digest_prefs;
167   prefitem_t *personal_compress_prefs;
168   int no_perm_warn;
169   int no_mdc_warn;
170   char *temp_dir;
171   int no_encrypt_to;
172   int interactive;
173   struct notation *sig_notations;
174   struct notation *cert_notations;
175   strlist_t sig_policy_url;
176   strlist_t cert_policy_url;
177   strlist_t sig_keyserver_url;
178   strlist_t cert_subpackets;
179   strlist_t sig_subpackets;
180   int allow_non_selfsigned_uid;
181   int allow_freeform_uid;
182   int no_literal;
183   ulong set_filesize;
184   int fast_list_mode;
185   int ignore_time_conflict;
186   int ignore_valid_from;
187   int ignore_crc_error;
188   int ignore_mdc_error;
189   int command_fd;
190   const char *override_session_key;
191   int show_session_key;
192
193   const char *gpg_agent_info;
194   int try_all_secrets;
195   int no_expensive_trust_checks;
196   int no_sig_cache;
197   int no_sig_create_check;
198   int no_auto_check_trustdb;
199   int preserve_permissions;
200   int no_homedir_creation;
201   struct groupitem *grouplist;
202   int mangle_dos_filenames;
203   int enable_progress_filter;
204   unsigned int screen_columns;
205   unsigned int screen_lines;
206   byte *show_subpackets;
207   int rfc2440_text;
208
209   /* If true, let write failures on the status-fd exit the process. */
210   int exit_on_status_write_error;
211
212   /* If > 0, limit the number of card insertion prompts to this
213      value. */
214   int limit_card_insert_tries;
215
216 #ifdef ENABLE_CARD_SUPPORT
217   /* FIXME: We don't needs this here as it is done in scdaemon. */
218   const char *ctapi_driver; /* Library to access the ctAPI. */
219   const char *pcsc_driver;  /* Library to access the PC/SC system. */
220   int disable_ccid;    /* Disable the use of the internal CCID driver. */
221 #endif /*ENABLE_CARD_SUPPORT*/
222
223   struct
224   {
225     /* If set, require an 0x19 backsig to be present on signatures
226        made by signing subkeys.  If not set, a missing backsig is not
227        an error (but an invalid backsig still is). */
228     unsigned int require_cross_cert:1;
229
230     unsigned int use_embedded_filename:1;
231     unsigned int utf8_filename:1;
232     unsigned int dsa2:1;
233     unsigned int allow_multiple_messages:1;
234     unsigned int allow_weak_digest_algos:1;
235     unsigned int large_rsa:1;
236   } flags;
237
238   /* Linked list of ways to find a key if the key isn't on the local
239      keyring. */
240   struct akl
241   {
242     enum {
243       AKL_NODEFAULT,
244       AKL_LOCAL,
245       AKL_CERT,
246       AKL_PKA,
247       AKL_LDAP,
248       AKL_KEYSERVER,
249       AKL_SPEC
250     } type;
251     struct keyserver_spec *spec;
252     struct akl *next;
253   } *auto_key_locate;
254
255   int passphrase_repeat;
256 } opt;
257
258 /* CTRL is used to keep some global variables we currently can't
259    avoid.  Future concurrent versions of gpg will put it into a per
260    request structure CTRL. */
261 EXTERN_UNLESS_MAIN_MODULE
262 struct {
263   int in_auto_key_retrieve; /* True if we are doing an
264                                auto_key_retrieve. */
265 } glo_ctrl;
266
267 #define DBG_PACKET_VALUE  1     /* debug packet reading/writing */
268 #define DBG_MPI_VALUE     2     /* debug mpi details */
269 #define DBG_CIPHER_VALUE  4     /* debug cipher handling */
270                                 /* (may reveal sensitive data) */
271 #define DBG_FILTER_VALUE  8     /* debug internal filter handling */
272 #define DBG_IOBUF_VALUE   16    /* debug iobuf stuff */
273 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
274 #define DBG_CACHE_VALUE   64    /* debug the cacheing */
275 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
276 #define DBG_TRUST_VALUE   256   /* debug the trustdb */
277 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
278 #define DBG_EXTPROG_VALUE 1024  /* debug external program calls */
279 #define DBG_CARD_IO_VALUE 2048  /* debug smart card I/O.  */
280
281 /* Fixme: For now alias this value.  */
282 #define DBG_ASSUAN_VALUE  DBG_EXTPROG_VALUE
283
284
285 /* Tests for the debugging flags.  */
286 #define DBG_PACKET (opt.debug & DBG_PACKET_VALUE)
287 #define DBG_CIPHER (opt.debug & DBG_CIPHER_VALUE)
288 #define DBG_FILTER (opt.debug & DBG_FILTER_VALUE)
289 #define DBG_CACHE  (opt.debug & DBG_CACHE_VALUE)
290 #define DBG_TRUST  (opt.debug & DBG_TRUST_VALUE)
291 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
292 #define DBG_EXTPROG (opt.debug & DBG_EXTPROG_VALUE)
293 #define DBG_CARD_IO (opt.debug & DBG_CARD_IO_VALUE)
294 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
295
296 /* FIXME: We need to check whey we did not put this into opt. */
297 #define DBG_MEMORY    memory_debug_mode
298 #define DBG_MEMSTAT   memory_stat_debug_mode
299
300 EXTERN_UNLESS_MAIN_MODULE int memory_debug_mode;
301 EXTERN_UNLESS_MAIN_MODULE int memory_stat_debug_mode;
302
303
304
305 #define GNUPG   (opt.compliance==CO_GNUPG)
306 #define RFC1991 (opt.compliance==CO_RFC1991 || opt.compliance==CO_PGP2)
307 #define RFC2440 (opt.compliance==CO_RFC2440)
308 #define RFC4880 (opt.compliance==CO_RFC4880)
309 #define PGP2    (opt.compliance==CO_PGP2)
310 #define PGP6    (opt.compliance==CO_PGP6)
311 #define PGP7    (opt.compliance==CO_PGP7)
312 #define PGP8    (opt.compliance==CO_PGP8)
313 #define PGPX    (PGP2 || PGP6 || PGP7 || PGP8)
314
315 /* Various option flags.  Note that there should be no common string
316    names between the IMPORT_ and EXPORT_ flags as they can be mixed in
317    the keyserver-options option. */
318
319 #define IMPORT_LOCAL_SIGS                (1<<0)
320 #define IMPORT_REPAIR_PKS_SUBKEY_BUG     (1<<1)
321 #define IMPORT_FAST                      (1<<2)
322 #define IMPORT_SK2PK                     (1<<3)
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
350 #define VERIFY_SHOW_PHOTOS               (1<<0)
351 #define VERIFY_SHOW_POLICY_URLS          (1<<1)
352 #define VERIFY_SHOW_STD_NOTATIONS        (1<<2)
353 #define VERIFY_SHOW_USER_NOTATIONS       (1<<3)
354 #define VERIFY_SHOW_NOTATIONS (VERIFY_SHOW_STD_NOTATIONS|VERIFY_SHOW_USER_NOTATIONS)
355 #define VERIFY_SHOW_KEYSERVER_URLS       (1<<4)
356 #define VERIFY_SHOW_UID_VALIDITY         (1<<5)
357 #define VERIFY_SHOW_UNUSABLE_UIDS        (1<<6)
358 #define VERIFY_PKA_LOOKUPS               (1<<7)
359 #define VERIFY_PKA_TRUST_INCREASE        (1<<8)
360 #define VERIFY_SHOW_PRIMARY_UID_ONLY     (1<<9)
361
362 #define KEYSERVER_USE_TEMP_FILES         (1<<0)
363 #define KEYSERVER_KEEP_TEMP_FILES        (1<<1)
364 #define KEYSERVER_ADD_FAKE_V3            (1<<2)
365 #define KEYSERVER_AUTO_KEY_RETRIEVE      (1<<3)
366 #define KEYSERVER_HONOR_KEYSERVER_URL    (1<<4)
367 #define KEYSERVER_HONOR_PKA_RECORD       (1<<5)
368
369 #endif /*G10_OPTIONS_H*/