diff options
| author | Matt Caswell <matt@openssl.org> | 2020-09-14 17:30:50 +0200 |
|---|---|---|
| committer | Dmitry Belyavskiy <beldmit@gmail.com> | 2020-09-17 10:13:05 +0200 |
| commit | 3f96b687f7d27a32f37f7c6b4fdee45dae685b38 (patch) | |
| tree | a3de688408f02e6a1cf2948c79190311c07bb618 /doc/man3/EVP_PKEY_is_a.pod | |
| parent | Test HMAC output from the dgst CLI (diff) | |
| download | openssl-3f96b687f7d27a32f37f7c6b4fdee45dae685b38.tar.xz openssl-3f96b687f7d27a32f37f7c6b4fdee45dae685b38.zip | |
Document 2 newly added functions
Adds documentation for EVP_PKEY_get0_first_alg_name() and
EVP_KEYMGMT_get0_first_name().
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/12850)
Diffstat (limited to 'doc/man3/EVP_PKEY_is_a.pod')
| -rw-r--r-- | doc/man3/EVP_PKEY_is_a.pod | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/man3/EVP_PKEY_is_a.pod b/doc/man3/EVP_PKEY_is_a.pod index cfce3de5da..efc72ea110 100644 --- a/doc/man3/EVP_PKEY_is_a.pod +++ b/doc/man3/EVP_PKEY_is_a.pod @@ -2,7 +2,7 @@ =head1 NAME -EVP_PKEY_is_a, EVP_PKEY_can_sign +EVP_PKEY_is_a, EVP_PKEY_can_sign, EVP_PKEY_get0_first_alg_name - key type and capabilities functions =head1 SYNOPSIS @@ -11,6 +11,8 @@ EVP_PKEY_is_a, EVP_PKEY_can_sign int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name); int EVP_PKEY_can_sign(const EVP_PKEY *pkey); + const char *EVP_PKEY_get0_first_alg_name(const EVP_PKEY *key); + =head1 DESCRIPTION @@ -20,6 +22,12 @@ EVP_PKEY_can_sign() checks if the functionality for the key type of I<pkey> supports signing. No other check is done, such as whether I<pkey> contains a private key. +EVP_PKEY_get0_first_alg_name() returns the first algorithm name that is found +for the given I<pkey>. Note that the I<pkey> may have multiple synonyms +associated with it. In this case it is undefined which one will be returned. +Ownership of the returned string is retained by the I<pkey> object and should +not be freed by the caller. + =head1 RETURN VALUES EVP_PKEY_is_a() returns 1 if I<pkey> has the key type I<name>, @@ -28,6 +36,8 @@ otherwise 0. EVP_PKEY_can_sign() returns 1 if the I<pkey> key type functionality supports signing, otherwise 0. +EVP_PKEY_get0_first_alg_name() returns the name that is found or NULL on error. + =head1 EXAMPLES =head2 EVP_PKEY_is_a() @@ -60,6 +70,10 @@ this as an crude example: } /* Sign something... */ +=head1 HISTORY + +The functions described here were added in OpenSSL 3.0. + =head1 COPYRIGHT Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. |