* options.h: Encapsulate keyserver details. Change all callers.
[gnupg.git] / g10 / options.h
1 /* options.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
3  *               2004 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 <sys/types.h>
25 #include <types.h>
26 #include "main.h"
27 #include "packet.h"
28
29 #undef ENABLE_COMMENT_PACKETS  /* don't create comment packets */
30
31 #ifndef EXTERN_UNLESS_MAIN_MODULE
32 /* Norcraft can't cope with common symbols */
33 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
34 #define EXTERN_UNLESS_MAIN_MODULE extern
35 #else
36 #define EXTERN_UNLESS_MAIN_MODULE 
37 #endif
38 #endif
39
40 EXTERN_UNLESS_MAIN_MODULE
41 struct
42 {
43   int verbose;
44   int quiet;
45   unsigned debug;
46   int armor;
47   char *outfile;
48   off_t max_output;
49   int dry_run;
50   int list_only;
51   int textmode;
52   int expert;
53   int ask_sig_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 sk_comments;
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_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 *host;
133     char *port;
134     char *opaque;
135   } keyserver;
136   struct
137   {
138     int verbose;
139     int include_revoked;
140     int include_disabled;
141     int include_subkeys;
142     int use_temp_files;
143     int keep_temp_files;
144     int fake_v3_keyids;
145     int auto_key_retrieve;
146     int try_dns_srv;
147     unsigned int import_options;
148     unsigned int export_options;
149     STRLIST other;
150   } keyserver_options;
151   int exec_disable;
152   int exec_path_set;
153   unsigned int import_options;
154   unsigned int export_options;
155   unsigned int list_options;
156   unsigned int verify_options;
157   char *def_preference_list;
158   prefitem_t *personal_cipher_prefs;
159   prefitem_t *personal_digest_prefs;
160   prefitem_t *personal_compress_prefs;
161   int no_perm_warn;
162   int no_mdc_warn;
163   char *temp_dir;
164   int no_encrypt_to;
165   int interactive;
166   STRLIST sig_notation_data;
167   STRLIST cert_notation_data;
168   STRLIST sig_policy_url;
169   STRLIST cert_policy_url;
170   STRLIST sig_keyserver_url;
171   int use_embedded_filename;
172   int allow_non_selfsigned_uid;
173   int allow_freeform_uid;
174   int no_literal;
175   ulong set_filesize;
176   int fast_list_mode;
177   int fixed_list_mode;
178   int ignore_time_conflict;
179   int ignore_valid_from;
180   int ignore_crc_error;
181   int ignore_mdc_error;
182   int command_fd;
183   const char *override_session_key;
184   int show_session_key;
185   int use_agent;
186   const char *gpg_agent_info;
187   int try_all_secrets;
188   int no_expensive_trust_checks;
189   int no_sig_cache;
190   int no_sig_create_check;
191   int no_auto_check_trustdb;
192   int preserve_permissions;
193   int no_homedir_creation;
194   struct groupitem *grouplist;
195   int strict;
196   int mangle_dos_filenames; 
197   int enable_progress_filter;
198   int screen_columns;
199   int screen_lines;
200
201 #ifdef ENABLE_CARD_SUPPORT
202   const char *ctapi_driver; /* Library to access the ctAPI. */
203   const char *pcsc_driver;  /* Library to access the PC/SC system. */
204   int disable_ccid;    /* Disable the use of the internal CCID driver. */
205 #endif /*ENABLE_CARD_SUPPORT*/
206
207 } opt;
208
209 #define DBG_PACKET_VALUE  1     /* debug packet reading/writing */
210 #define DBG_MPI_VALUE     2     /* debug mpi details */
211 #define DBG_CIPHER_VALUE  4     /* debug cipher handling */
212                                 /* (may reveal sensitive data) */
213 #define DBG_FILTER_VALUE  8     /* debug internal filter handling */
214 #define DBG_IOBUF_VALUE   16    /* debug iobuf stuff */
215 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
216 #define DBG_CACHE_VALUE   64    /* debug the cacheing */
217 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
218 #define DBG_TRUST_VALUE   256   /* debug the trustdb */
219 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
220 #define DBG_EXTPROG_VALUE 1024  /* debug external program calls */
221 #define DBG_CARD_IO_VALUE 2048
222
223 #define DBG_PACKET (opt.debug & DBG_PACKET_VALUE)
224 #define DBG_FILTER (opt.debug & DBG_FILTER_VALUE)
225 #define DBG_CACHE  (opt.debug & DBG_CACHE_VALUE)
226 #define DBG_TRUST  (opt.debug & DBG_TRUST_VALUE)
227 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
228 #define DBG_EXTPROG (opt.debug & DBG_EXTPROG_VALUE)
229 #define DBG_CARD_IO (opt.debug & DBG_CARD_IO_VALUE)
230
231
232 #define GNUPG   (opt.compliance==CO_GNUPG)
233 #define RFC1991 (opt.compliance==CO_RFC1991 || opt.compliance==CO_PGP2)
234 #define RFC2440 (opt.compliance==CO_RFC2440)
235 #define PGP2    (opt.compliance==CO_PGP2)
236 #define PGP6    (opt.compliance==CO_PGP6)
237 #define PGP7    (opt.compliance==CO_PGP7)
238 #define PGP8    (opt.compliance==CO_PGP8)
239
240 /* Various option flags */
241
242 #define IMPORT_ALLOW_LOCAL_SIGS          (1<<0)
243 #define IMPORT_REPAIR_PKS_SUBKEY_BUG     (1<<1)
244 #define IMPORT_FAST_IMPORT               (1<<2)
245 #define IMPORT_SK2PK                     (1<<3)
246 #define IMPORT_MERGE_ONLY                (1<<4)
247
248 #define EXPORT_INCLUDE_LOCAL_SIGS        (1<<0)
249 #define EXPORT_INCLUDE_ATTRIBUTES        (1<<1)
250 #define EXPORT_INCLUDE_SENSITIVE_REVKEYS (1<<2)
251
252 #define LIST_SHOW_PHOTOS                 (1<<0)
253 #define LIST_SHOW_POLICY_URLS            (1<<1)
254 #define LIST_SHOW_NOTATIONS              (1<<2)
255 #define LIST_SHOW_KEYSERVER_URLS         (1<<3)
256 #define LIST_SHOW_VALIDITY               (1<<4)
257 #define LIST_SHOW_UNUSABLE_UIDS          (1<<5)
258 #define LIST_SHOW_UNUSABLE_SUBKEYS       (1<<6)
259 #define LIST_SHOW_KEYRING                (1<<7)
260 #define LIST_SHOW_SIG_EXPIRE             (1<<8)
261
262 #define VERIFY_SHOW_PHOTOS               (1<<0)
263 #define VERIFY_SHOW_POLICY_URLS          (1<<1)
264 #define VERIFY_SHOW_NOTATIONS            (1<<2)
265 #define VERIFY_SHOW_KEYSERVER_URLS       (1<<3)
266 #define VERIFY_SHOW_VALIDITY             (1<<4)
267 #define VERIFY_SHOW_UNUSABLE_UIDS        (1<<5)
268
269 #endif /*G10_OPTIONS_H*/