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