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