pubkey: Move sexp parsing for gcry_pk_getkey to the modules.
[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) (gcry_sexp_t genparms,
54                                                gcry_sexp_t *r_skey);
55
56 /* Type for the pk_check_secret_key function.  */
57 typedef gcry_err_code_t (*gcry_pk_check_secret_key_t) (int algo,
58                                                        gcry_mpi_t *skey);
59
60 /* Type for the pk_encrypt function.  */
61 typedef gcry_err_code_t (*gcry_pk_encrypt_t) (int algo,
62                                               gcry_sexp_t *r_result,
63                                               gcry_mpi_t data,
64                                               gcry_mpi_t *pkey,
65                                               int flags);
66
67 /* Type for the pk_decrypt function.  */
68 typedef gcry_err_code_t (*gcry_pk_decrypt_t) (int algo,
69                                               gcry_sexp_t *r_result,
70                                               gcry_mpi_t *data,
71                                               gcry_mpi_t *skey,
72                                               int flags,
73                                               enum pk_encoding encoding,
74                                               int hash_algo,
75                                               unsigned char *label,
76                                               size_t labellen);
77
78 /* Type for the pk_sign function.  */
79 typedef gcry_err_code_t (*gcry_pk_sign_t) (int algo,
80                                            gcry_sexp_t *r_result,
81                                            gcry_mpi_t data,
82                                            gcry_mpi_t *skey,
83                                            int flags,
84                                            int hashalgo);
85
86 /* Type for the pk_verify function.  */
87 typedef gcry_err_code_t (*gcry_pk_verify_t) (int algo,
88                                              gcry_mpi_t hash,
89                                              gcry_mpi_t *data,
90                                              gcry_mpi_t *pkey,
91                                              int (*cmp) (void *, gcry_mpi_t),
92                                              void *opaquev,
93                                              int flags,
94                                              int hashalgo);
95
96 /* Type for the pk_get_nbits function.  */
97 typedef unsigned (*gcry_pk_get_nbits_t) (int algo,
98                                          gcry_mpi_t *pkey);
99
100
101 /* The type used to compute the keygrip.  */
102 typedef gpg_err_code_t (*pk_comp_keygrip_t) (gcry_md_hd_t md,
103                                              gcry_sexp_t keyparm);
104
105 /* The type used to query ECC curve parameters.  */
106 typedef gcry_err_code_t (*pk_get_param_t) (const char *name,
107                                            gcry_mpi_t *pkey);
108
109 /* The type used to query an ECC curve name.  */
110 typedef const char *(*pk_get_curve_t)(gcry_mpi_t *pkey, int iterator,
111                                       unsigned int *r_nbits);
112
113 /* The type used to query ECC curve parameters by name.  */
114 typedef gcry_sexp_t (*pk_get_curve_param_t)(const char *name);
115
116
117 /* Module specification structure for public key algoritms.  */
118 typedef struct gcry_pk_spec
119 {
120   int algo;
121   struct {
122     unsigned int disabled:1;
123     unsigned int fips:1;
124   } flags;
125   int use;
126   const char *name;
127   const char **aliases;
128   const char *elements_pkey;
129   const char *elements_skey;
130   const char *elements_enc;
131   const char *elements_sig;
132   const char *elements_grip;
133   gcry_pk_generate_t generate;
134   gcry_pk_check_secret_key_t check_secret_key;
135   gcry_pk_encrypt_t encrypt;
136   gcry_pk_decrypt_t decrypt;
137   gcry_pk_sign_t sign;
138   gcry_pk_verify_t verify;
139   gcry_pk_get_nbits_t get_nbits;
140   selftest_func_t selftest;
141   pk_comp_keygrip_t comp_keygrip;
142   pk_get_param_t get_param;
143   pk_get_curve_t get_curve;
144   pk_get_curve_param_t get_curve_param;
145 } gcry_pk_spec_t;
146
147
148 \f
149 /*
150  *
151  * Symmetric cipher related definitions.
152  *
153  */
154
155 /* Type for the cipher_setkey function.  */
156 typedef gcry_err_code_t (*gcry_cipher_setkey_t) (void *c,
157                                                  const unsigned char *key,
158                                                  unsigned keylen);
159
160 /* Type for the cipher_encrypt function.  */
161 typedef unsigned int (*gcry_cipher_encrypt_t) (void *c,
162                                                unsigned char *outbuf,
163                                                const unsigned char *inbuf);
164
165 /* Type for the cipher_decrypt function.  */
166 typedef unsigned int (*gcry_cipher_decrypt_t) (void *c,
167                                                unsigned char *outbuf,
168                                                const unsigned char *inbuf);
169
170 /* Type for the cipher_stencrypt function.  */
171 typedef void (*gcry_cipher_stencrypt_t) (void *c,
172                                          unsigned char *outbuf,
173                                          const unsigned char *inbuf,
174                                          unsigned int n);
175
176 /* Type for the cipher_stdecrypt function.  */
177 typedef void (*gcry_cipher_stdecrypt_t) (void *c,
178                                          unsigned char *outbuf,
179                                          const unsigned char *inbuf,
180                                          unsigned int n);
181
182 /* The type used to convey additional information to a cipher.  */
183 typedef gpg_err_code_t (*cipher_set_extra_info_t)
184      (void *c, int what, const void *buffer, size_t buflen);
185
186 /* The type used to set an IV directly in the algorithm module.  */
187 typedef void (*cipher_setiv_func_t)(void *c,
188                                     const byte *iv, unsigned int ivlen);
189
190 /* A structure to map OIDs to encryption modes.  */
191 typedef struct gcry_cipher_oid_spec
192 {
193   const char *oid;
194   int mode;
195 } gcry_cipher_oid_spec_t;
196
197
198 /* Module specification structure for ciphers.  */
199 typedef struct gcry_cipher_spec
200 {
201   int algo;
202   struct {
203     unsigned int disabled:1;
204     unsigned int fips:1;
205   } flags;
206   const char *name;
207   const char **aliases;
208   gcry_cipher_oid_spec_t *oids;
209   size_t blocksize;
210   size_t keylen;
211   size_t contextsize;
212   gcry_cipher_setkey_t setkey;
213   gcry_cipher_encrypt_t encrypt;
214   gcry_cipher_decrypt_t decrypt;
215   gcry_cipher_stencrypt_t stencrypt;
216   gcry_cipher_stdecrypt_t stdecrypt;
217   selftest_func_t selftest;
218   cipher_set_extra_info_t set_extra_info;
219   cipher_setiv_func_t setiv;
220 } gcry_cipher_spec_t;
221
222
223 \f
224 /*
225  *
226  * Message digest related definitions.
227  *
228  */
229
230 /* Type for the md_init function.  */
231 typedef void (*gcry_md_init_t) (void *c);
232
233 /* Type for the md_write function.  */
234 typedef void (*gcry_md_write_t) (void *c, const void *buf, size_t nbytes);
235
236 /* Type for the md_final function.  */
237 typedef void (*gcry_md_final_t) (void *c);
238
239 /* Type for the md_read function.  */
240 typedef unsigned char *(*gcry_md_read_t) (void *c);
241
242 typedef struct gcry_md_oid_spec
243 {
244   const char *oidstring;
245 } gcry_md_oid_spec_t;
246
247 /* Module specification structure for message digests.  */
248 typedef struct gcry_md_spec
249 {
250   int algo;
251   struct {
252     unsigned int disabled:1;
253     unsigned int fips:1;
254   } flags;
255   const char *name;
256   unsigned char *asnoid;
257   int asnlen;
258   gcry_md_oid_spec_t *oids;
259   int mdlen;
260   gcry_md_init_t init;
261   gcry_md_write_t write;
262   gcry_md_final_t final;
263   gcry_md_read_t read;
264   size_t contextsize; /* allocate this amount of context */
265   selftest_func_t selftest;
266 } gcry_md_spec_t;
267
268
269 \f
270 /* The selftest functions.  */
271 gcry_error_t _gcry_cipher_selftest (int algo, int extended,
272                                     selftest_report_func_t report);
273 gcry_error_t _gcry_md_selftest (int algo, int extended,
274                                 selftest_report_func_t report);
275 gcry_error_t _gcry_pk_selftest (int algo, int extended,
276                                 selftest_report_func_t report);
277 gcry_error_t _gcry_hmac_selftest (int algo, int extended,
278                                   selftest_report_func_t report);
279
280 gcry_error_t _gcry_random_selftest (selftest_report_func_t report);
281
282
283 /*-- pubkey.c --*/
284 gcry_err_code_t _gcry_pubkey_get_sexp (gcry_sexp_t *r_sexp,
285                                        int reserved, gcry_ctx_t ctx);
286
287
288 #endif /*G10_CIPHER_PROTO_H*/