2 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
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
10 #ifndef OSSL_INTERNAL_PROVIDER_H
11 # define OSSL_INTERNAL_PROVIDER_H
14 # include <openssl/core.h>
15 # include <openssl/core_dispatch.h>
16 # include "internal/dso.h"
17 # include "internal/symhacks.h"
26 * ossl_provider_ Provider Object internal API
27 * OSSL_PROVIDER Provider Object
30 /* Provider Object finder, constructor and destructor */
31 OSSL_PROVIDER *ossl_provider_find(OSSL_LIB_CTX *libctx, const char *name,
33 OSSL_PROVIDER *ossl_provider_new(OSSL_LIB_CTX *libctx, const char *name,
34 OSSL_provider_init_fn *init_function,
36 int ossl_provider_up_ref(OSSL_PROVIDER *prov);
37 void ossl_provider_free(OSSL_PROVIDER *prov);
40 int ossl_provider_set_fallback(OSSL_PROVIDER *prov);
41 int ossl_provider_set_module_path(OSSL_PROVIDER *prov, const char *module_path);
42 int ossl_provider_add_parameter(OSSL_PROVIDER *prov, const char *name,
44 int ossl_provider_set_child(OSSL_PROVIDER *prov, const OSSL_CORE_HANDLE *handle);
45 const OSSL_CORE_HANDLE *ossl_provider_get_parent(OSSL_PROVIDER *prov);
46 int ossl_provider_up_ref_parent(OSSL_PROVIDER *prov, int activate);
47 int ossl_provider_free_parent(OSSL_PROVIDER *prov, int deactivate);
49 /* Disable fallback loading */
50 int ossl_provider_disable_fallback_loading(OSSL_LIB_CTX *libctx);
53 * Activate the Provider
54 * If the Provider is a module, the module will be loaded
56 int ossl_provider_activate(OSSL_PROVIDER *prov, int retain_fallbacks,
58 int ossl_provider_deactivate(OSSL_PROVIDER *prov);
59 /* Check if the provider is available (activated) */
60 int ossl_provider_available(OSSL_PROVIDER *prov);
62 /* Return pointer to the provider's context */
63 void *ossl_provider_ctx(const OSSL_PROVIDER *prov);
65 /* Iterate over all loaded providers */
66 int ossl_provider_doall_activated(OSSL_LIB_CTX *,
67 int (*cb)(OSSL_PROVIDER *provider,
71 /* Getters for other library functions */
72 const char *ossl_provider_name(const OSSL_PROVIDER *prov);
73 const DSO *ossl_provider_dso(const OSSL_PROVIDER *prov);
74 const char *ossl_provider_module_name(const OSSL_PROVIDER *prov);
75 const char *ossl_provider_module_path(const OSSL_PROVIDER *prov);
76 void *ossl_provider_prov_ctx(const OSSL_PROVIDER *prov);
77 const OSSL_DISPATCH *ossl_provider_get0_dispatch(const OSSL_PROVIDER *prov);
78 OSSL_LIB_CTX *ossl_provider_libctx(const OSSL_PROVIDER *prov);
80 /* Thin wrappers around calls to the provider */
81 void ossl_provider_teardown(const OSSL_PROVIDER *prov);
82 const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov);
83 int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[]);
84 int ossl_provider_get_capabilities(const OSSL_PROVIDER *prov,
85 const char *capability,
88 int ossl_provider_self_test(const OSSL_PROVIDER *prov);
89 const OSSL_ALGORITHM *ossl_provider_query_operation(const OSSL_PROVIDER *prov,
92 void ossl_provider_unquery_operation(const OSSL_PROVIDER *prov,
94 const OSSL_ALGORITHM *algs);
96 /* Cache of bits to see if we already queried an operation */
97 int ossl_provider_set_operation_bit(OSSL_PROVIDER *provider, size_t bitnum);
98 int ossl_provider_test_operation_bit(OSSL_PROVIDER *provider, size_t bitnum,
100 int ossl_provider_clear_all_operation_bits(OSSL_LIB_CTX *libctx);
103 void ossl_provider_add_conf_module(void);
105 /* Child providers */
106 int ossl_provider_init_child_providers(OSSL_LIB_CTX *ctx);
107 int ossl_provider_init_as_child(OSSL_LIB_CTX *ctx,
108 const OSSL_CORE_HANDLE *handle,
109 const OSSL_DISPATCH *in);