1 /* crypto/engine/eng_openssl.c */
3 * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
59 /* ====================================================================
60 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
61 * ECDH support in OpenSSL originally developed by
62 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
66 #include <openssl/crypto.h>
68 #include <openssl/engine.h>
69 #include <openssl/dso.h>
70 #include <openssl/pem.h>
71 #include <openssl/evp.h>
72 #include <openssl/rand.h>
73 #ifndef OPENSSL_NO_RSA
74 # include <openssl/rsa.h>
76 #ifndef OPENSSL_NO_DSA
77 # include <openssl/dsa.h>
80 # include <openssl/dh.h>
83 #include <openssl/hmac.h>
84 #include <openssl/x509v3.h>
87 * This testing gunk is implemented (and explained) lower down. It also
88 * assumes the application explicitly calls "ENGINE_load_openssl()" because
89 * this is no longer automatic in ENGINE_load_builtin_engines().
91 #define TEST_ENG_OPENSSL_RC4
92 #define TEST_ENG_OPENSSL_PKEY
93 /* #define TEST_ENG_OPENSSL_HMAC */
94 /* #define TEST_ENG_OPENSSL_HMAC_INIT */
95 /* #define TEST_ENG_OPENSSL_RC4_OTHERS */
96 #define TEST_ENG_OPENSSL_RC4_P_INIT
97 /* #define TEST_ENG_OPENSSL_RC4_P_CIPHER */
98 #define TEST_ENG_OPENSSL_SHA
99 /* #define TEST_ENG_OPENSSL_SHA_OTHERS */
100 /* #define TEST_ENG_OPENSSL_SHA_P_INIT */
101 /* #define TEST_ENG_OPENSSL_SHA_P_UPDATE */
102 /* #define TEST_ENG_OPENSSL_SHA_P_FINAL */
104 /* Now check what of those algorithms are actually enabled */
105 #ifdef OPENSSL_NO_RC4
106 # undef TEST_ENG_OPENSSL_RC4
107 # undef TEST_ENG_OPENSSL_RC4_OTHERS
108 # undef TEST_ENG_OPENSSL_RC4_P_INIT
109 # undef TEST_ENG_OPENSSL_RC4_P_CIPHER
112 #ifdef TEST_ENG_OPENSSL_RC4
113 static int openssl_ciphers(ENGINE
*e
, const EVP_CIPHER
**cipher
,
114 const int **nids
, int nid
);
116 #ifdef TEST_ENG_OPENSSL_SHA
117 static int openssl_digests(ENGINE
*e
, const EVP_MD
**digest
,
118 const int **nids
, int nid
);
121 #ifdef TEST_ENG_OPENSSL_PKEY
122 static EVP_PKEY
*openssl_load_privkey(ENGINE
*eng
, const char *key_id
,
123 UI_METHOD
*ui_method
,
124 void *callback_data
);
127 #ifdef TEST_ENG_OPENSSL_HMAC
128 static int ossl_register_hmac_meth(void);
129 static int ossl_pkey_meths(ENGINE
*e
, EVP_PKEY_METHOD
**pmeth
,
130 const int **nids
, int nid
);
133 /* The constants used when creating the ENGINE */
134 static const char *engine_openssl_id
= "openssl";
135 static const char *engine_openssl_name
= "Software engine support";
138 * This internal function is used by ENGINE_openssl() and possibly by the
139 * "dynamic" ENGINE support too
141 static int bind_helper(ENGINE
*e
)
143 if (!ENGINE_set_id(e
, engine_openssl_id
)
144 || !ENGINE_set_name(e
, engine_openssl_name
)
145 #ifndef TEST_ENG_OPENSSL_NO_ALGORITHMS
146 # ifndef OPENSSL_NO_RSA
147 || !ENGINE_set_RSA(e
, RSA_get_default_method())
149 # ifndef OPENSSL_NO_DSA
150 || !ENGINE_set_DSA(e
, DSA_get_default_method())
152 # ifndef OPENSSL_NO_ECDH
153 || !ENGINE_set_ECDH(e
, ECDH_OpenSSL())
155 # ifndef OPENSSL_NO_ECDSA
156 || !ENGINE_set_ECDSA(e
, ECDSA_OpenSSL())
158 # ifndef OPENSSL_NO_DH
159 || !ENGINE_set_DH(e
, DH_get_default_method())
161 || !ENGINE_set_RAND(e
, RAND_SSLeay())
162 # ifdef TEST_ENG_OPENSSL_RC4
163 || !ENGINE_set_ciphers(e
, openssl_ciphers
)
165 # ifdef TEST_ENG_OPENSSL_SHA
166 || !ENGINE_set_digests(e
, openssl_digests
)
169 #ifdef TEST_ENG_OPENSSL_PKEY
170 || !ENGINE_set_load_privkey_function(e
, openssl_load_privkey
)
172 #ifdef TEST_ENG_OPENSSL_HMAC
173 || !ossl_register_hmac_meth()
174 || !ENGINE_set_pkey_meths(e
, ossl_pkey_meths
)
179 * If we add errors to this ENGINE, ensure the error handling is setup
182 /* openssl_load_error_strings(); */
186 static ENGINE
*engine_openssl(void)
188 ENGINE
*ret
= ENGINE_new();
191 if (!bind_helper(ret
)) {
198 void ENGINE_load_openssl(void)
200 ENGINE
*toadd
= engine_openssl();
205 * If the "add" worked, it gets a structural reference. So either way, we
206 * release our just-created reference.
213 * This stuff is needed if this ENGINE is being compiled into a
214 * self-contained shared-library.
216 #ifdef ENGINE_DYNAMIC_SUPPORT
217 static int bind_fn(ENGINE
*e
, const char *id
)
219 if (id
&& (strcmp(id
, engine_openssl_id
) != 0))
226 IMPLEMENT_DYNAMIC_CHECK_FN()
227 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn
)
228 #endif /* ENGINE_DYNAMIC_SUPPORT */
229 #ifdef TEST_ENG_OPENSSL_RC4
231 * This section of code compiles an "alternative implementation" of two modes of
232 * RC4 into this ENGINE. The result is that EVP_CIPHER operation for "rc4"
233 * should under normal circumstances go via this support rather than the default
234 * EVP support. There are other symbols to tweak the testing;
235 * TEST_ENC_OPENSSL_RC4_OTHERS - print a one line message to stderr each time
236 * we're asked for a cipher we don't support (should not happen).
237 * TEST_ENG_OPENSSL_RC4_P_INIT - print a one line message to stderr each time
238 * the "init_key" handler is called.
239 * TEST_ENG_OPENSSL_RC4_P_CIPHER - ditto for the "cipher" handler.
241 # include <openssl/rc4.h>
242 # define TEST_RC4_KEY_SIZE 16
243 static const int test_cipher_nids
[] = { NID_rc4
, NID_rc4_40
};
245 static const int test_cipher_nids_number
= 2;
247 unsigned char key
[TEST_RC4_KEY_SIZE
];
250 # define test(ctx) ((TEST_RC4_KEY *)(ctx)->cipher_data)
251 static int test_rc4_init_key(EVP_CIPHER_CTX
*ctx
, const unsigned char *key
,
252 const unsigned char *iv
, int enc
)
254 # ifdef TEST_ENG_OPENSSL_RC4_P_INIT
255 fprintf(stderr
, "(TEST_ENG_OPENSSL_RC4) test_init_key() called\n");
257 memcpy(&test(ctx
)->key
[0], key
, EVP_CIPHER_CTX_key_length(ctx
));
258 RC4_set_key(&test(ctx
)->ks
, EVP_CIPHER_CTX_key_length(ctx
),
263 static int test_rc4_cipher(EVP_CIPHER_CTX
*ctx
, unsigned char *out
,
264 const unsigned char *in
, size_t inl
)
266 # ifdef TEST_ENG_OPENSSL_RC4_P_CIPHER
267 fprintf(stderr
, "(TEST_ENG_OPENSSL_RC4) test_cipher() called\n");
269 RC4(&test(ctx
)->ks
, inl
, in
, out
);
273 static const EVP_CIPHER test_r4_cipher
= {
275 1, TEST_RC4_KEY_SIZE
, 0,
276 EVP_CIPH_VARIABLE_LENGTH
,
280 sizeof(TEST_RC4_KEY
),
287 static const EVP_CIPHER test_r4_40_cipher
= {
289 1, 5 /* 40 bit */ , 0,
290 EVP_CIPH_VARIABLE_LENGTH
,
294 sizeof(TEST_RC4_KEY
),
301 static int openssl_ciphers(ENGINE
*e
, const EVP_CIPHER
**cipher
,
302 const int **nids
, int nid
)
305 /* We are returning a list of supported nids */
306 *nids
= test_cipher_nids
;
307 return test_cipher_nids_number
;
309 /* We are being asked for a specific cipher */
311 *cipher
= &test_r4_cipher
;
312 else if (nid
== NID_rc4_40
)
313 *cipher
= &test_r4_40_cipher
;
315 # ifdef TEST_ENG_OPENSSL_RC4_OTHERS
316 fprintf(stderr
, "(TEST_ENG_OPENSSL_RC4) returning NULL for "
326 #ifdef TEST_ENG_OPENSSL_SHA
327 /* Much the same sort of comment as for TEST_ENG_OPENSSL_RC4 */
328 # include <openssl/sha.h>
329 static const int test_digest_nids
[] = { NID_sha1
};
331 static const int test_digest_nids_number
= 1;
332 static int test_sha1_init(EVP_MD_CTX
*ctx
)
334 # ifdef TEST_ENG_OPENSSL_SHA_P_INIT
335 fprintf(stderr
, "(TEST_ENG_OPENSSL_SHA) test_sha1_init() called\n");
337 return SHA1_Init(ctx
->md_data
);
340 static int test_sha1_update(EVP_MD_CTX
*ctx
, const void *data
, size_t count
)
342 # ifdef TEST_ENG_OPENSSL_SHA_P_UPDATE
343 fprintf(stderr
, "(TEST_ENG_OPENSSL_SHA) test_sha1_update() called\n");
345 return SHA1_Update(ctx
->md_data
, data
, count
);
348 static int test_sha1_final(EVP_MD_CTX
*ctx
, unsigned char *md
)
350 # ifdef TEST_ENG_OPENSSL_SHA_P_FINAL
351 fprintf(stderr
, "(TEST_ENG_OPENSSL_SHA) test_sha1_final() called\n");
353 return SHA1_Final(md
, ctx
->md_data
);
356 static const EVP_MD test_sha_md
= {
358 NID_sha1WithRSAEncryption
,
368 sizeof(EVP_MD
*) + sizeof(SHA_CTX
),
371 static int openssl_digests(ENGINE
*e
, const EVP_MD
**digest
,
372 const int **nids
, int nid
)
375 /* We are returning a list of supported nids */
376 *nids
= test_digest_nids
;
377 return test_digest_nids_number
;
379 /* We are being asked for a specific digest */
381 *digest
= &test_sha_md
;
383 # ifdef TEST_ENG_OPENSSL_SHA_OTHERS
384 fprintf(stderr
, "(TEST_ENG_OPENSSL_SHA) returning NULL for "
394 #ifdef TEST_ENG_OPENSSL_PKEY
395 static EVP_PKEY
*openssl_load_privkey(ENGINE
*eng
, const char *key_id
,
396 UI_METHOD
*ui_method
,
401 fprintf(stderr
, "(TEST_ENG_OPENSSL_PKEY)Loading Private key %s\n",
403 in
= BIO_new_file(key_id
, "r");
406 key
= PEM_read_bio_PrivateKey(in
, NULL
, 0, NULL
);
412 #ifdef TEST_ENG_OPENSSL_HMAC
415 * Experimental HMAC redirection implementation: mainly copied from
419 /* HMAC pkey context structure */
422 const EVP_MD
*md
; /* MD for HMAC use */
423 ASN1_OCTET_STRING ktmp
; /* Temp storage for key */
425 } OSSL_HMAC_PKEY_CTX
;
427 static int ossl_hmac_init(EVP_PKEY_CTX
*ctx
)
429 OSSL_HMAC_PKEY_CTX
*hctx
;
430 hctx
= OPENSSL_malloc(sizeof(OSSL_HMAC_PKEY_CTX
));
434 hctx
->ktmp
.data
= NULL
;
435 hctx
->ktmp
.length
= 0;
436 hctx
->ktmp
.flags
= 0;
437 hctx
->ktmp
.type
= V_ASN1_OCTET_STRING
;
438 HMAC_CTX_init(&hctx
->ctx
);
439 EVP_PKEY_CTX_set_data(ctx
, hctx
);
440 EVP_PKEY_CTX_set0_keygen_info(ctx
, NULL
, 0);
441 # ifdef TEST_ENG_OPENSSL_HMAC_INIT
442 fprintf(stderr
, "(TEST_ENG_OPENSSL_HMAC) ossl_hmac_init() called\n");
447 static int ossl_hmac_copy(EVP_PKEY_CTX
*dst
, EVP_PKEY_CTX
*src
)
449 OSSL_HMAC_PKEY_CTX
*sctx
, *dctx
;
450 if (!ossl_hmac_init(dst
))
452 sctx
= EVP_PKEY_CTX_get_data(src
);
453 dctx
= EVP_PKEY_CTX_get_data(dst
);
455 HMAC_CTX_init(&dctx
->ctx
);
456 if (!HMAC_CTX_copy(&dctx
->ctx
, &sctx
->ctx
))
458 if (sctx
->ktmp
.data
) {
459 if (!ASN1_OCTET_STRING_set(&dctx
->ktmp
,
460 sctx
->ktmp
.data
, sctx
->ktmp
.length
))
466 static void ossl_hmac_cleanup(EVP_PKEY_CTX
*ctx
)
468 OSSL_HMAC_PKEY_CTX
*hctx
;
469 hctx
= EVP_PKEY_CTX_get_data(ctx
);
470 HMAC_CTX_cleanup(&hctx
->ctx
);
471 if (hctx
->ktmp
.data
) {
472 if (hctx
->ktmp
.length
)
473 OPENSSL_cleanse(hctx
->ktmp
.data
, hctx
->ktmp
.length
);
474 OPENSSL_free(hctx
->ktmp
.data
);
475 hctx
->ktmp
.data
= NULL
;
480 static int ossl_hmac_keygen(EVP_PKEY_CTX
*ctx
, EVP_PKEY
*pkey
)
482 ASN1_OCTET_STRING
*hkey
= NULL
;
483 OSSL_HMAC_PKEY_CTX
*hctx
= EVP_PKEY_CTX_get_data(ctx
);
484 if (!hctx
->ktmp
.data
)
486 hkey
= ASN1_OCTET_STRING_dup(&hctx
->ktmp
);
489 EVP_PKEY_assign(pkey
, EVP_PKEY_HMAC
, hkey
);
494 static int ossl_int_update(EVP_MD_CTX
*ctx
, const void *data
, size_t count
)
496 OSSL_HMAC_PKEY_CTX
*hctx
= EVP_PKEY_CTX_get_data(ctx
->pctx
);
497 if (!HMAC_Update(&hctx
->ctx
, data
, count
))
502 static int ossl_hmac_signctx_init(EVP_PKEY_CTX
*ctx
, EVP_MD_CTX
*mctx
)
504 EVP_MD_CTX_set_flags(mctx
, EVP_MD_CTX_FLAG_NO_INIT
);
505 mctx
->update
= ossl_int_update
;
509 static int ossl_hmac_signctx(EVP_PKEY_CTX
*ctx
, unsigned char *sig
,
510 size_t *siglen
, EVP_MD_CTX
*mctx
)
513 OSSL_HMAC_PKEY_CTX
*hctx
= EVP_PKEY_CTX_get_data(ctx
);
514 int l
= EVP_MD_CTX_size(mctx
);
522 if (!HMAC_Final(&hctx
->ctx
, sig
, &hlen
))
524 *siglen
= (size_t)hlen
;
528 static int ossl_hmac_ctrl(EVP_PKEY_CTX
*ctx
, int type
, int p1
, void *p2
)
530 OSSL_HMAC_PKEY_CTX
*hctx
= EVP_PKEY_CTX_get_data(ctx
);
532 ASN1_OCTET_STRING
*key
;
535 case EVP_PKEY_CTRL_SET_MAC_KEY
:
536 if ((!p2
&& p1
> 0) || (p1
< -1))
538 if (!ASN1_OCTET_STRING_set(&hctx
->ktmp
, p2
, p1
))
542 case EVP_PKEY_CTRL_MD
:
546 case EVP_PKEY_CTRL_DIGESTINIT
:
547 pk
= EVP_PKEY_CTX_get0_pkey(ctx
);
548 key
= EVP_PKEY_get0(pk
);
549 if (!HMAC_Init_ex(&hctx
->ctx
, key
->data
, key
->length
, hctx
->md
, NULL
))
560 static int ossl_hmac_ctrl_str(EVP_PKEY_CTX
*ctx
,
561 const char *type
, const char *value
)
566 if (!strcmp(type
, "key")) {
567 void *p
= (void *)value
;
568 return ossl_hmac_ctrl(ctx
, EVP_PKEY_CTRL_SET_MAC_KEY
, -1, p
);
570 if (!strcmp(type
, "hexkey")) {
574 key
= string_to_hex(value
, &keylen
);
577 r
= ossl_hmac_ctrl(ctx
, EVP_PKEY_CTRL_SET_MAC_KEY
, keylen
, key
);
584 static EVP_PKEY_METHOD
*ossl_hmac_meth
;
586 static int ossl_register_hmac_meth(void)
588 EVP_PKEY_METHOD
*meth
;
589 meth
= EVP_PKEY_meth_new(EVP_PKEY_HMAC
, 0);
592 EVP_PKEY_meth_set_init(meth
, ossl_hmac_init
);
593 EVP_PKEY_meth_set_copy(meth
, ossl_hmac_copy
);
594 EVP_PKEY_meth_set_cleanup(meth
, ossl_hmac_cleanup
);
596 EVP_PKEY_meth_set_keygen(meth
, 0, ossl_hmac_keygen
);
598 EVP_PKEY_meth_set_signctx(meth
, ossl_hmac_signctx_init
,
601 EVP_PKEY_meth_set_ctrl(meth
, ossl_hmac_ctrl
, ossl_hmac_ctrl_str
);
602 ossl_hmac_meth
= meth
;
606 static int ossl_pkey_meths(ENGINE
*e
, EVP_PKEY_METHOD
**pmeth
,
607 const int **nids
, int nid
)
609 static int ossl_pkey_nids
[] = {
614 *nids
= ossl_pkey_nids
;
618 if (nid
== EVP_PKEY_HMAC
) {
619 *pmeth
= ossl_hmac_meth
;