31bf6ba370343edc812e66d0d2950e0ea7e150ef
[libgcrypt.git] / src / cipher-proto.h
1 /* cipher-proto.h - Internal declarations
2  *      Copyright (C) 2008 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
51 /* The type used to compute the keygrip.  */
52 typedef gpg_err_code_t (*pk_comp_keygrip_t)
53      (gcry_md_hd_t md, gcry_sexp_t keyparm);
54
55 /* The type used to quert ECC curve parameters.  */
56 typedef gcry_err_code_t (*pk_get_param_t)
57      (const char *name, gcry_mpi_t *pkey);
58
59 /* The type used to convey additional information to a cipher.  */
60 typedef gpg_err_code_t (*cipher_set_extra_info_t)
61      (void *c, int what, const void *buffer, size_t buflen);
62
63
64 /* Extra module specification structures.  These are used for internal
65    modules which provide more functions than available through the
66    public algorithm register APIs.  */
67 typedef struct cipher_extra_spec
68 {
69   selftest_func_t selftest;
70   cipher_set_extra_info_t set_extra_info;
71 } cipher_extra_spec_t;
72
73 typedef struct md_extra_spec
74 {
75   selftest_func_t selftest;
76 } md_extra_spec_t;
77
78 typedef struct pk_extra_spec
79 {
80   selftest_func_t selftest;
81   pk_ext_generate_t ext_generate;
82   pk_comp_keygrip_t comp_keygrip;
83   pk_get_param_t get_param;
84 } pk_extra_spec_t;
85
86
87
88 /* The private register functions. */
89 gcry_error_t _gcry_cipher_register (gcry_cipher_spec_t *cipher,
90                                     cipher_extra_spec_t *extraspec,
91                                     int *algorithm_id,
92                                     gcry_module_t *module);
93 gcry_error_t _gcry_md_register (gcry_md_spec_t *cipher,
94                                 md_extra_spec_t *extraspec,
95                                 unsigned int *algorithm_id,
96                                 gcry_module_t *module);
97 gcry_error_t _gcry_pk_register (gcry_pk_spec_t *cipher,
98                                 pk_extra_spec_t *extraspec,
99                                 unsigned int *algorithm_id,
100                                 gcry_module_t *module);
101
102 /* The selftest functions.  */
103 gcry_error_t _gcry_cipher_selftest (int algo, int extended, 
104                                     selftest_report_func_t report);
105 gcry_error_t _gcry_md_selftest (int algo, int extended,
106                                 selftest_report_func_t report);
107 gcry_error_t _gcry_pk_selftest (int algo, int extended,
108                                 selftest_report_func_t report);
109 gcry_error_t _gcry_hmac_selftest (int algo, int extended,
110                                   selftest_report_func_t report);
111
112 gcry_error_t _gcry_random_selftest (selftest_report_func_t report);
113
114 #endif /*G10_CIPHER_PROTO_H*/