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