2 * Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
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
10 /* We need to use some engine deprecated APIs */
11 #define OPENSSL_SUPPRESS_DEPRECATED
13 #include "e_os.h" /* for strncasecmp */
14 #include "internal/cryptlib.h"
16 #include <openssl/asn1t.h>
17 #include <openssl/x509.h>
18 #include <openssl/engine.h>
19 #include "crypto/asn1.h"
20 #include "crypto/evp.h"
22 #include "standard_methods.h"
24 typedef int sk_cmp_fn_type(const char *const *a, const char *const *b);
25 static STACK_OF(EVP_PKEY_ASN1_METHOD) *app_methods = NULL;
27 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_ASN1_METHOD *,
28 const EVP_PKEY_ASN1_METHOD *, ameth);
30 static int ameth_cmp(const EVP_PKEY_ASN1_METHOD *const *a,
31 const EVP_PKEY_ASN1_METHOD *const *b)
33 return ((*a)->pkey_id - (*b)->pkey_id);
36 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_ASN1_METHOD *,
37 const EVP_PKEY_ASN1_METHOD *, ameth);
39 int EVP_PKEY_asn1_get_count(void)
41 int num = OSSL_NELEM(standard_methods);
43 num += sk_EVP_PKEY_ASN1_METHOD_num(app_methods);
47 const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_get0(int idx)
49 int num = OSSL_NELEM(standard_methods);
53 return standard_methods[idx];
55 return sk_EVP_PKEY_ASN1_METHOD_value(app_methods, idx);
58 static const EVP_PKEY_ASN1_METHOD *pkey_asn1_find(int type)
60 EVP_PKEY_ASN1_METHOD tmp;
61 const EVP_PKEY_ASN1_METHOD *t = &tmp, **ret;
66 idx = sk_EVP_PKEY_ASN1_METHOD_find(app_methods, &tmp);
68 return sk_EVP_PKEY_ASN1_METHOD_value(app_methods, idx);
70 ret = OBJ_bsearch_ameth(&t, standard_methods, OSSL_NELEM(standard_methods));
71 if (ret == NULL || *ret == NULL)
77 * Find an implementation of an ASN1 algorithm. If 'pe' is not NULL also
78 * search through engines and set *pe to a functional reference to the engine
79 * implementing 'type' or NULL if no engine implements it.
82 const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find(ENGINE **pe, int type)
84 const EVP_PKEY_ASN1_METHOD *t;
87 t = pkey_asn1_find(type);
88 if (!t || !(t->pkey_flags & ASN1_PKEY_ALIAS))
90 type = t->pkey_base_id;
93 #ifndef OPENSSL_NO_ENGINE
95 /* type will contain the final unaliased type */
96 e = ENGINE_get_pkey_asn1_meth_engine(type);
99 return ENGINE_get_pkey_asn1_meth(e, type);
107 const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find_str(ENGINE **pe,
108 const char *str, int len)
111 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
116 #ifndef OPENSSL_NO_ENGINE
118 ameth = ENGINE_pkey_asn1_find_str(&e, str, len);
121 * Convert structural into functional reference
132 for (i = EVP_PKEY_asn1_get_count(); i-- > 0; ) {
133 ameth = EVP_PKEY_asn1_get0(i);
134 if (ameth->pkey_flags & ASN1_PKEY_ALIAS)
136 if ((int)strlen(ameth->pem_str) == len
137 && strncasecmp(ameth->pem_str, str, len) == 0)
143 int EVP_PKEY_asn1_add0(const EVP_PKEY_ASN1_METHOD *ameth)
145 EVP_PKEY_ASN1_METHOD tmp = { 0, };
148 * One of the following must be true:
150 * pem_str == NULL AND ASN1_PKEY_ALIAS is set
151 * pem_str != NULL AND ASN1_PKEY_ALIAS is clear
153 * Anything else is an error and may lead to a corrupt ASN1 method table
155 if (!((ameth->pem_str == NULL
156 && (ameth->pkey_flags & ASN1_PKEY_ALIAS) != 0)
157 || (ameth->pem_str != NULL
158 && (ameth->pkey_flags & ASN1_PKEY_ALIAS) == 0))) {
159 EVPerr(EVP_F_EVP_PKEY_ASN1_ADD0, ERR_R_PASSED_INVALID_ARGUMENT);
163 if (app_methods == NULL) {
164 app_methods = sk_EVP_PKEY_ASN1_METHOD_new(ameth_cmp);
165 if (app_methods == NULL)
169 tmp.pkey_id = ameth->pkey_id;
170 if (sk_EVP_PKEY_ASN1_METHOD_find(app_methods, &tmp) >= 0) {
171 EVPerr(EVP_F_EVP_PKEY_ASN1_ADD0,
172 EVP_R_PKEY_APPLICATION_ASN1_METHOD_ALREADY_REGISTERED);
176 if (!sk_EVP_PKEY_ASN1_METHOD_push(app_methods, ameth))
178 sk_EVP_PKEY_ASN1_METHOD_sort(app_methods);
182 int EVP_PKEY_asn1_add_alias(int to, int from)
184 EVP_PKEY_ASN1_METHOD *ameth;
185 ameth = EVP_PKEY_asn1_new(from, ASN1_PKEY_ALIAS, NULL, NULL);
188 ameth->pkey_base_id = to;
189 if (!EVP_PKEY_asn1_add0(ameth)) {
190 EVP_PKEY_asn1_free(ameth);
196 int EVP_PKEY_asn1_get0_info(int *ppkey_id, int *ppkey_base_id,
197 int *ppkey_flags, const char **pinfo,
198 const char **ppem_str,
199 const EVP_PKEY_ASN1_METHOD *ameth)
204 *ppkey_id = ameth->pkey_id;
206 *ppkey_base_id = ameth->pkey_base_id;
208 *ppkey_flags = ameth->pkey_flags;
210 *pinfo = ameth->info;
212 *ppem_str = ameth->pem_str;
216 const EVP_PKEY_ASN1_METHOD *EVP_PKEY_get0_asn1(const EVP_PKEY *pkey)
221 EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_new(int id, int flags,
222 const char *pem_str, const char *info)
224 EVP_PKEY_ASN1_METHOD *ameth = OPENSSL_zalloc(sizeof(*ameth));
230 ameth->pkey_base_id = id;
231 ameth->pkey_flags = flags | ASN1_PKEY_DYNAMIC;
234 ameth->info = OPENSSL_strdup(info);
240 ameth->pem_str = OPENSSL_strdup(pem_str);
248 EVP_PKEY_asn1_free(ameth);
253 void EVP_PKEY_asn1_copy(EVP_PKEY_ASN1_METHOD *dst,
254 const EVP_PKEY_ASN1_METHOD *src)
256 int pkey_id = dst->pkey_id;
257 int pkey_base_id = dst->pkey_base_id;
258 unsigned long pkey_flags = dst->pkey_flags;
259 char *pem_str = dst->pem_str;
260 char *info = dst->info;
264 /* We only copy the function pointers so restore the other values */
265 dst->pkey_id = pkey_id;
266 dst->pkey_base_id = pkey_base_id;
267 dst->pkey_flags = pkey_flags;
268 dst->pem_str = pem_str;
272 void EVP_PKEY_asn1_free(EVP_PKEY_ASN1_METHOD *ameth)
274 if (ameth && (ameth->pkey_flags & ASN1_PKEY_DYNAMIC)) {
275 OPENSSL_free(ameth->pem_str);
276 OPENSSL_free(ameth->info);
281 void EVP_PKEY_asn1_set_public(EVP_PKEY_ASN1_METHOD *ameth,
282 int (*pub_decode) (EVP_PKEY *pk,
283 const X509_PUBKEY *pub),
284 int (*pub_encode) (X509_PUBKEY *pub,
286 int (*pub_cmp) (const EVP_PKEY *a,
288 int (*pub_print) (BIO *out,
289 const EVP_PKEY *pkey,
290 int indent, ASN1_PCTX *pctx),
291 int (*pkey_size) (const EVP_PKEY *pk),
292 int (*pkey_bits) (const EVP_PKEY *pk))
294 ameth->pub_decode = pub_decode;
295 ameth->pub_encode = pub_encode;
296 ameth->pub_cmp = pub_cmp;
297 ameth->pub_print = pub_print;
298 ameth->pkey_size = pkey_size;
299 ameth->pkey_bits = pkey_bits;
302 void EVP_PKEY_asn1_set_private(EVP_PKEY_ASN1_METHOD *ameth,
303 int (*priv_decode) (EVP_PKEY *pk,
304 const PKCS8_PRIV_KEY_INFO
306 int (*priv_encode) (PKCS8_PRIV_KEY_INFO *p8,
308 int (*priv_print) (BIO *out,
309 const EVP_PKEY *pkey,
313 ameth->priv_decode = priv_decode;
314 ameth->priv_encode = priv_encode;
315 ameth->priv_print = priv_print;
318 void EVP_PKEY_asn1_set_param(EVP_PKEY_ASN1_METHOD *ameth,
319 int (*param_decode) (EVP_PKEY *pkey,
320 const unsigned char **pder,
322 int (*param_encode) (const EVP_PKEY *pkey,
323 unsigned char **pder),
324 int (*param_missing) (const EVP_PKEY *pk),
325 int (*param_copy) (EVP_PKEY *to,
326 const EVP_PKEY *from),
327 int (*param_cmp) (const EVP_PKEY *a,
329 int (*param_print) (BIO *out,
330 const EVP_PKEY *pkey,
331 int indent, ASN1_PCTX *pctx))
333 ameth->param_decode = param_decode;
334 ameth->param_encode = param_encode;
335 ameth->param_missing = param_missing;
336 ameth->param_copy = param_copy;
337 ameth->param_cmp = param_cmp;
338 ameth->param_print = param_print;
341 void EVP_PKEY_asn1_set_free(EVP_PKEY_ASN1_METHOD *ameth,
342 void (*pkey_free) (EVP_PKEY *pkey))
344 ameth->pkey_free = pkey_free;
347 void EVP_PKEY_asn1_set_ctrl(EVP_PKEY_ASN1_METHOD *ameth,
348 int (*pkey_ctrl) (EVP_PKEY *pkey, int op,
349 long arg1, void *arg2))
351 ameth->pkey_ctrl = pkey_ctrl;
354 void EVP_PKEY_asn1_set_security_bits(EVP_PKEY_ASN1_METHOD *ameth,
355 int (*pkey_security_bits) (const EVP_PKEY
358 ameth->pkey_security_bits = pkey_security_bits;
361 void EVP_PKEY_asn1_set_item(EVP_PKEY_ASN1_METHOD *ameth,
362 int (*item_verify) (EVP_MD_CTX *ctx,
366 ASN1_BIT_STRING *sig,
368 int (*item_sign) (EVP_MD_CTX *ctx,
373 ASN1_BIT_STRING *sig))
375 ameth->item_sign = item_sign;
376 ameth->item_verify = item_verify;
379 void EVP_PKEY_asn1_set_siginf(EVP_PKEY_ASN1_METHOD *ameth,
380 int (*siginf_set) (X509_SIG_INFO *siginf,
381 const X509_ALGOR *alg,
382 const ASN1_STRING *sig))
384 ameth->siginf_set = siginf_set;
387 void EVP_PKEY_asn1_set_check(EVP_PKEY_ASN1_METHOD *ameth,
388 int (*pkey_check) (const EVP_PKEY *pk))
390 ameth->pkey_check = pkey_check;
393 void EVP_PKEY_asn1_set_public_check(EVP_PKEY_ASN1_METHOD *ameth,
394 int (*pkey_pub_check) (const EVP_PKEY *pk))
396 ameth->pkey_public_check = pkey_pub_check;
399 void EVP_PKEY_asn1_set_param_check(EVP_PKEY_ASN1_METHOD *ameth,
400 int (*pkey_param_check) (const EVP_PKEY *pk))
402 ameth->pkey_param_check = pkey_param_check;
405 void EVP_PKEY_asn1_set_set_priv_key(EVP_PKEY_ASN1_METHOD *ameth,
406 int (*set_priv_key) (EVP_PKEY *pk,
411 ameth->set_priv_key = set_priv_key;
414 void EVP_PKEY_asn1_set_set_pub_key(EVP_PKEY_ASN1_METHOD *ameth,
415 int (*set_pub_key) (EVP_PKEY *pk,
416 const unsigned char *pub,
419 ameth->set_pub_key = set_pub_key;
422 void EVP_PKEY_asn1_set_get_priv_key(EVP_PKEY_ASN1_METHOD *ameth,
423 int (*get_priv_key) (const EVP_PKEY *pk,
427 ameth->get_priv_key = get_priv_key;
430 void EVP_PKEY_asn1_set_get_pub_key(EVP_PKEY_ASN1_METHOD *ameth,
431 int (*get_pub_key) (const EVP_PKEY *pk,
435 ameth->get_pub_key = get_pub_key;