From 36fafb2e80dd178309ff4d271c4c8c9bafb2d87c Mon Sep 17 00:00:00 2001 From: Tomas Mraz Date: Wed, 20 Jan 2021 15:35:50 +0100 Subject: [PATCH] Add manpage for EVP_PKEY_get_field_type and EVP_PKEY_get_point_conv_form Reviewed-by: Matt Caswell (Merged from https://github.com/openssl/openssl/pull/13139) --- doc/man3/EVP_PKEY_get_field_type.pod | 55 ++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 doc/man3/EVP_PKEY_get_field_type.pod diff --git a/doc/man3/EVP_PKEY_get_field_type.pod b/doc/man3/EVP_PKEY_get_field_type.pod new file mode 100644 index 00000000000..e32fa7290c1 --- /dev/null +++ b/doc/man3/EVP_PKEY_get_field_type.pod @@ -0,0 +1,55 @@ +=pod + +=head1 NAME + +EVP_PKEY_get_field_type, EVP_PKEY_get_ec_point_conv_form - get field type +or point conversion form of a key + +=head1 SYNOPSIS + + #include + + int EVP_PKEY_get_field_type(const EVP_PKEY *pkey); + int EVP_PKEY_get_ec_point_conv_form(const EVP_PKEY *pkey); + +=head1 DESCRIPTION + +EVP_PKEY_get_field_type() returns the field type NID of the I, if +I's key type supports it. The types currently supported +by the built-in OpenSSL providers are either B +for prime curves or B for binary curves; +these values are defined in the F<< >> header file. + +EVP_PKEY_get_ec_point_conv_form() returns the point conversion format +of the I, if I's key type supports it. + +=head1 NOTES + +Among the standard OpenSSL key types, this is only supported for EC and +SM2 keys. Other providers may support this for additional key types. + +=head1 RETURN VALUES + +EVP_PKEY_get_field_type() returns the field type NID or 0 on error. + +EVP_PKEY_get_ec_point_conv_form() returns the point conversion format number +(see L) or 0 on error. + +=head1 SEE ALSO + +L + +=head1 HISTORY + +These functions were added in OpenSSL 3.0. + +=head1 COPYRIGHT + +Copyright 2021 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut -- 2.47.2