md: Simplify the message digest dispatcher md.c.
[libgcrypt.git] / src / cipher-proto.h
1 /* cipher-proto.h - Internal declarations
2  *      Copyright (C) 2008, 2011 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser general Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt 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 Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 /* This file has been factored out from cipher.h so that it can be
21    used standalone in visibility.c . */
22
23 #ifndef G10_CIPHER_PROTO_H
24 #define G10_CIPHER_PROTO_H
25
26
27 enum pk_encoding;
28
29
30 /* Definition of a function used to report selftest failures.
31    DOMAIN is a string describing the function block:
32           "cipher", "digest", "pubkey or "random",
33    ALGO   is the algorithm under test,
34    WHAT   is a string describing what has been tested,
35    DESC   is a string describing the error. */
36 typedef void (*selftest_report_func_t)(const char *domain,
37                                        int algo,
38                                        const char *what,
39                                        const char *errdesc);
40
41 /* Definition of the selftest functions.  */
42 typedef gpg_err_code_t (*selftest_func_t)
43      (int algo, int extended, selftest_report_func_t report);
44
45 \f
46 /*
47  *
48  * Public key related definitions.
49  *
50  */
51
52 /* Type for the pk_generate function.  */
53 typedef gcry_err_code_t (*gcry_pk_generate_t) (int algo,
54                                                unsigned int nbits,
55                                                unsigned long evalue,
56                                                gcry_sexp_t genparms,
57                                                gcry_sexp_t *r_skey);
58
59 /* Type for the pk_check_secret_key function.  */
60 typedef gcry_err_code_t (*gcry_pk_check_secret_key_t) (int algo,
61                                                        gcry_mpi_t *skey);
62
63 /* Type for the pk_encrypt function.  */
64 typedef gcry_err_code_t (*gcry_pk_encrypt_t) (int algo,
65                                               gcry_sexp_t *r_result,
66                                               gcry_mpi_t data,
67                                               gcry_mpi_t *pkey,
68                                               int flags);
69
70 /* Type for the pk_decrypt function.  */
71 typedef gcry_err_code_t (*gcry_pk_decrypt_t) (int algo,
72                                               gcry_sexp_t *r_result,
73                                               gcry_mpi_t *data,
74                                               gcry_mpi_t *skey,
75                                               int flags,
76                                               enum pk_encoding encoding,
77                                               int hash_algo,
78                                               unsigned char *label,
79                                               size_t labellen);
80
81 /* Type for the pk_sign function.  */
82 typedef gcry_err_code_t (*gcry_pk_sign_t) (int algo,
83                                            gcry_sexp_t *r_result,
84                                            gcry_mpi_t data,
85                                            gcry_mpi_t *skey,
86                                            int flags,
87                                            int hashalgo);
88
89 /* Type for the pk_verify function.  */
90 typedef gcry_err_code_t (*gcry_pk_verify_t) (int algo,
91                                              gcry_mpi_t hash,
92                                              gcry_mpi_t *data,
93                                              gcry_mpi_t *pkey,
94                                              int (*cmp) (void *, gcry_mpi_t),
95                                              void *opaquev,
96                                              int flags,
97                                              int hashalgo);
98
99 /* Type for the pk_get_nbits function.  */
100 typedef unsigned (*gcry_pk_get_nbits_t) (int algo,
101                                          gcry_mpi_t *pkey);
102
103
104 /* The type used to compute the keygrip.  */
105 typedef gpg_err_code_t (*pk_comp_keygrip_t) (gcry_md_hd_t md,
106                                              gcry_sexp_t keyparm);
107
108 /* The type used to query ECC curve parameters.  */
109 typedef gcry_err_code_t (*pk_get_param_t) (const char *name,
110                                            gcry_mpi_t *pkey);
111
112 /* The type used to query an ECC curve name.  */
113 typedef const char *(*pk_get_curve_t)(gcry_mpi_t *pkey, int iterator,
114                                       unsigned int *r_nbits);
115
116 /* The type used to query ECC curve parameters by name.  */
117 typedef gcry_sexp_t (*pk_get_curve_param_t)(const char *name);
118
119
120 /* Module specification structure for public key algoritms.  */
121 typedef struct gcry_pk_spec
122 {
123   int algo;
124   struct {
125     unsigned int disabled:1;
126     unsigned int fips:1;
127   } flags;
128   int use;
129   const char *name;
130   const char **aliases;
131   const char *elements_pkey;
132   const char *elements_skey;
133   const char *elements_enc;
134   const char *elements_sig;
135   const char *elements_grip;
136   gcry_pk_generate_t generate;
137   gcry_pk_check_secret_key_t check_secret_key;
138   gcry_pk_encrypt_t encrypt;
139   gcry_pk_decrypt_t decrypt;
140   gcry_pk_sign_t sign;
141   gcry_pk_verify_t verify;
142   gcry_pk_get_nbits_t get_nbits;
143   selftest_func_t selftest;
144   pk_comp_keygrip_t comp_keygrip;
145   pk_get_param_t get_param;
146   pk_get_curve_t get_curve;
147   pk_get_curve_param_t get_curve_param;
148 } gcry_pk_spec_t;
149
150
151 \f
152 /*
153  *
154  * Symmetric cipher related definitions.
155  *
156  */
157
158 /* Type for the cipher_setkey function.  */
159 typedef gcry_err_code_t (*gcry_cipher_setkey_t) (void *c,
160                                                  const unsigned char *key,
161                                                  unsigned keylen);
162
163 /* Type for the cipher_encrypt function.  */
164 typedef unsigned int (*gcry_cipher_encrypt_t) (void *c,
165                                                unsigned char *outbuf,
166                                                const unsigned char *inbuf);
167
168 /* Type for the cipher_decrypt function.  */
169 typedef unsigned int (*gcry_cipher_decrypt_t) (void *c,
170                                                unsigned char *outbuf,
171                                                const unsigned char *inbuf);
172
173 /* Type for the cipher_stencrypt function.  */
174 typedef void (*gcry_cipher_stencrypt_t) (void *c,
175                                          unsigned char *outbuf,
176                                          const unsigned char *inbuf,
177                                          unsigned int n);
178
179 /* Type for the cipher_stdecrypt function.  */
180 typedef void (*gcry_cipher_stdecrypt_t) (void *c,
181                                          unsigned char *outbuf,
182                                          const unsigned char *inbuf,
183                                          unsigned int n);
184
185 /* The type used to convey additional information to a cipher.  */
186 typedef gpg_err_code_t (*cipher_set_extra_info_t)
187      (void *c, int what, const void *buffer, size_t buflen);
188
189 /* The type used to set an IV directly in the algorithm module.  */
190 typedef void (*cipher_setiv_func_t)(void *c,
191                                     const byte *iv, unsigned int ivlen);
192
193 /* A structure to map OIDs to encryption modes.  */
194 typedef struct gcry_cipher_oid_spec
195 {
196   const char *oid;
197   int mode;
198 } gcry_cipher_oid_spec_t;
199
200
201 /* Module specification structure for ciphers.  */
202 typedef struct gcry_cipher_spec
203 {
204   int algo;
205   struct {
206     unsigned int disabled:1;
207     unsigned int fips:1;
208   } flags;
209   const char *name;
210   const char **aliases;
211   gcry_cipher_oid_spec_t *oids;
212   size_t blocksize;
213   size_t keylen;
214   size_t contextsize;
215   gcry_cipher_setkey_t setkey;
216   gcry_cipher_encrypt_t encrypt;
217   gcry_cipher_decrypt_t decrypt;
218   gcry_cipher_stencrypt_t stencrypt;
219   gcry_cipher_stdecrypt_t stdecrypt;
220   selftest_func_t selftest;
221   cipher_set_extra_info_t set_extra_info;
222   cipher_setiv_func_t setiv;
223 } gcry_cipher_spec_t;
224
225
226 \f
227 /*
228  *
229  * Message digest related definitions.
230  *
231  */
232
233 /* Type for the md_init function.  */
234 typedef void (*gcry_md_init_t) (void *c);
235
236 /* Type for the md_write function.  */
237 typedef void (*gcry_md_write_t) (void *c, const void *buf, size_t nbytes);
238
239 /* Type for the md_final function.  */
240 typedef void (*gcry_md_final_t) (void *c);
241
242 /* Type for the md_read function.  */
243 typedef unsigned char *(*gcry_md_read_t) (void *c);
244
245 typedef struct gcry_md_oid_spec
246 {
247   const char *oidstring;
248 } gcry_md_oid_spec_t;
249
250 /* Module specification structure for message digests.  */
251 typedef struct gcry_md_spec
252 {
253   int algo;
254   struct {
255     unsigned int disabled:1;
256     unsigned int fips:1;
257   } flags;
258   const char *name;
259   unsigned char *asnoid;
260   int asnlen;
261   gcry_md_oid_spec_t *oids;
262   int mdlen;
263   gcry_md_init_t init;
264   gcry_md_write_t write;
265   gcry_md_final_t final;
266   gcry_md_read_t read;
267   size_t contextsize; /* allocate this amount of context */
268   selftest_func_t selftest;
269 } gcry_md_spec_t;
270
271
272 \f
273 /* The selftest functions.  */
274 gcry_error_t _gcry_cipher_selftest (int algo, int extended,
275                                     selftest_report_func_t report);
276 gcry_error_t _gcry_md_selftest (int algo, int extended,
277                                 selftest_report_func_t report);
278 gcry_error_t _gcry_pk_selftest (int algo, int extended,
279                                 selftest_report_func_t report);
280 gcry_error_t _gcry_hmac_selftest (int algo, int extended,
281                                   selftest_report_func_t report);
282
283 gcry_error_t _gcry_random_selftest (selftest_report_func_t report);
284
285
286 /*-- pubkey.c --*/
287 gcry_err_code_t _gcry_pubkey_get_sexp (gcry_sexp_t *r_sexp,
288                                        int reserved, gcry_ctx_t ctx);
289
290
291 #endif /*G10_CIPHER_PROTO_H*/