xref: /freebsd-src/crypto/openssl/crypto/encode_decode/decoder_meth.c (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery /*
2*b077aed3SPierre Pronchery  * Copyright 2020-2022 The OpenSSL Project Authors. All Rights Reserved.
3*b077aed3SPierre Pronchery  *
4*b077aed3SPierre Pronchery  * Licensed under the Apache License 2.0 (the "License").  You may not use
5*b077aed3SPierre Pronchery  * this file except in compliance with the License.  You can obtain a copy
6*b077aed3SPierre Pronchery  * in the file LICENSE in the source distribution or at
7*b077aed3SPierre Pronchery  * https://www.openssl.org/source/license.html
8*b077aed3SPierre Pronchery  */
9*b077aed3SPierre Pronchery 
10*b077aed3SPierre Pronchery #include <openssl/core.h>
11*b077aed3SPierre Pronchery #include <openssl/core_dispatch.h>
12*b077aed3SPierre Pronchery #include <openssl/decoder.h>
13*b077aed3SPierre Pronchery #include <openssl/ui.h>
14*b077aed3SPierre Pronchery #include "internal/core.h"
15*b077aed3SPierre Pronchery #include "internal/namemap.h"
16*b077aed3SPierre Pronchery #include "internal/property.h"
17*b077aed3SPierre Pronchery #include "internal/provider.h"
18*b077aed3SPierre Pronchery #include "crypto/decoder.h"
19*b077aed3SPierre Pronchery #include "encoder_local.h"
20*b077aed3SPierre Pronchery 
21*b077aed3SPierre Pronchery /*
22*b077aed3SPierre Pronchery  * Decoder can have multiple names, separated with colons in a name string
23*b077aed3SPierre Pronchery  */
24*b077aed3SPierre Pronchery #define NAME_SEPARATOR ':'
25*b077aed3SPierre Pronchery 
26*b077aed3SPierre Pronchery /* Simple method structure constructor and destructor */
ossl_decoder_new(void)27*b077aed3SPierre Pronchery static OSSL_DECODER *ossl_decoder_new(void)
28*b077aed3SPierre Pronchery {
29*b077aed3SPierre Pronchery     OSSL_DECODER *decoder = NULL;
30*b077aed3SPierre Pronchery 
31*b077aed3SPierre Pronchery     if ((decoder = OPENSSL_zalloc(sizeof(*decoder))) == NULL
32*b077aed3SPierre Pronchery         || (decoder->base.lock = CRYPTO_THREAD_lock_new()) == NULL) {
33*b077aed3SPierre Pronchery         OSSL_DECODER_free(decoder);
34*b077aed3SPierre Pronchery         ERR_raise(ERR_LIB_OSSL_DECODER, ERR_R_MALLOC_FAILURE);
35*b077aed3SPierre Pronchery         return NULL;
36*b077aed3SPierre Pronchery     }
37*b077aed3SPierre Pronchery 
38*b077aed3SPierre Pronchery     decoder->base.refcnt = 1;
39*b077aed3SPierre Pronchery 
40*b077aed3SPierre Pronchery     return decoder;
41*b077aed3SPierre Pronchery }
42*b077aed3SPierre Pronchery 
OSSL_DECODER_up_ref(OSSL_DECODER * decoder)43*b077aed3SPierre Pronchery int OSSL_DECODER_up_ref(OSSL_DECODER *decoder)
44*b077aed3SPierre Pronchery {
45*b077aed3SPierre Pronchery     int ref = 0;
46*b077aed3SPierre Pronchery 
47*b077aed3SPierre Pronchery     CRYPTO_UP_REF(&decoder->base.refcnt, &ref, decoder->base.lock);
48*b077aed3SPierre Pronchery     return 1;
49*b077aed3SPierre Pronchery }
50*b077aed3SPierre Pronchery 
OSSL_DECODER_free(OSSL_DECODER * decoder)51*b077aed3SPierre Pronchery void OSSL_DECODER_free(OSSL_DECODER *decoder)
52*b077aed3SPierre Pronchery {
53*b077aed3SPierre Pronchery     int ref = 0;
54*b077aed3SPierre Pronchery 
55*b077aed3SPierre Pronchery     if (decoder == NULL)
56*b077aed3SPierre Pronchery         return;
57*b077aed3SPierre Pronchery 
58*b077aed3SPierre Pronchery     CRYPTO_DOWN_REF(&decoder->base.refcnt, &ref, decoder->base.lock);
59*b077aed3SPierre Pronchery     if (ref > 0)
60*b077aed3SPierre Pronchery         return;
61*b077aed3SPierre Pronchery     OPENSSL_free(decoder->base.name);
62*b077aed3SPierre Pronchery     ossl_property_free(decoder->base.parsed_propdef);
63*b077aed3SPierre Pronchery     ossl_provider_free(decoder->base.prov);
64*b077aed3SPierre Pronchery     CRYPTO_THREAD_lock_free(decoder->base.lock);
65*b077aed3SPierre Pronchery     OPENSSL_free(decoder);
66*b077aed3SPierre Pronchery }
67*b077aed3SPierre Pronchery 
68*b077aed3SPierre Pronchery /* Permanent decoder method store, constructor and destructor */
decoder_store_free(void * vstore)69*b077aed3SPierre Pronchery static void decoder_store_free(void *vstore)
70*b077aed3SPierre Pronchery {
71*b077aed3SPierre Pronchery     ossl_method_store_free(vstore);
72*b077aed3SPierre Pronchery }
73*b077aed3SPierre Pronchery 
decoder_store_new(OSSL_LIB_CTX * ctx)74*b077aed3SPierre Pronchery static void *decoder_store_new(OSSL_LIB_CTX *ctx)
75*b077aed3SPierre Pronchery {
76*b077aed3SPierre Pronchery     return ossl_method_store_new(ctx);
77*b077aed3SPierre Pronchery }
78*b077aed3SPierre Pronchery 
79*b077aed3SPierre Pronchery 
80*b077aed3SPierre Pronchery static const OSSL_LIB_CTX_METHOD decoder_store_method = {
81*b077aed3SPierre Pronchery     /* We want decoder_store to be cleaned up before the provider store */
82*b077aed3SPierre Pronchery     OSSL_LIB_CTX_METHOD_PRIORITY_2,
83*b077aed3SPierre Pronchery     decoder_store_new,
84*b077aed3SPierre Pronchery     decoder_store_free,
85*b077aed3SPierre Pronchery };
86*b077aed3SPierre Pronchery 
87*b077aed3SPierre Pronchery /* Data to be passed through ossl_method_construct() */
88*b077aed3SPierre Pronchery struct decoder_data_st {
89*b077aed3SPierre Pronchery     OSSL_LIB_CTX *libctx;
90*b077aed3SPierre Pronchery     int id;                      /* For get_decoder_from_store() */
91*b077aed3SPierre Pronchery     const char *names;           /* For get_decoder_from_store() */
92*b077aed3SPierre Pronchery     const char *propquery;       /* For get_decoder_from_store() */
93*b077aed3SPierre Pronchery 
94*b077aed3SPierre Pronchery     OSSL_METHOD_STORE *tmp_store; /* For get_tmp_decoder_store() */
95*b077aed3SPierre Pronchery 
96*b077aed3SPierre Pronchery     unsigned int flag_construct_error_occurred : 1;
97*b077aed3SPierre Pronchery };
98*b077aed3SPierre Pronchery 
99*b077aed3SPierre Pronchery /*
100*b077aed3SPierre Pronchery  * Generic routines to fetch / create DECODER methods with
101*b077aed3SPierre Pronchery  * ossl_method_construct()
102*b077aed3SPierre Pronchery  */
103*b077aed3SPierre Pronchery 
104*b077aed3SPierre Pronchery /* Temporary decoder method store, constructor and destructor */
get_tmp_decoder_store(void * data)105*b077aed3SPierre Pronchery static void *get_tmp_decoder_store(void *data)
106*b077aed3SPierre Pronchery {
107*b077aed3SPierre Pronchery     struct decoder_data_st *methdata = data;
108*b077aed3SPierre Pronchery 
109*b077aed3SPierre Pronchery     if (methdata->tmp_store == NULL)
110*b077aed3SPierre Pronchery         methdata->tmp_store = ossl_method_store_new(methdata->libctx);
111*b077aed3SPierre Pronchery     return methdata->tmp_store;
112*b077aed3SPierre Pronchery }
113*b077aed3SPierre Pronchery 
dealloc_tmp_decoder_store(void * store)114*b077aed3SPierre Pronchery static void dealloc_tmp_decoder_store(void *store)
115*b077aed3SPierre Pronchery {
116*b077aed3SPierre Pronchery     if (store != NULL)
117*b077aed3SPierre Pronchery         ossl_method_store_free(store);
118*b077aed3SPierre Pronchery }
119*b077aed3SPierre Pronchery 
120*b077aed3SPierre Pronchery /* Get the permanent decoder store */
get_decoder_store(OSSL_LIB_CTX * libctx)121*b077aed3SPierre Pronchery static OSSL_METHOD_STORE *get_decoder_store(OSSL_LIB_CTX *libctx)
122*b077aed3SPierre Pronchery {
123*b077aed3SPierre Pronchery     return ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_DECODER_STORE_INDEX,
124*b077aed3SPierre Pronchery                                  &decoder_store_method);
125*b077aed3SPierre Pronchery }
126*b077aed3SPierre Pronchery 
reserve_decoder_store(void * store,void * data)127*b077aed3SPierre Pronchery static int reserve_decoder_store(void *store, void *data)
128*b077aed3SPierre Pronchery {
129*b077aed3SPierre Pronchery     struct decoder_data_st *methdata = data;
130*b077aed3SPierre Pronchery 
131*b077aed3SPierre Pronchery     if (store == NULL
132*b077aed3SPierre Pronchery         && (store = get_decoder_store(methdata->libctx)) == NULL)
133*b077aed3SPierre Pronchery         return 0;
134*b077aed3SPierre Pronchery 
135*b077aed3SPierre Pronchery     return ossl_method_lock_store(store);
136*b077aed3SPierre Pronchery }
137*b077aed3SPierre Pronchery 
unreserve_decoder_store(void * store,void * data)138*b077aed3SPierre Pronchery static int unreserve_decoder_store(void *store, void *data)
139*b077aed3SPierre Pronchery {
140*b077aed3SPierre Pronchery     struct decoder_data_st *methdata = data;
141*b077aed3SPierre Pronchery 
142*b077aed3SPierre Pronchery     if (store == NULL
143*b077aed3SPierre Pronchery         && (store = get_decoder_store(methdata->libctx)) == NULL)
144*b077aed3SPierre Pronchery         return 0;
145*b077aed3SPierre Pronchery 
146*b077aed3SPierre Pronchery     return ossl_method_unlock_store(store);
147*b077aed3SPierre Pronchery }
148*b077aed3SPierre Pronchery 
149*b077aed3SPierre Pronchery /* Get decoder methods from a store, or put one in */
get_decoder_from_store(void * store,const OSSL_PROVIDER ** prov,void * data)150*b077aed3SPierre Pronchery static void *get_decoder_from_store(void *store, const OSSL_PROVIDER **prov,
151*b077aed3SPierre Pronchery                                     void *data)
152*b077aed3SPierre Pronchery {
153*b077aed3SPierre Pronchery     struct decoder_data_st *methdata = data;
154*b077aed3SPierre Pronchery     void *method = NULL;
155*b077aed3SPierre Pronchery     int id;
156*b077aed3SPierre Pronchery 
157*b077aed3SPierre Pronchery     /*
158*b077aed3SPierre Pronchery      * get_decoder_from_store() is only called to try and get the method
159*b077aed3SPierre Pronchery      * that OSSL_DECODER_fetch() is asking for, and the name or name id are
160*b077aed3SPierre Pronchery      * passed via methdata.
161*b077aed3SPierre Pronchery      */
162*b077aed3SPierre Pronchery     if ((id = methdata->id) == 0 && methdata->names != NULL) {
163*b077aed3SPierre Pronchery         OSSL_NAMEMAP *namemap = ossl_namemap_stored(methdata->libctx);
164*b077aed3SPierre Pronchery         const char *names = methdata->names;
165*b077aed3SPierre Pronchery         const char *q = strchr(names, NAME_SEPARATOR);
166*b077aed3SPierre Pronchery         size_t l = (q == NULL ? strlen(names) : (size_t)(q - names));
167*b077aed3SPierre Pronchery 
168*b077aed3SPierre Pronchery         if (namemap == 0)
169*b077aed3SPierre Pronchery             return NULL;
170*b077aed3SPierre Pronchery         id = ossl_namemap_name2num_n(namemap, names, l);
171*b077aed3SPierre Pronchery     }
172*b077aed3SPierre Pronchery 
173*b077aed3SPierre Pronchery     if (id == 0)
174*b077aed3SPierre Pronchery         return NULL;
175*b077aed3SPierre Pronchery 
176*b077aed3SPierre Pronchery     if (store == NULL
177*b077aed3SPierre Pronchery         && (store = get_decoder_store(methdata->libctx)) == NULL)
178*b077aed3SPierre Pronchery         return NULL;
179*b077aed3SPierre Pronchery 
180*b077aed3SPierre Pronchery     if (!ossl_method_store_fetch(store, id, methdata->propquery, prov, &method))
181*b077aed3SPierre Pronchery         return NULL;
182*b077aed3SPierre Pronchery     return method;
183*b077aed3SPierre Pronchery }
184*b077aed3SPierre Pronchery 
put_decoder_in_store(void * store,void * method,const OSSL_PROVIDER * prov,const char * names,const char * propdef,void * data)185*b077aed3SPierre Pronchery static int put_decoder_in_store(void *store, void *method,
186*b077aed3SPierre Pronchery                                 const OSSL_PROVIDER *prov,
187*b077aed3SPierre Pronchery                                 const char *names, const char *propdef,
188*b077aed3SPierre Pronchery                                 void *data)
189*b077aed3SPierre Pronchery {
190*b077aed3SPierre Pronchery     struct decoder_data_st *methdata = data;
191*b077aed3SPierre Pronchery     OSSL_NAMEMAP *namemap;
192*b077aed3SPierre Pronchery     int id;
193*b077aed3SPierre Pronchery     size_t l = 0;
194*b077aed3SPierre Pronchery 
195*b077aed3SPierre Pronchery     /*
196*b077aed3SPierre Pronchery      * put_decoder_in_store() is only called with an OSSL_DECODER method that
197*b077aed3SPierre Pronchery      * was successfully created by construct_decoder() below, which means that
198*b077aed3SPierre Pronchery      * all the names should already be stored in the namemap with the same
199*b077aed3SPierre Pronchery      * numeric identity, so just use the first to get that identity.
200*b077aed3SPierre Pronchery      */
201*b077aed3SPierre Pronchery     if (names != NULL) {
202*b077aed3SPierre Pronchery         const char *q = strchr(names, NAME_SEPARATOR);
203*b077aed3SPierre Pronchery 
204*b077aed3SPierre Pronchery         l = (q == NULL ? strlen(names) : (size_t)(q - names));
205*b077aed3SPierre Pronchery     }
206*b077aed3SPierre Pronchery 
207*b077aed3SPierre Pronchery     if ((namemap = ossl_namemap_stored(methdata->libctx)) == NULL
208*b077aed3SPierre Pronchery         || (id = ossl_namemap_name2num_n(namemap, names, l)) == 0)
209*b077aed3SPierre Pronchery         return 0;
210*b077aed3SPierre Pronchery 
211*b077aed3SPierre Pronchery     if (store == NULL && (store = get_decoder_store(methdata->libctx)) == NULL)
212*b077aed3SPierre Pronchery         return 0;
213*b077aed3SPierre Pronchery 
214*b077aed3SPierre Pronchery     return ossl_method_store_add(store, prov, id, propdef, method,
215*b077aed3SPierre Pronchery                                  (int (*)(void *))OSSL_DECODER_up_ref,
216*b077aed3SPierre Pronchery                                  (void (*)(void *))OSSL_DECODER_free);
217*b077aed3SPierre Pronchery }
218*b077aed3SPierre Pronchery 
219*b077aed3SPierre Pronchery /* Create and populate a decoder method */
ossl_decoder_from_algorithm(int id,const OSSL_ALGORITHM * algodef,OSSL_PROVIDER * prov)220*b077aed3SPierre Pronchery void *ossl_decoder_from_algorithm(int id, const OSSL_ALGORITHM *algodef,
221*b077aed3SPierre Pronchery                                   OSSL_PROVIDER *prov)
222*b077aed3SPierre Pronchery {
223*b077aed3SPierre Pronchery     OSSL_DECODER *decoder = NULL;
224*b077aed3SPierre Pronchery     const OSSL_DISPATCH *fns = algodef->implementation;
225*b077aed3SPierre Pronchery     OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
226*b077aed3SPierre Pronchery 
227*b077aed3SPierre Pronchery     if ((decoder = ossl_decoder_new()) == NULL)
228*b077aed3SPierre Pronchery         return NULL;
229*b077aed3SPierre Pronchery     decoder->base.id = id;
230*b077aed3SPierre Pronchery     if ((decoder->base.name = ossl_algorithm_get1_first_name(algodef)) == NULL) {
231*b077aed3SPierre Pronchery         OSSL_DECODER_free(decoder);
232*b077aed3SPierre Pronchery         return NULL;
233*b077aed3SPierre Pronchery     }
234*b077aed3SPierre Pronchery     decoder->base.algodef = algodef;
235*b077aed3SPierre Pronchery     if ((decoder->base.parsed_propdef
236*b077aed3SPierre Pronchery          = ossl_parse_property(libctx, algodef->property_definition)) == NULL) {
237*b077aed3SPierre Pronchery         OSSL_DECODER_free(decoder);
238*b077aed3SPierre Pronchery         return NULL;
239*b077aed3SPierre Pronchery     }
240*b077aed3SPierre Pronchery 
241*b077aed3SPierre Pronchery     for (; fns->function_id != 0; fns++) {
242*b077aed3SPierre Pronchery         switch (fns->function_id) {
243*b077aed3SPierre Pronchery         case OSSL_FUNC_DECODER_NEWCTX:
244*b077aed3SPierre Pronchery             if (decoder->newctx == NULL)
245*b077aed3SPierre Pronchery                 decoder->newctx = OSSL_FUNC_decoder_newctx(fns);
246*b077aed3SPierre Pronchery             break;
247*b077aed3SPierre Pronchery         case OSSL_FUNC_DECODER_FREECTX:
248*b077aed3SPierre Pronchery             if (decoder->freectx == NULL)
249*b077aed3SPierre Pronchery                 decoder->freectx = OSSL_FUNC_decoder_freectx(fns);
250*b077aed3SPierre Pronchery             break;
251*b077aed3SPierre Pronchery         case OSSL_FUNC_DECODER_GET_PARAMS:
252*b077aed3SPierre Pronchery             if (decoder->get_params == NULL)
253*b077aed3SPierre Pronchery                 decoder->get_params =
254*b077aed3SPierre Pronchery                     OSSL_FUNC_decoder_get_params(fns);
255*b077aed3SPierre Pronchery             break;
256*b077aed3SPierre Pronchery         case OSSL_FUNC_DECODER_GETTABLE_PARAMS:
257*b077aed3SPierre Pronchery             if (decoder->gettable_params == NULL)
258*b077aed3SPierre Pronchery                 decoder->gettable_params =
259*b077aed3SPierre Pronchery                     OSSL_FUNC_decoder_gettable_params(fns);
260*b077aed3SPierre Pronchery             break;
261*b077aed3SPierre Pronchery         case OSSL_FUNC_DECODER_SET_CTX_PARAMS:
262*b077aed3SPierre Pronchery             if (decoder->set_ctx_params == NULL)
263*b077aed3SPierre Pronchery                 decoder->set_ctx_params =
264*b077aed3SPierre Pronchery                     OSSL_FUNC_decoder_set_ctx_params(fns);
265*b077aed3SPierre Pronchery             break;
266*b077aed3SPierre Pronchery         case OSSL_FUNC_DECODER_SETTABLE_CTX_PARAMS:
267*b077aed3SPierre Pronchery             if (decoder->settable_ctx_params == NULL)
268*b077aed3SPierre Pronchery                 decoder->settable_ctx_params =
269*b077aed3SPierre Pronchery                     OSSL_FUNC_decoder_settable_ctx_params(fns);
270*b077aed3SPierre Pronchery             break;
271*b077aed3SPierre Pronchery         case OSSL_FUNC_DECODER_DOES_SELECTION:
272*b077aed3SPierre Pronchery             if (decoder->does_selection == NULL)
273*b077aed3SPierre Pronchery                 decoder->does_selection =
274*b077aed3SPierre Pronchery                     OSSL_FUNC_decoder_does_selection(fns);
275*b077aed3SPierre Pronchery             break;
276*b077aed3SPierre Pronchery         case OSSL_FUNC_DECODER_DECODE:
277*b077aed3SPierre Pronchery             if (decoder->decode == NULL)
278*b077aed3SPierre Pronchery                 decoder->decode = OSSL_FUNC_decoder_decode(fns);
279*b077aed3SPierre Pronchery             break;
280*b077aed3SPierre Pronchery         case OSSL_FUNC_DECODER_EXPORT_OBJECT:
281*b077aed3SPierre Pronchery             if (decoder->export_object == NULL)
282*b077aed3SPierre Pronchery                 decoder->export_object = OSSL_FUNC_decoder_export_object(fns);
283*b077aed3SPierre Pronchery             break;
284*b077aed3SPierre Pronchery         }
285*b077aed3SPierre Pronchery     }
286*b077aed3SPierre Pronchery     /*
287*b077aed3SPierre Pronchery      * Try to check that the method is sensible.
288*b077aed3SPierre Pronchery      * If you have a constructor, you must have a destructor and vice versa.
289*b077aed3SPierre Pronchery      * You must have at least one of the encoding driver functions.
290*b077aed3SPierre Pronchery      */
291*b077aed3SPierre Pronchery     if (!((decoder->newctx == NULL && decoder->freectx == NULL)
292*b077aed3SPierre Pronchery           || (decoder->newctx != NULL && decoder->freectx != NULL))
293*b077aed3SPierre Pronchery         || decoder->decode == NULL) {
294*b077aed3SPierre Pronchery         OSSL_DECODER_free(decoder);
295*b077aed3SPierre Pronchery         ERR_raise(ERR_LIB_OSSL_DECODER, ERR_R_INVALID_PROVIDER_FUNCTIONS);
296*b077aed3SPierre Pronchery         return NULL;
297*b077aed3SPierre Pronchery     }
298*b077aed3SPierre Pronchery 
299*b077aed3SPierre Pronchery     if (prov != NULL && !ossl_provider_up_ref(prov)) {
300*b077aed3SPierre Pronchery         OSSL_DECODER_free(decoder);
301*b077aed3SPierre Pronchery         return NULL;
302*b077aed3SPierre Pronchery     }
303*b077aed3SPierre Pronchery 
304*b077aed3SPierre Pronchery     decoder->base.prov = prov;
305*b077aed3SPierre Pronchery     return decoder;
306*b077aed3SPierre Pronchery }
307*b077aed3SPierre Pronchery 
308*b077aed3SPierre Pronchery 
309*b077aed3SPierre Pronchery /*
310*b077aed3SPierre Pronchery  * The core fetching functionality passes the names of the implementation.
311*b077aed3SPierre Pronchery  * This function is responsible to getting an identity number for them,
312*b077aed3SPierre Pronchery  * then call ossl_decoder_from_algorithm() with that identity number.
313*b077aed3SPierre Pronchery  */
construct_decoder(const OSSL_ALGORITHM * algodef,OSSL_PROVIDER * prov,void * data)314*b077aed3SPierre Pronchery static void *construct_decoder(const OSSL_ALGORITHM *algodef,
315*b077aed3SPierre Pronchery                                OSSL_PROVIDER *prov, void *data)
316*b077aed3SPierre Pronchery {
317*b077aed3SPierre Pronchery     /*
318*b077aed3SPierre Pronchery      * This function is only called if get_decoder_from_store() returned
319*b077aed3SPierre Pronchery      * NULL, so it's safe to say that of all the spots to create a new
320*b077aed3SPierre Pronchery      * namemap entry, this is it.  Should the name already exist there, we
321*b077aed3SPierre Pronchery      * know that ossl_namemap_add() will return its corresponding number.
322*b077aed3SPierre Pronchery      */
323*b077aed3SPierre Pronchery     struct decoder_data_st *methdata = data;
324*b077aed3SPierre Pronchery     OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
325*b077aed3SPierre Pronchery     OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
326*b077aed3SPierre Pronchery     const char *names = algodef->algorithm_names;
327*b077aed3SPierre Pronchery     int id = ossl_namemap_add_names(namemap, 0, names, NAME_SEPARATOR);
328*b077aed3SPierre Pronchery     void *method = NULL;
329*b077aed3SPierre Pronchery 
330*b077aed3SPierre Pronchery     if (id != 0)
331*b077aed3SPierre Pronchery         method = ossl_decoder_from_algorithm(id, algodef, prov);
332*b077aed3SPierre Pronchery 
333*b077aed3SPierre Pronchery     /*
334*b077aed3SPierre Pronchery      * Flag to indicate that there was actual construction errors.  This
335*b077aed3SPierre Pronchery      * helps inner_evp_generic_fetch() determine what error it should
336*b077aed3SPierre Pronchery      * record on inaccessible algorithms.
337*b077aed3SPierre Pronchery      */
338*b077aed3SPierre Pronchery     if (method == NULL)
339*b077aed3SPierre Pronchery         methdata->flag_construct_error_occurred = 1;
340*b077aed3SPierre Pronchery 
341*b077aed3SPierre Pronchery     return method;
342*b077aed3SPierre Pronchery }
343*b077aed3SPierre Pronchery 
344*b077aed3SPierre Pronchery /* Intermediary function to avoid ugly casts, used below */
destruct_decoder(void * method,void * data)345*b077aed3SPierre Pronchery static void destruct_decoder(void *method, void *data)
346*b077aed3SPierre Pronchery {
347*b077aed3SPierre Pronchery     OSSL_DECODER_free(method);
348*b077aed3SPierre Pronchery }
349*b077aed3SPierre Pronchery 
up_ref_decoder(void * method)350*b077aed3SPierre Pronchery static int up_ref_decoder(void *method)
351*b077aed3SPierre Pronchery {
352*b077aed3SPierre Pronchery     return OSSL_DECODER_up_ref(method);
353*b077aed3SPierre Pronchery }
354*b077aed3SPierre Pronchery 
free_decoder(void * method)355*b077aed3SPierre Pronchery static void free_decoder(void *method)
356*b077aed3SPierre Pronchery {
357*b077aed3SPierre Pronchery     OSSL_DECODER_free(method);
358*b077aed3SPierre Pronchery }
359*b077aed3SPierre Pronchery 
360*b077aed3SPierre Pronchery /* Fetching support.  Can fetch by numeric identity or by name */
361*b077aed3SPierre Pronchery static OSSL_DECODER *
inner_ossl_decoder_fetch(struct decoder_data_st * methdata,int id,const char * name,const char * properties)362*b077aed3SPierre Pronchery inner_ossl_decoder_fetch(struct decoder_data_st *methdata, int id,
363*b077aed3SPierre Pronchery                          const char *name, const char *properties)
364*b077aed3SPierre Pronchery {
365*b077aed3SPierre Pronchery     OSSL_METHOD_STORE *store = get_decoder_store(methdata->libctx);
366*b077aed3SPierre Pronchery     OSSL_NAMEMAP *namemap = ossl_namemap_stored(methdata->libctx);
367*b077aed3SPierre Pronchery     const char *const propq = properties != NULL ? properties : "";
368*b077aed3SPierre Pronchery     void *method = NULL;
369*b077aed3SPierre Pronchery     int unsupported = 0;
370*b077aed3SPierre Pronchery 
371*b077aed3SPierre Pronchery     if (store == NULL || namemap == NULL) {
372*b077aed3SPierre Pronchery         ERR_raise(ERR_LIB_OSSL_DECODER, ERR_R_PASSED_INVALID_ARGUMENT);
373*b077aed3SPierre Pronchery         return NULL;
374*b077aed3SPierre Pronchery     }
375*b077aed3SPierre Pronchery 
376*b077aed3SPierre Pronchery     /*
377*b077aed3SPierre Pronchery      * If we have been passed both an id and a name, we have an
378*b077aed3SPierre Pronchery      * internal programming error.
379*b077aed3SPierre Pronchery      */
380*b077aed3SPierre Pronchery     if (!ossl_assert(id == 0 || name == NULL)) {
381*b077aed3SPierre Pronchery         ERR_raise(ERR_LIB_OSSL_DECODER, ERR_R_INTERNAL_ERROR);
382*b077aed3SPierre Pronchery         return NULL;
383*b077aed3SPierre Pronchery     }
384*b077aed3SPierre Pronchery 
385*b077aed3SPierre Pronchery     if (id == 0 && name != NULL)
386*b077aed3SPierre Pronchery         id = ossl_namemap_name2num(namemap, name);
387*b077aed3SPierre Pronchery 
388*b077aed3SPierre Pronchery     /*
389*b077aed3SPierre Pronchery      * If we haven't found the name yet, chances are that the algorithm to
390*b077aed3SPierre Pronchery      * be fetched is unsupported.
391*b077aed3SPierre Pronchery      */
392*b077aed3SPierre Pronchery     if (id == 0)
393*b077aed3SPierre Pronchery         unsupported = 1;
394*b077aed3SPierre Pronchery 
395*b077aed3SPierre Pronchery     if (id == 0
396*b077aed3SPierre Pronchery         || !ossl_method_store_cache_get(store, NULL, id, propq, &method)) {
397*b077aed3SPierre Pronchery         OSSL_METHOD_CONSTRUCT_METHOD mcm = {
398*b077aed3SPierre Pronchery             get_tmp_decoder_store,
399*b077aed3SPierre Pronchery             reserve_decoder_store,
400*b077aed3SPierre Pronchery             unreserve_decoder_store,
401*b077aed3SPierre Pronchery             get_decoder_from_store,
402*b077aed3SPierre Pronchery             put_decoder_in_store,
403*b077aed3SPierre Pronchery             construct_decoder,
404*b077aed3SPierre Pronchery             destruct_decoder
405*b077aed3SPierre Pronchery         };
406*b077aed3SPierre Pronchery         OSSL_PROVIDER *prov = NULL;
407*b077aed3SPierre Pronchery 
408*b077aed3SPierre Pronchery         methdata->id = id;
409*b077aed3SPierre Pronchery         methdata->names = name;
410*b077aed3SPierre Pronchery         methdata->propquery = propq;
411*b077aed3SPierre Pronchery         methdata->flag_construct_error_occurred = 0;
412*b077aed3SPierre Pronchery         if ((method = ossl_method_construct(methdata->libctx, OSSL_OP_DECODER,
413*b077aed3SPierre Pronchery                                             &prov, 0 /* !force_cache */,
414*b077aed3SPierre Pronchery                                             &mcm, methdata)) != NULL) {
415*b077aed3SPierre Pronchery             /*
416*b077aed3SPierre Pronchery              * If construction did create a method for us, we know that
417*b077aed3SPierre Pronchery              * there is a correct name_id and meth_id, since those have
418*b077aed3SPierre Pronchery              * already been calculated in get_decoder_from_store() and
419*b077aed3SPierre Pronchery              * put_decoder_in_store() above.
420*b077aed3SPierre Pronchery              */
421*b077aed3SPierre Pronchery             if (id == 0 && name != NULL)
422*b077aed3SPierre Pronchery                 id = ossl_namemap_name2num(namemap, name);
423*b077aed3SPierre Pronchery             if (id != 0)
424*b077aed3SPierre Pronchery                 ossl_method_store_cache_set(store, prov, id, propq, method,
425*b077aed3SPierre Pronchery                                             up_ref_decoder, free_decoder);
426*b077aed3SPierre Pronchery         }
427*b077aed3SPierre Pronchery 
428*b077aed3SPierre Pronchery         /*
429*b077aed3SPierre Pronchery          * If we never were in the constructor, the algorithm to be fetched
430*b077aed3SPierre Pronchery          * is unsupported.
431*b077aed3SPierre Pronchery          */
432*b077aed3SPierre Pronchery         unsupported = !methdata->flag_construct_error_occurred;
433*b077aed3SPierre Pronchery     }
434*b077aed3SPierre Pronchery 
435*b077aed3SPierre Pronchery     if ((id != 0 || name != NULL) && method == NULL) {
436*b077aed3SPierre Pronchery         int code = unsupported ? ERR_R_UNSUPPORTED : ERR_R_FETCH_FAILED;
437*b077aed3SPierre Pronchery 
438*b077aed3SPierre Pronchery         if (name == NULL)
439*b077aed3SPierre Pronchery             name = ossl_namemap_num2name(namemap, id, 0);
440*b077aed3SPierre Pronchery         ERR_raise_data(ERR_LIB_OSSL_DECODER, code,
441*b077aed3SPierre Pronchery                        "%s, Name (%s : %d), Properties (%s)",
442*b077aed3SPierre Pronchery                        ossl_lib_ctx_get_descriptor(methdata->libctx),
443*b077aed3SPierre Pronchery                        name == NULL ? "<null>" : name, id,
444*b077aed3SPierre Pronchery                        properties == NULL ? "<null>" : properties);
445*b077aed3SPierre Pronchery     }
446*b077aed3SPierre Pronchery 
447*b077aed3SPierre Pronchery     return method;
448*b077aed3SPierre Pronchery }
449*b077aed3SPierre Pronchery 
OSSL_DECODER_fetch(OSSL_LIB_CTX * libctx,const char * name,const char * properties)450*b077aed3SPierre Pronchery OSSL_DECODER *OSSL_DECODER_fetch(OSSL_LIB_CTX *libctx, const char *name,
451*b077aed3SPierre Pronchery                                  const char *properties)
452*b077aed3SPierre Pronchery {
453*b077aed3SPierre Pronchery     struct decoder_data_st methdata;
454*b077aed3SPierre Pronchery     void *method;
455*b077aed3SPierre Pronchery 
456*b077aed3SPierre Pronchery     methdata.libctx = libctx;
457*b077aed3SPierre Pronchery     methdata.tmp_store = NULL;
458*b077aed3SPierre Pronchery     method = inner_ossl_decoder_fetch(&methdata, 0, name, properties);
459*b077aed3SPierre Pronchery     dealloc_tmp_decoder_store(methdata.tmp_store);
460*b077aed3SPierre Pronchery     return method;
461*b077aed3SPierre Pronchery }
462*b077aed3SPierre Pronchery 
ossl_decoder_fetch_by_number(OSSL_LIB_CTX * libctx,int id,const char * properties)463*b077aed3SPierre Pronchery OSSL_DECODER *ossl_decoder_fetch_by_number(OSSL_LIB_CTX *libctx, int id,
464*b077aed3SPierre Pronchery                                            const char *properties)
465*b077aed3SPierre Pronchery {
466*b077aed3SPierre Pronchery     struct decoder_data_st methdata;
467*b077aed3SPierre Pronchery     void *method;
468*b077aed3SPierre Pronchery 
469*b077aed3SPierre Pronchery     methdata.libctx = libctx;
470*b077aed3SPierre Pronchery     methdata.tmp_store = NULL;
471*b077aed3SPierre Pronchery     method = inner_ossl_decoder_fetch(&methdata, id, NULL, properties);
472*b077aed3SPierre Pronchery     dealloc_tmp_decoder_store(methdata.tmp_store);
473*b077aed3SPierre Pronchery     return method;
474*b077aed3SPierre Pronchery }
475*b077aed3SPierre Pronchery 
ossl_decoder_store_cache_flush(OSSL_LIB_CTX * libctx)476*b077aed3SPierre Pronchery int ossl_decoder_store_cache_flush(OSSL_LIB_CTX *libctx)
477*b077aed3SPierre Pronchery {
478*b077aed3SPierre Pronchery     OSSL_METHOD_STORE *store = get_decoder_store(libctx);
479*b077aed3SPierre Pronchery 
480*b077aed3SPierre Pronchery     if (store != NULL)
481*b077aed3SPierre Pronchery         return ossl_method_store_cache_flush_all(store);
482*b077aed3SPierre Pronchery     return 1;
483*b077aed3SPierre Pronchery }
484*b077aed3SPierre Pronchery 
ossl_decoder_store_remove_all_provided(const OSSL_PROVIDER * prov)485*b077aed3SPierre Pronchery int ossl_decoder_store_remove_all_provided(const OSSL_PROVIDER *prov)
486*b077aed3SPierre Pronchery {
487*b077aed3SPierre Pronchery     OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
488*b077aed3SPierre Pronchery     OSSL_METHOD_STORE *store = get_decoder_store(libctx);
489*b077aed3SPierre Pronchery 
490*b077aed3SPierre Pronchery     if (store != NULL)
491*b077aed3SPierre Pronchery         return ossl_method_store_remove_all_provided(store, prov);
492*b077aed3SPierre Pronchery     return 1;
493*b077aed3SPierre Pronchery }
494*b077aed3SPierre Pronchery 
495*b077aed3SPierre Pronchery /*
496*b077aed3SPierre Pronchery  * Library of basic method functions
497*b077aed3SPierre Pronchery  */
498*b077aed3SPierre Pronchery 
OSSL_DECODER_get0_provider(const OSSL_DECODER * decoder)499*b077aed3SPierre Pronchery const OSSL_PROVIDER *OSSL_DECODER_get0_provider(const OSSL_DECODER *decoder)
500*b077aed3SPierre Pronchery {
501*b077aed3SPierre Pronchery     if (!ossl_assert(decoder != NULL)) {
502*b077aed3SPierre Pronchery         ERR_raise(ERR_LIB_OSSL_DECODER, ERR_R_PASSED_NULL_PARAMETER);
503*b077aed3SPierre Pronchery         return 0;
504*b077aed3SPierre Pronchery     }
505*b077aed3SPierre Pronchery 
506*b077aed3SPierre Pronchery     return decoder->base.prov;
507*b077aed3SPierre Pronchery }
508*b077aed3SPierre Pronchery 
OSSL_DECODER_get0_properties(const OSSL_DECODER * decoder)509*b077aed3SPierre Pronchery const char *OSSL_DECODER_get0_properties(const OSSL_DECODER *decoder)
510*b077aed3SPierre Pronchery {
511*b077aed3SPierre Pronchery     if (!ossl_assert(decoder != NULL)) {
512*b077aed3SPierre Pronchery         ERR_raise(ERR_LIB_OSSL_DECODER, ERR_R_PASSED_NULL_PARAMETER);
513*b077aed3SPierre Pronchery         return 0;
514*b077aed3SPierre Pronchery     }
515*b077aed3SPierre Pronchery 
516*b077aed3SPierre Pronchery     return decoder->base.algodef->property_definition;
517*b077aed3SPierre Pronchery }
518*b077aed3SPierre Pronchery 
519*b077aed3SPierre Pronchery const OSSL_PROPERTY_LIST *
ossl_decoder_parsed_properties(const OSSL_DECODER * decoder)520*b077aed3SPierre Pronchery ossl_decoder_parsed_properties(const OSSL_DECODER *decoder)
521*b077aed3SPierre Pronchery {
522*b077aed3SPierre Pronchery     if (!ossl_assert(decoder != NULL)) {
523*b077aed3SPierre Pronchery         ERR_raise(ERR_LIB_OSSL_DECODER, ERR_R_PASSED_NULL_PARAMETER);
524*b077aed3SPierre Pronchery         return 0;
525*b077aed3SPierre Pronchery     }
526*b077aed3SPierre Pronchery 
527*b077aed3SPierre Pronchery     return decoder->base.parsed_propdef;
528*b077aed3SPierre Pronchery }
529*b077aed3SPierre Pronchery 
ossl_decoder_get_number(const OSSL_DECODER * decoder)530*b077aed3SPierre Pronchery int ossl_decoder_get_number(const OSSL_DECODER *decoder)
531*b077aed3SPierre Pronchery {
532*b077aed3SPierre Pronchery     if (!ossl_assert(decoder != NULL)) {
533*b077aed3SPierre Pronchery         ERR_raise(ERR_LIB_OSSL_DECODER, ERR_R_PASSED_NULL_PARAMETER);
534*b077aed3SPierre Pronchery         return 0;
535*b077aed3SPierre Pronchery     }
536*b077aed3SPierre Pronchery 
537*b077aed3SPierre Pronchery     return decoder->base.id;
538*b077aed3SPierre Pronchery }
539*b077aed3SPierre Pronchery 
OSSL_DECODER_get0_name(const OSSL_DECODER * decoder)540*b077aed3SPierre Pronchery const char *OSSL_DECODER_get0_name(const OSSL_DECODER *decoder)
541*b077aed3SPierre Pronchery {
542*b077aed3SPierre Pronchery     return decoder->base.name;
543*b077aed3SPierre Pronchery }
544*b077aed3SPierre Pronchery 
OSSL_DECODER_get0_description(const OSSL_DECODER * decoder)545*b077aed3SPierre Pronchery const char *OSSL_DECODER_get0_description(const OSSL_DECODER *decoder)
546*b077aed3SPierre Pronchery {
547*b077aed3SPierre Pronchery     return decoder->base.algodef->algorithm_description;
548*b077aed3SPierre Pronchery }
549*b077aed3SPierre Pronchery 
OSSL_DECODER_is_a(const OSSL_DECODER * decoder,const char * name)550*b077aed3SPierre Pronchery int OSSL_DECODER_is_a(const OSSL_DECODER *decoder, const char *name)
551*b077aed3SPierre Pronchery {
552*b077aed3SPierre Pronchery     if (decoder->base.prov != NULL) {
553*b077aed3SPierre Pronchery         OSSL_LIB_CTX *libctx = ossl_provider_libctx(decoder->base.prov);
554*b077aed3SPierre Pronchery         OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
555*b077aed3SPierre Pronchery 
556*b077aed3SPierre Pronchery         return ossl_namemap_name2num(namemap, name) == decoder->base.id;
557*b077aed3SPierre Pronchery     }
558*b077aed3SPierre Pronchery     return 0;
559*b077aed3SPierre Pronchery }
560*b077aed3SPierre Pronchery 
561*b077aed3SPierre Pronchery struct do_one_data_st {
562*b077aed3SPierre Pronchery     void (*user_fn)(OSSL_DECODER *decoder, void *arg);
563*b077aed3SPierre Pronchery     void *user_arg;
564*b077aed3SPierre Pronchery };
565*b077aed3SPierre Pronchery 
do_one(ossl_unused int id,void * method,void * arg)566*b077aed3SPierre Pronchery static void do_one(ossl_unused int id, void *method, void *arg)
567*b077aed3SPierre Pronchery {
568*b077aed3SPierre Pronchery     struct do_one_data_st *data = arg;
569*b077aed3SPierre Pronchery 
570*b077aed3SPierre Pronchery     data->user_fn(method, data->user_arg);
571*b077aed3SPierre Pronchery }
572*b077aed3SPierre Pronchery 
OSSL_DECODER_do_all_provided(OSSL_LIB_CTX * libctx,void (* user_fn)(OSSL_DECODER * decoder,void * arg),void * user_arg)573*b077aed3SPierre Pronchery void OSSL_DECODER_do_all_provided(OSSL_LIB_CTX *libctx,
574*b077aed3SPierre Pronchery                                   void (*user_fn)(OSSL_DECODER *decoder,
575*b077aed3SPierre Pronchery                                                   void *arg),
576*b077aed3SPierre Pronchery                                   void *user_arg)
577*b077aed3SPierre Pronchery {
578*b077aed3SPierre Pronchery     struct decoder_data_st methdata;
579*b077aed3SPierre Pronchery     struct do_one_data_st data;
580*b077aed3SPierre Pronchery 
581*b077aed3SPierre Pronchery     methdata.libctx = libctx;
582*b077aed3SPierre Pronchery     methdata.tmp_store = NULL;
583*b077aed3SPierre Pronchery     (void)inner_ossl_decoder_fetch(&methdata, 0, NULL, NULL /* properties */);
584*b077aed3SPierre Pronchery 
585*b077aed3SPierre Pronchery     data.user_fn = user_fn;
586*b077aed3SPierre Pronchery     data.user_arg = user_arg;
587*b077aed3SPierre Pronchery     if (methdata.tmp_store != NULL)
588*b077aed3SPierre Pronchery         ossl_method_store_do_all(methdata.tmp_store, &do_one, &data);
589*b077aed3SPierre Pronchery     ossl_method_store_do_all(get_decoder_store(libctx), &do_one, &data);
590*b077aed3SPierre Pronchery     dealloc_tmp_decoder_store(methdata.tmp_store);
591*b077aed3SPierre Pronchery }
592*b077aed3SPierre Pronchery 
OSSL_DECODER_names_do_all(const OSSL_DECODER * decoder,void (* fn)(const char * name,void * data),void * data)593*b077aed3SPierre Pronchery int OSSL_DECODER_names_do_all(const OSSL_DECODER *decoder,
594*b077aed3SPierre Pronchery                               void (*fn)(const char *name, void *data),
595*b077aed3SPierre Pronchery                               void *data)
596*b077aed3SPierre Pronchery {
597*b077aed3SPierre Pronchery     if (decoder == NULL)
598*b077aed3SPierre Pronchery         return 0;
599*b077aed3SPierre Pronchery 
600*b077aed3SPierre Pronchery     if (decoder->base.prov != NULL) {
601*b077aed3SPierre Pronchery         OSSL_LIB_CTX *libctx = ossl_provider_libctx(decoder->base.prov);
602*b077aed3SPierre Pronchery         OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
603*b077aed3SPierre Pronchery 
604*b077aed3SPierre Pronchery         return ossl_namemap_doall_names(namemap, decoder->base.id, fn, data);
605*b077aed3SPierre Pronchery     }
606*b077aed3SPierre Pronchery 
607*b077aed3SPierre Pronchery     return 1;
608*b077aed3SPierre Pronchery }
609*b077aed3SPierre Pronchery 
610*b077aed3SPierre Pronchery const OSSL_PARAM *
OSSL_DECODER_gettable_params(OSSL_DECODER * decoder)611*b077aed3SPierre Pronchery OSSL_DECODER_gettable_params(OSSL_DECODER *decoder)
612*b077aed3SPierre Pronchery {
613*b077aed3SPierre Pronchery     if (decoder != NULL && decoder->gettable_params != NULL) {
614*b077aed3SPierre Pronchery         void *provctx = ossl_provider_ctx(OSSL_DECODER_get0_provider(decoder));
615*b077aed3SPierre Pronchery 
616*b077aed3SPierre Pronchery         return decoder->gettable_params(provctx);
617*b077aed3SPierre Pronchery     }
618*b077aed3SPierre Pronchery     return NULL;
619*b077aed3SPierre Pronchery }
620*b077aed3SPierre Pronchery 
OSSL_DECODER_get_params(OSSL_DECODER * decoder,OSSL_PARAM params[])621*b077aed3SPierre Pronchery int OSSL_DECODER_get_params(OSSL_DECODER *decoder, OSSL_PARAM params[])
622*b077aed3SPierre Pronchery {
623*b077aed3SPierre Pronchery     if (decoder != NULL && decoder->get_params != NULL)
624*b077aed3SPierre Pronchery         return decoder->get_params(params);
625*b077aed3SPierre Pronchery     return 0;
626*b077aed3SPierre Pronchery }
627*b077aed3SPierre Pronchery 
628*b077aed3SPierre Pronchery const OSSL_PARAM *
OSSL_DECODER_settable_ctx_params(OSSL_DECODER * decoder)629*b077aed3SPierre Pronchery OSSL_DECODER_settable_ctx_params(OSSL_DECODER *decoder)
630*b077aed3SPierre Pronchery {
631*b077aed3SPierre Pronchery     if (decoder != NULL && decoder->settable_ctx_params != NULL) {
632*b077aed3SPierre Pronchery         void *provctx = ossl_provider_ctx(OSSL_DECODER_get0_provider(decoder));
633*b077aed3SPierre Pronchery 
634*b077aed3SPierre Pronchery         return decoder->settable_ctx_params(provctx);
635*b077aed3SPierre Pronchery     }
636*b077aed3SPierre Pronchery     return NULL;
637*b077aed3SPierre Pronchery }
638*b077aed3SPierre Pronchery 
639*b077aed3SPierre Pronchery /*
640*b077aed3SPierre Pronchery  * Decoder context support
641*b077aed3SPierre Pronchery  */
642*b077aed3SPierre Pronchery 
643*b077aed3SPierre Pronchery /*
644*b077aed3SPierre Pronchery  * |encoder| value NULL is valid, and signifies that there is no decoder.
645*b077aed3SPierre Pronchery  * This is useful to provide fallback mechanisms.
646*b077aed3SPierre Pronchery  *  Functions that want to verify if there is a decoder can do so with
647*b077aed3SPierre Pronchery  * OSSL_DECODER_CTX_get_decoder()
648*b077aed3SPierre Pronchery  */
OSSL_DECODER_CTX_new(void)649*b077aed3SPierre Pronchery OSSL_DECODER_CTX *OSSL_DECODER_CTX_new(void)
650*b077aed3SPierre Pronchery {
651*b077aed3SPierre Pronchery     OSSL_DECODER_CTX *ctx;
652*b077aed3SPierre Pronchery 
653*b077aed3SPierre Pronchery     if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL)
654*b077aed3SPierre Pronchery         ERR_raise(ERR_LIB_OSSL_DECODER, ERR_R_MALLOC_FAILURE);
655*b077aed3SPierre Pronchery 
656*b077aed3SPierre Pronchery     return ctx;
657*b077aed3SPierre Pronchery }
658*b077aed3SPierre Pronchery 
OSSL_DECODER_CTX_set_params(OSSL_DECODER_CTX * ctx,const OSSL_PARAM params[])659*b077aed3SPierre Pronchery int OSSL_DECODER_CTX_set_params(OSSL_DECODER_CTX *ctx,
660*b077aed3SPierre Pronchery                                 const OSSL_PARAM params[])
661*b077aed3SPierre Pronchery {
662*b077aed3SPierre Pronchery     int ok = 1;
663*b077aed3SPierre Pronchery     size_t i;
664*b077aed3SPierre Pronchery     size_t l;
665*b077aed3SPierre Pronchery 
666*b077aed3SPierre Pronchery     if (!ossl_assert(ctx != NULL)) {
667*b077aed3SPierre Pronchery         ERR_raise(ERR_LIB_OSSL_DECODER, ERR_R_PASSED_NULL_PARAMETER);
668*b077aed3SPierre Pronchery         return 0;
669*b077aed3SPierre Pronchery     }
670*b077aed3SPierre Pronchery 
671*b077aed3SPierre Pronchery     if (ctx->decoder_insts == NULL)
672*b077aed3SPierre Pronchery         return 1;
673*b077aed3SPierre Pronchery 
674*b077aed3SPierre Pronchery     l = OSSL_DECODER_CTX_get_num_decoders(ctx);
675*b077aed3SPierre Pronchery     for (i = 0; i < l; i++) {
676*b077aed3SPierre Pronchery         OSSL_DECODER_INSTANCE *decoder_inst =
677*b077aed3SPierre Pronchery             sk_OSSL_DECODER_INSTANCE_value(ctx->decoder_insts, i);
678*b077aed3SPierre Pronchery         OSSL_DECODER *decoder =
679*b077aed3SPierre Pronchery             OSSL_DECODER_INSTANCE_get_decoder(decoder_inst);
680*b077aed3SPierre Pronchery         OSSL_DECODER *decoderctx =
681*b077aed3SPierre Pronchery             OSSL_DECODER_INSTANCE_get_decoder_ctx(decoder_inst);
682*b077aed3SPierre Pronchery 
683*b077aed3SPierre Pronchery         if (decoderctx == NULL || decoder->set_ctx_params == NULL)
684*b077aed3SPierre Pronchery             continue;
685*b077aed3SPierre Pronchery         if (!decoder->set_ctx_params(decoderctx, params))
686*b077aed3SPierre Pronchery             ok = 0;
687*b077aed3SPierre Pronchery     }
688*b077aed3SPierre Pronchery     return ok;
689*b077aed3SPierre Pronchery }
690*b077aed3SPierre Pronchery 
OSSL_DECODER_CTX_free(OSSL_DECODER_CTX * ctx)691*b077aed3SPierre Pronchery void OSSL_DECODER_CTX_free(OSSL_DECODER_CTX *ctx)
692*b077aed3SPierre Pronchery {
693*b077aed3SPierre Pronchery     if (ctx != NULL) {
694*b077aed3SPierre Pronchery         if (ctx->cleanup != NULL)
695*b077aed3SPierre Pronchery             ctx->cleanup(ctx->construct_data);
696*b077aed3SPierre Pronchery         sk_OSSL_DECODER_INSTANCE_pop_free(ctx->decoder_insts,
697*b077aed3SPierre Pronchery                                           ossl_decoder_instance_free);
698*b077aed3SPierre Pronchery         ossl_pw_clear_passphrase_data(&ctx->pwdata);
699*b077aed3SPierre Pronchery         OPENSSL_free(ctx);
700*b077aed3SPierre Pronchery     }
701*b077aed3SPierre Pronchery }
702