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