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