/src/openssl/crypto/ec/ecx_backend.c

Source (jump to first uncovered line)
/*
 * Copyright 2020-2024 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 <string.h>
#include <openssl/core_names.h>
#include <openssl/params.h>
#include <openssl/ec.h>
#include <openssl/rand.h>
#include <openssl/err.h>
#ifndef FIPS_MODULE
# include <openssl/x509.h>
#endif
#include "crypto/ecx.h"
#include "ecx_backend.h"

/*
 * The intention with the "backend" source file is to offer backend support
 * for legacy backends (EVP_PKEY_ASN1_METHOD and EVP_PKEY_METHOD) and provider
 * implementations alike.
 */

int ossl_ecx_public_from_private(ECX_KEY *key)
{
    switch (key->type) {
    case ECX_KEY_TYPE_X25519:
        ossl_x25519_public_from_private(key->pubkey, key->privkey);
        break;
    case ECX_KEY_TYPE_ED25519:
        if (!ossl_ed25519_public_from_private(key->libctx, key->pubkey,
                                              key->privkey, key->propq)) {
            ERR_raise(ERR_LIB_EC, EC_R_FAILED_MAKING_PUBLIC_KEY);
            return 0;
        }
        break;
    case ECX_KEY_TYPE_X448:
        ossl_x448_public_from_private(key->pubkey, key->privkey);
        break;
    case ECX_KEY_TYPE_ED448:
        if (!ossl_ed448_public_from_private(key->libctx, key->pubkey,
                                            key->privkey, key->propq)) {
            ERR_raise(ERR_LIB_EC, EC_R_FAILED_MAKING_PUBLIC_KEY);
            return 0;
        }
        break;
    }
    return 1;
}

int ossl_ecx_key_fromdata(ECX_KEY *ecx, const OSSL_PARAM params[],
                          int include_private)
{
    size_t privkeylen = 0, pubkeylen = 0;
    const OSSL_PARAM *param_priv_key = NULL, *param_pub_key;
    unsigned char *pubkey;

    if (ecx == NULL)
        return 0;

    param_pub_key = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY);
    if (include_private)
        param_priv_key =
            OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY);

    if (param_pub_key == NULL && param_priv_key == NULL)
        return 0;

    if (param_priv_key != NULL) {
        if (!OSSL_PARAM_get_octet_string(param_priv_key,
                                         (void **)&ecx->privkey, ecx->keylen,
                                         &privkeylen))
            return 0;
        if (privkeylen != ecx->keylen) {
            /*
             * Invalid key length. We will clear what we've received now. We
             * can't leave it to ossl_ecx_key_free() because that will call
             * OPENSSL_secure_clear_free() and assume the correct key length
             */
            OPENSSL_secure_clear_free(ecx->privkey, privkeylen);
            ecx->privkey = NULL;
            return 0;
        }
    }


    pubkey = ecx->pubkey;
    if (param_pub_key != NULL
        && !OSSL_PARAM_get_octet_string(param_pub_key,
                                        (void **)&pubkey,
                                         sizeof(ecx->pubkey), &pubkeylen))
        return 0;

    if ((param_pub_key != NULL && pubkeylen != ecx->keylen))
        return 0;

    if (param_pub_key == NULL && !ossl_ecx_public_from_private(ecx))
        return 0;

    ecx->haspubkey = 1;

    return 1;
}

ECX_KEY *ossl_ecx_key_dup(const ECX_KEY *key, int selection)
{
    ECX_KEY *ret = OPENSSL_zalloc(sizeof(*ret));

    if (ret == NULL)
        return NULL;

    ret->libctx = key->libctx;
    ret->haspubkey = 0;
    ret->keylen = key->keylen;
    ret->type = key->type;

    if (!CRYPTO_NEW_REF(&ret->references, 1))
        goto err;

    if (key->propq != NULL) {
        ret->propq = OPENSSL_strdup(key->propq);
        if (ret->propq == NULL)
            goto err;
    }

    if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0
        && key->haspubkey == 1) {
        memcpy(ret->pubkey, key->pubkey, sizeof(ret->pubkey));
        ret->haspubkey = 1;
    }

    if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0
        && key->privkey != NULL) {
        if (ossl_ecx_key_allocate_privkey(ret) == NULL) {
            ERR_raise(ERR_LIB_EC, ERR_R_EC_LIB);
            goto err;
        }
        memcpy(ret->privkey, key->privkey, ret->keylen);
    }

    return ret;

err:
    CRYPTO_FREE_REF(&ret->references);
    ossl_ecx_key_free(ret);
    return NULL;
}

#ifndef FIPS_MODULE
ECX_KEY *ossl_ecx_key_op(const X509_ALGOR *palg,
                         const unsigned char *p, int plen,
                         int id, ecx_key_op_t op,
                         OSSL_LIB_CTX *libctx, const char *propq)
{
    ECX_KEY *key = NULL;
    unsigned char *privkey, *pubkey;

    if (op != KEY_OP_KEYGEN) {
        if (palg != NULL) {
            int ptype;

            /* Algorithm parameters must be absent */
            X509_ALGOR_get0(NULL, &ptype, NULL, palg);
            if (ptype != V_ASN1_UNDEF) {
                ERR_raise(ERR_LIB_EC, EC_R_INVALID_ENCODING);
                return 0;
            }
            if (id == EVP_PKEY_NONE)
                id = OBJ_obj2nid(palg->algorithm);
            else if (id != OBJ_obj2nid(palg->algorithm)) {
                ERR_raise(ERR_LIB_EC, EC_R_INVALID_ENCODING);
                return 0;
            }
        }

        if (p == NULL || id == EVP_PKEY_NONE || plen != KEYLENID(id)) {
            ERR_raise(ERR_LIB_EC, EC_R_INVALID_ENCODING);
            return 0;
        }
    }

    key = ossl_ecx_key_new(libctx, KEYNID2TYPE(id), 1, propq);
    if (key == NULL) {
        ERR_raise(ERR_LIB_EC, ERR_R_EC_LIB);
        return 0;
    }
    pubkey = key->pubkey;

    if (op == KEY_OP_PUBLIC) {
        memcpy(pubkey, p, plen);
    } else {
        privkey = ossl_ecx_key_allocate_privkey(key);
        if (privkey == NULL) {
            ERR_raise(ERR_LIB_EC, ERR_R_EC_LIB);
            goto err;
        }
        if (op == KEY_OP_KEYGEN) {
            if (id != EVP_PKEY_NONE) {
                if (RAND_priv_bytes_ex(libctx, privkey, KEYLENID(id), 0) <= 0)
                    goto err;
                if (id == EVP_PKEY_X25519) {
                    privkey[0] &= 248;
                    privkey[X25519_KEYLEN - 1] &= 127;
                    privkey[X25519_KEYLEN - 1] |= 64;
                } else if (id == EVP_PKEY_X448) {
                    privkey[0] &= 252;
                    privkey[X448_KEYLEN - 1] |= 128;
                }
            }
        } else {
            memcpy(privkey, p, KEYLENID(id));
        }
        if (!ossl_ecx_public_from_private(key)) {
            ERR_raise(ERR_LIB_EC, EC_R_FAILED_MAKING_PUBLIC_KEY);
            goto err;
        }
    }

    return key;
 err:
    ossl_ecx_key_free(key);
    return NULL;
}

ECX_KEY *ossl_ecx_key_from_pkcs8(const PKCS8_PRIV_KEY_INFO *p8inf,
                                 OSSL_LIB_CTX *libctx, const char *propq)
{
    ECX_KEY *ecx = NULL;
    const unsigned char *p;
    int plen;
    ASN1_OCTET_STRING *oct = NULL;
    const X509_ALGOR *palg;

    if (!PKCS8_pkey_get0(NULL, &p, &plen, &palg, p8inf))
        return 0;

    oct = d2i_ASN1_OCTET_STRING(NULL, &p, plen);
    if (oct == NULL) {
        p = NULL;
        plen = 0;
    } else {
        p = ASN1_STRING_get0_data(oct);
        plen = ASN1_STRING_length(oct);
    }

    /*
     * EVP_PKEY_NONE means that ecx_key_op() has to figure out the key type
     * on its own.
     */
    ecx = ossl_ecx_key_op(palg, p, plen, EVP_PKEY_NONE, KEY_OP_PRIVATE,
                          libctx, propq);
    ASN1_OCTET_STRING_free(oct);
    return ecx;
}
#endif

Coverage Report

Created: 2025-06-13 06:56

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright 2020-2024 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 <string.h>
11		#include <openssl/core_names.h>
12		#include <openssl/params.h>
13		#include <openssl/ec.h>
14		#include <openssl/rand.h>
15		#include <openssl/err.h>
16		#ifndef FIPS_MODULE
17		# include <openssl/x509.h>
18		#endif
19		#include "crypto/ecx.h"
20		#include "ecx_backend.h"
21
22		/*
23		* The intention with the "backend" source file is to offer backend support
24		* for legacy backends (EVP_PKEY_ASN1_METHOD and EVP_PKEY_METHOD) and provider
25		* implementations alike.
26		*/
27
28		int ossl_ecx_public_from_private(ECX_KEY *key)
29	0	{
30	0	switch (key->type) {
31	0	case ECX_KEY_TYPE_X25519:
32	0	ossl_x25519_public_from_private(key->pubkey, key->privkey);
33	0	break;
34	0	case ECX_KEY_TYPE_ED25519:
35	0	if (!ossl_ed25519_public_from_private(key->libctx, key->pubkey,
36	0	key->privkey, key->propq)) {
37	0	ERR_raise(ERR_LIB_EC, EC_R_FAILED_MAKING_PUBLIC_KEY);
38	0	return 0;
39	0	}
40	0	break;
41	0	case ECX_KEY_TYPE_X448:
42	0	ossl_x448_public_from_private(key->pubkey, key->privkey);
43	0	break;
44	0	case ECX_KEY_TYPE_ED448:
45	0	if (!ossl_ed448_public_from_private(key->libctx, key->pubkey,
46	0	key->privkey, key->propq)) {
47	0	ERR_raise(ERR_LIB_EC, EC_R_FAILED_MAKING_PUBLIC_KEY);
48	0	return 0;
49	0	}
50	0	break;
51	0	}
52	0	return 1;
53	0	}
54
55		int ossl_ecx_key_fromdata(ECX_KEY *ecx, const OSSL_PARAM params[],
56		int include_private)
57	0	{
58	0	size_t privkeylen = 0, pubkeylen = 0;
59	0	const OSSL_PARAM param_priv_key = NULL, param_pub_key;
60	0	unsigned char *pubkey;
61
62	0	if (ecx == NULL)
63	0	return 0;
64
65	0	param_pub_key = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY);
66	0	if (include_private)
67	0	param_priv_key =
68	0	OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY);
69
70	0	if (param_pub_key == NULL && param_priv_key == NULL)
71	0	return 0;
72
73	0	if (param_priv_key != NULL) {
74	0	if (!OSSL_PARAM_get_octet_string(param_priv_key,
75	0	(void **)&ecx->privkey, ecx->keylen,
76	0	&privkeylen))
77	0	return 0;
78	0	if (privkeylen != ecx->keylen) {
79		/*
80		* Invalid key length. We will clear what we've received now. We
81		* can't leave it to ossl_ecx_key_free() because that will call
82		* OPENSSL_secure_clear_free() and assume the correct key length
83		*/
84	0	OPENSSL_secure_clear_free(ecx->privkey, privkeylen);
85	0	ecx->privkey = NULL;
86	0	return 0;
87	0	}
88	0	}
89
90
91	0	pubkey = ecx->pubkey;
92	0	if (param_pub_key != NULL
93	0	&& !OSSL_PARAM_get_octet_string(param_pub_key,
94	0	(void **)&pubkey,
95	0	sizeof(ecx->pubkey), &pubkeylen))
96	0	return 0;
97
98	0	if ((param_pub_key != NULL && pubkeylen != ecx->keylen))
99	0	return 0;
100
101	0	if (param_pub_key == NULL && !ossl_ecx_public_from_private(ecx))
102	0	return 0;
103
104	0	ecx->haspubkey = 1;
105
106	0	return 1;
107	0	}
108
109		ECX_KEY ossl_ecx_key_dup(const ECX_KEY key, int selection)
110	0	{
111	0	ECX_KEY ret = OPENSSL_zalloc(sizeof(ret));
112
113	0	if (ret == NULL)
114	0	return NULL;
115
116	0	ret->libctx = key->libctx;
117	0	ret->haspubkey = 0;
118	0	ret->keylen = key->keylen;
119	0	ret->type = key->type;
120
121	0	if (!CRYPTO_NEW_REF(&ret->references, 1))
122	0	goto err;
123
124	0	if (key->propq != NULL) {
125	0	ret->propq = OPENSSL_strdup(key->propq);
126	0	if (ret->propq == NULL)
127	0	goto err;
128	0	}
129
130	0	if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0
131	0	&& key->haspubkey == 1) {
132	0	memcpy(ret->pubkey, key->pubkey, sizeof(ret->pubkey));
133	0	ret->haspubkey = 1;
134	0	}
135
136	0	if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0
137	0	&& key->privkey != NULL) {
138	0	if (ossl_ecx_key_allocate_privkey(ret) == NULL) {
139	0	ERR_raise(ERR_LIB_EC, ERR_R_EC_LIB);
140	0	goto err;
141	0	}
142	0	memcpy(ret->privkey, key->privkey, ret->keylen);
143	0	}
144
145	0	return ret;
146
147	0	err:
148	0	CRYPTO_FREE_REF(&ret->references);
149	0	ossl_ecx_key_free(ret);
150	0	return NULL;
151	0	}
152
153		#ifndef FIPS_MODULE
154		ECX_KEY ossl_ecx_key_op(const X509_ALGOR palg,
155		const unsigned char *p, int plen,
156		int id, ecx_key_op_t op,
157		OSSL_LIB_CTX libctx, const char propq)
158	0	{
159	0	ECX_KEY *key = NULL;
160	0	unsigned char privkey, pubkey;
161
162	0	if (op != KEY_OP_KEYGEN) {
163	0	if (palg != NULL) {
164	0	int ptype;
165
166		/* Algorithm parameters must be absent */
167	0	X509_ALGOR_get0(NULL, &ptype, NULL, palg);
168	0	if (ptype != V_ASN1_UNDEF) {
169	0	ERR_raise(ERR_LIB_EC, EC_R_INVALID_ENCODING);
170	0	return 0;
171	0	}
172	0	if (id == EVP_PKEY_NONE)
173	0	id = OBJ_obj2nid(palg->algorithm);
174	0	else if (id != OBJ_obj2nid(palg->algorithm)) {
175	0	ERR_raise(ERR_LIB_EC, EC_R_INVALID_ENCODING);
176	0	return 0;
177	0	}
178	0	}
179
180	0	if (p == NULL \|\| id == EVP_PKEY_NONE \|\| plen != KEYLENID(id)) {
181	0	ERR_raise(ERR_LIB_EC, EC_R_INVALID_ENCODING);
182	0	return 0;
183	0	}
184	0	}
185
186	0	key = ossl_ecx_key_new(libctx, KEYNID2TYPE(id), 1, propq);
187	0	if (key == NULL) {
188	0	ERR_raise(ERR_LIB_EC, ERR_R_EC_LIB);
189	0	return 0;
190	0	}
191	0	pubkey = key->pubkey;
192
193	0	if (op == KEY_OP_PUBLIC) {
194	0	memcpy(pubkey, p, plen);
195	0	} else {
196	0	privkey = ossl_ecx_key_allocate_privkey(key);
197	0	if (privkey == NULL) {
198	0	ERR_raise(ERR_LIB_EC, ERR_R_EC_LIB);
199	0	goto err;
200	0	}
201	0	if (op == KEY_OP_KEYGEN) {
202	0	if (id != EVP_PKEY_NONE) {
203	0	if (RAND_priv_bytes_ex(libctx, privkey, KEYLENID(id), 0) <= 0)
204	0	goto err;
205	0	if (id == EVP_PKEY_X25519) {
206	0	privkey[0] &= 248;
207	0	privkey[X25519_KEYLEN - 1] &= 127;
208	0	privkey[X25519_KEYLEN - 1] \|= 64;
209	0	} else if (id == EVP_PKEY_X448) {
210	0	privkey[0] &= 252;
211	0	privkey[X448_KEYLEN - 1] \|= 128;
212	0	}
213	0	}
214	0	} else {
215	0	memcpy(privkey, p, KEYLENID(id));
216	0	}
217	0	if (!ossl_ecx_public_from_private(key)) {
218	0	ERR_raise(ERR_LIB_EC, EC_R_FAILED_MAKING_PUBLIC_KEY);
219	0	goto err;
220	0	}
221	0	}
222
223	0	return key;
224	0	err:
225	0	ossl_ecx_key_free(key);
226	0	return NULL;
227	0	}
228
229		ECX_KEY ossl_ecx_key_from_pkcs8(const PKCS8_PRIV_KEY_INFO p8inf,
230		OSSL_LIB_CTX libctx, const char propq)
231	0	{
232	0	ECX_KEY *ecx = NULL;
233	0	const unsigned char *p;
234	0	int plen;
235	0	ASN1_OCTET_STRING *oct = NULL;
236	0	const X509_ALGOR *palg;
237
238	0	if (!PKCS8_pkey_get0(NULL, &p, &plen, &palg, p8inf))
239	0	return 0;
240
241	0	oct = d2i_ASN1_OCTET_STRING(NULL, &p, plen);
242	0	if (oct == NULL) {
243	0	p = NULL;
244	0	plen = 0;
245	0	} else {
246	0	p = ASN1_STRING_get0_data(oct);
247	0	plen = ASN1_STRING_length(oct);
248	0	}
249
250		/*
251		* EVP_PKEY_NONE means that ecx_key_op() has to figure out the key type
252		* on its own.
253		*/
254	0	ecx = ossl_ecx_key_op(palg, p, plen, EVP_PKEY_NONE, KEY_OP_PRIVATE,
255	0	libctx, propq);
256	0	ASN1_OCTET_STRING_free(oct);
257	0	return ecx;
258	0	}
259		#endif