Add support for Salsa20.
[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 /* Definition of a function used to report selftest failures.
27    DOMAIN is a string describing the function block:
28           "cipher", "digest", "pubkey or "random",
29    ALGO   is the algorithm under test,
30    WHAT   is a string describing what has been tested,
31    DESC   is a string describing the error. */
32 typedef void (*selftest_report_func_t)(const char *domain,
33                                        int algo,
34                                        const char *what,
35                                        const char *errdesc);
36
37 /* Definition of the selftest functions.  */
38 typedef gpg_err_code_t (*selftest_func_t)
39      (int algo, int extended, selftest_report_func_t report);
40
41
42 /* An extended type of the generate function.  */
43 typedef gcry_err_code_t (*pk_ext_generate_t)
44      (int algo,
45       unsigned int nbits,
46       unsigned long evalue,
47       gcry_sexp_t genparms,
48       gcry_mpi_t *skey,
49       gcry_mpi_t **retfactors,
50       gcry_sexp_t *extrainfo);
51
52 /* The type used to compute the keygrip.  */
53 typedef gpg_err_code_t (*pk_comp_keygrip_t)
54      (gcry_md_hd_t md, gcry_sexp_t keyparm);
55
56 /* The type used to query ECC curve parameters.  */
57 typedef gcry_err_code_t (*pk_get_param_t)
58      (const char *name, gcry_mpi_t *pkey);
59
60 /* The type used to query an ECC curve name.  */
61 typedef const char *(*pk_get_curve_t)(gcry_mpi_t *pkey, int iterator,
62                                       unsigned int *r_nbits);
63
64 /* The type used to query ECC curve parameters by name.  */
65 typedef gcry_sexp_t (*pk_get_curve_param_t)(const char *name);
66
67 /* The type used to convey additional information to a cipher.  */
68 typedef gpg_err_code_t (*cipher_set_extra_info_t)
69      (void *c, int what, const void *buffer, size_t buflen);
70
71 /* The type used to set an IV directly in the algorithm module.  */
72 typedef void (*cipher_setiv_func_t)(void *c,
73                                     const byte *iv, unsigned int ivlen);
74
75 /* Extra module specification structures.  These are used for internal
76    modules which provide more functions than available through the
77    public algorithm register APIs.  */
78 typedef struct cipher_extra_spec
79 {
80   selftest_func_t selftest;
81   cipher_set_extra_info_t set_extra_info;
82   cipher_setiv_func_t setiv;
83 } cipher_extra_spec_t;
84
85 typedef struct md_extra_spec
86 {
87   selftest_func_t selftest;
88 } md_extra_spec_t;
89
90 typedef struct pk_extra_spec
91 {
92   selftest_func_t selftest;
93   pk_ext_generate_t ext_generate;
94   pk_comp_keygrip_t comp_keygrip;
95   pk_get_param_t get_param;
96   pk_get_curve_t get_curve;
97   pk_get_curve_param_t get_curve_param;
98 } pk_extra_spec_t;
99
100
101
102 /* The private register functions. */
103 gcry_error_t _gcry_cipher_register (gcry_cipher_spec_t *cipher,
104                                     cipher_extra_spec_t *extraspec,
105                                     int *algorithm_id,
106                                     gcry_module_t *module);
107 gcry_error_t _gcry_md_register (gcry_md_spec_t *cipher,
108                                 md_extra_spec_t *extraspec,
109                                 unsigned int *algorithm_id,
110                                 gcry_module_t *module);
111 gcry_error_t _gcry_pk_register (gcry_pk_spec_t *cipher,
112                                 pk_extra_spec_t *extraspec,
113                                 unsigned int *algorithm_id,
114                                 gcry_module_t *module);
115
116 /* The selftest functions.  */
117 gcry_error_t _gcry_cipher_selftest (int algo, int extended,
118                                     selftest_report_func_t report);
119 gcry_error_t _gcry_md_selftest (int algo, int extended,
120                                 selftest_report_func_t report);
121 gcry_error_t _gcry_pk_selftest (int algo, int extended,
122                                 selftest_report_func_t report);
123 gcry_error_t _gcry_hmac_selftest (int algo, int extended,
124                                   selftest_report_func_t report);
125
126 gcry_error_t _gcry_random_selftest (selftest_report_func_t report);
127
128
129 /*-- pubkey.c --*/
130 gcry_err_code_t _gcry_pubkey_get_sexp (gcry_sexp_t *r_sexp,
131                                        int reserved, gcry_ctx_t ctx);
132
133
134 #endif /*G10_CIPHER_PROTO_H*/