Make the definition of EVP_MD_CTX opaque
[oweals/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 # define M_EVP_MD_CTX_set_flags(ctx,flgs) ((ctx)->flags|=(flgs))
75 # define M_EVP_MD_CTX_clear_flags(ctx,flgs) ((ctx)->flags&=~(flgs))
76 # define M_EVP_MD_CTX_test_flags(ctx,flgs) ((ctx)->flags&(flgs))
77 # define M_EVP_MD_CTX_type(e)            M_EVP_MD_type(M_EVP_MD_CTX_md(e))
78 # define M_EVP_MD_CTX_md(e)                      ((e)->digest)
79
80 /* Macros to code block cipher wrappers */
81
82 /* Wrapper functions for each cipher mode */
83
84 #define BLOCK_CIPHER_ecb_loop() \
85         size_t i, bl; \
86         bl = ctx->cipher->block_size;\
87         if(inl < bl) return 1;\
88         inl -= bl; \
89         for(i=0; i <= inl; i+=bl)
90
91 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
92 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
93 {\
94         BLOCK_CIPHER_ecb_loop() \
95                 cprefix##_ecb_encrypt(in + i, out + i, &((kstruct *)ctx->cipher_data)->ksched, ctx->encrypt);\
96         return 1;\
97 }
98
99 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
100
101 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
102 static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
103 {\
104         while(inl>=EVP_MAXCHUNK)\
105             {\
106             cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &((kstruct *)ctx->cipher_data)->ksched, ctx->iv, &ctx->num);\
107             inl-=EVP_MAXCHUNK;\
108             in +=EVP_MAXCHUNK;\
109             out+=EVP_MAXCHUNK;\
110             }\
111         if (inl)\
112             cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &((kstruct *)ctx->cipher_data)->ksched, ctx->iv, &ctx->num);\
113         return 1;\
114 }
115
116 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
117 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
118 {\
119         while(inl>=EVP_MAXCHUNK) \
120             {\
121             cprefix##_cbc_encrypt(in, out, (long)EVP_MAXCHUNK, &((kstruct *)ctx->cipher_data)->ksched, ctx->iv, ctx->encrypt);\
122             inl-=EVP_MAXCHUNK;\
123             in +=EVP_MAXCHUNK;\
124             out+=EVP_MAXCHUNK;\
125             }\
126         if (inl)\
127             cprefix##_cbc_encrypt(in, out, (long)inl, &((kstruct *)ctx->cipher_data)->ksched, ctx->iv, ctx->encrypt);\
128         return 1;\
129 }
130
131 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
132 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
133 {\
134         size_t chunk=EVP_MAXCHUNK;\
135         if (cbits==1)  chunk>>=3;\
136         if (inl<chunk) chunk=inl;\
137         while(inl && inl>=chunk)\
138             {\
139             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);\
140             inl-=chunk;\
141             in +=chunk;\
142             out+=chunk;\
143             if(inl<chunk) chunk=inl;\
144             }\
145         return 1;\
146 }
147
148 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
149         BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
150         BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
151         BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
152         BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
153
154 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
155                           key_len, iv_len, flags, init_key, cleanup, \
156                           set_asn1, get_asn1, ctrl) \
157 static const EVP_CIPHER cname##_##mode = { \
158         nid##_##nmode, block_size, key_len, iv_len, \
159         flags | EVP_CIPH_##MODE##_MODE, \
160         init_key, \
161         cname##_##mode##_cipher, \
162         cleanup, \
163         sizeof(kstruct), \
164         set_asn1, get_asn1,\
165         ctrl, \
166         NULL \
167 }; \
168 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
169
170 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
171                              iv_len, flags, init_key, cleanup, set_asn1, \
172                              get_asn1, ctrl) \
173 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
174                   iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
175
176 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
177                              iv_len, cbits, flags, init_key, cleanup, \
178                              set_asn1, get_asn1, ctrl) \
179 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
180                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
181                   get_asn1, ctrl)
182
183 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
184                              iv_len, cbits, flags, init_key, cleanup, \
185                              set_asn1, get_asn1, ctrl) \
186 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
187                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
188                   get_asn1, ctrl)
189
190 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
191                              flags, init_key, cleanup, set_asn1, \
192                              get_asn1, ctrl) \
193 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
194                   0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
195
196 #define BLOCK_CIPHER_defs(cname, kstruct, \
197                           nid, block_size, key_len, iv_len, cbits, flags, \
198                           init_key, cleanup, set_asn1, get_asn1, ctrl) \
199 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
200                      init_key, cleanup, set_asn1, get_asn1, ctrl) \
201 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
202                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
203 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
204                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
205 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
206                      init_key, cleanup, set_asn1, get_asn1, ctrl)
207
208 /*-
209 #define BLOCK_CIPHER_defs(cname, kstruct, \
210                                 nid, block_size, key_len, iv_len, flags,\
211                                  init_key, cleanup, set_asn1, get_asn1, ctrl)\
212 static const EVP_CIPHER cname##_cbc = {\
213         nid##_cbc, block_size, key_len, iv_len, \
214         flags | EVP_CIPH_CBC_MODE,\
215         init_key,\
216         cname##_cbc_cipher,\
217         cleanup,\
218         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
219                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
220         set_asn1, get_asn1,\
221         ctrl, \
222         NULL \
223 };\
224 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
225 static const EVP_CIPHER cname##_cfb = {\
226         nid##_cfb64, 1, key_len, iv_len, \
227         flags | EVP_CIPH_CFB_MODE,\
228         init_key,\
229         cname##_cfb_cipher,\
230         cleanup,\
231         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
232                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
233         set_asn1, get_asn1,\
234         ctrl,\
235         NULL \
236 };\
237 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
238 static const EVP_CIPHER cname##_ofb = {\
239         nid##_ofb64, 1, key_len, iv_len, \
240         flags | EVP_CIPH_OFB_MODE,\
241         init_key,\
242         cname##_ofb_cipher,\
243         cleanup,\
244         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
245                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
246         set_asn1, get_asn1,\
247         ctrl,\
248         NULL \
249 };\
250 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
251 static const EVP_CIPHER cname##_ecb = {\
252         nid##_ecb, block_size, key_len, iv_len, \
253         flags | EVP_CIPH_ECB_MODE,\
254         init_key,\
255         cname##_ecb_cipher,\
256         cleanup,\
257         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
258                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
259         set_asn1, get_asn1,\
260         ctrl,\
261         NULL \
262 };\
263 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
264 */
265
266 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
267                                block_size, key_len, iv_len, cbits, \
268                                flags, init_key, \
269                                cleanup, set_asn1, get_asn1, ctrl) \
270         BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
271         BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
272                           cbits, flags, init_key, cleanup, set_asn1, \
273                           get_asn1, ctrl)
274
275 #define EVP_C_DATA(kstruct, ctx)        ((kstruct *)(ctx)->cipher_data)
276
277 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
278         BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
279         BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
280                              NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
281                              (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
282                              cipher##_init_key, NULL, NULL, NULL, NULL)
283
284 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
285                              int passlen, ASN1_TYPE *param,
286                              const EVP_CIPHER *c, const EVP_MD *md,
287                              int en_de);