1=pod
2
3=head1 NAME
4
5EVP_PKEY_get_field_type, EVP_PKEY_get_ec_point_conv_form - get field type
6or point conversion form of a key
7
8=head1 SYNOPSIS
9
10 #include <openssl/evp.h>
11
12 int EVP_PKEY_get_field_type(const EVP_PKEY *pkey);
13 int EVP_PKEY_get_ec_point_conv_form(const EVP_PKEY *pkey);
14
15=head1 DESCRIPTION
16
17EVP_PKEY_get_field_type() returns the field type NID of the I<pkey>, if
18I<pkey>'s key type supports it. The types currently supported
19by the built-in OpenSSL providers are either B<NID_X9_62_prime_field>
20for prime curves or B<NID_X9_62_characteristic_two_field> for binary curves;
21these values are defined in the F<< <openssl/obj_mac.h> >> header file.
22
23EVP_PKEY_get_ec_point_conv_form() returns the point conversion format
24of the I<pkey>, if I<pkey>'s key type supports it.
25
26=head1 NOTES
27
28Among the standard OpenSSL key types, this is only supported for EC and
29SM2 keys.  Other providers may support this for additional key types.
30
31=head1 RETURN VALUES
32
33EVP_PKEY_get_field_type() returns the field type NID or 0 on error.
34
35EVP_PKEY_get_ec_point_conv_form() returns the point conversion format number
36(see L<EC_GROUP_copy(3)>) or 0 on error.
37
38=head1 SEE ALSO
39
40L<EC_GROUP_copy(3)>
41
42=head1 HISTORY
43
44These functions were added in OpenSSL 3.0.
45
46=head1 COPYRIGHT
47
48Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
49
50Licensed under the Apache License 2.0 (the "License").  You may not use
51this file except in compliance with the License.  You can obtain a copy
52in the file LICENSE in the source distribution or at
53L<https://www.openssl.org/source/license.html>.
54
55=cut
56