1EVP_PKEY_GET_FIELD_TYPE(3ossl)      OpenSSL     EVP_PKEY_GET_FIELD_TYPE(3ossl)
2
3
4

NAME

6       EVP_PKEY_get_field_type, EVP_PKEY_get_ec_point_conv_form - get field
7       type or point conversion form of a key
8

SYNOPSIS

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

DESCRIPTION

16       EVP_PKEY_get_field_type() returns the field type NID of the pkey, if
17       pkey's key type supports it. The types currently supported by the
18       built-in OpenSSL providers are either NID_X9_62_prime_field for prime
19       curves or NID_X9_62_characteristic_two_field for binary curves; these
20       values are defined in the <openssl/obj_mac.h> header file.
21
22       EVP_PKEY_get_ec_point_conv_form() returns the point conversion format
23       of the pkey, if pkey's key type supports it.
24

NOTES

26       Among the standard OpenSSL key types, this is only supported for EC and
27       SM2 keys.  Other providers may support this for additional key types.
28

RETURN VALUES

30       EVP_PKEY_get_field_type() returns the field type NID or 0 on error.
31
32       EVP_PKEY_get_ec_point_conv_form() returns the point conversion format
33       number (see EC_GROUP_copy(3)) or 0 on error.
34

SEE ALSO

36       EC_GROUP_copy(3)
37

HISTORY

39       These functions were added in OpenSSL 3.0.
40

42       Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
43
44       Licensed under the Apache License 2.0 (the "License").  You may not use
45       this file except in compliance with the License.  You can obtain a copy
46       in the file LICENSE in the source distribution or at
47       <https://www.openssl.org/source/license.html>.
48
49
50
513.1.1                             2023-08-31    EVP_PKEY_GET_FIELD_TYPE(3ossl)
Impressum