nettle-meta.h 6.83 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
64
65
/* null-terminated list of ciphers implemented by this version of nettle */
extern const struct nettle_cipher * const nettle_ciphers[];

Niels Möller's avatar
Niels Möller committed
66
67
68
69
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
70
71
72
73
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
74
75
76
77
78
79
80
81
82
83
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;

84
85
86
87
88
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
89
90
91
92
93
struct nettle_hash
{
  const char *name;

  /* Size of the context struct */
94
  unsigned context_size;
Niels Möller's avatar
Niels Möller committed
95
96
97
98
99
100
101

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

102
103
104
  nettle_hash_init_func *init;
  nettle_hash_update_func *update;
  nettle_hash_digest_func *digest;
Niels Möller's avatar
Niels Möller committed
105
106
107
108
109
110
};

#define _NETTLE_HASH(name, NAME) {		\
 #name,						\
 sizeof(struct name##_ctx),			\
 NAME##_DIGEST_SIZE,				\
111
 NAME##_BLOCK_SIZE,				\
112
113
114
 (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
115
116
} 

117
118
119
/* null-terminated list of digests implemented by this version of nettle */
extern const struct nettle_hash * const nettle_hashes[];

120
121
extern const struct nettle_hash nettle_md2;
extern const struct nettle_hash nettle_md4;
Niels Möller's avatar
Niels Möller committed
122
extern const struct nettle_hash nettle_md5;
123
extern const struct nettle_hash nettle_gosthash94;
124
extern const struct nettle_hash nettle_ripemd160;
Niels Möller's avatar
Niels Möller committed
125
extern const struct nettle_hash nettle_sha1;
Niels Möller's avatar
Niels Möller committed
126
extern const struct nettle_hash nettle_sha224;
Niels Möller's avatar
Niels Möller committed
127
extern const struct nettle_hash nettle_sha256;
128
extern const struct nettle_hash nettle_sha384;
129
extern const struct nettle_hash nettle_sha512;
130
131
extern const struct nettle_hash nettle_sha512_224;
extern const struct nettle_hash nettle_sha512_256;
132
extern const struct nettle_hash nettle_sha3_224;
Niels Möller's avatar
Niels Möller committed
133
extern const struct nettle_hash nettle_sha3_256;
134
135
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
136

137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
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;
};

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
161
extern const struct nettle_aead nettle_gcm_camellia128;
Niels Möller's avatar
Niels Möller committed
162
extern const struct nettle_aead nettle_gcm_camellia256;
163
extern const struct nettle_aead nettle_eax_aes128;
Niels Möller's avatar
Niels Möller committed
164
extern const struct nettle_aead nettle_chacha_poly1305;
165

166
167
168
struct nettle_armor
{
  const char *name;
169
170
171
172
173
  unsigned encode_context_size;
  unsigned decode_context_size;

  unsigned encode_final_length;

174
175
176
177
  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;
178
  
179
180
181
182
  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;
183
184
};

185
186
187
188
189
#define _NETTLE_ARMOR(name, NAME) {				\
  #name,							\
  sizeof(struct name##_encode_ctx),				\
  sizeof(struct name##_decode_ctx),				\
  NAME##_ENCODE_FINAL_LENGTH,					\
190
191
192
193
194
195
196
197
  (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,	\
198
199
}

200
201
202
203
204
#define _NETTLE_ARMOR_0(name, NAME) {				\
  #name,							\
  0,								\
  sizeof(struct name##_decode_ctx),				\
  NAME##_ENCODE_FINAL_LENGTH,					\
205
206
207
208
209
210
211
212
  (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,	\
213
214
}

215
216
217
/* null-terminated list of armor schemes implemented by this version of nettle */
extern const struct nettle_armor * const nettle_armors[];

218
extern const struct nettle_armor nettle_base64;
219
extern const struct nettle_armor nettle_base16;
220

Niels Möller's avatar
Niels Möller committed
221
222
223
224
#ifdef __cplusplus
}
#endif

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