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 OpenSSL license (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 #define TEST_ENG_OPENSSL_RC4_P_INIT
38 /* #define TEST_ENG_OPENSSL_RC4_P_CIPHER */
39 #define TEST_ENG_OPENSSL_SHA
40 /* #define TEST_ENG_OPENSSL_SHA_OTHERS */
41 /* #define TEST_ENG_OPENSSL_SHA_P_INIT */
42 /* #define TEST_ENG_OPENSSL_SHA_P_UPDATE */
43 /* #define TEST_ENG_OPENSSL_SHA_P_FINAL */
45 /* Now check what of those algorithms are actually enabled */
47 # undef TEST_ENG_OPENSSL_RC4
48 # undef TEST_ENG_OPENSSL_RC4_OTHERS
49 # undef TEST_ENG_OPENSSL_RC4_P_INIT
50 # undef TEST_ENG_OPENSSL_RC4_P_CIPHER
53 static int openssl_destroy(ENGINE *e);
55 #ifdef TEST_ENG_OPENSSL_RC4
56 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
57 const int **nids, int nid);
59 #ifdef TEST_ENG_OPENSSL_SHA
60 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
61 const int **nids, int nid);
64 #ifdef TEST_ENG_OPENSSL_PKEY
65 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
70 #ifdef TEST_ENG_OPENSSL_HMAC
71 static int ossl_register_hmac_meth(void);
72 static int ossl_pkey_meths(ENGINE *e, EVP_PKEY_METHOD **pmeth,
73 const int **nids, int nid);
76 /* The constants used when creating the ENGINE */
77 static const char *engine_openssl_id = "openssl";
78 static const char *engine_openssl_name = "Software engine support";
81 * This internal function is used by ENGINE_openssl() and possibly by the
82 * "dynamic" ENGINE support too
84 static int bind_helper(ENGINE *e)
86 if (!ENGINE_set_id(e, engine_openssl_id)
87 || !ENGINE_set_name(e, engine_openssl_name)
88 || !ENGINE_set_destroy_function(e, openssl_destroy)
89 #ifndef TEST_ENG_OPENSSL_NO_ALGORITHMS
90 # ifndef OPENSSL_NO_RSA
91 || !ENGINE_set_RSA(e, RSA_get_default_method())
93 # ifndef OPENSSL_NO_DSA
94 || !ENGINE_set_DSA(e, DSA_get_default_method())
96 # ifndef OPENSSL_NO_EC
97 || !ENGINE_set_EC(e, EC_KEY_OpenSSL())
99 # ifndef OPENSSL_NO_DH
100 || !ENGINE_set_DH(e, DH_get_default_method())
102 || !ENGINE_set_RAND(e, RAND_OpenSSL())
103 # ifdef TEST_ENG_OPENSSL_RC4
104 || !ENGINE_set_ciphers(e, openssl_ciphers)
106 # ifdef TEST_ENG_OPENSSL_SHA
107 || !ENGINE_set_digests(e, openssl_digests)
110 #ifdef TEST_ENG_OPENSSL_PKEY
111 || !ENGINE_set_load_privkey_function(e, openssl_load_privkey)
113 #ifdef TEST_ENG_OPENSSL_HMAC
114 || !ossl_register_hmac_meth()
115 || !ENGINE_set_pkey_meths(e, ossl_pkey_meths)
120 * If we add errors to this ENGINE, ensure the error handling is setup
123 /* openssl_load_error_strings(); */
127 static ENGINE *engine_openssl(void)
129 ENGINE *ret = ENGINE_new();
132 if (!bind_helper(ret)) {
139 void engine_load_openssl_int(void)
141 ENGINE *toadd = engine_openssl();
146 * If the "add" worked, it gets a structural reference. So either way, we
147 * release our just-created reference.
154 * This stuff is needed if this ENGINE is being compiled into a
155 * self-contained shared-library.
157 #ifdef ENGINE_DYNAMIC_SUPPORT
158 static int bind_fn(ENGINE *e, const char *id)
160 if (id && (strcmp(id, engine_openssl_id) != 0))
167 IMPLEMENT_DYNAMIC_CHECK_FN()
168 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
169 #endif /* ENGINE_DYNAMIC_SUPPORT */
170 #ifdef TEST_ENG_OPENSSL_RC4
172 * This section of code compiles an "alternative implementation" of two modes of
173 * RC4 into this ENGINE. The result is that EVP_CIPHER operation for "rc4"
174 * should under normal circumstances go via this support rather than the default
175 * EVP support. There are other symbols to tweak the testing;
176 * TEST_ENC_OPENSSL_RC4_OTHERS - print a one line message to stderr each time
177 * we're asked for a cipher we don't support (should not happen).
178 * TEST_ENG_OPENSSL_RC4_P_INIT - print a one line message to stderr each time
179 * the "init_key" handler is called.
180 * TEST_ENG_OPENSSL_RC4_P_CIPHER - ditto for the "cipher" handler.
182 # include <openssl/rc4.h>
183 # define TEST_RC4_KEY_SIZE 16
185 unsigned char key[TEST_RC4_KEY_SIZE];
188 # define test(ctx) ((TEST_RC4_KEY *)EVP_CIPHER_CTX_get_cipher_data(ctx))
189 static int test_rc4_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
190 const unsigned char *iv, int enc)
192 # ifdef TEST_ENG_OPENSSL_RC4_P_INIT
193 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_init_key() called\n");
195 memcpy(&test(ctx)->key[0], key, EVP_CIPHER_CTX_key_length(ctx));
196 RC4_set_key(&test(ctx)->ks, EVP_CIPHER_CTX_key_length(ctx),
201 static int test_rc4_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
202 const unsigned char *in, size_t inl)
204 # ifdef TEST_ENG_OPENSSL_RC4_P_CIPHER
205 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) test_cipher() called\n");
207 RC4(&test(ctx)->ks, inl, in, out);
211 static EVP_CIPHER *r4_cipher = NULL;
212 static const EVP_CIPHER *test_r4_cipher(void)
214 if (r4_cipher == NULL) {
217 if ((cipher = EVP_CIPHER_meth_new(NID_rc4, 1, TEST_RC4_KEY_SIZE)) == NULL
218 || !EVP_CIPHER_meth_set_iv_length(cipher, 0)
219 || !EVP_CIPHER_meth_set_flags(cipher, EVP_CIPH_VARIABLE_LENGTH)
220 || !EVP_CIPHER_meth_set_init(cipher, test_rc4_init_key)
221 || !EVP_CIPHER_meth_set_do_cipher(cipher, test_rc4_cipher)
222 || !EVP_CIPHER_meth_set_impl_ctx_size(cipher, sizeof(TEST_RC4_KEY))) {
223 EVP_CIPHER_meth_free(cipher);
230 static void test_r4_cipher_destroy(void)
232 EVP_CIPHER_meth_free(r4_cipher);
236 static EVP_CIPHER *r4_40_cipher = NULL;
237 static const EVP_CIPHER *test_r4_40_cipher(void)
239 if (r4_40_cipher == NULL) {
242 if ((cipher = EVP_CIPHER_meth_new(NID_rc4, 1, 5 /* 40 bits */)) == NULL
243 || !EVP_CIPHER_meth_set_iv_length(cipher, 0)
244 || !EVP_CIPHER_meth_set_flags(cipher, EVP_CIPH_VARIABLE_LENGTH)
245 || !EVP_CIPHER_meth_set_init(cipher, test_rc4_init_key)
246 || !EVP_CIPHER_meth_set_do_cipher(cipher, test_rc4_cipher)
247 || !EVP_CIPHER_meth_set_impl_ctx_size(cipher, sizeof(TEST_RC4_KEY))) {
248 EVP_CIPHER_meth_free(cipher);
251 r4_40_cipher = cipher;
255 static void test_r4_40_cipher_destroy(void)
257 EVP_CIPHER_meth_free(r4_40_cipher);
260 static int test_cipher_nids(const int **nids)
262 static int cipher_nids[4] = { 0, 0, 0, 0 };
267 const EVP_CIPHER *cipher;
268 if ((cipher = test_r4_cipher()) != NULL)
269 cipher_nids[pos++] = EVP_CIPHER_nid(cipher);
270 if ((cipher = test_r4_40_cipher()) != NULL)
271 cipher_nids[pos++] = EVP_CIPHER_nid(cipher);
272 cipher_nids[pos] = 0;
279 static int openssl_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
280 const int **nids, int nid)
283 /* We are returning a list of supported nids */
284 return test_cipher_nids(nids);
286 /* We are being asked for a specific cipher */
288 *cipher = test_r4_cipher();
289 else if (nid == NID_rc4_40)
290 *cipher = test_r4_40_cipher();
292 # ifdef TEST_ENG_OPENSSL_RC4_OTHERS
293 fprintf(stderr, "(TEST_ENG_OPENSSL_RC4) returning NULL for "
303 #ifdef TEST_ENG_OPENSSL_SHA
304 /* Much the same sort of comment as for TEST_ENG_OPENSSL_RC4 */
305 # include <openssl/sha.h>
307 static int test_sha1_init(EVP_MD_CTX *ctx)
309 # ifdef TEST_ENG_OPENSSL_SHA_P_INIT
310 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_init() called\n");
312 return SHA1_Init(EVP_MD_CTX_md_data(ctx));
315 static int test_sha1_update(EVP_MD_CTX *ctx, const void *data, size_t count)
317 # ifdef TEST_ENG_OPENSSL_SHA_P_UPDATE
318 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_update() called\n");
320 return SHA1_Update(EVP_MD_CTX_md_data(ctx), data, count);
323 static int test_sha1_final(EVP_MD_CTX *ctx, unsigned char *md)
325 # ifdef TEST_ENG_OPENSSL_SHA_P_FINAL
326 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) test_sha1_final() called\n");
328 return SHA1_Final(md, EVP_MD_CTX_md_data(ctx));
331 static EVP_MD *sha1_md = NULL;
332 static const EVP_MD *test_sha_md(void)
334 if (sha1_md == NULL) {
337 if ((md = EVP_MD_meth_new(NID_sha1, NID_sha1WithRSAEncryption)) == NULL
338 || !EVP_MD_meth_set_result_size(md, SHA_DIGEST_LENGTH)
339 || !EVP_MD_meth_set_input_blocksize(md, SHA_CBLOCK)
340 || !EVP_MD_meth_set_app_datasize(md,
341 sizeof(EVP_MD *) + sizeof(SHA_CTX))
342 || !EVP_MD_meth_set_flags(md, 0)
343 || !EVP_MD_meth_set_init(md, test_sha1_init)
344 || !EVP_MD_meth_set_update(md, test_sha1_update)
345 || !EVP_MD_meth_set_final(md, test_sha1_final)) {
346 EVP_MD_meth_free(md);
353 static void test_sha_md_destroy(void)
355 EVP_MD_meth_free(sha1_md);
358 static int test_digest_nids(const int **nids)
360 static int digest_nids[2] = { 0, 0 };
366 if ((md = test_sha_md()) != NULL)
367 digest_nids[pos++] = EVP_MD_type(md);
368 digest_nids[pos] = 0;
375 static int openssl_digests(ENGINE *e, const EVP_MD **digest,
376 const int **nids, int nid)
379 /* We are returning a list of supported nids */
380 return test_digest_nids(nids);
382 /* We are being asked for a specific digest */
384 *digest = test_sha_md();
386 # ifdef TEST_ENG_OPENSSL_SHA_OTHERS
387 fprintf(stderr, "(TEST_ENG_OPENSSL_SHA) returning NULL for "
397 #ifdef TEST_ENG_OPENSSL_PKEY
398 static EVP_PKEY *openssl_load_privkey(ENGINE *eng, const char *key_id,
399 UI_METHOD *ui_method,
404 fprintf(stderr, "(TEST_ENG_OPENSSL_PKEY)Loading Private key %s\n",
406 in = BIO_new_file(key_id, "r");
409 key = PEM_read_bio_PrivateKey(in, NULL, 0, NULL);
415 #ifdef TEST_ENG_OPENSSL_HMAC
418 * Experimental HMAC redirection implementation: mainly copied from
422 /* HMAC pkey context structure */
425 const EVP_MD *md; /* MD for HMAC use */
426 ASN1_OCTET_STRING ktmp; /* Temp storage for key */
428 } OSSL_HMAC_PKEY_CTX;
430 static int ossl_hmac_init(EVP_PKEY_CTX *ctx)
432 OSSL_HMAC_PKEY_CTX *hctx;
434 if ((hctx = OPENSSL_zalloc(sizeof(*hctx))) == NULL) {
435 ENGINEerr(ENGINE_F_OSSL_HMAC_INIT, ERR_R_MALLOC_FAILURE);
438 hctx->ktmp.type = V_ASN1_OCTET_STRING;
439 hctx->ctx = HMAC_CTX_new();
440 if (hctx->ctx == NULL) {
444 EVP_PKEY_CTX_set_data(ctx, hctx);
445 EVP_PKEY_CTX_set0_keygen_info(ctx, NULL, 0);
446 # ifdef TEST_ENG_OPENSSL_HMAC_INIT
447 fprintf(stderr, "(TEST_ENG_OPENSSL_HMAC) ossl_hmac_init() called\n");
452 static void ossl_hmac_cleanup(EVP_PKEY_CTX *ctx);
454 static int ossl_hmac_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
456 OSSL_HMAC_PKEY_CTX *sctx, *dctx;
458 /* allocate memory for dst->data and a new HMAC_CTX in dst->data->ctx */
459 if (!ossl_hmac_init(dst))
461 sctx = EVP_PKEY_CTX_get_data(src);
462 dctx = EVP_PKEY_CTX_get_data(dst);
464 if (!HMAC_CTX_copy(dctx->ctx, sctx->ctx))
466 if (sctx->ktmp.data) {
467 if (!ASN1_OCTET_STRING_set(&dctx->ktmp,
468 sctx->ktmp.data, sctx->ktmp.length))
473 /* release HMAC_CTX in dst->data->ctx and memory allocated for dst->data */
474 ossl_hmac_cleanup(dst);
478 static void ossl_hmac_cleanup(EVP_PKEY_CTX *ctx)
480 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
483 HMAC_CTX_free(hctx->ctx);
484 OPENSSL_clear_free(hctx->ktmp.data, hctx->ktmp.length);
486 EVP_PKEY_CTX_set_data(ctx, NULL);
490 static int ossl_hmac_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
492 ASN1_OCTET_STRING *hkey = NULL;
493 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
494 if (!hctx->ktmp.data)
496 hkey = ASN1_OCTET_STRING_dup(&hctx->ktmp);
499 EVP_PKEY_assign(pkey, EVP_PKEY_HMAC, hkey);
504 static int ossl_int_update(EVP_MD_CTX *ctx, const void *data, size_t count)
506 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(EVP_MD_CTX_pkey_ctx(ctx));
507 if (!HMAC_Update(hctx->ctx, data, count))
512 static int ossl_hmac_signctx_init(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx)
514 EVP_MD_CTX_set_flags(mctx, EVP_MD_CTX_FLAG_NO_INIT);
515 EVP_MD_CTX_set_update_fn(mctx, ossl_int_update);
519 static int ossl_hmac_signctx(EVP_PKEY_CTX *ctx, unsigned char *sig,
520 size_t *siglen, EVP_MD_CTX *mctx)
523 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
524 int l = EVP_MD_CTX_size(mctx);
532 if (!HMAC_Final(hctx->ctx, sig, &hlen))
534 *siglen = (size_t)hlen;
538 static int ossl_hmac_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
540 OSSL_HMAC_PKEY_CTX *hctx = EVP_PKEY_CTX_get_data(ctx);
542 ASN1_OCTET_STRING *key;
545 case EVP_PKEY_CTRL_SET_MAC_KEY:
546 if ((!p2 && p1 > 0) || (p1 < -1))
548 if (!ASN1_OCTET_STRING_set(&hctx->ktmp, p2, p1))
552 case EVP_PKEY_CTRL_MD:
556 case EVP_PKEY_CTRL_DIGESTINIT:
557 pk = EVP_PKEY_CTX_get0_pkey(ctx);
558 key = EVP_PKEY_get0(pk);
559 if (!HMAC_Init_ex(hctx->ctx, key->data, key->length, hctx->md, NULL))
570 static int ossl_hmac_ctrl_str(EVP_PKEY_CTX *ctx,
571 const char *type, const char *value)
576 if (strcmp(type, "key") == 0) {
577 void *p = (void *)value;
578 return ossl_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, -1, p);
580 if (strcmp(type, "hexkey") == 0) {
584 key = OPENSSL_hexstr2buf(value, &keylen);
587 r = ossl_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, keylen, key);
594 static EVP_PKEY_METHOD *ossl_hmac_meth;
596 static int ossl_register_hmac_meth(void)
598 EVP_PKEY_METHOD *meth;
599 meth = EVP_PKEY_meth_new(EVP_PKEY_HMAC, 0);
602 EVP_PKEY_meth_set_init(meth, ossl_hmac_init);
603 EVP_PKEY_meth_set_copy(meth, ossl_hmac_copy);
604 EVP_PKEY_meth_set_cleanup(meth, ossl_hmac_cleanup);
606 EVP_PKEY_meth_set_keygen(meth, 0, ossl_hmac_keygen);
608 EVP_PKEY_meth_set_signctx(meth, ossl_hmac_signctx_init,
611 EVP_PKEY_meth_set_ctrl(meth, ossl_hmac_ctrl, ossl_hmac_ctrl_str);
612 ossl_hmac_meth = meth;
616 static int ossl_pkey_meths(ENGINE *e, EVP_PKEY_METHOD **pmeth,
617 const int **nids, int nid)
619 static int ossl_pkey_nids[] = {
624 *nids = ossl_pkey_nids;
628 if (nid == EVP_PKEY_HMAC) {
629 *pmeth = ossl_hmac_meth;
639 int openssl_destroy(ENGINE *e)
641 test_sha_md_destroy();
642 #ifdef TEST_ENG_OPENSSL_RC4
643 test_r4_cipher_destroy();
644 test_r4_40_cipher_destroy();