/src/openssl/providers/implementations/encode_decode/encode_key2ms.c

Source
/*
 * Copyright 2020-2025 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

/*
 * Low level APIs are deprecated for public use, but still ok for internal use.
 */
#include "internal/deprecated.h"

#include <string.h>
#include <openssl/core.h>
#include <openssl/core_dispatch.h>
#include <openssl/core_names.h>
#include <openssl/params.h>
#include <openssl/err.h>
#include <openssl/proverr.h>
#include <openssl/pem.h> /* Functions for writing MSBLOB and PVK */
#include <openssl/dsa.h>
#include "internal/cryptlib.h"
#include "internal/passphrase.h"
#include "crypto/rsa.h"
#include "prov/implementations.h"
#include "prov/bio.h"
#include "prov/provider_ctx.h"
#include "prov/endecoder_local.h"
#include "providers/implementations/encode_decode/encode_key2ms.inc"

struct key2ms_ctx_st {
    PROV_CTX *provctx;

    int pvk_encr_level;

    struct ossl_passphrase_data_st pwdata;
};

static int write_msblob(struct key2ms_ctx_st *ctx, OSSL_CORE_BIO *cout,
    EVP_PKEY *pkey, int ispub)
{
    BIO *out = ossl_bio_new_from_core_bio(ctx->provctx, cout);
    int ret;

    if (out == NULL)
        return 0;
    ret = ispub ? i2b_PublicKey_bio(out, pkey) : i2b_PrivateKey_bio(out, pkey);

    BIO_free(out);
    return ret;
}

static int write_pvk(struct key2ms_ctx_st *ctx, OSSL_CORE_BIO *cout,
    EVP_PKEY *pkey)
{
    BIO *out = NULL;
    int ret;
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);

    out = ossl_bio_new_from_core_bio(ctx->provctx, cout);
    if (out == NULL)
        return 0;
    ret = i2b_PVK_bio_ex(out, pkey, ctx->pvk_encr_level,
        ossl_pw_pvk_password, &ctx->pwdata, libctx, NULL);
    BIO_free(out);
    return ret;
}

static OSSL_FUNC_encoder_newctx_fn key2ms_newctx;
static OSSL_FUNC_encoder_freectx_fn key2ms_freectx;
static OSSL_FUNC_encoder_does_selection_fn key2ms_does_selection;

static void *key2ms_newctx(void *provctx)
{
    struct key2ms_ctx_st *ctx = OPENSSL_zalloc(sizeof(*ctx));

    if (ctx != NULL) {
        ctx->provctx = provctx;
        /* This is the strongest encryption level */
        ctx->pvk_encr_level = 2;
    }
    return ctx;
}

static void key2ms_freectx(void *vctx)
{
    struct key2ms_ctx_st *ctx = vctx;

    ossl_pw_clear_passphrase_data(&ctx->pwdata);
    OPENSSL_free(ctx);
}

static const OSSL_PARAM *key2pvk_settable_ctx_params(ossl_unused void *provctx)
{
    return key2pvk_set_ctx_params_list;
}

static int key2pvk_set_ctx_params(void *vctx, const OSSL_PARAM params[])
{
    struct key2ms_ctx_st *ctx = vctx;
    struct key2pvk_set_ctx_params_st p;

    if (ctx == NULL || !key2pvk_set_ctx_params_decoder(params, &p))
        return 0;

    if (p.enclvl != NULL && !OSSL_PARAM_get_int(p.enclvl, &ctx->pvk_encr_level))
        return 0;
    return 1;
}

static int key2ms_does_selection(void *vctx, int selection)
{
    return (selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0;
}

/*
 * The real EVP_PKEY_set1_TYPE() functions take a non-const key, while the key
 * pointer in the encode function is a const pointer.  We violate the constness
 * knowingly, since we know that the key comes from the same provider, is never
 * actually const, and the implied reference count change is safe.
 *
 * EVP_PKEY_assign() can't be used, because there's no way to clear the internal
 * key using that function without freeing the existing internal key.
 */
typedef int evp_pkey_set1_fn(EVP_PKEY *, const void *key);

static int key2msblob_encode(void *vctx, const void *key, int selection,
    OSSL_CORE_BIO *cout, evp_pkey_set1_fn *set1_key,
    OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)
{
    struct key2ms_ctx_st *ctx = vctx;
    int ispub = -1;
    EVP_PKEY *pkey = NULL;
    int ok = 0;

    if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
        ispub = 0;
    else if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
        ispub = 1;
    else
        return 0; /* Error */

    if ((pkey = EVP_PKEY_new()) != NULL && set1_key(pkey, key))
        ok = write_msblob(ctx, cout, pkey, ispub);
    EVP_PKEY_free(pkey);
    return ok;
}

static int key2pvk_encode(void *vctx, const void *key, int selection,
    OSSL_CORE_BIO *cout, evp_pkey_set1_fn *set1_key,
    OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)
{
    struct key2ms_ctx_st *ctx = vctx;
    EVP_PKEY *pkey = NULL;
    int ok = 0;

    if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) == 0)
        return 0; /* Error */

    if ((pkey = EVP_PKEY_new()) != NULL && set1_key(pkey, key)
        && (pw_cb == NULL
            || ossl_pw_set_ossl_passphrase_cb(&ctx->pwdata, pw_cb, pw_cbarg)))
        ok = write_pvk(ctx, cout, pkey);
    EVP_PKEY_free(pkey);
    return ok;
}

#define dsa_set1 (evp_pkey_set1_fn *)EVP_PKEY_set1_DSA
#define rsa_set1 (evp_pkey_set1_fn *)EVP_PKEY_set1_RSA

#define msblob_set_params
#define pvk_set_params                                 \
    { OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS,           \
        (void (*)(void))key2pvk_settable_ctx_params }, \
        { OSSL_FUNC_ENCODER_SET_CTX_PARAMS,            \
            (void (*)(void))key2pvk_set_ctx_params },

#define MAKE_MS_ENCODER(impl, output, type)                                   \
    static OSSL_FUNC_encoder_import_object_fn                                 \
        impl##2##output##_import_object;                                      \
    static OSSL_FUNC_encoder_free_object_fn impl##2##output##_free_object;    \
    static OSSL_FUNC_encoder_encode_fn impl##2##output##_encode;              \
                                                                              \
    static void *                                                             \
        impl##2##output##_import_object(void *ctx, int selection,             \
            const OSSL_PARAM params[])                                        \
    {                                                                         \
        return ossl_prov_import_key(ossl_##impl##_keymgmt_functions,          \
            ctx, selection, params);                                          \
    }                                                                         \
    static void impl##2##output##_free_object(void *key)                      \
    {                                                                         \
        ossl_prov_free_key(ossl_##impl##_keymgmt_functions, key);             \
    }                                                                         \
    static int impl##2##output##_encode(void *vctx, OSSL_CORE_BIO *cout,      \
        const void *key,                                                      \
        const OSSL_PARAM key_abstract[],                                      \
        int selection,                                                        \
        OSSL_PASSPHRASE_CALLBACK *cb,                                         \
        void *cbarg)                                                          \
    {                                                                         \
        /* We don't deal with abstract objects */                             \
        if (key_abstract != NULL) {                                           \
            ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);           \
            return 0;                                                         \
        }                                                                     \
        return key2##output##_encode(vctx, key, selection, cout, type##_set1, \
            cb, cbarg);                                                       \
    }                                                                         \
    const OSSL_DISPATCH ossl_##impl##_to_##output##_encoder_functions[] = {   \
        { OSSL_FUNC_ENCODER_NEWCTX,                                           \
            (void (*)(void))key2ms_newctx },                                  \
        { OSSL_FUNC_ENCODER_FREECTX,                                          \
            (void (*)(void))key2ms_freectx },                                 \
        output##_set_params { OSSL_FUNC_ENCODER_DOES_SELECTION,               \
            (void (*)(void))key2ms_does_selection },                          \
        { OSSL_FUNC_ENCODER_IMPORT_OBJECT,                                    \
            (void (*)(void))impl##2##output##_import_object },                \
        { OSSL_FUNC_ENCODER_FREE_OBJECT,                                      \
            (void (*)(void))impl##2##output##_free_object },                  \
        { OSSL_FUNC_ENCODER_ENCODE,                                           \
            (void (*)(void))impl##2##output##_encode },                       \
        OSSL_DISPATCH_END                                                     \
    }

#ifndef OPENSSL_NO_DSA
MAKE_MS_ENCODER(dsa, pvk, dsa);
MAKE_MS_ENCODER(dsa, msblob, dsa);
#endif

MAKE_MS_ENCODER(rsa, pvk, rsa);
MAKE_MS_ENCODER(rsa, msblob, rsa);

Coverage Report

Created: 2026-07-16 06:59

Line	Count	Source
1		/*
2		* Copyright 2020-2025 The OpenSSL Project Authors. All Rights Reserved.
3		*
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
8		*/
9
10		/*
11		* Low level APIs are deprecated for public use, but still ok for internal use.
12		*/
13		#include "internal/deprecated.h"
14
15		#include <string.h>
16		#include <openssl/core.h>
17		#include <openssl/core_dispatch.h>
18		#include <openssl/core_names.h>
19		#include <openssl/params.h>
20		#include <openssl/err.h>
21		#include <openssl/proverr.h>
22		#include <openssl/pem.h> /* Functions for writing MSBLOB and PVK */
23		#include <openssl/dsa.h>
24		#include "internal/cryptlib.h"
25		#include "internal/passphrase.h"
26		#include "crypto/rsa.h"
27		#include "prov/implementations.h"
28		#include "prov/bio.h"
29		#include "prov/provider_ctx.h"
30		#include "prov/endecoder_local.h"
31		#include "providers/implementations/encode_decode/encode_key2ms.inc"
32
33		struct key2ms_ctx_st {
34		PROV_CTX *provctx;
35
36		int pvk_encr_level;
37
38		struct ossl_passphrase_data_st pwdata;
39		};
40
41		static int write_msblob(struct key2ms_ctx_st ctx, OSSL_CORE_BIO cout,
42		EVP_PKEY *pkey, int ispub)
43	0	{
44	0	BIO *out = ossl_bio_new_from_core_bio(ctx->provctx, cout);
45	0	int ret;
46
47	0	if (out == NULL)
48	0	return 0;
49	0	ret = ispub ? i2b_PublicKey_bio(out, pkey) : i2b_PrivateKey_bio(out, pkey);
50
51	0	BIO_free(out);
52	0	return ret;
53	0	}
54
55		static int write_pvk(struct key2ms_ctx_st ctx, OSSL_CORE_BIO cout,
56		EVP_PKEY *pkey)
57	0	{
58	0	BIO *out = NULL;
59	0	int ret;
60	0	OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
61
62	0	out = ossl_bio_new_from_core_bio(ctx->provctx, cout);
63	0	if (out == NULL)
64	0	return 0;
65	0	ret = i2b_PVK_bio_ex(out, pkey, ctx->pvk_encr_level,
66	0	ossl_pw_pvk_password, &ctx->pwdata, libctx, NULL);
67	0	BIO_free(out);
68	0	return ret;
69	0	}
70
71		static OSSL_FUNC_encoder_newctx_fn key2ms_newctx;
72		static OSSL_FUNC_encoder_freectx_fn key2ms_freectx;
73		static OSSL_FUNC_encoder_does_selection_fn key2ms_does_selection;
74
75		static void key2ms_newctx(void provctx)
76	0	{
77	0	struct key2ms_ctx_st ctx = OPENSSL_zalloc(sizeof(ctx));
78
79	0	if (ctx != NULL) {
80	0	ctx->provctx = provctx;
81		/* This is the strongest encryption level */
82	0	ctx->pvk_encr_level = 2;
83	0	}
84	0	return ctx;
85	0	}
86
87		static void key2ms_freectx(void *vctx)
88	0	{
89	0	struct key2ms_ctx_st *ctx = vctx;
90
91	0	ossl_pw_clear_passphrase_data(&ctx->pwdata);
92	0	OPENSSL_free(ctx);
93	0	}
94
95		static const OSSL_PARAM key2pvk_settable_ctx_params(ossl_unused void provctx)
96	0	{
97	0	return key2pvk_set_ctx_params_list;
98	0	}
99
100		static int key2pvk_set_ctx_params(void *vctx, const OSSL_PARAM params[])
101	0	{
102	0	struct key2ms_ctx_st *ctx = vctx;
103	0	struct key2pvk_set_ctx_params_st p;
104
105	0	if (ctx == NULL \|\| !key2pvk_set_ctx_params_decoder(params, &p))
106	0	return 0;
107
108	0	if (p.enclvl != NULL && !OSSL_PARAM_get_int(p.enclvl, &ctx->pvk_encr_level))
109	0	return 0;
110	0	return 1;
111	0	}
112
113		static int key2ms_does_selection(void *vctx, int selection)
114	0	{
115	0	return (selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0;
116	0	}
117
118		/*
119		* The real EVP_PKEY_set1_TYPE() functions take a non-const key, while the key
120		* pointer in the encode function is a const pointer. We violate the constness
121		* knowingly, since we know that the key comes from the same provider, is never
122		* actually const, and the implied reference count change is safe.
123		*
124		* EVP_PKEY_assign() can't be used, because there's no way to clear the internal
125		* key using that function without freeing the existing internal key.
126		*/
127		typedef int evp_pkey_set1_fn(EVP_PKEY , const void key);
128
129		static int key2msblob_encode(void vctx, const void key, int selection,
130		OSSL_CORE_BIO cout, evp_pkey_set1_fn set1_key,
131		OSSL_PASSPHRASE_CALLBACK pw_cb, void pw_cbarg)
132	0	{
133	0	struct key2ms_ctx_st *ctx = vctx;
134	0	int ispub = -1;
135	0	EVP_PKEY *pkey = NULL;
136	0	int ok = 0;
137
138	0	if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
139	0	ispub = 0;
140	0	else if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
141	0	ispub = 1;
142	0	else
143	0	return 0; /* Error */
144
145	0	if ((pkey = EVP_PKEY_new()) != NULL && set1_key(pkey, key))
146	0	ok = write_msblob(ctx, cout, pkey, ispub);
147	0	EVP_PKEY_free(pkey);
148	0	return ok;
149	0	}
150
151		static int key2pvk_encode(void vctx, const void key, int selection,
152		OSSL_CORE_BIO cout, evp_pkey_set1_fn set1_key,
153		OSSL_PASSPHRASE_CALLBACK pw_cb, void pw_cbarg)
154	0	{
155	0	struct key2ms_ctx_st *ctx = vctx;
156	0	EVP_PKEY *pkey = NULL;
157	0	int ok = 0;
158
159	0	if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) == 0)
160	0	return 0; /* Error */
161
162	0	if ((pkey = EVP_PKEY_new()) != NULL && set1_key(pkey, key)
163	0	&& (pw_cb == NULL
164	0	\|\| ossl_pw_set_ossl_passphrase_cb(&ctx->pwdata, pw_cb, pw_cbarg)))
165	0	ok = write_pvk(ctx, cout, pkey);
166	0	EVP_PKEY_free(pkey);
167	0	return ok;
168	0	}
169
170	0	#define dsa_set1 (evp_pkey_set1_fn *)EVP_PKEY_set1_DSA
171	0	#define rsa_set1 (evp_pkey_set1_fn *)EVP_PKEY_set1_RSA
172
173		#define msblob_set_params
174		#define pvk_set_params \
175		{ OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS, \
176		(void (*)(void))key2pvk_settable_ctx_params }, \
177		{ OSSL_FUNC_ENCODER_SET_CTX_PARAMS, \
178		(void (*)(void))key2pvk_set_ctx_params },
179
180		#define MAKE_MS_ENCODER(impl, output, type) \
181		static OSSL_FUNC_encoder_import_object_fn \
182		impl##2##output##_import_object; \
183		static OSSL_FUNC_encoder_free_object_fn impl##2##output##_free_object; \
184		static OSSL_FUNC_encoder_encode_fn impl##2##output##_encode; \
185		\
186		static void * \
187		impl##2##output##_import_object(void *ctx, int selection, \
188		const OSSL_PARAM params[]) \
189	0	{ \
190	0	return ossl_prov_import_key(ossl_##impl##_keymgmt_functions, \
191	0	ctx, selection, params); \
192	0	} \ Unexecuted instantiation: encode_key2ms.c:dsa2pvk_import_object Unexecuted instantiation: encode_key2ms.c:dsa2msblob_import_object Unexecuted instantiation: encode_key2ms.c:rsa2pvk_import_object Unexecuted instantiation: encode_key2ms.c:rsa2msblob_import_object
193		static void impl##2##output##_free_object(void *key) \
194	0	{ \
195	0	ossl_prov_free_key(ossl_##impl##_keymgmt_functions, key); \
196	0	} \ Unexecuted instantiation: encode_key2ms.c:dsa2pvk_free_object Unexecuted instantiation: encode_key2ms.c:dsa2msblob_free_object Unexecuted instantiation: encode_key2ms.c:rsa2pvk_free_object Unexecuted instantiation: encode_key2ms.c:rsa2msblob_free_object
197		static int impl##2##output##_encode(void vctx, OSSL_CORE_BIO cout, \
198		const void *key, \
199		const OSSL_PARAM key_abstract[], \
200		int selection, \
201		OSSL_PASSPHRASE_CALLBACK *cb, \
202		void *cbarg) \
203	0	{ \
204	0	/* We don't deal with abstract objects */ \
205	0	if (key_abstract != NULL) { \
206	0	ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT); \
207	0	return 0; \
208	0	} \
209	0	return key2##output##_encode(vctx, key, selection, cout, type##_set1, \
210	0	cb, cbarg); \
211	0	} \
212		const OSSL_DISPATCH ossl_##impl##_to_##output##_encoder_functions[] = { \
213		{ OSSL_FUNC_ENCODER_NEWCTX, \
214		(void (*)(void))key2ms_newctx }, \
215		{ OSSL_FUNC_ENCODER_FREECTX, \
216		(void (*)(void))key2ms_freectx }, \
217		output##_set_params { OSSL_FUNC_ENCODER_DOES_SELECTION, \
218		(void (*)(void))key2ms_does_selection }, \
219		{ OSSL_FUNC_ENCODER_IMPORT_OBJECT, \
220		(void (*)(void))impl##2##output##_import_object }, \
221		{ OSSL_FUNC_ENCODER_FREE_OBJECT, \
222		(void (*)(void))impl##2##output##_free_object }, \
223		{ OSSL_FUNC_ENCODER_ENCODE, \
224		(void (*)(void))impl##2##output##_encode }, \
225		OSSL_DISPATCH_END \
226		}
227
228		#ifndef OPENSSL_NO_DSA
229	0	MAKE_MS_ENCODER(dsa, pvk, dsa);
230	0	MAKE_MS_ENCODER(dsa, msblob, dsa);
231		#endif
232
233	0	MAKE_MS_ENCODER(rsa, pvk, rsa);
234		MAKE_MS_ENCODER(rsa, msblob, rsa);