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