./autogen.sh --build-w32ce does now succeed.
[gnupg.git] / g10 / options.h
index 294dec8..221d040 100644 (file)
@@ -1,12 +1,12 @@
 /* options.h
- * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
- *               2005 Free Software Foundation, Inc.
+ * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
+ *               2007, 2010 Free Software Foundation, Inc.
  *
  * This file is part of GnuPG.
  *
  * GnuPG is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * GnuPG is distributed in the hope that it will be useful,
@@ -15,8 +15,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 #ifndef G10_OPTIONS_H
 #define G10_OPTIONS_H
@@ -25,6 +24,7 @@
 #include <types.h>
 #include "main.h"
 #include "packet.h"
+#include "../common/session-env.h"
 
 #ifndef EXTERN_UNLESS_MAIN_MODULE
 /* Norcraft can't cope with common symbols */
@@ -43,6 +43,7 @@ struct
   unsigned debug;
   int armor;
   char *outfile;
+  FILE *outfp;      /* Hack, sometimes used in place of outfile.  */
   off_t max_output;
   int dry_run;
   int list_only;
@@ -80,20 +81,20 @@ struct
   int def_cert_level;
   int min_cert_level;
   int ask_cert_level;
-  int sk_comments;
   int no_version;
   int marginals_needed;
   int completes_needed;
   int max_cert_depth;
   const char *homedir;
+  const char *agent_program; 
 
-  char *display;      /* 5 options to be passed to the gpg-agent */
-  char *ttyname;     
-  char *ttytype;
+  /* Options to be passed to the gpg-agent */
+  session_env_t session_env;
   char *lc_ctype;
   char *lc_messages;
 
   int skip_verify;
+  int skip_hidden_recipients;
   int compress_keys;
   int compress_sigs;
   /* TM_CLASSIC must be zero to accomodate trustdbs generated before
@@ -105,7 +106,8 @@ struct
   int force_ownertrust;
   enum
     {
-      CO_GNUPG=0, CO_RFC2440, CO_RFC1991, CO_PGP2, CO_PGP6, CO_PGP7, CO_PGP8
+      CO_GNUPG, CO_RFC4880, CO_RFC2440, CO_RFC1991, CO_PGP2,
+      CO_PGP6, CO_PGP7, CO_PGP8
     } compliance;
   enum
     {
@@ -114,14 +116,16 @@ struct
   int pgp2_workarounds;
   int shm_coprocess;
   const char *set_filename;
-  STRLIST comments;
+  strlist_t comments;
   int throw_keyid;
   const char *photo_viewer;
   int s2k_mode;
   int s2k_digest_algo;
   int s2k_cipher_algo;
-  int simple_sk_checksum; /* create the deprecated rfc2440 secret
-                            key protection*/
+  unsigned char s2k_count; /* This is the encoded form, not the raw
+                             count */
+  int simple_sk_checksum; /* create the deprecated rfc2440 secret key
+                            protection */
   int not_dash_escaped;
   int escape_from;
   int lock_once;
@@ -134,13 +138,19 @@ struct
     char *port;
     char *path;
     char *opaque;
+    strlist_t options;
+    struct
+    {
+      unsigned int direct_uri:1;
+    } flags;
+    struct keyserver_spec *next;
   } *keyserver;
   struct
   {
     unsigned int options;
     unsigned int import_options;
     unsigned int export_options;
-    STRLIST other;
+    strlist_t other;
   } keyserver_options;
   int exec_disable;
   int exec_path_set;
@@ -148,7 +158,8 @@ struct
   unsigned int export_options;
   unsigned int list_options;
   unsigned int verify_options;
-  char *def_preference_list;
+  const char *def_preference_list;
+  const char *def_keyserver_url;
   prefitem_t *personal_cipher_prefs;
   prefitem_t *personal_digest_prefs;
   prefitem_t *personal_compress_prefs;
@@ -157,18 +168,18 @@ struct
   char *temp_dir;
   int no_encrypt_to;
   int interactive;
-  STRLIST sig_notation_data;
-  STRLIST cert_notation_data;
-  STRLIST sig_policy_url;
-  STRLIST cert_policy_url;
-  STRLIST sig_keyserver_url;
-  int use_embedded_filename;
+  struct notation *sig_notations;
+  struct notation *cert_notations;
+  strlist_t sig_policy_url;
+  strlist_t cert_policy_url;
+  strlist_t sig_keyserver_url;
+  strlist_t cert_subpackets;
+  strlist_t sig_subpackets;
   int allow_non_selfsigned_uid;
   int allow_freeform_uid;
   int no_literal;
   ulong set_filesize;
   int fast_list_mode;
-  int fixed_list_mode;
   int ignore_time_conflict;
   int ignore_valid_from;
   int ignore_crc_error;
@@ -176,7 +187,7 @@ struct
   int command_fd;
   const char *override_session_key;
   int show_session_key;
-  int use_agent;
+
   const char *gpg_agent_info;
   int try_all_secrets;
   int no_expensive_trust_checks;
@@ -186,7 +197,6 @@ struct
   int preserve_permissions;
   int no_homedir_creation;
   struct groupitem *grouplist;
-  int strict;
   int mangle_dos_filenames;
   int enable_progress_filter;
   unsigned int screen_columns;
@@ -194,12 +204,51 @@ struct
   byte *show_subpackets;
   int rfc2440_text;
 
+  /* If true, let write failures on the status-fd exit the process. */
+  int exit_on_status_write_error;
+
+  /* If > 0, limit the number of card insertion prompts to this
+     value. */
+  int limit_card_insert_tries; 
+
 #ifdef ENABLE_CARD_SUPPORT
+  /* FIXME: We don't needs this here as it is done in scdaemon. */
   const char *ctapi_driver; /* Library to access the ctAPI. */
   const char *pcsc_driver;  /* Library to access the PC/SC system. */
   int disable_ccid;    /* Disable the use of the internal CCID driver. */
 #endif /*ENABLE_CARD_SUPPORT*/
 
+  struct
+  {
+    /* If set, require an 0x19 backsig to be present on signatures
+       made by signing subkeys.  If not set, a missing backsig is not
+       an error (but an invalid backsig still is). */
+    unsigned int require_cross_cert:1;
+
+    unsigned int use_embedded_filename:1;
+    unsigned int utf8_filename:1;
+    unsigned int dsa2:1;
+    unsigned int allow_multiple_messages:1;
+  } flags;
+
+  /* Linked list of ways to find a key if the key isn't on the local
+     keyring. */
+  struct akl
+  {
+    enum {
+      AKL_NODEFAULT,
+      AKL_LOCAL,
+      AKL_CERT, 
+      AKL_PKA, 
+      AKL_LDAP,
+      AKL_KEYSERVER,
+      AKL_SPEC
+    } type;
+    struct keyserver_spec *spec;
+    struct akl *next;
+  } *auto_key_locate;
+
+  int passphrase_repeat;
 } opt;
 
 /* CTRL is used to keep some global variables we currently can't
@@ -209,6 +258,11 @@ EXTERN_UNLESS_MAIN_MODULE
 struct {
   int in_auto_key_retrieve; /* True if we are doing an
                                auto_key_retrieve. */
+  /* Hack to store the last error.  We currently need it because the
+     proc_packet machinery is not able to reliabale return error
+     codes.  Thus for the --server purposes we store some of the error
+     codes here.  FIXME! */
+  gpg_error_t lasterr;
 } glo_ctrl;
 
 #define DBG_PACKET_VALUE  1    /* debug packet reading/writing */
@@ -225,22 +279,39 @@ struct {
 #define DBG_EXTPROG_VALUE 1024  /* debug external program calls */
 #define DBG_CARD_IO_VALUE 2048  /* debug smart card I/O.  */
 
+/* Fixme: For now alias this value.  */
+#define DBG_ASSUAN_VALUE  DBG_EXTPROG_VALUE
+
+
+/* Tests for the debugging flags.  */
 #define DBG_PACKET (opt.debug & DBG_PACKET_VALUE)
+#define DBG_CIPHER (opt.debug & DBG_CIPHER_VALUE)
 #define DBG_FILTER (opt.debug & DBG_FILTER_VALUE)
 #define DBG_CACHE  (opt.debug & DBG_CACHE_VALUE)
 #define DBG_TRUST  (opt.debug & DBG_TRUST_VALUE)
 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
 #define DBG_EXTPROG (opt.debug & DBG_EXTPROG_VALUE)
 #define DBG_CARD_IO (opt.debug & DBG_CARD_IO_VALUE)
+#define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
+
+/* FIXME: We need to check whey we did not put this into opt. */
+#define DBG_MEMORY    memory_debug_mode
+#define DBG_MEMSTAT   memory_stat_debug_mode
+
+EXTERN_UNLESS_MAIN_MODULE int memory_debug_mode;
+EXTERN_UNLESS_MAIN_MODULE int memory_stat_debug_mode;
+
 
 
 #define GNUPG   (opt.compliance==CO_GNUPG)
 #define RFC1991 (opt.compliance==CO_RFC1991 || opt.compliance==CO_PGP2)
 #define RFC2440 (opt.compliance==CO_RFC2440)
+#define RFC4880 (opt.compliance==CO_RFC4880)
 #define PGP2    (opt.compliance==CO_PGP2)
 #define PGP6    (opt.compliance==CO_PGP6)
 #define PGP7    (opt.compliance==CO_PGP7)
 #define PGP8    (opt.compliance==CO_PGP8)
+#define PGPX    (PGP2 || PGP6 || PGP7 || PGP8)
 
 /* Various option flags.  Note that there should be no common string
    names between the IMPORT_ and EXPORT_ flags as they can be mixed in
@@ -251,13 +322,16 @@ struct {
 #define IMPORT_FAST                      (1<<2)
 #define IMPORT_SK2PK                     (1<<3)
 #define IMPORT_MERGE_ONLY                (1<<4)
-#define IMPORT_UNUSABLE_SIGS             (1<<5)
+#define IMPORT_MINIMAL                   (1<<5)
+#define IMPORT_CLEAN                     (1<<6)
 
 #define EXPORT_LOCAL_SIGS                (1<<0)
 #define EXPORT_ATTRIBUTES                (1<<1)
 #define EXPORT_SENSITIVE_REVKEYS         (1<<2)
-#define EXPORT_MINIMAL                   (1<<3)
-#define EXPORT_UNUSABLE_SIGS             (1<<4)
+#define EXPORT_RESET_SUBKEY_PASSWD       (1<<3)
+#define EXPORT_MINIMAL                   (1<<4)
+#define EXPORT_CLEAN                     (1<<5)
+#define EXPORT_SEXP_FORMAT               (1<<6)
 
 #define LIST_SHOW_PHOTOS                 (1<<0)
 #define LIST_SHOW_POLICY_URLS            (1<<1)
@@ -280,14 +354,15 @@ struct {
 #define VERIFY_SHOW_KEYSERVER_URLS       (1<<4)
 #define VERIFY_SHOW_UID_VALIDITY         (1<<5)
 #define VERIFY_SHOW_UNUSABLE_UIDS        (1<<6)
+#define VERIFY_PKA_LOOKUPS               (1<<7)
+#define VERIFY_PKA_TRUST_INCREASE        (1<<8)
+#define VERIFY_SHOW_PRIMARY_UID_ONLY     (1<<9)
 
-#define KEYSERVER_INCLUDE_REVOKED        (1<<0)
-#define KEYSERVER_INCLUDE_SUBKEYS        (1<<1)
-#define KEYSERVER_USE_TEMP_FILES         (1<<2)
-#define KEYSERVER_KEEP_TEMP_FILES        (1<<3)
-#define KEYSERVER_ADD_FAKE_V3            (1<<4)
-#define KEYSERVER_AUTO_KEY_RETRIEVE      (1<<5)
-#define KEYSERVER_TRY_DNS_SRV            (1<<6)
-#define KEYSERVER_HONOR_KEYSERVER_URL    (1<<7)
+#define KEYSERVER_USE_TEMP_FILES         (1<<0)
+#define KEYSERVER_KEEP_TEMP_FILES        (1<<1)
+#define KEYSERVER_ADD_FAKE_V3            (1<<2)
+#define KEYSERVER_AUTO_KEY_RETRIEVE      (1<<3)
+#define KEYSERVER_HONOR_KEYSERVER_URL    (1<<4)
+#define KEYSERVER_HONOR_PKA_RECORD       (1<<5)
 
 #endif /*G10_OPTIONS_H*/