doc/man3/EVP_ASYM_CIPHER_free.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_ASYM_CIPHER_fetch, EVP_ASYM_CIPHER_free, EVP_ASYM_CIPHER_up_ref,
   6 EVP_ASYM_CIPHER_is_a, EVP_ASYM_CIPHER_get0_provider,
   7 EVP_ASYM_CIPHER_do_all_provided, EVP_ASYM_CIPHER_names_do_all,
   8 EVP_ASYM_CIPHER_get0_name, EVP_ASYM_CIPHER_get0_description,
   9 EVP_ASYM_CIPHER_gettable_ctx_params, EVP_ASYM_CIPHER_settable_ctx_params
  10 - Functions to manage EVP_ASYM_CIPHER algorithm objects
  11
  12 =head1 SYNOPSIS
  13
  14  #include <openssl/evp.h>
  15
  16  EVP_ASYM_CIPHER *EVP_ASYM_CIPHER_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
  17                                         const char *properties);
  18  void EVP_ASYM_CIPHER_free(EVP_ASYM_CIPHER *cipher);
  19  int EVP_ASYM_CIPHER_up_ref(EVP_ASYM_CIPHER *cipher);
  20  const char *EVP_ASYM_CIPHER_get0_name(const EVP_ASYM_CIPHER *cipher);
  21  int EVP_ASYM_CIPHER_is_a(const EVP_ASYM_CIPHER *cipher, const char *name);
  22  OSSL_PROVIDER *EVP_ASYM_CIPHER_get0_provider(const EVP_ASYM_CIPHER *cipher);
  23  void EVP_ASYM_CIPHER_do_all_provided(OSSL_LIB_CTX *libctx,
  24                                       void (*fn)(EVP_ASYM_CIPHER *cipher,
  25                                                  void *arg),
  26                                       void *arg);
  27  int EVP_ASYM_CIPHER_names_do_all(const EVP_ASYM_CIPHER *cipher,
  28                                   void (*fn)(const char *name, void *data),
  29                                   void *data);
  30  const char *EVP_ASYM_CIPHER_get0_description(const EVP_ASYM_CIPHER *cipher);
  31  const OSSL_PARAM *EVP_ASYM_CIPHER_gettable_ctx_params(const EVP_ASYM_CIPHER *cip);
  32  const OSSL_PARAM *EVP_ASYM_CIPHER_settable_ctx_params(const EVP_ASYM_CIPHER *cip);
  33
  34 =head1 DESCRIPTION
  35
  36 EVP_ASYM_CIPHER_fetch() fetches the implementation for the given
  37 B<algorithm> from any provider offering it, within the criteria given
  38 by the B<properties> and in the scope of the given library context B<ctx> (see
  39 L<OSSL_LIB_CTX(3)>). The algorithm will be one offering functions for performing
  40 asymmetric cipher related tasks such as asymmetric encryption and decryption.
  41 See L<crypto(7)/ALGORITHM FETCHING> for further information.
  42
  43 The returned value must eventually be freed with EVP_ASYM_CIPHER_free().
  44
  45 EVP_ASYM_CIPHER_free() decrements the reference count for the B<EVP_ASYM_CIPHER>
  46 structure. Typically this structure will have been obtained from an earlier call
  47 to EVP_ASYM_CIPHER_fetch(). If the reference count drops to 0 then the
  48 structure is freed.
  49
  50 EVP_ASYM_CIPHER_up_ref() increments the reference count for an
  51 B<EVP_ASYM_CIPHER> structure.
  52
  53 EVP_ASYM_CIPHER_is_a() returns 1 if I<cipher> is an implementation of an
  54 algorithm that's identifiable with I<name>, otherwise 0.
  55
  56 EVP_ASYM_CIPHER_get0_provider() returns the provider that I<cipher> was
  57 fetched from.
  58
  59 EVP_ASYM_CIPHER_do_all_provided() traverses all EVP_ASYM_CIPHERs implemented by
  60 all activated providers in the given library context I<libctx>, and for each of
  61 the implementations, calls the given function I<fn> with the implementation
  62 method and the given I<arg> as argument.
  63
  64 EVP_ASYM_CIPHER_get0_name() returns the algorithm name from the provided
  65 implementation for the given I<cipher>. Note that the I<cipher> may have
  66 multiple synonyms associated with it. In this case the first name from the
  67 algorithm definition is returned. Ownership of the returned string is retained
  68 by the I<cipher> object and should not be freed by the caller.
  69
  70 EVP_ASYM_CIPHER_names_do_all() traverses all names for I<cipher>, and calls
  71 I<fn> with each name and I<data>.
  72
  73 EVP_ASYM_CIPHER_get0_description() returns a description of the I<cipher>,
  74 meant for display and human consumption.  The description is at the
  75 discretion of the I<cipher> implementation.
  76
  77 EVP_ASYM_CIPHER_gettable_ctx_params() and EVP_ASYM_CIPHER_settable_ctx_params()
  78 return a constant L<OSSL_PARAM(3)> array that describes the names and types of key
  79 parameters that can be retrieved or set by a key encryption algorithm using
  80 L<EVP_PKEY_CTX_get_params(3)> and L<EVP_PKEY_CTX_set_params(3)>.
  81
  82 =head1 RETURN VALUES
  83
  84 EVP_ASYM_CIPHER_fetch() returns a pointer to an B<EVP_ASYM_CIPHER> for success
  85 or B<NULL> for failure.
  86
  87 EVP_ASYM_CIPHER_up_ref() returns 1 for success or 0 otherwise.
  88
  89 EVP_ASYM_CIPHER_names_do_all() returns 1 if the callback was called for all
  90 names. A return value of 0 means that the callback was not called for any names.
  91
  92 EVP_ASYM_CIPHER_gettable_ctx_params() and EVP_ASYM_CIPHER_settable_ctx_params()
  93 return a constant L<OSSL_PARAM(3)> array or NULL on error.
  94
  95 =head1 SEE ALSO
  96
  97 L<crypto(7)/ALGORITHM FETCHING>, L<OSSL_PROVIDER(3)>
  98
  99 =head1 HISTORY
 100
 101 The functions described here were added in OpenSSL 3.0.
 102
 103 =head1 COPYRIGHT
 104
 105 Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
 106
 107 Licensed under the Apache License 2.0 (the "License").  You may not use
 108 this file except in compliance with the License.  You can obtain a copy
 109 in the file LICENSE in the source distribution or at
 110 L<https://www.openssl.org/source/license.html>.
 111
 112 =cut