Minor changes for gettext
[gnupg.git] / sm / gpgsm.h
index a00e11d..702b343 100644 (file)
 #define GPGSM_H
 
 #include <ksba.h>
-#include "util.h"
-
-/* Error numbers */
-enum {
-  GPGSM_EOF = -1,
-  GPGSM_No_Error = 0,
-  GPGSM_General_Error = 1, 
-  GPGSM_Out_Of_Core = 2,
-  GPGSM_Invalid_Value = 3,
-  GPGSM_IO_Error = 4,
-  GPGSM_Resource_Limit = 5,
-  GPGSM_Internal_Error = 6,
-  GPGSM_Bad_Certificate = 7,
-  GPGSM_Bad_Certificate_Path = 8,
-  GPGSM_Missing_Certificate = 9,
-  GPGSM_No_Data = 10,
-  GPGSM_Bad_Signature = 11,
-  GPGSM_Not_Implemented = 12,
-  GPGSM_Conflict = 13,
-  GPGSM_Bug = 14
-};
-
-/* Status codes (shared with gpg) */
-enum {
-  STATUS_ENTER,
-  STATUS_LEAVE,
-  STATUS_ABORT,
-  STATUS_GOODSIG,
-  STATUS_BADSIG,
-  STATUS_ERRSIG,
-  STATUS_BADARMOR,
-  STATUS_RSA_OR_IDEA,
-  STATUS_SIGEXPIRED,
-  STATUS_KEYREVOKED,
-  STATUS_TRUST_UNDEFINED,
-  STATUS_TRUST_NEVER,
-  STATUS_TRUST_MARGINAL,
-  STATUS_TRUST_FULLY,
-  STATUS_TRUST_ULTIMATE,
-  
-  STATUS_SHM_INFO,
-  STATUS_SHM_GET,
-  STATUS_SHM_GET_BOOL,
-  STATUS_SHM_GET_HIDDEN,
-  
-  STATUS_NEED_PASSPHRASE,
-  STATUS_VALIDSIG,
-  STATUS_SIG_ID,
-  STATUS_ENC_TO,
-  STATUS_NODATA,
-  STATUS_BAD_PASSPHRASE,
-  STATUS_NO_PUBKEY,
-  STATUS_NO_SECKEY,
-  STATUS_NEED_PASSPHRASE_SYM,
-  STATUS_DECRYPTION_FAILED,
-  STATUS_DECRYPTION_OKAY,
-  STATUS_MISSING_PASSPHRASE,
-  STATUS_GOOD_PASSPHRASE,
-  STATUS_GOODMDC,
-  STATUS_BADMDC,
-  STATUS_ERRMDC,
-  STATUS_IMPORTED,
-  STATUS_IMPORT_RES,
-  STATUS_FILE_START,
-  STATUS_FILE_DONE,
-  STATUS_FILE_ERROR,
-  
-  STATUS_BEGIN_DECRYPTION,
-  STATUS_END_DECRYPTION,
-  STATUS_BEGIN_ENCRYPTION,
-  STATUS_END_ENCRYPTION,
-  
-  STATUS_DELETE_PROBLEM,
-  STATUS_GET_BOOL,
-  STATUS_GET_LINE,
-  STATUS_GET_HIDDEN,
-  STATUS_GOT_IT,
-  STATUS_PROGRESS,
-  STATUS_SIG_CREATED,
-  STATUS_SESSION_KEY,
-  STATUS_NOTATION_NAME,
-  STATUS_NOTATION_DATA,
-  STATUS_POLICY_URL,
-  STATUS_BEGIN_STREAM,
-  STATUS_END_STREAM,
-  STATUS_KEY_CREATED,
-  STATUS_USERID_HIN,
-  STATUS_UNEXPECTED,
-  STATUS_INV_RECP,
-  STATUS_NO_RECP,
-  STATUS_ALREADY_SIGNED,
-};
-
+#include "../common/util.h"
+#include "../common/errors.h"
 
 #define MAX_DIGEST_LEN 24 
 
@@ -129,22 +38,34 @@ struct {
   int dry_run;      /* don't change any persistent data */
 
   const char *homedir; /* configuration directory name */
+  const char *agent_program; 
+  char *display;
+  char *ttyname;
+  char *ttytype;
+  char *lc_ctype;
+  char *lc_messages;
+
+  const char *dirmngr_program;
   char *outfile;    /* name of output file */
 
   int with_key_data;/* include raw key in the column delimted output */
 
   int fingerprint;  /* list fingerprints in all key listings */
 
-  int armor;        /* force base64 armoring */
+  int armor;        /* force base64 armoring (see also ctrl.with_base64) */
   int no_armor;     /* don't try to figure out whether data is base64 armored*/
 
-  int def_cipher_algo;    /* cipher algorithm to use if nothing else is know */
+  const char *def_cipher_algoid;  /* cipher algorithm to use if
+                                     nothing else is specified */
+
   int def_digest_algo;    /* Ditto for hash algorithm */
   int def_compress_algo;  /* Ditto for compress algorithm */
 
   char *def_recipient;    /* userID of the default recipient */
   int def_recipient_self; /* The default recipient is the default key */
 
+  char *local_user;       /* NULL or argument to -u */
+
   int always_trust;       /* Trust the given keys even if there is no
                              valid certification path */
   int skip_verify;        /* do not check signatures on data */
@@ -153,6 +74,13 @@ struct {
 
   int ignore_time_conflict; /* Ignore certain time conflicts */
 
+  int no_crl_check;         /* Don't do a CRL check */
+
+  char *policy_file;        /* full pathname of policy file */
+  int no_policy_check;      /* ignore certificate policies */
+  int no_path_validation;   /* Bypass all cert path validity tests */
+
+  int auto_issuer_key_retrieve; /* try to retrieve a missing issuer key. */
 } opt;
 
 
@@ -163,42 +91,95 @@ struct {
 #define DBG_CACHE_VALUE   64   /* debug the caching */
 #define DBG_MEMSTAT_VALUE 128  /* show memory statistics */
 #define DBG_HASHING_VALUE 512  /* debug hashing operations */
+#define DBG_ASSUAN_VALUE  1024  /* debug assuan communication */
 
 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
+#define DBG_ASSUAN   (opt.debug & DBG_ASSUAN_VALUE)
 
 struct server_local_s;
 
+/* Note that the default values for this are set by
+   gpgsm_init_default_ctrl() */
 struct server_control_s {
   int no_server;     /* we are not running under server control */
   int  status_fd;    /* only for non-server mode */
   struct server_local_s *server_local;
   int with_colons;  /* use column delimited output format */
+  int with_chain;   /* include the certifying certs in a listing */
+
+  int autodetect_encoding; /* try to detect the input encoding */
+  int is_pem;         /* Is in PEM format */
+  int is_base64;      /* is in plain base-64 format */
+
+  int create_base64;  /* Create base64 encoded output */
+  int create_pem;     /* create PEM output */
+  const char *pem_name; /* PEM name to use */
+
+  int include_certs;  /* -1 to send all certificates in the chain
+                         along with a signature or the number of
+                         certificates up the chain (0 = none, 1 = only
+                         signer) */
 };
 typedef struct server_control_s *CTRL;
 
+/* data structure used in base64.c */
+typedef struct base64_context_s *Base64Context;
+
+
+struct certlist_s {
+  struct certlist_s *next;
+  KsbaCert cert;
+};
+typedef struct certlist_s *CERTLIST;
 
 /*-- gpgsm.c --*/
 void gpgsm_exit (int rc);
+void gpgsm_init_default_ctrl (struct server_control_s *ctrl);
 
 /*-- server.c --*/
 void gpgsm_server (void);
 void gpgsm_status (CTRL ctrl, int no, const char *text);
+void gpgsm_status2 (CTRL ctrl, int no, ...);
 
 /*-- fingerprint --*/
 char *gpgsm_get_fingerprint (KsbaCert cert, int algo, char *array, int *r_len);
 char *gpgsm_get_fingerprint_string (KsbaCert cert, int algo);
 char *gpgsm_get_fingerprint_hexstring (KsbaCert cert, int algo);
+unsigned long gpgsm_get_short_fingerprint (KsbaCert cert);
+char *gpgsm_get_keygrip (KsbaCert cert, char *array);
+char *gpgsm_get_keygrip_hexstring (KsbaCert cert);
+char *gpgsm_get_certid (KsbaCert cert);
+
+
+/*-- base64.c --*/
+int  gpgsm_create_reader (Base64Context *ctx,
+                          CTRL ctrl, FILE *fp, KsbaReader *r_reader);
+void gpgsm_destroy_reader (Base64Context ctx);
+int  gpgsm_create_writer (Base64Context *ctx,
+                          CTRL ctrl, FILE *fp, KsbaWriter *r_writer);
+int  gpgsm_finish_writer (Base64Context ctx);
+void gpgsm_destroy_writer (Base64Context ctx);
+
 
 /*-- certdump.c --*/
+void gpgsm_print_serial (FILE *fp, KsbaConstSexp p);
+void gpgsm_print_time (FILE *fp, time_t t);
+void gpgsm_print_name (FILE *fp, const char *string);
+
 void gpgsm_dump_cert (const char *text, KsbaCert cert);
+void gpgsm_dump_serial (KsbaConstSexp p);
+void gpgsm_dump_time (time_t t);
+void gpgsm_dump_string (const char *string);
+
+
 
 /*-- certcheck.c --*/
 int gpgsm_check_cert_sig (KsbaCert issuer_cert, KsbaCert cert);
-int gpgsm_check_cms_signature (KsbaCert cert, const char *sigval,
+int gpgsm_check_cms_signature (KsbaCert cert, KsbaConstSexp sigval,
                                GCRY_MD_HD md, int hash_algo);
 /* fixme: move create functions to another file */
 int gpgsm_create_cms_signature (KsbaCert cert, GCRY_MD_HD md, int mdalgo,
@@ -206,25 +187,73 @@ int gpgsm_create_cms_signature (KsbaCert cert, GCRY_MD_HD md, int mdalgo,
 
 
 /*-- certpath.c --*/
-int gpgsm_validate_path (KsbaCert cert);
+int gpgsm_walk_cert_chain (KsbaCert start, KsbaCert *r_next);
+int gpgsm_is_root_cert (KsbaCert cert);
+int gpgsm_validate_path (CTRL ctrl, KsbaCert cert, time_t *r_exptime);
+int gpgsm_basic_cert_check (KsbaCert cert);
+
+/*-- certlist.c --*/
+int gpgsm_cert_use_sign_p (KsbaCert cert);
+int gpgsm_cert_use_encrypt_p (KsbaCert cert);
+int gpgsm_cert_use_verify_p (KsbaCert cert);
+int gpgsm_cert_use_decrypt_p (KsbaCert cert);
+int gpgsm_cert_use_cert_p (KsbaCert cert);
+int gpgsm_add_to_certlist (CTRL ctrl, const char *name, int secret,
+                           CERTLIST *listaddr);
+void gpgsm_release_certlist (CERTLIST list);
+int gpgsm_find_cert (const char *name, KsbaCert *r_cert);
 
 /*-- keylist.c --*/
-void gpgsm_list_keys (CTRL ctrl, STRLIST names, FILE *fp);
-
+void gpgsm_list_keys (CTRL ctrl, STRLIST names, FILE *fp, unsigned int mode);
 
 /*-- import.c --*/
 int gpgsm_import (CTRL ctrl, int in_fd);
 
+/*-- export.c --*/
+void gpgsm_export (CTRL ctrl, STRLIST names, FILE *fp);
+
+/*-- delete.c --*/
+int gpgsm_delete (CTRL ctrl, STRLIST names);
+
 /*-- verify.c --*/
-int gpgsm_verify (CTRL ctrl, int in_fd, int data_fd);
+int gpgsm_verify (CTRL ctrl, int in_fd, int data_fd, FILE *out_fp);
 
 /*-- sign.c --*/
-int gpgsm_sign (CTRL ctrl, int data_fd, int detached, FILE *out_fp);
+int gpgsm_get_default_cert (KsbaCert *r_cert);
+int gpgsm_sign (CTRL ctrl, CERTLIST signerlist,
+                int data_fd, int detached, FILE *out_fp);
+
+/*-- encrypt.c --*/
+int gpgsm_encrypt (CTRL ctrl, CERTLIST recplist, int in_fd, FILE *out_fp);
+
+/*-- decrypt.c --*/
+int gpgsm_decrypt (CTRL ctrl, int in_fd, FILE *out_fp);
+
+/*-- certreqgen.c --*/
+int gpgsm_genkey (CTRL ctrl, int in_fd, FILE *out_fp);
+
+/*-- call-agent.c --*/
+int gpgsm_agent_pksign (const char *keygrip,
+                        unsigned char *digest,
+                        size_t digestlen,
+                        int digestalgo,
+                        char **r_buf, size_t *r_buflen);
+int gpgsm_agent_pkdecrypt (const char *keygrip,
+                           KsbaConstSexp  ciphertext, 
+                           char **r_buf, size_t *r_buflen);
+int gpgsm_agent_genkey (KsbaConstSexp keyparms, KsbaSexp *r_pubkey);
+int gpgsm_agent_istrusted (KsbaCert cert);
+int gpgsm_agent_havekey (const char *hexkeygrip);
+int gpgsm_agent_marktrusted (KsbaCert cert);
+int gpgsm_agent_learn (void);
+
+/*-- call-dirmngr.c --*/
+int gpgsm_dirmngr_isvalid (KsbaCert cert);
+int gpgsm_dirmngr_lookup (CTRL ctrl, STRLIST names,
+                          void (*cb)(void*, KsbaCert), void *cb_value);
 
 
 
-/*-- errors.c (built) --*/
-const char *gpgsm_strerror (int err);
 
 
 #endif /*GPGSM_H*/