[thirdparty/openssl.git] / providers / implementations / serializers / serializer_dh_priv.c

/*
 * Copyright 2019 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/core_numbers.h>
#include <openssl/core_names.h>
#include <openssl/err.h>
#include <openssl/pem.h>
#include <openssl/dh.h>
#include <openssl/types.h>
#include <openssl/params.h>
#include "prov/bio.h"
#include "prov/implementations.h"
#include "serializer_local.h"

static OSSL_OP_serializer_newctx_fn dh_priv_newctx;
static OSSL_OP_serializer_freectx_fn dh_priv_freectx;
static OSSL_OP_serializer_set_ctx_params_fn dh_priv_set_ctx_params;
static OSSL_OP_serializer_settable_ctx_params_fn dh_priv_settable_ctx_params;
static OSSL_OP_serializer_serialize_data_fn dh_priv_der_data;
static OSSL_OP_serializer_serialize_object_fn dh_priv_der;
static OSSL_OP_serializer_serialize_data_fn dh_pem_priv_data;
static OSSL_OP_serializer_serialize_object_fn dh_pem_priv;

static OSSL_OP_serializer_newctx_fn dh_print_newctx;
static OSSL_OP_serializer_freectx_fn dh_print_freectx;
static OSSL_OP_serializer_serialize_data_fn dh_priv_print_data;
static OSSL_OP_serializer_serialize_object_fn dh_priv_print;

 /*
 * Context used for private key serialization.
 */
struct dh_priv_ctx_st {
    void *provctx;

    struct pkcs8_encrypt_ctx_st sc;
};

/* Private key : context */
static void *dh_priv_newctx(void *provctx)
{
    struct dh_priv_ctx_st *ctx = OPENSSL_zalloc(sizeof(*ctx));

    if (ctx != NULL) {
        ctx->provctx = provctx;

        /* -1 is the "whatever" indicator, i.e. the PKCS8 library default PBE */
        ctx->sc.pbe_nid = -1;
    }
    return ctx;
}

static void dh_priv_freectx(void *vctx)
{
    struct dh_priv_ctx_st *ctx = vctx;

    EVP_CIPHER_free(ctx->sc.cipher);
    OPENSSL_free(ctx->sc.cipher_pass);
    OPENSSL_free(ctx);
}

static const OSSL_PARAM *dh_priv_settable_ctx_params(void)
{
    static const OSSL_PARAM settables[] = {
        OSSL_PARAM_utf8_string(OSSL_SERIALIZER_PARAM_CIPHER, NULL, 0),
        OSSL_PARAM_octet_string(OSSL_SERIALIZER_PARAM_PASS, NULL, 0),
        OSSL_PARAM_END,
    };

    return settables;
}

static int dh_priv_set_ctx_params(void *vctx, const OSSL_PARAM params[])
{
    struct dh_priv_ctx_st *ctx = vctx;
    const OSSL_PARAM *p;

    if ((p = OSSL_PARAM_locate_const(params, OSSL_SERIALIZER_PARAM_CIPHER))
        != NULL) {
        const OSSL_PARAM *propsp =
            OSSL_PARAM_locate_const(params, OSSL_SERIALIZER_PARAM_PROPERTIES);
        const char *props = NULL;

        if (p->data_type != OSSL_PARAM_UTF8_STRING)
            return 0;
        if (propsp != NULL && propsp->data_type != OSSL_PARAM_UTF8_STRING)
            return 0;
        props = (propsp != NULL ? propsp->data : NULL);

        EVP_CIPHER_free(ctx->sc.cipher);
        ctx->sc.cipher_intent = p->data != NULL;
        if (p->data != NULL
            && ((ctx->sc.cipher = EVP_CIPHER_fetch(NULL, p->data, props))
                == NULL))
            return 0;
    }
    if ((p = OSSL_PARAM_locate_const(params, OSSL_SERIALIZER_PARAM_PASS))
        != NULL) {
        OPENSSL_free(ctx->sc.cipher_pass);
        ctx->sc.cipher_pass = NULL;
        if (!OSSL_PARAM_get_octet_string(p, &ctx->sc.cipher_pass, 0,
                                         &ctx->sc.cipher_pass_length))
            return 0;
    }
    return 1;
}

/* Private key : DER */
static int dh_priv_der_data(void *vctx, const OSSL_PARAM params[], BIO *out,
                            OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    struct dh_priv_ctx_st *ctx = vctx;
    OSSL_OP_keymgmt_new_fn *dh_new = ossl_prov_get_keymgmt_dh_new();
    OSSL_OP_keymgmt_free_fn *dh_free = ossl_prov_get_keymgmt_dh_free();
    OSSL_OP_keymgmt_import_fn *dh_import = ossl_prov_get_keymgmt_dh_import();
    int ok = 0;

    if (dh_import != NULL) {
        DH *dh;

        if ((dh = dh_new(ctx->provctx)) != NULL
            && dh_import(dh, OSSL_KEYMGMT_SELECT_KEYPAIR, params)
            && dh_priv_der(ctx, dh, out, cb, cbarg))
            ok = 1;
        dh_free(dh);
    }
    return ok;
}

static int dh_priv_der(void *vctx, void *dh, BIO *out,
                        OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    struct dh_priv_ctx_st *ctx = vctx;
    int ret;

    ctx->sc.cb = cb;
    ctx->sc.cbarg = cbarg;

    ret = ossl_prov_write_priv_der_from_obj(out, dh, EVP_PKEY_DH,
                                            ossl_prov_prepare_dh_params,
                                            ossl_prov_dh_priv_to_der,
                                            &ctx->sc);

    return ret;
}

/* Private key : PEM */
static int dh_pem_priv_data(void *vctx, const OSSL_PARAM params[], BIO *out,
                            OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    struct dh_priv_ctx_st *ctx = vctx;
    OSSL_OP_keymgmt_new_fn *dh_new = ossl_prov_get_keymgmt_dh_new();
    OSSL_OP_keymgmt_free_fn *dh_free = ossl_prov_get_keymgmt_dh_free();
    OSSL_OP_keymgmt_import_fn *dh_import = ossl_prov_get_keymgmt_dh_import();
    int ok = 0;

    if (dh_import != NULL) {
        DH *dh;

        if ((dh = dh_new(ctx->provctx)) != NULL
            && dh_import(dh, OSSL_KEYMGMT_SELECT_KEYPAIR, params)
            && dh_pem_priv(ctx->provctx, dh, out, cb, cbarg))
            ok = 1;
        dh_free(dh);
    }
    return ok;
}

static int dh_pem_priv(void *vctx, void *dh, BIO *out,
                       OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    struct dh_priv_ctx_st *ctx = vctx;
    int ret;

    ctx->sc.cb = cb;
    ctx->sc.cbarg = cbarg;

    ret = ossl_prov_write_priv_pem_from_obj(out, dh, EVP_PKEY_DH,
                                            ossl_prov_prepare_dh_params,
                                            ossl_prov_dh_priv_to_der,
                                            &ctx->sc);

    return ret;
}

/*
 * There's no specific print context, so we use the provider context
 */
static void *dh_print_newctx(void *provctx)
{
    return provctx;
}

static void dh_print_freectx(void *ctx)
{
}

static int dh_priv_print_data(void *vctx, const OSSL_PARAM params[], BIO *out,
                              OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    struct dh_priv_ctx_st *ctx = vctx;
    OSSL_OP_keymgmt_new_fn *dh_new = ossl_prov_get_keymgmt_dh_new();
    OSSL_OP_keymgmt_free_fn *dh_free = ossl_prov_get_keymgmt_dh_free();
    OSSL_OP_keymgmt_import_fn *dh_import = ossl_prov_get_keymgmt_dh_import();
    int ok = 0;

    if (dh_import != NULL) {
        DH *dh;

        if ((dh = dh_new(ctx->provctx)) != NULL
            && dh_import(dh, OSSL_KEYMGMT_SELECT_KEYPAIR, params)
            && dh_priv_print(ctx, dh, out, cb, cbarg))
            ok = 1;
        dh_free(dh);
    }
    return ok;
}

static int dh_priv_print(void *ctx, void *dh, BIO *out,
                         OSSL_PASSPHRASE_CALLBACK *cb, void *cbarg)
{
    return ossl_prov_print_dh(out, dh, dh_print_priv);
}

const OSSL_DISPATCH dh_priv_der_serializer_functions[] = {
    { OSSL_FUNC_SERIALIZER_NEWCTX, (void (*)(void))dh_priv_newctx },
    { OSSL_FUNC_SERIALIZER_FREECTX, (void (*)(void))dh_priv_freectx },
    { OSSL_FUNC_SERIALIZER_SET_CTX_PARAMS,
      (void (*)(void))dh_priv_set_ctx_params },
    { OSSL_FUNC_SERIALIZER_SETTABLE_CTX_PARAMS,
      (void (*)(void))dh_priv_settable_ctx_params },
    { OSSL_FUNC_SERIALIZER_SERIALIZE_DATA, (void (*)(void))dh_priv_der_data },
    { OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT, (void (*)(void))dh_priv_der },
    { 0, NULL }
};

const OSSL_DISPATCH dh_priv_pem_serializer_functions[] = {
    { OSSL_FUNC_SERIALIZER_NEWCTX, (void (*)(void))dh_priv_newctx },
    { OSSL_FUNC_SERIALIZER_FREECTX, (void (*)(void))dh_priv_freectx },
    { OSSL_FUNC_SERIALIZER_SET_CTX_PARAMS,
      (void (*)(void))dh_priv_set_ctx_params },
    { OSSL_FUNC_SERIALIZER_SETTABLE_CTX_PARAMS,
      (void (*)(void))dh_priv_settable_ctx_params },
    { OSSL_FUNC_SERIALIZER_SERIALIZE_DATA, (void (*)(void))dh_pem_priv_data },
    { OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT, (void (*)(void))dh_pem_priv },
    { 0, NULL }
};

const OSSL_DISPATCH dh_priv_text_serializer_functions[] = {
    { OSSL_FUNC_SERIALIZER_NEWCTX, (void (*)(void))dh_print_newctx },
    { OSSL_FUNC_SERIALIZER_FREECTX, (void (*)(void))dh_print_freectx },
    { OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT, (void (*)(void))dh_priv_print },
    { OSSL_FUNC_SERIALIZER_SERIALIZE_DATA,
      (void (*)(void))dh_priv_print_data },
    { 0, NULL }
};
Commit	Line	Data
045e51cb RL	1	/*
	2	* Copyright 2019 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	#include <openssl/core_numbers.h>
	11	#include <openssl/core_names.h>
	12	#include <openssl/err.h>
	13	#include <openssl/pem.h>
	14	#include <openssl/dh.h>
	15	#include <openssl/types.h>
	16	#include <openssl/params.h>
	17	#include "prov/bio.h"
	18	#include "prov/implementations.h"
	19	#include "serializer_local.h"
	20
	21	static OSSL_OP_serializer_newctx_fn dh_priv_newctx;
	22	static OSSL_OP_serializer_freectx_fn dh_priv_freectx;
	23	static OSSL_OP_serializer_set_ctx_params_fn dh_priv_set_ctx_params;
	24	static OSSL_OP_serializer_settable_ctx_params_fn dh_priv_settable_ctx_params;
	25	static OSSL_OP_serializer_serialize_data_fn dh_priv_der_data;
	26	static OSSL_OP_serializer_serialize_object_fn dh_priv_der;
	27	static OSSL_OP_serializer_serialize_data_fn dh_pem_priv_data;
	28	static OSSL_OP_serializer_serialize_object_fn dh_pem_priv;
	29
	30	static OSSL_OP_serializer_newctx_fn dh_print_newctx;
	31	static OSSL_OP_serializer_freectx_fn dh_print_freectx;
	32	static OSSL_OP_serializer_serialize_data_fn dh_priv_print_data;
	33	static OSSL_OP_serializer_serialize_object_fn dh_priv_print;
	34
	35	/*
	36	* Context used for private key serialization.
	37	*/
	38	struct dh_priv_ctx_st {
	39	void *provctx;
	40
	41	struct pkcs8_encrypt_ctx_st sc;
	42	};
	43
	44	/* Private key : context */
	45	static void dh_priv_newctx(void provctx)
	46	{
	47	struct dh_priv_ctx_st ctx = OPENSSL_zalloc(sizeof(ctx));
	48
	49	if (ctx != NULL) {
	50	ctx->provctx = provctx;
045e51cb	51
4c1e06fc P	52	/* -1 is the "whatever" indicator, i.e. the PKCS8 library default PBE */
	53	ctx->sc.pbe_nid = -1;
	54	}
045e51cb RL	55	return ctx;
	56	}
	57
	58	static void dh_priv_freectx(void *vctx)
	59	{
	60	struct dh_priv_ctx_st *ctx = vctx;
	61
	62	EVP_CIPHER_free(ctx->sc.cipher);
	63	OPENSSL_free(ctx->sc.cipher_pass);
	64	OPENSSL_free(ctx);
	65	}
	66
	67	static const OSSL_PARAM *dh_priv_settable_ctx_params(void)
	68	{
	69	static const OSSL_PARAM settables[] = {
	70	OSSL_PARAM_utf8_string(OSSL_SERIALIZER_PARAM_CIPHER, NULL, 0),
	71	OSSL_PARAM_octet_string(OSSL_SERIALIZER_PARAM_PASS, NULL, 0),
	72	OSSL_PARAM_END,
	73	};
	74
	75	return settables;
	76	}
	77
	78	static int dh_priv_set_ctx_params(void *vctx, const OSSL_PARAM params[])
	79	{
	80	struct dh_priv_ctx_st *ctx = vctx;
	81	const OSSL_PARAM *p;
	82
	83	if ((p = OSSL_PARAM_locate_const(params, OSSL_SERIALIZER_PARAM_CIPHER))
	84	!= NULL) {
	85	const OSSL_PARAM *propsp =
	86	OSSL_PARAM_locate_const(params, OSSL_SERIALIZER_PARAM_PROPERTIES);
	87	const char *props = NULL;
	88
	89	if (p->data_type != OSSL_PARAM_UTF8_STRING)
	90	return 0;
	91	if (propsp != NULL && propsp->data_type != OSSL_PARAM_UTF8_STRING)
	92	return 0;
	93	props = (propsp != NULL ? propsp->data : NULL);
	94
	95	EVP_CIPHER_free(ctx->sc.cipher);
	96	ctx->sc.cipher_intent = p->data != NULL;
	97	if (p->data != NULL
	98	&& ((ctx->sc.cipher = EVP_CIPHER_fetch(NULL, p->data, props))
	99	== NULL))
	100	return 0;
	101	}
	102	if ((p = OSSL_PARAM_locate_const(params, OSSL_SERIALIZER_PARAM_PASS))
	103	!= NULL) {
	104	OPENSSL_free(ctx->sc.cipher_pass);
	105	ctx->sc.cipher_pass = NULL;
	106	if (!OSSL_PARAM_get_octet_string(p, &ctx->sc.cipher_pass, 0,
	107	&ctx->sc.cipher_pass_length))
	108	return 0;
	109	}
	110	return 1;
	111	}
	112
	113	/* Private key : DER */
	114	static int dh_priv_der_data(void vctx, const OSSL_PARAM params[], BIO out,
32b0645c	115	OSSL_PASSPHRASE_CALLBACK cb, void cbarg)
045e51cb RL	116	{
045e51cb RL	117	struct dh_priv_ctx_st *ctx = vctx;
32b0645c RL	118	OSSL_OP_keymgmt_new_fn *dh_new = ossl_prov_get_keymgmt_dh_new();
	119	OSSL_OP_keymgmt_free_fn *dh_free = ossl_prov_get_keymgmt_dh_free();
	120	OSSL_OP_keymgmt_import_fn *dh_import = ossl_prov_get_keymgmt_dh_import();
045e51cb RL	121	int ok = 0;
045e51cb RL	122
32b0645c RL	123	if (dh_import != NULL) {
32b0645c RL	124	DH *dh;
045e51cb	125
32b0645c RL	126	if ((dh = dh_new(ctx->provctx)) != NULL
	127	&& dh_import(dh, OSSL_KEYMGMT_SELECT_KEYPAIR, params)
	128	&& dh_priv_der(ctx, dh, out, cb, cbarg))
	129	ok = 1;
	130	dh_free(dh);
045e51cb RL	131	}
	132	return ok;
	133	}
	134
	135	static int dh_priv_der(void vctx, void dh, BIO *out,
	136	OSSL_PASSPHRASE_CALLBACK cb, void cbarg)
	137	{
	138	struct dh_priv_ctx_st *ctx = vctx;
	139	int ret;
	140
	141	ctx->sc.cb = cb;
	142	ctx->sc.cbarg = cbarg;
	143
	144	ret = ossl_prov_write_priv_der_from_obj(out, dh, EVP_PKEY_DH,
	145	ossl_prov_prepare_dh_params,
	146	ossl_prov_dh_priv_to_der,
	147	&ctx->sc);
	148
	149	return ret;
	150	}
	151
	152	/* Private key : PEM */
	153	static int dh_pem_priv_data(void vctx, const OSSL_PARAM params[], BIO out,
32b0645c	154	OSSL_PASSPHRASE_CALLBACK cb, void cbarg)
045e51cb RL	155	{
045e51cb RL	156	struct dh_priv_ctx_st *ctx = vctx;
32b0645c RL	157	OSSL_OP_keymgmt_new_fn *dh_new = ossl_prov_get_keymgmt_dh_new();
	158	OSSL_OP_keymgmt_free_fn *dh_free = ossl_prov_get_keymgmt_dh_free();
	159	OSSL_OP_keymgmt_import_fn *dh_import = ossl_prov_get_keymgmt_dh_import();
045e51cb RL	160	int ok = 0;
045e51cb RL	161
32b0645c RL	162	if (dh_import != NULL) {
32b0645c RL	163	DH *dh;
045e51cb	164
32b0645c RL	165	if ((dh = dh_new(ctx->provctx)) != NULL
	166	&& dh_import(dh, OSSL_KEYMGMT_SELECT_KEYPAIR, params)
	167	&& dh_pem_priv(ctx->provctx, dh, out, cb, cbarg))
	168	ok = 1;
	169	dh_free(dh);
045e51cb RL	170	}
	171	return ok;
	172	}
	173
	174	static int dh_pem_priv(void vctx, void dh, BIO *out,
32b0645c	175	OSSL_PASSPHRASE_CALLBACK cb, void cbarg)
045e51cb RL	176	{
	177	struct dh_priv_ctx_st *ctx = vctx;
	178	int ret;
	179
	180	ctx->sc.cb = cb;
	181	ctx->sc.cbarg = cbarg;
	182
	183	ret = ossl_prov_write_priv_pem_from_obj(out, dh, EVP_PKEY_DH,
	184	ossl_prov_prepare_dh_params,
	185	ossl_prov_dh_priv_to_der,
	186	&ctx->sc);
	187
	188	return ret;
	189	}
	190
	191	/*
	192	* There's no specific print context, so we use the provider context
	193	*/
	194	static void dh_print_newctx(void provctx)
	195	{
	196	return provctx;
	197	}
	198
	199	static void dh_print_freectx(void *ctx)
	200	{
	201	}
	202
32b0645c RL	203	static int dh_priv_print_data(void vctx, const OSSL_PARAM params[], BIO out,
32b0645c RL	204	OSSL_PASSPHRASE_CALLBACK cb, void cbarg)
045e51cb	205	{
32b0645c RL	206	struct dh_priv_ctx_st *ctx = vctx;
	207	OSSL_OP_keymgmt_new_fn *dh_new = ossl_prov_get_keymgmt_dh_new();
	208	OSSL_OP_keymgmt_free_fn *dh_free = ossl_prov_get_keymgmt_dh_free();
	209	OSSL_OP_keymgmt_import_fn *dh_import = ossl_prov_get_keymgmt_dh_import();
045e51cb RL	210	int ok = 0;
045e51cb RL	211
32b0645c RL	212	if (dh_import != NULL) {
32b0645c RL	213	DH *dh;
045e51cb	214
32b0645c RL	215	if ((dh = dh_new(ctx->provctx)) != NULL
	216	&& dh_import(dh, OSSL_KEYMGMT_SELECT_KEYPAIR, params)
	217	&& dh_priv_print(ctx, dh, out, cb, cbarg))
	218	ok = 1;
	219	dh_free(dh);
045e51cb RL	220	}
	221	return ok;
	222	}
	223
	224	static int dh_priv_print(void ctx, void dh, BIO *out,
32b0645c	225	OSSL_PASSPHRASE_CALLBACK cb, void cbarg)
045e51cb RL	226	{
	227	return ossl_prov_print_dh(out, dh, dh_print_priv);
	228	}
	229
	230	const OSSL_DISPATCH dh_priv_der_serializer_functions[] = {
	231	{ OSSL_FUNC_SERIALIZER_NEWCTX, (void (*)(void))dh_priv_newctx },
	232	{ OSSL_FUNC_SERIALIZER_FREECTX, (void (*)(void))dh_priv_freectx },
	233	{ OSSL_FUNC_SERIALIZER_SET_CTX_PARAMS,
	234	(void (*)(void))dh_priv_set_ctx_params },
	235	{ OSSL_FUNC_SERIALIZER_SETTABLE_CTX_PARAMS,
	236	(void (*)(void))dh_priv_settable_ctx_params },
	237	{ OSSL_FUNC_SERIALIZER_SERIALIZE_DATA, (void (*)(void))dh_priv_der_data },
	238	{ OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT, (void (*)(void))dh_priv_der },
	239	{ 0, NULL }
	240	};
	241
	242	const OSSL_DISPATCH dh_priv_pem_serializer_functions[] = {
	243	{ OSSL_FUNC_SERIALIZER_NEWCTX, (void (*)(void))dh_priv_newctx },
	244	{ OSSL_FUNC_SERIALIZER_FREECTX, (void (*)(void))dh_priv_freectx },
	245	{ OSSL_FUNC_SERIALIZER_SET_CTX_PARAMS,
	246	(void (*)(void))dh_priv_set_ctx_params },
	247	{ OSSL_FUNC_SERIALIZER_SETTABLE_CTX_PARAMS,
	248	(void (*)(void))dh_priv_settable_ctx_params },
	249	{ OSSL_FUNC_SERIALIZER_SERIALIZE_DATA, (void (*)(void))dh_pem_priv_data },
	250	{ OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT, (void (*)(void))dh_pem_priv },
	251	{ 0, NULL }
	252	};
	253
	254	const OSSL_DISPATCH dh_priv_text_serializer_functions[] = {
	255	{ OSSL_FUNC_SERIALIZER_NEWCTX, (void (*)(void))dh_print_newctx },
	256	{ OSSL_FUNC_SERIALIZER_FREECTX, (void (*)(void))dh_print_freectx },
	257	{ OSSL_FUNC_SERIALIZER_SERIALIZE_OBJECT, (void (*)(void))dh_priv_print },
	258	{ OSSL_FUNC_SERIALIZER_SERIALIZE_DATA,
	259	(void (*)(void))dh_priv_print_data },
	260	{ 0, NULL }
	261	};