135b660f49639c1e1bd91f3b801ba8e9b5834b22
[openssl.git] / include / internal / provider.h
1 /*
2  * Copyright 2019-2020 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_PROVIDER_H
11 # define OSSL_INTERNAL_PROVIDER_H
12
13 # include <openssl/core.h>
14 # include <openssl/core_numbers.h>
15 # include "internal/dso.h"
16 # include "internal/symhacks.h"
17
18 # ifdef __cplusplus
19 extern "C" {
20 # endif
21
22 /*
23  * namespaces:
24  *
25  * ossl_provider_       Provider Object internal API
26  * OSSL_PROVIDER        Provider Object
27  */
28
29 /* Provider Object finder, constructor and destructor */
30 OSSL_PROVIDER *ossl_provider_find(OPENSSL_CTX *libctx, const char *name,
31                                   int noconfig);
32 OSSL_PROVIDER *ossl_provider_new(OPENSSL_CTX *libctx, const char *name,
33                                  OSSL_provider_init_fn *init_function,
34                                  int noconfig);
35 int ossl_provider_up_ref(OSSL_PROVIDER *prov);
36 void ossl_provider_free(OSSL_PROVIDER *prov);
37
38 /* Setters */
39 int ossl_provider_set_fallback(OSSL_PROVIDER *prov);
40 int ossl_provider_set_module_path(OSSL_PROVIDER *prov, const char *module_path);
41 int ossl_provider_add_parameter(OSSL_PROVIDER *prov, const char *name,
42                                 const char *value);
43
44 /*
45  * Activate the Provider
46  * If the Provider is a module, the module will be loaded
47  * Inactivation is done by freeing the Provider
48  */
49 int ossl_provider_activate(OSSL_PROVIDER *prov);
50 /* Check if the provider is available */
51 int ossl_provider_available(OSSL_PROVIDER *prov);
52
53 /* Return pointer to the provider's context */
54 void *ossl_provider_ctx(const OSSL_PROVIDER *prov);
55
56 /* Iterate over all loaded providers */
57 int ossl_provider_forall_loaded(OPENSSL_CTX *,
58                                 int (*cb)(OSSL_PROVIDER *provider,
59                                           void *cbdata),
60                                 void *cbdata);
61
62 /* Getters for other library functions */
63 const char *ossl_provider_name(const OSSL_PROVIDER *prov);
64 const DSO *ossl_provider_dso(const OSSL_PROVIDER *prov);
65 const char *ossl_provider_module_name(const OSSL_PROVIDER *prov);
66 const char *ossl_provider_module_path(const OSSL_PROVIDER *prov);
67 OPENSSL_CTX *ossl_provider_library_context(const OSSL_PROVIDER *prov);
68
69 /* Thin wrappers around calls to the provider */
70 void ossl_provider_teardown(const OSSL_PROVIDER *prov);
71 const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov);
72 int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[]);
73 const OSSL_ALGORITHM *ossl_provider_query_operation(const OSSL_PROVIDER *prov,
74                                                     int operation_id,
75                                                     int *no_cache);
76
77 /* Cache of bits to see if we already queried an operation */
78 int ossl_provider_set_operation_bit(OSSL_PROVIDER *provider, size_t bitnum);
79 int ossl_provider_test_operation_bit(OSSL_PROVIDER *provider, size_t bitnum,
80                                      int *result);
81
82 /* Configuration */
83 void ossl_provider_add_conf_module(void);
84
85 # ifdef __cplusplus
86 }
87 # endif
88
89 #endif