include/openssl/provider.h

   1 /*
   2  * Copyright 2019-2023 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 and Get a library context search path */
  21 int OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX *, const char *path);
  22 const char *OSSL_PROVIDER_get0_default_search_path(OSSL_LIB_CTX *libctx);
  23
  24 /* Load and unload a provider */
  25 OSSL_PROVIDER *OSSL_PROVIDER_load(OSSL_LIB_CTX *, const char *name);
  26 OSSL_PROVIDER *OSSL_PROVIDER_load_ex(OSSL_LIB_CTX *, const char *name,
  27                                      OSSL_PARAM *params);
  28 OSSL_PROVIDER *OSSL_PROVIDER_try_load(OSSL_LIB_CTX *, const char *name,
  29                                       int retain_fallbacks);
  30 OSSL_PROVIDER *OSSL_PROVIDER_try_load_ex(OSSL_LIB_CTX *, const char *name,
  31                                          OSSL_PARAM *params,
  32                                          int retain_fallbacks);
  33 int OSSL_PROVIDER_unload(OSSL_PROVIDER *prov);
  34 int OSSL_PROVIDER_available(OSSL_LIB_CTX *, const char *name);
  35 int OSSL_PROVIDER_do_all(OSSL_LIB_CTX *ctx,
  36                          int (*cb)(OSSL_PROVIDER *provider, void *cbdata),
  37                          void *cbdata);
  38
  39 const OSSL_PARAM *OSSL_PROVIDER_gettable_params(const OSSL_PROVIDER *prov);
  40 int OSSL_PROVIDER_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[]);
  41 int OSSL_PROVIDER_self_test(const OSSL_PROVIDER *prov);
  42 int OSSL_PROVIDER_get_capabilities(const OSSL_PROVIDER *prov,
  43                                    const char *capability,
  44                                    OSSL_CALLBACK *cb,
  45                                    void *arg);
  46
  47 const OSSL_ALGORITHM *OSSL_PROVIDER_query_operation(const OSSL_PROVIDER *prov,
  48                                                     int operation_id,
  49                                                     int *no_cache);
  50 void OSSL_PROVIDER_unquery_operation(const OSSL_PROVIDER *prov,
  51                                      int operation_id, const OSSL_ALGORITHM *algs);
  52 void *OSSL_PROVIDER_get0_provider_ctx(const OSSL_PROVIDER *prov);
  53 const OSSL_DISPATCH *OSSL_PROVIDER_get0_dispatch(const OSSL_PROVIDER *prov);
  54
  55 /* Add a built in providers */
  56 int OSSL_PROVIDER_add_builtin(OSSL_LIB_CTX *, const char *name,
  57                               OSSL_provider_init_fn *init_fn);
  58
  59 /* Information */
  60 const char *OSSL_PROVIDER_get0_name(const OSSL_PROVIDER *prov);
  61
  62 # ifdef __cplusplus
  63 }
  64 # endif
  65
  66 #endif