doc/man3/EVP_KEYMGMT.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_KEYMGMT,
   6 EVP_KEYMGMT_fetch,
   7 EVP_KEYMGMT_up_ref,
   8 EVP_KEYMGMT_free,
   9 EVP_KEYMGMT_provider,
  10 EVP_KEYMGMT_is_a,
  11 EVP_KEYMGMT_do_all_provided,
  12 - EVP key management routines
  13
  14 =head1 SYNOPSIS
  15
  16  #include <openssl/evp.h>
  17
  18  typedef struct evp_keymgmt_st EVP_KEYMGMT;
  19
  20  EVP_KEYMGMT *EVP_KEYMGMT_fetch(OPENSSL_CTX *ctx, const char *algorithm,
  21                                 const char *properties);
  22  int EVP_KEYMGMT_up_ref(EVP_KEYMGMT *keymgmt);
  23  void EVP_KEYMGMT_free(EVP_KEYMGMT *keymgmt);
  24  const OSSL_PROVIDER *EVP_KEYMGMT_provider(const EVP_KEYMGMT *keymgmt);
  25  int EVP_KEYMGMT_is_a(const EVP_KEYMGMT *keymgmt, const char *name);
  26  void EVP_KEYMGMT_do_all_provided(OPENSSL_CTX *libctx,
  27                                   void (*fn)(EVP_KEYMGMT *keymgmt, void *arg),
  28                                   void *arg);
  29
  30 =head1 DESCRIPTION
  31
  32 B<EVP_KEYMGMT> is a method object that represents key management
  33 implementations for different cryptographic algorithms.
  34 This method object provides functionality to have providers import key
  35 material from the outside, as well as export key material to the
  36 outside.
  37 Most of the functionality can only be used internally and has no
  38 public interface, this object is simply passed into other functions
  39 when needed.
  40
  41 EVP_KEYMGMT_fetch() looks for an algorithm within the provider that
  42 has been loaded into the B<OPENSSL_CTX> given by I<ctx>, having the
  43 name given by I<algorithm> and the properties given by I<properties>.
  44
  45 EVP_KEYMGMT_up_ref() increments the reference count for the given
  46 B<EVP_KEYMGMT> I<keymgmt>.
  47
  48 EVP_KEYMGMT_free() decrements the reference count for the given
  49 B<EVP_KEYMGMT> I<keymgmt>, and when the count reaches zero, frees it.
  50
  51 EVP_KEYMGMT_provider() returns the provider that has this particular
  52 implementation.
  53
  54 EVP_KEYMGMT_is_a() checks if I<keymgmt> is an implementation of an
  55 algorithm that's identifiable with I<name>.
  56
  57 EVP_KEYMGMT_do_all_provided() traverses all key keymgmt implementations by
  58 all activated providers in the library context I<libctx>, and for each
  59 of the implementations, calls I<fn> with the implementation method and
  60 I<data> as arguments.
  61
  62 =head1 NOTES
  63
  64 EVP_KEYMGMT_fetch() may be called implicitly by other fetching
  65 functions, using the same library context and properties.
  66 Any other API that uses keys will typically do this.
  67
  68 =head1 RETURN VALUES
  69
  70 EVP_KEYMGMT_fetch() returns a pointer to the key management
  71 implementation represented by an EVP_KEYMGMT object, or NULL on
  72 error.
  73
  74 EVP_KEYMGMT_up_ref() returns 1 on success, or 0 on error.
  75
  76 EVP_KEYMGMT_free() doesn't return any value.
  77
  78 EVP_KEYMGMT_provider() returns a pointer to a provider object, or NULL
  79 on error.
  80
  81 EVP_KEYMGMT_is_a() returns 1 of I<keymgmt> was identifiable,
  82 otherwise 0.
  83
  84 =head1 SEE ALSO
  85
  86 L<EVP_MD_fetch(3)>, L<OPENSSL_CTX(3)>
  87
  88 =head1 HISTORY
  89
  90 The functions described here were added in OpenSSL 3.0.
  91
  92 =head1 COPYRIGHT
  93
  94 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
  95
  96 Licensed under the Apache License 2.0 (the "License").  You may not use
  97 this file except in compliance with the License.  You can obtain a copy
  98 in the file LICENSE in the source distribution or at
  99 L<https://www.openssl.org/source/license.html>.
 100
 101 =cut