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