Typo.
[oweals/openssl.git] / crypto / evp / evp_lib.c
1 /* crypto/evp/evp_lib.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #include <stdio.h>
60 #include "cryptlib.h"
61 #include <openssl/evp.h>
62 #include <openssl/objects.h>
63 #ifdef OPENSSL_FIPS
64 # include <openssl/fips.h>
65 # include "evp_locl.h"
66 #endif
67
68 int EVP_CIPHER_param_to_asn1(EVP_CIPHER_CTX *c, ASN1_TYPE *type)
69 {
70     int ret;
71
72     if (c->cipher->set_asn1_parameters != NULL)
73         ret = c->cipher->set_asn1_parameters(c, type);
74     else if (c->cipher->flags & EVP_CIPH_FLAG_DEFAULT_ASN1) {
75         switch (EVP_CIPHER_CTX_mode(c)) {
76         case EVP_CIPH_WRAP_MODE:
77             ASN1_TYPE_set(type, V_ASN1_NULL, NULL);
78             ret = 1;
79             break;
80
81         case EVP_CIPH_GCM_MODE:
82         case EVP_CIPH_CCM_MODE:
83         case EVP_CIPH_XTS_MODE:
84             ret = -1;
85             break;
86
87         default:
88             ret = EVP_CIPHER_set_asn1_iv(c, type);
89         }
90     } else
91         ret = -1;
92     return (ret);
93 }
94
95 int EVP_CIPHER_asn1_to_param(EVP_CIPHER_CTX *c, ASN1_TYPE *type)
96 {
97     int ret;
98
99     if (c->cipher->get_asn1_parameters != NULL)
100         ret = c->cipher->get_asn1_parameters(c, type);
101     else if (c->cipher->flags & EVP_CIPH_FLAG_DEFAULT_ASN1) {
102         switch (EVP_CIPHER_CTX_mode(c)) {
103
104         case EVP_CIPH_WRAP_MODE:
105             ret = 1;
106             break;
107
108         case EVP_CIPH_GCM_MODE:
109         case EVP_CIPH_CCM_MODE:
110         case EVP_CIPH_XTS_MODE:
111             ret = -1;
112             break;
113
114         default:
115             ret = EVP_CIPHER_get_asn1_iv(c, type);
116             break;
117         }
118     } else
119         ret = -1;
120     return (ret);
121 }
122
123 int EVP_CIPHER_get_asn1_iv(EVP_CIPHER_CTX *c, ASN1_TYPE *type)
124 {
125     int i = 0;
126     unsigned int l;
127
128     if (type != NULL) {
129         l = EVP_CIPHER_CTX_iv_length(c);
130         OPENSSL_assert(l <= sizeof(c->iv));
131         i = ASN1_TYPE_get_octetstring(type, c->oiv, l);
132         if (i != (int)l)
133             return (-1);
134         else if (i > 0)
135             memcpy(c->iv, c->oiv, l);
136     }
137     return (i);
138 }
139
140 int EVP_CIPHER_set_asn1_iv(EVP_CIPHER_CTX *c, ASN1_TYPE *type)
141 {
142     int i = 0;
143     unsigned int j;
144
145     if (type != NULL) {
146         j = EVP_CIPHER_CTX_iv_length(c);
147         OPENSSL_assert(j <= sizeof(c->iv));
148         i = ASN1_TYPE_set_octetstring(type, c->oiv, j);
149     }
150     return (i);
151 }
152
153 /* Convert the various cipher NIDs and dummies to a proper OID NID */
154 int EVP_CIPHER_type(const EVP_CIPHER *ctx)
155 {
156     int nid;
157     ASN1_OBJECT *otmp;
158     nid = EVP_CIPHER_nid(ctx);
159
160     switch (nid) {
161
162     case NID_rc2_cbc:
163     case NID_rc2_64_cbc:
164     case NID_rc2_40_cbc:
165
166         return NID_rc2_cbc;
167
168     case NID_rc4:
169     case NID_rc4_40:
170
171         return NID_rc4;
172
173     case NID_aes_128_cfb128:
174     case NID_aes_128_cfb8:
175     case NID_aes_128_cfb1:
176
177         return NID_aes_128_cfb128;
178
179     case NID_aes_192_cfb128:
180     case NID_aes_192_cfb8:
181     case NID_aes_192_cfb1:
182
183         return NID_aes_192_cfb128;
184
185     case NID_aes_256_cfb128:
186     case NID_aes_256_cfb8:
187     case NID_aes_256_cfb1:
188
189         return NID_aes_256_cfb128;
190
191     case NID_des_cfb64:
192     case NID_des_cfb8:
193     case NID_des_cfb1:
194
195         return NID_des_cfb64;
196
197     case NID_des_ede3_cfb64:
198     case NID_des_ede3_cfb8:
199     case NID_des_ede3_cfb1:
200
201         return NID_des_cfb64;
202
203     default:
204         /* Check it has an OID and it is valid */
205         otmp = OBJ_nid2obj(nid);
206         if (!otmp || !otmp->data)
207             nid = NID_undef;
208         ASN1_OBJECT_free(otmp);
209         return nid;
210     }
211 }
212
213 int EVP_CIPHER_block_size(const EVP_CIPHER *e)
214 {
215     return e->block_size;
216 }
217
218 int EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *ctx)
219 {
220     return ctx->cipher->block_size;
221 }
222
223 int EVP_Cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
224                const unsigned char *in, unsigned int inl)
225 {
226     return ctx->cipher->do_cipher(ctx, out, in, inl);
227 }
228
229 const EVP_CIPHER *EVP_CIPHER_CTX_cipher(const EVP_CIPHER_CTX *ctx)
230 {
231     return ctx->cipher;
232 }
233
234 unsigned long EVP_CIPHER_flags(const EVP_CIPHER *cipher)
235 {
236 #ifdef OPENSSL_FIPS
237     const EVP_CIPHER *fcipher;
238     fcipher = evp_get_fips_cipher(cipher);
239     if (fcipher && fcipher->flags & EVP_CIPH_FLAG_FIPS)
240         return cipher->flags | EVP_CIPH_FLAG_FIPS;
241 #endif
242     return cipher->flags;
243 }
244
245 unsigned long EVP_CIPHER_CTX_flags(const EVP_CIPHER_CTX *ctx)
246 {
247 #ifdef OPENSSL_FIPS
248     return EVP_CIPHER_flags(ctx->cipher);
249 #else
250     return ctx->cipher->flags;
251 #endif
252 }
253
254 void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx)
255 {
256     return ctx->app_data;
257 }
258
259 void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX *ctx, void *data)
260 {
261     ctx->app_data = data;
262 }
263
264 int EVP_CIPHER_iv_length(const EVP_CIPHER *cipher)
265 {
266     return cipher->iv_len;
267 }
268
269 int EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *ctx)
270 {
271     return ctx->cipher->iv_len;
272 }
273
274 int EVP_CIPHER_key_length(const EVP_CIPHER *cipher)
275 {
276     return cipher->key_len;
277 }
278
279 int EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *ctx)
280 {
281     return ctx->key_len;
282 }
283
284 int EVP_CIPHER_nid(const EVP_CIPHER *cipher)
285 {
286     return cipher->nid;
287 }
288
289 int EVP_CIPHER_CTX_nid(const EVP_CIPHER_CTX *ctx)
290 {
291     return ctx->cipher->nid;
292 }
293
294 int EVP_MD_block_size(const EVP_MD *md)
295 {
296     return md->block_size;
297 }
298
299 int EVP_MD_type(const EVP_MD *md)
300 {
301     return md->type;
302 }
303
304 int EVP_MD_pkey_type(const EVP_MD *md)
305 {
306     return md->pkey_type;
307 }
308
309 int EVP_MD_size(const EVP_MD *md)
310 {
311     if (!md) {
312         EVPerr(EVP_F_EVP_MD_SIZE, EVP_R_MESSAGE_DIGEST_IS_NULL);
313         return -1;
314     }
315     return md->md_size;
316 }
317
318 #ifdef OPENSSL_FIPS
319
320 const EVP_MD *evp_get_fips_md(const EVP_MD *md)
321 {
322     int nid = EVP_MD_type(md);
323     if (nid == NID_dsa)
324         return FIPS_evp_dss1();
325     else if (nid == NID_dsaWithSHA)
326         return FIPS_evp_dss();
327     else if (nid == NID_ecdsa_with_SHA1)
328         return FIPS_evp_ecdsa();
329     else
330         return FIPS_get_digestbynid(nid);
331 }
332
333 const EVP_CIPHER *evp_get_fips_cipher(const EVP_CIPHER *cipher)
334 {
335     int nid = cipher->nid;
336     if (nid == NID_undef)
337         return FIPS_evp_enc_null();
338     else
339         return FIPS_get_cipherbynid(nid);
340 }
341
342 #endif
343
344 unsigned long EVP_MD_flags(const EVP_MD *md)
345 {
346 #ifdef OPENSSL_FIPS
347     const EVP_MD *fmd;
348     fmd = evp_get_fips_md(md);
349     if (fmd && fmd->flags & EVP_MD_FLAG_FIPS)
350         return md->flags | EVP_MD_FLAG_FIPS;
351 #endif
352     return md->flags;
353 }
354
355 const EVP_MD *EVP_MD_CTX_md(const EVP_MD_CTX *ctx)
356 {
357     if (!ctx)
358         return NULL;
359     return ctx->digest;
360 }
361
362 void EVP_MD_CTX_set_flags(EVP_MD_CTX *ctx, int flags)
363 {
364     ctx->flags |= flags;
365 }
366
367 void EVP_MD_CTX_clear_flags(EVP_MD_CTX *ctx, int flags)
368 {
369     ctx->flags &= ~flags;
370 }
371
372 int EVP_MD_CTX_test_flags(const EVP_MD_CTX *ctx, int flags)
373 {
374     return (ctx->flags & flags);
375 }
376
377 void EVP_CIPHER_CTX_set_flags(EVP_CIPHER_CTX *ctx, int flags)
378 {
379     ctx->flags |= flags;
380 }
381
382 void EVP_CIPHER_CTX_clear_flags(EVP_CIPHER_CTX *ctx, int flags)
383 {
384     ctx->flags &= ~flags;
385 }
386
387 int EVP_CIPHER_CTX_test_flags(const EVP_CIPHER_CTX *ctx, int flags)
388 {
389     return (ctx->flags & flags);
390 }