include/internal/provider.h

   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_PROVIDER_H
  11 # define OSSL_INTERNAL_PROVIDER_H
  12 # pragma once
  13
  14 # include <openssl/core.h>
  15 # include <openssl/core_dispatch.h>
  16 # include "internal/dso.h"
  17 # include "internal/symhacks.h"
  18
  19 # ifdef __cplusplus
  20 extern "C" {
  21 # endif
  22
  23 /*
  24  * namespaces:
  25  *
  26  * ossl_provider_       Provider Object internal API
  27  * OSSL_PROVIDER        Provider Object
  28  */
  29
  30 /* Provider Object finder, constructor and destructor */
  31 OSSL_PROVIDER *ossl_provider_find(OSSL_LIB_CTX *libctx, const char *name,
  32                                   int noconfig);
  33 OSSL_PROVIDER *ossl_provider_new(OSSL_LIB_CTX *libctx, const char *name,
  34                                  OSSL_provider_init_fn *init_function,
  35                                  int noconfig);
  36 int ossl_provider_up_ref(OSSL_PROVIDER *prov);
  37 void ossl_provider_free(OSSL_PROVIDER *prov);
  38
  39 /* Setters */
  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,
  43                                 const char *value);
  44
  45 int ossl_provider_is_child(const OSSL_PROVIDER *prov);
  46 int ossl_provider_set_child(OSSL_PROVIDER *prov, const OSSL_CORE_HANDLE *handle);
  47 int ossl_provider_convert_to_child(OSSL_PROVIDER *prov,
  48                                    const OSSL_CORE_HANDLE *handle,
  49                                    OSSL_provider_init_fn *init_function);
  50 const OSSL_CORE_HANDLE *ossl_provider_get_parent(OSSL_PROVIDER *prov);
  51 int ossl_provider_up_ref_parent(OSSL_PROVIDER *prov, int activate);
  52 int ossl_provider_free_parent(OSSL_PROVIDER *prov, int deactivate);
  53
  54 /* Disable fallback loading */
  55 int ossl_provider_disable_fallback_loading(OSSL_LIB_CTX *libctx);
  56
  57 /*
  58  * Activate the Provider
  59  * If the Provider is a module, the module will be loaded
  60  */
  61 int ossl_provider_activate(OSSL_PROVIDER *prov, int retain_fallbacks,
  62                            int upcalls);
  63 int ossl_provider_deactivate(OSSL_PROVIDER *prov);
  64 /* Check if the provider is available (activated) */
  65 int ossl_provider_available(OSSL_PROVIDER *prov);
  66
  67 /* Return pointer to the provider's context */
  68 void *ossl_provider_ctx(const OSSL_PROVIDER *prov);
  69
  70 /* Iterate over all loaded providers */
  71 int ossl_provider_doall_activated(OSSL_LIB_CTX *,
  72                                   int (*cb)(OSSL_PROVIDER *provider,
  73                                             void *cbdata),
  74                                   void *cbdata);
  75
  76 /* Getters for other library functions */
  77 const char *ossl_provider_name(const OSSL_PROVIDER *prov);
  78 const DSO *ossl_provider_dso(const OSSL_PROVIDER *prov);
  79 const char *ossl_provider_module_name(const OSSL_PROVIDER *prov);
  80 const char *ossl_provider_module_path(const OSSL_PROVIDER *prov);
  81 void *ossl_provider_prov_ctx(const OSSL_PROVIDER *prov);
  82 const OSSL_DISPATCH *ossl_provider_get0_dispatch(const OSSL_PROVIDER *prov);
  83 OSSL_LIB_CTX *ossl_provider_libctx(const OSSL_PROVIDER *prov);
  84
  85 /* Thin wrappers around calls to the provider */
  86 void ossl_provider_teardown(const OSSL_PROVIDER *prov);
  87 const OSSL_PARAM *ossl_provider_gettable_params(const OSSL_PROVIDER *prov);
  88 int ossl_provider_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[]);
  89 int ossl_provider_get_capabilities(const OSSL_PROVIDER *prov,
  90                                    const char *capability,
  91                                    OSSL_CALLBACK *cb,
  92                                    void *arg);
  93 int ossl_provider_self_test(const OSSL_PROVIDER *prov);
  94 const OSSL_ALGORITHM *ossl_provider_query_operation(const OSSL_PROVIDER *prov,
  95                                                     int operation_id,
  96                                                     int *no_cache);
  97 void ossl_provider_unquery_operation(const OSSL_PROVIDER *prov,
  98                                      int operation_id,
  99                                      const OSSL_ALGORITHM *algs);
 100
 101 /* Cache of bits to see if we already queried an operation */
 102 int ossl_provider_set_operation_bit(OSSL_PROVIDER *provider, size_t bitnum);
 103 int ossl_provider_test_operation_bit(OSSL_PROVIDER *provider, size_t bitnum,
 104                                      int *result);
 105 int ossl_provider_clear_all_operation_bits(OSSL_LIB_CTX *libctx);
 106
 107 /* Configuration */
 108 void ossl_provider_add_conf_module(void);
 109
 110 /* Child providers */
 111 int ossl_provider_init_as_child(OSSL_LIB_CTX *ctx,
 112                                 const OSSL_CORE_HANDLE *handle,
 113                                 const OSSL_DISPATCH *in);
 114
 115 # ifdef __cplusplus
 116 }
 117 # endif
 118
 119 #endif