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