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