2 * Copyright 2019-2022 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"
20 #include "crypto/context.h"
23 * Encoder can have multiple names, separated with colons in a name string
25 #define NAME_SEPARATOR ':'
27 /* Simple method structure constructor and destructor */
28 static OSSL_ENCODER
*ossl_encoder_new(void)
30 OSSL_ENCODER
*encoder
= NULL
;
32 if ((encoder
= OPENSSL_zalloc(sizeof(*encoder
))) == NULL
33 || (encoder
->base
.lock
= CRYPTO_THREAD_lock_new()) == NULL
) {
34 OSSL_ENCODER_free(encoder
);
35 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_MALLOC_FAILURE
);
39 encoder
->base
.refcnt
= 1;
44 int OSSL_ENCODER_up_ref(OSSL_ENCODER
*encoder
)
48 CRYPTO_UP_REF(&encoder
->base
.refcnt
, &ref
, encoder
->base
.lock
);
52 void OSSL_ENCODER_free(OSSL_ENCODER
*encoder
)
59 CRYPTO_DOWN_REF(&encoder
->base
.refcnt
, &ref
, encoder
->base
.lock
);
62 OPENSSL_free(encoder
->base
.name
);
63 ossl_property_free(encoder
->base
.parsed_propdef
);
64 ossl_provider_free(encoder
->base
.prov
);
65 CRYPTO_THREAD_lock_free(encoder
->base
.lock
);
66 OPENSSL_free(encoder
);
69 /* Data to be passed through ossl_method_construct() */
70 struct encoder_data_st
{
72 int id
; /* For get_encoder_from_store() */
73 const char *names
; /* For get_encoder_from_store() */
74 const char *propquery
; /* For get_encoder_from_store() */
76 OSSL_METHOD_STORE
*tmp_store
; /* For get_tmp_encoder_store() */
78 unsigned int flag_construct_error_occurred
: 1;
82 * Generic routines to fetch / create ENCODER methods with
83 * ossl_method_construct()
86 /* Temporary encoder method store, constructor and destructor */
87 static void *get_tmp_encoder_store(void *data
)
89 struct encoder_data_st
*methdata
= data
;
91 if (methdata
->tmp_store
== NULL
)
92 methdata
->tmp_store
= ossl_method_store_new(methdata
->libctx
);
93 return methdata
->tmp_store
;
96 static void dealloc_tmp_encoder_store(void *store
)
99 ossl_method_store_free(store
);
102 /* Get the permanent encoder store */
103 static OSSL_METHOD_STORE
*get_encoder_store(OSSL_LIB_CTX
*libctx
)
105 return ossl_lib_ctx_get_data(libctx
, OSSL_LIB_CTX_ENCODER_STORE_INDEX
);
108 /* Get encoder methods from a store, or put one in */
109 static void *get_encoder_from_store(void *store
, const OSSL_PROVIDER
**prov
,
112 struct encoder_data_st
*methdata
= data
;
117 * get_encoder_from_store() is only called to try and get the method
118 * that OSSL_ENCODER_fetch() is asking for, and the name or name id are
119 * passed via methdata.
121 if ((id
= methdata
->id
) == 0 && methdata
->names
!= NULL
) {
122 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(methdata
->libctx
);
123 const char *names
= methdata
->names
;
124 const char *q
= strchr(names
, NAME_SEPARATOR
);
125 size_t l
= (q
== NULL
? strlen(names
) : (size_t)(q
- names
));
129 id
= ossl_namemap_name2num_n(namemap
, methdata
->names
, l
);
136 && (store
= get_encoder_store(methdata
->libctx
)) == NULL
)
139 if (!ossl_method_store_fetch(store
, id
, methdata
->propquery
, prov
, &method
))
144 static int put_encoder_in_store(void *store
, void *method
,
145 const OSSL_PROVIDER
*prov
,
146 const char *names
, const char *propdef
,
149 struct encoder_data_st
*methdata
= data
;
150 OSSL_NAMEMAP
*namemap
;
155 * put_encoder_in_store() is only called with an OSSL_ENCODER method that
156 * was successfully created by construct_encoder() below, which means that
157 * all the names should already be stored in the namemap with the same
158 * numeric identity, so just use the first to get that identity.
161 const char *q
= strchr(names
, NAME_SEPARATOR
);
163 l
= (q
== NULL
? strlen(names
) : (size_t)(q
- names
));
166 if ((namemap
= ossl_namemap_stored(methdata
->libctx
)) == NULL
167 || (id
= ossl_namemap_name2num_n(namemap
, names
, l
)) == 0)
170 if (store
== NULL
&& (store
= get_encoder_store(methdata
->libctx
)) == NULL
)
173 return ossl_method_store_add(store
, prov
, id
, propdef
, method
,
174 (int (*)(void *))OSSL_ENCODER_up_ref
,
175 (void (*)(void *))OSSL_ENCODER_free
);
178 /* Create and populate a encoder method */
179 static void *encoder_from_algorithm(int id
, const OSSL_ALGORITHM
*algodef
,
182 OSSL_ENCODER
*encoder
= NULL
;
183 const OSSL_DISPATCH
*fns
= algodef
->implementation
;
184 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(prov
);
186 if ((encoder
= ossl_encoder_new()) == NULL
)
188 encoder
->base
.id
= id
;
189 if ((encoder
->base
.name
= ossl_algorithm_get1_first_name(algodef
)) == NULL
) {
190 OSSL_ENCODER_free(encoder
);
193 encoder
->base
.algodef
= algodef
;
194 encoder
->base
.parsed_propdef
195 = ossl_parse_property(libctx
, algodef
->property_definition
);
197 for (; fns
->function_id
!= 0; fns
++) {
198 switch (fns
->function_id
) {
199 case OSSL_FUNC_ENCODER_NEWCTX
:
200 if (encoder
->newctx
== NULL
)
202 OSSL_FUNC_encoder_newctx(fns
);
204 case OSSL_FUNC_ENCODER_FREECTX
:
205 if (encoder
->freectx
== NULL
)
207 OSSL_FUNC_encoder_freectx(fns
);
209 case OSSL_FUNC_ENCODER_GET_PARAMS
:
210 if (encoder
->get_params
== NULL
)
211 encoder
->get_params
=
212 OSSL_FUNC_encoder_get_params(fns
);
214 case OSSL_FUNC_ENCODER_GETTABLE_PARAMS
:
215 if (encoder
->gettable_params
== NULL
)
216 encoder
->gettable_params
=
217 OSSL_FUNC_encoder_gettable_params(fns
);
219 case OSSL_FUNC_ENCODER_SET_CTX_PARAMS
:
220 if (encoder
->set_ctx_params
== NULL
)
221 encoder
->set_ctx_params
=
222 OSSL_FUNC_encoder_set_ctx_params(fns
);
224 case OSSL_FUNC_ENCODER_SETTABLE_CTX_PARAMS
:
225 if (encoder
->settable_ctx_params
== NULL
)
226 encoder
->settable_ctx_params
=
227 OSSL_FUNC_encoder_settable_ctx_params(fns
);
229 case OSSL_FUNC_ENCODER_DOES_SELECTION
:
230 if (encoder
->does_selection
== NULL
)
231 encoder
->does_selection
=
232 OSSL_FUNC_encoder_does_selection(fns
);
234 case OSSL_FUNC_ENCODER_ENCODE
:
235 if (encoder
->encode
== NULL
)
236 encoder
->encode
= OSSL_FUNC_encoder_encode(fns
);
238 case OSSL_FUNC_ENCODER_IMPORT_OBJECT
:
239 if (encoder
->import_object
== NULL
)
240 encoder
->import_object
=
241 OSSL_FUNC_encoder_import_object(fns
);
243 case OSSL_FUNC_ENCODER_FREE_OBJECT
:
244 if (encoder
->free_object
== NULL
)
245 encoder
->free_object
=
246 OSSL_FUNC_encoder_free_object(fns
);
251 * Try to check that the method is sensible.
252 * If you have a constructor, you must have a destructor and vice versa.
253 * You must have the encoding driver functions.
255 if (!((encoder
->newctx
== NULL
&& encoder
->freectx
== NULL
)
256 || (encoder
->newctx
!= NULL
&& encoder
->freectx
!= NULL
)
257 || (encoder
->import_object
!= NULL
&& encoder
->free_object
!= NULL
)
258 || (encoder
->import_object
== NULL
&& encoder
->free_object
== NULL
))
259 || encoder
->encode
== NULL
) {
260 OSSL_ENCODER_free(encoder
);
261 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_INVALID_PROVIDER_FUNCTIONS
);
265 if (prov
!= NULL
&& !ossl_provider_up_ref(prov
)) {
266 OSSL_ENCODER_free(encoder
);
270 encoder
->base
.prov
= prov
;
276 * The core fetching functionality passes the names of the implementation.
277 * This function is responsible to getting an identity number for them,
278 * then call encoder_from_algorithm() with that identity number.
280 static void *construct_encoder(const OSSL_ALGORITHM
*algodef
,
281 OSSL_PROVIDER
*prov
, void *data
)
284 * This function is only called if get_encoder_from_store() returned
285 * NULL, so it's safe to say that of all the spots to create a new
286 * namemap entry, this is it. Should the name already exist there, we
287 * know that ossl_namemap_add() will return its corresponding number.
289 struct encoder_data_st
*methdata
= data
;
290 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(prov
);
291 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
292 const char *names
= algodef
->algorithm_names
;
293 int id
= ossl_namemap_add_names(namemap
, 0, names
, NAME_SEPARATOR
);
297 method
= encoder_from_algorithm(id
, algodef
, prov
);
300 * Flag to indicate that there was actual construction errors. This
301 * helps inner_evp_generic_fetch() determine what error it should
302 * record on inaccessible algorithms.
305 methdata
->flag_construct_error_occurred
= 1;
310 /* Intermediary function to avoid ugly casts, used below */
311 static void destruct_encoder(void *method
, void *data
)
313 OSSL_ENCODER_free(method
);
316 static int up_ref_encoder(void *method
)
318 return OSSL_ENCODER_up_ref(method
);
321 static void free_encoder(void *method
)
323 OSSL_ENCODER_free(method
);
326 /* Fetching support. Can fetch by numeric identity or by name */
327 static OSSL_ENCODER
*
328 inner_ossl_encoder_fetch(struct encoder_data_st
*methdata
, int id
,
329 const char *name
, const char *properties
)
331 OSSL_METHOD_STORE
*store
= get_encoder_store(methdata
->libctx
);
332 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(methdata
->libctx
);
333 const char *const propq
= properties
!= NULL
? properties
: "";
337 if (store
== NULL
|| namemap
== NULL
) {
338 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_PASSED_INVALID_ARGUMENT
);
343 * If we have been passed both an id and a name, we have an
344 * internal programming error.
346 if (!ossl_assert(id
== 0 || name
== NULL
)) {
347 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_INTERNAL_ERROR
);
352 id
= ossl_namemap_name2num(namemap
, name
);
355 * If we haven't found the name yet, chances are that the algorithm to
356 * be fetched is unsupported.
362 || !ossl_method_store_cache_get(store
, NULL
, id
, propq
, &method
)) {
363 OSSL_METHOD_CONSTRUCT_METHOD mcm
= {
364 get_tmp_encoder_store
,
365 get_encoder_from_store
,
366 put_encoder_in_store
,
370 OSSL_PROVIDER
*prov
= NULL
;
373 methdata
->names
= name
;
374 methdata
->propquery
= propq
;
375 methdata
->flag_construct_error_occurred
= 0;
376 if ((method
= ossl_method_construct(methdata
->libctx
, OSSL_OP_ENCODER
,
377 &prov
, 0 /* !force_cache */,
378 &mcm
, methdata
)) != NULL
) {
380 * If construction did create a method for us, we know that
381 * there is a correct name_id and meth_id, since those have
382 * already been calculated in get_encoder_from_store() and
383 * put_encoder_in_store() above.
386 id
= ossl_namemap_name2num(namemap
, name
);
387 ossl_method_store_cache_set(store
, prov
, id
, propq
, method
,
388 up_ref_encoder
, free_encoder
);
392 * If we never were in the constructor, the algorithm to be fetched
395 unsupported
= !methdata
->flag_construct_error_occurred
;
398 if ((id
!= 0 || name
!= NULL
) && method
== NULL
) {
399 int code
= unsupported
? ERR_R_UNSUPPORTED
: ERR_R_FETCH_FAILED
;
402 name
= ossl_namemap_num2name(namemap
, id
, 0);
403 ERR_raise_data(ERR_LIB_OSSL_ENCODER
, code
,
404 "%s, Name (%s : %d), Properties (%s)",
405 ossl_lib_ctx_get_descriptor(methdata
->libctx
),
406 name
= NULL
? "<null>" : name
, id
,
407 properties
== NULL
? "<null>" : properties
);
413 OSSL_ENCODER
*OSSL_ENCODER_fetch(OSSL_LIB_CTX
*libctx
, const char *name
,
414 const char *properties
)
416 struct encoder_data_st methdata
;
419 methdata
.libctx
= libctx
;
420 methdata
.tmp_store
= NULL
;
421 method
= inner_ossl_encoder_fetch(&methdata
, 0, name
, properties
);
422 dealloc_tmp_encoder_store(methdata
.tmp_store
);
426 OSSL_ENCODER
*ossl_encoder_fetch_by_number(OSSL_LIB_CTX
*libctx
, int id
,
427 const char *properties
)
429 struct encoder_data_st methdata
;
432 methdata
.libctx
= libctx
;
433 methdata
.tmp_store
= NULL
;
434 method
= inner_ossl_encoder_fetch(&methdata
, id
, NULL
, properties
);
435 dealloc_tmp_encoder_store(methdata
.tmp_store
);
439 int ossl_encoder_store_cache_flush(OSSL_LIB_CTX
*libctx
)
441 OSSL_METHOD_STORE
*store
= get_encoder_store(libctx
);
444 return ossl_method_store_cache_flush_all(store
);
448 int ossl_encoder_store_remove_all_provided(const OSSL_PROVIDER
*prov
)
450 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(prov
);
451 OSSL_METHOD_STORE
*store
= get_encoder_store(libctx
);
454 return ossl_method_store_remove_all_provided(store
, prov
);
459 * Library of basic method functions
462 const OSSL_PROVIDER
*OSSL_ENCODER_get0_provider(const OSSL_ENCODER
*encoder
)
464 if (!ossl_assert(encoder
!= NULL
)) {
465 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_PASSED_NULL_PARAMETER
);
469 return encoder
->base
.prov
;
472 const char *OSSL_ENCODER_get0_properties(const OSSL_ENCODER
*encoder
)
474 if (!ossl_assert(encoder
!= NULL
)) {
475 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_PASSED_NULL_PARAMETER
);
479 return encoder
->base
.algodef
->property_definition
;
482 const OSSL_PROPERTY_LIST
*
483 ossl_encoder_parsed_properties(const OSSL_ENCODER
*encoder
)
485 if (!ossl_assert(encoder
!= NULL
)) {
486 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_PASSED_NULL_PARAMETER
);
490 return encoder
->base
.parsed_propdef
;
493 int ossl_encoder_get_number(const OSSL_ENCODER
*encoder
)
495 if (!ossl_assert(encoder
!= NULL
)) {
496 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_PASSED_NULL_PARAMETER
);
500 return encoder
->base
.id
;
503 const char *OSSL_ENCODER_get0_name(const OSSL_ENCODER
*encoder
)
505 return encoder
->base
.name
;
508 const char *OSSL_ENCODER_get0_description(const OSSL_ENCODER
*encoder
)
510 return encoder
->base
.algodef
->algorithm_description
;
513 int OSSL_ENCODER_is_a(const OSSL_ENCODER
*encoder
, const char *name
)
515 if (encoder
->base
.prov
!= NULL
) {
516 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(encoder
->base
.prov
);
517 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
519 return ossl_namemap_name2num(namemap
, name
) == encoder
->base
.id
;
524 struct do_one_data_st
{
525 void (*user_fn
)(OSSL_ENCODER
*encoder
, void *arg
);
529 static void do_one(ossl_unused
int id
, void *method
, void *arg
)
531 struct do_one_data_st
*data
= arg
;
533 data
->user_fn(method
, data
->user_arg
);
536 void OSSL_ENCODER_do_all_provided(OSSL_LIB_CTX
*libctx
,
537 void (*user_fn
)(OSSL_ENCODER
*encoder
,
541 struct encoder_data_st methdata
;
542 struct do_one_data_st data
;
544 methdata
.libctx
= libctx
;
545 methdata
.tmp_store
= NULL
;
546 (void)inner_ossl_encoder_fetch(&methdata
, 0, NULL
, NULL
/* properties */);
548 data
.user_fn
= user_fn
;
549 data
.user_arg
= user_arg
;
550 if (methdata
.tmp_store
!= NULL
)
551 ossl_method_store_do_all(methdata
.tmp_store
, &do_one
, &data
);
552 ossl_method_store_do_all(get_encoder_store(libctx
), &do_one
, &data
);
553 dealloc_tmp_encoder_store(methdata
.tmp_store
);
556 int OSSL_ENCODER_names_do_all(const OSSL_ENCODER
*encoder
,
557 void (*fn
)(const char *name
, void *data
),
563 if (encoder
->base
.prov
!= NULL
) {
564 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(encoder
->base
.prov
);
565 OSSL_NAMEMAP
*namemap
= ossl_namemap_stored(libctx
);
567 return ossl_namemap_doall_names(namemap
, encoder
->base
.id
, fn
, data
);
574 OSSL_ENCODER_gettable_params(OSSL_ENCODER
*encoder
)
576 if (encoder
!= NULL
&& encoder
->gettable_params
!= NULL
) {
577 void *provctx
= ossl_provider_ctx(OSSL_ENCODER_get0_provider(encoder
));
579 return encoder
->gettable_params(provctx
);
584 int OSSL_ENCODER_get_params(OSSL_ENCODER
*encoder
, OSSL_PARAM params
[])
586 if (encoder
!= NULL
&& encoder
->get_params
!= NULL
)
587 return encoder
->get_params(params
);
591 const OSSL_PARAM
*OSSL_ENCODER_settable_ctx_params(OSSL_ENCODER
*encoder
)
593 if (encoder
!= NULL
&& encoder
->settable_ctx_params
!= NULL
) {
594 void *provctx
= ossl_provider_ctx(OSSL_ENCODER_get0_provider(encoder
));
596 return encoder
->settable_ctx_params(provctx
);
602 * Encoder context support
605 OSSL_ENCODER_CTX
*OSSL_ENCODER_CTX_new(void)
607 OSSL_ENCODER_CTX
*ctx
;
609 if ((ctx
= OPENSSL_zalloc(sizeof(*ctx
))) == NULL
)
610 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_MALLOC_FAILURE
);
615 int OSSL_ENCODER_CTX_set_params(OSSL_ENCODER_CTX
*ctx
,
616 const OSSL_PARAM params
[])
622 if (!ossl_assert(ctx
!= NULL
)) {
623 ERR_raise(ERR_LIB_OSSL_ENCODER
, ERR_R_PASSED_NULL_PARAMETER
);
627 if (ctx
->encoder_insts
== NULL
)
630 l
= OSSL_ENCODER_CTX_get_num_encoders(ctx
);
631 for (i
= 0; i
< l
; i
++) {
632 OSSL_ENCODER_INSTANCE
*encoder_inst
=
633 sk_OSSL_ENCODER_INSTANCE_value(ctx
->encoder_insts
, i
);
634 OSSL_ENCODER
*encoder
= OSSL_ENCODER_INSTANCE_get_encoder(encoder_inst
);
635 void *encoderctx
= OSSL_ENCODER_INSTANCE_get_encoder_ctx(encoder_inst
);
637 if (encoderctx
== NULL
|| encoder
->set_ctx_params
== NULL
)
639 if (!encoder
->set_ctx_params(encoderctx
, params
))
645 void OSSL_ENCODER_CTX_free(OSSL_ENCODER_CTX
*ctx
)
648 sk_OSSL_ENCODER_INSTANCE_pop_free(ctx
->encoder_insts
,
649 ossl_encoder_instance_free
);
650 OPENSSL_free(ctx
->construct_data
);
651 ossl_pw_clear_passphrase_data(&ctx
->pwdata
);