2 * Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
12 #include <openssl/crypto.h>
13 #include "internal/cryptlib.h"
14 #include "internal/engine.h"
15 #include <openssl/pem.h>
16 #include <openssl/evp.h>
17 #include <openssl/rand.h>
18 #include <openssl/rsa.h>
19 #include <openssl/dsa.h>
20 #include <openssl/dh.h>
22 #include <openssl/hmac.h>
23 #include <openssl/x509v3.h>
26 * This testing gunk is implemented (and explained) lower down. It also
27 * assumes the application explicitly calls "ENGINE_load_openssl()" because
28 * this is no longer automatic in ENGINE_load_builtin_engines().
30 #define TEST_ENG_OPENSSL_RC4
31 #ifndef OPENSSL_NO_STDIO
32 # define TEST_ENG_OPENSSL_PKEY
34 /* #define TEST_ENG_OPENSSL_HMAC */
35 /* #define TEST_ENG_OPENSSL_HMAC_INIT */
36 /* #define TEST_ENG_OPENSSL_RC4_OTHERS */
37 #ifndef OPENSSL_NO_STDIO
38 # define TEST_ENG_OPENSSL_RC4_P_INIT
40 /* #define TEST_ENG_OPENSSL_RC4_P_CIPHER */
41 #define TEST_ENG_OPENSSL_SHA
42 /* #define TEST_ENG_OPENSSL_SHA_OTHERS */
43 /* #define TEST_ENG_OPENSSL_SHA_P_INIT */
44 /* #define TEST_ENG_OPENSSL_SHA_P_UPDATE */
45 /* #define TEST_ENG_OPENSSL_SHA_P_FINAL */
47 /* Now check what of those algorithms are actually enabled */
49 # undef TEST_ENG_OPENSSL_RC4
50 # undef TEST_ENG_OPENSSL_RC4_OTHERS
51 # undef TEST_ENG_OPENSSL_RC4_P_INIT
52 # undef TEST_ENG_OPENSSL_RC4_P_CIPHER
55 static int openssl_destroy(ENGINE *e);
57 #ifdef TEST_ENG_OPENSSL_RC4
58 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
59 const int **nids, int nid);
61 #ifdef TEST_ENG_OPENSSL_SHA
62 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
63 const int **nids, int nid);
66 #ifdef TEST_ENG_OPENSSL_PKEY
67 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
72 #ifdef TEST_ENG_OPENSSL_HMAC
73 static int ossl_register_hmac_meth(void);
74 static int ossl_pkey_meths(ENGINE *e, EVP_PKEY_METHOD **pmeth,
75 const int **nids, int nid);
78 /* The constants used when creating the ENGINE */
79 static const char *engine_openssl_id = "openssl";
80 static const char *engine_openssl_name = "Software engine support";
83 * This internal function is used by ENGINE_openssl() and possibly by the
84 * "dynamic" ENGINE support too
86 static int bind_helper(ENGINE *e)
88 if (!ENGINE_set_id(e, engine_openssl_id)
89 || !ENGINE_set_name(e, engine_openssl_name)
90 || !ENGINE_set_destroy_function(e, openssl_destroy)
91 #ifndef TEST_ENG_OPENSSL_NO_ALGORITHMS
92 # ifndef OPENSSL_NO_RSA
93 || !ENGINE_set_RSA(e, RSA_get_default_method())
95 # ifndef OPENSSL_NO_DSA
96 || !ENGINE_set_DSA(e, DSA_get_default_method())
98 # ifndef OPENSSL_NO_EC
99 || !ENGINE_set_EC(e, EC_KEY_OpenSSL())
101 # ifndef OPENSSL_NO_DH
102 || !ENGINE_set_DH(e, DH_get_default_method())
104 || !ENGINE_set_RAND(e, RAND_OpenSSL())
105 # ifdef TEST_ENG_OPENSSL_RC4
106 || !ENGINE_set_ciphers(e, openssl_ciphers)
108 # ifdef TEST_ENG_OPENSSL_SHA
109 || !ENGINE_set_digests(e, openssl_digests)
112 #ifdef TEST_ENG_OPENSSL_PKEY
113 || !ENGINE_set_load_privkey_function(e, openssl_load_privkey)
115 #ifdef TEST_ENG_OPENSSL_HMAC
116 || !ossl_register_hmac_meth()
117 || !ENGINE_set_pkey_meths(e, ossl_pkey_meths)
122 * If we add errors to this ENGINE, ensure the error handling is setup
125 /* openssl_load_error_strings(); */
129 static ENGINE *engine_openssl(void)
131 ENGINE *ret = ENGINE_new();
134 if (!bind_helper(ret)) {
141 void engine_load_openssl_int(void)
143 ENGINE *toadd = engine_openssl();
148 * If the "add" worked, it gets a structural reference. So either way, we
149 * release our just-created reference.
156 * This stuff is needed if this ENGINE is being compiled into a
157 * self-contained shared-library.
159 #ifdef ENGINE_DYNAMIC_SUPPORT
160 static int bind_fn(ENGINE *e, const char *id)
162 if (id && (strcmp(id, engine_openssl_id) != 0))
169 IMPLEMENT_DYNAMIC_CHECK_FN()
170 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
171 #endif /* ENGINE_DYNAMIC_SUPPORT */
172 #ifdef TEST_ENG_OPENSSL_RC4
174 * This section of code compiles an "alternative implementation" of two modes of
175 * RC4 into this ENGINE. The result is that EVP_CIPHER operation for "rc4"
176 * should under normal circumstances go via this support rather than the default
177 * EVP support. There are other symbols to tweak the testing;
178 * TEST_ENC_OPENSSL_RC4_OTHERS - print a one line message to stderr each time
179 * we're asked for a cipher we don't support (should not happen).
180 * TEST_ENG_OPENSSL_RC4_P_INIT - print a one line message to stderr each time
181 * the "init_key" handler is called.
182 * TEST_ENG_OPENSSL_RC4_P_CIPHER - ditto for the "cipher" handler.
184 # include <openssl/rc4.h>
185 # define TEST_RC4_KEY_SIZE 16
187 unsigned char key[TEST_RC4_KEY_SIZE];
190 # define test(ctx) ((TEST_RC4_KEY *)EVP_CIPHER_CTX_get_cipher_data(ctx))
191 static int test_rc4_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
192 const unsigned char *iv, int enc)
194 const int n = EVP_CIPHER_CTX_key_length(ctx);
196 # ifdef TEST_ENG_OPENSSL_RC4_P_INIT
197 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_init_key() called\n");
201 memcpy(&test(ctx)->key[0], key, n);
202 RC4_set_key(&test(ctx)->ks, n, test(ctx)->key);
206 static int test_rc4_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
207 const unsigned char *in, size_t inl)
209 # ifdef TEST_ENG_OPENSSL_RC4_P_CIPHER
210 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_cipher() called\n");
212 RC4(&test(ctx)->ks, inl, in, out);
216 static EVP_CIPHER *r4_cipher = NULL;
217 static const EVP_CIPHER *test_r4_cipher(void)
219 if (r4_cipher == NULL) {
222 if ((cipher = EVP_CIPHER_meth_new(NID_rc4, 1, TEST_RC4_KEY_SIZE)) == NULL
223 || !EVP_CIPHER_meth_set_iv_length(cipher, 0)
224 || !EVP_CIPHER_meth_set_flags(cipher, EVP_CIPH_VARIABLE_LENGTH)
225 || !EVP_CIPHER_meth_set_init(cipher, test_rc4_init_key)
226 || !EVP_CIPHER_meth_set_do_cipher(cipher, test_rc4_cipher)
227 || !EVP_CIPHER_meth_set_impl_ctx_size(cipher, sizeof(TEST_RC4_KEY))) {
228 EVP_CIPHER_meth_free(cipher);
235 static void test_r4_cipher_destroy(void)
237 EVP_CIPHER_meth_free(r4_cipher);
241 static EVP_CIPHER *r4_40_cipher = NULL;
242 static const EVP_CIPHER *test_r4_40_cipher(void)
244 if (r4_40_cipher == NULL) {
247 if ((cipher = EVP_CIPHER_meth_new(NID_rc4, 1, 5 /* 40 bits */)) == NULL
248 || !EVP_CIPHER_meth_set_iv_length(cipher, 0)
249 || !EVP_CIPHER_meth_set_flags(cipher, EVP_CIPH_VARIABLE_LENGTH)
250 || !EVP_CIPHER_meth_set_init(cipher, test_rc4_init_key)
251 || !EVP_CIPHER_meth_set_do_cipher(cipher, test_rc4_cipher)
252 || !EVP_CIPHER_meth_set_impl_ctx_size(cipher, sizeof(TEST_RC4_KEY))) {
253 EVP_CIPHER_meth_free(cipher);
256 r4_40_cipher = cipher;
260 static void test_r4_40_cipher_destroy(void)
262 EVP_CIPHER_meth_free(r4_40_cipher);
265 static int test_cipher_nids(const int **nids)
267 static int cipher_nids[4] = { 0, 0, 0, 0 };
272 const EVP_CIPHER *cipher;
273 if ((cipher = test_r4_cipher()) != NULL)
274 cipher_nids[pos++] = EVP_CIPHER_nid(cipher);
275 if ((cipher = test_r4_40_cipher()) != NULL)
276 cipher_nids[pos++] = EVP_CIPHER_nid(cipher);
277 cipher_nids[pos] = 0;
284 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
285 const int **nids, int nid)
288 /* We are returning a list of supported nids */
289 return test_cipher_nids(nids);
291 /* We are being asked for a specific cipher */
293 *cipher = test_r4_cipher();
294 else if (nid == NID_rc4_40)
295 *cipher = test_r4_40_cipher();
297 # ifdef TEST_ENG_OPENSSL_RC4_OTHERS
298 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) returning NULL for "
308 #ifdef TEST_ENG_OPENSSL_SHA
309 /* Much the same sort of comment as for TEST_ENG_OPENSSL_RC4 */
310 # include <openssl/sha.h>
312 static int test_sha1_init(EVP_MD_CTX *ctx)
314 # ifdef TEST_ENG_OPENSSL_SHA_P_INIT
315 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_init() called\n");
317 return SHA1_Init(EVP_MD_CTX_md_data(ctx));
320 static int test_sha1_update(EVP_MD_CTX *ctx, const void *data, size_t count)
322 # ifdef TEST_ENG_OPENSSL_SHA_P_UPDATE
323 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_update() called\n");
325 return SHA1_Update(EVP_MD_CTX_md_data(ctx), data, count);
328 static int test_sha1_final(EVP_MD_CTX *ctx, unsigned char *md)
330 # ifdef TEST_ENG_OPENSSL_SHA_P_FINAL
331 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_final() called\n");
333 return SHA1_Final(md, EVP_MD_CTX_md_data(ctx));
336 static EVP_MD *sha1_md = NULL;
337 static const EVP_MD *test_sha_md(void)
339 if (sha1_md == NULL) {
342 if ((md = EVP_MD_meth_new(NID_sha1, NID_sha1WithRSAEncryption)) == NULL
343 || !EVP_MD_meth_set_result_size(md, SHA_DIGEST_LENGTH)
344 || !EVP_MD_meth_set_input_blocksize(md, SHA_CBLOCK)
345 || !EVP_MD_meth_set_app_datasize(md,
346 sizeof(EVP_MD *) + sizeof(SHA_CTX))
347 || !EVP_MD_meth_set_flags(md, 0)
348 || !EVP_MD_meth_set_init(md, test_sha1_init)
349 || !EVP_MD_meth_set_update(md, test_sha1_update)
350 || !EVP_MD_meth_set_final(md, test_sha1_final)) {
351 EVP_MD_meth_free(md);
358 static void test_sha_md_destroy(void)
360 EVP_MD_meth_free(sha1_md);
363 static int test_digest_nids(const int **nids)
365 static int digest_nids[2] = { 0, 0 };
371 if ((md = test_sha_md()) != NULL)
372 digest_nids[pos++] = EVP_MD_type(md);
373 digest_nids[pos] = 0;
380 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
381 const int **nids, int nid)
384 /* We are returning a list of supported nids */
385 return test_digest_nids(nids);
387 /* We are being asked for a specific digest */
389 *digest = test_sha_md();
391 # ifdef TEST_ENG_OPENSSL_SHA_OTHERS
392 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) returning NULL for "
402 #ifdef TEST_ENG_OPENSSL_PKEY
403 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
404 UI_METHOD *ui_method,
409 fprintf(stderr, "(TEST_ENG_OPENSSL_PKEY)Loading Private key %s\n",
411 in = BIO_new_file(key_id, "r");
414 key = PEM_read_bio_PrivateKey(in, NULL, 0, NULL);
420 #ifdef TEST_ENG_OPENSSL_HMAC
423 * Experimental HMAC redirection implementation: mainly copied from
427 /* HMAC pkey context structure */
430 const EVP_MD *md; /* MD for HMAC use */
431 ASN1_OCTET_STRING ktmp; /* Temp storage for key */
433 } OSSL_HMAC_PKEY_CTX;
435 static int ossl_hmac_init(EVP_PKEY_CTX *ctx)
437 OSSL_HMAC_PKEY_CTX *hctx;
439 if ((hctx = OPENSSL_zalloc(sizeof(*hctx))) == NULL) {
440 ENGINEerr(ENGINE_F_OSSL_HMAC_INIT, ERR_R_MALLOC_FAILURE);
443 hctx->ktmp.type = V_ASN1_OCTET_STRING;
444 hctx->ctx = HMAC_CTX_new();
445 if (hctx->ctx == NULL) {
449 EVP_PKEY_CTX_set_data(ctx, hctx);
450 EVP_PKEY_CTX_set0_keygen_info(ctx, NULL, 0);
451 # ifdef TEST_ENG_OPENSSL_HMAC_INIT
452 fprintf(stderr, "(TEST_ENG_OPENSSL_HMAC) ossl_hmac_init() called\n");
457 static void ossl_hmac_cleanup(EVP_PKEY_CTX *ctx);
459 static int ossl_hmac_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
461 OSSL_HMAC_PKEY_CTX *sctx, *dctx;
463 /* allocate memory for dst->data and a new HMAC_CTX in dst->data->ctx */
464 if (!ossl_hmac_init(dst))
466 sctx = EVP_PKEY_CTX_get_data(src);
467 dctx = EVP_PKEY_CTX_get_data(dst);
469 if (!HMAC_CTX_copy(dctx->ctx, sctx->ctx))
471 if (sctx->ktmp.data) {
472 if (!ASN1_OCTET_STRING_set(&dctx->ktmp,
473 sctx->ktmp.data, sctx->ktmp.length))
478 /* release HMAC_CTX in dst->data->ctx and memory allocated for dst->data */
479 ossl_hmac_cleanup(dst);
483 static void ossl_hmac_cleanup(EVP_PKEY_CTX *ctx)
485 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
488 HMAC_CTX_free(hctx->ctx);
489 OPENSSL_clear_free(hctx->ktmp.data, hctx->ktmp.length);
491 EVP_PKEY_CTX_set_data(ctx, NULL);
495 static int ossl_hmac_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
497 ASN1_OCTET_STRING *hkey = NULL;
498 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
499 if (!hctx->ktmp.data)
501 hkey = ASN1_OCTET_STRING_dup(&hctx->ktmp);
504 EVP_PKEY_assign(pkey, EVP_PKEY_HMAC, hkey);
509 static int ossl_int_update(EVP_MD_CTX *ctx, const void *data, size_t count)
511 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(EVP_MD_CTX_pkey_ctx(ctx));
512 if (!HMAC_Update(hctx->ctx, data, count))
517 static int ossl_hmac_signctx_init(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx)
519 EVP_MD_CTX_set_flags(mctx, EVP_MD_CTX_FLAG_NO_INIT);
520 EVP_MD_CTX_set_update_fn(mctx, ossl_int_update);
524 static int ossl_hmac_signctx(EVP_PKEY_CTX *ctx, unsigned char *sig,
525 size_t *siglen, EVP_MD_CTX *mctx)
528 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
529 int l = EVP_MD_CTX_size(mctx);
537 if (!HMAC_Final(hctx->ctx, sig, &hlen))
539 *siglen = (size_t)hlen;
543 static int ossl_hmac_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
545 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
547 ASN1_OCTET_STRING *key;
550 case EVP_PKEY_CTRL_SET_MAC_KEY:
551 if ((!p2 && p1 > 0) || (p1 < -1))
553 if (!ASN1_OCTET_STRING_set(&hctx->ktmp, p2, p1))
557 case EVP_PKEY_CTRL_MD:
561 case EVP_PKEY_CTRL_DIGESTINIT:
562 pk = EVP_PKEY_CTX_get0_pkey(ctx);
563 key = EVP_PKEY_get0(pk);
564 if (!HMAC_Init_ex(hctx->ctx, key->data, key->length, hctx->md, NULL))
575 static int ossl_hmac_ctrl_str(EVP_PKEY_CTX *ctx,
576 const char *type, const char *value)
581 if (strcmp(type, "key") == 0) {
582 void *p = (void *)value;
583 return ossl_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, -1, p);
585 if (strcmp(type, "hexkey") == 0) {
589 key = OPENSSL_hexstr2buf(value, &keylen);
592 r = ossl_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, keylen, key);
599 static EVP_PKEY_METHOD *ossl_hmac_meth;
601 static int ossl_register_hmac_meth(void)
603 EVP_PKEY_METHOD *meth;
604 meth = EVP_PKEY_meth_new(EVP_PKEY_HMAC, 0);
607 EVP_PKEY_meth_set_init(meth, ossl_hmac_init);
608 EVP_PKEY_meth_set_copy(meth, ossl_hmac_copy);
609 EVP_PKEY_meth_set_cleanup(meth, ossl_hmac_cleanup);
611 EVP_PKEY_meth_set_keygen(meth, 0, ossl_hmac_keygen);
613 EVP_PKEY_meth_set_signctx(meth, ossl_hmac_signctx_init,
616 EVP_PKEY_meth_set_ctrl(meth, ossl_hmac_ctrl, ossl_hmac_ctrl_str);
617 ossl_hmac_meth = meth;
621 static int ossl_pkey_meths(ENGINE *e, EVP_PKEY_METHOD **pmeth,
622 const int **nids, int nid)
624 static int ossl_pkey_nids[] = {
629 *nids = ossl_pkey_nids;
633 if (nid == EVP_PKEY_HMAC) {
634 *pmeth = ossl_hmac_meth;
644 int openssl_destroy(ENGINE *e)
646 test_sha_md_destroy();
647 #ifdef TEST_ENG_OPENSSL_RC4
648 test_r4_cipher_destroy();
649 test_r4_40_cipher_destroy();