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