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