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
14 #include "eng_local.h"
15 #include <openssl/evp.h>
16 #include "crypto/asn1.h"
19 * If this symbol is defined then ENGINE_get_pkey_asn1_meth_engine(), the
20 * function that is used by EVP to hook in pkey_asn1_meth code and cache
21 * defaults (etc), will display brief debugging summaries to stderr with the
24 /* #define ENGINE_PKEY_ASN1_METH_DEBUG */
26 static ENGINE_TABLE
*pkey_asn1_meth_table
= NULL
;
28 void ENGINE_unregister_pkey_asn1_meths(ENGINE
*e
)
30 engine_table_unregister(&pkey_asn1_meth_table
, e
);
33 static void engine_unregister_all_pkey_asn1_meths(void)
35 engine_table_cleanup(&pkey_asn1_meth_table
);
38 int ENGINE_register_pkey_asn1_meths(ENGINE
*e
)
40 if (e
->pkey_asn1_meths
) {
42 int num_nids
= e
->pkey_asn1_meths(e
, NULL
, &nids
, 0);
44 return engine_table_register(&pkey_asn1_meth_table
,
45 engine_unregister_all_pkey_asn1_meths
,
46 e
, nids
, num_nids
, 0);
51 void ENGINE_register_all_pkey_asn1_meths(void)
55 for (e
= ENGINE_get_first(); e
; e
= ENGINE_get_next(e
))
56 ENGINE_register_pkey_asn1_meths(e
);
59 int ENGINE_set_default_pkey_asn1_meths(ENGINE
*e
)
61 if (e
->pkey_asn1_meths
) {
63 int num_nids
= e
->pkey_asn1_meths(e
, NULL
, &nids
, 0);
65 return engine_table_register(&pkey_asn1_meth_table
,
66 engine_unregister_all_pkey_asn1_meths
,
67 e
, nids
, num_nids
, 1);
73 * Exposed API function to get a functional reference from the implementation
74 * table (ie. try to get a functional reference from the tabled structural
75 * references) for a given pkey_asn1_meth 'nid'
77 ENGINE
*ENGINE_get_pkey_asn1_meth_engine(int nid
)
79 return engine_table_select(&pkey_asn1_meth_table
, nid
);
83 * Obtains a pkey_asn1_meth implementation from an ENGINE functional
86 const EVP_PKEY_ASN1_METHOD
*ENGINE_get_pkey_asn1_meth(ENGINE
*e
, int nid
)
88 EVP_PKEY_ASN1_METHOD
*ret
;
89 ENGINE_PKEY_ASN1_METHS_PTR fn
= ENGINE_get_pkey_asn1_meths(e
);
90 if (!fn
|| !fn(e
, &ret
, NULL
, nid
)) {
91 ERR_raise(ERR_LIB_ENGINE
, ENGINE_R_UNIMPLEMENTED_PUBLIC_KEY_METHOD
);
97 /* Gets the pkey_asn1_meth callback from an ENGINE structure */
98 ENGINE_PKEY_ASN1_METHS_PTR
ENGINE_get_pkey_asn1_meths(const ENGINE
*e
)
100 return e
->pkey_asn1_meths
;
103 /* Sets the pkey_asn1_meth callback in an ENGINE structure */
104 int ENGINE_set_pkey_asn1_meths(ENGINE
*e
, ENGINE_PKEY_ASN1_METHS_PTR f
)
106 e
->pkey_asn1_meths
= f
;
111 * Internal function to free up EVP_PKEY_ASN1_METHOD structures before an
112 * ENGINE is destroyed
115 void engine_pkey_asn1_meths_free(ENGINE
*e
)
118 EVP_PKEY_ASN1_METHOD
*pkm
;
119 if (e
->pkey_asn1_meths
) {
122 npknids
= e
->pkey_asn1_meths(e
, NULL
, &pknids
, 0);
123 for (i
= 0; i
< npknids
; i
++) {
124 if (e
->pkey_asn1_meths(e
, &pkm
, NULL
, pknids
[i
])) {
125 EVP_PKEY_asn1_free(pkm
);
132 * Find a method based on a string. This does a linear search through all
133 * implemented algorithms. This is OK in practice because only a small number
134 * of algorithms are likely to be implemented in an engine and it is not used
135 * for speed critical operations.
138 const EVP_PKEY_ASN1_METHOD
*ENGINE_get_pkey_asn1_meth_str(ENGINE
*e
,
144 EVP_PKEY_ASN1_METHOD
*ameth
;
145 if (!e
->pkey_asn1_meths
)
149 nidcount
= e
->pkey_asn1_meths(e
, NULL
, &nids
, 0);
150 for (i
= 0; i
< nidcount
; i
++) {
151 e
->pkey_asn1_meths(e
, &ameth
, NULL
, nids
[i
]);
153 && ((int)strlen(ameth
->pem_str
) == len
)
154 && strncasecmp(ameth
->pem_str
, str
, len
) == 0)
162 const EVP_PKEY_ASN1_METHOD
*ameth
;
167 static void look_str_cb(int nid
, STACK_OF(ENGINE
) *sk
, ENGINE
*def
, void *arg
)
169 ENGINE_FIND_STR
*lk
= arg
;
173 for (i
= 0; i
< sk_ENGINE_num(sk
); i
++) {
174 ENGINE
*e
= sk_ENGINE_value(sk
, i
);
175 EVP_PKEY_ASN1_METHOD
*ameth
;
176 e
->pkey_asn1_meths(e
, &ameth
, NULL
, nid
);
178 && ((int)strlen(ameth
->pem_str
) == lk
->len
)
179 && strncasecmp(ameth
->pem_str
, lk
->str
, lk
->len
) == 0) {
187 const EVP_PKEY_ASN1_METHOD
*ENGINE_pkey_asn1_find_str(ENGINE
**pe
,
191 ENGINE_FIND_STR fstr
;
197 if (!RUN_ONCE(&engine_lock_init
, do_engine_lock_init
)) {
198 ERR_raise(ERR_LIB_ENGINE
, ERR_R_MALLOC_FAILURE
);
202 if (!CRYPTO_THREAD_write_lock(global_engine_lock
))
204 engine_table_doall(pkey_asn1_meth_table
, look_str_cb
, &fstr
);
205 /* If found obtain a structural reference to engine */
207 fstr
.e
->struct_ref
++;
208 engine_ref_debug(fstr
.e
, 0, 1);
211 CRYPTO_THREAD_unlock(global_engine_lock
);