include/openssl/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 OPENSSL_PROVIDER_H
  11 # define OPENSSL_PROVIDER_H
  12 # pragma once
  13
  14 # include <openssl/core.h>
  15
  16 # ifdef __cplusplus
  17 extern "C" {
  18 # endif
  19
  20 /* Set the default provider search path */
  21 int OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX *, const char *path);
  22
  23 /* Load and unload a provider */
  24 OSSL_PROVIDER *OSSL_PROVIDER_load(OSSL_LIB_CTX *, const char *name);
  25 OSSL_PROVIDER *OSSL_PROVIDER_try_load(OSSL_LIB_CTX *, const char *name,
  26                                       int retain_fallbacks);
  27 int OSSL_PROVIDER_unload(OSSL_PROVIDER *prov);
  28 int OSSL_PROVIDER_available(OSSL_LIB_CTX *, const char *name);
  29 int OSSL_PROVIDER_do_all(OSSL_LIB_CTX *ctx,
  30                          int (*cb)(OSSL_PROVIDER *provider, void *cbdata),
  31                          void *cbdata);
  32
  33 const OSSL_PARAM *OSSL_PROVIDER_gettable_params(const OSSL_PROVIDER *prov);
  34 int OSSL_PROVIDER_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[]);
  35 int OSSL_PROVIDER_self_test(const OSSL_PROVIDER *prov);
  36 int OSSL_PROVIDER_get_capabilities(const OSSL_PROVIDER *prov,
  37                                    const char *capability,
  38                                    OSSL_CALLBACK *cb,
  39                                    void *arg);
  40
  41 const OSSL_ALGORITHM *OSSL_PROVIDER_query_operation(const OSSL_PROVIDER *prov,
  42                                                     int operation_id,
  43                                                     int *no_cache);
  44 void OSSL_PROVIDER_unquery_operation(const OSSL_PROVIDER *prov,
  45                                      int operation_id, const OSSL_ALGORITHM *algs);
  46 void *OSSL_PROVIDER_get0_provider_ctx(const OSSL_PROVIDER *prov);
  47 const OSSL_DISPATCH *OSSL_PROVIDER_get0_dispatch(const OSSL_PROVIDER *prov);
  48
  49 /* Add a built in providers */
  50 int OSSL_PROVIDER_add_builtin(OSSL_LIB_CTX *, const char *name,
  51                               OSSL_provider_init_fn *init_fn);
  52
  53 /* Information */
  54 const char *OSSL_PROVIDER_name(const OSSL_PROVIDER *prov);
  55
  56 # ifdef __cplusplus
  57 }
  58 # endif
  59
  60 #endif