1 /*
2  * Copyright 2019-2021 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 #ifndef OSSL_INTERNAL_CORE_H
11 # define OSSL_INTERNAL_CORE_H
12 # pragma once
13 
14 /*
15  * namespaces:
16  *
17  * ossl_method_         Core Method API
18  */
19 
20 /*
21  * construct an arbitrary method from a dispatch table found by looking
22  * up a match for the < operation_id, name, property > combination.
23  * constructor and destructor are the constructor and destructor for that
24  * arbitrary object.
25  *
26  * These objects are normally cached, unless the provider says not to cache.
27  * However, force_cache can be used to force caching whatever the provider
28  * says (for example, because the application knows better).
29  */
30 typedef struct ossl_method_construct_method_st {
31     /* Get a temporary store */
32     void *(*get_tmp_store)(void *data);
33     /* Get an already existing method from a store */
34     void *(*get)(void *store, const OSSL_PROVIDER **prov, void *data);
35     /* Store a method in a store */
36     int (*put)(void *store, void *method, const OSSL_PROVIDER *prov,
37                const char *name, const char *propdef, void *data);
38     /* Construct a new method */
39     void *(*construct)(const OSSL_ALGORITHM *algodef, OSSL_PROVIDER *prov,
40                        void *data);
41     /* Destruct a method */
42     void (*destruct)(void *method, void *data);
43 } OSSL_METHOD_CONSTRUCT_METHOD;
44 
45 void *ossl_method_construct(OSSL_LIB_CTX *ctx, int operation_id,
46                             OSSL_PROVIDER **provider_rw, int force_cache,
47                             OSSL_METHOD_CONSTRUCT_METHOD *mcm, void *mcm_data);
48 
49 void ossl_algorithm_do_all(OSSL_LIB_CTX *libctx, int operation_id,
50                            OSSL_PROVIDER *provider,
51                            int (*pre)(OSSL_PROVIDER *, int operation_id,
52                                       void *data, int *result),
53                            void (*fn)(OSSL_PROVIDER *provider,
54                                       const OSSL_ALGORITHM *algo,
55                                       int no_store, void *data),
56                            int (*post)(OSSL_PROVIDER *, int operation_id,
57                                        int no_store, void *data, int *result),
58                            void *data);
59 char *ossl_algorithm_get1_first_name(const OSSL_ALGORITHM *algo);
60 
61 __owur int ossl_lib_ctx_write_lock(OSSL_LIB_CTX *ctx);
62 __owur int ossl_lib_ctx_read_lock(OSSL_LIB_CTX *ctx);
63 int ossl_lib_ctx_unlock(OSSL_LIB_CTX *ctx);
64 int ossl_lib_ctx_is_child(OSSL_LIB_CTX *ctx);
65 
66 #endif
67