* options.h, g10.c (main), compress.c (init_compress), compress-bz2.c
[gnupg.git] / g10 / options.h
1 /* options.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002,
3  *               2003 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21 #ifndef G10_OPTIONS_H
22 #define G10_OPTIONS_H
23
24 #include <types.h>
25 #include "main.h"
26 #include "packet.h"
27
28 #undef ENABLE_COMMENT_PACKETS  /* don't create comment packets */
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     int verbose;
42     int quiet;
43     unsigned debug;
44     int armor;
45     char *outfile;
46     int dry_run;
47     int list_only;
48     int textmode;
49     int expert;
50     int ask_sig_expire;
51     int ask_cert_expire;
52     int batch;      /* run in batch mode */
53     int answer_yes; /* answer yes on most questions */
54     int answer_no;  /* answer no on most questions */
55     int check_sigs; /* check key signatures */
56     int with_colons;
57     int with_key_data;
58     int with_fingerprint; /* opt --with-fingerprint active */
59     int fingerprint; /* list fingerprints */
60     int list_sigs;   /* list signatures */
61     int no_armor;
62     int list_packets; /* list-packets mode: 1=normal, 2=invoked by command*/
63     int def_cipher_algo;
64     int force_v3_sigs;
65     int force_v4_certs;
66     int force_mdc;
67     int disable_mdc;
68     int def_digest_algo;
69     int cert_digest_algo;
70     int compress_algo;
71     int compress_level;
72     int bz2_compress_level;
73     const char *def_secret_key;
74     char *def_recipient;
75     int def_recipient_self;
76     int def_cert_check_level;
77     int sk_comments;
78     int no_version;
79     int marginals_needed;
80     int completes_needed;
81     int max_cert_depth;
82     const char *homedir;
83
84     char *display;      /* 5 options to be passed to the gpg-agent */
85     char *ttyname;     
86     char *ttytype;
87     char *lc_ctype;
88     char *lc_messages;
89
90     int skip_verify;
91     int compress_keys;
92     int compress_sigs;
93     /* TM_CLASSIC must be zero to accomodate trustdbs generated before
94        we started storing the trust model inside the trustdb. */
95     enum
96       {
97         TM_CLASSIC=0, TM_PGP=1, TM_EXTERNAL=2, TM_ALWAYS, TM_AUTO
98       } trust_model;
99     unsigned int force_ownertrust;
100     enum
101       {
102         CO_GNUPG=0, CO_RFC2440, CO_RFC1991, CO_PGP2, CO_PGP6, CO_PGP7, CO_PGP8
103       } compliance;
104     int pgp2_workarounds;
105     unsigned int emulate_bugs; /* bug emulation flags EMUBUG_xxxx */
106     int shm_coprocess;
107     const char *set_filename;
108     STRLIST comments;
109     int throw_keyid;
110     const char *photo_viewer;
111     int s2k_mode;
112     int s2k_digest_algo;
113     int s2k_cipher_algo;
114     int simple_sk_checksum; /* create the deprecated rfc2440 secret
115                                key protection*/
116     int not_dash_escaped;
117     int escape_from;
118     int lock_once;
119     char *keyserver_uri;
120     char *keyserver_scheme;
121     char *keyserver_host;
122     char *keyserver_port;
123     char *keyserver_opaque;
124     struct
125     {
126       int verbose;
127       int include_revoked;
128       int include_disabled;
129       int include_subkeys;
130       int honor_http_proxy;
131       int broken_http_proxy;
132       int use_temp_files;
133       int keep_temp_files;
134       int fake_v3_keyids;
135       int auto_key_retrieve;
136       int try_dns_srv;
137       unsigned int import_options;
138       unsigned int export_options;
139       STRLIST other;
140     } keyserver_options;
141     int exec_disable;
142     int exec_path_set;
143     unsigned int import_options;
144     unsigned int export_options;
145     unsigned int list_options;
146     unsigned int verify_options;
147     char *def_preference_list;
148     prefitem_t *personal_cipher_prefs;
149     prefitem_t *personal_digest_prefs;
150     prefitem_t *personal_compress_prefs;
151     int no_perm_warn;
152     int no_mdc_warn;
153     char *temp_dir;
154     int no_encrypt_to;
155     int interactive;
156     STRLIST sig_notation_data;
157     STRLIST cert_notation_data;
158     STRLIST sig_policy_url;
159     STRLIST cert_policy_url;
160     STRLIST sig_keyserver_url;
161     int use_embedded_filename;
162     int allow_non_selfsigned_uid;
163     int allow_freeform_uid;
164     int no_literal;
165     ulong set_filesize;
166     int fast_list_mode;
167     int fixed_list_mode;
168     int ignore_time_conflict;
169     int ignore_valid_from;
170     int ignore_crc_error;
171     int ignore_mdc_error;
172     int command_fd;
173     const char *override_session_key;
174     int show_session_key;
175     int use_agent;
176     const char *gpg_agent_info;
177     int merge_only;
178     int try_all_secrets;
179     int no_expensive_trust_checks;
180     int no_sig_cache;
181     int no_sig_create_check;
182     int no_auto_check_trustdb;
183     int preserve_permissions;
184     int no_homedir_creation;
185     struct groupitem *grouplist;
186     int strict;
187     int mangle_dos_filenames; 
188     int enable_progress_filter;
189
190 #ifdef ENABLE_CARD_SUPPORT
191     const char *ctapi_driver; /* Library to access the ctAPI. */
192     const char *pcsc_driver;  /* Library to access the PC/SC system. */
193     int disable_ccid;    /* Disable the use of the internal CCID driver. */
194 #endif /*ENABLE_CARD_SUPPORT*/
195
196 } opt;
197
198
199 #define EMUBUG_MDENCODE   4
200
201 #define DBG_PACKET_VALUE  1     /* debug packet reading/writing */
202 #define DBG_MPI_VALUE     2     /* debug mpi details */
203 #define DBG_CIPHER_VALUE  4     /* debug cipher handling */
204                                 /* (may reveal sensitive data) */
205 #define DBG_FILTER_VALUE  8     /* debug internal filter handling */
206 #define DBG_IOBUF_VALUE   16    /* debug iobuf stuff */
207 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
208 #define DBG_CACHE_VALUE   64    /* debug the cacheing */
209 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
210 #define DBG_TRUST_VALUE   256   /* debug the trustdb */
211 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
212 #define DBG_EXTPROG_VALUE 1024  /* debug external program calls */
213 #define DBG_CARD_IO_VALUE 2048
214
215
216 #define DBG_PACKET (opt.debug & DBG_PACKET_VALUE)
217 #define DBG_FILTER (opt.debug & DBG_FILTER_VALUE)
218 #define DBG_CACHE  (opt.debug & DBG_CACHE_VALUE)
219 #define DBG_TRUST  (opt.debug & DBG_TRUST_VALUE)
220 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
221 #define DBG_EXTPROG (opt.debug & DBG_EXTPROG_VALUE)
222 #define DBG_CARD_IO (opt.debug & DBG_CARD_IO_VALUE)
223
224 #define GNUPG   (opt.compliance==CO_GNUPG)
225 #define RFC1991 (opt.compliance==CO_RFC1991 || opt.compliance==CO_PGP2)
226 #define RFC2440 (opt.compliance==CO_RFC2440)
227 #define PGP2    (opt.compliance==CO_PGP2)
228 #define PGP6    (opt.compliance==CO_PGP6)
229 #define PGP7    (opt.compliance==CO_PGP7)
230 #define PGP8    (opt.compliance==CO_PGP8)
231
232 /* Various option flags */
233
234 #define IMPORT_ALLOW_LOCAL_SIGS          (1<<0)
235 #define IMPORT_REPAIR_PKS_SUBKEY_BUG     (1<<1)
236 #define IMPORT_FAST_IMPORT               (1<<2)
237 #define IMPORT_SK2PK                     (1<<3)
238
239 #define EXPORT_INCLUDE_NON_RFC           (1<<0)
240 #define EXPORT_INCLUDE_LOCAL_SIGS        (1<<1)
241 #define EXPORT_INCLUDE_ATTRIBUTES        (1<<2)
242 #define EXPORT_INCLUDE_SENSITIVE_REVKEYS (1<<3)
243
244 #define LIST_SHOW_PHOTOS                 (1<<0)
245 #define LIST_SHOW_POLICY_URLS            (1<<1)
246 #define LIST_SHOW_NOTATIONS              (1<<2)
247 #define LIST_SHOW_KEYSERVER_URLS         (1<<3)
248 #define LIST_SHOW_VALIDITY               (1<<4)
249 #define LIST_SHOW_LONG_KEYIDS            (1<<5)
250 #define LIST_SHOW_UNUSABLE_UIDS          (1<<6)
251 #define LIST_SHOW_KEYRING                (1<<7)
252 #define LIST_SHOW_SIG_EXPIRE             (1<<8)
253
254 #define VERIFY_SHOW_PHOTOS               (1<<0)
255 #define VERIFY_SHOW_POLICY_URLS          (1<<1)
256 #define VERIFY_SHOW_NOTATIONS            (1<<2)
257 #define VERIFY_SHOW_KEYSERVER_URLS       (1<<3)
258 #define VERIFY_SHOW_VALIDITY             (1<<4)
259 #define VERIFY_SHOW_LONG_KEYIDS          (1<<5)
260 #define VERIFY_SHOW_UNUSABLE_UIDS        (1<<6)
261
262 #endif /*G10_OPTIONS_H*/