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