validate args before use
[heimdal.git] / lib / hcrypto / evp.h
blob03ec175d5976784eaa7774d76bf9b5d8b221f308
1 /*
2 * Copyright (c) 2005 - 2008 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the Institute nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
34 /* $Id$ */
36 #ifndef HEIM_EVP_H
37 #define HEIM_EVP_H 1
39 #include <hcrypto/engine.h>
41 /* symbol renaming */
42 #define EVP_CIPHER_CTX_block_size hc_EVP_CIPHER_CTX_block_size
43 #define EVP_CIPHER_CTX_cipher hc_EVP_CIPHER_CTX_cipher
44 #define EVP_CIPHER_CTX_cleanup hc_EVP_CIPHER_CTX_cleanup
45 #define EVP_CIPHER_CTX_flags hc_EVP_CIPHER_CTX_flags
46 #define EVP_CIPHER_CTX_get_app_data hc_EVP_CIPHER_CTX_get_app_data
47 #define EVP_CIPHER_CTX_init hc_EVP_CIPHER_CTX_init
48 #define EVP_CIPHER_CTX_iv_length hc_EVP_CIPHER_CTX_iv_length
49 #define EVP_CIPHER_CTX_key_length hc_EVP_CIPHER_CTX_key_length
50 #define EVP_CIPHER_CTX_mode hc_EVP_CIPHER_CTX_mode
51 #define EVP_CIPHER_CTX_set_app_data hc_EVP_CIPHER_CTX_set_app_data
52 #define EVP_CIPHER_CTX_set_key_length hc_EVP_CIPHER_CTX_set_key_length
53 #define EVP_CIPHER_CTX_set_padding hc_EVP_CIPHER_CTX_set_padding
54 #define EVP_CIPHER_block_size hc_EVP_CIPHER_block_size
55 #define EVP_CIPHER_iv_length hc_EVP_CIPHER_iv_length
56 #define EVP_CIPHER_key_length hc_EVP_CIPHER_key_length
57 #define EVP_Cipher hc_EVP_Cipher
58 #define EVP_CipherInit_ex hc_EVP_CipherInit_ex
59 #define EVP_CipherUpdate hc_EVP_CipherUpdate
60 #define EVP_CipherFinal_ex hc_EVP_CipherFinal_ex
61 #define EVP_Digest hc_EVP_Digest
62 #define EVP_DigestFinal_ex hc_EVP_DigestFinal_ex
63 #define EVP_DigestInit_ex hc_EVP_DigestInit_ex
64 #define EVP_DigestUpdate hc_EVP_DigestUpdate
65 #define EVP_MD_CTX_block_size hc_EVP_MD_CTX_block_size
66 #define EVP_MD_CTX_cleanup hc_EVP_MD_CTX_cleanup
67 #define EVP_MD_CTX_create hc_EVP_MD_CTX_create
68 #define EVP_MD_CTX_init hc_EVP_MD_CTX_init
69 #define EVP_MD_CTX_destroy hc_EVP_MD_CTX_destroy
70 #define EVP_MD_CTX_md hc_EVP_MD_CTX_md
71 #define EVP_MD_CTX_size hc_EVP_MD_CTX_size
72 #define EVP_MD_block_size hc_EVP_MD_block_size
73 #define EVP_MD_size hc_EVP_MD_size
74 #define EVP_aes_128_cbc hc_EVP_aes_128_cbc
75 #define EVP_aes_192_cbc hc_EVP_aes_192_cbc
76 #define EVP_aes_256_cbc hc_EVP_aes_256_cbc
77 #define EVP_aes_128_cfb8 hc_EVP_aes_128_cfb8
78 #define EVP_aes_192_cfb8 hc_EVP_aes_192_cfb8
79 #define EVP_aes_256_cfb8 hc_EVP_aes_256_cfb8
81 #define EVP_des_cbc hc_EVP_des_cbc
82 #define EVP_des_ede3_cbc hc_EVP_des_ede3_cbc
83 #define EVP_enc_null hc_EVP_enc_null
84 #define EVP_md2 hc_EVP_md2
85 #define EVP_md4 hc_EVP_md4
86 #define EVP_md5 hc_EVP_md5
87 #define EVP_md_null hc_EVP_md_null
88 #define EVP_rc2_40_cbc hc_EVP_rc2_40_cbc
89 #define EVP_rc2_64_cbc hc_EVP_rc2_64_cbc
90 #define EVP_rc2_cbc hc_EVP_rc2_cbc
91 #define EVP_rc4 hc_EVP_rc4
92 #define EVP_rc4_40 hc_EVP_rc4_40
93 #define EVP_camellia_128_cbc hc_EVP_camellia_128_cbc
94 #define EVP_camellia_192_cbc hc_EVP_camellia_192_cbc
95 #define EVP_camellia_256_cbc hc_EVP_camellia_256_cbc
96 #define EVP_sha hc_EVP_sha
97 #define EVP_sha1 hc_EVP_sha1
98 #define EVP_sha256 hc_EVP_sha256
99 #define PKCS5_PBKDF2_HMAC_SHA1 hc_PKCS5_PBKDF2_HMAC_SHA1
100 #define EVP_BytesToKey hc_EVP_BytesToKey
101 #define EVP_get_cipherbyname hc_EVP_get_cipherbyname
102 #define OpenSSL_add_all_algorithms hc_OpenSSL_add_all_algorithms
103 #define OpenSSL_add_all_algorithms_conf hc_OpenSSL_add_all_algorithms_conf
104 #define OpenSSL_add_all_algorithms_noconf hc_OpenSSL_add_all_algorithms_noconf
105 #define EVP_CIPHER_CTX_ctrl hc_EVP_CIPHER_CTX_ctrl
106 #define EVP_CIPHER_CTX_rand_key hc_EVP_CIPHER_CTX_rand_key
107 #define hcrypto_validate hc_hcrypto_validate
113 typedef struct hc_EVP_MD_CTX EVP_MD_CTX;
114 typedef struct hc_evp_pkey EVP_PKEY;
115 typedef struct hc_evp_md EVP_MD;
116 typedef struct hc_CIPHER EVP_CIPHER;
117 typedef struct hc_CIPHER_CTX EVP_CIPHER_CTX;
119 #define EVP_MAX_IV_LENGTH 16
120 #define EVP_MAX_BLOCK_LENGTH 32
122 #define EVP_MAX_MD_SIZE 64
124 struct hc_CIPHER {
125 int nid;
126 int block_size;
127 int key_len;
128 int iv_len;
129 unsigned long flags;
130 /* The lowest 3 bits is used as integer field for the mode the
131 * cipher is used in (use EVP_CIPHER.._mode() to extract the
132 * mode). The rest of the flag field is a bitfield.
134 #define EVP_CIPH_STREAM_CIPHER 0
135 #define EVP_CIPH_CBC_MODE 2
136 #define EVP_CIPH_CFB8_MODE 4
137 #define EVP_CIPH_MODE 0x7
139 #define EVP_CIPH_VARIABLE_LENGTH 0x008 /* variable key length */
140 #define EVP_CIPH_ALWAYS_CALL_INIT 0x020
141 #define EVP_CIPH_RAND_KEY 0x200
143 int (*init)(EVP_CIPHER_CTX*,const unsigned char*,const unsigned char*,int);
144 int (*do_cipher)(EVP_CIPHER_CTX *, unsigned char *,
145 const unsigned char *, unsigned int);
146 int (*cleanup)(EVP_CIPHER_CTX *);
147 int ctx_size;
148 void *set_asn1_parameters;
149 void *get_asn1_parameters;
150 int (*ctrl)(EVP_CIPHER_CTX *, int type, int arg, void *ptr);
151 #define EVP_CTRL_RAND_KEY 0x6
153 void *app_data;
156 struct hc_CIPHER_CTX {
157 const EVP_CIPHER *cipher;
158 ENGINE *engine;
159 int encrypt;
160 int buf_len; /* bytes stored in buf for EVP_CipherUpdate */
161 unsigned char oiv[EVP_MAX_IV_LENGTH];
162 unsigned char iv[EVP_MAX_IV_LENGTH];
163 unsigned char buf[EVP_MAX_BLOCK_LENGTH];
164 int num;
165 void *app_data;
166 int key_len;
167 unsigned long flags;
168 void *cipher_data;
169 int final_used;
170 int block_mask;
171 unsigned char final[EVP_MAX_BLOCK_LENGTH];
174 typedef int (*hc_evp_md_init)(EVP_MD_CTX *);
175 typedef int (*hc_evp_md_update)(EVP_MD_CTX *,const void *, size_t);
176 typedef int (*hc_evp_md_final)(void *, EVP_MD_CTX *);
177 typedef int (*hc_evp_md_cleanup)(EVP_MD_CTX *);
179 struct hc_evp_md {
180 int hash_size;
181 int block_size;
182 int ctx_size;
183 hc_evp_md_init init;
184 hc_evp_md_update update;
185 hc_evp_md_final final;
186 hc_evp_md_cleanup cleanup;
189 #if !defined(__GNUC__) && !defined(__attribute__)
190 #define __attribute__(x)
191 #endif
193 #ifndef HC_DEPRECATED
194 #if defined(__GNUC__) && ((__GNUC__ > 3) || ((__GNUC__ == 3) && (__GNUC_MINOR__ >= 1 )))
195 #define HC_DEPRECATED __attribute__((deprecated))
196 #elif defined(_MSC_VER) && (_MSC_VER>1200)
197 #define HC_DEPRECATED __declspec(deprecated)
198 #else
199 #define HC_DEPRECATED
200 #endif
201 #endif
203 #ifndef HC_DEPRECATED_CRYPTO
204 #define HC_DEPRECATED_CRYPTO HC_DEPRECATED
205 #endif
207 #ifdef __cplusplus
208 #define HC_CPP_BEGIN extern "C" {
209 #define HC_CPP_END }
210 #else
211 #define HC_CPP_BEGIN
212 #define HC_CPP_END
213 #endif
215 HC_CPP_BEGIN
218 * Avaible crypto algs
221 const EVP_MD *EVP_md_null(void);
222 HC_DEPRECATED_CRYPTO const EVP_MD *EVP_md2(void);
223 HC_DEPRECATED_CRYPTO const EVP_MD *EVP_md4(void);
224 HC_DEPRECATED_CRYPTO const EVP_MD *EVP_md5(void);
225 const EVP_MD *EVP_sha(void);
226 const EVP_MD *EVP_sha1(void);
227 const EVP_MD *EVP_sha256(void);
229 const EVP_CIPHER * EVP_aes_128_cbc(void);
230 const EVP_CIPHER * EVP_aes_192_cbc(void);
231 const EVP_CIPHER * EVP_aes_256_cbc(void);
232 const EVP_CIPHER * EVP_aes_128_cfb8(void);
233 const EVP_CIPHER * EVP_aes_192_cfb8(void);
234 const EVP_CIPHER * EVP_aes_256_cfb8(void);
235 HC_DEPRECATED_CRYPTO const EVP_CIPHER * EVP_des_cbc(void);
236 const EVP_CIPHER * EVP_des_ede3_cbc(void);
237 const EVP_CIPHER * EVP_enc_null(void);
238 HC_DEPRECATED_CRYPTO const EVP_CIPHER * EVP_rc2_40_cbc(void);
239 HC_DEPRECATED_CRYPTO const EVP_CIPHER * EVP_rc2_64_cbc(void);
240 HC_DEPRECATED_CRYPTO const EVP_CIPHER * EVP_rc2_cbc(void);
241 const EVP_CIPHER * EVP_rc4(void);
242 HC_DEPRECATED_CRYPTO const EVP_CIPHER * EVP_rc4_40(void);
243 const EVP_CIPHER * EVP_camellia_128_cbc(void);
244 const EVP_CIPHER * EVP_camellia_192_cbc(void);
245 const EVP_CIPHER * EVP_camellia_256_cbc(void);
247 size_t EVP_MD_size(const EVP_MD *);
248 size_t EVP_MD_block_size(const EVP_MD *);
250 const EVP_MD *
251 EVP_MD_CTX_md(EVP_MD_CTX *);
252 size_t EVP_MD_CTX_size(EVP_MD_CTX *);
253 size_t EVP_MD_CTX_block_size(EVP_MD_CTX *);
255 EVP_MD_CTX *
256 EVP_MD_CTX_create(void);
257 void HC_DEPRECATED EVP_MD_CTX_init(EVP_MD_CTX *);
258 void EVP_MD_CTX_destroy(EVP_MD_CTX *);
259 int HC_DEPRECATED EVP_MD_CTX_cleanup(EVP_MD_CTX *);
261 int EVP_DigestInit_ex(EVP_MD_CTX *, const EVP_MD *, ENGINE *);
262 int EVP_DigestUpdate(EVP_MD_CTX *,const void *, size_t);
263 int EVP_DigestFinal_ex(EVP_MD_CTX *, void *, unsigned int *);
264 int EVP_Digest(const void *, size_t, void *, unsigned int *,
265 const EVP_MD *, ENGINE *);
270 const EVP_CIPHER *
271 EVP_get_cipherbyname(const char *);
273 size_t EVP_CIPHER_block_size(const EVP_CIPHER *);
274 size_t EVP_CIPHER_key_length(const EVP_CIPHER *);
275 size_t EVP_CIPHER_iv_length(const EVP_CIPHER *);
277 void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *);
278 int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *);
279 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *, int);
280 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *, int);
281 unsigned long
282 EVP_CIPHER_CTX_flags(const EVP_CIPHER_CTX *);
283 int EVP_CIPHER_CTX_mode(const EVP_CIPHER_CTX *);
285 const EVP_CIPHER *
286 EVP_CIPHER_CTX_cipher(EVP_CIPHER_CTX *);
287 size_t EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *);
288 size_t EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *);
289 size_t EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *);
290 void * EVP_CIPHER_CTX_get_app_data(EVP_CIPHER_CTX *);
291 void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX *, void *);
293 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *, int, int, void *);
294 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *, void *);
297 int EVP_CipherInit_ex(EVP_CIPHER_CTX *,const EVP_CIPHER *, ENGINE *,
298 const void *, const void *, int);
299 int EVP_CipherUpdate(EVP_CIPHER_CTX *, void *, int *, void *, size_t);
300 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *, void *, int *);
302 int EVP_Cipher(EVP_CIPHER_CTX *,void *,const void *,size_t);
304 int PKCS5_PBKDF2_HMAC_SHA1(const void *, size_t, const void *, size_t,
305 unsigned long, size_t, void *);
307 int EVP_BytesToKey(const EVP_CIPHER *, const EVP_MD *,
308 const void *, const void *, size_t,
309 unsigned int, void *, void *);
316 void OpenSSL_add_all_algorithms(void);
317 void OpenSSL_add_all_algorithms_conf(void);
318 void OpenSSL_add_all_algorithms_noconf(void);
320 void
321 hcrypto_validate(void);
323 HC_CPP_END
325 #endif /* HEIM_EVP_H */