doc/man3/EVP_PKEY_meth_get_count.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_PKEY_meth_get_count, EVP_PKEY_meth_get0, EVP_PKEY_meth_get0_info - enumerate public key methods
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/evp.h>
  10
  11 The following functions have been deprecated since OpenSSL 3.0, and can be
  12 hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
  13 see L<openssl_user_macros(7)>:
  14
  15  size_t EVP_PKEY_meth_get_count(void);
  16  const EVP_PKEY_METHOD *EVP_PKEY_meth_get0(size_t idx);
  17  void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
  18                               const EVP_PKEY_METHOD *meth);
  19
  20 =head1 DESCRIPTION
  21
  22 All of the functions described on this page are deprecated.
  23 Applications should instead use the OSSL_PROVIDER APIs.
  24
  25 EVP_PKEY_meth_count() returns a count of the number of public key methods
  26 available: it includes standard methods and any methods added by the
  27 application.
  28
  29 EVP_PKEY_meth_get0() returns the public key method B<idx>. The value of B<idx>
  30 must be between zero and EVP_PKEY_meth_get_count() - 1.
  31
  32 EVP_PKEY_meth_get0_info() returns the public key ID (a NID) and any flags
  33 associated with the public key method B<*meth>.
  34
  35 =head1 RETURN VALUES
  36
  37 EVP_PKEY_meth_count() returns the number of available public key methods.
  38
  39 EVP_PKEY_meth_get0() return a public key method or B<NULL> if B<idx> is
  40 out of range.
  41
  42 EVP_PKEY_meth_get0_info() does not return a value.
  43
  44 =head1 SEE ALSO
  45
  46 L<EVP_PKEY_new(3)>
  47
  48 =head1 HISTORY
  49
  50 All of these functions were deprecated in OpenSSL 3.0.
  51
  52 =head1 COPYRIGHT
  53
  54 Copyright 2002-2020 The OpenSSL Project Authors. All Rights Reserved.
  55
  56 Licensed under the Apache License 2.0 (the "License").  You may not use
  57 this file except in compliance with the License.  You can obtain a copy
  58 in the file LICENSE in the source distribution or at
  59 L<https://www.openssl.org/source/license.html>.
  60
  61 =cut