1 /* gpgsm.h - Global definitions for GpgSM
2 * Copyright (C) 2001, 2003, 2004, 2007, 2009,
3 * 2010 Free Software Foundation, Inc.
5 * This file is part of GnuPG.
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.
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.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <https://www.gnu.org/licenses/>.
24 #ifdef GPG_ERR_SOURCE_DEFAULT
25 #error GPG_ERR_SOURCE_DEFAULT already defined
27 #define GPG_ERR_SOURCE_DEFAULT GPG_ERR_SOURCE_GPGSM
28 #include <gpg-error.h>
32 #include "../common/util.h"
33 #include "../common/status.h"
34 #include "../common/audit.h"
35 #include "../common/session-env.h"
36 #include "../common/ksba-io-support.h"
37 #include "../common/compliance.h"
40 #define MAX_DIGEST_LEN 64
44 struct keyserver_spec *next;
54 /* A large struct named "opt" to keep global flags. */
57 unsigned int debug; /* debug flags (DBG_foo_VALUE) */
58 int verbose; /* verbosity level */
59 int quiet; /* be as quiet as possible */
60 int batch; /* run in batch mode, i.e w/o any user interaction */
61 int answer_yes; /* assume yes on most questions */
62 int answer_no; /* assume no on most questions */
63 int dry_run; /* don't change any persistent data */
64 int no_homedir_creation;
66 const char *config_filename; /* Name of the used config file. */
67 const char *agent_program;
69 session_env_t session_env;
74 const char *dirmngr_program;
75 int disable_dirmngr; /* Do not do any dirmngr calls. */
76 const char *protect_tool_program;
77 char *outfile; /* name of output file */
79 int with_key_data;/* include raw key in the column delimted output */
81 int fingerprint; /* list fingerprints in all key listings */
83 int with_md5_fingerprint; /* Also print an MD5 fingerprint for
84 standard key listings. */
86 int with_keygrip; /* Option --with-keygrip active. */
91 int armor; /* force base64 armoring (see also ctrl.with_base64) */
92 int no_armor; /* don't try to figure out whether data is base64 armored*/
94 const char *p12_charset; /* Use this charset for encoding the
95 pkcs#12 passphrase. */
98 const char *def_cipher_algoid; /* cipher algorithm to use if
99 nothing else is specified */
101 int def_compress_algo; /* Ditto for compress algorithm */
103 int forced_digest_algo; /* User forced hash algorithm. */
105 char *def_recipient; /* userID of the default recipient */
106 int def_recipient_self; /* The default recipient is the default key */
108 int no_encrypt_to; /* Ignore all as encrypt to marked recipients. */
110 char *local_user; /* NULL or argument to -u */
112 int extra_digest_algo; /* A digest algorithm also used for
113 verification of signatures. */
115 int always_trust; /* Trust the given keys even if there is no
116 valid certification chain */
117 int skip_verify; /* do not check signatures on data */
119 int lock_once; /* Keep lock once they are set */
121 int ignore_time_conflict; /* Ignore certain time conflicts */
123 int no_crl_check; /* Don't do a CRL check */
124 int no_trusted_cert_crl_check; /* Don't run a CRL check for trusted certs. */
125 int force_crl_refresh; /* Force refreshing the CRL. */
126 int enable_ocsp; /* Default to use OCSP checks. */
128 char *policy_file; /* full pathname of policy file */
129 int no_policy_check; /* ignore certificate policies */
130 int no_chain_validation; /* Bypass all cert chain validity tests */
131 int ignore_expiration; /* Ignore the notAfter validity checks. */
133 int auto_issuer_key_retrieve; /* try to retrieve a missing issuer key. */
135 int qualsig_approval; /* Set to true if this software has
136 officially been approved to create an
137 verify qualified signatures. This is a
138 runtime option in case we want to check
139 the integrity of the software at
142 struct keyserver_spec *keyserver;
144 /* A list of certificate extension OIDs which are ignored so that
145 one can claim that a critical extension has been handled. One
147 strlist_t ignored_cert_extensions;
149 enum gnupg_compliance_mode compliance;
152 /* Debug values and macros. */
153 #define DBG_X509_VALUE 1 /* debug x.509 data reading/writing */
154 #define DBG_MPI_VALUE 2 /* debug mpi details */
155 #define DBG_CRYPTO_VALUE 4 /* debug low level crypto */
156 #define DBG_MEMORY_VALUE 32 /* debug memory allocation stuff */
157 #define DBG_CACHE_VALUE 64 /* debug the caching */
158 #define DBG_MEMSTAT_VALUE 128 /* show memory statistics */
159 #define DBG_HASHING_VALUE 512 /* debug hashing operations */
160 #define DBG_IPC_VALUE 1024 /* debug assuan communication */
162 #define DBG_X509 (opt.debug & DBG_X509_VALUE)
163 #define DBG_CRYPTO (opt.debug & DBG_CRYPTO_VALUE)
164 #define DBG_MEMORY (opt.debug & DBG_MEMORY_VALUE)
165 #define DBG_CACHE (opt.debug & DBG_CACHE_VALUE)
166 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
167 #define DBG_IPC (opt.debug & DBG_IPC_VALUE)
169 /* Forward declaration for an object defined in server.c */
170 struct server_local_s;
172 /* Session control object. This object is passed down to most
173 functions. Note that the default values for it are set by
174 gpgsm_init_default_ctrl(). */
175 struct server_control_s
177 int no_server; /* We are not running under server control */
178 int status_fd; /* Only for non-server mode */
179 struct server_local_s *server_local;
181 audit_ctx_t audit; /* NULL or a context for the audit subsystem. */
182 int agent_seen; /* Flag indicating that the gpg-agent has been
185 int with_colons; /* Use column delimited output format */
186 int with_secret; /* Mark secret keys in a public key listing. */
187 int with_chain; /* Include the certifying certs in a listing */
188 int with_validation;/* Validate each key while listing. */
189 int with_ephemeral_keys; /* Include ephemeral flagged keys in the
192 int autodetect_encoding; /* Try to detect the input encoding */
193 int is_pem; /* Is in PEM format */
194 int is_base64; /* is in plain base-64 format */
196 int create_base64; /* Create base64 encoded output */
197 int create_pem; /* create PEM output */
198 const char *pem_name; /* PEM name to use */
200 int include_certs; /* -1 to send all certificates in the chain
201 along with a signature or the number of
202 certificates up the chain (0 = none, 1 = only
204 int use_ocsp; /* Set to true if OCSP should be used. */
205 int validation_model; /* 0 := standard model (shell),
208 int offline; /* If true gpgsm won't do any network access. */
212 /* An object to keep a list of certificates. */
215 struct certlist_s *next;
217 int is_encrypt_to; /* True if the certificate has been set through
218 the --encrypto-to option. */
219 int hash_algo; /* Used to track the hash algorithm to use. */
220 const char *hash_algo_oid; /* And the corresponding OID. */
222 typedef struct certlist_s *certlist_t;
225 /* A structure carrying information about trusted root certificates. */
226 struct rootca_flags_s
228 unsigned int valid:1; /* The rest of the structure has valid
230 unsigned int relax:1; /* Relax checking of root certificates. */
231 unsigned int chain_model:1; /* Root requires the use of the chain model. */
237 void gpgsm_exit (int rc);
238 void gpgsm_init_default_ctrl (struct server_control_s *ctrl);
239 int gpgsm_parse_validation_model (const char *model);
242 void gpgsm_server (certlist_t default_recplist);
243 gpg_error_t gpgsm_status (ctrl_t ctrl, int no, const char *text);
244 gpg_error_t gpgsm_status2 (ctrl_t ctrl, int no, ...) GPGRT_ATTR_SENTINEL(0);
245 gpg_error_t gpgsm_status_with_err_code (ctrl_t ctrl, int no, const char *text,
247 gpg_error_t gpgsm_status_with_error (ctrl_t ctrl, int no, const char *text,
249 gpg_error_t gpgsm_proxy_pinentry_notify (ctrl_t ctrl,
250 const unsigned char *line);
252 /*-- fingerprint --*/
253 unsigned char *gpgsm_get_fingerprint (ksba_cert_t cert, int algo,
254 unsigned char *array, int *r_len);
255 char *gpgsm_get_fingerprint_string (ksba_cert_t cert, int algo);
256 char *gpgsm_get_fingerprint_hexstring (ksba_cert_t cert, int algo);
257 unsigned long gpgsm_get_short_fingerprint (ksba_cert_t cert,
258 unsigned long *r_high);
259 unsigned char *gpgsm_get_keygrip (ksba_cert_t cert, unsigned char *array);
260 char *gpgsm_get_keygrip_hexstring (ksba_cert_t cert);
261 int gpgsm_get_key_algo_info (ksba_cert_t cert, unsigned int *nbits);
262 char *gpgsm_get_certid (ksba_cert_t cert);
266 void gpgsm_print_serial (estream_t fp, ksba_const_sexp_t p);
267 void gpgsm_print_time (estream_t fp, ksba_isotime_t t);
268 void gpgsm_print_name2 (FILE *fp, const char *string, int translate);
269 void gpgsm_print_name (FILE *fp, const char *string);
270 void gpgsm_es_print_name (estream_t fp, const char *string);
271 void gpgsm_es_print_name2 (estream_t fp, const char *string, int translate);
273 void gpgsm_cert_log_name (const char *text, ksba_cert_t cert);
275 void gpgsm_dump_cert (const char *text, ksba_cert_t cert);
276 void gpgsm_dump_serial (ksba_const_sexp_t p);
277 void gpgsm_dump_time (ksba_isotime_t t);
278 void gpgsm_dump_string (const char *string);
280 char *gpgsm_format_serial (ksba_const_sexp_t p);
281 char *gpgsm_format_name2 (const char *name, int translate);
282 char *gpgsm_format_name (const char *name);
283 char *gpgsm_format_sn_issuer (ksba_sexp_t sn, const char *issuer);
285 char *gpgsm_fpr_and_name_for_status (ksba_cert_t cert);
287 char *gpgsm_format_keydesc (ksba_cert_t cert);
290 /*-- certcheck.c --*/
291 int gpgsm_check_cert_sig (ksba_cert_t issuer_cert, ksba_cert_t cert);
292 int gpgsm_check_cms_signature (ksba_cert_t cert, ksba_const_sexp_t sigval,
293 gcry_md_hd_t md, int hash_algo, int *r_pkalgo);
294 /* fixme: move create functions to another file */
295 int gpgsm_create_cms_signature (ctrl_t ctrl,
296 ksba_cert_t cert, gcry_md_hd_t md, int mdalgo,
297 unsigned char **r_sigval);
300 /*-- certchain.c --*/
302 /* Flags used with gpgsm_validate_chain. */
303 #define VALIDATE_FLAG_NO_DIRMNGR 1
304 #define VALIDATE_FLAG_CHAIN_MODEL 2
305 #define VALIDATE_FLAG_STEED 4
307 int gpgsm_walk_cert_chain (ctrl_t ctrl,
308 ksba_cert_t start, ksba_cert_t *r_next);
309 int gpgsm_is_root_cert (ksba_cert_t cert);
310 int gpgsm_validate_chain (ctrl_t ctrl, ksba_cert_t cert,
311 ksba_isotime_t checktime,
312 ksba_isotime_t r_exptime,
313 int listmode, estream_t listfp,
314 unsigned int flags, unsigned int *retflags);
315 int gpgsm_basic_cert_check (ctrl_t ctrl, ksba_cert_t cert);
318 int gpgsm_cert_use_sign_p (ksba_cert_t cert);
319 int gpgsm_cert_use_encrypt_p (ksba_cert_t cert);
320 int gpgsm_cert_use_verify_p (ksba_cert_t cert);
321 int gpgsm_cert_use_decrypt_p (ksba_cert_t cert);
322 int gpgsm_cert_use_cert_p (ksba_cert_t cert);
323 int gpgsm_cert_use_ocsp_p (ksba_cert_t cert);
324 int gpgsm_cert_has_well_known_private_key (ksba_cert_t cert);
325 int gpgsm_certs_identical_p (ksba_cert_t cert_a, ksba_cert_t cert_b);
326 int gpgsm_add_cert_to_certlist (ctrl_t ctrl, ksba_cert_t cert,
327 certlist_t *listaddr, int is_encrypt_to);
328 int gpgsm_add_to_certlist (ctrl_t ctrl, const char *name, int secret,
329 certlist_t *listaddr, int is_encrypt_to);
330 void gpgsm_release_certlist (certlist_t list);
331 int gpgsm_find_cert (ctrl_t ctrl, const char *name, ksba_sexp_t keyid,
332 ksba_cert_t *r_cert, int allow_ambiguous);
335 gpg_error_t gpgsm_list_keys (ctrl_t ctrl, strlist_t names,
336 estream_t fp, unsigned int mode);
339 int gpgsm_import (ctrl_t ctrl, int in_fd, int reimport_mode);
340 int gpgsm_import_files (ctrl_t ctrl, int nfiles, char **files,
341 int (*of)(const char *fname));
344 void gpgsm_export (ctrl_t ctrl, strlist_t names, estream_t stream);
345 void gpgsm_p12_export (ctrl_t ctrl, const char *name, estream_t stream,
349 int gpgsm_delete (ctrl_t ctrl, strlist_t names);
352 int gpgsm_verify (ctrl_t ctrl, int in_fd, int data_fd, estream_t out_fp);
355 int gpgsm_get_default_cert (ctrl_t ctrl, ksba_cert_t *r_cert);
356 int gpgsm_sign (ctrl_t ctrl, certlist_t signerlist,
357 int data_fd, int detached, estream_t out_fp);
360 int gpgsm_encrypt (ctrl_t ctrl, certlist_t recplist,
361 int in_fd, estream_t out_fp);
364 int gpgsm_decrypt (ctrl_t ctrl, int in_fd, estream_t out_fp);
366 /*-- certreqgen.c --*/
367 int gpgsm_genkey (ctrl_t ctrl, estream_t in_stream, estream_t out_stream);
369 /*-- certreqgen-ui.c --*/
370 void gpgsm_gencertreq_tty (ctrl_t ctrl, estream_t out_stream);
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,
407 gpg_error_t gpgsm_agent_ask_passphrase (ctrl_t ctrl, const char *desc_msg,
408 int repeat, char **r_passphrase);
409 gpg_error_t gpgsm_agent_keywrap_key (ctrl_t ctrl, int forexport,
410 void **r_kek, size_t *r_keklen);
411 gpg_error_t gpgsm_agent_import_key (ctrl_t ctrl,
412 const void *key, size_t keylen);
413 gpg_error_t gpgsm_agent_export_key (ctrl_t ctrl, const char *keygrip,
415 unsigned char **r_result,
416 size_t *r_resultlen);
418 /*-- call-dirmngr.c --*/
419 int gpgsm_dirmngr_isvalid (ctrl_t ctrl,
420 ksba_cert_t cert, ksba_cert_t issuer_cert,
422 int gpgsm_dirmngr_lookup (ctrl_t ctrl, strlist_t names, int cache_only,
423 void (*cb)(void*, ksba_cert_t), void *cb_value);
424 int gpgsm_dirmngr_run_command (ctrl_t ctrl, const char *command,
425 int argc, char **argv);
429 void setup_pinentry_env (void);
430 gpg_error_t transform_sigval (const unsigned char *sigval, size_t sigvallen,
432 unsigned char **r_newsigval,
433 size_t *r_newsigvallen);