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