* call-agent.c (gpgsm_agent_havekey): New.
[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   const char *dirmngr_program;
43   char *outfile;    /* name of output file */
44
45   int with_key_data;/* include raw key in the column delimted output */
46
47   int fingerprint;  /* list fingerprints in all key listings */
48
49   int armor;        /* force base64 armoring (see also ctrl.with_base64) */
50   int no_armor;     /* don't try to figure out whether data is base64 armored*/
51
52   const char *def_cipher_algoid;  /* cipher algorithm to use if
53                                      nothing else is specified */
54
55   int def_digest_algo;    /* Ditto for hash algorithm */
56   int def_compress_algo;  /* Ditto for compress algorithm */
57
58   char *def_recipient;    /* userID of the default recipient */
59   int def_recipient_self; /* The default recipient is the default key */
60
61   int always_trust;       /* Trust the given keys even if there is no
62                              valid certification path */
63   int skip_verify;        /* do not check signatures on data */
64
65   int lock_once;          /* Keep lock once they are set */
66
67   int ignore_time_conflict; /* Ignore certain time conflicts */
68
69   int no_crl_check;       /* Don't do a CRL check */
70
71 } opt;
72
73
74 #define DBG_X509_VALUE    1     /* debug x.509 data reading/writing */
75 #define DBG_MPI_VALUE     2     /* debug mpi details */
76 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
77 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
78 #define DBG_CACHE_VALUE   64    /* debug the caching */
79 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
80 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
81 #define DBG_AGENT_VALUE  1024   /* debug communication with the agent */
82
83 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
84 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
85 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
86 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
87 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
88 #define DBG_AGENT   (opt.debug & DBG_AGENT_VALUE)
89
90 struct server_local_s;
91
92 /* Note that the default values for this are set by
93    gpgsm_init_default_ctrl() */
94 struct server_control_s {
95   int no_server;     /* we are not running under server control */
96   int  status_fd;    /* only for non-server mode */
97   struct server_local_s *server_local;
98   int with_colons;  /* use column delimited output format */
99
100   int autodetect_encoding; /* try to detect the input encoding */
101   int is_pem;         /* Is in PEM format */
102   int is_base64;      /* is in plain base-64 format */
103
104   int create_base64;  /* Create base64 encoded output */
105   int create_pem;     /* create PEM output */
106   const char *pem_name; /* PEM name to use */
107
108   int include_certs;  /* -1 to send all certificates in the chain
109                          along with a signature or the number of
110                          certificates up the chain (0 = none, 1 = only
111                          signer) */
112  
113 };
114 typedef struct server_control_s *CTRL;
115
116 /* data structure used in base64.c */
117 typedef struct base64_context_s *Base64Context;
118
119
120 struct certlist_s {
121   struct certlist_s *next;
122   KsbaCert cert;
123 };
124 typedef struct certlist_s *CERTLIST;
125
126 /*-- gpgsm.c --*/
127 void gpgsm_exit (int rc);
128 void gpgsm_init_default_ctrl (struct server_control_s *ctrl);
129
130 /*-- server.c --*/
131 void gpgsm_server (void);
132 void gpgsm_status (CTRL ctrl, int no, const char *text);
133
134 /*-- fingerprint --*/
135 char *gpgsm_get_fingerprint (KsbaCert cert, int algo, char *array, int *r_len);
136 char *gpgsm_get_fingerprint_string (KsbaCert cert, int algo);
137 char *gpgsm_get_fingerprint_hexstring (KsbaCert cert, int algo);
138 char *gpgsm_get_keygrip (KsbaCert cert, char *array);
139 char *gpgsm_get_keygrip_hexstring (KsbaCert cert);
140 char *gpgsm_get_certid (KsbaCert cert);
141
142
143 /*-- base64.c --*/
144 int  gpgsm_create_reader (Base64Context *ctx,
145                           CTRL ctrl, FILE *fp, KsbaReader *r_reader);
146 void gpgsm_destroy_reader (Base64Context ctx);
147 int  gpgsm_create_writer (Base64Context *ctx,
148                           CTRL ctrl, FILE *fp, KsbaWriter *r_writer);
149 int  gpgsm_finish_writer (Base64Context ctx);
150 void gpgsm_destroy_writer (Base64Context ctx);
151
152
153 /*-- certdump.c --*/
154 void gpgsm_dump_cert (const char *text, KsbaCert cert);
155 void gpgsm_dump_serial (KsbaConstSexp p);
156 void gpgsm_dump_time (time_t t);
157 void gpgsm_dump_string (const char *string);
158
159 /*-- certcheck.c --*/
160 int gpgsm_check_cert_sig (KsbaCert issuer_cert, KsbaCert cert);
161 int gpgsm_check_cms_signature (KsbaCert cert, KsbaConstSexp sigval,
162                                GCRY_MD_HD md, int hash_algo);
163 /* fixme: move create functions to another file */
164 int gpgsm_create_cms_signature (KsbaCert cert, GCRY_MD_HD md, int mdalgo,
165                                 char **r_sigval);
166
167
168 /*-- certpath.c --*/
169 int gpgsm_walk_cert_chain (KsbaCert start, KsbaCert *r_next);
170 int gpgsm_validate_path (KsbaCert cert);
171 int gpgsm_basic_cert_check (KsbaCert cert);
172
173 /*-- cetrlist.c --*/
174 int gpgsm_add_to_certlist (const char *name, CERTLIST *listaddr);
175 void gpgsm_release_certlist (CERTLIST list);
176 int gpgsm_find_cert (const char *name, KsbaCert *r_cert);
177
178 /*-- keylist.c --*/
179 void gpgsm_list_keys (CTRL ctrl, STRLIST names, FILE *fp, unsigned int mode);
180
181 /*-- import.c --*/
182 int gpgsm_import (CTRL ctrl, int in_fd);
183
184 /*-- verify.c --*/
185 int gpgsm_verify (CTRL ctrl, int in_fd, int data_fd, FILE *out_fp);
186
187 /*-- sign.c --*/
188 int gpgsm_sign (CTRL ctrl, int data_fd, int detached, FILE *out_fp);
189
190 /*-- encrypt.c --*/
191 int gpgsm_encrypt (CTRL ctrl, CERTLIST recplist, int in_fd, FILE *out_fp);
192
193 /*-- decrypt.c --*/
194 int gpgsm_decrypt (CTRL ctrl, int in_fd, FILE *out_fp);
195
196 /*-- certreqgen.c --*/
197 int gpgsm_genkey (CTRL ctrl, int in_fd, FILE *out_fp);
198
199 /*-- call-agent.c --*/
200 int gpgsm_agent_pksign (const char *keygrip,
201                         unsigned char *digest,
202                         size_t digestlen,
203                         int digestalgo,
204                         char **r_buf, size_t *r_buflen);
205 int gpgsm_agent_pkdecrypt (const char *keygrip,
206                            KsbaConstSexp  ciphertext, 
207                            char **r_buf, size_t *r_buflen);
208 int gpgsm_agent_genkey (KsbaConstSexp keyparms, KsbaSexp *r_pubkey);
209 int gpgsm_agent_istrusted (KsbaCert cert);
210 int gpgsm_agent_havekey (const char *hexkeygrip);
211
212 /*-- call-dirmngr.c --*/
213 int gpgsm_dirmngr_isvalid (KsbaCert cert);
214
215
216
217
218
219 #endif /*GPGSM_H*/
220
221
222