sm/gpgsm.h

   1 /* gpgsm.h - Global definitions for GpgSM
   2  * Copyright (C) 2001, 2003, 2004, 2007, 2009 Free Software Foundation, Inc.
   3  *
   4  * This file is part of GnuPG.
   5  *
   6  * GnuPG is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * GnuPG is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef GPGSM_H
  21 #define GPGSM_H
  22
  23 #ifdef GPG_ERR_SOURCE_DEFAULT
  24 #error GPG_ERR_SOURCE_DEFAULT already defined
  25 #endif
  26 #define GPG_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_GPGSM
  27 #include <gpg-error.h>
  28
  29
  30 #include <ksba.h>
  31 #include "../common/util.h"
  32 #include "../common/status.h"
  33 #include "../common/estream.h"
  34 #include "../common/audit.h"
  35 #include "../common/session-env.h"
  36
  37
  38 #define MAX_DIGEST_LEN 64
  39
  40 struct keyserver_spec
  41 {
  42   struct keyserver_spec *next;
  43
  44   char *host;
  45   int port;
  46   char *user;
  47   char *pass;
  48   char *base;
  49 };
  50
  51
  52 /* A large struct named "opt" to keep global flags. */
  53 struct
  54 {
  55   unsigned int debug; /* debug flags (DBG_foo_VALUE) */
  56   int verbose;      /* verbosity level */
  57   int quiet;        /* be as quiet as possible */
  58   int batch;        /* run in batch mode, i.e w/o any user interaction */
  59   int answer_yes;   /* assume yes on most questions */
  60   int answer_no;    /* assume no on most questions */
  61   int dry_run;      /* don't change any persistent data */
  62
  63   const char *homedir;         /* Configuration directory name */
  64   const char *config_filename; /* Name of the used config file. */
  65   const char *agent_program;
  66
  67   session_env_t session_env;
  68   char *lc_ctype;
  69   char *lc_messages;
  70
  71   const char *dirmngr_program;
  72   int prefer_system_dirmngr;  /* Prefer using a system wide drimngr.  */
  73   int disable_dirmngr;        /* Do not do any dirmngr calls.  */
  74   const char *protect_tool_program;
  75   char *outfile;    /* name of output file */
  76
  77   int with_key_data;/* include raw key in the column delimted output */
  78
  79   int fingerprint;  /* list fingerprints in all key listings */
  80
  81   int with_md5_fingerprint; /* Also print an MD5 fingerprint for
  82                                standard key listings. */
  83
  84   int armor;        /* force base64 armoring (see also ctrl.with_base64) */
  85   int no_armor;     /* don't try to figure out whether data is base64 armored*/
  86
  87   const char *p12_charset; /* Use this charset for encoding the
  88                               pkcs#12 passphrase.  */
  89
  90
  91   const char *def_cipher_algoid;  /* cipher algorithm to use if
  92                                      nothing else is specified */
  93
  94   int def_compress_algo;  /* Ditto for compress algorithm */
  95
  96   int forced_digest_algo; /* User forced hash algorithm. */
  97
  98   char *def_recipient;    /* userID of the default recipient */
  99   int def_recipient_self; /* The default recipient is the default key */
 100
 101   int no_encrypt_to;      /* Ignore all as encrypt to marked recipients. */
 102
 103   char *local_user;       /* NULL or argument to -u */
 104
 105   int extra_digest_algo;  /* A digest algorithm also used for
 106                              verification of signatures.  */
 107
 108   int always_trust;       /* Trust the given keys even if there is no
 109                              valid certification chain */
 110   int skip_verify;        /* do not check signatures on data */
 111
 112   int lock_once;          /* Keep lock once they are set */
 113
 114   int ignore_time_conflict; /* Ignore certain time conflicts */
 115
 116   int no_crl_check;         /* Don't do a CRL check */
 117   int no_trusted_cert_crl_check; /* Don't run a CRL check for trusted certs. */
 118   int force_crl_refresh;    /* Force refreshing the CRL. */
 119   int enable_ocsp;          /* Default to use OCSP checks. */
 120
 121   char *policy_file;        /* full pathname of policy file */
 122   int no_policy_check;      /* ignore certificate policies */
 123   int no_chain_validation;  /* Bypass all cert chain validity tests */
 124   int ignore_expiration;    /* Ignore the notAfter validity checks. */
 125   char *fixed_passphrase;   /* Passphrase used by regression tests.  */
 126
 127   int auto_issuer_key_retrieve; /* try to retrieve a missing issuer key. */
 128
 129   int qualsig_approval;     /* Set to true if this software has
 130                                officially been approved to create an
 131                                verify qualified signatures.  This is a
 132                                runtime option in case we want to check
 133                                the integrity of the software at
 134                                runtime. */
 135
 136   struct keyserver_spec *keyserver;
 137 } opt;
 138
 139
 140 /* Debug values and macros.  */
 141 #define DBG_X509_VALUE    1     /* debug x.509 data reading/writing */
 142 #define DBG_MPI_VALUE     2     /* debug mpi details */
 143 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
 144 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
 145 #define DBG_CACHE_VALUE   64    /* debug the caching */
 146 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
 147 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
 148 #define DBG_ASSUAN_VALUE  1024  /* debug assuan communication */
 149
 150 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
 151 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
 152 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
 153 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
 154 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
 155 #define DBG_ASSUAN   (opt.debug & DBG_ASSUAN_VALUE)
 156
 157 /* Forward declaration for an object defined in server.c */
 158 struct server_local_s;
 159
 160 /* Session control object.  This object is passed down to most
 161    functions.  Note that the default values for it are set by
 162    gpgsm_init_default_ctrl(). */
 163 struct server_control_s
 164 {
 165   int no_server;      /* We are not running under server control */
 166   int  status_fd;     /* Only for non-server mode */
 167   struct server_local_s *server_local;
 168
 169   audit_ctx_t audit;  /* NULL or a context for the audit subsystem.  */
 170   int agent_seen;     /* Flag indicating that the gpg-agent has been
 171                          accessed.  */
 172
 173   int with_colons;    /* Use column delimited output format */
 174   int with_chain;     /* Include the certifying certs in a listing */
 175   int with_validation;/* Validate each key while listing. */
 176   int with_ephemeral_keys;  /* Include ephemeral flagged keys in the
 177                                keylisting. */
 178
 179   int autodetect_encoding; /* Try to detect the input encoding */
 180   int is_pem;         /* Is in PEM format */
 181   int is_base64;      /* is in plain base-64 format */
 182
 183   int create_base64;  /* Create base64 encoded output */
 184   int create_pem;     /* create PEM output */
 185   const char *pem_name; /* PEM name to use */
 186
 187   int include_certs;  /* -1 to send all certificates in the chain
 188                          along with a signature or the number of
 189                          certificates up the chain (0 = none, 1 = only
 190                          signer) */
 191   int use_ocsp;       /* Set to true if OCSP should be used. */
 192   int validation_model; /* Set to 1 for the chain model.  */
 193 };
 194
 195
 196 /* Data structure used in base64.c. */
 197 typedef struct base64_context_s *Base64Context;
 198
 199
 200 /* An object to keep a list of certificates. */
 201 struct certlist_s
 202 {
 203   struct certlist_s *next;
 204   ksba_cert_t cert;
 205   int is_encrypt_to; /* True if the certificate has been set through
 206                         the --encrypto-to option. */
 207   int hash_algo;     /* Used to track the hash algorithm to use.  */
 208   const char *hash_algo_oid;  /* And the corresponding OID.  */
 209 };
 210 typedef struct certlist_s *certlist_t;
 211
 212
 213 /* A structure carrying information about trusted root certificates. */
 214 struct rootca_flags_s
 215 {
 216   unsigned int valid:1;  /* The rest of the structure has valid
 217                             information.  */
 218   unsigned int relax:1;  /* Relax checking of root certificates.  */
 219   unsigned int chain_model:1; /* Root requires the use of the chain model.  */
 220 };
 221
 222
 223 \f
 224 /*-- gpgsm.c --*/
 225 void gpgsm_exit (int rc);
 226 void gpgsm_init_default_ctrl (struct server_control_s *ctrl);
 227 int  gpgsm_parse_validation_model (const char *model);
 228
 229 /*-- server.c --*/
 230 void gpgsm_server (certlist_t default_recplist);
 231 gpg_error_t gpgsm_status (ctrl_t ctrl, int no, const char *text);
 232 gpg_error_t gpgsm_status2 (ctrl_t ctrl, int no, ...) GNUPG_GCC_A_SENTINEL(0);
 233 gpg_error_t gpgsm_status_with_err_code (ctrl_t ctrl, int no, const char *text,
 234                                         gpg_err_code_t ec);
 235 gpg_error_t gpgsm_proxy_pinentry_notify (ctrl_t ctrl,
 236                                          const unsigned char *line);
 237
 238 /*-- fingerprint --*/
 239 unsigned char *gpgsm_get_fingerprint (ksba_cert_t cert, int algo,
 240                                       unsigned char *array, int *r_len);
 241 char *gpgsm_get_fingerprint_string (ksba_cert_t cert, int algo);
 242 char *gpgsm_get_fingerprint_hexstring (ksba_cert_t cert, int algo);
 243 unsigned long gpgsm_get_short_fingerprint (ksba_cert_t cert,
 244                                            unsigned long *r_high);
 245 unsigned char *gpgsm_get_keygrip (ksba_cert_t cert, unsigned char *array);
 246 char *gpgsm_get_keygrip_hexstring (ksba_cert_t cert);
 247 int  gpgsm_get_key_algo_info (ksba_cert_t cert, unsigned int *nbits);
 248 char *gpgsm_get_certid (ksba_cert_t cert);
 249
 250
 251 /*-- base64.c --*/
 252 int  gpgsm_create_reader (Base64Context *ctx,
 253                           ctrl_t ctrl, FILE *fp, int allow_multi_pem,
 254                           ksba_reader_t *r_reader);
 255 int gpgsm_reader_eof_seen (Base64Context ctx);
 256 void gpgsm_destroy_reader (Base64Context ctx);
 257 int  gpgsm_create_writer (Base64Context *ctx,
 258                           ctrl_t ctrl, FILE *fp, estream_t stream,
 259                           ksba_writer_t *r_writer);
 260 int  gpgsm_finish_writer (Base64Context ctx);
 261 void gpgsm_destroy_writer (Base64Context ctx);
 262
 263
 264 /*-- certdump.c --*/
 265 void gpgsm_print_serial (estream_t fp, ksba_const_sexp_t p);
 266 void gpgsm_print_time (estream_t fp, ksba_isotime_t t);
 267 void gpgsm_print_name2 (FILE *fp, const char *string, int translate);
 268 void gpgsm_print_name (FILE *fp, const char *string);
 269 void gpgsm_es_print_name (estream_t fp, const char *string);
 270 void gpgsm_es_print_name2 (estream_t fp, const char *string, int translate);
 271
 272 void gpgsm_cert_log_name (const char *text, ksba_cert_t cert);
 273
 274 void gpgsm_dump_cert (const char *text, ksba_cert_t cert);
 275 void gpgsm_dump_serial (ksba_const_sexp_t p);
 276 void gpgsm_dump_time (ksba_isotime_t t);
 277 void gpgsm_dump_string (const char *string);
 278
 279 char *gpgsm_format_serial (ksba_const_sexp_t p);
 280 char *gpgsm_format_name2 (const char *name, int translate);
 281 char *gpgsm_format_name (const char *name);
 282 char *gpgsm_format_sn_issuer (ksba_sexp_t sn, const char *issuer);
 283
 284 char *gpgsm_fpr_and_name_for_status (ksba_cert_t cert);
 285
 286 char *gpgsm_format_keydesc (ksba_cert_t cert);
 287
 288
 289 /*-- certcheck.c --*/
 290 int gpgsm_check_cert_sig (ksba_cert_t issuer_cert, ksba_cert_t cert);
 291 int gpgsm_check_cms_signature (ksba_cert_t cert, ksba_const_sexp_t sigval,
 292                                gcry_md_hd_t md, int hash_algo, int *r_pkalgo);
 293 /* fixme: move create functions to another file */
 294 int gpgsm_create_cms_signature (ctrl_t ctrl,
 295                                 ksba_cert_t cert, gcry_md_hd_t md, int mdalgo,
 296                                 unsigned char **r_sigval);
 297
 298
 299 /*-- certchain.c --*/
 300
 301 /* Flags used with  gpgsm_validate_chain.  */
 302 #define VALIDATE_FLAG_NO_DIRMNGR  1
 303 #define VALIDATE_FLAG_CHAIN_MODEL 2
 304
 305
 306 int gpgsm_walk_cert_chain (ctrl_t ctrl,
 307                            ksba_cert_t start, ksba_cert_t *r_next);
 308 int gpgsm_is_root_cert (ksba_cert_t cert);
 309 int gpgsm_validate_chain (ctrl_t ctrl, ksba_cert_t cert,
 310                           ksba_isotime_t checktime,
 311                           ksba_isotime_t r_exptime,
 312                           int listmode, estream_t listfp,
 313                           unsigned int flags, unsigned int *retflags);
 314 int gpgsm_basic_cert_check (ctrl_t ctrl, ksba_cert_t cert);
 315
 316 /*-- certlist.c --*/
 317 int gpgsm_cert_use_sign_p (ksba_cert_t cert);
 318 int gpgsm_cert_use_encrypt_p (ksba_cert_t cert);
 319 int gpgsm_cert_use_verify_p (ksba_cert_t cert);
 320 int gpgsm_cert_use_decrypt_p (ksba_cert_t cert);
 321 int gpgsm_cert_use_cert_p (ksba_cert_t cert);
 322 int gpgsm_cert_use_ocsp_p (ksba_cert_t cert);
 323 int gpgsm_certs_identical_p (ksba_cert_t cert_a, ksba_cert_t cert_b);
 324 int gpgsm_add_cert_to_certlist (ctrl_t ctrl, ksba_cert_t cert,
 325                                 certlist_t *listaddr, int is_encrypt_to);
 326 int gpgsm_add_to_certlist (ctrl_t ctrl, const char *name, int secret,
 327                            certlist_t *listaddr, int is_encrypt_to);
 328 void gpgsm_release_certlist (certlist_t list);
 329 int gpgsm_find_cert (const char *name, ksba_sexp_t keyid, ksba_cert_t *r_cert);
 330
 331 /*-- keylist.c --*/
 332 gpg_error_t gpgsm_list_keys (ctrl_t ctrl, strlist_t names,
 333                              estream_t fp, unsigned int mode);
 334
 335 /*-- import.c --*/
 336 int gpgsm_import (ctrl_t ctrl, int in_fd, int reimport_mode);
 337 int gpgsm_import_files (ctrl_t ctrl, int nfiles, char **files,
 338                         int (*of)(const char *fname));
 339
 340 /*-- export.c --*/
 341 void gpgsm_export (ctrl_t ctrl, strlist_t names, FILE *fp, estream_t stream);
 342 void gpgsm_p12_export (ctrl_t ctrl, const char *name, FILE *fp);
 343
 344 /*-- delete.c --*/
 345 int gpgsm_delete (ctrl_t ctrl, strlist_t names);
 346
 347 /*-- verify.c --*/
 348 int gpgsm_verify (ctrl_t ctrl, int in_fd, int data_fd, FILE *out_fp);
 349
 350 /*-- sign.c --*/
 351 int gpgsm_get_default_cert (ctrl_t ctrl, ksba_cert_t *r_cert);
 352 int gpgsm_sign (ctrl_t ctrl, certlist_t signerlist,
 353                 int data_fd, int detached, FILE *out_fp);
 354
 355 /*-- encrypt.c --*/
 356 int gpgsm_encrypt (ctrl_t ctrl, certlist_t recplist, int in_fd, FILE *out_fp);
 357
 358 /*-- decrypt.c --*/
 359 int gpgsm_decrypt (ctrl_t ctrl, int in_fd, FILE *out_fp);
 360
 361 /*-- certreqgen.c --*/
 362 int gpgsm_genkey (ctrl_t ctrl, estream_t in_stream, FILE *out_fp);
 363
 364 /*-- certreqgen-ui.c --*/
 365 void gpgsm_gencertreq_tty (ctrl_t ctrl, FILE *out_fp);
 366
 367
 368 /*-- qualified.c --*/
 369 gpg_error_t gpgsm_is_in_qualified_list (ctrl_t ctrl, ksba_cert_t cert,
 370                                         char *country);
 371 gpg_error_t gpgsm_qualified_consent (ctrl_t ctrl, ksba_cert_t cert);
 372 gpg_error_t gpgsm_not_qualified_warning (ctrl_t ctrl, ksba_cert_t cert);
 373
 374 /*-- call-agent.c --*/
 375 int gpgsm_agent_pksign (ctrl_t ctrl, const char *keygrip, const char *desc,
 376                         unsigned char *digest,
 377                         size_t digestlen,
 378                         int digestalgo,
 379                         unsigned char **r_buf, size_t *r_buflen);
 380 int gpgsm_scd_pksign (ctrl_t ctrl, const char *keyid, const char *desc,
 381                       unsigned char *digest, size_t digestlen, int digestalgo,
 382                       unsigned char **r_buf, size_t *r_buflen);
 383 int gpgsm_agent_pkdecrypt (ctrl_t ctrl, const char *keygrip, const char *desc,
 384                            ksba_const_sexp_t ciphertext,
 385                            char **r_buf, size_t *r_buflen);
 386 int gpgsm_agent_genkey (ctrl_t ctrl,
 387                         ksba_const_sexp_t keyparms, ksba_sexp_t *r_pubkey);
 388 int gpgsm_agent_readkey (ctrl_t ctrl, int fromcard, const char *hexkeygrip,
 389                          ksba_sexp_t *r_pubkey);
 390 int gpgsm_agent_scd_serialno (ctrl_t ctrl, char **r_serialno);
 391 int gpgsm_agent_scd_keypairinfo (ctrl_t ctrl, strlist_t *r_list);
 392 int gpgsm_agent_istrusted (ctrl_t ctrl, ksba_cert_t cert, const char *hexfpr,
 393                            struct rootca_flags_s *rootca_flags);
 394 int gpgsm_agent_havekey (ctrl_t ctrl, const char *hexkeygrip);
 395 int gpgsm_agent_marktrusted (ctrl_t ctrl, ksba_cert_t cert);
 396 int gpgsm_agent_learn (ctrl_t ctrl);
 397 int gpgsm_agent_passwd (ctrl_t ctrl, const char *hexkeygrip, const char *desc);
 398 gpg_error_t gpgsm_agent_get_confirmation (ctrl_t ctrl, const char *desc);
 399 gpg_error_t gpgsm_agent_send_nop (ctrl_t ctrl);
 400 gpg_error_t gpgsm_agent_keyinfo (ctrl_t ctrl, const char *hexkeygrip,
 401                                  char **r_serialno);
 402
 403 /*-- call-dirmngr.c --*/
 404 int gpgsm_dirmngr_isvalid (ctrl_t ctrl,
 405                            ksba_cert_t cert, ksba_cert_t issuer_cert,
 406                            int use_ocsp);
 407 int gpgsm_dirmngr_lookup (ctrl_t ctrl, strlist_t names, int cache_only,
 408                           void (*cb)(void*, ksba_cert_t), void *cb_value);
 409 int gpgsm_dirmngr_run_command (ctrl_t ctrl, const char *command,
 410                                int argc, char **argv);
 411
 412
 413 /*-- misc.c --*/
 414 void setup_pinentry_env (void);
 415
 416
 417
 418 #endif /*GPGSM_H*/