doc/man3/EVP_PKEY_asn1_get_count.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_PKEY_asn1_find,
   6 EVP_PKEY_asn1_find_str,
   7 EVP_PKEY_asn1_get_count,
   8 EVP_PKEY_asn1_get0,
   9 EVP_PKEY_asn1_get0_info
  10 - enumerate public key ASN.1 methods
  11
  12 =head1 SYNOPSIS
  13
  14  #include <openssl/evp.h>
  15
  16  int EVP_PKEY_asn1_get_count(void);
  17  const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_get0(int idx);
  18  const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find(ENGINE **pe, int type);
  19  const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find_str(ENGINE **pe,
  20                                                     const char *str, int len);
  21  int EVP_PKEY_asn1_get0_info(int *ppkey_id, int *pkey_base_id,
  22                              int *ppkey_flags, const char **pinfo,
  23                              const char **ppem_str,
  24                              const EVP_PKEY_ASN1_METHOD *ameth);
  25
  26 =head1 DESCRIPTION
  27
  28 EVP_PKEY_asn1_count() returns a count of the number of public key
  29 ASN.1 methods available: it includes standard methods and any methods
  30 added by the application.
  31
  32 EVP_PKEY_asn1_get0() returns the public key ASN.1 method B<idx>.
  33 The value of B<idx> must be between zero and EVP_PKEY_asn1_get_count()
  34 - 1.
  35
  36 EVP_PKEY_asn1_find() looks up the B<EVP_PKEY_ASN1_METHOD> with NID
  37 B<type>.
  38 If B<pe> isn't B<NULL>, then it will look up an engine implementing a
  39 B<EVP_PKEY_ASN1_METHOD> for the NID B<type> and return that instead,
  40 and also set B<*pe> to point at the engine that implements it.
  41
  42 EVP_PKEY_asn1_find_str() looks up the B<EVP_PKEY_ASN1_METHOD> with PEM
  43 type string B<str>.
  44 Just like EVP_PKEY_asn1_find(), if B<pe> isn't B<NULL>, then it will
  45 look up an engine implementing a B<EVP_PKEY_ASN1_METHOD> for the NID
  46 B<type> and return that instead, and also set B<*pe> to point at the
  47 engine that implements it.
  48
  49 EVP_PKEY_asn1_get0_info() returns the public key ID, base public key
  50 ID (both NIDs), any flags, the method description and PEM type string
  51 associated with the public key ASN.1 method B<*ameth>.
  52
  53 EVP_PKEY_asn1_count(), EVP_PKEY_asn1_get0(), EVP_PKEY_asn1_find() and
  54 EVP_PKEY_asn1_find_str() are not thread safe, but as long as all
  55 B<EVP_PKEY_ASN1_METHOD> objects are added before the application gets
  56 threaded, using them is safe.  See L<EVP_PKEY_asn1_add0(3)>.
  57
  58 =head1 RETURN VALUES
  59
  60 EVP_PKEY_asn1_count() returns the number of available public key methods.
  61
  62 EVP_PKEY_asn1_get0() return a public key method or B<NULL> if B<idx> is
  63 out of range.
  64
  65 EVP_PKEY_asn1_get0_info() returns 0 on failure, 1 on success.
  66
  67 =head1 SEE ALSO
  68
  69 L<EVP_PKEY_asn1_new(3)>, L<EVP_PKEY_asn1_add0(3)>
  70
  71 =head1 COPYRIGHT
  72
  73 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
  74
  75 Licensed under the Apache License 2.0 (the "License").  You may not use
  76 this file except in compliance with the License.  You can obtain a copy
  77 in the file LICENSE in the source distribution or at
  78 L<https://www.openssl.org/source/license.html>.
  79
  80 =cut