1*e7be843bSPierre Pronchery /*
2*e7be843bSPierre Pronchery * Copyright 2023-2025 The OpenSSL Project Authors. All Rights Reserved.
3*e7be843bSPierre Pronchery *
4*e7be843bSPierre Pronchery * Licensed under the Apache License 2.0 (the "License"). You may not use
5*e7be843bSPierre Pronchery * this file except in compliance with the License. You can obtain a copy
6*e7be843bSPierre Pronchery * in the file LICENSE in the source distribution or at
7*e7be843bSPierre Pronchery * https://www.openssl.org/source/license.html
8*e7be843bSPierre Pronchery */
9*e7be843bSPierre Pronchery
10*e7be843bSPierre Pronchery #include <openssl/pem.h>
11*e7be843bSPierre Pronchery #include <openssl/core_names.h>
12*e7be843bSPierre Pronchery #include <openssl/self_test.h>
13*e7be843bSPierre Pronchery #include "testutil.h"
14*e7be843bSPierre Pronchery
15*e7be843bSPierre Pronchery typedef enum OPTION_choice {
16*e7be843bSPierre Pronchery OPT_ERR = -1,
17*e7be843bSPierre Pronchery OPT_EOF = 0,
18*e7be843bSPierre Pronchery OPT_PROVIDER_NAME,
19*e7be843bSPierre Pronchery OPT_CONFIG_FILE,
20*e7be843bSPierre Pronchery OPT_PAIRWISETEST,
21*e7be843bSPierre Pronchery OPT_DSAPARAM,
22*e7be843bSPierre Pronchery OPT_TEST_ENUM
23*e7be843bSPierre Pronchery } OPTION_CHOICE;
24*e7be843bSPierre Pronchery
25*e7be843bSPierre Pronchery struct self_test_arg {
26*e7be843bSPierre Pronchery const char *type;
27*e7be843bSPierre Pronchery };
28*e7be843bSPierre Pronchery
29*e7be843bSPierre Pronchery static OSSL_LIB_CTX *libctx = NULL;
30*e7be843bSPierre Pronchery static char *pairwise_name = NULL;
31*e7be843bSPierre Pronchery static char *dsaparam_file = NULL;
32*e7be843bSPierre Pronchery static struct self_test_arg self_test_args = { 0 };
33*e7be843bSPierre Pronchery
test_get_options(void)34*e7be843bSPierre Pronchery const OPTIONS *test_get_options(void)
35*e7be843bSPierre Pronchery {
36*e7be843bSPierre Pronchery static const OPTIONS test_options[] = {
37*e7be843bSPierre Pronchery OPT_TEST_OPTIONS_DEFAULT_USAGE,
38*e7be843bSPierre Pronchery { "config", OPT_CONFIG_FILE, '<',
39*e7be843bSPierre Pronchery "The configuration file to use for the libctx" },
40*e7be843bSPierre Pronchery { "pairwise", OPT_PAIRWISETEST, 's',
41*e7be843bSPierre Pronchery "Test keygen pairwise test failures" },
42*e7be843bSPierre Pronchery { "dsaparam", OPT_DSAPARAM, 's', "DSA param file" },
43*e7be843bSPierre Pronchery { NULL }
44*e7be843bSPierre Pronchery };
45*e7be843bSPierre Pronchery return test_options;
46*e7be843bSPierre Pronchery }
47*e7be843bSPierre Pronchery
self_test_on_pairwise_fail(const OSSL_PARAM params[],void * arg)48*e7be843bSPierre Pronchery static int self_test_on_pairwise_fail(const OSSL_PARAM params[], void *arg)
49*e7be843bSPierre Pronchery {
50*e7be843bSPierre Pronchery struct self_test_arg *args = arg;
51*e7be843bSPierre Pronchery const OSSL_PARAM *p = NULL;
52*e7be843bSPierre Pronchery const char *type = NULL, *phase = NULL;
53*e7be843bSPierre Pronchery
54*e7be843bSPierre Pronchery p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_PHASE);
55*e7be843bSPierre Pronchery if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
56*e7be843bSPierre Pronchery return 0;
57*e7be843bSPierre Pronchery phase = (const char *)p->data;
58*e7be843bSPierre Pronchery if (strcmp(phase, OSSL_SELF_TEST_PHASE_CORRUPT) == 0) {
59*e7be843bSPierre Pronchery p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_TYPE);
60*e7be843bSPierre Pronchery if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
61*e7be843bSPierre Pronchery return 0;
62*e7be843bSPierre Pronchery type = (const char *)p->data;
63*e7be843bSPierre Pronchery if (strcmp(type, args->type) == 0)
64*e7be843bSPierre Pronchery return 0;
65*e7be843bSPierre Pronchery }
66*e7be843bSPierre Pronchery return 1;
67*e7be843bSPierre Pronchery }
68*e7be843bSPierre Pronchery
setup_selftest_pairwise_failure(const char * type)69*e7be843bSPierre Pronchery static int setup_selftest_pairwise_failure(const char *type)
70*e7be843bSPierre Pronchery {
71*e7be843bSPierre Pronchery int ret = 0;
72*e7be843bSPierre Pronchery OSSL_PROVIDER *prov = NULL;
73*e7be843bSPierre Pronchery
74*e7be843bSPierre Pronchery if (!TEST_ptr(prov = OSSL_PROVIDER_load(libctx, "fips")))
75*e7be843bSPierre Pronchery goto err;
76*e7be843bSPierre Pronchery
77*e7be843bSPierre Pronchery /* Setup a callback that corrupts the pairwise self tests and causes failures */
78*e7be843bSPierre Pronchery self_test_args.type = type;
79*e7be843bSPierre Pronchery OSSL_SELF_TEST_set_callback(libctx, self_test_on_pairwise_fail, &self_test_args);
80*e7be843bSPierre Pronchery
81*e7be843bSPierre Pronchery ret = 1;
82*e7be843bSPierre Pronchery err:
83*e7be843bSPierre Pronchery OSSL_PROVIDER_unload(prov);
84*e7be843bSPierre Pronchery return ret;
85*e7be843bSPierre Pronchery }
86*e7be843bSPierre Pronchery
test_keygen_pairwise_failure(void)87*e7be843bSPierre Pronchery static int test_keygen_pairwise_failure(void)
88*e7be843bSPierre Pronchery {
89*e7be843bSPierre Pronchery BIO *bio = NULL;
90*e7be843bSPierre Pronchery EVP_PKEY_CTX *ctx = NULL;
91*e7be843bSPierre Pronchery EVP_PKEY *pParams = NULL;
92*e7be843bSPierre Pronchery EVP_PKEY *pkey = NULL;
93*e7be843bSPierre Pronchery const char *type = OSSL_SELF_TEST_TYPE_PCT;
94*e7be843bSPierre Pronchery int ret = 0;
95*e7be843bSPierre Pronchery
96*e7be843bSPierre Pronchery if (strcmp(pairwise_name, "rsa") == 0) {
97*e7be843bSPierre Pronchery if (!TEST_true(setup_selftest_pairwise_failure(type)))
98*e7be843bSPierre Pronchery goto err;
99*e7be843bSPierre Pronchery if (!TEST_ptr_null(pkey = EVP_PKEY_Q_keygen(libctx, NULL, "RSA", (size_t)2048)))
100*e7be843bSPierre Pronchery goto err;
101*e7be843bSPierre Pronchery } else if (strncmp(pairwise_name, "ec", 2) == 0) {
102*e7be843bSPierre Pronchery if (strcmp(pairwise_name, "eckat") == 0)
103*e7be843bSPierre Pronchery type = OSSL_SELF_TEST_TYPE_PCT_KAT;
104*e7be843bSPierre Pronchery if (!TEST_true(setup_selftest_pairwise_failure(type)))
105*e7be843bSPierre Pronchery goto err;
106*e7be843bSPierre Pronchery if (!TEST_ptr_null(pkey = EVP_PKEY_Q_keygen(libctx, NULL, "EC", "P-256")))
107*e7be843bSPierre Pronchery goto err;
108*e7be843bSPierre Pronchery } else if (strncmp(pairwise_name, "dsa", 3) == 0) {
109*e7be843bSPierre Pronchery if (strcmp(pairwise_name, "dsakat") == 0)
110*e7be843bSPierre Pronchery type = OSSL_SELF_TEST_TYPE_PCT_KAT;
111*e7be843bSPierre Pronchery if (!TEST_true(setup_selftest_pairwise_failure(type)))
112*e7be843bSPierre Pronchery goto err;
113*e7be843bSPierre Pronchery if (!TEST_ptr(bio = BIO_new_file(dsaparam_file, "r")))
114*e7be843bSPierre Pronchery goto err;
115*e7be843bSPierre Pronchery if (!TEST_ptr(pParams = PEM_read_bio_Parameters_ex(bio, NULL, libctx, NULL)))
116*e7be843bSPierre Pronchery goto err;
117*e7be843bSPierre Pronchery if (!TEST_ptr(ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pParams, NULL)))
118*e7be843bSPierre Pronchery goto err;
119*e7be843bSPierre Pronchery if (!TEST_int_eq(EVP_PKEY_keygen_init(ctx), 1))
120*e7be843bSPierre Pronchery goto err;
121*e7be843bSPierre Pronchery if (!TEST_int_le(EVP_PKEY_keygen(ctx, &pkey), 0))
122*e7be843bSPierre Pronchery goto err;
123*e7be843bSPierre Pronchery if (!TEST_ptr_null(pkey))
124*e7be843bSPierre Pronchery goto err;
125*e7be843bSPierre Pronchery } else if (strncmp(pairwise_name, "eddsa", 5) == 0) {
126*e7be843bSPierre Pronchery if (!TEST_true(setup_selftest_pairwise_failure(type)))
127*e7be843bSPierre Pronchery goto err;
128*e7be843bSPierre Pronchery if (!TEST_ptr(ctx = EVP_PKEY_CTX_new_from_name(libctx, "ED25519", NULL)))
129*e7be843bSPierre Pronchery goto err;
130*e7be843bSPierre Pronchery if (!TEST_int_eq(EVP_PKEY_keygen_init(ctx), 1))
131*e7be843bSPierre Pronchery goto err;
132*e7be843bSPierre Pronchery if (!TEST_int_le(EVP_PKEY_keygen(ctx, &pkey), 0))
133*e7be843bSPierre Pronchery goto err;
134*e7be843bSPierre Pronchery if (!TEST_ptr_null(pkey))
135*e7be843bSPierre Pronchery goto err;
136*e7be843bSPierre Pronchery } else if (strncmp(pairwise_name, "ml-dsa", 6) == 0) {
137*e7be843bSPierre Pronchery if (!TEST_true(setup_selftest_pairwise_failure(type)))
138*e7be843bSPierre Pronchery goto err;
139*e7be843bSPierre Pronchery if (!TEST_ptr(ctx = EVP_PKEY_CTX_new_from_name(libctx, "ML-DSA-87", NULL)))
140*e7be843bSPierre Pronchery goto err;
141*e7be843bSPierre Pronchery if (!TEST_int_eq(EVP_PKEY_keygen_init(ctx), 1))
142*e7be843bSPierre Pronchery goto err;
143*e7be843bSPierre Pronchery if (!TEST_int_le(EVP_PKEY_keygen(ctx, &pkey), 0))
144*e7be843bSPierre Pronchery goto err;
145*e7be843bSPierre Pronchery if (!TEST_ptr_null(pkey))
146*e7be843bSPierre Pronchery goto err;
147*e7be843bSPierre Pronchery } else if (strncmp(pairwise_name, "slh-dsa", 7) == 0) {
148*e7be843bSPierre Pronchery if (!TEST_true(setup_selftest_pairwise_failure(type)))
149*e7be843bSPierre Pronchery goto err;
150*e7be843bSPierre Pronchery if (!TEST_ptr(ctx = EVP_PKEY_CTX_new_from_name(libctx, "SLH-DSA-SHA2-256f", NULL)))
151*e7be843bSPierre Pronchery goto err;
152*e7be843bSPierre Pronchery if (!TEST_int_eq(EVP_PKEY_keygen_init(ctx), 1))
153*e7be843bSPierre Pronchery goto err;
154*e7be843bSPierre Pronchery if (!TEST_int_le(EVP_PKEY_keygen(ctx, &pkey), 0))
155*e7be843bSPierre Pronchery goto err;
156*e7be843bSPierre Pronchery if (!TEST_ptr_null(pkey))
157*e7be843bSPierre Pronchery goto err;
158*e7be843bSPierre Pronchery } else if (strncmp(pairwise_name, "ml-kem", 6) == 0) {
159*e7be843bSPierre Pronchery if (!TEST_true(setup_selftest_pairwise_failure(type)))
160*e7be843bSPierre Pronchery goto err;
161*e7be843bSPierre Pronchery if (!TEST_ptr(ctx = EVP_PKEY_CTX_new_from_name(libctx, "ML-KEM-1024", NULL)))
162*e7be843bSPierre Pronchery goto err;
163*e7be843bSPierre Pronchery if (!TEST_int_eq(EVP_PKEY_keygen_init(ctx), 1))
164*e7be843bSPierre Pronchery goto err;
165*e7be843bSPierre Pronchery if (!TEST_int_le(EVP_PKEY_keygen(ctx, &pkey), 0))
166*e7be843bSPierre Pronchery goto err;
167*e7be843bSPierre Pronchery if (!TEST_ptr_null(pkey))
168*e7be843bSPierre Pronchery goto err;
169*e7be843bSPierre Pronchery }
170*e7be843bSPierre Pronchery ret = 1;
171*e7be843bSPierre Pronchery err:
172*e7be843bSPierre Pronchery EVP_PKEY_free(pkey);
173*e7be843bSPierre Pronchery EVP_PKEY_CTX_free(ctx);
174*e7be843bSPierre Pronchery BIO_free(bio);
175*e7be843bSPierre Pronchery EVP_PKEY_free(pParams);
176*e7be843bSPierre Pronchery return ret;
177*e7be843bSPierre Pronchery }
178*e7be843bSPierre Pronchery
setup_tests(void)179*e7be843bSPierre Pronchery int setup_tests(void)
180*e7be843bSPierre Pronchery {
181*e7be843bSPierre Pronchery OPTION_CHOICE o;
182*e7be843bSPierre Pronchery char *config_file = NULL;
183*e7be843bSPierre Pronchery
184*e7be843bSPierre Pronchery while ((o = opt_next()) != OPT_EOF) {
185*e7be843bSPierre Pronchery switch (o) {
186*e7be843bSPierre Pronchery case OPT_CONFIG_FILE:
187*e7be843bSPierre Pronchery config_file = opt_arg();
188*e7be843bSPierre Pronchery break;
189*e7be843bSPierre Pronchery case OPT_PAIRWISETEST:
190*e7be843bSPierre Pronchery pairwise_name = opt_arg();
191*e7be843bSPierre Pronchery break;
192*e7be843bSPierre Pronchery case OPT_DSAPARAM:
193*e7be843bSPierre Pronchery dsaparam_file = opt_arg();
194*e7be843bSPierre Pronchery break;
195*e7be843bSPierre Pronchery case OPT_TEST_CASES:
196*e7be843bSPierre Pronchery break;
197*e7be843bSPierre Pronchery default:
198*e7be843bSPierre Pronchery case OPT_ERR:
199*e7be843bSPierre Pronchery return 0;
200*e7be843bSPierre Pronchery }
201*e7be843bSPierre Pronchery }
202*e7be843bSPierre Pronchery
203*e7be843bSPierre Pronchery libctx = OSSL_LIB_CTX_new();
204*e7be843bSPierre Pronchery if (libctx == NULL)
205*e7be843bSPierre Pronchery return 0;
206*e7be843bSPierre Pronchery if (!OSSL_LIB_CTX_load_config(libctx, config_file)) {
207*e7be843bSPierre Pronchery opt_printf_stderr("Failed to load config\n");
208*e7be843bSPierre Pronchery return 0;
209*e7be843bSPierre Pronchery }
210*e7be843bSPierre Pronchery ADD_TEST(test_keygen_pairwise_failure);
211*e7be843bSPierre Pronchery return 1;
212*e7be843bSPierre Pronchery }
213*e7be843bSPierre Pronchery
cleanup_tests(void)214*e7be843bSPierre Pronchery void cleanup_tests(void)
215*e7be843bSPierre Pronchery {
216*e7be843bSPierre Pronchery OSSL_LIB_CTX_free(libctx);
217*e7be843bSPierre Pronchery }
218