2 * Copyright 2020-2025 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/decoder.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/decoder.h"
19 #include "encoder_local.h"
20 #include "crypto/context.h"
23 * Decoder can have multiple names, separated with colons in a name string
25 #define NAME_SEPARATOR ':'
27 static void ossl_decoder_free(void *data
)
29 OSSL_DECODER_free(data
);
32 static int ossl_decoder_up_ref(void *data
)
34 return OSSL_DECODER_up_ref(data
);
37 /* Simple method structure constructor and destructor */
38 static OSSL_DECODER
*ossl_decoder_new(void)
40 OSSL_DECODER
*decoder
= NULL
;
42 if ((decoder
= OPENSSL_zalloc(sizeof(*decoder
))) == NULL
)
44 if (!CRYPTO_NEW_REF(&decoder
->base
.refcnt
, 1)) {
45 OSSL_DECODER_free(decoder
);
52 int OSSL_DECODER_up_ref(OSSL_DECODER
*decoder
)
56 CRYPTO_UP_REF(&decoder
->base
.refcnt
, &ref
);
60 void OSSL_DECODER_free(OSSL_DECODER
*decoder
)
67 CRYPTO_DOWN_REF(&decoder
->base
.refcnt
, &ref
);
70 OPENSSL_free(decoder
->base
.name
);
71 ossl_property_free(decoder
->base
.parsed_propdef
);
72 ossl_provider_free(decoder
->base
.prov
);
73 CRYPTO_FREE_REF(&decoder
->base
.refcnt
);
74 OPENSSL_free(decoder
);
77 /* Data to be passed through ossl_method_construct() */
78 struct decoder_data_st
{
80 int id
; /* For get_decoder_from_store() */
81 const char *names
; /* For get_decoder_from_store() */
82 const char *propquery
; /* For get_decoder_from_store() */
84 OSSL_METHOD_STORE
*tmp_store
; /* For get_tmp_decoder_store() */
86 unsigned int flag_construct_error_occurred
: 1;
90 * Generic routines to fetch / create DECODER methods with
91 * ossl_method_construct()
94 /* Temporary decoder method store, constructor and destructor */
95 static void *get_tmp_decoder_store(void *data
)
97 struct decoder_data_st
*methdata
= data
;
99 if (methdata
->tmp_store
== NULL
)
100 methdata
->tmp_store
= ossl_method_store_new(methdata
->libctx
);
101 return methdata
->tmp_store
;
104 static void dealloc_tmp_decoder_store(void *store
)
107 ossl_method_store_free(store
);
110 /* Get the permanent decoder store */
111 static OSSL_METHOD_STORE
*get_decoder_store(OSSL_LIB_CTX
*libctx
)
113 return ossl_lib_ctx_get_data(libctx
, OSSL_LIB_CTX_DECODER_STORE_INDEX
);
116 static int reserve_decoder_store(void *store
, void *data
)
118 struct decoder_data_st
*methdata
= data
;
121 && (store
= get_decoder_store(methdata
->libctx
)) == NULL
)
124 return ossl_method_lock_store(store
);
127 static int unreserve_decoder_store(void *store
, void *data
)
129 struct decoder_data_st
*methdata
= data
;
132 && (store
= get_decoder_store(methdata
->libctx
)) == NULL
)
135 return ossl_method_unlock_store(store
);
138 /* Get decoder methods from a store, or put one in */
139 static void *get_decoder_from_store(void *store
, const OSSL_PROVIDER
**prov
,
142 struct decoder_data_st
*methdata
= data
;
147 * get_decoder_from_store() is only called to try and get the method
148 * that OSSL_DECODER_fetch() is asking for, and the name or name id are
149 * passed via methdata.
151 if ((id
= methdata
->id
) == 0 && methdata
->names
!= NULL
) {
152 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(methdata
->libctx
);
153 const char *names
= methdata
->names
;
154 const char *q
= strchr(names
, NAME_SEPARATOR
);
155 size_t l
= (q
== NULL
? strlen(names
) : (size_t)(q
- names
));
159 id
= ossl_namemap_name2num_n(namemap
, names
, l
);
166 && (store
= get_decoder_store(methdata
->libctx
)) == NULL
)
169 if (!ossl_method_store_fetch(store
, id
, methdata
->propquery
, prov
, &method
))
174 static int put_decoder_in_store(void *store
, void *method
,
175 const OSSL_PROVIDER
*prov
,
176 const char *names
, const char *propdef
,
179 struct decoder_data_st
*methdata
= data
;
180 OSSL_NAMEMAP
*namemap
;
185 * put_decoder_in_store() is only called with an OSSL_DECODER method that
186 * was successfully created by construct_decoder() below, which means that
187 * all the names should already be stored in the namemap with the same
188 * numeric identity, so just use the first to get that identity.
191 const char *q
= strchr(names
, NAME_SEPARATOR
);
193 l
= (q
== NULL
? strlen(names
) : (size_t)(q
- names
));
196 if ((namemap
= ossl_namemap_stored(methdata
->libctx
)) == NULL
197 || (id
= ossl_namemap_name2num_n(namemap
, names
, l
)) == 0)
200 if (store
== NULL
&& (store
= get_decoder_store(methdata
->libctx
)) == NULL
)
203 return ossl_method_store_add(store
, prov
, id
, propdef
, method
,
208 /* Create and populate a decoder method */
209 void *ossl_decoder_from_algorithm(int id
, const OSSL_ALGORITHM
*algodef
,
212 OSSL_DECODER
*decoder
= NULL
;
213 const OSSL_DISPATCH
*fns
= algodef
->implementation
;
214 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(prov
);
216 if ((decoder
= ossl_decoder_new()) == NULL
)
218 decoder
->base
.id
= id
;
219 if ((decoder
->base
.name
= ossl_algorithm_get1_first_name(algodef
)) == NULL
) {
220 OSSL_DECODER_free(decoder
);
223 decoder
->base
.algodef
= algodef
;
224 if ((decoder
->base
.parsed_propdef
225 = ossl_parse_property(libctx
, algodef
->property_definition
)) == NULL
) {
226 OSSL_DECODER_free(decoder
);
230 for (; fns
->function_id
!= 0; fns
++) {
231 switch (fns
->function_id
) {
232 case OSSL_FUNC_DECODER_NEWCTX
:
233 if (decoder
->newctx
== NULL
)
234 decoder
->newctx
= OSSL_FUNC_decoder_newctx(fns
);
236 case OSSL_FUNC_DECODER_FREECTX
:
237 if (decoder
->freectx
== NULL
)
238 decoder
->freectx
= OSSL_FUNC_decoder_freectx(fns
);
240 case OSSL_FUNC_DECODER_GET_PARAMS
:
241 if (decoder
->get_params
== NULL
)
242 decoder
->get_params
=
243 OSSL_FUNC_decoder_get_params(fns
);
245 case OSSL_FUNC_DECODER_GETTABLE_PARAMS
:
246 if (decoder
->gettable_params
== NULL
)
247 decoder
->gettable_params
=
248 OSSL_FUNC_decoder_gettable_params(fns
);
250 case OSSL_FUNC_DECODER_SET_CTX_PARAMS
:
251 if (decoder
->set_ctx_params
== NULL
)
252 decoder
->set_ctx_params
=
253 OSSL_FUNC_decoder_set_ctx_params(fns
);
255 case OSSL_FUNC_DECODER_SETTABLE_CTX_PARAMS
:
256 if (decoder
->settable_ctx_params
== NULL
)
257 decoder
->settable_ctx_params
=
258 OSSL_FUNC_decoder_settable_ctx_params(fns
);
260 case OSSL_FUNC_DECODER_DOES_SELECTION
:
261 if (decoder
->does_selection
== NULL
)
262 decoder
->does_selection
=
263 OSSL_FUNC_decoder_does_selection(fns
);
265 case OSSL_FUNC_DECODER_DECODE
:
266 if (decoder
->decode
== NULL
)
267 decoder
->decode
= OSSL_FUNC_decoder_decode(fns
);
269 case OSSL_FUNC_DECODER_EXPORT_OBJECT
:
270 if (decoder
->export_object
== NULL
)
271 decoder
->export_object
= OSSL_FUNC_decoder_export_object(fns
);
276 * Try to check that the method is sensible.
277 * If you have a constructor, you must have a destructor and vice versa.
278 * You must have at least one of the encoding driver functions.
280 if (!((decoder
->newctx
== NULL
&& decoder
->freectx
== NULL
)
281 || (decoder
->newctx
!= NULL
&& decoder
->freectx
!= NULL
))
282 || decoder
->decode
== NULL
) {
283 OSSL_DECODER_free(decoder
);
284 ERR_raise(ERR_LIB_OSSL_DECODER
, ERR_R_INVALID_PROVIDER_FUNCTIONS
);
288 if (prov
!= NULL
&& !ossl_provider_up_ref(prov
)) {
289 OSSL_DECODER_free(decoder
);
293 decoder
->base
.prov
= prov
;
299 * The core fetching functionality passes the names of the implementation.
300 * This function is responsible to getting an identity number for them,
301 * then call ossl_decoder_from_algorithm() with that identity number.
303 static void *construct_decoder(const OSSL_ALGORITHM
*algodef
,
304 OSSL_PROVIDER
*prov
, void *data
)
307 * This function is only called if get_decoder_from_store() returned
308 * NULL, so it's safe to say that of all the spots to create a new
309 * namemap entry, this is it. Should the name already exist there, we
310 * know that ossl_namemap_add() will return its corresponding number.
312 struct decoder_data_st
*methdata
= data
;
313 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(prov
);
314 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
315 const char *names
= algodef
->algorithm_names
;
316 int id
= ossl_namemap_add_names(namemap
, 0, names
, NAME_SEPARATOR
);
320 method
= ossl_decoder_from_algorithm(id
, algodef
, prov
);
323 * Flag to indicate that there was actual construction errors. This
324 * helps inner_evp_generic_fetch() determine what error it should
325 * record on inaccessible algorithms.
328 methdata
->flag_construct_error_occurred
= 1;
333 /* Intermediary function to avoid ugly casts, used below */
334 static void destruct_decoder(void *method
, void *data
)
336 OSSL_DECODER_free(method
);
339 static int up_ref_decoder(void *method
)
341 return OSSL_DECODER_up_ref(method
);
344 static void free_decoder(void *method
)
346 OSSL_DECODER_free(method
);
349 /* Fetching support. Can fetch by numeric identity or by name */
350 static OSSL_DECODER
*
351 inner_ossl_decoder_fetch(struct decoder_data_st
*methdata
,
352 const char *name
, const char *properties
)
354 OSSL_METHOD_STORE
*store
= get_decoder_store(methdata
->libctx
);
355 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(methdata
->libctx
);
356 const char *const propq
= properties
!= NULL
? properties
: "";
360 if (store
== NULL
|| namemap
== NULL
) {
361 ERR_raise(ERR_LIB_OSSL_DECODER
, ERR_R_PASSED_INVALID_ARGUMENT
);
365 id
= name
!= NULL
? ossl_namemap_name2num(namemap
, name
) : 0;
368 * If we haven't found the name yet, chances are that the algorithm to
369 * be fetched is unsupported.
371 unsupported
= id
== 0;
374 || !ossl_method_store_cache_get(store
, NULL
, id
, propq
, &method
)) {
375 OSSL_METHOD_CONSTRUCT_METHOD mcm
= {
376 get_tmp_decoder_store
,
377 reserve_decoder_store
,
378 unreserve_decoder_store
,
379 get_decoder_from_store
,
380 put_decoder_in_store
,
384 OSSL_PROVIDER
*prov
= NULL
;
387 methdata
->names
= name
;
388 methdata
->propquery
= propq
;
389 methdata
->flag_construct_error_occurred
= 0;
390 if ((method
= ossl_method_construct(methdata
->libctx
, OSSL_OP_DECODER
,
391 &prov
, 0 /* !force_cache */,
392 &mcm
, methdata
)) != NULL
) {
394 * If construction did create a method for us, we know that
395 * there is a correct name_id and meth_id, since those have
396 * already been calculated in get_decoder_from_store() and
397 * put_decoder_in_store() above.
399 if (id
== 0 && name
!= NULL
)
400 id
= ossl_namemap_name2num(namemap
, name
);
402 ossl_method_store_cache_set(store
, prov
, id
, propq
, method
,
403 up_ref_decoder
, free_decoder
);
407 * If we never were in the constructor, the algorithm to be fetched
410 unsupported
= !methdata
->flag_construct_error_occurred
;
413 if ((id
!= 0 || name
!= NULL
) && method
== NULL
) {
414 int code
= unsupported
? ERR_R_UNSUPPORTED
: ERR_R_FETCH_FAILED
;
417 name
= ossl_namemap_num2name(namemap
, id
, 0);
418 ERR_raise_data(ERR_LIB_OSSL_DECODER
, code
,
419 "%s, Name (%s : %d), Properties (%s)",
420 ossl_lib_ctx_get_descriptor(methdata
->libctx
),
421 name
== NULL
? "<null>" : name
, id
,
422 properties
== NULL
? "<null>" : properties
);
428 OSSL_DECODER
*OSSL_DECODER_fetch(OSSL_LIB_CTX
*libctx
, const char *name
,
429 const char *properties
)
431 struct decoder_data_st methdata
;
434 methdata
.libctx
= libctx
;
435 methdata
.tmp_store
= NULL
;
436 method
= inner_ossl_decoder_fetch(&methdata
, name
, properties
);
437 dealloc_tmp_decoder_store(methdata
.tmp_store
);
441 int ossl_decoder_store_cache_flush(OSSL_LIB_CTX
*libctx
)
443 OSSL_METHOD_STORE
*store
= get_decoder_store(libctx
);
446 return ossl_method_store_cache_flush_all(store
);
450 int ossl_decoder_store_remove_all_provided(const OSSL_PROVIDER
*prov
)
452 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(prov
);
453 OSSL_METHOD_STORE
*store
= get_decoder_store(libctx
);
456 return ossl_method_store_remove_all_provided(store
, prov
);
461 * Library of basic method functions
464 const OSSL_PROVIDER
*OSSL_DECODER_get0_provider(const OSSL_DECODER
*decoder
)
466 if (!ossl_assert(decoder
!= NULL
)) {
467 ERR_raise(ERR_LIB_OSSL_DECODER
, ERR_R_PASSED_NULL_PARAMETER
);
471 return decoder
->base
.prov
;
474 const char *OSSL_DECODER_get0_properties(const OSSL_DECODER
*decoder
)
476 if (!ossl_assert(decoder
!= NULL
)) {
477 ERR_raise(ERR_LIB_OSSL_DECODER
, ERR_R_PASSED_NULL_PARAMETER
);
481 return decoder
->base
.algodef
->property_definition
;
484 const OSSL_PROPERTY_LIST
*
485 ossl_decoder_parsed_properties(const OSSL_DECODER
*decoder
)
487 if (!ossl_assert(decoder
!= NULL
)) {
488 ERR_raise(ERR_LIB_OSSL_DECODER
, ERR_R_PASSED_NULL_PARAMETER
);
492 return decoder
->base
.parsed_propdef
;
495 int ossl_decoder_get_number(const OSSL_DECODER
*decoder
)
497 if (!ossl_assert(decoder
!= NULL
)) {
498 ERR_raise(ERR_LIB_OSSL_DECODER
, ERR_R_PASSED_NULL_PARAMETER
);
502 return decoder
->base
.id
;
505 const char *OSSL_DECODER_get0_name(const OSSL_DECODER
*decoder
)
507 return decoder
->base
.name
;
510 const char *OSSL_DECODER_get0_description(const OSSL_DECODER
*decoder
)
512 return decoder
->base
.algodef
->algorithm_description
;
515 int OSSL_DECODER_is_a(const OSSL_DECODER
*decoder
, const char *name
)
517 if (decoder
->base
.prov
!= NULL
) {
518 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(decoder
->base
.prov
);
519 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
521 return ossl_namemap_name2num(namemap
, name
) == decoder
->base
.id
;
526 static int resolve_name(OSSL_DECODER
*decoder
, const char *name
)
528 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(decoder
->base
.prov
);
529 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
531 return ossl_namemap_name2num(namemap
, name
);
534 int ossl_decoder_fast_is_a(OSSL_DECODER
*decoder
, const char *name
, int *id_cache
)
539 *id_cache
= id
= resolve_name(decoder
, name
);
541 return id
> 0 && ossl_decoder_get_number(decoder
) == id
;
544 struct do_one_data_st
{
545 void (*user_fn
)(OSSL_DECODER
*decoder
, void *arg
);
549 static void do_one(ossl_unused
int id
, void *method
, void *arg
)
551 struct do_one_data_st
*data
= arg
;
553 data
->user_fn(method
, data
->user_arg
);
556 void OSSL_DECODER_do_all_provided(OSSL_LIB_CTX
*libctx
,
557 void (*user_fn
)(OSSL_DECODER
*decoder
,
561 struct decoder_data_st methdata
;
562 struct do_one_data_st data
;
564 methdata
.libctx
= libctx
;
565 methdata
.tmp_store
= NULL
;
566 (void)inner_ossl_decoder_fetch(&methdata
, NULL
, NULL
/* properties */);
568 data
.user_fn
= user_fn
;
569 data
.user_arg
= user_arg
;
570 if (methdata
.tmp_store
!= NULL
)
571 ossl_method_store_do_all(methdata
.tmp_store
, &do_one
, &data
);
572 ossl_method_store_do_all(get_decoder_store(libctx
), &do_one
, &data
);
573 dealloc_tmp_decoder_store(methdata
.tmp_store
);
576 int OSSL_DECODER_names_do_all(const OSSL_DECODER
*decoder
,
577 void (*fn
)(const char *name
, void *data
),
583 if (decoder
->base
.prov
!= NULL
) {
584 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(decoder
->base
.prov
);
585 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
587 return ossl_namemap_doall_names(namemap
, decoder
->base
.id
, fn
, data
);
594 OSSL_DECODER_gettable_params(OSSL_DECODER
*decoder
)
596 if (decoder
!= NULL
&& decoder
->gettable_params
!= NULL
) {
597 void *provctx
= ossl_provider_ctx(OSSL_DECODER_get0_provider(decoder
));
599 return decoder
->gettable_params(provctx
);
604 int OSSL_DECODER_get_params(OSSL_DECODER
*decoder
, OSSL_PARAM params
[])
606 if (decoder
!= NULL
&& decoder
->get_params
!= NULL
)
607 return decoder
->get_params(params
);
612 OSSL_DECODER_settable_ctx_params(OSSL_DECODER
*decoder
)
614 if (decoder
!= NULL
&& decoder
->settable_ctx_params
!= NULL
) {
615 void *provctx
= ossl_provider_ctx(OSSL_DECODER_get0_provider(decoder
));
617 return decoder
->settable_ctx_params(provctx
);
623 * Decoder context support
627 * |encoder| value NULL is valid, and signifies that there is no decoder.
628 * This is useful to provide fallback mechanisms.
629 * Functions that want to verify if there is a decoder can do so with
630 * OSSL_DECODER_CTX_get_decoder()
632 OSSL_DECODER_CTX
*OSSL_DECODER_CTX_new(void)
634 OSSL_DECODER_CTX
*ctx
;
636 ctx
= OPENSSL_zalloc(sizeof(*ctx
));
640 int OSSL_DECODER_CTX_set_params(OSSL_DECODER_CTX
*ctx
,
641 const OSSL_PARAM params
[])
647 if (!ossl_assert(ctx
!= NULL
)) {
648 ERR_raise(ERR_LIB_OSSL_DECODER
, ERR_R_PASSED_NULL_PARAMETER
);
652 if (ctx
->decoder_insts
== NULL
)
655 l
= OSSL_DECODER_CTX_get_num_decoders(ctx
);
656 for (i
= 0; i
< l
; i
++) {
657 OSSL_DECODER_INSTANCE
*decoder_inst
=
658 sk_OSSL_DECODER_INSTANCE_value(ctx
->decoder_insts
, i
);
659 OSSL_DECODER
*decoder
=
660 OSSL_DECODER_INSTANCE_get_decoder(decoder_inst
);
661 OSSL_DECODER
*decoderctx
=
662 OSSL_DECODER_INSTANCE_get_decoder_ctx(decoder_inst
);
664 if (decoderctx
== NULL
|| decoder
->set_ctx_params
== NULL
)
666 if (!decoder
->set_ctx_params(decoderctx
, params
))
672 void OSSL_DECODER_CTX_free(OSSL_DECODER_CTX
*ctx
)
675 if (ctx
->cleanup
!= NULL
)
676 ctx
->cleanup(ctx
->construct_data
);
677 sk_OSSL_DECODER_INSTANCE_pop_free(ctx
->decoder_insts
,
678 ossl_decoder_instance_free
);
679 ossl_pw_clear_passphrase_data(&ctx
->pwdata
);