1 /* gpgsm.h - Global definitions for GpgSM
2 * Copyright (C) 2001, 2003, 2004, 2007, 2009 Free Software Foundation, Inc.
4 * This file is part of GnuPG.
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.
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.
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/>.
23 #ifdef GPG_ERR_SOURCE_DEFAULT
24 #error GPG_ERR_SOURCE_DEFAULT already defined
26 #define GPG_ERR_SOURCE_DEFAULT GPG_ERR_SOURCE_GPGSM
27 #include <gpg-error.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"
38 #define MAX_DIGEST_LEN 64
42 struct keyserver_spec *next;
52 /* A large struct named "opt" to keep global flags. */
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 */
63 const char *homedir; /* Configuration directory name */
64 const char *config_filename; /* Name of the used config file. */
65 const char *agent_program;
67 session_env_t session_env;
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 */
77 int with_key_data;/* include raw key in the column delimted output */
79 int fingerprint; /* list fingerprints in all key listings */
81 int with_md5_fingerprint; /* Also print an MD5 fingerprint for
82 standard key listings. */
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*/
87 const char *p12_charset; /* Use this charset for encoding the
88 pkcs#12 passphrase. */
91 const char *def_cipher_algoid; /* cipher algorithm to use if
92 nothing else is specified */
94 int def_compress_algo; /* Ditto for compress algorithm */
96 int forced_digest_algo; /* User forced hash algorithm. */
98 char *def_recipient; /* userID of the default recipient */
99 int def_recipient_self; /* The default recipient is the default key */
101 int no_encrypt_to; /* Ignore all as encrypt to marked recipients. */
103 char *local_user; /* NULL or argument to -u */
105 int extra_digest_algo; /* A digest algorithm also used for
106 verification of signatures. */
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 */
112 int lock_once; /* Keep lock once they are set */
114 int ignore_time_conflict; /* Ignore certain time conflicts */
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. */
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. */
127 int auto_issuer_key_retrieve; /* try to retrieve a missing issuer key. */
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
136 struct keyserver_spec *keyserver;
138 /* A list of certificate extension OIDs which are ignored so that
139 one can claim that a critical extension has been handled. One
141 strlist_t ignored_cert_extensions;
145 /* Debug values and macros. */
146 #define DBG_X509_VALUE 1 /* debug x.509 data reading/writing */
147 #define DBG_MPI_VALUE 2 /* debug mpi details */
148 #define DBG_CRYPTO_VALUE 4 /* debug low level crypto */
149 #define DBG_MEMORY_VALUE 32 /* debug memory allocation stuff */
150 #define DBG_CACHE_VALUE 64 /* debug the caching */
151 #define DBG_MEMSTAT_VALUE 128 /* show memory statistics */
152 #define DBG_HASHING_VALUE 512 /* debug hashing operations */
153 #define DBG_ASSUAN_VALUE 1024 /* debug assuan communication */
155 #define DBG_X509 (opt.debug & DBG_X509_VALUE)
156 #define DBG_CRYPTO (opt.debug & DBG_CRYPTO_VALUE)
157 #define DBG_MEMORY (opt.debug & DBG_MEMORY_VALUE)
158 #define DBG_CACHE (opt.debug & DBG_CACHE_VALUE)
159 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
160 #define DBG_ASSUAN (opt.debug & DBG_ASSUAN_VALUE)
162 /* Forward declaration for an object defined in server.c */
163 struct server_local_s;
165 /* Session control object. This object is passed down to most
166 functions. Note that the default values for it are set by
167 gpgsm_init_default_ctrl(). */
168 struct server_control_s
170 int no_server; /* We are not running under server control */
171 int status_fd; /* Only for non-server mode */
172 struct server_local_s *server_local;
174 audit_ctx_t audit; /* NULL or a context for the audit subsystem. */
175 int agent_seen; /* Flag indicating that the gpg-agent has been
178 int with_colons; /* Use column delimited output format */
179 int with_chain; /* Include the certifying certs in a listing */
180 int with_validation;/* Validate each key while listing. */
181 int with_ephemeral_keys; /* Include ephemeral flagged keys in the
184 int autodetect_encoding; /* Try to detect the input encoding */
185 int is_pem; /* Is in PEM format */
186 int is_base64; /* is in plain base-64 format */
188 int create_base64; /* Create base64 encoded output */
189 int create_pem; /* create PEM output */
190 const char *pem_name; /* PEM name to use */
192 int include_certs; /* -1 to send all certificates in the chain
193 along with a signature or the number of
194 certificates up the chain (0 = none, 1 = only
196 int use_ocsp; /* Set to true if OCSP should be used. */
197 int validation_model; /* Set to 1 for the chain model. */
201 /* Data structure used in base64.c. */
202 typedef struct base64_context_s *Base64Context;
205 /* An object to keep a list of certificates. */
208 struct certlist_s *next;
210 int is_encrypt_to; /* True if the certificate has been set through
211 the --encrypto-to option. */
212 int hash_algo; /* Used to track the hash algorithm to use. */
213 const char *hash_algo_oid; /* And the corresponding OID. */
215 typedef struct certlist_s *certlist_t;
218 /* A structure carrying information about trusted root certificates. */
219 struct rootca_flags_s
221 unsigned int valid:1; /* The rest of the structure has valid
223 unsigned int relax:1; /* Relax checking of root certificates. */
224 unsigned int chain_model:1; /* Root requires the use of the chain model. */
230 void gpgsm_exit (int rc);
231 void gpgsm_init_default_ctrl (struct server_control_s *ctrl);
232 int gpgsm_parse_validation_model (const char *model);
235 void gpgsm_server (certlist_t default_recplist);
236 gpg_error_t gpgsm_status (ctrl_t ctrl, int no, const char *text);
237 gpg_error_t gpgsm_status2 (ctrl_t ctrl, int no, ...) GNUPG_GCC_A_SENTINEL(0);
238 gpg_error_t gpgsm_status_with_err_code (ctrl_t ctrl, int no, const char *text,
240 gpg_error_t gpgsm_proxy_pinentry_notify (ctrl_t ctrl,
241 const unsigned char *line);
243 /*-- fingerprint --*/
244 unsigned char *gpgsm_get_fingerprint (ksba_cert_t cert, int algo,
245 unsigned char *array, int *r_len);
246 char *gpgsm_get_fingerprint_string (ksba_cert_t cert, int algo);
247 char *gpgsm_get_fingerprint_hexstring (ksba_cert_t cert, int algo);
248 unsigned long gpgsm_get_short_fingerprint (ksba_cert_t cert,
249 unsigned long *r_high);
250 unsigned char *gpgsm_get_keygrip (ksba_cert_t cert, unsigned char *array);
251 char *gpgsm_get_keygrip_hexstring (ksba_cert_t cert);
252 int gpgsm_get_key_algo_info (ksba_cert_t cert, unsigned int *nbits);
253 char *gpgsm_get_certid (ksba_cert_t cert);
257 int gpgsm_create_reader (Base64Context *ctx,
258 ctrl_t ctrl, FILE *fp, int allow_multi_pem,
259 ksba_reader_t *r_reader);
260 int gpgsm_reader_eof_seen (Base64Context ctx);
261 void gpgsm_destroy_reader (Base64Context ctx);
262 int gpgsm_create_writer (Base64Context *ctx,
263 ctrl_t ctrl, FILE *fp, estream_t stream,
264 ksba_writer_t *r_writer);
265 int gpgsm_finish_writer (Base64Context ctx);
266 void gpgsm_destroy_writer (Base64Context ctx);
270 void gpgsm_print_serial (estream_t fp, ksba_const_sexp_t p);
271 void gpgsm_print_time (estream_t fp, ksba_isotime_t t);
272 void gpgsm_print_name2 (FILE *fp, const char *string, int translate);
273 void gpgsm_print_name (FILE *fp, const char *string);
274 void gpgsm_es_print_name (estream_t fp, const char *string);
275 void gpgsm_es_print_name2 (estream_t fp, const char *string, int translate);
277 void gpgsm_cert_log_name (const char *text, ksba_cert_t cert);
279 void gpgsm_dump_cert (const char *text, ksba_cert_t cert);
280 void gpgsm_dump_serial (ksba_const_sexp_t p);
281 void gpgsm_dump_time (ksba_isotime_t t);
282 void gpgsm_dump_string (const char *string);
284 char *gpgsm_format_serial (ksba_const_sexp_t p);
285 char *gpgsm_format_name2 (const char *name, int translate);
286 char *gpgsm_format_name (const char *name);
287 char *gpgsm_format_sn_issuer (ksba_sexp_t sn, const char *issuer);
289 char *gpgsm_fpr_and_name_for_status (ksba_cert_t cert);
291 char *gpgsm_format_keydesc (ksba_cert_t cert);
294 /*-- certcheck.c --*/
295 int gpgsm_check_cert_sig (ksba_cert_t issuer_cert, ksba_cert_t cert);
296 int gpgsm_check_cms_signature (ksba_cert_t cert, ksba_const_sexp_t sigval,
297 gcry_md_hd_t md, int hash_algo, int *r_pkalgo);
298 /* fixme: move create functions to another file */
299 int gpgsm_create_cms_signature (ctrl_t ctrl,
300 ksba_cert_t cert, gcry_md_hd_t md, int mdalgo,
301 unsigned char **r_sigval);
304 /*-- certchain.c --*/
306 /* Flags used with gpgsm_validate_chain. */
307 #define VALIDATE_FLAG_NO_DIRMNGR 1
308 #define VALIDATE_FLAG_CHAIN_MODEL 2
311 int gpgsm_walk_cert_chain (ctrl_t ctrl,
312 ksba_cert_t start, ksba_cert_t *r_next);
313 int gpgsm_is_root_cert (ksba_cert_t cert);
314 int gpgsm_validate_chain (ctrl_t ctrl, ksba_cert_t cert,
315 ksba_isotime_t checktime,
316 ksba_isotime_t r_exptime,
317 int listmode, estream_t listfp,
318 unsigned int flags, unsigned int *retflags);
319 int gpgsm_basic_cert_check (ctrl_t ctrl, ksba_cert_t cert);
322 int gpgsm_cert_use_sign_p (ksba_cert_t cert);
323 int gpgsm_cert_use_encrypt_p (ksba_cert_t cert);
324 int gpgsm_cert_use_verify_p (ksba_cert_t cert);
325 int gpgsm_cert_use_decrypt_p (ksba_cert_t cert);
326 int gpgsm_cert_use_cert_p (ksba_cert_t cert);
327 int gpgsm_cert_use_ocsp_p (ksba_cert_t cert);
328 int gpgsm_certs_identical_p (ksba_cert_t cert_a, ksba_cert_t cert_b);
329 int gpgsm_add_cert_to_certlist (ctrl_t ctrl, ksba_cert_t cert,
330 certlist_t *listaddr, int is_encrypt_to);
331 int gpgsm_add_to_certlist (ctrl_t ctrl, const char *name, int secret,
332 certlist_t *listaddr, int is_encrypt_to);
333 void gpgsm_release_certlist (certlist_t list);
334 int gpgsm_find_cert (const char *name, ksba_sexp_t keyid, ksba_cert_t *r_cert);
337 gpg_error_t gpgsm_list_keys (ctrl_t ctrl, strlist_t names,
338 estream_t fp, unsigned int mode);
341 int gpgsm_import (ctrl_t ctrl, int in_fd, int reimport_mode);
342 int gpgsm_import_files (ctrl_t ctrl, int nfiles, char **files,
343 int (*of)(const char *fname));
346 void gpgsm_export (ctrl_t ctrl, strlist_t names, FILE *fp, estream_t stream);
347 void gpgsm_p12_export (ctrl_t ctrl, const char *name, FILE *fp);
350 int gpgsm_delete (ctrl_t ctrl, strlist_t names);
353 int gpgsm_verify (ctrl_t ctrl, int in_fd, int data_fd, FILE *out_fp);
356 int gpgsm_get_default_cert (ctrl_t ctrl, ksba_cert_t *r_cert);
357 int gpgsm_sign (ctrl_t ctrl, certlist_t signerlist,
358 int data_fd, int detached, FILE *out_fp);
361 int gpgsm_encrypt (ctrl_t ctrl, certlist_t recplist, int in_fd, FILE *out_fp);
364 int gpgsm_decrypt (ctrl_t ctrl, int in_fd, FILE *out_fp);
366 /*-- certreqgen.c --*/
367 int gpgsm_genkey (ctrl_t ctrl, estream_t in_stream, FILE *out_fp);
369 /*-- certreqgen-ui.c --*/
370 void gpgsm_gencertreq_tty (ctrl_t ctrl, FILE *out_fp);
373 /*-- qualified.c --*/
374 gpg_error_t gpgsm_is_in_qualified_list (ctrl_t ctrl, ksba_cert_t cert,
376 gpg_error_t gpgsm_qualified_consent (ctrl_t ctrl, ksba_cert_t cert);
377 gpg_error_t gpgsm_not_qualified_warning (ctrl_t ctrl, ksba_cert_t cert);
379 /*-- call-agent.c --*/
380 int gpgsm_agent_pksign (ctrl_t ctrl, const char *keygrip, const char *desc,
381 unsigned char *digest,
384 unsigned char **r_buf, size_t *r_buflen);
385 int gpgsm_scd_pksign (ctrl_t ctrl, const char *keyid, const char *desc,
386 unsigned char *digest, size_t digestlen, int digestalgo,
387 unsigned char **r_buf, size_t *r_buflen);
388 int gpgsm_agent_pkdecrypt (ctrl_t ctrl, const char *keygrip, const char *desc,
389 ksba_const_sexp_t ciphertext,
390 char **r_buf, size_t *r_buflen);
391 int gpgsm_agent_genkey (ctrl_t ctrl,
392 ksba_const_sexp_t keyparms, ksba_sexp_t *r_pubkey);
393 int gpgsm_agent_readkey (ctrl_t ctrl, int fromcard, const char *hexkeygrip,
394 ksba_sexp_t *r_pubkey);
395 int gpgsm_agent_scd_serialno (ctrl_t ctrl, char **r_serialno);
396 int gpgsm_agent_scd_keypairinfo (ctrl_t ctrl, strlist_t *r_list);
397 int gpgsm_agent_istrusted (ctrl_t ctrl, ksba_cert_t cert, const char *hexfpr,
398 struct rootca_flags_s *rootca_flags);
399 int gpgsm_agent_havekey (ctrl_t ctrl, const char *hexkeygrip);
400 int gpgsm_agent_marktrusted (ctrl_t ctrl, ksba_cert_t cert);
401 int gpgsm_agent_learn (ctrl_t ctrl);
402 int gpgsm_agent_passwd (ctrl_t ctrl, const char *hexkeygrip, const char *desc);
403 gpg_error_t gpgsm_agent_get_confirmation (ctrl_t ctrl, const char *desc);
404 gpg_error_t gpgsm_agent_send_nop (ctrl_t ctrl);
405 gpg_error_t gpgsm_agent_keyinfo (ctrl_t ctrl, const char *hexkeygrip,
408 /*-- call-dirmngr.c --*/
409 int gpgsm_dirmngr_isvalid (ctrl_t ctrl,
410 ksba_cert_t cert, ksba_cert_t issuer_cert,
412 int gpgsm_dirmngr_lookup (ctrl_t ctrl, strlist_t names, int cache_only,
413 void (*cb)(void*, ksba_cert_t), void *cb_value);
414 int gpgsm_dirmngr_run_command (ctrl_t ctrl, const char *command,
415 int argc, char **argv);
419 void setup_pinentry_env (void);