nettle-meta.h 7.43 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1
/* nettle-meta.h
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

   Information about algorithms.

   Copyright (C) 2002, 2014 Niels Möller

   This file is part of GNU Nettle.

   GNU Nettle is free software: you can redistribute it and/or
   modify it under the terms of either:

     * the GNU Lesser General Public License as published by the Free
       Software Foundation; either version 3 of the License, or (at your
       option) any later version.

   or

     * the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your
       option) any later version.

   or both in parallel, as here.

   GNU Nettle is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received copies of the GNU General Public License and
   the GNU Lesser General Public License along with this program.  If
   not, see http://www.gnu.org/licenses/.
*/
Niels Möller's avatar
Niels Möller committed
33
34
35
36

#ifndef NETTLE_META_H_INCLUDED
#define NETTLE_META_H_INCLUDED

37
#include "nettle-types.h"
Niels Möller's avatar
Niels Möller committed
38

Niels Möller's avatar
Niels Möller committed
39
40
41
42
#ifdef __cplusplus
extern "C" {
#endif

Niels Möller's avatar
Niels Möller committed
43
44
45
46
47

struct nettle_cipher
{
  const char *name;
  
48
  unsigned context_size;
Niels Möller's avatar
Niels Möller committed
49
50
  
  /* Zero for stream ciphers */
51
  unsigned block_size;
Niels Möller's avatar
Niels Möller committed
52

53
  /* Suggested key size; other sizes are sometimes possible. */
54
  unsigned key_size;
Niels Möller's avatar
Niels Möller committed
55

56
57
  nettle_set_key_func *set_encrypt_key;
  nettle_set_key_func *set_decrypt_key;
Niels Möller's avatar
Niels Möller committed
58

59
60
  nettle_cipher_func *encrypt;
  nettle_cipher_func *decrypt;
Niels Möller's avatar
Niels Möller committed
61
62
};

63
/* null-terminated list of ciphers implemented by this version of nettle */
64
const struct nettle_cipher * const * _NETTLE_ATTRIBUTE_PURE
65
66
67
nettle_get_ciphers (void);

#define nettle_ciphers (nettle_get_ciphers())
68

Niels Möller's avatar
Niels Möller committed
69
70
71
72
extern const struct nettle_cipher nettle_aes128;
extern const struct nettle_cipher nettle_aes192;
extern const struct nettle_cipher nettle_aes256;

Niels Möller's avatar
Niels Möller committed
73
74
75
76
extern const struct nettle_cipher nettle_camellia128;
extern const struct nettle_cipher nettle_camellia192;
extern const struct nettle_cipher nettle_camellia256;

Niels Möller's avatar
Niels Möller committed
77
78
79
80
81
82
83
84
85
86
extern const struct nettle_cipher nettle_cast128;

extern const struct nettle_cipher nettle_serpent128;
extern const struct nettle_cipher nettle_serpent192;
extern const struct nettle_cipher nettle_serpent256;

extern const struct nettle_cipher nettle_twofish128;
extern const struct nettle_cipher nettle_twofish192;
extern const struct nettle_cipher nettle_twofish256;

87
88
89
90
91
extern const struct nettle_cipher nettle_arctwo40;
extern const struct nettle_cipher nettle_arctwo64;
extern const struct nettle_cipher nettle_arctwo128;
extern const struct nettle_cipher nettle_arctwo_gutmann128;

Niels Möller's avatar
Niels Möller committed
92
93
94
95
96
struct nettle_hash
{
  const char *name;

  /* Size of the context struct */
97
  unsigned context_size;
Niels Möller's avatar
Niels Möller committed
98
99
100
101
102
103
104

  /* Size of digests */
  unsigned digest_size;
  
  /* Internal block size */
  unsigned block_size;

105
106
107
  nettle_hash_init_func *init;
  nettle_hash_update_func *update;
  nettle_hash_digest_func *digest;
Niels Möller's avatar
Niels Möller committed
108
109
110
111
112
113
};

#define _NETTLE_HASH(name, NAME) {		\
 #name,						\
 sizeof(struct name##_ctx),			\
 NAME##_DIGEST_SIZE,				\
114
 NAME##_BLOCK_SIZE,				\
115
116
117
 (nettle_hash_init_func *) name##_init,		\
 (nettle_hash_update_func *) name##_update,	\
 (nettle_hash_digest_func *) name##_digest	\
Niels Möller's avatar
Niels Möller committed
118
119
} 

120
/* null-terminated list of digests implemented by this version of nettle */
121
const struct nettle_hash * const * _NETTLE_ATTRIBUTE_PURE
122
123
124
125
126
127
nettle_get_hashes (void);

#define nettle_hashes (nettle_get_hashes())

const struct nettle_hash *
nettle_lookup_hash (const char *name);
128

129
130
extern const struct nettle_hash nettle_md2;
extern const struct nettle_hash nettle_md4;
Niels Möller's avatar
Niels Möller committed
131
extern const struct nettle_hash nettle_md5;
132
extern const struct nettle_hash nettle_gosthash94;
133
extern const struct nettle_hash nettle_gosthash94cp;
134
extern const struct nettle_hash nettle_ripemd160;
Niels Möller's avatar
Niels Möller committed
135
extern const struct nettle_hash nettle_sha1;
Niels Möller's avatar
Niels Möller committed
136
extern const struct nettle_hash nettle_sha224;
Niels Möller's avatar
Niels Möller committed
137
extern const struct nettle_hash nettle_sha256;
138
extern const struct nettle_hash nettle_sha384;
139
extern const struct nettle_hash nettle_sha512;
140
141
extern const struct nettle_hash nettle_sha512_224;
extern const struct nettle_hash nettle_sha512_256;
142
extern const struct nettle_hash nettle_sha3_224;
Niels Möller's avatar
Niels Möller committed
143
extern const struct nettle_hash nettle_sha3_256;
144
145
extern const struct nettle_hash nettle_sha3_384;
extern const struct nettle_hash nettle_sha3_512;
Niels Möller's avatar
Niels Möller committed
146

147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
struct nettle_aead
{
  const char *name;
  
  unsigned context_size;
  /* Block size for encrypt and decrypt. */
  unsigned block_size;
  unsigned key_size;
  unsigned nonce_size;
  unsigned digest_size;

  nettle_set_key_func *set_encrypt_key;
  nettle_set_key_func *set_decrypt_key;
  nettle_set_key_func *set_nonce;
  nettle_hash_update_func *update;
  nettle_crypt_func *encrypt;
  nettle_crypt_func *decrypt;
  /* FIXME: Drop length argument? */
  nettle_hash_digest_func *digest;
};

168
169
/* null-terminated list of aead constructions implemented by this
   version of nettle */
170
const struct nettle_aead * const * _NETTLE_ATTRIBUTE_PURE
Niels Möller's avatar
Niels Möller committed
171
172
173
nettle_get_aeads (void);

#define nettle_aeads (nettle_get_aeads())
174

175
176
177
extern const struct nettle_aead nettle_gcm_aes128;
extern const struct nettle_aead nettle_gcm_aes192;
extern const struct nettle_aead nettle_gcm_aes256;
Niels Möller's avatar
Niels Möller committed
178
extern const struct nettle_aead nettle_gcm_camellia128;
Niels Möller's avatar
Niels Möller committed
179
extern const struct nettle_aead nettle_gcm_camellia256;
180
extern const struct nettle_aead nettle_eax_aes128;
Niels Möller's avatar
Niels Möller committed
181
extern const struct nettle_aead nettle_chacha_poly1305;
182

183
184
185
struct nettle_armor
{
  const char *name;
186
187
188
189
190
  unsigned encode_context_size;
  unsigned decode_context_size;

  unsigned encode_final_length;

191
192
193
194
  nettle_armor_init_func *encode_init;
  nettle_armor_length_func *encode_length;
  nettle_armor_encode_update_func *encode_update;
  nettle_armor_encode_final_func *encode_final;
195
  
196
197
198
199
  nettle_armor_init_func *decode_init;
  nettle_armor_length_func *decode_length;
  nettle_armor_decode_update_func *decode_update;
  nettle_armor_decode_final_func *decode_final;
200
201
};

202
203
204
205
206
#define _NETTLE_ARMOR(name, NAME) {				\
  #name,							\
  sizeof(struct name##_encode_ctx),				\
  sizeof(struct name##_decode_ctx),				\
  NAME##_ENCODE_FINAL_LENGTH,					\
207
208
209
210
211
212
213
214
  (nettle_armor_init_func *) name##_encode_init,		\
  (nettle_armor_length_func *) name##_encode_length,		\
  (nettle_armor_encode_update_func *) name##_encode_update,	\
  (nettle_armor_encode_final_func *) name##_encode_final,	\
  (nettle_armor_init_func *) name##_decode_init,		\
  (nettle_armor_length_func *) name##_decode_length,		\
  (nettle_armor_decode_update_func *) name##_decode_update,	\
  (nettle_armor_decode_final_func *) name##_decode_final,	\
215
216
}

217
218
219
220
221
#define _NETTLE_ARMOR_0(name, NAME) {				\
  #name,							\
  0,								\
  sizeof(struct name##_decode_ctx),				\
  NAME##_ENCODE_FINAL_LENGTH,					\
222
223
224
225
226
227
228
229
  (nettle_armor_init_func *) name##_encode_init,		\
  (nettle_armor_length_func *) name##_encode_length,		\
  (nettle_armor_encode_update_func *) name##_encode_update,	\
  (nettle_armor_encode_final_func *) name##_encode_final,	\
  (nettle_armor_init_func *) name##_decode_init,		\
  (nettle_armor_length_func *) name##_decode_length,		\
  (nettle_armor_decode_update_func *) name##_decode_update,	\
  (nettle_armor_decode_final_func *) name##_decode_final,	\
230
231
}

232
/* null-terminated list of armor schemes implemented by this version of nettle */
233
const struct nettle_armor * const * _NETTLE_ATTRIBUTE_PURE
234
235
236
nettle_get_armors (void);

#define nettle_armors (nettle_get_armors())
237

238
extern const struct nettle_armor nettle_base64;
239
extern const struct nettle_armor nettle_base64url;
240
extern const struct nettle_armor nettle_base16;
241

Niels Möller's avatar
Niels Möller committed
242
243
244
245
#ifdef __cplusplus
}
#endif

Niels Möller's avatar
Niels Möller committed
246
#endif /* NETTLE_META_H_INCLUDED */