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