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