2 * Copyright 2019-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 #include <openssl/core.h>
11 #include <openssl/core_dispatch.h>
12 #include <openssl/encoder.h>
13 #include <openssl/ui.h>
14 #include "internal/core.h"
15 #include "internal/namemap.h"
16 #include "internal/property.h"
17 #include "internal/provider.h"
18 #include "crypto/encoder.h"
19 #include "encoder_local.h"
22 * Encoder can have multiple names, separated with colons in a name string
24 #define NAME_SEPARATOR ':'
26 /* Simple method structure constructor and destructor */
27 static OSSL_ENCODER
*ossl_encoder_new(void)
29 OSSL_ENCODER
*encoder
= NULL
;
31 if ((encoder
= OPENSSL_zalloc(sizeof(*encoder
))) == NULL
32 || (encoder
->base
.lock
= CRYPTO_THREAD_lock_new()) == NULL
) {
33 OSSL_ENCODER_free(encoder
);
34 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_MALLOC_FAILURE
);
38 encoder
->base
.refcnt
= 1;
43 int OSSL_ENCODER_up_ref(OSSL_ENCODER
*encoder
)
47 CRYPTO_UP_REF(&encoder
->base
.refcnt
, &ref
, encoder
->base
.lock
);
51 void OSSL_ENCODER_free(OSSL_ENCODER
*encoder
)
58 CRYPTO_DOWN_REF(&encoder
->base
.refcnt
, &ref
, encoder
->base
.lock
);
61 ossl_provider_free(encoder
->base
.prov
);
62 CRYPTO_THREAD_lock_free(encoder
->base
.lock
);
63 OPENSSL_free(encoder
);
66 /* Permanent encoder method store, constructor and destructor */
67 static void encoder_store_free(void *vstore
)
69 ossl_method_store_free(vstore
);
72 static void *encoder_store_new(OSSL_LIB_CTX
*ctx
)
74 return ossl_method_store_new(ctx
);
78 static const OSSL_LIB_CTX_METHOD encoder_store_method
= {
83 /* Data to be passed through ossl_method_construct() */
84 struct encoder_data_st
{
86 OSSL_METHOD_CONSTRUCT_METHOD
*mcm
;
87 int id
; /* For get_encoder_from_store() */
88 const char *names
; /* For get_encoder_from_store() */
89 const char *propquery
; /* For get_encoder_from_store() */
93 * Generic routines to fetch / create ENCODER methods with
94 * ossl_method_construct()
97 /* Temporary encoder method store, constructor and destructor */
98 static void *alloc_tmp_encoder_store(OSSL_LIB_CTX
*ctx
)
100 return ossl_method_store_new(ctx
);
103 static void dealloc_tmp_encoder_store(void *store
)
106 ossl_method_store_free(store
);
109 /* Get the permanent encoder store */
110 static OSSL_METHOD_STORE
*get_encoder_store(OSSL_LIB_CTX
*libctx
)
112 return ossl_lib_ctx_get_data(libctx
, OSSL_LIB_CTX_ENCODER_STORE_INDEX
,
113 &encoder_store_method
);
116 /* Get encoder methods from a store, or put one in */
117 static void *get_encoder_from_store(OSSL_LIB_CTX
*libctx
, void *store
,
120 struct encoder_data_st
*methdata
= data
;
124 if ((id
= methdata
->id
) == 0) {
125 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
127 id
= ossl_namemap_name2num(namemap
, methdata
->names
);
131 && (store
= get_encoder_store(libctx
)) == NULL
)
134 if (!ossl_method_store_fetch(store
, id
, methdata
->propquery
, &method
))
139 static int put_encoder_in_store(OSSL_LIB_CTX
*libctx
, void *store
,
140 void *method
, const OSSL_PROVIDER
*prov
,
141 int operation_id
, const char *names
,
142 const char *propdef
, void *unused
)
144 OSSL_NAMEMAP
*namemap
;
147 if ((namemap
= ossl_namemap_stored(libctx
)) == NULL
148 || (id
= ossl_namemap_name2num(namemap
, names
)) == 0)
151 if (store
== NULL
&& (store
= get_encoder_store(libctx
)) == NULL
)
154 return ossl_method_store_add(store
, prov
, id
, propdef
, method
,
155 (int (*)(void *))OSSL_ENCODER_up_ref
,
156 (void (*)(void *))OSSL_ENCODER_free
);
159 /* Create and populate a encoder method */
160 static void *encoder_from_dispatch(int id
, const OSSL_ALGORITHM
*algodef
,
163 OSSL_ENCODER
*encoder
= NULL
;
164 const OSSL_DISPATCH
*fns
= algodef
->implementation
;
166 if ((encoder
= ossl_encoder_new()) == NULL
)
168 encoder
->base
.id
= id
;
169 encoder
->base
.propdef
= algodef
->property_definition
;
171 for (; fns
->function_id
!= 0; fns
++) {
172 switch (fns
->function_id
) {
173 case OSSL_FUNC_ENCODER_NEWCTX
:
174 if (encoder
->newctx
== NULL
)
176 OSSL_FUNC_encoder_newctx(fns
);
178 case OSSL_FUNC_ENCODER_FREECTX
:
179 if (encoder
->freectx
== NULL
)
181 OSSL_FUNC_encoder_freectx(fns
);
183 case OSSL_FUNC_ENCODER_GET_PARAMS
:
184 if (encoder
->get_params
== NULL
)
185 encoder
->get_params
=
186 OSSL_FUNC_encoder_get_params(fns
);
188 case OSSL_FUNC_ENCODER_GETTABLE_PARAMS
:
189 if (encoder
->gettable_params
== NULL
)
190 encoder
->gettable_params
=
191 OSSL_FUNC_encoder_gettable_params(fns
);
193 case OSSL_FUNC_ENCODER_SET_CTX_PARAMS
:
194 if (encoder
->set_ctx_params
== NULL
)
195 encoder
->set_ctx_params
=
196 OSSL_FUNC_encoder_set_ctx_params(fns
);
198 case OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS
:
199 if (encoder
->settable_ctx_params
== NULL
)
200 encoder
->settable_ctx_params
=
201 OSSL_FUNC_encoder_settable_ctx_params(fns
);
203 case OSSL_FUNC_ENCODER_ENCODE
:
204 if (encoder
->encode
== NULL
)
205 encoder
->encode
= OSSL_FUNC_encoder_encode(fns
);
207 case OSSL_FUNC_ENCODER_IMPORT_OBJECT
:
208 if (encoder
->import_object
== NULL
)
209 encoder
->import_object
=
210 OSSL_FUNC_encoder_import_object(fns
);
212 case OSSL_FUNC_ENCODER_FREE_OBJECT
:
213 if (encoder
->free_object
== NULL
)
214 encoder
->free_object
=
215 OSSL_FUNC_encoder_free_object(fns
);
220 * Try to check that the method is sensible.
221 * If you have a constructor, you must have a destructor and vice versa.
222 * You must have the encoding driver functions.
224 if (!((encoder
->newctx
== NULL
&& encoder
->freectx
== NULL
)
225 || (encoder
->newctx
!= NULL
&& encoder
->freectx
!= NULL
)
226 || (encoder
->import_object
!= NULL
&& encoder
->free_object
!= NULL
)
227 || (encoder
->import_object
== NULL
&& encoder
->free_object
== NULL
))
228 || encoder
->encode
== NULL
229 || encoder
->gettable_params
== NULL
230 || encoder
->get_params
== NULL
) {
231 OSSL_ENCODER_free(encoder
);
232 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_INVALID_PROVIDER_FUNCTIONS
);
236 if (prov
!= NULL
&& !ossl_provider_up_ref(prov
)) {
237 OSSL_ENCODER_free(encoder
);
241 encoder
->base
.prov
= prov
;
247 * The core fetching functionality passes the names of the implementation.
248 * This function is responsible to getting an identity number for them,
249 * then call encoder_from_dispatch() with that identity number.
251 static void *construct_encoder(const OSSL_ALGORITHM
*algodef
,
252 OSSL_PROVIDER
*prov
, void *unused
)
255 * This function is only called if get_encoder_from_store() returned
256 * NULL, so it's safe to say that of all the spots to create a new
257 * namemap entry, this is it. Should the name already exist there, we
258 * know that ossl_namemap_add() will return its corresponding number.
260 OSSL_LIB_CTX
*libctx
= ossl_provider_library_context(prov
);
261 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
262 const char *names
= algodef
->algorithm_names
;
263 int id
= ossl_namemap_add_names(namemap
, 0, names
, NAME_SEPARATOR
);
267 method
= encoder_from_dispatch(id
, algodef
, prov
);
272 /* Intermediary function to avoid ugly casts, used below */
273 static void destruct_encoder(void *method
, void *data
)
275 OSSL_ENCODER_free(method
);
278 static int up_ref_encoder(void *method
)
280 return OSSL_ENCODER_up_ref(method
);
283 static void free_encoder(void *method
)
285 OSSL_ENCODER_free(method
);
288 /* Fetching support. Can fetch by numeric identity or by name */
289 static OSSL_ENCODER
*inner_ossl_encoder_fetch(OSSL_LIB_CTX
*libctx
,
290 int id
, const char *name
,
291 const char *properties
)
293 OSSL_METHOD_STORE
*store
= get_encoder_store(libctx
);
294 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
297 if (store
== NULL
|| namemap
== NULL
)
301 * If we have been passed neither a name_id or a name, we have an
302 * internal programming error.
304 if (!ossl_assert(id
!= 0 || name
!= NULL
))
308 id
= ossl_namemap_name2num(namemap
, name
);
311 || !ossl_method_store_cache_get(store
, id
, properties
, &method
)) {
312 OSSL_METHOD_CONSTRUCT_METHOD mcm
= {
313 alloc_tmp_encoder_store
,
314 dealloc_tmp_encoder_store
,
315 get_encoder_from_store
,
316 put_encoder_in_store
,
320 struct encoder_data_st mcmdata
;
322 mcmdata
.libctx
= libctx
;
325 mcmdata
.names
= name
;
326 mcmdata
.propquery
= properties
;
327 if ((method
= ossl_method_construct(libctx
, OSSL_OP_ENCODER
,
328 0 /* !force_cache */,
329 &mcm
, &mcmdata
)) != NULL
) {
331 * If construction did create a method for us, we know that
332 * there is a correct name_id and meth_id, since those have
333 * already been calculated in get_encoder_from_store() and
334 * put_encoder_in_store() above.
337 id
= ossl_namemap_name2num(namemap
, name
);
338 ossl_method_store_cache_set(store
, id
, properties
, method
,
339 up_ref_encoder
, free_encoder
);
346 OSSL_ENCODER
*OSSL_ENCODER_fetch(OSSL_LIB_CTX
*libctx
, const char *name
,
347 const char *properties
)
349 return inner_ossl_encoder_fetch(libctx
, 0, name
, properties
);
352 OSSL_ENCODER
*ossl_encoder_fetch_by_number(OSSL_LIB_CTX
*libctx
, int id
,
353 const char *properties
)
355 return inner_ossl_encoder_fetch(libctx
, id
, NULL
, properties
);
359 * Library of basic method functions
362 const OSSL_PROVIDER
*OSSL_ENCODER_provider(const OSSL_ENCODER
*encoder
)
364 if (!ossl_assert(encoder
!= NULL
)) {
365 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_PASSED_NULL_PARAMETER
);
369 return encoder
->base
.prov
;
372 const char *OSSL_ENCODER_properties(const OSSL_ENCODER
*encoder
)
374 if (!ossl_assert(encoder
!= NULL
)) {
375 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_PASSED_NULL_PARAMETER
);
379 return encoder
->base
.propdef
;
382 int OSSL_ENCODER_number(const OSSL_ENCODER
*encoder
)
384 if (!ossl_assert(encoder
!= NULL
)) {
385 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_PASSED_NULL_PARAMETER
);
389 return encoder
->base
.id
;
392 int OSSL_ENCODER_is_a(const OSSL_ENCODER
*encoder
, const char *name
)
394 if (encoder
->base
.prov
!= NULL
) {
395 OSSL_LIB_CTX
*libctx
= ossl_provider_library_context(encoder
->base
.prov
);
396 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
398 return ossl_namemap_name2num(namemap
, name
) == encoder
->base
.id
;
403 struct encoder_do_all_data_st
{
404 void (*user_fn
)(void *method
, void *arg
);
408 static void encoder_do_one(OSSL_PROVIDER
*provider
,
409 const OSSL_ALGORITHM
*algodef
,
410 int no_store
, void *vdata
)
412 struct encoder_do_all_data_st
*data
= vdata
;
413 OSSL_LIB_CTX
*libctx
= ossl_provider_library_context(provider
);
414 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
415 const char *names
= algodef
->algorithm_names
;
416 int id
= ossl_namemap_add_names(namemap
, 0, names
, NAME_SEPARATOR
);
421 encoder_from_dispatch(id
, algodef
, provider
);
423 if (method
!= NULL
) {
424 data
->user_fn(method
, data
->user_arg
);
425 OSSL_ENCODER_free(method
);
429 void OSSL_ENCODER_do_all_provided(OSSL_LIB_CTX
*libctx
,
430 void (*fn
)(OSSL_ENCODER
*encoder
, void *arg
),
433 struct encoder_do_all_data_st data
;
435 data
.user_fn
= (void (*)(void *, void *))fn
;
439 * No pre- or post-condition for this call, as this only creates methods
440 * temporarly and then promptly destroys them.
442 ossl_algorithm_do_all(libctx
, OSSL_OP_ENCODER
, NULL
, NULL
,
443 encoder_do_one
, NULL
, &data
);
446 void OSSL_ENCODER_names_do_all(const OSSL_ENCODER
*encoder
,
447 void (*fn
)(const char *name
, void *data
),
453 if (encoder
->base
.prov
!= NULL
) {
454 OSSL_LIB_CTX
*libctx
= ossl_provider_library_context(encoder
->base
.prov
);
455 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
457 ossl_namemap_doall_names(namemap
, encoder
->base
.id
, fn
, data
);
462 OSSL_ENCODER_gettable_params(OSSL_ENCODER
*encoder
)
464 if (encoder
!= NULL
&& encoder
->gettable_params
!= NULL
) {
465 void *provctx
= ossl_provider_ctx(OSSL_ENCODER_provider(encoder
));
467 return encoder
->gettable_params(provctx
);
472 int OSSL_ENCODER_get_params(OSSL_ENCODER
*encoder
, OSSL_PARAM params
[])
474 if (encoder
!= NULL
&& encoder
->get_params
!= NULL
)
475 return encoder
->get_params(params
);
479 const OSSL_PARAM
*OSSL_ENCODER_settable_ctx_params(OSSL_ENCODER
*encoder
)
481 if (encoder
!= NULL
&& encoder
->settable_ctx_params
!= NULL
) {
482 void *provctx
= ossl_provider_ctx(OSSL_ENCODER_provider(encoder
));
484 return encoder
->settable_ctx_params(provctx
);
490 * Encoder context support
493 OSSL_ENCODER_CTX
*OSSL_ENCODER_CTX_new(void)
495 OSSL_ENCODER_CTX
*ctx
;
497 if ((ctx
= OPENSSL_zalloc(sizeof(*ctx
))) == NULL
)
498 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_MALLOC_FAILURE
);
503 int OSSL_ENCODER_CTX_set_params(OSSL_ENCODER_CTX
*ctx
,
504 const OSSL_PARAM params
[])
509 if (!ossl_assert(ctx
!= NULL
)) {
510 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_PASSED_NULL_PARAMETER
);
514 if (ctx
->encoder_insts
== NULL
)
517 l
= OSSL_ENCODER_CTX_get_num_encoders(ctx
);
518 for (i
= 0; i
< l
; i
++) {
519 OSSL_ENCODER_INSTANCE
*encoder_inst
=
520 sk_OSSL_ENCODER_INSTANCE_value(ctx
->encoder_insts
, i
);
521 OSSL_ENCODER
*encoder
= OSSL_ENCODER_INSTANCE_get_encoder(encoder_inst
);
522 void *encoderctx
= OSSL_ENCODER_INSTANCE_get_encoder_ctx(encoder_inst
);
524 if (encoderctx
== NULL
|| encoder
->set_ctx_params
== NULL
)
526 if (!encoder
->set_ctx_params(encoderctx
, params
))
532 void OSSL_ENCODER_CTX_free(OSSL_ENCODER_CTX
*ctx
)
535 sk_OSSL_ENCODER_INSTANCE_pop_free(ctx
->encoder_insts
,
536 ossl_encoder_instance_free
);
537 OPENSSL_free(ctx
->construct_data
);
538 ossl_pw_clear_passphrase_data(&ctx
->pwdata
);