Make EVP_CIPHER_CTX opaque and renew the creator / destructor functions
[openssl.git] / crypto / evp / evp_locl.h
1 /* evp_locl.h */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4  * 2000.
5  */
6 /* ====================================================================
7  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59
60 /* EVP_MD_CTX related stuff */
61
62 struct evp_md_ctx_st {
63     const EVP_MD *digest;
64     ENGINE *engine;             /* functional reference if 'digest' is
65                                  * ENGINE-provided */
66     unsigned long flags;
67     void *md_data;
68     /* Public key context for sign/verify */
69     EVP_PKEY_CTX *pctx;
70     /* Update function: usually copied from EVP_MD */
71     int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
72 } /* EVP_MD_CTX */ ;
73
74 struct evp_cipher_ctx_st {
75     const EVP_CIPHER *cipher;
76     ENGINE *engine;             /* functional reference if 'cipher' is
77                                  * ENGINE-provided */
78     int encrypt;                /* encrypt or decrypt */
79     int buf_len;                /* number we have left */
80     unsigned char oiv[EVP_MAX_IV_LENGTH]; /* original iv */
81     unsigned char iv[EVP_MAX_IV_LENGTH]; /* working iv */
82     unsigned char buf[EVP_MAX_BLOCK_LENGTH]; /* saved partial block */
83     int num;                    /* used by cfb/ofb/ctr mode */
84     /* FIXME: Should this even exist? It appears unused */
85     void *app_data;             /* application stuff */
86     int key_len;                /* May change for variable length cipher */
87     unsigned long flags;        /* Various flags */
88     void *cipher_data;          /* per EVP data */
89     int final_used;
90     int block_mask;
91     unsigned char final[EVP_MAX_BLOCK_LENGTH]; /* possible final block */
92 } /* EVP_CIPHER_CTX */ ;
93
94 /* Macros to code block cipher wrappers */
95
96 /* Wrapper functions for each cipher mode */
97
98 #define BLOCK_CIPHER_ecb_loop() \
99         size_t i, bl; \
100         bl = ctx->cipher->block_size;\
101         if(inl < bl) return 1;\
102         inl -= bl; \
103         for(i=0; i <= inl; i+=bl)
104
105 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
106 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
107 {\
108         BLOCK_CIPHER_ecb_loop() \
109                 cprefix##_ecb_encrypt(in + i, out + i, &((kstruct *)ctx->cipher_data)->ksched, ctx->encrypt);\
110         return 1;\
111 }
112
113 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
114
115 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
116 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
117 {\
118         while(inl>=EVP_MAXCHUNK)\
119             {\
120             cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &((kstruct *)ctx->cipher_data)->ksched, ctx->iv, &ctx->num);\
121             inl-=EVP_MAXCHUNK;\
122             in +=EVP_MAXCHUNK;\
123             out+=EVP_MAXCHUNK;\
124             }\
125         if (inl)\
126             cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &((kstruct *)ctx->cipher_data)->ksched, ctx->iv, &ctx->num);\
127         return 1;\
128 }
129
130 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
131 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
132 {\
133         while(inl>=EVP_MAXCHUNK) \
134             {\
135             cprefix##_cbc_encrypt(in, out, (long)EVP_MAXCHUNK, &((kstruct *)ctx->cipher_data)->ksched, ctx->iv, ctx->encrypt);\
136             inl-=EVP_MAXCHUNK;\
137             in +=EVP_MAXCHUNK;\
138             out+=EVP_MAXCHUNK;\
139             }\
140         if (inl)\
141             cprefix##_cbc_encrypt(in, out, (long)inl, &((kstruct *)ctx->cipher_data)->ksched, ctx->iv, ctx->encrypt);\
142         return 1;\
143 }
144
145 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
146 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
147 {\
148         size_t chunk=EVP_MAXCHUNK;\
149         if (cbits==1)  chunk>>=3;\
150         if (inl<chunk) chunk=inl;\
151         while(inl && inl>=chunk)\
152             {\
153             cprefix##_cfb##cbits##_encrypt(in, out, (long)((cbits==1) && !(ctx->flags & EVP_CIPH_FLAG_LENGTH_BITS) ?inl*8:inl), &((kstruct *)ctx->cipher_data)->ksched, ctx->iv, &ctx->num, ctx->encrypt);\
154             inl-=chunk;\
155             in +=chunk;\
156             out+=chunk;\
157             if(inl<chunk) chunk=inl;\
158             }\
159         return 1;\
160 }
161
162 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
163         BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
164         BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
165         BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
166         BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
167
168 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
169                           key_len, iv_len, flags, init_key, cleanup, \
170                           set_asn1, get_asn1, ctrl) \
171 static const EVP_CIPHER cname##_##mode = { \
172         nid##_##nmode, block_size, key_len, iv_len, \
173         flags | EVP_CIPH_##MODE##_MODE, \
174         init_key, \
175         cname##_##mode##_cipher, \
176         cleanup, \
177         sizeof(kstruct), \
178         set_asn1, get_asn1,\
179         ctrl, \
180         NULL \
181 }; \
182 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
183
184 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
185                              iv_len, flags, init_key, cleanup, set_asn1, \
186                              get_asn1, ctrl) \
187 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
188                   iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
189
190 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
191                              iv_len, cbits, flags, init_key, cleanup, \
192                              set_asn1, get_asn1, ctrl) \
193 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
194                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
195                   get_asn1, ctrl)
196
197 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
198                              iv_len, cbits, flags, init_key, cleanup, \
199                              set_asn1, get_asn1, ctrl) \
200 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
201                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
202                   get_asn1, ctrl)
203
204 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
205                              flags, init_key, cleanup, set_asn1, \
206                              get_asn1, ctrl) \
207 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
208                   0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
209
210 #define BLOCK_CIPHER_defs(cname, kstruct, \
211                           nid, block_size, key_len, iv_len, cbits, flags, \
212                           init_key, cleanup, set_asn1, get_asn1, ctrl) \
213 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
214                      init_key, cleanup, set_asn1, get_asn1, ctrl) \
215 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
216                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
217 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
218                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
219 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
220                      init_key, cleanup, set_asn1, get_asn1, ctrl)
221
222 /*-
223 #define BLOCK_CIPHER_defs(cname, kstruct, \
224                                 nid, block_size, key_len, iv_len, flags,\
225                                  init_key, cleanup, set_asn1, get_asn1, ctrl)\
226 static const EVP_CIPHER cname##_cbc = {\
227         nid##_cbc, block_size, key_len, iv_len, \
228         flags | EVP_CIPH_CBC_MODE,\
229         init_key,\
230         cname##_cbc_cipher,\
231         cleanup,\
232         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
233                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
234         set_asn1, get_asn1,\
235         ctrl, \
236         NULL \
237 };\
238 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
239 static const EVP_CIPHER cname##_cfb = {\
240         nid##_cfb64, 1, key_len, iv_len, \
241         flags | EVP_CIPH_CFB_MODE,\
242         init_key,\
243         cname##_cfb_cipher,\
244         cleanup,\
245         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
246                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
247         set_asn1, get_asn1,\
248         ctrl,\
249         NULL \
250 };\
251 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
252 static const EVP_CIPHER cname##_ofb = {\
253         nid##_ofb64, 1, key_len, iv_len, \
254         flags | EVP_CIPH_OFB_MODE,\
255         init_key,\
256         cname##_ofb_cipher,\
257         cleanup,\
258         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
259                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
260         set_asn1, get_asn1,\
261         ctrl,\
262         NULL \
263 };\
264 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
265 static const EVP_CIPHER cname##_ecb = {\
266         nid##_ecb, block_size, key_len, iv_len, \
267         flags | EVP_CIPH_ECB_MODE,\
268         init_key,\
269         cname##_ecb_cipher,\
270         cleanup,\
271         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
272                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
273         set_asn1, get_asn1,\
274         ctrl,\
275         NULL \
276 };\
277 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
278 */
279
280 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
281                                block_size, key_len, iv_len, cbits, \
282                                flags, init_key, \
283                                cleanup, set_asn1, get_asn1, ctrl) \
284         BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
285         BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
286                           cbits, flags, init_key, cleanup, set_asn1, \
287                           get_asn1, ctrl)
288
289 #define EVP_C_DATA(kstruct, ctx)        ((kstruct *)(ctx)->cipher_data)
290
291 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
292         BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
293         BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
294                              NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
295                              (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
296                              cipher##_init_key, NULL, NULL, NULL, NULL)
297
298 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
299                              int passlen, ASN1_TYPE *param,
300                              const EVP_CIPHER *c, const EVP_MD *md,
301                              int en_de);
302
303 struct evp_Encode_Ctx_st {
304     /* number saved in a partial encode/decode */
305     int num;
306     /*
307      * The length is either the output line length (in input bytes) or the
308      * shortest input line length that is ok.  Once decoding begins, the
309      * length is adjusted up each time a longer line is decoded
310      */
311     int length;
312     /* data to encode */
313     unsigned char enc_data[80];
314     /* number read on current line */
315     int line_num;
316     int expect_nl;
317 };
318
319 typedef struct evp_pbe_st EVP_PBE_CTL;
320 DEFINE_STACK_OF(EVP_PBE_CTL)