2 * Copyright 2019 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
11 #include <openssl/ossl_typ.h>
12 #include <openssl/evp.h>
13 #include <openssl/core.h>
14 #include "internal/cryptlib.h"
15 #include "internal/thread_once.h"
16 #include "internal/property.h"
17 #include "internal/core.h"
18 #include "internal/namemap.h"
19 #include "internal/evp_int.h" /* evp_locl.h needs it */
22 static void default_method_store_free(void *vstore
)
24 ossl_method_store_free(vstore
);
27 static void *default_method_store_new(OPENSSL_CTX
*ctx
)
29 return ossl_method_store_new(ctx
);
33 static const OPENSSL_CTX_METHOD default_method_store_method
= {
34 default_method_store_new
,
35 default_method_store_free
,
38 /* Data to be passed through ossl_method_construct() */
39 struct method_data_st
{
42 OSSL_METHOD_CONSTRUCT_METHOD
*mcm
;
43 void *(*method_from_dispatch
)(const char *, const OSSL_DISPATCH
*,
45 int (*refcnt_up_method
)(void *method
);
46 void (*destruct_method
)(void *method
);
50 * Generic routines to fetch / create EVP methods with ossl_method_construct()
52 static void *alloc_tmp_method_store(OPENSSL_CTX
*ctx
)
54 return ossl_method_store_new(ctx
);
57 static void dealloc_tmp_method_store(void *store
)
60 ossl_method_store_free(store
);
63 static OSSL_METHOD_STORE
*get_default_method_store(OPENSSL_CTX
*libctx
)
65 return openssl_ctx_get_data(libctx
, OPENSSL_CTX_DEFAULT_METHOD_STORE_INDEX
,
66 &default_method_store_method
);
70 * To identity the method in the method store, we mix the name identity
71 * with the operation identity, with the assumption that we don't have
72 * more than 2^24 names or more than 2^8 operation types.
74 * The resulting identity is a 32-bit integer, composed like this:
76 * +---------24 bits--------+-8 bits-+
77 * | name identity | op id |
78 * +------------------------+--------+
80 static uint32_t method_id(unsigned int operation_id
, unsigned int name_id
)
82 if (!ossl_assert(name_id
< (1 << 24) || operation_id
< (1 << 8))
83 || !ossl_assert(name_id
> 0 && operation_id
> 0))
85 return ((name_id
<< 8) & 0xFFFFFF00) | (operation_id
& 0x000000FF);
88 static void *get_method_from_store(OPENSSL_CTX
*libctx
, void *store
,
89 int operation_id
, const char *name
,
90 const char *propquery
, void *data
)
92 struct method_data_st
*methdata
= data
;
94 OSSL_NAMEMAP
*namemap
;
99 && (store
= get_default_method_store(libctx
)) == NULL
)
102 if ((namemap
= ossl_namemap_stored(libctx
)) == NULL
103 || (nameid
= ossl_namemap_name2num(namemap
, name
)) == 0
104 || (methid
= method_id(operation_id
, nameid
)) == 0)
107 (void)ossl_method_store_fetch(store
, methid
, propquery
, &method
);
110 && !methdata
->refcnt_up_method(method
)) {
116 static int put_method_in_store(OPENSSL_CTX
*libctx
, void *store
,
117 void *method
, int operation_id
,
118 const char *name
, const char *propdef
,
121 struct method_data_st
*methdata
= data
;
122 OSSL_NAMEMAP
*namemap
;
126 if ((namemap
= ossl_namemap_stored(methdata
->libctx
)) == NULL
127 || (nameid
= ossl_namemap_add(namemap
, 0, name
)) == 0
128 || (methid
= method_id(operation_id
, nameid
)) == 0)
132 && (store
= get_default_method_store(libctx
)) == NULL
)
135 return ossl_method_store_add(store
, methid
, propdef
, method
,
136 methdata
->refcnt_up_method
,
137 methdata
->destruct_method
);
140 static void *construct_method(const char *name
, const OSSL_DISPATCH
*fns
,
141 OSSL_PROVIDER
*prov
, void *data
)
143 struct method_data_st
*methdata
= data
;
145 return methdata
->method_from_dispatch(name
, fns
, prov
);
148 static void destruct_method(void *method
, void *data
)
150 struct method_data_st
*methdata
= data
;
152 methdata
->destruct_method(method
);
155 void *evp_generic_fetch(OPENSSL_CTX
*libctx
, int operation_id
,
156 const char *name
, const char *properties
,
157 void *(*new_method
)(const char *name
,
158 const OSSL_DISPATCH
*fns
,
159 OSSL_PROVIDER
*prov
),
160 int (*up_ref_method
)(void *),
161 void (*free_method
)(void *))
163 OSSL_METHOD_STORE
*store
= get_default_method_store(libctx
);
164 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
169 if (store
== NULL
|| namemap
== NULL
)
173 * If there's ever an operation_id == 0 passed, we have an internal
176 if (!ossl_assert(operation_id
> 0))
180 * method_id returns 0 if we have too many operations (more than
181 * about 2^8) or too many names (more than about 2^24). In that
182 * case, we can't create any new method.
184 if ((nameid
= ossl_namemap_name2num(namemap
, name
)) != 0
185 && (methid
= method_id(operation_id
, nameid
)) == 0)
189 || !ossl_method_store_cache_get(store
, methid
, properties
,
191 OSSL_METHOD_CONSTRUCT_METHOD mcm
= {
192 alloc_tmp_method_store
,
193 dealloc_tmp_method_store
,
194 get_method_from_store
,
199 struct method_data_st mcmdata
;
202 mcmdata
.libctx
= libctx
;
204 mcmdata
.method_from_dispatch
= new_method
;
205 mcmdata
.destruct_method
= free_method
;
206 mcmdata
.refcnt_up_method
= up_ref_method
;
207 mcmdata
.destruct_method
= free_method
;
208 if ((method
= ossl_method_construct(libctx
, operation_id
, name
,
209 properties
, 0 /* !force_cache */,
210 &mcm
, &mcmdata
)) != NULL
) {
212 * If construction did create a method for us, we know that
213 * there is a correct nameid and methodid, since those have
214 * already been calculated in get_method_from_store() and
215 * put_method_in_store() above.
217 nameid
= ossl_namemap_name2num(namemap
, name
);
218 methid
= method_id(operation_id
, nameid
);
219 ossl_method_store_cache_set(store
, methid
, properties
, method
);
222 up_ref_method(method
);
228 int EVP_set_default_properties(OPENSSL_CTX
*libctx
, const char *propq
)
230 OSSL_METHOD_STORE
*store
= get_default_method_store(libctx
);
233 return ossl_method_store_set_global_properties(store
, propq
);
234 EVPerr(EVP_F_EVP_SET_DEFAULT_PROPERTIES
, ERR_R_INTERNAL_ERROR
);
238 struct do_all_data_st
{
239 void (*user_fn
)(void *method
, void *arg
);
241 void *(*new_method
)(const char *name
, const OSSL_DISPATCH
*fns
,
242 OSSL_PROVIDER
*prov
);
243 void (*free_method
)(void *);
246 static void do_one(OSSL_PROVIDER
*provider
, const OSSL_ALGORITHM
*algo
,
247 int no_store
, void *vdata
)
249 struct do_all_data_st
*data
= vdata
;
250 void *method
= data
->new_method(algo
->algorithm_name
,
251 algo
->implementation
, provider
);
253 if (method
!= NULL
) {
254 data
->user_fn(method
, data
->user_arg
);
255 data
->free_method(method
);
259 void evp_generic_do_all(OPENSSL_CTX
*libctx
, int operation_id
,
260 void (*user_fn
)(void *method
, void *arg
),
262 void *(*new_method
)(const char *name
,
263 const OSSL_DISPATCH
*fns
,
264 OSSL_PROVIDER
*prov
),
265 void (*free_method
)(void *))
267 struct do_all_data_st data
;
269 data
.new_method
= new_method
;
270 data
.free_method
= free_method
;
271 data
.user_fn
= user_fn
;
272 data
.user_arg
= user_arg
;
273 ossl_algorithm_do_all(libctx
, operation_id
, NULL
, do_one
, &data
);