provider.h 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. /*
  2. * Copyright 2019-2025 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. #ifndef OPENSSL_PROVIDER_H
  10. #define OPENSSL_PROVIDER_H
  11. #pragma once
  12. #include <openssl/core.h>
  13. #ifdef __cplusplus
  14. extern "C" {
  15. #endif
  16. /* Set and Get a library context search path */
  17. int OSSL_PROVIDER_set_default_search_path(OSSL_LIB_CTX *, const char *path);
  18. const char *OSSL_PROVIDER_get0_default_search_path(OSSL_LIB_CTX *libctx);
  19. /* Load and unload a provider */
  20. OSSL_PROVIDER *OSSL_PROVIDER_load(OSSL_LIB_CTX *, const char *name);
  21. OSSL_PROVIDER *OSSL_PROVIDER_load_ex(OSSL_LIB_CTX *, const char *name,
  22. OSSL_PARAM *params);
  23. OSSL_PROVIDER *OSSL_PROVIDER_try_load(OSSL_LIB_CTX *, const char *name,
  24. int retain_fallbacks);
  25. OSSL_PROVIDER *OSSL_PROVIDER_try_load_ex(OSSL_LIB_CTX *, const char *name,
  26. OSSL_PARAM *params,
  27. int retain_fallbacks);
  28. int OSSL_PROVIDER_unload(OSSL_PROVIDER *prov);
  29. int OSSL_PROVIDER_available(OSSL_LIB_CTX *, const char *name);
  30. int OSSL_PROVIDER_do_all(OSSL_LIB_CTX *ctx,
  31. int (*cb)(OSSL_PROVIDER *provider, void *cbdata),
  32. void *cbdata);
  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. * Provider configuration parameters are normally set in the configuration file,
  42. * but can also be set early in the main program before a provider is in use by
  43. * multiple threads.
  44. *
  45. * Only UTF8-string values are supported.
  46. */
  47. int OSSL_PROVIDER_add_conf_parameter(OSSL_PROVIDER *prov, const char *name,
  48. const char *value);
  49. /*
  50. * Retrieves any of the requested configuration parameters for the given
  51. * provider that were set in the configuration file or via the above
  52. * OSSL_PROVIDER_add_parameter() function.
  53. *
  54. * The |params| array elements MUST have type OSSL_PARAM_UTF8_PTR, values are
  55. * returned by reference, not as copies.
  56. */
  57. int OSSL_PROVIDER_get_conf_parameters(const OSSL_PROVIDER *prov,
  58. OSSL_PARAM params[]);
  59. /*
  60. * Parse a provider configuration parameter as a boolean value,
  61. * or return a default value if unable to retrieve the parameter.
  62. * Values like "1", "yes", "true", ... are true (nonzero).
  63. * Values like "0", "no", "false", ... are false (zero).
  64. */
  65. int OSSL_PROVIDER_conf_get_bool(const OSSL_PROVIDER *prov,
  66. const char *name, int defval);
  67. const OSSL_ALGORITHM *OSSL_PROVIDER_query_operation(const OSSL_PROVIDER *prov,
  68. int operation_id,
  69. int *no_cache);
  70. void OSSL_PROVIDER_unquery_operation(const OSSL_PROVIDER *prov,
  71. int operation_id, const OSSL_ALGORITHM *algs);
  72. void *OSSL_PROVIDER_get0_provider_ctx(const OSSL_PROVIDER *prov);
  73. const OSSL_DISPATCH *OSSL_PROVIDER_get0_dispatch(const OSSL_PROVIDER *prov);
  74. /* Add a built in providers */
  75. int OSSL_PROVIDER_add_builtin(OSSL_LIB_CTX *, const char *name,
  76. OSSL_provider_init_fn *init_fn);
  77. /* Information */
  78. const char *OSSL_PROVIDER_get0_name(const OSSL_PROVIDER *prov);
  79. #ifdef __cplusplus
  80. }
  81. #endif
  82. #endif