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