10 - EVP key management routines
14 #include <openssl/evp.h>
16 typedef struct evp_keymgmt_st EVP_KEYMGMT;
18 EVP_KEYMGMT *EVP_KEYMGMT_fetch(OPENSSL_CTX *ctx, const char *algorithm,
19 const char *properties);
20 int EVP_KEYMGMT_up_ref(EVP_KEYMGMT *keymgmt);
21 void EVP_KEYMGMT_free(EVP_KEYMGMT *keymgmt);
22 const OSSL_PROVIDER *EVP_KEYMGMT_provider(const EVP_KEYMGMT *keymgmt);
26 B<EVP_KEYMGMT> is a method object that represents key management
27 implementations for different cryptographic algorithms.
28 This method object provides functionality to have providers import key
29 material from the outside, as well as export key material to the
31 Most of the functionality can only be used internally and has no
32 public interface, this object is simply passed into other functions
35 EVP_KEYMGMT_fetch() looks for an algorithm within the provider that
36 has been loaded into the B<OPENSSL_CTX> given by I<ctx>, having the
37 name given by I<algorithm> and the properties given by I<properties>.
39 EVP_KEYMGMT_up_ref() increments the reference count for the given
40 B<EVP_KEYMGMT> I<keymgmt>.
42 EVP_KEYMGMT_free() decrements the reference count for the given
43 B<EVP_KEYMGMT> I<keymgmt>, and when the count reaches zero, frees it.
45 EVP_KEYMGMT_provider() returns the provider that has this particular
50 EVP_KEYMGMT_fetch() may be called implicitly by other fetching
51 functions, using the same library context and properties.
52 Any other API that uses keys will typically do this.
56 EVP_KEYMGMT_fetch() returns a pointer to the key management
57 implementation represented by an EVP_KEYMGMT object, or NULL on
60 EVP_KEYMGMT_up_ref() returns 1 on success, or 0 on error.
62 EVP_KEYMGMT_free() doesn't return any value.
64 EVP_KEYMGMT_provider() returns a pointer to a provider object, or NULL
69 L<EVP_MD_fetch(3)>, L<OPENSSL_CTX(3)>
73 The functions described here were added in OpenSSL 3.0.
77 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
79 Licensed under the Apache License 2.0 (the "License"). You may not use
80 this file except in compliance with the License. You can obtain a copy
81 in the file LICENSE in the source distribution or at
82 L<https://www.openssl.org/source/license.html>.