doc/man3/EVP_PKEY_is_a.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_PKEY_is_a, EVP_PKEY_can_sign, EVP_PKEY_typenames_do_all,
   6 EVP_PKEY_get0_first_alg_name
   7 - key type and capabilities functions
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/evp.h>
  12
  13  int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name);
  14  int EVP_PKEY_can_sign(const EVP_PKEY *pkey);
  15  void EVP_PKEY_typenames_do_all(const EVP_PKEY *pkey,
  16                                 void (*fn)(const char *name, void *data),
  17                                 void *data);
  18  const char *EVP_PKEY_get0_first_alg_name(const EVP_PKEY *key);
  19
  20 =head1 DESCRIPTION
  21
  22 EVP_PKEY_is_a() checks if the key type of I<pkey> is I<name>.
  23
  24 EVP_PKEY_can_sign() checks if the functionality for the key type of
  25 I<pkey> supports signing.  No other check is done, such as whether
  26 I<pkey> contains a private key.
  27
  28 EVP_PKEY_typenames_do_all() traverses all names for I<pkey>'s key type, and
  29 calls I<fn> with each name and I<data>.  For example, an RSA B<EVP_PKEY> may
  30 be named both C<RSA> and C<rsaEncryption>.
  31 The order of the names is undefined.
  32
  33 EVP_PKEY_get0_first_alg_name() returns the first algorithm name that is found
  34 for the given I<pkey>. Note that the I<pkey> may have multiple synonyms
  35 associated with it. In this case it is undefined which one will be returned.
  36 Ownership of the returned string is retained by the I<pkey> object and should
  37 not be freed by the caller.
  38
  39 =head1 RETURN VALUES
  40
  41 EVP_PKEY_is_a() returns 1 if I<pkey> has the key type I<name>,
  42 otherwise 0.
  43
  44 EVP_PKEY_can_sign() returns 1 if the I<pkey> key type functionality
  45 supports signing, otherwise 0.
  46
  47 EVP_PKEY_get0_first_alg_name() returns the name that is found or NULL on error.
  48
  49 =head1 EXAMPLES
  50
  51 =head2 EVP_PKEY_is_a()
  52
  53 The loaded providers and what key types they support will ultimately
  54 determine what I<name> is possible to use with EVP_PKEY_is_a().  We do know
  55 that the default provider supports RSA, DH, DSA and EC keys, so we can use
  56 this as an crude example:
  57
  58  #include <openssl/evp.h>
  59
  60  ...
  61      /* |pkey| is an EVP_PKEY* */
  62      if (EVP_PKEY_is_a(pkey, "RSA")) {
  63          BIGNUM *modulus = NULL;
  64          if (EVP_PKEY_get_bn_param(pkey, "n", &modulus))
  65              /* do whatever with the modulus */
  66          BN_free(modulus);
  67      }
  68
  69 =head2 EVP_PKEY_can_sign()
  70
  71  #include <openssl/evp.h>
  72
  73  ...
  74      /* |pkey| is an EVP_PKEY* */
  75      if (!EVP_PKEY_can_sign(pkey)) {
  76          fprintf(stderr, "Not a signing key!");
  77          exit(1);
  78      }
  79      /* Sign something... */
  80
  81 =head1 HISTORY
  82
  83 The functions described here were added in OpenSSL 3.0.
  84
  85 =head1 COPYRIGHT
  86
  87 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
  88
  89 Licensed under the Apache License 2.0 (the "License").  You may not use
  90 this file except in compliance with the License.  You can obtain a copy
  91 in the file LICENSE in the source distribution or at
  92 L<https://www.openssl.org/source/license.html>.
  93
  94 =cut