common: Add 'free_strlist_wipe' which wipes memory.
[gnupg.git] / sm / gpgsm.h
1 /* gpgsm.h - Global definitions for GpgSM
2  * Copyright (C) 2001, 2003, 2004, 2007, 2009,
3  *               2010 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
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
31 #include <ksba.h>
32 #include "../common/util.h"
33 #include "../common/status.h"
34 #include "../common/audit.h"
35 #include "../common/session-env.h"
36
37
38 #define MAX_DIGEST_LEN 64
39
40 struct keyserver_spec
41 {
42   struct keyserver_spec *next;
43
44   char *host;
45   int port;
46   char *user;
47   char *pass;
48   char *base;
49 };
50
51
52 /* A large struct named "opt" to keep global flags. */
53 struct
54 {
55   unsigned int debug; /* debug flags (DBG_foo_VALUE) */
56   int verbose;      /* verbosity level */
57   int quiet;        /* be as quiet as possible */
58   int batch;        /* run in batch mode, i.e w/o any user interaction */
59   int answer_yes;   /* assume yes on most questions */
60   int answer_no;    /* assume no on most questions */
61   int dry_run;      /* don't change any persistent data */
62   int no_homedir_creation;
63
64   const char *homedir;         /* Configuration directory name */
65   const char *config_filename; /* Name of the used config file. */
66   const char *agent_program;
67
68   session_env_t session_env;
69   char *lc_ctype;
70   char *lc_messages;
71
72   int autostart;
73   const char *dirmngr_program;
74   int disable_dirmngr;        /* Do not do any dirmngr calls.  */
75   const char *protect_tool_program;
76   char *outfile;    /* name of output file */
77
78   int with_key_data;/* include raw key in the column delimted output */
79
80   int fingerprint;  /* list fingerprints in all key listings */
81
82   int with_md5_fingerprint; /* Also print an MD5 fingerprint for
83                                standard key listings. */
84
85   int with_keygrip; /* Option --with-keygrip active.  */
86
87   int pinentry_mode;
88
89   int armor;        /* force base64 armoring (see also ctrl.with_base64) */
90   int no_armor;     /* don't try to figure out whether data is base64 armored*/
91
92   const char *p12_charset; /* Use this charset for encoding the
93                               pkcs#12 passphrase.  */
94
95
96   const char *def_cipher_algoid;  /* cipher algorithm to use if
97                                      nothing else is specified */
98
99   int def_compress_algo;  /* Ditto for compress algorithm */
100
101   int forced_digest_algo; /* User forced hash algorithm. */
102
103   char *def_recipient;    /* userID of the default recipient */
104   int def_recipient_self; /* The default recipient is the default key */
105
106   int no_encrypt_to;      /* Ignore all as encrypt to marked recipients. */
107
108   char *local_user;       /* NULL or argument to -u */
109
110   int extra_digest_algo;  /* A digest algorithm also used for
111                              verification of signatures.  */
112
113   int always_trust;       /* Trust the given keys even if there is no
114                              valid certification chain */
115   int skip_verify;        /* do not check signatures on data */
116
117   int lock_once;          /* Keep lock once they are set */
118
119   int ignore_time_conflict; /* Ignore certain time conflicts */
120
121   int no_crl_check;         /* Don't do a CRL check */
122   int no_trusted_cert_crl_check; /* Don't run a CRL check for trusted certs. */
123   int force_crl_refresh;    /* Force refreshing the CRL. */
124   int enable_ocsp;          /* Default to use OCSP checks. */
125
126   char *policy_file;        /* full pathname of policy file */
127   int no_policy_check;      /* ignore certificate policies */
128   int no_chain_validation;  /* Bypass all cert chain validity tests */
129   int ignore_expiration;    /* Ignore the notAfter validity checks. */
130
131   int auto_issuer_key_retrieve; /* try to retrieve a missing issuer key. */
132
133   int qualsig_approval;     /* Set to true if this software has
134                                officially been approved to create an
135                                verify qualified signatures.  This is a
136                                runtime option in case we want to check
137                                the integrity of the software at
138                                runtime. */
139
140   struct keyserver_spec *keyserver;
141
142   /* A list of certificate extension OIDs which are ignored so that
143      one can claim that a critical extension has been handled.  One
144      OID per string.  */
145   strlist_t ignored_cert_extensions;
146
147 } opt;
148
149 /* Debug values and macros.  */
150 #define DBG_X509_VALUE    1     /* debug x.509 data reading/writing */
151 #define DBG_MPI_VALUE     2     /* debug mpi details */
152 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
153 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
154 #define DBG_CACHE_VALUE   64    /* debug the caching */
155 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
156 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
157 #define DBG_IPC_VALUE     1024  /* debug assuan communication */
158
159 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
160 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
161 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
162 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
163 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
164 #define DBG_IPC     (opt.debug & DBG_IPC_VALUE)
165
166 /* Forward declaration for an object defined in server.c */
167 struct server_local_s;
168
169 /* Session control object.  This object is passed down to most
170    functions.  Note that the default values for it are set by
171    gpgsm_init_default_ctrl(). */
172 struct server_control_s
173 {
174   int no_server;      /* We are not running under server control */
175   int  status_fd;     /* Only for non-server mode */
176   struct server_local_s *server_local;
177
178   audit_ctx_t audit;  /* NULL or a context for the audit subsystem.  */
179   int agent_seen;     /* Flag indicating that the gpg-agent has been
180                          accessed.  */
181
182   int with_colons;    /* Use column delimited output format */
183   int with_secret;    /* Mark secret keys in a public key listing.  */
184   int with_chain;     /* Include the certifying certs in a listing */
185   int with_validation;/* Validate each key while listing. */
186   int with_ephemeral_keys;  /* Include ephemeral flagged keys in the
187                                keylisting. */
188
189   int autodetect_encoding; /* Try to detect the input encoding */
190   int is_pem;         /* Is in PEM format */
191   int is_base64;      /* is in plain base-64 format */
192
193   int create_base64;  /* Create base64 encoded output */
194   int create_pem;     /* create PEM output */
195   const char *pem_name; /* PEM name to use */
196
197   int include_certs;  /* -1 to send all certificates in the chain
198                          along with a signature or the number of
199                          certificates up the chain (0 = none, 1 = only
200                          signer) */
201   int use_ocsp;       /* Set to true if OCSP should be used. */
202   int validation_model; /* 0 := standard model (shell),
203                            1 := chain model,
204                            2 := STEED model. */
205   int offline;        /* If true gpgsm won't do any network access.  */
206 };
207
208
209 /* Data structure used in base64.c. */
210 typedef struct base64_context_s *Base64Context;
211
212
213 /* An object to keep a list of certificates. */
214 struct certlist_s
215 {
216   struct certlist_s *next;
217   ksba_cert_t cert;
218   int is_encrypt_to; /* True if the certificate has been set through
219                         the --encrypto-to option. */
220   int hash_algo;     /* Used to track the hash algorithm to use.  */
221   const char *hash_algo_oid;  /* And the corresponding OID.  */
222 };
223 typedef struct certlist_s *certlist_t;
224
225
226 /* A structure carrying information about trusted root certificates. */
227 struct rootca_flags_s
228 {
229   unsigned int valid:1;  /* The rest of the structure has valid
230                             information.  */
231   unsigned int relax:1;  /* Relax checking of root certificates.  */
232   unsigned int chain_model:1; /* Root requires the use of the chain model.  */
233 };
234
235
236 \f
237 /*-- gpgsm.c --*/
238 void gpgsm_exit (int rc);
239 void gpgsm_init_default_ctrl (struct server_control_s *ctrl);
240 int  gpgsm_parse_validation_model (const char *model);
241
242 /*-- server.c --*/
243 void gpgsm_server (certlist_t default_recplist);
244 gpg_error_t gpgsm_status (ctrl_t ctrl, int no, const char *text);
245 gpg_error_t gpgsm_status2 (ctrl_t ctrl, int no, ...) GPGRT_ATTR_SENTINEL(0);
246 gpg_error_t gpgsm_status_with_err_code (ctrl_t ctrl, int no, const char *text,
247                                         gpg_err_code_t ec);
248 gpg_error_t gpgsm_proxy_pinentry_notify (ctrl_t ctrl,
249                                          const unsigned char *line);
250
251 /*-- fingerprint --*/
252 unsigned char *gpgsm_get_fingerprint (ksba_cert_t cert, int algo,
253                                       unsigned char *array, int *r_len);
254 char *gpgsm_get_fingerprint_string (ksba_cert_t cert, int algo);
255 char *gpgsm_get_fingerprint_hexstring (ksba_cert_t cert, int algo);
256 unsigned long gpgsm_get_short_fingerprint (ksba_cert_t cert,
257                                            unsigned long *r_high);
258 unsigned char *gpgsm_get_keygrip (ksba_cert_t cert, unsigned char *array);
259 char *gpgsm_get_keygrip_hexstring (ksba_cert_t cert);
260 int  gpgsm_get_key_algo_info (ksba_cert_t cert, unsigned int *nbits);
261 char *gpgsm_get_certid (ksba_cert_t cert);
262
263
264 /*-- base64.c --*/
265 int  gpgsm_create_reader (Base64Context *ctx,
266                           ctrl_t ctrl, estream_t fp, int allow_multi_pem,
267                           ksba_reader_t *r_reader);
268 int gpgsm_reader_eof_seen (Base64Context ctx);
269 void gpgsm_destroy_reader (Base64Context ctx);
270 int  gpgsm_create_writer (Base64Context *ctx,
271                           ctrl_t ctrl, estream_t stream,
272                           ksba_writer_t *r_writer);
273 int  gpgsm_finish_writer (Base64Context ctx);
274 void gpgsm_destroy_writer (Base64Context ctx);
275
276
277 /*-- certdump.c --*/
278 void gpgsm_print_serial (estream_t fp, ksba_const_sexp_t p);
279 void gpgsm_print_time (estream_t fp, ksba_isotime_t t);
280 void gpgsm_print_name2 (FILE *fp, const char *string, int translate);
281 void gpgsm_print_name (FILE *fp, const char *string);
282 void gpgsm_es_print_name (estream_t fp, const char *string);
283 void gpgsm_es_print_name2 (estream_t fp, const char *string, int translate);
284
285 void gpgsm_cert_log_name (const char *text, ksba_cert_t cert);
286
287 void gpgsm_dump_cert (const char *text, ksba_cert_t cert);
288 void gpgsm_dump_serial (ksba_const_sexp_t p);
289 void gpgsm_dump_time (ksba_isotime_t t);
290 void gpgsm_dump_string (const char *string);
291
292 char *gpgsm_format_serial (ksba_const_sexp_t p);
293 char *gpgsm_format_name2 (const char *name, int translate);
294 char *gpgsm_format_name (const char *name);
295 char *gpgsm_format_sn_issuer (ksba_sexp_t sn, const char *issuer);
296
297 char *gpgsm_fpr_and_name_for_status (ksba_cert_t cert);
298
299 char *gpgsm_format_keydesc (ksba_cert_t cert);
300
301
302 /*-- certcheck.c --*/
303 int gpgsm_check_cert_sig (ksba_cert_t issuer_cert, ksba_cert_t cert);
304 int gpgsm_check_cms_signature (ksba_cert_t cert, ksba_const_sexp_t sigval,
305                                gcry_md_hd_t md, int hash_algo, int *r_pkalgo);
306 /* fixme: move create functions to another file */
307 int gpgsm_create_cms_signature (ctrl_t ctrl,
308                                 ksba_cert_t cert, gcry_md_hd_t md, int mdalgo,
309                                 unsigned char **r_sigval);
310
311
312 /*-- certchain.c --*/
313
314 /* Flags used with  gpgsm_validate_chain.  */
315 #define VALIDATE_FLAG_NO_DIRMNGR  1
316 #define VALIDATE_FLAG_CHAIN_MODEL 2
317 #define VALIDATE_FLAG_STEED       4
318
319 int gpgsm_walk_cert_chain (ctrl_t ctrl,
320                            ksba_cert_t start, ksba_cert_t *r_next);
321 int gpgsm_is_root_cert (ksba_cert_t cert);
322 int gpgsm_validate_chain (ctrl_t ctrl, ksba_cert_t cert,
323                           ksba_isotime_t checktime,
324                           ksba_isotime_t r_exptime,
325                           int listmode, estream_t listfp,
326                           unsigned int flags, unsigned int *retflags);
327 int gpgsm_basic_cert_check (ctrl_t ctrl, ksba_cert_t cert);
328
329 /*-- certlist.c --*/
330 int gpgsm_cert_use_sign_p (ksba_cert_t cert);
331 int gpgsm_cert_use_encrypt_p (ksba_cert_t cert);
332 int gpgsm_cert_use_verify_p (ksba_cert_t cert);
333 int gpgsm_cert_use_decrypt_p (ksba_cert_t cert);
334 int gpgsm_cert_use_cert_p (ksba_cert_t cert);
335 int gpgsm_cert_use_ocsp_p (ksba_cert_t cert);
336 int gpgsm_cert_has_well_known_private_key (ksba_cert_t cert);
337 int gpgsm_certs_identical_p (ksba_cert_t cert_a, ksba_cert_t cert_b);
338 int gpgsm_add_cert_to_certlist (ctrl_t ctrl, ksba_cert_t cert,
339                                 certlist_t *listaddr, int is_encrypt_to);
340 int gpgsm_add_to_certlist (ctrl_t ctrl, const char *name, int secret,
341                            certlist_t *listaddr, int is_encrypt_to);
342 void gpgsm_release_certlist (certlist_t list);
343 int gpgsm_find_cert (const char *name, ksba_sexp_t keyid, ksba_cert_t *r_cert);
344
345 /*-- keylist.c --*/
346 gpg_error_t gpgsm_list_keys (ctrl_t ctrl, strlist_t names,
347                              estream_t fp, unsigned int mode);
348
349 /*-- import.c --*/
350 int gpgsm_import (ctrl_t ctrl, int in_fd, int reimport_mode);
351 int gpgsm_import_files (ctrl_t ctrl, int nfiles, char **files,
352                         int (*of)(const char *fname));
353
354 /*-- export.c --*/
355 void gpgsm_export (ctrl_t ctrl, strlist_t names, estream_t stream);
356 void gpgsm_p12_export (ctrl_t ctrl, const char *name, estream_t stream,
357                        int rawmode);
358
359 /*-- delete.c --*/
360 int gpgsm_delete (ctrl_t ctrl, strlist_t names);
361
362 /*-- verify.c --*/
363 int gpgsm_verify (ctrl_t ctrl, int in_fd, int data_fd, estream_t out_fp);
364
365 /*-- sign.c --*/
366 int gpgsm_get_default_cert (ctrl_t ctrl, ksba_cert_t *r_cert);
367 int gpgsm_sign (ctrl_t ctrl, certlist_t signerlist,
368                 int data_fd, int detached, estream_t out_fp);
369
370 /*-- encrypt.c --*/
371 int gpgsm_encrypt (ctrl_t ctrl, certlist_t recplist,
372                    int in_fd, estream_t out_fp);
373
374 /*-- decrypt.c --*/
375 int gpgsm_decrypt (ctrl_t ctrl, int in_fd, estream_t out_fp);
376
377 /*-- certreqgen.c --*/
378 int gpgsm_genkey (ctrl_t ctrl, estream_t in_stream, estream_t out_stream);
379
380 /*-- certreqgen-ui.c --*/
381 void gpgsm_gencertreq_tty (ctrl_t ctrl, estream_t out_stream);
382
383
384 /*-- qualified.c --*/
385 gpg_error_t gpgsm_is_in_qualified_list (ctrl_t ctrl, ksba_cert_t cert,
386                                         char *country);
387 gpg_error_t gpgsm_qualified_consent (ctrl_t ctrl, ksba_cert_t cert);
388 gpg_error_t gpgsm_not_qualified_warning (ctrl_t ctrl, ksba_cert_t cert);
389
390 /*-- call-agent.c --*/
391 int gpgsm_agent_pksign (ctrl_t ctrl, const char *keygrip, const char *desc,
392                         unsigned char *digest,
393                         size_t digestlen,
394                         int digestalgo,
395                         unsigned char **r_buf, size_t *r_buflen);
396 int gpgsm_scd_pksign (ctrl_t ctrl, const char *keyid, const char *desc,
397                       unsigned char *digest, size_t digestlen, int digestalgo,
398                       unsigned char **r_buf, size_t *r_buflen);
399 int gpgsm_agent_pkdecrypt (ctrl_t ctrl, const char *keygrip, const char *desc,
400                            ksba_const_sexp_t ciphertext,
401                            char **r_buf, size_t *r_buflen);
402 int gpgsm_agent_genkey (ctrl_t ctrl,
403                         ksba_const_sexp_t keyparms, ksba_sexp_t *r_pubkey);
404 int gpgsm_agent_readkey (ctrl_t ctrl, int fromcard, const char *hexkeygrip,
405                          ksba_sexp_t *r_pubkey);
406 int gpgsm_agent_scd_serialno (ctrl_t ctrl, char **r_serialno);
407 int gpgsm_agent_scd_keypairinfo (ctrl_t ctrl, strlist_t *r_list);
408 int gpgsm_agent_istrusted (ctrl_t ctrl, ksba_cert_t cert, const char *hexfpr,
409                            struct rootca_flags_s *rootca_flags);
410 int gpgsm_agent_havekey (ctrl_t ctrl, const char *hexkeygrip);
411 int gpgsm_agent_marktrusted (ctrl_t ctrl, ksba_cert_t cert);
412 int gpgsm_agent_learn (ctrl_t ctrl);
413 int gpgsm_agent_passwd (ctrl_t ctrl, const char *hexkeygrip, const char *desc);
414 gpg_error_t gpgsm_agent_get_confirmation (ctrl_t ctrl, const char *desc);
415 gpg_error_t gpgsm_agent_send_nop (ctrl_t ctrl);
416 gpg_error_t gpgsm_agent_keyinfo (ctrl_t ctrl, const char *hexkeygrip,
417                                  char **r_serialno);
418 gpg_error_t gpgsm_agent_ask_passphrase (ctrl_t ctrl, const char *desc_msg,
419                                         int repeat, char **r_passphrase);
420 gpg_error_t gpgsm_agent_keywrap_key (ctrl_t ctrl, int forexport,
421                                      void **r_kek, size_t *r_keklen);
422 gpg_error_t gpgsm_agent_import_key (ctrl_t ctrl,
423                                     const void *key, size_t keylen);
424 gpg_error_t gpgsm_agent_export_key (ctrl_t ctrl, const char *keygrip,
425                                     const char *desc,
426                                     unsigned char **r_result,
427                                     size_t *r_resultlen);
428
429 /*-- call-dirmngr.c --*/
430 int gpgsm_dirmngr_isvalid (ctrl_t ctrl,
431                            ksba_cert_t cert, ksba_cert_t issuer_cert,
432                            int use_ocsp);
433 int gpgsm_dirmngr_lookup (ctrl_t ctrl, strlist_t names, int cache_only,
434                           void (*cb)(void*, ksba_cert_t), void *cb_value);
435 int gpgsm_dirmngr_run_command (ctrl_t ctrl, const char *command,
436                                int argc, char **argv);
437
438
439 /*-- misc.c --*/
440 void setup_pinentry_env (void);
441 gpg_error_t transform_sigval (const unsigned char *sigval, size_t sigvallen,
442                               int mdalgo,
443                               unsigned char **r_newsigval,
444                               size_t *r_newsigvallen);
445
446
447
448 #endif /*GPGSM_H*/