Replaced deprecated type names.
[gnupg.git] / sm / gpgsm.h
1 /* gpgsm.h - Global definitions for GpgSM
2  *      Copyright (C) 2001, 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
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 #include <ksba.h>
31 #include "../common/util.h"
32 #include "../common/errors.h"
33
34 #define OUT_OF_CORE(a) (gpg_error (gpg_err_code_from_errno ((a))))
35
36 #define MAX_DIGEST_LEN 24 
37
38 /* A large struct named "opt" to keep global flags */
39 struct {
40   unsigned int debug; /* debug flags (DBG_foo_VALUE) */
41   int verbose;      /* verbosity level */
42   int quiet;        /* be as quiet as possible */
43   int batch;        /* run in batch mode, i.e w/o any user interaction */
44   int answer_yes;   /* assume yes on most questions */
45   int answer_no;    /* assume no on most questions */
46   int dry_run;      /* don't change any persistent data */
47
48   const char *homedir; /* configuration directory name */
49   const char *agent_program; 
50   char *display;
51   char *ttyname;
52   char *ttytype;
53   char *lc_ctype;
54   char *lc_messages;
55
56   const char *dirmngr_program;
57   char *outfile;    /* name of output file */
58
59   int with_key_data;/* include raw key in the column delimted output */
60
61   int fingerprint;  /* list fingerprints in all key listings */
62
63   int armor;        /* force base64 armoring (see also ctrl.with_base64) */
64   int no_armor;     /* don't try to figure out whether data is base64 armored*/
65
66   const char *def_cipher_algoid;  /* cipher algorithm to use if
67                                      nothing else is specified */
68
69   int def_digest_algo;    /* Ditto for hash algorithm */
70   int def_compress_algo;  /* Ditto for compress algorithm */
71
72   char *def_recipient;    /* userID of the default recipient */
73   int def_recipient_self; /* The default recipient is the default key */
74
75   char *local_user;       /* NULL or argument to -u */
76
77   int always_trust;       /* Trust the given keys even if there is no
78                              valid certification chain */
79   int skip_verify;        /* do not check signatures on data */
80
81   int lock_once;          /* Keep lock once they are set */
82
83   int ignore_time_conflict; /* Ignore certain time conflicts */
84
85   int no_crl_check;         /* Don't do a CRL check */
86   int enable_ocsp;          /* Default to use OCSP checks. */
87
88   char *policy_file;        /* full pathname of policy file */
89   int no_policy_check;      /* ignore certificate policies */
90   int no_chain_validation;  /* Bypass all cert chain validity tests */
91
92   int auto_issuer_key_retrieve; /* try to retrieve a missing issuer key. */
93 } opt;
94
95
96 #define DBG_X509_VALUE    1     /* debug x.509 data reading/writing */
97 #define DBG_MPI_VALUE     2     /* debug mpi details */
98 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
99 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
100 #define DBG_CACHE_VALUE   64    /* debug the caching */
101 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
102 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
103 #define DBG_ASSUAN_VALUE  1024  /* debug assuan communication */
104
105 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
106 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
107 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
108 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
109 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
110 #define DBG_ASSUAN   (opt.debug & DBG_ASSUAN_VALUE)
111
112 struct server_local_s;
113
114 /* Note that the default values for this are set by
115    gpgsm_init_default_ctrl() */
116 struct server_control_s {
117   int no_server;     /* we are not running under server control */
118   int  status_fd;    /* only for non-server mode */
119   struct server_local_s *server_local;
120   int with_colons;  /* use column delimited output format */
121   int with_chain;   /* include the certifying certs in a listing */
122
123   int autodetect_encoding; /* try to detect the input encoding */
124   int is_pem;         /* Is in PEM format */
125   int is_base64;      /* is in plain base-64 format */
126
127   int create_base64;  /* Create base64 encoded output */
128   int create_pem;     /* create PEM output */
129   const char *pem_name; /* PEM name to use */
130
131   int include_certs;  /* -1 to send all certificates in the chain
132                          along with a signature or the number of
133                          certificates up the chain (0 = none, 1 = only
134                          signer) */
135   int use_ocsp;       /* Set to true if OCSP should be used. */
136 };
137 typedef struct server_control_s *CTRL;
138
139 /* data structure used in base64.c */
140 typedef struct base64_context_s *Base64Context;
141
142
143 struct certlist_s {
144   struct certlist_s *next;
145   ksba_cert_t cert;
146 };
147 typedef struct certlist_s *CERTLIST;
148
149 /*-- gpgsm.c --*/
150 void gpgsm_exit (int rc);
151 void gpgsm_init_default_ctrl (struct server_control_s *ctrl);
152
153 /*-- server.c --*/
154 void gpgsm_server (void);
155 void gpgsm_status (CTRL ctrl, int no, const char *text);
156 void gpgsm_status2 (CTRL ctrl, int no, ...);
157 void gpgsm_status_with_err_code (CTRL ctrl, int no, const char *text,
158                                  gpg_err_code_t ec);
159
160 /*-- fingerprint --*/
161 char *gpgsm_get_fingerprint (ksba_cert_t cert, int algo, char *array, int *r_len);
162 char *gpgsm_get_fingerprint_string (ksba_cert_t cert, int algo);
163 char *gpgsm_get_fingerprint_hexstring (ksba_cert_t cert, int algo);
164 unsigned long gpgsm_get_short_fingerprint (ksba_cert_t cert);
165 char *gpgsm_get_keygrip (ksba_cert_t cert, char *array);
166 char *gpgsm_get_keygrip_hexstring (ksba_cert_t cert);
167 char *gpgsm_get_certid (ksba_cert_t cert);
168
169
170 /*-- base64.c --*/
171 int  gpgsm_create_reader (Base64Context *ctx,
172                           CTRL ctrl, FILE *fp, ksba_reader_t *r_reader);
173 void gpgsm_destroy_reader (Base64Context ctx);
174 int  gpgsm_create_writer (Base64Context *ctx,
175                           CTRL ctrl, FILE *fp, ksba_writer_t *r_writer);
176 int  gpgsm_finish_writer (Base64Context ctx);
177 void gpgsm_destroy_writer (Base64Context ctx);
178
179
180 /*-- certdump.c --*/
181 void gpgsm_print_serial (FILE *fp, ksba_const_sexp_t p);
182 void gpgsm_print_time (FILE *fp, ksba_isotime_t t);
183 void gpgsm_print_name (FILE *fp, const char *string);
184
185 void gpgsm_dump_cert (const char *text, ksba_cert_t cert);
186 void gpgsm_dump_serial (ksba_const_sexp_t p);
187 void gpgsm_dump_time (ksba_isotime_t t);
188 void gpgsm_dump_string (const char *string);
189
190
191
192 /*-- certcheck.c --*/
193 int gpgsm_check_cert_sig (ksba_cert_t issuer_cert, ksba_cert_t cert);
194 int gpgsm_check_cms_signature (ksba_cert_t cert, ksba_const_sexp_t sigval,
195                                gcry_md_hd_t md, int hash_algo);
196 /* fixme: move create functions to another file */
197 int gpgsm_create_cms_signature (ksba_cert_t cert, gcry_md_hd_t md, int mdalgo,
198                                 char **r_sigval);
199
200
201 /*-- certchain.c --*/
202 int gpgsm_walk_cert_chain (ksba_cert_t start, ksba_cert_t *r_next);
203 int gpgsm_is_root_cert (ksba_cert_t cert);
204 int gpgsm_validate_chain (CTRL ctrl, ksba_cert_t cert, ksba_isotime_t r_exptime);
205 int gpgsm_basic_cert_check (ksba_cert_t cert);
206
207 /*-- certlist.c --*/
208 int gpgsm_cert_use_sign_p (ksba_cert_t cert);
209 int gpgsm_cert_use_encrypt_p (ksba_cert_t cert);
210 int gpgsm_cert_use_verify_p (ksba_cert_t cert);
211 int gpgsm_cert_use_decrypt_p (ksba_cert_t cert);
212 int gpgsm_cert_use_cert_p (ksba_cert_t cert);
213 int gpgsm_add_to_certlist (CTRL ctrl, const char *name, int secret,
214                            CERTLIST *listaddr);
215 void gpgsm_release_certlist (CERTLIST list);
216 int gpgsm_find_cert (const char *name, ksba_cert_t *r_cert);
217
218 /*-- keylist.c --*/
219 void gpgsm_list_keys (CTRL ctrl, STRLIST names, FILE *fp, unsigned int mode);
220
221 /*-- import.c --*/
222 int gpgsm_import (CTRL ctrl, int in_fd);
223 int gpgsm_import_files (CTRL ctrl, int nfiles, char **files,
224                         int (*of)(const char *fname));
225
226 /*-- export.c --*/
227 void gpgsm_export (CTRL ctrl, STRLIST names, FILE *fp);
228
229 /*-- delete.c --*/
230 int gpgsm_delete (CTRL ctrl, STRLIST names);
231
232 /*-- verify.c --*/
233 int gpgsm_verify (CTRL ctrl, int in_fd, int data_fd, FILE *out_fp);
234
235 /*-- sign.c --*/
236 int gpgsm_get_default_cert (ksba_cert_t *r_cert);
237 int gpgsm_sign (CTRL ctrl, CERTLIST signerlist,
238                 int data_fd, int detached, FILE *out_fp);
239
240 /*-- encrypt.c --*/
241 int gpgsm_encrypt (CTRL ctrl, CERTLIST recplist, int in_fd, FILE *out_fp);
242
243 /*-- decrypt.c --*/
244 int gpgsm_decrypt (CTRL ctrl, int in_fd, FILE *out_fp);
245
246 /*-- certreqgen.c --*/
247 int gpgsm_genkey (CTRL ctrl, int in_fd, FILE *out_fp);
248
249 /*-- call-agent.c --*/
250 int gpgsm_agent_pksign (const char *keygrip,
251                         unsigned char *digest,
252                         size_t digestlen,
253                         int digestalgo,
254                         char **r_buf, size_t *r_buflen);
255 int gpgsm_agent_pkdecrypt (const char *keygrip,
256                            ksba_const_sexp_t ciphertext, 
257                            char **r_buf, size_t *r_buflen);
258 int gpgsm_agent_genkey (ksba_const_sexp_t keyparms, ksba_sexp_t *r_pubkey);
259 int gpgsm_agent_istrusted (ksba_cert_t cert);
260 int gpgsm_agent_havekey (const char *hexkeygrip);
261 int gpgsm_agent_marktrusted (ksba_cert_t cert);
262 int gpgsm_agent_learn (void);
263 int gpgsm_agent_passwd (const char *hexkeygrip);
264
265 /*-- call-dirmngr.c --*/
266 int gpgsm_dirmngr_isvalid (ksba_cert_t cert, int use_ocsp);
267 int gpgsm_dirmngr_lookup (CTRL ctrl, STRLIST names,
268                           void (*cb)(void*, ksba_cert_t), void *cb_value);
269 int gpgsm_dirmngr_run_command (CTRL ctrl, const char *command,
270                                int argc, char **argv);
271
272
273
274
275
276 #endif /*GPGSM_H*/