Import OpenPGP keys into the agent.
[gnupg.git] / g10 / options.h
1 /* options.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
3  *               2007, 2010 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   FILE *outfp;      /* Hack, sometimes used in place of outfile.  */
47   off_t max_output;
48   int dry_run;
49   int list_only;
50   int textmode;
51   int expert;
52   const char *def_sig_expire;
53   int ask_sig_expire;
54   const char *def_cert_expire;
55   int ask_cert_expire;
56   int batch;        /* run in batch mode */
57   int answer_yes; /* answer yes on most questions */
58   int answer_no;  /* answer no on most questions */
59   int check_sigs; /* check key signatures */
60   int with_colons;
61   int with_key_data;
62   int with_fingerprint; /* opt --with-fingerprint active */
63   int fingerprint; /* list fingerprints */
64   int list_sigs;   /* list signatures */
65   int no_armor;
66   int list_packets; /* list-packets mode: 1=normal, 2=invoked by command*/
67   int def_cipher_algo;
68   int force_v3_sigs;
69   int force_v4_certs;
70   int force_mdc;
71   int disable_mdc;
72   int def_digest_algo;
73   int cert_digest_algo;
74   int compress_algo;
75   int compress_level;
76   int bz2_compress_level;
77   int bz2_decompress_lowmem;
78   const char *def_secret_key;
79   char *def_recipient;
80   int def_recipient_self;
81   int def_cert_level;
82   int min_cert_level;
83   int ask_cert_level;
84   int no_version;
85   int marginals_needed;
86   int completes_needed;
87   int max_cert_depth;
88   const char *homedir;
89   const char *agent_program; 
90
91   /* Options to be passed to the gpg-agent */
92   session_env_t session_env;
93   char *lc_ctype;
94   char *lc_messages;
95
96   int skip_verify;
97   int skip_hidden_recipients;
98   int compress_keys;
99   int compress_sigs;
100   /* TM_CLASSIC must be zero to accomodate trustdbs generated before
101      we started storing the trust model inside the trustdb. */
102   enum
103     {
104       TM_CLASSIC=0, TM_PGP=1, TM_EXTERNAL=2, TM_ALWAYS, TM_DIRECT, TM_AUTO
105     } trust_model;
106   int force_ownertrust;
107   enum
108     {
109       CO_GNUPG, CO_RFC4880, CO_RFC2440, CO_RFC1991, CO_PGP2,
110       CO_PGP6, CO_PGP7, CO_PGP8
111     } compliance;
112   enum
113     {
114       KF_SHORT, KF_LONG, KF_0xSHORT, KF_0xLONG
115     } keyid_format;
116   int pgp2_workarounds;
117   int shm_coprocess;
118   const char *set_filename;
119   strlist_t comments;
120   int throw_keyid;
121   const char *photo_viewer;
122   int s2k_mode;
123   int s2k_digest_algo;
124   int s2k_cipher_algo;
125   unsigned char s2k_count; /* This is the encoded form, not the raw
126                               count */
127   int simple_sk_checksum; /* create the deprecated rfc2440 secret key
128                              protection */
129   int not_dash_escaped;
130   int escape_from;
131   int lock_once;
132   struct keyserver_spec
133   {
134     char *uri;
135     char *scheme;
136     char *auth;
137     char *host;
138     char *port;
139     char *path;
140     char *opaque;
141     strlist_t options;
142     struct
143     {
144       unsigned int direct_uri:1;
145     } flags;
146     struct keyserver_spec *next;
147   } *keyserver;
148   struct
149   {
150     unsigned int options;
151     unsigned int import_options;
152     unsigned int export_options;
153     strlist_t other;
154   } keyserver_options;
155   int exec_disable;
156   int exec_path_set;
157   unsigned int import_options;
158   unsigned int export_options;
159   unsigned int list_options;
160   unsigned int verify_options;
161   const char *def_preference_list;
162   const char *def_keyserver_url;
163   prefitem_t *personal_cipher_prefs;
164   prefitem_t *personal_digest_prefs;
165   prefitem_t *personal_compress_prefs;
166   int no_perm_warn;
167   int no_mdc_warn;
168   char *temp_dir;
169   int no_encrypt_to;
170   int interactive;
171   struct notation *sig_notations;
172   struct notation *cert_notations;
173   strlist_t sig_policy_url;
174   strlist_t cert_policy_url;
175   strlist_t sig_keyserver_url;
176   strlist_t cert_subpackets;
177   strlist_t sig_subpackets;
178   int allow_non_selfsigned_uid;
179   int allow_freeform_uid;
180   int no_literal;
181   ulong set_filesize;
182   int fast_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   } flags;
233
234   /* Linked list of ways to find a key if the key isn't on the local
235      keyring. */
236   struct akl
237   {
238     enum {
239       AKL_NODEFAULT,
240       AKL_LOCAL,
241       AKL_CERT, 
242       AKL_PKA, 
243       AKL_LDAP,
244       AKL_KEYSERVER,
245       AKL_SPEC
246     } type;
247     struct keyserver_spec *spec;
248     struct akl *next;
249   } *auto_key_locate;
250
251   int passphrase_repeat;
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
282 /* Fixme: For now alias this value.  */
283 #define DBG_ASSUAN_VALUE  DBG_EXTPROG_VALUE
284
285
286 /* Tests for the debugging flags.  */
287 #define DBG_PACKET (opt.debug & DBG_PACKET_VALUE)
288 #define DBG_CIPHER (opt.debug & DBG_CIPHER_VALUE)
289 #define DBG_FILTER (opt.debug & DBG_FILTER_VALUE)
290 #define DBG_CACHE  (opt.debug & DBG_CACHE_VALUE)
291 #define DBG_TRUST  (opt.debug & DBG_TRUST_VALUE)
292 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
293 #define DBG_EXTPROG (opt.debug & DBG_EXTPROG_VALUE)
294 #define DBG_CARD_IO (opt.debug & DBG_CARD_IO_VALUE)
295 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
296
297 /* FIXME: We need to check whey we did not put this into opt. */
298 #define DBG_MEMORY    memory_debug_mode
299 #define DBG_MEMSTAT   memory_stat_debug_mode
300
301 EXTERN_UNLESS_MAIN_MODULE int memory_debug_mode;
302 EXTERN_UNLESS_MAIN_MODULE int memory_stat_debug_mode;
303
304
305
306 #define GNUPG   (opt.compliance==CO_GNUPG)
307 #define RFC1991 (opt.compliance==CO_RFC1991 || opt.compliance==CO_PGP2)
308 #define RFC2440 (opt.compliance==CO_RFC2440)
309 #define RFC4880 (opt.compliance==CO_RFC4880)
310 #define PGP2    (opt.compliance==CO_PGP2)
311 #define PGP6    (opt.compliance==CO_PGP6)
312 #define PGP7    (opt.compliance==CO_PGP7)
313 #define PGP8    (opt.compliance==CO_PGP8)
314 #define PGPX    (PGP2 || 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
327 #define EXPORT_LOCAL_SIGS                (1<<0)
328 #define EXPORT_ATTRIBUTES                (1<<1)
329 #define EXPORT_SENSITIVE_REVKEYS         (1<<2)
330 #define EXPORT_RESET_SUBKEY_PASSWD       (1<<3)
331 #define EXPORT_MINIMAL                   (1<<4)
332 #define EXPORT_CLEAN                     (1<<5)
333 #define EXPORT_SEXP_FORMAT               (1<<6)
334
335 #define LIST_SHOW_PHOTOS                 (1<<0)
336 #define LIST_SHOW_POLICY_URLS            (1<<1)
337 #define LIST_SHOW_STD_NOTATIONS          (1<<2)
338 #define LIST_SHOW_USER_NOTATIONS         (1<<3)
339 #define LIST_SHOW_NOTATIONS (LIST_SHOW_STD_NOTATIONS|LIST_SHOW_USER_NOTATIONS)
340 #define LIST_SHOW_KEYSERVER_URLS         (1<<4)
341 #define LIST_SHOW_UID_VALIDITY           (1<<5)
342 #define LIST_SHOW_UNUSABLE_UIDS          (1<<6)
343 #define LIST_SHOW_UNUSABLE_SUBKEYS       (1<<7)
344 #define LIST_SHOW_KEYRING                (1<<8)
345 #define LIST_SHOW_SIG_EXPIRE             (1<<9)
346 #define LIST_SHOW_SIG_SUBPACKETS         (1<<10)
347
348 #define VERIFY_SHOW_PHOTOS               (1<<0)
349 #define VERIFY_SHOW_POLICY_URLS          (1<<1)
350 #define VERIFY_SHOW_STD_NOTATIONS        (1<<2)
351 #define VERIFY_SHOW_USER_NOTATIONS       (1<<3)
352 #define VERIFY_SHOW_NOTATIONS (VERIFY_SHOW_STD_NOTATIONS|VERIFY_SHOW_USER_NOTATIONS)
353 #define VERIFY_SHOW_KEYSERVER_URLS       (1<<4)
354 #define VERIFY_SHOW_UID_VALIDITY         (1<<5)
355 #define VERIFY_SHOW_UNUSABLE_UIDS        (1<<6)
356 #define VERIFY_PKA_LOOKUPS               (1<<7)
357 #define VERIFY_PKA_TRUST_INCREASE        (1<<8)
358 #define VERIFY_SHOW_PRIMARY_UID_ONLY     (1<<9)
359
360 #define KEYSERVER_USE_TEMP_FILES         (1<<0)
361 #define KEYSERVER_KEEP_TEMP_FILES        (1<<1)
362 #define KEYSERVER_ADD_FAKE_V3            (1<<2)
363 #define KEYSERVER_AUTO_KEY_RETRIEVE      (1<<3)
364 #define KEYSERVER_HONOR_KEYSERVER_URL    (1<<4)
365 #define KEYSERVER_HONOR_PKA_RECORD       (1<<5)
366
367 #endif /*G10_OPTIONS_H*/