nettle-meta.h 7.02 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1
2
3
4
5
6
7
/* nettle-meta.h
 *
 * Information about algorithms.
 */

/* nettle, low-level cryptographics library
 *
Niels Möller's avatar
Niels Möller committed
8
 * Copyright (C) 2002 Niels Möller
Niels Möller's avatar
Niels Möller committed
9
10
11
12
13
14
15
16
17
18
19
20
21
 *  
 * The nettle library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 * 
 * The nettle library 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 Lesser General Public
 * License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with the nettle library; see the file COPYING.LIB.  If not, write to
22
23
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02111-1301, USA.
Niels Möller's avatar
Niels Möller committed
24
25
26
27
28
 */

#ifndef NETTLE_META_H_INCLUDED
#define NETTLE_META_H_INCLUDED

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

Niels Möller's avatar
Niels Möller committed
31
32
33
34
#ifdef __cplusplus
extern "C" {
#endif

Niels Möller's avatar
Niels Möller committed
35
36
37
38
39
40
41
42
43
44

struct nettle_cipher
{
  const char *name;
  
  unsigned context_size;
  
  /* Zero for stream ciphers */
  unsigned block_size;

45
  /* Suggested key size; other sizes are sometimes possible. */
Niels Möller's avatar
Niels Möller committed
46
47
  unsigned key_size;

48
49
  nettle_set_key_func *set_encrypt_key;
  nettle_set_key_func *set_decrypt_key;
Niels Möller's avatar
Niels Möller committed
50

51
52
  nettle_crypt_func *encrypt;
  nettle_crypt_func *decrypt;
Niels Möller's avatar
Niels Möller committed
53
54
};

Niels Möller's avatar
Niels Möller committed
55
56
#define _NETTLE_CIPHER(name, NAME, key_size) {	\
  #name #key_size,				\
Niels Möller's avatar
Niels Möller committed
57
58
  sizeof(struct name##_ctx),			\
  NAME##_BLOCK_SIZE,				\
Niels Möller's avatar
Niels Möller committed
59
  key_size / 8,					\
60
61
62
63
  (nettle_set_key_func *) name##_set_key,	\
  (nettle_set_key_func *) name##_set_key,	\
  (nettle_crypt_func *) name##_encrypt,		\
  (nettle_crypt_func *) name##_decrypt,		\
64
65
}

Niels Möller's avatar
Niels Möller committed
66
67
#define _NETTLE_CIPHER_SEP(name, NAME, key_size) {	\
  #name #key_size,					\
68
69
  sizeof(struct name##_ctx),				\
  NAME##_BLOCK_SIZE,					\
Niels Möller's avatar
Niels Möller committed
70
  key_size / 8,						\
71
72
73
74
  (nettle_set_key_func *) name##_set_encrypt_key,	\
  (nettle_set_key_func *) name##_set_decrypt_key,	\
  (nettle_crypt_func *) name##_encrypt,			\
  (nettle_crypt_func *) name##_decrypt,			\
Niels Möller's avatar
Niels Möller committed
75
}
76

Niels Möller's avatar
Niels Möller committed
77
78
#define _NETTLE_CIPHER_SEP_SET_KEY(name, NAME, key_size) {\
  #name #key_size,					\
79
80
  sizeof(struct name##_ctx),				\
  NAME##_BLOCK_SIZE,					\
Niels Möller's avatar
Niels Möller committed
81
  key_size / 8,						\
82
83
84
85
86
87
  (nettle_set_key_func *) name##_set_encrypt_key,	\
  (nettle_set_key_func *) name##_set_decrypt_key,	\
  (nettle_crypt_func *) name##_crypt,			\
  (nettle_crypt_func *) name##_crypt,			\
}

88
#define _NETTLE_CIPHER_FIX(name, NAME) {	\
89
90
91
  #name,						\
  sizeof(struct name##_ctx),				\
  NAME##_BLOCK_SIZE,					\
92
  NAME##_KEY_SIZE,					\
93
94
95
96
  (nettle_set_key_func *) name##_set_key,		\
  (nettle_set_key_func *) name##_set_key,		\
  (nettle_crypt_func *) name##_encrypt,			\
  (nettle_crypt_func *) name##_decrypt,			\
97
98
}

99
100
101
/* 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
102
103
104
105
106
extern const struct nettle_cipher nettle_aes128;
extern const struct nettle_cipher nettle_aes192;
extern const struct nettle_cipher nettle_aes256;

extern const struct nettle_cipher nettle_arcfour128;
Niels Möller's avatar
Niels Möller committed
107
108
109
110
111

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
112
113
114
115
116
117
118
119
120
121
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;

122
123
124
125
126
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
127
128
129
130
131
struct nettle_hash
{
  const char *name;

  /* Size of the context struct */
132
  unsigned context_size;
Niels Möller's avatar
Niels Möller committed
133
134
135
136
137
138
139

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

140
141
142
  nettle_hash_init_func *init;
  nettle_hash_update_func *update;
  nettle_hash_digest_func *digest;
Niels Möller's avatar
Niels Möller committed
143
144
145
146
147
148
149
};

#define _NETTLE_HASH(name, NAME) {		\
 #name,						\
 sizeof(struct name##_ctx),			\
 NAME##_DIGEST_SIZE,				\
 NAME##_DATA_SIZE,				\
150
151
152
 (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
153
154
} 

155
156
157
/* null-terminated list of digests implemented by this version of nettle */
extern const struct nettle_hash * const nettle_hashes[];

158
159
extern const struct nettle_hash nettle_md2;
extern const struct nettle_hash nettle_md4;
Niels Möller's avatar
Niels Möller committed
160
extern const struct nettle_hash nettle_md5;
161
extern const struct nettle_hash nettle_gosthash94;
162
extern const struct nettle_hash nettle_ripemd160;
Niels Möller's avatar
Niels Möller committed
163
extern const struct nettle_hash nettle_sha1;
Niels Möller's avatar
Niels Möller committed
164
extern const struct nettle_hash nettle_sha224;
Niels Möller's avatar
Niels Möller committed
165
extern const struct nettle_hash nettle_sha256;
166
extern const struct nettle_hash nettle_sha384;
167
extern const struct nettle_hash nettle_sha512;
Niels Möller's avatar
Niels Möller committed
168
extern const struct nettle_hash nettle_sha3_256;
Niels Möller's avatar
Niels Möller committed
169

170
171
172
struct nettle_armor
{
  const char *name;
173
174
175
176
177
  unsigned encode_context_size;
  unsigned decode_context_size;

  unsigned encode_final_length;

178
179
180
181
  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;
182
  
183
184
185
186
  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;
187
188
};

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

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

219
220
221
/* null-terminated list of armor schemes implemented by this version of nettle */
extern const struct nettle_armor * const nettle_armors[];

222
extern const struct nettle_armor nettle_base64;
223
extern const struct nettle_armor nettle_base16;
224

Niels Möller's avatar
Niels Möller committed
225
226
227
228
#ifdef __cplusplus
}
#endif

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