include/openssl/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 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 OSSL_PROVIDER_unload(OSSL_PROVIDER *prov);
  27 int OSSL_PROVIDER_available(OSSL_LIB_CTX *, const char *name);
  28 int OSSL_PROVIDER_do_all(OSSL_LIB_CTX *ctx,
  29                          int (*cb)(OSSL_PROVIDER *provider, void *cbdata),
  30                          void *cbdata);
  31
  32 const OSSL_PARAM *OSSL_PROVIDER_gettable_params(const OSSL_PROVIDER *prov);
  33 int OSSL_PROVIDER_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[]);
  34 int OSSL_PROVIDER_self_test(const OSSL_PROVIDER *prov);
  35 int OSSL_PROVIDER_get_capabilities(const OSSL_PROVIDER *prov,
  36                                    const char *capability,
  37                                    OSSL_CALLBACK *cb,
  38                                    void *arg);
  39
  40 const OSSL_ALGORITHM *OSSL_PROVIDER_query_operation(const OSSL_PROVIDER *prov,
  41                                                     int operation_id,
  42                                                     int *no_cache);
  43 void *OSSL_PROVIDER_get0_provider_ctx(const OSSL_PROVIDER *prov);
  44
  45 /* Add a built in providers */
  46 int OSSL_PROVIDER_add_builtin(OSSL_LIB_CTX *, const char *name,
  47                               OSSL_provider_init_fn *init_fn);
  48
  49 /* Information */
  50 const char *OSSL_PROVIDER_name(const OSSL_PROVIDER *prov);
  51
  52 # ifdef __cplusplus
  53 }
  54 # endif
  55
  56 #endif