[thirdparty/openssl.git] / crypto / encode_decode / encoder_pkey.c

/*
 * Copyright 2019-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
 */

#include <openssl/err.h>
#include <openssl/ui.h>
#include <openssl/params.h>
#include <openssl/encoder.h>
#include <openssl/core_names.h>
#include <openssl/provider.h>
#include <openssl/safestack.h>
#include <openssl/trace.h>
#include "internal/provider.h"
#include "internal/property.h"
#include "internal/namemap.h"
#include "crypto/evp.h"
#include "encoder_local.h"

DEFINE_STACK_OF(OSSL_ENCODER)

int OSSL_ENCODER_CTX_set_cipher(OSSL_ENCODER_CTX *ctx,
                                const char *cipher_name,
                                const char *propquery)
{
    OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END };

    params[0] =
        OSSL_PARAM_construct_utf8_string(OSSL_ENCODER_PARAM_CIPHER,
                                         (void *)cipher_name, 0);
    params[1] =
        OSSL_PARAM_construct_utf8_string(OSSL_ENCODER_PARAM_PROPERTIES,
                                         (void *)propquery, 0);

    return OSSL_ENCODER_CTX_set_params(ctx, params);
}

int OSSL_ENCODER_CTX_set_passphrase(OSSL_ENCODER_CTX *ctx,
                                    const unsigned char *kstr,
                                    size_t klen)
{
    return ossl_pw_set_passphrase(&ctx->pwdata, kstr, klen);
}

int OSSL_ENCODER_CTX_set_passphrase_ui(OSSL_ENCODER_CTX *ctx,
                                       const UI_METHOD *ui_method,
                                       void *ui_data)
{
    return ossl_pw_set_ui_method(&ctx->pwdata, ui_method, ui_data);
}

int OSSL_ENCODER_CTX_set_pem_password_cb(OSSL_ENCODER_CTX *ctx,
                                         pem_password_cb *cb, void *cbarg)
{
    return ossl_pw_set_pem_password_cb(&ctx->pwdata, cb, cbarg);
}

int OSSL_ENCODER_CTX_set_passphrase_cb(OSSL_ENCODER_CTX *ctx,
                                       OSSL_PASSPHRASE_CALLBACK *cb,
                                       void *cbarg)
{
    return ossl_pw_set_ossl_passphrase_cb(&ctx->pwdata, cb, cbarg);
}

/*
 * Support for OSSL_ENCODER_CTX_new_for_type:
 * finding a suitable encoder
 */

struct collected_encoder_st {
    STACK_OF(OPENSSL_CSTRING) *names;
    int *id_names;
    const char *output_structure;
    const char *output_type;

    const OSSL_PROVIDER *keymgmt_prov;
    OSSL_ENCODER_CTX *ctx;
    unsigned int flag_find_same_provider:1;

    int error_occurred;
};

static void collect_encoder(OSSL_ENCODER *encoder, void *arg)
{
    struct collected_encoder_st *data = arg;
    const OSSL_PROVIDER *prov;

    if (data->error_occurred)
        return;

    data->error_occurred = 1;     /* Assume the worst */

    prov = OSSL_ENCODER_get0_provider(encoder);
    /*
     * collect_encoder() is called in two passes, one where the encoders
     * from the same provider as the keymgmt are looked up, and one where
     * the other encoders are looked up.  |data->flag_find_same_provider|
     * tells us which pass we're in.
     */
    if ((data->keymgmt_prov == prov) == data->flag_find_same_provider) {
        void *provctx = OSSL_PROVIDER_get0_provider_ctx(prov);
        int i, end_i = sk_OPENSSL_CSTRING_num(data->names);
        int match;

        for (i = 0; i < end_i; i++) {
            if (data->flag_find_same_provider)
                match = (data->id_names[i] == encoder->base.id);
            else
                match = OSSL_ENCODER_is_a(encoder,
                                          sk_OPENSSL_CSTRING_value(data->names, i));
            if (!match
                || (encoder->does_selection != NULL
                    && !encoder->does_selection(provctx, data->ctx->selection))
                || (data->keymgmt_prov != prov
                    && encoder->import_object == NULL))
                continue;

            /* Only add each encoder implementation once */
            if (OSSL_ENCODER_CTX_add_encoder(data->ctx, encoder))
                break;
        }
    }

    data->error_occurred = 0;         /* All is good now */
}

struct collected_names_st {
    STACK_OF(OPENSSL_CSTRING) *names;
    unsigned int error_occurred:1;
};

static void collect_name(const char *name, void *arg)
{
    struct collected_names_st *data = arg;

    if (data->error_occurred)
        return;

    data->error_occurred = 1;         /* Assume the worst */

    if (sk_OPENSSL_CSTRING_push(data->names, name) <= 0)
        return;

    data->error_occurred = 0;         /* All is good now */
}

/*
 * Support for OSSL_ENCODER_to_bio:
 * writing callback for the OSSL_PARAM (the implementation doesn't have
 * intimate knowledge of the provider side object)
 */

struct construct_data_st {
    const EVP_PKEY *pk;
    int selection;

    OSSL_ENCODER_INSTANCE *encoder_inst;
    const void *obj;
    void *constructed_obj;
};

static int encoder_import_cb(const OSSL_PARAM params[], void *arg)
{
    struct construct_data_st *construct_data = arg;
    OSSL_ENCODER_INSTANCE *encoder_inst = construct_data->encoder_inst;
    OSSL_ENCODER *encoder = OSSL_ENCODER_INSTANCE_get_encoder(encoder_inst);
    void *encoderctx = OSSL_ENCODER_INSTANCE_get_encoder_ctx(encoder_inst);

    construct_data->constructed_obj =
        encoder->import_object(encoderctx, construct_data->selection, params);

    return (construct_data->constructed_obj != NULL);
}

static const void *
encoder_construct_pkey(OSSL_ENCODER_INSTANCE *encoder_inst, void *arg)
{
    struct construct_data_st *data = arg;

    if (data->obj == NULL) {
        OSSL_ENCODER *encoder =
            OSSL_ENCODER_INSTANCE_get_encoder(encoder_inst);
        const EVP_PKEY *pk = data->pk;
        const OSSL_PROVIDER *k_prov = EVP_KEYMGMT_get0_provider(pk->keymgmt);
        const OSSL_PROVIDER *e_prov = OSSL_ENCODER_get0_provider(encoder);

        if (k_prov != e_prov) {
            int selection = data->selection;

            if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
                selection |= OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
            data->encoder_inst = encoder_inst;

            if (!evp_keymgmt_export(pk->keymgmt, pk->keydata, selection,
                                    &encoder_import_cb, data))
                return NULL;
            data->obj = data->constructed_obj;
        } else {
            data->obj = pk->keydata;
        }
    }

    return data->obj;
}

static void encoder_destruct_pkey(void *arg)
{
    struct construct_data_st *data = arg;
    int match = (data->obj == data->constructed_obj);

    if (data->encoder_inst != NULL) {
        OSSL_ENCODER *encoder =
            OSSL_ENCODER_INSTANCE_get_encoder(data->encoder_inst);

        encoder->free_object(data->constructed_obj);
    }
    data->constructed_obj = NULL;
    if (match)
        data->obj = NULL;
}

/*
 * OSSL_ENCODER_CTX_new_for_pkey() returns a ctx with no encoder if
 * it couldn't find a suitable encoder.  This allows a caller to detect if
 * a suitable encoder was found, with OSSL_ENCODER_CTX_get_num_encoder(),
 * and to use fallback methods if the result is NULL.
 */
static int ossl_encoder_ctx_setup_for_pkey(OSSL_ENCODER_CTX *ctx,
                                           const EVP_PKEY *pkey,
                                           int selection,
                                           const char *propquery)
{
    struct construct_data_st *data = NULL;
    const OSSL_PROVIDER *prov = NULL;
    OSSL_LIB_CTX *libctx = NULL;
    int ok = 0, i, end;
    OSSL_NAMEMAP *namemap;

    if (!ossl_assert(ctx != NULL) || !ossl_assert(pkey != NULL)) {
        ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_PASSED_NULL_PARAMETER);
        return 0;
    }

    if (evp_pkey_is_provided(pkey)) {
        prov = EVP_KEYMGMT_get0_provider(pkey->keymgmt);
        libctx = ossl_provider_libctx(prov);
    }

    if (pkey->keymgmt != NULL) {
        struct collected_encoder_st encoder_data;
        struct collected_names_st keymgmt_data;

        if ((data = OPENSSL_zalloc(sizeof(*data))) == NULL)
            goto err;

        /*
         * Select the first encoder implementations in two steps.
         * First, collect the keymgmt names, then the encoders that match.
         */
        keymgmt_data.names = sk_OPENSSL_CSTRING_new_null();
        if (keymgmt_data.names == NULL) {
            ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_CRYPTO_LIB);
            goto err;
        }

        keymgmt_data.error_occurred = 0;
        EVP_KEYMGMT_names_do_all(pkey->keymgmt, collect_name, &keymgmt_data);
        if (keymgmt_data.error_occurred) {
            sk_OPENSSL_CSTRING_free(keymgmt_data.names);
            goto err;
        }

        encoder_data.names = keymgmt_data.names;
        encoder_data.output_type = ctx->output_type;
        encoder_data.output_structure = ctx->output_structure;
        encoder_data.error_occurred = 0;
        encoder_data.keymgmt_prov = prov;
        encoder_data.ctx = ctx;
        encoder_data.id_names = NULL;

        /*
         * collect_encoder() is called many times, and for every call it converts all encoder_data.names
         * into namemap ids if it calls OSSL_ENCODER_is_a(). We cache the ids here instead,
         * and can use them for encoders with the same provider as the keymgmt.
         */
        namemap = ossl_namemap_stored(libctx);
        end = sk_OPENSSL_CSTRING_num(encoder_data.names);
        if (end > 0) {
            encoder_data.id_names = OPENSSL_malloc(end * sizeof(int));
            if (encoder_data.id_names == NULL) {
                sk_OPENSSL_CSTRING_free(keymgmt_data.names);
                goto err;
            }
            for (i = 0; i < end; ++i) {
                const char *name = sk_OPENSSL_CSTRING_value(keymgmt_data.names, i);

                encoder_data.id_names[i] = ossl_namemap_name2num(namemap, name);
            }
        }
        /*
         * Place the encoders with the a different provider as the keymgmt
         * last (the chain is processed in reverse order)
         */
        encoder_data.flag_find_same_provider = 0;
        OSSL_ENCODER_do_all_provided(libctx, collect_encoder, &encoder_data);

        /*
         * Place the encoders with the same provider as the keymgmt first
         * (the chain is processed in reverse order)
         */
        encoder_data.flag_find_same_provider = 1;
        OSSL_ENCODER_do_all_provided(libctx, collect_encoder, &encoder_data);

        OPENSSL_free(encoder_data.id_names);
        sk_OPENSSL_CSTRING_free(keymgmt_data.names);
        if (encoder_data.error_occurred) {
            ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_CRYPTO_LIB);
            goto err;
        }
    }

    if (data != NULL && OSSL_ENCODER_CTX_get_num_encoders(ctx) != 0) {
        if (!OSSL_ENCODER_CTX_set_construct(ctx, encoder_construct_pkey)
            || !OSSL_ENCODER_CTX_set_construct_data(ctx, data)
            || !OSSL_ENCODER_CTX_set_cleanup(ctx, encoder_destruct_pkey))
            goto err;

        data->pk = pkey;
        data->selection = selection;

        data = NULL;             /* Avoid it being freed */
    }

    ok = 1;
 err:
    if (data != NULL) {
        OSSL_ENCODER_CTX_set_construct_data(ctx, NULL);
        OPENSSL_free(data);
    }
    return ok;
}

OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new_for_pkey(const EVP_PKEY *pkey,
                                                int selection,
                                                const char *output_type,
                                                const char *output_struct,
                                                const char *propquery)
{
    OSSL_ENCODER_CTX *ctx = NULL;
    OSSL_LIB_CTX *libctx = NULL;

    if (pkey == NULL) {
        ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_PASSED_NULL_PARAMETER);
        return NULL;
    }

    if (!evp_pkey_is_assigned(pkey)) {
        ERR_raise_data(ERR_LIB_OSSL_ENCODER, ERR_R_PASSED_INVALID_ARGUMENT,
                       "The passed EVP_PKEY must be assigned a key");
        return NULL;
    }

    if ((ctx = OSSL_ENCODER_CTX_new()) == NULL) {
        ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_OSSL_ENCODER_LIB);
        return NULL;
    }

    if (evp_pkey_is_provided(pkey)) {
        const OSSL_PROVIDER *prov = EVP_KEYMGMT_get0_provider(pkey->keymgmt);

        libctx = ossl_provider_libctx(prov);
    }

    OSSL_TRACE_BEGIN(ENCODER) {
        BIO_printf(trc_out,
                   "(ctx %p) Looking for %s encoders with selection %d\n",
                   (void *)ctx, EVP_PKEY_get0_type_name(pkey), selection);
        BIO_printf(trc_out, "    output type: %s, output structure: %s\n",
                   output_type, output_struct);
    } OSSL_TRACE_END(ENCODER);

    if (OSSL_ENCODER_CTX_set_output_type(ctx, output_type)
        && (output_struct == NULL
            || OSSL_ENCODER_CTX_set_output_structure(ctx, output_struct))
        && OSSL_ENCODER_CTX_set_selection(ctx, selection)
        && ossl_encoder_ctx_setup_for_pkey(ctx, pkey, selection, propquery)
        && OSSL_ENCODER_CTX_add_extra(ctx, libctx, propquery)) {
        OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
        int save_parameters = pkey->save_parameters;

        params[0] = OSSL_PARAM_construct_int(OSSL_ENCODER_PARAM_SAVE_PARAMETERS,
                                             &save_parameters);
        /* ignoring error as this is only auxiliary parameter */
        (void)OSSL_ENCODER_CTX_set_params(ctx, params);

        OSSL_TRACE_BEGIN(ENCODER) {
            BIO_printf(trc_out, "(ctx %p) Got %d encoders\n",
                       (void *)ctx, OSSL_ENCODER_CTX_get_num_encoders(ctx));
        } OSSL_TRACE_END(ENCODER);
        return ctx;
    }

    OSSL_ENCODER_CTX_free(ctx);
    return NULL;
}
Commit	Line	Data
ece9304c	1	/*
0c679f55	2	* Copyright 2019-2025 The OpenSSL Project Authors. All Rights Reserved.
ece9304c RL	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	#include <openssl/err.h>
	11	#include <openssl/ui.h>
	12	#include <openssl/params.h>
	13	#include <openssl/encoder.h>
	14	#include <openssl/core_names.h>
b9a2afdf	15	#include <openssl/provider.h>
ece9304c	16	#include <openssl/safestack.h>
0b9f90f5	17	#include <openssl/trace.h>
ece9304c RL	18	#include "internal/provider.h"
ece9304c RL	19	#include "internal/property.h"
c3b46409	20	#include "internal/namemap.h"
ece9304c RL	21	#include "crypto/evp.h"
	22	#include "encoder_local.h"
	23
b8975c68 RL	24	DEFINE_STACK_OF(OSSL_ENCODER)
b8975c68 RL	25
ece9304c RL	26	int OSSL_ENCODER_CTX_set_cipher(OSSL_ENCODER_CTX *ctx,
	27	const char *cipher_name,
	28	const char *propquery)
	29	{
	30	OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END };
	31
	32	params[0] =
	33	OSSL_PARAM_construct_utf8_string(OSSL_ENCODER_PARAM_CIPHER,
	34	(void *)cipher_name, 0);
	35	params[1] =
	36	OSSL_PARAM_construct_utf8_string(OSSL_ENCODER_PARAM_PROPERTIES,
	37	(void *)propquery, 0);
	38
	39	return OSSL_ENCODER_CTX_set_params(ctx, params);
	40	}
	41
	42	int OSSL_ENCODER_CTX_set_passphrase(OSSL_ENCODER_CTX *ctx,
	43	const unsigned char *kstr,
	44	size_t klen)
	45	{
8ae40cf5	46	return ossl_pw_set_passphrase(&ctx->pwdata, kstr, klen);
ece9304c RL	47	}
ece9304c RL	48
ece9304c RL	49	int OSSL_ENCODER_CTX_set_passphrase_ui(OSSL_ENCODER_CTX *ctx,
	50	const UI_METHOD *ui_method,
	51	void *ui_data)
	52	{
a517edec	53	return ossl_pw_set_ui_method(&ctx->pwdata, ui_method, ui_data);
ece9304c RL	54	}
ece9304c RL	55
b8975c68 RL	56	int OSSL_ENCODER_CTX_set_pem_password_cb(OSSL_ENCODER_CTX *ctx,
b8975c68 RL	57	pem_password_cb cb, void cbarg)
ece9304c	58	{
a517edec	59	return ossl_pw_set_pem_password_cb(&ctx->pwdata, cb, cbarg);
ece9304c RL	60	}
ece9304c RL	61
b8975c68 RL	62	int OSSL_ENCODER_CTX_set_passphrase_cb(OSSL_ENCODER_CTX *ctx,
	63	OSSL_PASSPHRASE_CALLBACK *cb,
	64	void *cbarg)
	65	{
	66	return ossl_pw_set_ossl_passphrase_cb(&ctx->pwdata, cb, cbarg);
	67	}
	68
ece9304c	69	/*
fe75766c	70	* Support for OSSL_ENCODER_CTX_new_for_type:
ece9304c RL	71	* finding a suitable encoder
	72	*/
	73
b8975c68	74	struct collected_encoder_st {
b9a2afdf	75	STACK_OF(OPENSSL_CSTRING) *names;
c3b46409	76	int *id_names;
b9a2afdf	77	const char *output_structure;
b8975c68	78	const char *output_type;
b9a2afdf	79
021521aa	80	const OSSL_PROVIDER *keymgmt_prov;
b9a2afdf	81	OSSL_ENCODER_CTX *ctx;
f616ad4b	82	unsigned int flag_find_same_provider:1;
b9a2afdf	83
e3a2ba75	84	int error_occurred;
b8975c68 RL	85	};
	86
	87	static void collect_encoder(OSSL_ENCODER encoder, void arg)
	88	{
	89	struct collected_encoder_st *data = arg;
c3b46409	90	const OSSL_PROVIDER *prov;
b8975c68	91
e3a2ba75	92	if (data->error_occurred)
b8975c68 RL	93	return;
b8975c68 RL	94
e3a2ba75	95	data->error_occurred = 1; /* Assume the worst */
b9a2afdf	96
c3b46409	97	prov = OSSL_ENCODER_get0_provider(encoder);
	98	/*
	99	* collect_encoder() is called in two passes, one where the encoders
	100	* from the same provider as the keymgmt are looked up, and one where
	101	* the other encoders are looked up. \|data->flag_find_same_provider\|
	102	* tells us which pass we're in.
	103	*/
	104	if ((data->keymgmt_prov == prov) == data->flag_find_same_provider) {
b9a2afdf	105	void *provctx = OSSL_PROVIDER_get0_provider_ctx(prov);
9ab57f29	106	int i, end_i = sk_OPENSSL_CSTRING_num(data->names);
c3b46409	107	int match;
	108
	109	for (i = 0; i < end_i; i++) {
	110	if (data->flag_find_same_provider)
	111	match = (data->id_names[i] == encoder->base.id);
	112	else
9ab57f29 P	113	match = OSSL_ENCODER_is_a(encoder,
9ab57f29 P	114	sk_OPENSSL_CSTRING_value(data->names, i));
c3b46409	115	if (!match
	116	\|\| (encoder->does_selection != NULL
	117	&& !encoder->does_selection(provctx, data->ctx->selection))
	118	\|\| (data->keymgmt_prov != prov
	119	&& encoder->import_object == NULL))
	120	continue;
	121
	122	/* Only add each encoder implementation once */
	123	if (OSSL_ENCODER_CTX_add_encoder(data->ctx, encoder))
	124	break;
	125	}
b8975c68 RL	126	}
b8975c68 RL	127
e3a2ba75	128	data->error_occurred = 0; /* All is good now */
b8975c68 RL	129	}
	130
	131	struct collected_names_st {
ece9304c	132	STACK_OF(OPENSSL_CSTRING) *names;
e3a2ba75	133	unsigned int error_occurred:1;
ece9304c RL	134	};
ece9304c RL	135
b8975c68	136	static void collect_name(const char name, void arg)
ece9304c	137	{
b8975c68 RL	138	struct collected_names_st *data = arg;
b8975c68 RL	139
e3a2ba75	140	if (data->error_occurred)
b8975c68 RL	141	return;
b8975c68 RL	142
e3a2ba75	143	data->error_occurred = 1; /* Assume the worst */
ece9304c	144
b8975c68 RL	145	if (sk_OPENSSL_CSTRING_push(data->names, name) <= 0)
	146	return;
	147
e3a2ba75	148	data->error_occurred = 0; /* All is good now */
ece9304c RL	149	}
	150
	151	/*
	152	* Support for OSSL_ENCODER_to_bio:
	153	* writing callback for the OSSL_PARAM (the implementation doesn't have
	154	* intimate knowledge of the provider side object)
	155	*/
	156
b8975c68 RL	157	struct construct_data_st {
	158	const EVP_PKEY *pk;
	159	int selection;
	160
	161	OSSL_ENCODER_INSTANCE *encoder_inst;
	162	const void *obj;
	163	void *constructed_obj;
ece9304c RL	164	};
ece9304c RL	165
b8975c68	166	static int encoder_import_cb(const OSSL_PARAM params[], void *arg)
ece9304c	167	{
b8975c68 RL	168	struct construct_data_st *construct_data = arg;
	169	OSSL_ENCODER_INSTANCE *encoder_inst = construct_data->encoder_inst;
	170	OSSL_ENCODER *encoder = OSSL_ENCODER_INSTANCE_get_encoder(encoder_inst);
	171	void *encoderctx = OSSL_ENCODER_INSTANCE_get_encoder_ctx(encoder_inst);
ece9304c	172
b8975c68 RL	173	construct_data->constructed_obj =
b8975c68 RL	174	encoder->import_object(encoderctx, construct_data->selection, params);
ece9304c	175
b8975c68 RL	176	return (construct_data->constructed_obj != NULL);
	177	}
	178
	179	static const void *
fe75766c	180	encoder_construct_pkey(OSSL_ENCODER_INSTANCE encoder_inst, void arg)
ece9304c	181	{
b8975c68 RL	182	struct construct_data_st *data = arg;
	183
	184	if (data->obj == NULL) {
	185	OSSL_ENCODER *encoder =
	186	OSSL_ENCODER_INSTANCE_get_encoder(encoder_inst);
	187	const EVP_PKEY *pk = data->pk;
ed576acd TM	188	const OSSL_PROVIDER *k_prov = EVP_KEYMGMT_get0_provider(pk->keymgmt);
ed576acd TM	189	const OSSL_PROVIDER *e_prov = OSSL_ENCODER_get0_provider(encoder);
b8975c68 RL	190
b8975c68 RL	191	if (k_prov != e_prov) {
79c98fc6	192	int selection = data->selection;
	193
	194	if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
	195	selection \|= OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
b8975c68 RL	196	data->encoder_inst = encoder_inst;
b8975c68 RL	197
79c98fc6	198	if (!evp_keymgmt_export(pk->keymgmt, pk->keydata, selection,
b8975c68 RL	199	&encoder_import_cb, data))
	200	return NULL;
	201	data->obj = data->constructed_obj;
	202	} else {
	203	data->obj = pk->keydata;
	204	}
	205	}
ece9304c	206
b8975c68 RL	207	return data->obj;
b8975c68 RL	208	}
ece9304c	209
fe75766c	210	static void encoder_destruct_pkey(void *arg)
b8975c68 RL	211	{
b8975c68 RL	212	struct construct_data_st *data = arg;
c2f4d7aa	213	int match = (data->obj == data->constructed_obj);
ece9304c	214
b8975c68 RL	215	if (data->encoder_inst != NULL) {
	216	OSSL_ENCODER *encoder =
	217	OSSL_ENCODER_INSTANCE_get_encoder(data->encoder_inst);
ece9304c	218
b8975c68	219	encoder->free_object(data->constructed_obj);
ece9304c	220	}
b8975c68	221	data->constructed_obj = NULL;
c2f4d7aa	222	if (match)
c2f4d7aa	223	data->obj = NULL;
ece9304c RL	224	}
	225
	226	/*
fe75766c	227	* OSSL_ENCODER_CTX_new_for_pkey() returns a ctx with no encoder if
ece9304c	228	* it couldn't find a suitable encoder. This allows a caller to detect if
b8975c68	229	* a suitable encoder was found, with OSSL_ENCODER_CTX_get_num_encoder(),
ece9304c RL	230	* and to use fallback methods if the result is NULL.
ece9304c RL	231	*/
fe75766c TM	232	static int ossl_encoder_ctx_setup_for_pkey(OSSL_ENCODER_CTX *ctx,
	233	const EVP_PKEY *pkey,
	234	int selection,
	235	const char *propquery)
ece9304c	236	{
b8975c68	237	struct construct_data_st *data = NULL;
021521aa	238	const OSSL_PROVIDER *prov = NULL;
cbcbac64	239	OSSL_LIB_CTX *libctx = NULL;
c3b46409	240	int ok = 0, i, end;
c3b46409	241	OSSL_NAMEMAP *namemap;
ece9304c	242
b8975c68	243	if (!ossl_assert(ctx != NULL) \|\| !ossl_assert(pkey != NULL)) {
ece9304c	244	ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_PASSED_NULL_PARAMETER);
b8975c68	245	return 0;
ece9304c RL	246	}
ece9304c RL	247
cbcbac64	248	if (evp_pkey_is_provided(pkey)) {
ed576acd	249	prov = EVP_KEYMGMT_get0_provider(pkey->keymgmt);
cbcbac64 RL	250	libctx = ossl_provider_libctx(prov);
	251	}
	252
b8975c68	253	if (pkey->keymgmt != NULL) {
b8975c68 RL	254	struct collected_encoder_st encoder_data;
b8975c68 RL	255	struct collected_names_st keymgmt_data;
ece9304c	256
e077455e	257	if ((data = OPENSSL_zalloc(sizeof(*data))) == NULL)
b8975c68	258	goto err;
b8975c68	259
ece9304c	260	/*
b9a2afdf RL	261	* Select the first encoder implementations in two steps.
b9a2afdf RL	262	* First, collect the keymgmt names, then the encoders that match.
ece9304c	263	*/
b8975c68	264	keymgmt_data.names = sk_OPENSSL_CSTRING_new_null();
5266af87	265	if (keymgmt_data.names == NULL) {
e077455e	266	ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_CRYPTO_LIB);
5266af87	267	goto err;
	268	}
	269
e3a2ba75	270	keymgmt_data.error_occurred = 0;
b8975c68	271	EVP_KEYMGMT_names_do_all(pkey->keymgmt, collect_name, &keymgmt_data);
e3a2ba75	272	if (keymgmt_data.error_occurred) {
b9a2afdf RL	273	sk_OPENSSL_CSTRING_free(keymgmt_data.names);
b9a2afdf RL	274	goto err;
ece9304c	275	}
b8975c68	276
b9a2afdf RL	277	encoder_data.names = keymgmt_data.names;
	278	encoder_data.output_type = ctx->output_type;
	279	encoder_data.output_structure = ctx->output_structure;
e3a2ba75	280	encoder_data.error_occurred = 0;
021521aa	281	encoder_data.keymgmt_prov = prov;
b9a2afdf	282	encoder_data.ctx = ctx;
c3b46409	283	encoder_data.id_names = NULL;
f616ad4b	284
c3b46409	285	/*
	286	* collect_encoder() is called many times, and for every call it converts all encoder_data.names
	287	* into namemap ids if it calls OSSL_ENCODER_is_a(). We cache the ids here instead,
	288	* and can use them for encoders with the same provider as the keymgmt.
	289	*/
	290	namemap = ossl_namemap_stored(libctx);
	291	end = sk_OPENSSL_CSTRING_num(encoder_data.names);
	292	if (end > 0) {
	293	encoder_data.id_names = OPENSSL_malloc(end * sizeof(int));
8ef63b6f MC	294	if (encoder_data.id_names == NULL) {
8ef63b6f MC	295	sk_OPENSSL_CSTRING_free(keymgmt_data.names);
c3b46409	296	goto err;
8ef63b6f	297	}
c3b46409	298	for (i = 0; i < end; ++i) {
	299	const char *name = sk_OPENSSL_CSTRING_value(keymgmt_data.names, i);
	300
	301	encoder_data.id_names[i] = ossl_namemap_name2num(namemap, name);
	302	}
	303	}
f616ad4b RL	304	/*
	305	* Place the encoders with the a different provider as the keymgmt
	306	* last (the chain is processed in reverse order)
	307	*/
	308	encoder_data.flag_find_same_provider = 0;
	309	OSSL_ENCODER_do_all_provided(libctx, collect_encoder, &encoder_data);
	310
	311	/*
	312	* Place the encoders with the same provider as the keymgmt first
	313	* (the chain is processed in reverse order)
	314	*/
	315	encoder_data.flag_find_same_provider = 1;
b9a2afdf	316	OSSL_ENCODER_do_all_provided(libctx, collect_encoder, &encoder_data);
f616ad4b	317
c3b46409	318	OPENSSL_free(encoder_data.id_names);
b8975c68	319	sk_OPENSSL_CSTRING_free(keymgmt_data.names);
e3a2ba75	320	if (encoder_data.error_occurred) {
e077455e	321	ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_CRYPTO_LIB);
b9a2afdf RL	322	goto err;
b9a2afdf RL	323	}
ece9304c RL	324	}
ece9304c RL	325
3c4c8dd8	326	if (data != NULL && OSSL_ENCODER_CTX_get_num_encoders(ctx) != 0) {
fe75766c	327	if (!OSSL_ENCODER_CTX_set_construct(ctx, encoder_construct_pkey)
b8975c68	328	\|\| !OSSL_ENCODER_CTX_set_construct_data(ctx, data)
fe75766c	329	\|\| !OSSL_ENCODER_CTX_set_cleanup(ctx, encoder_destruct_pkey))
b8975c68	330	goto err;
ece9304c	331
b8975c68 RL	332	data->pk = pkey;
	333	data->selection = selection;
	334
	335	data = NULL; /* Avoid it being freed */
ece9304c RL	336	}
ece9304c RL	337
b8975c68 RL	338	ok = 1;
	339	err:
	340	if (data != NULL) {
	341	OSSL_ENCODER_CTX_set_construct_data(ctx, NULL);
	342	OPENSSL_free(data);
	343	}
	344	return ok;
ece9304c RL	345	}
ece9304c RL	346
fe75766c TM	347	OSSL_ENCODER_CTX OSSL_ENCODER_CTX_new_for_pkey(const EVP_PKEY pkey,
	348	int selection,
	349	const char *output_type,
	350	const char *output_struct,
	351	const char *propquery)
b8975c68 RL	352	{
b8975c68 RL	353	OSSL_ENCODER_CTX *ctx = NULL;
cbcbac64 RL	354	OSSL_LIB_CTX *libctx = NULL;
	355
	356	if (pkey == NULL) {
	357	ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_PASSED_NULL_PARAMETER);
	358	return NULL;
	359	}
	360
	361	if (!evp_pkey_is_assigned(pkey)) {
	362	ERR_raise_data(ERR_LIB_OSSL_ENCODER, ERR_R_PASSED_INVALID_ARGUMENT,
	363	"The passed EVP_PKEY must be assigned a key");
	364	return NULL;
	365	}
b8975c68 RL	366
b8975c68 RL	367	if ((ctx = OSSL_ENCODER_CTX_new()) == NULL) {
e077455e	368	ERR_raise(ERR_LIB_OSSL_ENCODER, ERR_R_OSSL_ENCODER_LIB);
b8975c68 RL	369	return NULL;
b8975c68 RL	370	}
0b9f90f5	371
cbcbac64	372	if (evp_pkey_is_provided(pkey)) {
ed576acd	373	const OSSL_PROVIDER *prov = EVP_KEYMGMT_get0_provider(pkey->keymgmt);
cbcbac64 RL	374
	375	libctx = ossl_provider_libctx(prov);
	376	}
	377
0b9f90f5 RL	378	OSSL_TRACE_BEGIN(ENCODER) {
	379	BIO_printf(trc_out,
	380	"(ctx %p) Looking for %s encoders with selection %d\n",
ddf0d149	381	(void *)ctx, EVP_PKEY_get0_type_name(pkey), selection);
0b9f90f5 RL	382	BIO_printf(trc_out, " output type: %s, output structure: %s\n",
	383	output_type, output_struct);
	384	} OSSL_TRACE_END(ENCODER);
	385
b8975c68	386	if (OSSL_ENCODER_CTX_set_output_type(ctx, output_type)
b9a2afdf RL	387	&& (output_struct == NULL
b9a2afdf RL	388	\|\| OSSL_ENCODER_CTX_set_output_structure(ctx, output_struct))
b8975c68	389	&& OSSL_ENCODER_CTX_set_selection(ctx, selection)
fe75766c	390	&& ossl_encoder_ctx_setup_for_pkey(ctx, pkey, selection, propquery)
0b9f90f5	391	&& OSSL_ENCODER_CTX_add_extra(ctx, libctx, propquery)) {
78043fe8 TM	392	OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
	393	int save_parameters = pkey->save_parameters;
	394
	395	params[0] = OSSL_PARAM_construct_int(OSSL_ENCODER_PARAM_SAVE_PARAMETERS,
	396	&save_parameters);
	397	/* ignoring error as this is only auxiliary parameter */
	398	(void)OSSL_ENCODER_CTX_set_params(ctx, params);
	399
0b9f90f5 RL	400	OSSL_TRACE_BEGIN(ENCODER) {
	401	BIO_printf(trc_out, "(ctx %p) Got %d encoders\n",
	402	(void *)ctx, OSSL_ENCODER_CTX_get_num_encoders(ctx));
	403	} OSSL_TRACE_END(ENCODER);
b8975c68	404	return ctx;
0b9f90f5	405	}
b8975c68 RL	406
	407	OSSL_ENCODER_CTX_free(ctx);
	408	return NULL;
	409	}