Make use of libgpg-error
[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 name "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
87   char *policy_file;        /* full pathname of policy file */
88   int no_policy_check;      /* ignore certificate policies */
89   int no_chain_validation;  /* Bypass all cert chain validity tests */
90
91   int auto_issuer_key_retrieve; /* try to retrieve a missing issuer key. */
92 } opt;
93
94
95 #define DBG_X509_VALUE    1     /* debug x.509 data reading/writing */
96 #define DBG_MPI_VALUE     2     /* debug mpi details */
97 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
98 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
99 #define DBG_CACHE_VALUE   64    /* debug the caching */
100 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
101 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
102 #define DBG_ASSUAN_VALUE  1024  /* debug assuan communication */
103
104 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
105 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
106 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
107 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
108 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
109 #define DBG_ASSUAN   (opt.debug & DBG_ASSUAN_VALUE)
110
111 struct server_local_s;
112
113 /* Note that the default values for this are set by
114    gpgsm_init_default_ctrl() */
115 struct server_control_s {
116   int no_server;     /* we are not running under server control */
117   int  status_fd;    /* only for non-server mode */
118   struct server_local_s *server_local;
119   int with_colons;  /* use column delimited output format */
120   int with_chain;   /* include the certifying certs in a listing */
121
122   int autodetect_encoding; /* try to detect the input encoding */
123   int is_pem;         /* Is in PEM format */
124   int is_base64;      /* is in plain base-64 format */
125
126   int create_base64;  /* Create base64 encoded output */
127   int create_pem;     /* create PEM output */
128   const char *pem_name; /* PEM name to use */
129
130   int include_certs;  /* -1 to send all certificates in the chain
131                          along with a signature or the number of
132                          certificates up the chain (0 = none, 1 = only
133                          signer) */
134 };
135 typedef struct server_control_s *CTRL;
136
137 /* data structure used in base64.c */
138 typedef struct base64_context_s *Base64Context;
139
140
141 struct certlist_s {
142   struct certlist_s *next;
143   KsbaCert cert;
144 };
145 typedef struct certlist_s *CERTLIST;
146
147 /*-- gpgsm.c --*/
148 void gpgsm_exit (int rc);
149 void gpgsm_init_default_ctrl (struct server_control_s *ctrl);
150
151 /*-- server.c --*/
152 void gpgsm_server (void);
153 void gpgsm_status (CTRL ctrl, int no, const char *text);
154 void gpgsm_status2 (CTRL ctrl, int no, ...);
155
156 /*-- fingerprint --*/
157 char *gpgsm_get_fingerprint (KsbaCert cert, int algo, char *array, int *r_len);
158 char *gpgsm_get_fingerprint_string (KsbaCert cert, int algo);
159 char *gpgsm_get_fingerprint_hexstring (KsbaCert cert, int algo);
160 unsigned long gpgsm_get_short_fingerprint (KsbaCert cert);
161 char *gpgsm_get_keygrip (KsbaCert cert, char *array);
162 char *gpgsm_get_keygrip_hexstring (KsbaCert cert);
163 char *gpgsm_get_certid (KsbaCert cert);
164
165
166 /*-- base64.c --*/
167 int  gpgsm_create_reader (Base64Context *ctx,
168                           CTRL ctrl, FILE *fp, KsbaReader *r_reader);
169 void gpgsm_destroy_reader (Base64Context ctx);
170 int  gpgsm_create_writer (Base64Context *ctx,
171                           CTRL ctrl, FILE *fp, KsbaWriter *r_writer);
172 int  gpgsm_finish_writer (Base64Context ctx);
173 void gpgsm_destroy_writer (Base64Context ctx);
174
175
176 /*-- certdump.c --*/
177 void gpgsm_print_serial (FILE *fp, KsbaConstSexp p);
178 void gpgsm_print_time (FILE *fp, time_t t);
179 void gpgsm_print_name (FILE *fp, const char *string);
180
181 void gpgsm_dump_cert (const char *text, KsbaCert cert);
182 void gpgsm_dump_serial (KsbaConstSexp p);
183 void gpgsm_dump_time (time_t t);
184 void gpgsm_dump_string (const char *string);
185
186
187
188 /*-- certcheck.c --*/
189 int gpgsm_check_cert_sig (KsbaCert issuer_cert, KsbaCert cert);
190 int gpgsm_check_cms_signature (KsbaCert cert, KsbaConstSexp sigval,
191                                GCRY_MD_HD md, int hash_algo);
192 /* fixme: move create functions to another file */
193 int gpgsm_create_cms_signature (KsbaCert cert, GCRY_MD_HD md, int mdalgo,
194                                 char **r_sigval);
195
196
197 /*-- certchain.c --*/
198 int gpgsm_walk_cert_chain (KsbaCert start, KsbaCert *r_next);
199 int gpgsm_is_root_cert (KsbaCert cert);
200 int gpgsm_validate_chain (CTRL ctrl, KsbaCert cert, time_t *r_exptime);
201 int gpgsm_basic_cert_check (KsbaCert cert);
202
203 /*-- certlist.c --*/
204 int gpgsm_cert_use_sign_p (KsbaCert cert);
205 int gpgsm_cert_use_encrypt_p (KsbaCert cert);
206 int gpgsm_cert_use_verify_p (KsbaCert cert);
207 int gpgsm_cert_use_decrypt_p (KsbaCert cert);
208 int gpgsm_cert_use_cert_p (KsbaCert cert);
209 int gpgsm_add_to_certlist (CTRL ctrl, const char *name, int secret,
210                            CERTLIST *listaddr);
211 void gpgsm_release_certlist (CERTLIST list);
212 int gpgsm_find_cert (const char *name, KsbaCert *r_cert);
213
214 /*-- keylist.c --*/
215 void gpgsm_list_keys (CTRL ctrl, STRLIST names, FILE *fp, unsigned int mode);
216
217 /*-- import.c --*/
218 int gpgsm_import (CTRL ctrl, int in_fd);
219 int gpgsm_import_files (CTRL ctrl, int nfiles, char **files,
220                         int (*of)(const char *fname));
221
222 /*-- export.c --*/
223 void gpgsm_export (CTRL ctrl, STRLIST names, FILE *fp);
224
225 /*-- delete.c --*/
226 int gpgsm_delete (CTRL ctrl, STRLIST names);
227
228 /*-- verify.c --*/
229 int gpgsm_verify (CTRL ctrl, int in_fd, int data_fd, FILE *out_fp);
230
231 /*-- sign.c --*/
232 int gpgsm_get_default_cert (KsbaCert *r_cert);
233 int gpgsm_sign (CTRL ctrl, CERTLIST signerlist,
234                 int data_fd, int detached, FILE *out_fp);
235
236 /*-- encrypt.c --*/
237 int gpgsm_encrypt (CTRL ctrl, CERTLIST recplist, int in_fd, FILE *out_fp);
238
239 /*-- decrypt.c --*/
240 int gpgsm_decrypt (CTRL ctrl, int in_fd, FILE *out_fp);
241
242 /*-- certreqgen.c --*/
243 int gpgsm_genkey (CTRL ctrl, int in_fd, FILE *out_fp);
244
245 /*-- call-agent.c --*/
246 int gpgsm_agent_pksign (const char *keygrip,
247                         unsigned char *digest,
248                         size_t digestlen,
249                         int digestalgo,
250                         char **r_buf, size_t *r_buflen);
251 int gpgsm_agent_pkdecrypt (const char *keygrip,
252                            KsbaConstSexp  ciphertext, 
253                            char **r_buf, size_t *r_buflen);
254 int gpgsm_agent_genkey (KsbaConstSexp keyparms, KsbaSexp *r_pubkey);
255 int gpgsm_agent_istrusted (KsbaCert cert);
256 int gpgsm_agent_havekey (const char *hexkeygrip);
257 int gpgsm_agent_marktrusted (KsbaCert cert);
258 int gpgsm_agent_learn (void);
259 int gpgsm_agent_passwd (const char *hexkeygrip);
260
261 /*-- call-dirmngr.c --*/
262 int gpgsm_dirmngr_isvalid (KsbaCert cert);
263 int gpgsm_dirmngr_lookup (CTRL ctrl, STRLIST names,
264                           void (*cb)(void*, KsbaCert), void *cb_value);
265 int gpgsm_dirmngr_run_command (CTRL ctrl, const char *command,
266                                int argc, char **argv);
267
268
269
270
271
272 #endif /*GPGSM_H*/