* gpg.sgml (http):
[gnupg.git] / g10 / options.h
1 /* options.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3  *               2005 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 2 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, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
20  * USA.
21  */
22 #ifndef G10_OPTIONS_H
23 #define G10_OPTIONS_H
24
25 #include <sys/types.h>
26 #include <types.h>
27 #include "main.h"
28 #include "packet.h"
29
30 #ifndef EXTERN_UNLESS_MAIN_MODULE
31 /* Norcraft can't cope with common symbols */
32 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
33 #define EXTERN_UNLESS_MAIN_MODULE extern
34 #else
35 #define EXTERN_UNLESS_MAIN_MODULE 
36 #endif
37 #endif
38
39 EXTERN_UNLESS_MAIN_MODULE
40 struct
41 {
42   int verbose;
43   int quiet;
44   unsigned debug;
45   int armor;
46   char *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
90   char *display;      /* 5 options to be passed to the gpg-agent */
91   char *ttyname;     
92   char *ttytype;
93   char *lc_ctype;
94   char *lc_messages;
95
96   int skip_verify;
97   int compress_keys;
98   int compress_sigs;
99   /* TM_CLASSIC must be zero to accomodate trustdbs generated before
100      we started storing the trust model inside the trustdb. */
101   enum
102     {
103       TM_CLASSIC=0, TM_PGP=1, TM_EXTERNAL=2, TM_ALWAYS, TM_DIRECT, TM_AUTO
104     } trust_model;
105   int force_ownertrust;
106   enum
107     {
108       CO_GNUPG=0, CO_RFC2440, CO_RFC1991, CO_PGP2, CO_PGP6, CO_PGP7, CO_PGP8
109     } compliance;
110   enum
111     {
112       KF_SHORT, KF_LONG, KF_0xSHORT, KF_0xLONG
113     } keyid_format;
114   int pgp2_workarounds;
115   int shm_coprocess;
116   const char *set_filename;
117   STRLIST comments;
118   int throw_keyid;
119   const char *photo_viewer;
120   int s2k_mode;
121   int s2k_digest_algo;
122   int s2k_cipher_algo;
123   int simple_sk_checksum; /* create the deprecated rfc2440 secret
124                              key protection*/
125   int not_dash_escaped;
126   int escape_from;
127   int lock_once;
128   struct keyserver_spec
129   {
130     char *uri;
131     char *scheme;
132     char *auth;
133     char *host;
134     char *port;
135     char *path;
136     char *opaque;
137   } *keyserver;
138   struct
139   {
140     unsigned int options;
141     unsigned int import_options;
142     unsigned int export_options;
143     STRLIST other;
144   } keyserver_options;
145   int exec_disable;
146   int exec_path_set;
147   unsigned int import_options;
148   unsigned int export_options;
149   unsigned int list_options;
150   unsigned int verify_options;
151   char *def_preference_list;
152   prefitem_t *personal_cipher_prefs;
153   prefitem_t *personal_digest_prefs;
154   prefitem_t *personal_compress_prefs;
155   int no_perm_warn;
156   int no_mdc_warn;
157   char *temp_dir;
158   int no_encrypt_to;
159   int interactive;
160   STRLIST sig_notation_data;
161   STRLIST cert_notation_data;
162   STRLIST sig_policy_url;
163   STRLIST cert_policy_url;
164   STRLIST sig_keyserver_url;
165   int use_embedded_filename;
166   int allow_non_selfsigned_uid;
167   int allow_freeform_uid;
168   int no_literal;
169   ulong set_filesize;
170   int fast_list_mode;
171   int fixed_list_mode;
172   int ignore_time_conflict;
173   int ignore_valid_from;
174   int ignore_crc_error;
175   int ignore_mdc_error;
176   int command_fd;
177   const char *override_session_key;
178   int show_session_key;
179   int use_agent;
180   const char *gpg_agent_info;
181   int try_all_secrets;
182   int no_expensive_trust_checks;
183   int no_sig_cache;
184   int no_sig_create_check;
185   int no_auto_check_trustdb;
186   int preserve_permissions;
187   int no_homedir_creation;
188   struct groupitem *grouplist;
189   int strict;
190   int mangle_dos_filenames;
191   int enable_progress_filter;
192   unsigned int screen_columns;
193   unsigned int screen_lines;
194   byte *show_subpackets;
195   int rfc2440_text;
196
197   /* If true, let write failures on the status-fd exit the process. */
198   int exit_on_status_write_error;
199
200   /* If > 0, limit the number of card insertion prompts to this
201      value. */
202   int limit_card_insert_tries; 
203
204 #ifdef ENABLE_CARD_SUPPORT
205   const char *ctapi_driver; /* Library to access the ctAPI. */
206   const char *pcsc_driver;  /* Library to access the PC/SC system. */
207   int disable_ccid;    /* Disable the use of the internal CCID driver. */
208 #endif /*ENABLE_CARD_SUPPORT*/
209
210 } opt;
211
212 /* CTRL is used to keep some global variables we currently can't
213    avoid.  Future concurrent versions of gpg will put it into a per
214    request structure CTRL. */
215 EXTERN_UNLESS_MAIN_MODULE
216 struct {
217   int in_auto_key_retrieve; /* True if we are doing an
218                                auto_key_retrieve. */
219 } glo_ctrl;
220
221 #define DBG_PACKET_VALUE  1     /* debug packet reading/writing */
222 #define DBG_MPI_VALUE     2     /* debug mpi details */
223 #define DBG_CIPHER_VALUE  4     /* debug cipher handling */
224                                 /* (may reveal sensitive data) */
225 #define DBG_FILTER_VALUE  8     /* debug internal filter handling */
226 #define DBG_IOBUF_VALUE   16    /* debug iobuf stuff */
227 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
228 #define DBG_CACHE_VALUE   64    /* debug the cacheing */
229 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
230 #define DBG_TRUST_VALUE   256   /* debug the trustdb */
231 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
232 #define DBG_EXTPROG_VALUE 1024  /* debug external program calls */
233 #define DBG_CARD_IO_VALUE 2048  /* debug smart card I/O.  */
234
235 #define DBG_PACKET (opt.debug & DBG_PACKET_VALUE)
236 #define DBG_FILTER (opt.debug & DBG_FILTER_VALUE)
237 #define DBG_CACHE  (opt.debug & DBG_CACHE_VALUE)
238 #define DBG_TRUST  (opt.debug & DBG_TRUST_VALUE)
239 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
240 #define DBG_EXTPROG (opt.debug & DBG_EXTPROG_VALUE)
241 #define DBG_CARD_IO (opt.debug & DBG_CARD_IO_VALUE)
242
243
244 #define GNUPG   (opt.compliance==CO_GNUPG)
245 #define RFC1991 (opt.compliance==CO_RFC1991 || opt.compliance==CO_PGP2)
246 #define RFC2440 (opt.compliance==CO_RFC2440)
247 #define PGP2    (opt.compliance==CO_PGP2)
248 #define PGP6    (opt.compliance==CO_PGP6)
249 #define PGP7    (opt.compliance==CO_PGP7)
250 #define PGP8    (opt.compliance==CO_PGP8)
251
252 /* Various option flags.  Note that there should be no common string
253    names between the IMPORT_ and EXPORT_ flags as they can be mixed in
254    the keyserver-options option. */
255
256 #define IMPORT_LOCAL_SIGS                (1<<0)
257 #define IMPORT_REPAIR_PKS_SUBKEY_BUG     (1<<1)
258 #define IMPORT_FAST                      (1<<2)
259 #define IMPORT_SK2PK                     (1<<3)
260 #define IMPORT_MERGE_ONLY                (1<<4)
261 #define IMPORT_CLEAN_SIGS                (1<<5)
262 #define IMPORT_CLEAN_UIDS                (1<<6)
263
264 #define EXPORT_LOCAL_SIGS                (1<<0)
265 #define EXPORT_ATTRIBUTES                (1<<1)
266 #define EXPORT_SENSITIVE_REVKEYS         (1<<2)
267 #define EXPORT_MINIMAL                   (1<<3)
268 #define EXPORT_CLEAN_SIGS                (1<<4)
269 #define EXPORT_CLEAN_UIDS                (1<<5)
270 #define EXPORT_RESET_SUBKEY_PASSWD       (1<<6)
271
272 #define LIST_SHOW_PHOTOS                 (1<<0)
273 #define LIST_SHOW_POLICY_URLS            (1<<1)
274 #define LIST_SHOW_STD_NOTATIONS          (1<<2)
275 #define LIST_SHOW_USER_NOTATIONS         (1<<3)
276 #define LIST_SHOW_NOTATIONS (LIST_SHOW_STD_NOTATIONS|LIST_SHOW_USER_NOTATIONS)
277 #define LIST_SHOW_KEYSERVER_URLS         (1<<4)
278 #define LIST_SHOW_UID_VALIDITY           (1<<5)
279 #define LIST_SHOW_UNUSABLE_UIDS          (1<<6)
280 #define LIST_SHOW_UNUSABLE_SUBKEYS       (1<<7)
281 #define LIST_SHOW_KEYRING                (1<<8)
282 #define LIST_SHOW_SIG_EXPIRE             (1<<9)
283 #define LIST_SHOW_SIG_SUBPACKETS         (1<<10)
284
285 #define VERIFY_SHOW_PHOTOS               (1<<0)
286 #define VERIFY_SHOW_POLICY_URLS          (1<<1)
287 #define VERIFY_SHOW_STD_NOTATIONS        (1<<2)
288 #define VERIFY_SHOW_USER_NOTATIONS       (1<<3)
289 #define VERIFY_SHOW_NOTATIONS (VERIFY_SHOW_STD_NOTATIONS|VERIFY_SHOW_USER_NOTATIONS)
290 #define VERIFY_SHOW_KEYSERVER_URLS       (1<<4)
291 #define VERIFY_SHOW_UID_VALIDITY         (1<<5)
292 #define VERIFY_SHOW_UNUSABLE_UIDS        (1<<6)
293
294 #define KEYSERVER_INCLUDE_REVOKED        (1<<0)
295 #define KEYSERVER_INCLUDE_SUBKEYS        (1<<1)
296 #define KEYSERVER_USE_TEMP_FILES         (1<<2)
297 #define KEYSERVER_KEEP_TEMP_FILES        (1<<3)
298 #define KEYSERVER_ADD_FAKE_V3            (1<<4)
299 #define KEYSERVER_AUTO_KEY_RETRIEVE      (1<<5)
300 #define KEYSERVER_TRY_DNS_SRV            (1<<6)
301 #define KEYSERVER_HONOR_KEYSERVER_URL    (1<<7)
302
303 #endif /*G10_OPTIONS_H*/