2 * Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* We need to use some deprecated APIs */
11 #define OPENSSL_SUPPRESS_DEPRECATED
16 #include <openssl/e_os2.h>
18 # include "testutil.h"
20 #ifndef OPENSSL_NO_ENGINE
21 # include <openssl/buffer.h>
22 # include <openssl/crypto.h>
23 # include <openssl/engine.h>
24 # include <openssl/rsa.h>
25 # include <openssl/err.h>
26 # include <openssl/x509.h>
27 # include <openssl/pem.h>
29 static void display_engine_list(void)
35 for (h
= ENGINE_get_first(); h
!= NULL
; h
= ENGINE_get_next(h
)) {
36 TEST_info("#%d: id = \"%s\", name = \"%s\"",
37 loop
++, ENGINE_get_id(h
), ENGINE_get_name(h
));
41 * ENGINE_get_first() increases the struct_ref counter, so we must call
42 * ENGINE_free() to decrease it again
49 static int test_engines(void)
51 ENGINE
*block
[NUMTOADD
];
53 char *ename
[NUMTOADD
];
58 ENGINE
*new_h1
= NULL
;
59 ENGINE
*new_h2
= NULL
;
60 ENGINE
*new_h3
= NULL
;
61 ENGINE
*new_h4
= NULL
;
63 memset(block
, 0, sizeof(block
));
64 if (!TEST_ptr(new_h1
= ENGINE_new())
65 || !TEST_true(ENGINE_set_id(new_h1
, "test_id0"))
66 || !TEST_true(ENGINE_set_name(new_h1
, "First test item"))
67 || !TEST_ptr(new_h2
= ENGINE_new())
68 || !TEST_true(ENGINE_set_id(new_h2
, "test_id1"))
69 || !TEST_true(ENGINE_set_name(new_h2
, "Second test item"))
70 || !TEST_ptr(new_h3
= ENGINE_new())
71 || !TEST_true(ENGINE_set_id(new_h3
, "test_id2"))
72 || !TEST_true(ENGINE_set_name(new_h3
, "Third test item"))
73 || !TEST_ptr(new_h4
= ENGINE_new())
74 || !TEST_true(ENGINE_set_id(new_h4
, "test_id3"))
75 || !TEST_true(ENGINE_set_name(new_h4
, "Fourth test item")))
77 TEST_info("Engines:");
78 display_engine_list();
80 if (!TEST_true(ENGINE_add(new_h1
)))
82 TEST_info("Engines:");
83 display_engine_list();
85 ptr
= ENGINE_get_first();
86 if (!TEST_true(ENGINE_remove(ptr
)))
89 TEST_info("Engines:");
90 display_engine_list();
92 if (!TEST_true(ENGINE_add(new_h3
))
93 || !TEST_true(ENGINE_add(new_h2
)))
95 TEST_info("Engines:");
96 display_engine_list();
98 if (!TEST_true(ENGINE_remove(new_h2
)))
100 TEST_info("Engines:");
101 display_engine_list();
103 if (!TEST_true(ENGINE_add(new_h4
)))
105 TEST_info("Engines:");
106 display_engine_list();
109 if (!TEST_false(ENGINE_add(new_h3
)))
114 if (!TEST_false(ENGINE_remove(new_h2
)))
118 if (!TEST_true(ENGINE_remove(new_h3
)))
120 TEST_info("Engines:");
121 display_engine_list();
123 if (!TEST_true(ENGINE_remove(new_h4
)))
125 TEST_info("Engines:");
126 display_engine_list();
129 * At this point, we should have an empty list, unless some hardware
130 * support engine got added. However, since we don't allow the config
131 * file to be loaded and don't otherwise load any built in engines,
132 * that is unlikely. Still, we check, if for nothing else, then to
133 * notify that something is a little off (and might mean that |new_h1|
134 * wasn't unloaded when it should have)
136 if ((ptr
= ENGINE_get_first()) != NULL
) {
137 if (!ENGINE_remove(ptr
))
138 TEST_info("Remove failed - probably no hardware support present");
141 TEST_info("Engines:");
142 display_engine_list();
144 if (!TEST_true(ENGINE_add(new_h1
))
145 || !TEST_true(ENGINE_remove(new_h1
)))
148 TEST_info("About to beef up the engine-type list");
149 for (loop
= 0; loop
< NUMTOADD
; loop
++) {
150 sprintf(buf
, "id%d", loop
);
151 eid
[loop
] = OPENSSL_strdup(buf
);
152 sprintf(buf
, "Fake engine type %d", loop
);
153 ename
[loop
] = OPENSSL_strdup(buf
);
154 if (!TEST_ptr(block
[loop
] = ENGINE_new())
155 || !TEST_true(ENGINE_set_id(block
[loop
], eid
[loop
]))
156 || !TEST_true(ENGINE_set_name(block
[loop
], ename
[loop
])))
159 for (loop
= 0; loop
< NUMTOADD
; loop
++) {
160 if (!TEST_true(ENGINE_add(block
[loop
]))) {
161 test_note("Adding stopped at %d, (%s,%s)",
162 loop
, ENGINE_get_id(block
[loop
]),
163 ENGINE_get_name(block
[loop
]));
168 TEST_info("About to empty the engine-type list");
169 while ((ptr
= ENGINE_get_first()) != NULL
) {
170 if (!TEST_true(ENGINE_remove(ptr
)))
174 for (loop
= 0; loop
< NUMTOADD
; loop
++) {
175 OPENSSL_free(eid
[loop
]);
176 OPENSSL_free(ename
[loop
]);
185 for (loop
= 0; loop
< NUMTOADD
; loop
++)
186 ENGINE_free(block
[loop
]);
190 /* Test EVP_PKEY method */
191 static EVP_PKEY_METHOD
*test_rsa
= NULL
;
193 static int called_encrypt
= 0;
195 /* Test function to check operation has been redirected */
196 static int test_encrypt(EVP_PKEY_CTX
*ctx
, unsigned char *sig
,
197 size_t *siglen
, const unsigned char *tbs
, size_t tbslen
)
203 static int test_pkey_meths(ENGINE
*e
, EVP_PKEY_METHOD
**pmeth
,
204 const int **pnids
, int nid
)
206 static const int rnid
= EVP_PKEY_RSA
;
212 if (nid
== EVP_PKEY_RSA
) {
221 /* Return a test EVP_PKEY value */
223 static EVP_PKEY
*get_test_pkey(void)
225 static unsigned char n
[] =
226 "\x00\xAA\x36\xAB\xCE\x88\xAC\xFD\xFF\x55\x52\x3C\x7F\xC4\x52\x3F"
227 "\x90\xEF\xA0\x0D\xF3\x77\x4A\x25\x9F\x2E\x62\xB4\xC5\xD9\x9C\xB5"
228 "\xAD\xB3\x00\xA0\x28\x5E\x53\x01\x93\x0E\x0C\x70\xFB\x68\x76\x93"
229 "\x9C\xE6\x16\xCE\x62\x4A\x11\xE0\x08\x6D\x34\x1E\xBC\xAC\xA0\xA1"
231 static unsigned char e
[] = "\x11";
233 RSA
*rsa
= RSA_new();
234 EVP_PKEY
*pk
= EVP_PKEY_new();
236 if (rsa
== NULL
|| pk
== NULL
|| !EVP_PKEY_assign_RSA(pk
, rsa
)) {
242 if (!RSA_set0_key(rsa
, BN_bin2bn(n
, sizeof(n
)-1, NULL
),
243 BN_bin2bn(e
, sizeof(e
)-1, NULL
), NULL
)) {
251 static int test_redirect(void)
253 const unsigned char pt
[] = "Hello World\n";
254 unsigned char *tmp
= NULL
;
256 EVP_PKEY_CTX
*ctx
= NULL
;
258 EVP_PKEY
*pkey
= NULL
;
262 if (!TEST_ptr(pkey
= get_test_pkey()))
265 len
= EVP_PKEY_get_size(pkey
);
266 if (!TEST_ptr(tmp
= OPENSSL_malloc(len
)))
269 if (!TEST_ptr(ctx
= EVP_PKEY_CTX_new(pkey
, NULL
)))
271 TEST_info("EVP_PKEY_encrypt test: no redirection");
272 /* Encrypt some data: should succeed but not be redirected */
273 if (!TEST_int_gt(EVP_PKEY_encrypt_init(ctx
), 0)
274 || !TEST_int_gt(EVP_PKEY_encrypt(ctx
, tmp
, &len
, pt
, sizeof(pt
)), 0)
275 || !TEST_false(called_encrypt
))
277 EVP_PKEY_CTX_free(ctx
);
280 /* Create a test ENGINE */
281 if (!TEST_ptr(e
= ENGINE_new())
282 || !TEST_true(ENGINE_set_id(e
, "Test redirect engine"))
283 || !TEST_true(ENGINE_set_name(e
, "Test redirect engine")))
287 * Try to create a context for this engine and test key.
288 * Try setting test key engine. Both should fail because the
289 * engine has no public key methods.
291 if (!TEST_ptr_null(ctx
= EVP_PKEY_CTX_new(pkey
, e
))
292 || !TEST_int_le(EVP_PKEY_set1_engine(pkey
, e
), 0))
295 /* Setup an empty test EVP_PKEY_METHOD and set callback to return it */
296 if (!TEST_ptr(test_rsa
= EVP_PKEY_meth_new(EVP_PKEY_RSA
, 0)))
298 ENGINE_set_pkey_meths(e
, test_pkey_meths
);
300 /* Getting a context for test ENGINE should now succeed */
301 if (!TEST_ptr(ctx
= EVP_PKEY_CTX_new(pkey
, e
)))
303 /* Encrypt should fail because operation is not supported */
304 if (!TEST_int_le(EVP_PKEY_encrypt_init(ctx
), 0))
306 EVP_PKEY_CTX_free(ctx
);
309 /* Add test encrypt operation to method */
310 EVP_PKEY_meth_set_encrypt(test_rsa
, 0, test_encrypt
);
312 TEST_info("EVP_PKEY_encrypt test: redirection via EVP_PKEY_CTX_new()");
313 if (!TEST_ptr(ctx
= EVP_PKEY_CTX_new(pkey
, e
)))
315 /* Encrypt some data: should succeed and be redirected */
316 if (!TEST_int_gt(EVP_PKEY_encrypt_init(ctx
), 0)
317 || !TEST_int_gt(EVP_PKEY_encrypt(ctx
, tmp
, &len
, pt
, sizeof(pt
)), 0)
318 || !TEST_true(called_encrypt
))
321 EVP_PKEY_CTX_free(ctx
);
325 /* Create context with default engine: should not be redirected */
326 if (!TEST_ptr(ctx
= EVP_PKEY_CTX_new(pkey
, NULL
))
327 || !TEST_int_gt(EVP_PKEY_encrypt_init(ctx
), 0)
328 || !TEST_int_gt(EVP_PKEY_encrypt(ctx
, tmp
, &len
, pt
, sizeof(pt
)), 0)
329 || !TEST_false(called_encrypt
))
332 EVP_PKEY_CTX_free(ctx
);
335 /* Set engine explicitly for test key */
336 if (!TEST_true(EVP_PKEY_set1_engine(pkey
, e
)))
339 TEST_info("EVP_PKEY_encrypt test: redirection via EVP_PKEY_set1_engine()");
341 /* Create context with default engine: should be redirected now */
342 if (!TEST_ptr(ctx
= EVP_PKEY_CTX_new(pkey
, NULL
))
343 || !TEST_int_gt(EVP_PKEY_encrypt_init(ctx
), 0)
344 || !TEST_int_gt(EVP_PKEY_encrypt(ctx
, tmp
, &len
, pt
, sizeof(pt
)), 0)
345 || !TEST_true(called_encrypt
))
351 EVP_PKEY_CTX_free(ctx
);
358 static int test_x509_dup_w_engine(void)
361 X509
*cert
= NULL
, *dupcert
= NULL
;
362 X509_PUBKEY
*pubkey
, *duppubkey
= NULL
;
365 RSA_METHOD
*rsameth
= NULL
;
367 if (!TEST_ptr(b
= BIO_new_file(test_get_argument(0), "r"))
368 || !TEST_ptr(cert
= PEM_read_bio_X509(b
, NULL
, NULL
, NULL
)))
371 /* Dup without an engine */
372 if (!TEST_ptr(dupcert
= X509_dup(cert
)))
377 if (!TEST_ptr(pubkey
= X509_get_X509_PUBKEY(cert
))
378 || !TEST_ptr(duppubkey
= X509_PUBKEY_dup(pubkey
))
379 || !TEST_ptr_ne(duppubkey
, pubkey
)
380 || !TEST_ptr_ne(X509_PUBKEY_get0(duppubkey
), X509_PUBKEY_get0(pubkey
)))
383 X509_PUBKEY_free(duppubkey
);
389 /* Create a test ENGINE */
390 if (!TEST_ptr(e
= ENGINE_new())
391 || !TEST_true(ENGINE_set_id(e
, "Test dummy engine"))
392 || !TEST_true(ENGINE_set_name(e
, "Test dummy engine")))
395 if (!TEST_ptr(rsameth
= RSA_meth_dup(RSA_get_default_method())))
398 ENGINE_set_RSA(e
, rsameth
);
400 if (!TEST_true(ENGINE_set_default_RSA(e
)))
403 if (!TEST_int_ge(BIO_seek(b
, 0), 0)
404 || !TEST_ptr(cert
= PEM_read_bio_X509(b
, NULL
, NULL
, NULL
)))
407 /* Dup with an engine set on the key */
408 if (!TEST_ptr(dupcert
= X509_dup(cert
)))
411 if (!TEST_ptr(pubkey
= X509_get_X509_PUBKEY(cert
))
412 || !TEST_ptr(duppubkey
= X509_PUBKEY_dup(pubkey
))
413 || !TEST_ptr_ne(duppubkey
, pubkey
)
414 || !TEST_ptr_ne(X509_PUBKEY_get0(duppubkey
), X509_PUBKEY_get0(pubkey
)))
422 X509_PUBKEY_free(duppubkey
);
424 ENGINE_unregister_RSA(e
);
427 RSA_meth_free(rsameth
);
433 int global_init(void)
436 * If the config file gets loaded, the dynamic engine will be loaded,
437 * and that interferes with our test above.
439 return OPENSSL_init_crypto(OPENSSL_INIT_NO_LOAD_CONFIG
, NULL
);
442 OPT_TEST_DECLARE_USAGE("certfile\n")
444 int setup_tests(void)
446 #ifdef OPENSSL_NO_ENGINE
447 TEST_note("No ENGINE support");
451 if (!test_skip_common_options()) {
452 TEST_error("Error parsing test options\n");
456 n
= test_get_argument_count();
460 ADD_TEST(test_engines
);
461 ADD_TEST(test_redirect
);
462 ADD_TEST(test_x509_dup_w_engine
);