Add Kludge for RegTP sillyness.
[gnupg.git] / sm / gpgsm.h
1 /* gpgsm.h - Global definitions for GpgSM
2  *      Copyright (C) 2001, 2003, 2004 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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef GPGSM_H
22 #define GPGSM_H
23
24 #ifdef GPG_ERR_SOURCE_DEFAULT
25 #error GPG_ERR_SOURCE_DEFAULT already defined
26 #endif
27 #define GPG_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_GPGSM
28 #include <gpg-error.h>
29 #define map_assuan_err(a) \
30         map_assuan_err_with_source (GPG_ERR_SOURCE_DEFAULT, (a))
31
32
33 #include <ksba.h>
34 #include "../common/util.h"
35 #include "../common/errors.h"
36
37 #define OUT_OF_CORE(a) (gpg_error (gpg_err_code_from_errno ((a))))
38
39 #define MAX_DIGEST_LEN 24 
40
41 /* A large struct named "opt" to keep global flags */
42 struct {
43   unsigned int debug; /* debug flags (DBG_foo_VALUE) */
44   int verbose;      /* verbosity level */
45   int quiet;        /* be as quiet as possible */
46   int batch;        /* run in batch mode, i.e w/o any user interaction */
47   int answer_yes;   /* assume yes on most questions */
48   int answer_no;    /* assume no on most questions */
49   int dry_run;      /* don't change any persistent data */
50
51   const char *homedir;         /* Configuration directory name */
52   const char *config_filename; /* Name of the used config file. */
53   const char *agent_program; 
54   char *display;
55   char *ttyname;
56   char *ttytype;
57   char *lc_ctype;
58   char *lc_messages;
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 *def_cipher_algoid;  /* cipher algorithm to use if
79                                      nothing else is specified */
80
81   int def_digest_algo;    /* Ditto for hash algorithm */
82   int def_compress_algo;  /* Ditto for compress algorithm */
83
84   char *def_recipient;    /* userID of the default recipient */
85   int def_recipient_self; /* The default recipient is the default key */
86
87   int no_encrypt_to;      /* Ignore all as encrypt to marked recipients. */
88
89   char *local_user;       /* NULL or argument to -u */
90
91   int always_trust;       /* Trust the given keys even if there is no
92                              valid certification chain */
93   int skip_verify;        /* do not check signatures on data */
94
95   int lock_once;          /* Keep lock once they are set */
96
97   int ignore_time_conflict; /* Ignore certain time conflicts */
98
99   int no_crl_check;         /* Don't do a CRL check */
100   int no_trusted_cert_crl_check; /* Don't run a CRL check for trusted certs. */
101   int force_crl_refresh;    /* Force refreshing the CRL. */
102   int enable_ocsp;          /* Default to use OCSP checks. */
103
104   char *policy_file;        /* full pathname of policy file */
105   int no_policy_check;      /* ignore certificate policies */
106   int no_chain_validation;  /* Bypass all cert chain validity tests */
107   int ignore_expiration;    /* Ignore the notAfter validity checks. */
108   char *fixed_passphrase;   /* Passphrase used by regression tests.  */
109
110   int auto_issuer_key_retrieve; /* try to retrieve a missing issuer key. */
111
112   int qualsig_approval;     /* Set to true if this software has
113                                officially been approved to create an
114                                verify qualified signatures.  This is a
115                                runtime option in case we want to check
116                                the integrity of the software at
117                                runtime. */
118 } opt;
119
120
121 #define DBG_X509_VALUE    1     /* debug x.509 data reading/writing */
122 #define DBG_MPI_VALUE     2     /* debug mpi details */
123 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
124 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
125 #define DBG_CACHE_VALUE   64    /* debug the caching */
126 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
127 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
128 #define DBG_ASSUAN_VALUE  1024  /* debug assuan communication */
129
130 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
131 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
132 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
133 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
134 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
135 #define DBG_ASSUAN   (opt.debug & DBG_ASSUAN_VALUE)
136
137 struct server_local_s;
138
139 /* Note that the default values for this are set by
140    gpgsm_init_default_ctrl() */
141 struct server_control_s {
142   int no_server;      /* We are not running under server control */
143   int  status_fd;     /* Only for non-server mode */
144   struct server_local_s *server_local;
145   int with_colons;    /* Use column delimited output format */
146   int with_chain;     /* Include the certifying certs in a listing */
147   int with_validation;/* Validate each key while listing. */
148
149   int autodetect_encoding; /* Try to detect the input encoding */
150   int is_pem;         /* Is in PEM format */
151   int is_base64;      /* is in plain base-64 format */
152
153   int create_base64;  /* Create base64 encoded output */
154   int create_pem;     /* create PEM output */
155   const char *pem_name; /* PEM name to use */
156
157   int include_certs;  /* -1 to send all certificates in the chain
158                          along with a signature or the number of
159                          certificates up the chain (0 = none, 1 = only
160                          signer) */
161   int use_ocsp;       /* Set to true if OCSP should be used. */
162 };
163 typedef struct server_control_s *CTRL;
164 typedef struct server_control_s *ctrl_t;
165
166 /* data structure used in base64.c */
167 typedef struct base64_context_s *Base64Context;
168
169
170 struct certlist_s {
171   struct certlist_s *next;
172   ksba_cert_t cert;
173   int is_encrypt_to; /* True if the certificate has been set through
174                         the --encrypto-to option. */
175 };
176 typedef struct certlist_s *CERTLIST;
177 typedef struct certlist_s *certlist_t;
178
179 /*-- gpgsm.c --*/
180 void gpgsm_exit (int rc);
181 void gpgsm_init_default_ctrl (struct server_control_s *ctrl);
182
183 /*-- server.c --*/
184 void gpgsm_server (certlist_t default_recplist);
185 gpg_error_t gpgsm_status (ctrl_t ctrl, int no, const char *text);
186 gpg_error_t gpgsm_status2 (ctrl_t ctrl, int no, ...);
187 gpg_error_t gpgsm_status_with_err_code (ctrl_t ctrl, int no, const char *text,
188                                         gpg_err_code_t ec);
189
190 /*-- fingerprint --*/
191 unsigned char *gpgsm_get_fingerprint (ksba_cert_t cert, int algo,
192                                       unsigned char *array, int *r_len);
193 char *gpgsm_get_fingerprint_string (ksba_cert_t cert, int algo);
194 char *gpgsm_get_fingerprint_hexstring (ksba_cert_t cert, int algo);
195 unsigned long gpgsm_get_short_fingerprint (ksba_cert_t cert);
196 unsigned char *gpgsm_get_keygrip (ksba_cert_t cert, unsigned char *array);
197 char *gpgsm_get_keygrip_hexstring (ksba_cert_t cert);
198 int  gpgsm_get_key_algo_info (ksba_cert_t cert, unsigned int *nbits);
199 char *gpgsm_get_certid (ksba_cert_t cert);
200
201
202 /*-- base64.c --*/
203 int  gpgsm_create_reader (Base64Context *ctx,
204                           ctrl_t ctrl, FILE *fp, int allow_multi_pem,
205                           ksba_reader_t *r_reader);
206 int gpgsm_reader_eof_seen (Base64Context ctx);
207 void gpgsm_destroy_reader (Base64Context ctx);
208 int  gpgsm_create_writer (Base64Context *ctx,
209                           ctrl_t ctrl, FILE *fp, ksba_writer_t *r_writer);
210 int  gpgsm_finish_writer (Base64Context ctx);
211 void gpgsm_destroy_writer (Base64Context ctx);
212
213
214 /*-- certdump.c --*/
215 void gpgsm_print_serial (FILE *fp, ksba_const_sexp_t p);
216 void gpgsm_print_time (FILE *fp, ksba_isotime_t t);
217 void gpgsm_print_name2 (FILE *fp, const char *string, int translate);
218 void gpgsm_print_name (FILE *fp, const char *string);
219
220 void gpgsm_dump_cert (const char *text, ksba_cert_t cert);
221 void gpgsm_dump_serial (ksba_const_sexp_t p);
222 void gpgsm_dump_time (ksba_isotime_t t);
223 void gpgsm_dump_string (const char *string);
224
225 char *gpgsm_format_serial (ksba_const_sexp_t p);
226 char *gpgsm_format_name2 (const char *name, int translate);
227 char *gpgsm_format_name (const char *name);
228
229 char *gpgsm_format_keydesc (ksba_cert_t cert);
230
231
232 /*-- certcheck.c --*/
233 int gpgsm_check_cert_sig (ksba_cert_t issuer_cert, ksba_cert_t cert);
234 int gpgsm_check_cms_signature (ksba_cert_t cert, ksba_const_sexp_t sigval,
235                                gcry_md_hd_t md, int hash_algo);
236 /* fixme: move create functions to another file */
237 int gpgsm_create_cms_signature (ctrl_t ctrl,
238                                 ksba_cert_t cert, gcry_md_hd_t md, int mdalgo,
239                                 unsigned char **r_sigval);
240
241
242 /*-- certchain.c --*/
243 int gpgsm_walk_cert_chain (ksba_cert_t start, ksba_cert_t *r_next);
244 int gpgsm_is_root_cert (ksba_cert_t cert);
245 int gpgsm_validate_chain (ctrl_t ctrl, ksba_cert_t cert,
246                           ksba_isotime_t r_exptime,
247                           int listmode, FILE *listfp,
248                           unsigned int flags);
249 int gpgsm_basic_cert_check (ksba_cert_t cert);
250
251 /*-- certlist.c --*/
252 int gpgsm_cert_use_sign_p (ksba_cert_t cert);
253 int gpgsm_cert_use_encrypt_p (ksba_cert_t cert);
254 int gpgsm_cert_use_verify_p (ksba_cert_t cert);
255 int gpgsm_cert_use_decrypt_p (ksba_cert_t cert);
256 int gpgsm_cert_use_cert_p (ksba_cert_t cert);
257 int gpgsm_cert_use_ocsp_p (ksba_cert_t cert);
258 int gpgsm_add_cert_to_certlist (ctrl_t ctrl, ksba_cert_t cert,
259                                 certlist_t *listaddr, int is_encrypt_to);
260 int gpgsm_add_to_certlist (ctrl_t ctrl, const char *name, int secret,
261                            certlist_t *listaddr, int is_encrypt_to);
262 void gpgsm_release_certlist (certlist_t list);
263 int gpgsm_find_cert (const char *name, ksba_sexp_t keyid, ksba_cert_t *r_cert);
264
265 /*-- keylist.c --*/
266 gpg_error_t gpgsm_list_keys (ctrl_t ctrl, STRLIST names,
267                              FILE *fp, unsigned int mode);
268
269 /*-- import.c --*/
270 int gpgsm_import (ctrl_t ctrl, int in_fd);
271 int gpgsm_import_files (ctrl_t ctrl, int nfiles, char **files,
272                         int (*of)(const char *fname));
273
274 /*-- export.c --*/
275 void gpgsm_export (ctrl_t ctrl, STRLIST names, FILE *fp);
276 void gpgsm_p12_export (ctrl_t ctrl, const char *name, FILE *fp);
277
278 /*-- delete.c --*/
279 int gpgsm_delete (ctrl_t ctrl, STRLIST names);
280
281 /*-- verify.c --*/
282 int gpgsm_verify (ctrl_t ctrl, int in_fd, int data_fd, FILE *out_fp);
283
284 /*-- sign.c --*/
285 int gpgsm_get_default_cert (ctrl_t ctrl, ksba_cert_t *r_cert);
286 int gpgsm_sign (ctrl_t ctrl, CERTLIST signerlist,
287                 int data_fd, int detached, FILE *out_fp);
288
289 /*-- encrypt.c --*/
290 int gpgsm_encrypt (ctrl_t ctrl, CERTLIST recplist, int in_fd, FILE *out_fp);
291
292 /*-- decrypt.c --*/
293 int gpgsm_decrypt (ctrl_t ctrl, int in_fd, FILE *out_fp);
294
295 /*-- certreqgen.c --*/
296 int gpgsm_genkey (ctrl_t ctrl, int in_fd, FILE *out_fp);
297
298 /*-- qualified.c --*/
299 gpg_error_t gpgsm_is_in_qualified_list (ctrl_t ctrl, ksba_cert_t cert,
300                                         char *country);
301 gpg_error_t gpgsm_qualified_consent (ctrl_t ctrl, ksba_cert_t cert);
302 gpg_error_t gpgsm_not_qualified_warning (ctrl_t ctrl, ksba_cert_t cert);
303
304 /*-- call-agent.c --*/
305 int gpgsm_agent_pksign (ctrl_t ctrl, const char *keygrip, const char *desc,
306                         unsigned char *digest,
307                         size_t digestlen,
308                         int digestalgo,
309                         unsigned char **r_buf, size_t *r_buflen);
310 int gpgsm_agent_pkdecrypt (ctrl_t ctrl, const char *keygrip, const char *desc,
311                            ksba_const_sexp_t ciphertext, 
312                            char **r_buf, size_t *r_buflen);
313 int gpgsm_agent_genkey (ctrl_t ctrl,
314                         ksba_const_sexp_t keyparms, ksba_sexp_t *r_pubkey);
315 int gpgsm_agent_readkey (ctrl_t ctrl, const char *hexkeygrip,
316                          ksba_sexp_t *r_pubkey);
317 int gpgsm_agent_istrusted (ctrl_t ctrl, ksba_cert_t cert);
318 int gpgsm_agent_havekey (ctrl_t ctrl, const char *hexkeygrip);
319 int gpgsm_agent_marktrusted (ctrl_t ctrl, ksba_cert_t cert);
320 int gpgsm_agent_learn (ctrl_t ctrl);
321 int gpgsm_agent_passwd (ctrl_t ctrl, const char *hexkeygrip, const char *desc);
322 gpg_error_t gpgsm_agent_get_confirmation (ctrl_t ctrl, const char *desc);
323
324 /*-- call-dirmngr.c --*/
325 int gpgsm_dirmngr_isvalid (ctrl_t ctrl,
326                            ksba_cert_t cert, ksba_cert_t issuer_cert,
327                            int use_ocsp);
328 int gpgsm_dirmngr_lookup (ctrl_t ctrl, STRLIST names,
329                           void (*cb)(void*, ksba_cert_t), void *cb_value);
330 int gpgsm_dirmngr_run_command (ctrl_t ctrl, const char *command,
331                                int argc, char **argv);
332
333
334 /*-- misc.c --*/
335 void setup_pinentry_env (void);
336
337
338
339 #endif /*GPGSM_H*/