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