* gpgsm.c (main): New option --debug-ignore-expiration.
[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
30 #include <ksba.h>
31 #include "../common/util.h"
32 #include "../common/errors.h"
33
34 #define OUT_OF_CORE(a) (gpg_error (gpg_err_code_from_errno ((a))))
35
36 #define MAX_DIGEST_LEN 24 
37
38 /* A large struct named "opt" to keep global flags */
39 struct {
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 *agent_program; 
50   char *display;
51   char *ttyname;
52   char *ttytype;
53   char *lc_ctype;
54   char *lc_messages;
55
56   const char *dirmngr_program;
57   const char *protect_tool_program;
58   char *outfile;    /* name of output file */
59
60   int with_key_data;/* include raw key in the column delimted output */
61   
62   int fingerprint;  /* list fingerprints in all key listings */
63
64   int with_md5_fingerprint; /* Also print an MD5 fingerprint for
65                                standard key listings. */
66
67   int armor;        /* force base64 armoring (see also ctrl.with_base64) */
68   int no_armor;     /* don't try to figure out whether data is base64 armored*/
69
70   const char *def_cipher_algoid;  /* cipher algorithm to use if
71                                      nothing else is specified */
72
73   int def_digest_algo;    /* Ditto for hash algorithm */
74   int def_compress_algo;  /* Ditto for compress algorithm */
75
76   char *def_recipient;    /* userID of the default recipient */
77   int def_recipient_self; /* The default recipient is the default key */
78
79   int no_encrypt_to;      /* Ignore all as encrypt to marked recipients. */
80
81   char *local_user;       /* NULL or argument to -u */
82
83   int always_trust;       /* Trust the given keys even if there is no
84                              valid certification chain */
85   int skip_verify;        /* do not check signatures on data */
86
87   int lock_once;          /* Keep lock once they are set */
88
89   int ignore_time_conflict; /* Ignore certain time conflicts */
90
91   int no_crl_check;         /* Don't do a CRL check */
92   int enable_ocsp;          /* Default to use OCSP checks. */
93
94   char *policy_file;        /* full pathname of policy file */
95   int no_policy_check;      /* ignore certificate policies */
96   int no_chain_validation;  /* Bypass all cert chain validity tests */
97   int ignore_expiration;    /* Ignore the notAfter validity checks. */
98
99   int auto_issuer_key_retrieve; /* try to retrieve a missing issuer key. */
100 } opt;
101
102
103 #define DBG_X509_VALUE    1     /* debug x.509 data reading/writing */
104 #define DBG_MPI_VALUE     2     /* debug mpi details */
105 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
106 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
107 #define DBG_CACHE_VALUE   64    /* debug the caching */
108 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
109 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
110 #define DBG_ASSUAN_VALUE  1024  /* debug assuan communication */
111
112 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
113 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
114 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
115 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
116 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
117 #define DBG_ASSUAN   (opt.debug & DBG_ASSUAN_VALUE)
118
119 struct server_local_s;
120
121 /* Note that the default values for this are set by
122    gpgsm_init_default_ctrl() */
123 struct server_control_s {
124   int no_server;      /* We are not running under server control */
125   int  status_fd;     /* Only for non-server mode */
126   struct server_local_s *server_local;
127   int with_colons;    /* Use column delimited output format */
128   int with_chain;     /* Include the certifying certs in a listing */
129   int with_validation;/* Validate each key while listing. */
130
131   int autodetect_encoding; /* Try to detect the input encoding */
132   int is_pem;         /* Is in PEM format */
133   int is_base64;      /* is in plain base-64 format */
134
135   int create_base64;  /* Create base64 encoded output */
136   int create_pem;     /* create PEM output */
137   const char *pem_name; /* PEM name to use */
138
139   int include_certs;  /* -1 to send all certificates in the chain
140                          along with a signature or the number of
141                          certificates up the chain (0 = none, 1 = only
142                          signer) */
143   int use_ocsp;       /* Set to true if OCSP should be used. */
144 };
145 typedef struct server_control_s *CTRL;
146 typedef struct server_control_s *ctrl_t;
147
148 /* data structure used in base64.c */
149 typedef struct base64_context_s *Base64Context;
150
151
152 struct certlist_s {
153   struct certlist_s *next;
154   ksba_cert_t cert;
155   int is_encrypt_to; /* True if the certificate has been set through
156                         the --encrypto-to option. */
157 };
158 typedef struct certlist_s *CERTLIST;
159 typedef struct certlist_s *certlist_t;
160
161 /*-- gpgsm.c --*/
162 void gpgsm_exit (int rc);
163 void gpgsm_init_default_ctrl (struct server_control_s *ctrl);
164
165 /*-- server.c --*/
166 void gpgsm_server (certlist_t default_recplist);
167 void gpgsm_status (ctrl_t ctrl, int no, const char *text);
168 void gpgsm_status2 (ctrl_t ctrl, int no, ...);
169 void gpgsm_status_with_err_code (ctrl_t ctrl, int no, const char *text,
170                                  gpg_err_code_t ec);
171
172 /*-- fingerprint --*/
173 char *gpgsm_get_fingerprint (ksba_cert_t cert, int algo,
174                              char *array, int *r_len);
175 char *gpgsm_get_fingerprint_string (ksba_cert_t cert, int algo);
176 char *gpgsm_get_fingerprint_hexstring (ksba_cert_t cert, int algo);
177 unsigned long gpgsm_get_short_fingerprint (ksba_cert_t cert);
178 char *gpgsm_get_keygrip (ksba_cert_t cert, char *array);
179 char *gpgsm_get_keygrip_hexstring (ksba_cert_t cert);
180 char *gpgsm_get_certid (ksba_cert_t cert);
181
182
183 /*-- base64.c --*/
184 int  gpgsm_create_reader (Base64Context *ctx,
185                           ctrl_t ctrl, FILE *fp, int allow_multi_pem,
186                           ksba_reader_t *r_reader);
187 int gpgsm_reader_eof_seen (Base64Context ctx);
188 void gpgsm_destroy_reader (Base64Context ctx);
189 int  gpgsm_create_writer (Base64Context *ctx,
190                           ctrl_t ctrl, FILE *fp, ksba_writer_t *r_writer);
191 int  gpgsm_finish_writer (Base64Context ctx);
192 void gpgsm_destroy_writer (Base64Context ctx);
193
194
195 /*-- certdump.c --*/
196 void gpgsm_print_serial (FILE *fp, ksba_const_sexp_t p);
197 void gpgsm_print_time (FILE *fp, ksba_isotime_t t);
198 void gpgsm_print_name (FILE *fp, const char *string);
199
200 void gpgsm_dump_cert (const char *text, ksba_cert_t cert);
201 void gpgsm_dump_serial (ksba_const_sexp_t p);
202 void gpgsm_dump_time (ksba_isotime_t t);
203 void gpgsm_dump_string (const char *string);
204
205 char *gpgsm_format_serial (ksba_const_sexp_t p);
206 char *gpgsm_format_name (const char *name);
207
208 char *gpgsm_format_keydesc (ksba_cert_t cert);
209
210
211 /*-- certcheck.c --*/
212 int gpgsm_check_cert_sig (ksba_cert_t issuer_cert, ksba_cert_t cert);
213 int gpgsm_check_cms_signature (ksba_cert_t cert, ksba_const_sexp_t sigval,
214                                gcry_md_hd_t md, int hash_algo);
215 /* fixme: move create functions to another file */
216 int gpgsm_create_cms_signature (ksba_cert_t cert, gcry_md_hd_t md, int mdalgo,
217                                 char **r_sigval);
218
219
220 /*-- certchain.c --*/
221 int gpgsm_walk_cert_chain (ksba_cert_t start, ksba_cert_t *r_next);
222 int gpgsm_is_root_cert (ksba_cert_t cert);
223 int gpgsm_validate_chain (ctrl_t ctrl, ksba_cert_t cert,
224                           ksba_isotime_t r_exptime,
225                           int listmode, FILE *listfp);
226 int gpgsm_basic_cert_check (ksba_cert_t cert);
227
228 /*-- certlist.c --*/
229 int gpgsm_cert_use_sign_p (ksba_cert_t cert);
230 int gpgsm_cert_use_encrypt_p (ksba_cert_t cert);
231 int gpgsm_cert_use_verify_p (ksba_cert_t cert);
232 int gpgsm_cert_use_decrypt_p (ksba_cert_t cert);
233 int gpgsm_cert_use_cert_p (ksba_cert_t cert);
234 int gpgsm_add_cert_to_certlist (ctrl_t ctrl, ksba_cert_t cert,
235                                 certlist_t *listaddr, int is_encrypt_to);
236 int gpgsm_add_to_certlist (ctrl_t ctrl, const char *name, int secret,
237                            certlist_t *listaddr, int is_encrypt_to);
238 void gpgsm_release_certlist (certlist_t list);
239 int gpgsm_find_cert (const char *name, ksba_cert_t *r_cert);
240
241 /*-- keylist.c --*/
242 void gpgsm_list_keys (ctrl_t ctrl, STRLIST names, FILE *fp, unsigned int mode);
243
244 /*-- import.c --*/
245 int gpgsm_import (ctrl_t ctrl, int in_fd);
246 int gpgsm_import_files (ctrl_t ctrl, int nfiles, char **files,
247                         int (*of)(const char *fname));
248
249 /*-- export.c --*/
250 void gpgsm_export (ctrl_t ctrl, STRLIST names, FILE *fp);
251 void gpgsm_p12_export (ctrl_t ctrl, const char *name, FILE *fp);
252
253 /*-- delete.c --*/
254 int gpgsm_delete (ctrl_t ctrl, STRLIST names);
255
256 /*-- verify.c --*/
257 int gpgsm_verify (ctrl_t ctrl, int in_fd, int data_fd, FILE *out_fp);
258
259 /*-- sign.c --*/
260 int gpgsm_get_default_cert (ksba_cert_t *r_cert);
261 int gpgsm_sign (ctrl_t ctrl, CERTLIST signerlist,
262                 int data_fd, int detached, FILE *out_fp);
263
264 /*-- encrypt.c --*/
265 int gpgsm_encrypt (ctrl_t ctrl, CERTLIST recplist, int in_fd, FILE *out_fp);
266
267 /*-- decrypt.c --*/
268 int gpgsm_decrypt (ctrl_t ctrl, int in_fd, FILE *out_fp);
269
270 /*-- certreqgen.c --*/
271 int gpgsm_genkey (ctrl_t ctrl, int in_fd, FILE *out_fp);
272
273 /*-- call-agent.c --*/
274 int gpgsm_agent_pksign (const char *keygrip, const char *desc,
275                         unsigned char *digest,
276                         size_t digestlen,
277                         int digestalgo,
278                         char **r_buf, size_t *r_buflen);
279 int gpgsm_agent_pkdecrypt (const char *keygrip, const char *desc,
280                            ksba_const_sexp_t ciphertext, 
281                            char **r_buf, size_t *r_buflen);
282 int gpgsm_agent_genkey (ksba_const_sexp_t keyparms, ksba_sexp_t *r_pubkey);
283 int gpgsm_agent_istrusted (ksba_cert_t cert);
284 int gpgsm_agent_havekey (const char *hexkeygrip);
285 int gpgsm_agent_marktrusted (ksba_cert_t cert);
286 int gpgsm_agent_learn (void);
287 int gpgsm_agent_passwd (const char *hexkeygrip);
288
289 /*-- call-dirmngr.c --*/
290 int gpgsm_dirmngr_isvalid (ksba_cert_t cert, int use_ocsp);
291 int gpgsm_dirmngr_lookup (ctrl_t ctrl, STRLIST names,
292                           void (*cb)(void*, ksba_cert_t), void *cb_value);
293 int gpgsm_dirmngr_run_command (ctrl_t ctrl, const char *command,
294                                int argc, char **argv);
295
296
297
298
299
300 #endif /*GPGSM_H*/