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