]> git.ipfire.org Git - thirdparty/openssl.git/blame - providers/implementations/encode_decode/decode_der2key.c
projects / thirdparty / openssl.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
DECODER & ENCODER: Make sure to pass around the original selection bits
[thirdparty/openssl.git] / providers / implementations / encode_decode / decode_der2key.c
CommitLineData
7c664b1f 1/*
a28d06f3 2 * Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
7c664b1f
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/*
11 * low level APIs are deprecated for public use, but still ok for
12 * internal use.
13 */
14#include "internal/deprecated.h"
15
16#include <openssl/core_dispatch.h>
17#include <openssl/core_names.h>
14c8a3d1 18#include <openssl/core_object.h>
7c664b1f 19#include <openssl/crypto.h>
8ae40cf5 20#include <openssl/err.h>
7c664b1f 21#include <openssl/params.h>
8ae40cf5
RL		 22#include <openssl/pem.h> /* PEM_BUFSIZE and public PEM functions */
23#include <openssl/pkcs12.h>
7c664b1f 24#include <openssl/x509.h>
2741128e 25#include <openssl/proverr.h>
8ae40cf5
RL		 26#include "internal/cryptlib.h" /* ossl_assert() */
27#include "internal/asn1.h"
6963979f
RL		 28#include "crypto/dh.h"
29#include "crypto/dsa.h"
30#include "crypto/ec.h"
576892d7 31#include "crypto/evp.h"
8ae40cf5 32#include "crypto/ecx.h"
6963979f 33#include "crypto/rsa.h"
10315851 34#include "crypto/x509.h"
7c664b1f
RL		 35#include "prov/bio.h"
36#include "prov/implementations.h"
8ae40cf5 37#include "endecoder_local.h"
7c664b1f 38
6963979f 39struct der2key_ctx_st; /* Forward declaration */
65ef000e
RL		 40typedef int check_key_fn(void *, struct der2key_ctx_st *ctx);
41typedef void adjust_key_fn(void *, struct der2key_ctx_st *ctx);
42typedef void free_key_fn(void *);
cf333799 43typedef void *d2i_PKCS8_fn(void **, const unsigned char **, long,
6a2b8ff3 44 struct der2key_ctx_st *);
7c664b1f 45struct keytype_desc_st {
2c090c1d 46 const char *keytype_name;
7c664b1f
RL		 47 const OSSL_DISPATCH *fns; /* Keymgmt (to pilfer functions from) */
48
2c090c1d
RL		 49 /* The input structure name */
50 const char *structure_name;
51
52 /*
53 * The EVP_PKEY_xxx type macro. Should be zero for type specific
54 * structures, non-zero when the outermost structure is PKCS#8 or
55 * SubjectPublicKeyInfo. This determines which of the function
56 * pointers below will be used.
57 */
58 int evp_type;
59
60 /* The selection mask for OSSL_FUNC_decoder_does_selection() */
61 int selection_mask;
62
63 /* For type specific decoders, we use the corresponding d2i */
06f67612
RL		 64 d2i_of_void *d2i_private_key; /* From type-specific DER */
65 d2i_of_void *d2i_public_key; /* From type-specific DER */
66 d2i_of_void *d2i_key_params; /* From type-specific DER */
6a2b8ff3 67 d2i_PKCS8_fn *d2i_PKCS8; /* Wrapped in a PrivateKeyInfo */
06f67612 68 d2i_of_void *d2i_PUBKEY; /* Wrapped in a SubjectPublicKeyInfo */
6963979f 69
65ef000e
RL		 70 /*
71 * For any key, we may need to check that the key meets expectations.
72 * This is useful when the same functions can decode several variants
73 * of a key.
74 */
75 check_key_fn *check_key;
76
6963979f
RL		 77 /*
78 * For any key, we may need to make provider specific adjustments, such
79 * as ensure the key carries the correct library context.
80 */
81 adjust_key_fn *adjust_key;
2c090c1d 82 /* {type}_free() */
7c664b1f
RL		 83 free_key_fn *free_key;
84};
85
86/*
ece9304c 87 * Context used for DER to key decoding.
7c664b1f
RL		 88 */
89struct der2key_ctx_st {
90 PROV_CTX *provctx;
91 const struct keytype_desc_st *desc;
398f8fe1
RL		 92 /* The selection that is passed to der2key_decode() */
93 int selection;
cf333799
RL		 94 /* Flag used to signal that a failure is fatal */
95 unsigned int flag_fatal : 1;
7c664b1f
RL		 96};
97
cf333799
RL		 98typedef void *key_from_pkcs8_t(const PKCS8_PRIV_KEY_INFO *p8inf,
99 OSSL_LIB_CTX *libctx, const char *propq);
100static void *der2key_decode_p8(const unsigned char **input_der,
101 long input_der_len, struct der2key_ctx_st *ctx,
cf333799
RL		 102 key_from_pkcs8_t *key_from_pkcs8)
103{
cf333799
RL		 104 PKCS8_PRIV_KEY_INFO *p8inf = NULL;
105 const X509_ALGOR *alg = NULL;
106 void *key = NULL;
107
6a2b8ff3 108 if ((p8inf = d2i_PKCS8_PRIV_KEY_INFO(NULL, input_der, input_der_len)) != NULL
cf333799
RL		 109 && PKCS8_pkey_get0(NULL, NULL, NULL, &alg, p8inf)
110 && OBJ_obj2nid(alg->algorithm) == ctx->desc->evp_type)
111 key = key_from_pkcs8(p8inf, PROV_LIBCTX_OF(ctx->provctx), NULL);
112 PKCS8_PRIV_KEY_INFO_free(p8inf);
9cc97ddf 113
cf333799
RL		 114 return key;
115}
116
117/* ---------------------------------------------------------------------- */
118
119static OSSL_FUNC_decoder_freectx_fn der2key_freectx;
120static OSSL_FUNC_decoder_decode_fn der2key_decode;
121static OSSL_FUNC_decoder_export_object_fn der2key_export_object;
122
7c664b1f
RL		 123static struct der2key_ctx_st *
124der2key_newctx(void *provctx, const struct keytype_desc_st *desc)
125{
126 struct der2key_ctx_st *ctx = OPENSSL_zalloc(sizeof(*ctx));
127
128 if (ctx != NULL) {
129 ctx->provctx = provctx;
130 ctx->desc = desc;
131 }
132 return ctx;
133}
134
135static void der2key_freectx(void *vctx)
136{
137 struct der2key_ctx_st *ctx = vctx;
138
139 OPENSSL_free(ctx);
140}
141
2c090c1d
RL		 142static int der2key_check_selection(int selection,
143 const struct keytype_desc_st *desc)
144{
145 /*
146 * The selections are kinda sorta "levels", i.e. each selection given
147 * here is assumed to include those following.
148 */
149 int checks[] = {
150 OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
151 OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
152 OSSL_KEYMGMT_SELECT_ALL_PARAMETERS
153 };
154 size_t i;
155
156 /* The decoder implementations made here support guessing */
157 if (selection == 0)
158 return 1;
159
160 for (i = 0; i < OSSL_NELEM(checks); i++) {
161 int check1 = (selection & checks[i]) != 0;
162 int check2 = (desc->selection_mask & checks[i]) != 0;
163
164 /*
165 * If the caller asked for the currently checked bit(s), return
166 * whether the decoder description says it's supported.
167 */
168 if (check1)
169 return check2;
170 }
171
172 /* This should be dead code, but just to be safe... */
173 return 0;
174}
175
176static int der2key_decode(void *vctx, OSSL_CORE_BIO *cin, int selection,
ece9304c
RL		 177 OSSL_CALLBACK *data_cb, void *data_cbarg,
178 OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg)
7c664b1f
RL		 179{
180 struct der2key_ctx_st *ctx = vctx;
7c664b1f
RL		 181 unsigned char *der = NULL;
182 const unsigned char *derp;
183 long der_len = 0;
7c664b1f 184 void *key = NULL;
66066e1b 185 int ok = 0;
7c664b1f 186
398f8fe1 187 ctx->selection = selection;
7c664b1f 188 /*
2c090c1d
RL		 189 * The caller is allowed to specify 0 as a selection mark, to have the
190 * structure and key type guessed. For type-specific structures, this
191 * is not recommended, as some structures are very similar.
192 * Note that 0 isn't the same as OSSL_KEYMGMT_SELECT_ALL, as the latter
193 * signifies a private key structure, where everything else is assumed
194 * to be present as well.
7c664b1f 195 */
2c090c1d
RL		 196 if (selection == 0)
197 selection = ctx->desc->selection_mask;
198 if ((selection & ctx->desc->selection_mask) == 0) {
199 ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
200 return 0;
7c664b1f
RL		 201 }
202
8c7c1c84 203 ok = ossl_read_der(ctx->provctx, cin, &der, &der_len);
9cc97ddf 204 if (!ok)
65ef000e 205 goto next;
7c664b1f 206
9cc97ddf
RL		 207 ok = 0; /* Assume that we fail */
208
cf333799 209 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
b5b6669f 210 derp = der;
cf333799 211 if (ctx->desc->d2i_PKCS8 != NULL) {
6a2b8ff3 212 key = ctx->desc->d2i_PKCS8(NULL, &derp, der_len, ctx);
cf333799
RL		 213 if (ctx->flag_fatal)
214 goto end;
215 } else if (ctx->desc->d2i_private_key != NULL) {
216 key = ctx->desc->d2i_private_key(NULL, &derp, der_len);
217 }
398f8fe1 218 if (key == NULL && ctx->selection != 0)
65ef000e
RL		 219 goto next;
220 }
cf333799 221 if (key == NULL && (selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
65ef000e 222 derp = der;
06f67612
RL		 223 if (ctx->desc->d2i_PUBKEY != NULL)
224 key = ctx->desc->d2i_PUBKEY(NULL, &derp, der_len);
225 else
226 key = ctx->desc->d2i_public_key(NULL, &derp, der_len);
398f8fe1 227 if (key == NULL && ctx->selection != 0)
65ef000e
RL		 228 goto next;
229 }
cf333799 230 if (key == NULL && (selection & OSSL_KEYMGMT_SELECT_ALL_PARAMETERS) != 0) {
65ef000e 231 derp = der;
cf333799
RL		 232 if (ctx->desc->d2i_key_params != NULL)
233 key = ctx->desc->d2i_key_params(NULL, &derp, der_len);
398f8fe1 234 if (key == NULL && ctx->selection != 0)
cf333799 235 goto next;
7c664b1f 236 }
9cc97ddf
RL		 237
238 /*
239 * Last minute check to see if this was the correct type of key. This
240 * should never lead to a fatal error, i.e. the decoding itself was
241 * correct, it was just an unexpected key type. This is generally for
242 * classes of key types that have subtle variants, like RSA-PSS keys as
243 * opposed to plain RSA keys.
244 */
65ef000e
RL		 245 if (key != NULL
246 && ctx->desc->check_key != NULL
247 && !ctx->desc->check_key(key, ctx)) {
9cc97ddf
RL		 248 ctx->desc->free_key(key);
249 key = NULL;
65ef000e
RL		 250 }
251
6963979f
RL		 252 if (key != NULL && ctx->desc->adjust_key != NULL)
253 ctx->desc->adjust_key(key, ctx);
254
65ef000e 255 next:
2c090c1d 256 /*
9cc97ddf
RL		 257 * Indicated that we successfully decoded something, or not at all.
258 * Ending up "empty handed" is not an error.
2c090c1d 259 */
9cc97ddf 260 ok = 1;
2c090c1d 261
65ef000e
RL		 262 /*
263 * We free memory here so it's not held up during the callback, because
264 * we know the process is recursive and the allocated chunks of memory
265 * add up.
266 */
7c664b1f 267 OPENSSL_free(der);
65ef000e 268 der = NULL;
7c664b1f
RL		 269
270 if (key != NULL) {
14c8a3d1
RL		 271 OSSL_PARAM params[4];
272 int object_type = OSSL_OBJECT_PKEY;
7c664b1f
RL		 273
274 params[0] =
14c8a3d1
RL		 275 OSSL_PARAM_construct_int(OSSL_OBJECT_PARAM_TYPE, &object_type);
276 params[1] =
277 OSSL_PARAM_construct_utf8_string(OSSL_OBJECT_PARAM_DATA_TYPE,
2c090c1d
RL		 278 (char *)ctx->desc->keytype_name,
279 0);
7c664b1f 280 /* The address of the key becomes the octet string */
14c8a3d1
RL		 281 params[2] =
282 OSSL_PARAM_construct_octet_string(OSSL_OBJECT_PARAM_REFERENCE,
7c664b1f 283 &key, sizeof(key));
14c8a3d1 284 params[3] = OSSL_PARAM_construct_end();
7c664b1f
RL		 285
286 ok = data_cb(params, data_cbarg);
287 }
65ef000e
RL		 288
289 end:
7c664b1f 290 ctx->desc->free_key(key);
65ef000e 291 OPENSSL_free(der);
7c664b1f
RL		 292
293 return ok;
294}
295
296static int der2key_export_object(void *vctx,
297 const void *reference, size_t reference_sz,
298 OSSL_CALLBACK *export_cb, void *export_cbarg)
299{
300 struct der2key_ctx_st *ctx = vctx;
301 OSSL_FUNC_keymgmt_export_fn *export =
302 ossl_prov_get_keymgmt_export(ctx->desc->fns);
303 void *keydata;
304
305 if (reference_sz == sizeof(keydata) && export != NULL) {
306 /* The contents of the reference is the address to our object */
307 keydata = *(void **)reference;
308
398f8fe1 309 return export(keydata, ctx->selection, export_cb, export_cbarg);
7c664b1f
RL		 310 }
311 return 0;
312}
313
2c090c1d
RL		 314/* ---------------------------------------------------------------------- */
315
316#ifndef OPENSSL_NO_DH
317# define dh_evp_type EVP_PKEY_DH
2c090c1d
RL		 318# define dh_d2i_private_key NULL
319# define dh_d2i_public_key NULL
320# define dh_d2i_key_params (d2i_of_void *)d2i_DHparams
cf333799
RL		 321
322static void *dh_d2i_PKCS8(void **key, const unsigned char **der, long der_len,
6a2b8ff3 323 struct der2key_ctx_st *ctx)
cf333799 324{
6a2b8ff3 325 return der2key_decode_p8(der, der_len, ctx,
cf333799
RL		 326 (key_from_pkcs8_t *)ossl_dh_key_from_pkcs8);
327}
328
06f67612 329# define dh_d2i_PUBKEY (d2i_of_void *)ossl_d2i_DH_PUBKEY
2c090c1d 330# define dh_free (free_key_fn *)DH_free
65ef000e 331# define dh_check NULL
2c090c1d 332
6963979f
RL		 333static void dh_adjust(void *key, struct der2key_ctx_st *ctx)
334{
335 ossl_dh_set0_libctx(key, PROV_LIBCTX_OF(ctx->provctx));
336}
337
2c090c1d 338# define dhx_evp_type EVP_PKEY_DHX
2c090c1d
RL		 339# define dhx_d2i_private_key NULL
340# define dhx_d2i_public_key NULL
341# define dhx_d2i_key_params (d2i_of_void *)d2i_DHxparams
cf333799 342# define dhx_d2i_PKCS8 dh_d2i_PKCS8
06f67612 343# define dhx_d2i_PUBKEY (d2i_of_void *)ossl_d2i_DHx_PUBKEY
2c090c1d 344# define dhx_free (free_key_fn *)DH_free
65ef000e 345# define dhx_check NULL
6963979f 346# define dhx_adjust dh_adjust
2c090c1d
RL		 347#endif
348
349/* ---------------------------------------------------------------------- */
350
351#ifndef OPENSSL_NO_DSA
352# define dsa_evp_type EVP_PKEY_DSA
2c090c1d
RL		 353# define dsa_d2i_private_key (d2i_of_void *)d2i_DSAPrivateKey
354# define dsa_d2i_public_key (d2i_of_void *)d2i_DSAPublicKey
355# define dsa_d2i_key_params (d2i_of_void *)d2i_DSAparams
cf333799
RL		 356
357static void *dsa_d2i_PKCS8(void **key, const unsigned char **der, long der_len,
6a2b8ff3 358 struct der2key_ctx_st *ctx)
cf333799 359{
6a2b8ff3 360 return der2key_decode_p8(der, der_len, ctx,
cf333799
RL		 361 (key_from_pkcs8_t *)ossl_dsa_key_from_pkcs8);
362}
363
06f67612 364# define dsa_d2i_PUBKEY (d2i_of_void *)d2i_DSA_PUBKEY
2c090c1d 365# define dsa_free (free_key_fn *)DSA_free
65ef000e 366# define dsa_check NULL
6963979f
RL		 367
368static void dsa_adjust(void *key, struct der2key_ctx_st *ctx)
369{
370 ossl_dsa_set0_libctx(key, PROV_LIBCTX_OF(ctx->provctx));
371}
2c090c1d
RL		 372#endif
373
374/* ---------------------------------------------------------------------- */
375
376#ifndef OPENSSL_NO_EC
377# define ec_evp_type EVP_PKEY_EC
2c090c1d
RL		 378# define ec_d2i_private_key (d2i_of_void *)d2i_ECPrivateKey
379# define ec_d2i_public_key NULL
380# define ec_d2i_key_params (d2i_of_void *)d2i_ECParameters
cf333799
RL		 381
382static void *ec_d2i_PKCS8(void **key, const unsigned char **der, long der_len,
6a2b8ff3 383 struct der2key_ctx_st *ctx)
cf333799 384{
6a2b8ff3 385 return der2key_decode_p8(der, der_len, ctx,
cf333799
RL		 386 (key_from_pkcs8_t *)ossl_ec_key_from_pkcs8);
387}
388
06f67612 389# define ec_d2i_PUBKEY (d2i_of_void *)d2i_EC_PUBKEY
2c090c1d
RL		 390# define ec_free (free_key_fn *)EC_KEY_free
391
65ef000e
RL		 392static int ec_check(void *key, struct der2key_ctx_st *ctx)
393{
394 /* We're trying to be clever by comparing two truths */
395
396 int sm2 = (EC_KEY_get_flags(key) & EC_FLAG_SM2_RANGE) != 0;
397
398 return sm2 == (ctx->desc->evp_type == EVP_PKEY_SM2);
399}
400
6963979f
RL		 401static void ec_adjust(void *key, struct der2key_ctx_st *ctx)
402{
32ab57cb 403 ossl_ec_key_set0_libctx(key, PROV_LIBCTX_OF(ctx->provctx));
6963979f
RL		 404}
405
2c090c1d
RL		 406/*
407 * ED25519, ED448, X25519, X448 only implement PKCS#8 and SubjectPublicKeyInfo,
408 * so no d2i functions to be had.
409 */
6963979f 410
cf333799 411static void *ecx_d2i_PKCS8(void **key, const unsigned char **der, long der_len,
6a2b8ff3 412 struct der2key_ctx_st *ctx)
cf333799 413{
6a2b8ff3 414 return der2key_decode_p8(der, der_len, ctx,
cf333799
RL		 415 (key_from_pkcs8_t *)ossl_ecx_key_from_pkcs8);
416}
417
6963979f
RL		 418static void ecx_key_adjust(void *key, struct der2key_ctx_st *ctx)
419{
32ab57cb 420 ossl_ecx_key_set0_libctx(key, PROV_LIBCTX_OF(ctx->provctx));
6963979f
RL		 421}
422
2c090c1d 423# define ed25519_evp_type EVP_PKEY_ED25519
2c090c1d
RL		 424# define ed25519_d2i_private_key NULL
425# define ed25519_d2i_public_key NULL
426# define ed25519_d2i_key_params NULL
cf333799 427# define ed25519_d2i_PKCS8 ecx_d2i_PKCS8
06f67612 428# define ed25519_d2i_PUBKEY (d2i_of_void *)ossl_d2i_ED25519_PUBKEY
32ab57cb 429# define ed25519_free (free_key_fn *)ossl_ecx_key_free
65ef000e 430# define ed25519_check NULL
6963979f 431# define ed25519_adjust ecx_key_adjust
2c090c1d
RL		 432
433# define ed448_evp_type EVP_PKEY_ED448
2c090c1d
RL		 434# define ed448_d2i_private_key NULL
435# define ed448_d2i_public_key NULL
436# define ed448_d2i_key_params NULL
cf333799 437# define ed448_d2i_PKCS8 ecx_d2i_PKCS8
06f67612 438# define ed448_d2i_PUBKEY (d2i_of_void *)ossl_d2i_ED448_PUBKEY
32ab57cb 439# define ed448_free (free_key_fn *)ossl_ecx_key_free
65ef000e 440# define ed448_check NULL
6963979f 441# define ed448_adjust ecx_key_adjust
2c090c1d
RL		 442
443# define x25519_evp_type EVP_PKEY_X25519
2c090c1d
RL		 444# define x25519_d2i_private_key NULL
445# define x25519_d2i_public_key NULL
446# define x25519_d2i_key_params NULL
cf333799 447# define x25519_d2i_PKCS8 ecx_d2i_PKCS8
06f67612 448# define x25519_d2i_PUBKEY (d2i_of_void *)ossl_d2i_X25519_PUBKEY
32ab57cb 449# define x25519_free (free_key_fn *)ossl_ecx_key_free
65ef000e 450# define x25519_check NULL
6963979f 451# define x25519_adjust ecx_key_adjust
2c090c1d
RL		 452
453# define x448_evp_type EVP_PKEY_X448
2c090c1d
RL		 454# define x448_d2i_private_key NULL
455# define x448_d2i_public_key NULL
456# define x448_d2i_key_params NULL
cf333799 457# define x448_d2i_PKCS8 ecx_d2i_PKCS8
06f67612 458# define x448_d2i_PUBKEY (d2i_of_void *)ossl_d2i_X448_PUBKEY
32ab57cb 459# define x448_free (free_key_fn *)ossl_ecx_key_free
65ef000e 460# define x448_check NULL
6963979f 461# define x448_adjust ecx_key_adjust
f2db0528
RL		 462
463# ifndef OPENSSL_NO_SM2
464# define sm2_evp_type EVP_PKEY_SM2
f2db0528
RL		 465# define sm2_d2i_private_key (d2i_of_void *)d2i_ECPrivateKey
466# define sm2_d2i_public_key NULL
467# define sm2_d2i_key_params (d2i_of_void *)d2i_ECParameters
cf333799
RL		 468
469static void *sm2_d2i_PKCS8(void **key, const unsigned char **der, long der_len,
6a2b8ff3 470 struct der2key_ctx_st *ctx)
cf333799 471{
6a2b8ff3 472 return der2key_decode_p8(der, der_len, ctx,
cf333799
RL		 473 (key_from_pkcs8_t *)ossl_ec_key_from_pkcs8);
474}
475
06f67612 476# define sm2_d2i_PUBKEY (d2i_of_void *)d2i_EC_PUBKEY
f2db0528 477# define sm2_free (free_key_fn *)EC_KEY_free
65ef000e 478# define sm2_check ec_check
f2db0528
RL		 479# define sm2_adjust ec_adjust
480# endif
2c090c1d
RL		 481#endif
482
483/* ---------------------------------------------------------------------- */
484
485#define rsa_evp_type EVP_PKEY_RSA
2c090c1d
RL		 486#define rsa_d2i_private_key (d2i_of_void *)d2i_RSAPrivateKey
487#define rsa_d2i_public_key (d2i_of_void *)d2i_RSAPublicKey
488#define rsa_d2i_key_params NULL
cf333799
RL		 489
490static void *rsa_d2i_PKCS8(void **key, const unsigned char **der, long der_len,
6a2b8ff3 491 struct der2key_ctx_st *ctx)
cf333799 492{
6a2b8ff3 493 return der2key_decode_p8(der, der_len, ctx,
cf333799
RL		 494 (key_from_pkcs8_t *)ossl_rsa_key_from_pkcs8);
495}
496
06f67612 497#define rsa_d2i_PUBKEY (d2i_of_void *)d2i_RSA_PUBKEY
2c090c1d
RL		 498#define rsa_free (free_key_fn *)RSA_free
499
65ef000e
RL		 500static int rsa_check(void *key, struct der2key_ctx_st *ctx)
501{
502 switch (RSA_test_flags(key, RSA_FLAG_TYPE_MASK)) {
503 case RSA_FLAG_TYPE_RSA:
504 return ctx->desc->evp_type == EVP_PKEY_RSA;
505 case RSA_FLAG_TYPE_RSASSAPSS:
506 return ctx->desc->evp_type == EVP_PKEY_RSA_PSS;
507 }
508
509 /* Currently unsupported RSA key type */
510 return 0;
511}
512
6963979f
RL		 513static void rsa_adjust(void *key, struct der2key_ctx_st *ctx)
514{
515 ossl_rsa_set0_libctx(key, PROV_LIBCTX_OF(ctx->provctx));
516}
517
2c090c1d 518#define rsapss_evp_type EVP_PKEY_RSA_PSS
2c090c1d
RL		 519#define rsapss_d2i_private_key (d2i_of_void *)d2i_RSAPrivateKey
520#define rsapss_d2i_public_key (d2i_of_void *)d2i_RSAPublicKey
521#define rsapss_d2i_key_params NULL
cf333799 522#define rsapss_d2i_PKCS8 rsa_d2i_PKCS8
06f67612 523#define rsapss_d2i_PUBKEY (d2i_of_void *)d2i_RSA_PUBKEY
2c090c1d 524#define rsapss_free (free_key_fn *)RSA_free
65ef000e 525#define rsapss_check rsa_check
6963979f 526#define rsapss_adjust rsa_adjust
2c090c1d
RL		 527
528/* ---------------------------------------------------------------------- */
529
530/*
531 * The DO_ macros help define the selection mask and the method functions
532 * for each kind of object we want to decode.
533 */
534#define DO_type_specific_keypair(keytype) \
65ef000e 535 "type-specific", keytype##_evp_type, \
2c090c1d
RL		 536 ( OSSL_KEYMGMT_SELECT_KEYPAIR ), \
537 keytype##_d2i_private_key, \
538 keytype##_d2i_public_key, \
539 NULL, \
540 NULL, \
06f67612 541 NULL, \
65ef000e 542 keytype##_check, \
6963979f 543 keytype##_adjust, \
2c090c1d
RL		 544 keytype##_free
545
546#define DO_type_specific_pub(keytype) \
65ef000e 547 "type-specific", keytype##_evp_type, \
2c090c1d
RL		 548 ( OSSL_KEYMGMT_SELECT_PUBLIC_KEY ), \
549 NULL, \
550 keytype##_d2i_public_key, \
551 NULL, \
552 NULL, \
06f67612 553 NULL, \
65ef000e 554 keytype##_check, \
6963979f 555 keytype##_adjust, \
2c090c1d
RL		 556 keytype##_free
557
558#define DO_type_specific_priv(keytype) \
65ef000e 559 "type-specific", keytype##_evp_type, \
2c090c1d
RL		 560 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY ), \
561 keytype##_d2i_private_key, \
562 NULL, \
563 NULL, \
564 NULL, \
06f67612 565 NULL, \
65ef000e 566 keytype##_check, \
6963979f 567 keytype##_adjust, \
2c090c1d
RL		 568 keytype##_free
569
570#define DO_type_specific_params(keytype) \
65ef000e 571 "type-specific", keytype##_evp_type, \
2c090c1d
RL		 572 ( OSSL_KEYMGMT_SELECT_ALL_PARAMETERS ), \
573 NULL, \
574 NULL, \
575 keytype##_d2i_key_params, \
576 NULL, \
06f67612 577 NULL, \
65ef000e 578 keytype##_check, \
6963979f 579 keytype##_adjust, \
2c090c1d
RL		 580 keytype##_free
581
582#define DO_type_specific(keytype) \
65ef000e 583 "type-specific", keytype##_evp_type, \
2c090c1d
RL		 584 ( OSSL_KEYMGMT_SELECT_ALL ), \
585 keytype##_d2i_private_key, \
586 keytype##_d2i_public_key, \
587 keytype##_d2i_key_params, \
588 NULL, \
06f67612 589 NULL, \
65ef000e 590 keytype##_check, \
6963979f 591 keytype##_adjust, \
2c090c1d
RL		 592 keytype##_free
593
594#define DO_type_specific_no_pub(keytype) \
65ef000e 595 "type-specific", keytype##_evp_type, \
2c090c1d
RL		 596 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY \
597 | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS ), \
598 keytype##_d2i_private_key, \
599 NULL, \
600 keytype##_d2i_key_params, \
601 NULL, \
06f67612 602 NULL, \
65ef000e 603 keytype##_check, \
6963979f 604 keytype##_adjust, \
2c090c1d
RL		 605 keytype##_free
606
6a2b8ff3
RL		 607#define DO_PrivateKeyInfo(keytype) \
608 "PrivateKeyInfo", keytype##_evp_type, \
2c090c1d
RL		 609 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY ), \
610 NULL, \
611 NULL, \
612 NULL, \
cf333799 613 keytype##_d2i_PKCS8, \
06f67612 614 NULL, \
65ef000e 615 keytype##_check, \
6963979f 616 keytype##_adjust, \
2c090c1d
RL		 617 keytype##_free
618
619#define DO_SubjectPublicKeyInfo(keytype) \
620 "SubjectPublicKeyInfo", keytype##_evp_type, \
621 ( OSSL_KEYMGMT_SELECT_PUBLIC_KEY ), \
622 NULL, \
623 NULL, \
624 NULL, \
cf333799 625 NULL, \
06f67612 626 keytype##_d2i_PUBKEY, \
65ef000e 627 keytype##_check, \
6963979f 628 keytype##_adjust, \
2c090c1d
RL		 629 keytype##_free
630
631#define DO_DH(keytype) \
65ef000e 632 "DH", keytype##_evp_type, \
2c090c1d
RL		 633 ( OSSL_KEYMGMT_SELECT_ALL_PARAMETERS ), \
634 NULL, \
635 NULL, \
636 keytype##_d2i_key_params, \
637 NULL, \
06f67612 638 NULL, \
65ef000e 639 keytype##_check, \
6963979f 640 keytype##_adjust, \
2c090c1d
RL		 641 keytype##_free
642
643#define DO_DHX(keytype) \
65ef000e 644 "DHX", keytype##_evp_type, \
2c090c1d
RL		 645 ( OSSL_KEYMGMT_SELECT_ALL_PARAMETERS ), \
646 NULL, \
647 NULL, \
648 keytype##_d2i_key_params, \
649 NULL, \
06f67612 650 NULL, \
65ef000e 651 keytype##_check, \
6963979f 652 keytype##_adjust, \
2c090c1d
RL		 653 keytype##_free
654
655#define DO_DSA(keytype) \
65ef000e 656 "DSA", keytype##_evp_type, \
2c090c1d
RL		 657 ( OSSL_KEYMGMT_SELECT_ALL ), \
658 keytype##_d2i_private_key, \
659 keytype##_d2i_public_key, \
660 keytype##_d2i_key_params, \
661 NULL, \
06f67612 662 NULL, \
65ef000e 663 keytype##_check, \
6963979f 664 keytype##_adjust, \
2c090c1d
RL		 665 keytype##_free
666
667#define DO_EC(keytype) \
65ef000e 668 "EC", keytype##_evp_type, \
2c090c1d
RL		 669 ( OSSL_KEYMGMT_SELECT_PRIVATE_KEY \
670 | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS ), \
671 keytype##_d2i_private_key, \
672 NULL, \
673 keytype##_d2i_key_params, \
674 NULL, \
06f67612 675 NULL, \
65ef000e 676 keytype##_check, \
6963979f 677 keytype##_adjust, \
2c090c1d
RL		 678 keytype##_free
679
680#define DO_RSA(keytype) \
65ef000e 681 "RSA", keytype##_evp_type, \
2c090c1d
RL		 682 ( OSSL_KEYMGMT_SELECT_KEYPAIR ), \
683 keytype##_d2i_private_key, \
684 keytype##_d2i_public_key, \
685 NULL, \
686 NULL, \
06f67612 687 NULL, \
65ef000e 688 keytype##_check, \
6963979f 689 keytype##_adjust, \
2c090c1d
RL		 690 keytype##_free
691
692/*
693 * MAKE_DECODER is the single driver for creating OSSL_DISPATCH tables.
694 * It takes the following arguments:
695 *
696 * keytype_name The implementation key type as a string.
697 * keytype The implementation key type. This must correspond exactly
698 * to our existing keymgmt keytype names... in other words,
699 * there must exist an ossl_##keytype##_keymgmt_functions.
700 * type The type name for the set of functions that implement the
701 * decoder for the key type. This isn't necessarily the same
702 * as keytype. For example, the key types ed25519, ed448,
703 * x25519 and x448 are all handled by the same functions with
704 * the common type name ecx.
705 * kind The kind of support to implement. This translates into
706 * the DO_##kind macros above, to populate the keytype_desc_st
707 * structure.
708 */
709#define MAKE_DECODER(keytype_name, keytype, type, kind) \
710 static const struct keytype_desc_st kind##_##keytype##_desc = \
711 { keytype_name, ossl_##keytype##_keymgmt_functions, \
712 DO_##kind(keytype) }; \
713 \
714 static OSSL_FUNC_decoder_newctx_fn kind##_der2##keytype##_newctx; \
2c090c1d
RL		 715 \
716 static void *kind##_der2##keytype##_newctx(void *provctx) \
717 { \
718 return der2key_newctx(provctx, &kind##_##keytype##_desc); \
719 } \
2c090c1d
RL		 720 static int kind##_der2##keytype##_does_selection(void *provctx, \
721 int selection) \
7c664b1f 722 { \
2c090c1d
RL		 723 return der2key_check_selection(selection, \
724 &kind##_##keytype##_desc); \
7c664b1f 725 } \
2c090c1d
RL		 726 const OSSL_DISPATCH \
727 ossl_##kind##_der_to_##keytype##_decoder_functions[] = { \
ece9304c 728 { OSSL_FUNC_DECODER_NEWCTX, \
2c090c1d 729 (void (*)(void))kind##_der2##keytype##_newctx }, \
ece9304c 730 { OSSL_FUNC_DECODER_FREECTX, \
7c664b1f 731 (void (*)(void))der2key_freectx }, \
2c090c1d
RL		 732 { OSSL_FUNC_DECODER_DOES_SELECTION, \
733 (void (*)(void))kind##_der2##keytype##_does_selection }, \
ece9304c
RL		 734 { OSSL_FUNC_DECODER_DECODE, \
735 (void (*)(void))der2key_decode }, \
736 { OSSL_FUNC_DECODER_EXPORT_OBJECT, \
7c664b1f
RL		 737 (void (*)(void))der2key_export_object }, \
738 { 0, NULL } \
739 }
740
741#ifndef OPENSSL_NO_DH
6a2b8ff3 742MAKE_DECODER("DH", dh, dh, PrivateKeyInfo);
2c090c1d
RL		 743MAKE_DECODER("DH", dh, dh, SubjectPublicKeyInfo);
744MAKE_DECODER("DH", dh, dh, type_specific_params);
745MAKE_DECODER("DH", dh, dh, DH);
6a2b8ff3 746MAKE_DECODER("DHX", dhx, dhx, PrivateKeyInfo);
2c090c1d
RL		 747MAKE_DECODER("DHX", dhx, dhx, SubjectPublicKeyInfo);
748MAKE_DECODER("DHX", dhx, dhx, type_specific_params);
749MAKE_DECODER("DHX", dhx, dhx, DHX);
7c664b1f
RL		 750#endif
751#ifndef OPENSSL_NO_DSA
6a2b8ff3 752MAKE_DECODER("DSA", dsa, dsa, PrivateKeyInfo);
2c090c1d
RL		 753MAKE_DECODER("DSA", dsa, dsa, SubjectPublicKeyInfo);
754MAKE_DECODER("DSA", dsa, dsa, type_specific);
755MAKE_DECODER("DSA", dsa, dsa, DSA);
7c664b1f
RL		 756#endif
757#ifndef OPENSSL_NO_EC
6a2b8ff3 758MAKE_DECODER("EC", ec, ec, PrivateKeyInfo);
2c090c1d
RL		 759MAKE_DECODER("EC", ec, ec, SubjectPublicKeyInfo);
760MAKE_DECODER("EC", ec, ec, type_specific_no_pub);
761MAKE_DECODER("EC", ec, ec, EC);
6a2b8ff3 762MAKE_DECODER("X25519", x25519, ecx, PrivateKeyInfo);
2c090c1d 763MAKE_DECODER("X25519", x25519, ecx, SubjectPublicKeyInfo);
6a2b8ff3 764MAKE_DECODER("X448", x448, ecx, PrivateKeyInfo);
2c090c1d 765MAKE_DECODER("X448", x448, ecx, SubjectPublicKeyInfo);
6a2b8ff3 766MAKE_DECODER("ED25519", ed25519, ecx, PrivateKeyInfo);
2c090c1d 767MAKE_DECODER("ED25519", ed25519, ecx, SubjectPublicKeyInfo);
6a2b8ff3 768MAKE_DECODER("ED448", ed448, ecx, PrivateKeyInfo);
2c090c1d 769MAKE_DECODER("ED448", ed448, ecx, SubjectPublicKeyInfo);
f2db0528 770# ifndef OPENSSL_NO_SM2
6a2b8ff3 771MAKE_DECODER("SM2", sm2, ec, PrivateKeyInfo);
f2db0528
RL		 772MAKE_DECODER("SM2", sm2, ec, SubjectPublicKeyInfo);
773# endif
7c664b1f 774#endif
6a2b8ff3 775MAKE_DECODER("RSA", rsa, rsa, PrivateKeyInfo);
2c090c1d
RL		 776MAKE_DECODER("RSA", rsa, rsa, SubjectPublicKeyInfo);
777MAKE_DECODER("RSA", rsa, rsa, type_specific_keypair);
778MAKE_DECODER("RSA", rsa, rsa, RSA);
6a2b8ff3 779MAKE_DECODER("RSA-PSS", rsapss, rsapss, PrivateKeyInfo);
2c090c1d 780MAKE_DECODER("RSA-PSS", rsapss, rsapss, SubjectPublicKeyInfo);
A mirror of the official openssl repository