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 no_version;
  84   int marginals_needed;
  85   int completes_needed;
  86   int max_cert_depth;
  87   const char *homedir;
  88   const char *agent_program;
  89
  90   /* Options to be passed to the gpg-agent */
  91   session_env_t session_env;
  92   char *lc_ctype;
  93   char *lc_messages;
  94
  95   int skip_verify;
  96   int compress_keys;
  97   int compress_sigs;
  98   /* TM_CLASSIC must be zero to accomodate trustdbs generated before
  99      we started storing the trust model inside the trustdb. */
 100   enum
 101     {
 102       TM_CLASSIC=0, TM_PGP=1, TM_EXTERNAL=2, TM_ALWAYS, TM_DIRECT, TM_AUTO
 103     } trust_model;
 104   int force_ownertrust;
 105   enum
 106     {
 107       CO_GNUPG, CO_RFC4880, CO_RFC2440, CO_RFC1991, CO_PGP2,
 108       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_t 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   unsigned char s2k_count; /* This is the encoded form, not the raw
 124                               count */
 125   int simple_sk_checksum; /* create the deprecated rfc2440 secret key
 126                              protection */
 127   int not_dash_escaped;
 128   int escape_from;
 129   int lock_once;
 130   struct keyserver_spec
 131   {
 132     char *uri;
 133     char *scheme;
 134     char *auth;
 135     char *host;
 136     char *port;
 137     char *path;
 138     char *opaque;
 139     strlist_t options;
 140     struct
 141     {
 142       unsigned int direct_uri:1;
 143     } flags;
 144     struct keyserver_spec *next;
 145   } *keyserver;
 146   struct
 147   {
 148     unsigned int options;
 149     unsigned int import_options;
 150     unsigned int export_options;
 151     strlist_t other;
 152   } keyserver_options;
 153   int exec_disable;
 154   int exec_path_set;
 155   unsigned int import_options;
 156   unsigned int export_options;
 157   unsigned int list_options;
 158   unsigned int verify_options;
 159   const char *def_preference_list;
 160   const char *def_keyserver_url;
 161   prefitem_t *personal_cipher_prefs;
 162   prefitem_t *personal_digest_prefs;
 163   prefitem_t *personal_compress_prefs;
 164   int no_perm_warn;
 165   int no_mdc_warn;
 166   char *temp_dir;
 167   int no_encrypt_to;
 168   int interactive;
 169   struct notation *sig_notations;
 170   struct notation *cert_notations;
 171   strlist_t sig_policy_url;
 172   strlist_t cert_policy_url;
 173   strlist_t sig_keyserver_url;
 174   strlist_t cert_subpackets;
 175   strlist_t sig_subpackets;
 176   int allow_non_selfsigned_uid;
 177   int allow_freeform_uid;
 178   int no_literal;
 179   ulong set_filesize;
 180   int fast_list_mode;
 181   int ignore_time_conflict;
 182   int ignore_valid_from;
 183   int ignore_crc_error;
 184   int ignore_mdc_error;
 185   int command_fd;
 186   const char *override_session_key;
 187   int show_session_key;
 188
 189   const char *gpg_agent_info;
 190   int try_all_secrets;
 191   int no_expensive_trust_checks;
 192   int no_sig_cache;
 193   int no_sig_create_check;
 194   int no_auto_check_trustdb;
 195   int preserve_permissions;
 196   int no_homedir_creation;
 197   struct groupitem *grouplist;
 198   int mangle_dos_filenames;
 199   int enable_progress_filter;
 200   unsigned int screen_columns;
 201   unsigned int screen_lines;
 202   byte *show_subpackets;
 203   int rfc2440_text;
 204
 205   /* If true, let write failures on the status-fd exit the process. */
 206   int exit_on_status_write_error;
 207
 208   /* If > 0, limit the number of card insertion prompts to this
 209      value. */
 210   int limit_card_insert_tries;
 211
 212 #ifdef ENABLE_CARD_SUPPORT
 213   /* FIXME: We don't needs this here as it is done in scdaemon. */
 214   const char *ctapi_driver; /* Library to access the ctAPI. */
 215   const char *pcsc_driver;  /* Library to access the PC/SC system. */
 216   int disable_ccid;    /* Disable the use of the internal CCID driver. */
 217 #endif /*ENABLE_CARD_SUPPORT*/
 218
 219   struct
 220   {
 221     /* If set, require an 0x19 backsig to be present on signatures
 222        made by signing subkeys.  If not set, a missing backsig is not
 223        an error (but an invalid backsig still is). */
 224     unsigned int require_cross_cert:1;
 225
 226     unsigned int use_embedded_filename:1;
 227     unsigned int utf8_filename:1;
 228     unsigned int dsa2:1;
 229     unsigned int allow_multiple_messages:1;
 230   } flags;
 231
 232   /* Linked list of ways to find a key if the key isn't on the local
 233      keyring. */
 234   struct akl
 235   {
 236     enum {
 237       AKL_NODEFAULT,
 238       AKL_LOCAL,
 239       AKL_CERT,
 240       AKL_PKA,
 241       AKL_LDAP,
 242       AKL_KEYSERVER,
 243       AKL_SPEC
 244     } type;
 245     struct keyserver_spec *spec;
 246     struct akl *next;
 247   } *auto_key_locate;
 248
 249   int passwd_repeat;
 250 } opt;
 251
 252 /* CTRL is used to keep some global variables we currently can't
 253    avoid.  Future concurrent versions of gpg will put it into a per
 254    request structure CTRL. */
 255 EXTERN_UNLESS_MAIN_MODULE
 256 struct {
 257   int in_auto_key_retrieve; /* True if we are doing an
 258                                auto_key_retrieve. */
 259 } glo_ctrl;
 260
 261 #define DBG_PACKET_VALUE  1     /* debug packet reading/writing */
 262 #define DBG_MPI_VALUE     2     /* debug mpi details */
 263 #define DBG_CIPHER_VALUE  4     /* debug cipher handling */
 264                                 /* (may reveal sensitive data) */
 265 #define DBG_FILTER_VALUE  8     /* debug internal filter handling */
 266 #define DBG_IOBUF_VALUE   16    /* debug iobuf stuff */
 267 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
 268 #define DBG_CACHE_VALUE   64    /* debug the cacheing */
 269 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
 270 #define DBG_TRUST_VALUE   256   /* debug the trustdb */
 271 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
 272 #define DBG_EXTPROG_VALUE 1024  /* debug external program calls */
 273 #define DBG_CARD_IO_VALUE 2048  /* debug smart card I/O.  */
 274
 275 /* Fixme: For now alias this value.  */
 276 #define DBG_ASSUAN_VALUE  DBG_EXTPROG_VALUE
 277
 278
 279 /* Tests for the debugging flags.  */
 280 #define DBG_PACKET (opt.debug & DBG_PACKET_VALUE)
 281 #define DBG_CIPHER (opt.debug & DBG_CIPHER_VALUE)
 282 #define DBG_FILTER (opt.debug & DBG_FILTER_VALUE)
 283 #define DBG_CACHE  (opt.debug & DBG_CACHE_VALUE)
 284 #define DBG_TRUST  (opt.debug & DBG_TRUST_VALUE)
 285 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
 286 #define DBG_EXTPROG (opt.debug & DBG_EXTPROG_VALUE)
 287 #define DBG_CARD_IO (opt.debug & DBG_CARD_IO_VALUE)
 288 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
 289
 290 /* FIXME: We need to check whey we did not put this into opt. */
 291 #define DBG_MEMORY    memory_debug_mode
 292 #define DBG_MEMSTAT   memory_stat_debug_mode
 293
 294 EXTERN_UNLESS_MAIN_MODULE int memory_debug_mode;
 295 EXTERN_UNLESS_MAIN_MODULE int memory_stat_debug_mode;
 296
 297
 298
 299 #define GNUPG   (opt.compliance==CO_GNUPG)
 300 #define RFC1991 (opt.compliance==CO_RFC1991 || opt.compliance==CO_PGP2)
 301 #define RFC2440 (opt.compliance==CO_RFC2440)
 302 #define RFC4880 (opt.compliance==CO_RFC4880)
 303 #define PGP2    (opt.compliance==CO_PGP2)
 304 #define PGP6    (opt.compliance==CO_PGP6)
 305 #define PGP7    (opt.compliance==CO_PGP7)
 306 #define PGP8    (opt.compliance==CO_PGP8)
 307 #define PGPX    (PGP2 || PGP6 || PGP7 || PGP8)
 308
 309 /* Various option flags.  Note that there should be no common string
 310    names between the IMPORT_ and EXPORT_ flags as they can be mixed in
 311    the keyserver-options option. */
 312
 313 #define IMPORT_LOCAL_SIGS                (1<<0)
 314 #define IMPORT_REPAIR_PKS_SUBKEY_BUG     (1<<1)
 315 #define IMPORT_FAST                      (1<<2)
 316 #define IMPORT_SK2PK                     (1<<3)
 317 #define IMPORT_MERGE_ONLY                (1<<4)
 318 #define IMPORT_MINIMAL                   (1<<5)
 319 #define IMPORT_CLEAN                     (1<<6)
 320
 321 #define EXPORT_LOCAL_SIGS                (1<<0)
 322 #define EXPORT_ATTRIBUTES                (1<<1)
 323 #define EXPORT_SENSITIVE_REVKEYS         (1<<2)
 324 #define EXPORT_RESET_SUBKEY_PASSWD       (1<<3)
 325 #define EXPORT_MINIMAL                   (1<<4)
 326 #define EXPORT_CLEAN                     (1<<5)
 327 #define EXPORT_SEXP_FORMAT               (1<<6)
 328
 329 #define LIST_SHOW_PHOTOS                 (1<<0)
 330 #define LIST_SHOW_POLICY_URLS            (1<<1)
 331 #define LIST_SHOW_STD_NOTATIONS          (1<<2)
 332 #define LIST_SHOW_USER_NOTATIONS         (1<<3)
 333 #define LIST_SHOW_NOTATIONS (LIST_SHOW_STD_NOTATIONS|LIST_SHOW_USER_NOTATIONS)
 334 #define LIST_SHOW_KEYSERVER_URLS         (1<<4)
 335 #define LIST_SHOW_UID_VALIDITY           (1<<5)
 336 #define LIST_SHOW_UNUSABLE_UIDS          (1<<6)
 337 #define LIST_SHOW_UNUSABLE_SUBKEYS       (1<<7)
 338 #define LIST_SHOW_KEYRING                (1<<8)
 339 #define LIST_SHOW_SIG_EXPIRE             (1<<9)
 340 #define LIST_SHOW_SIG_SUBPACKETS         (1<<10)
 341
 342 #define VERIFY_SHOW_PHOTOS               (1<<0)
 343 #define VERIFY_SHOW_POLICY_URLS          (1<<1)
 344 #define VERIFY_SHOW_STD_NOTATIONS        (1<<2)
 345 #define VERIFY_SHOW_USER_NOTATIONS       (1<<3)
 346 #define VERIFY_SHOW_NOTATIONS (VERIFY_SHOW_STD_NOTATIONS|VERIFY_SHOW_USER_NOTATIONS)
 347 #define VERIFY_SHOW_KEYSERVER_URLS       (1<<4)
 348 #define VERIFY_SHOW_UID_VALIDITY         (1<<5)
 349 #define VERIFY_SHOW_UNUSABLE_UIDS        (1<<6)
 350 #define VERIFY_PKA_LOOKUPS               (1<<7)
 351 #define VERIFY_PKA_TRUST_INCREASE        (1<<8)
 352 #define VERIFY_SHOW_PRIMARY_UID_ONLY     (1<<9)
 353
 354 #define KEYSERVER_USE_TEMP_FILES         (1<<0)
 355 #define KEYSERVER_KEEP_TEMP_FILES        (1<<1)
 356 #define KEYSERVER_ADD_FAKE_V3            (1<<2)
 357 #define KEYSERVER_AUTO_KEY_RETRIEVE      (1<<3)
 358 #define KEYSERVER_HONOR_KEYSERVER_URL    (1<<4)
 359 #define KEYSERVER_HONOR_PKA_RECORD       (1<<5)
 360
 361 #endif /*G10_OPTIONS_H*/