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