EC_KEY_get_enc_flags.pod 2.0 KB
Newer Older
1 2 3 4
=pod

=head1 NAME

R
Rich Salz 已提交
5 6
EC_KEY_get_enc_flags, EC_KEY_set_enc_flags
- Get and set flags for encoding EC_KEY structures
7 8 9 10 11 12 13 14 15 16 17

=head1 SYNOPSIS

 #include <openssl/ec.h>

 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key);
 void EC_KEY_set_enc_flags(EC_KEY *eckey, unsigned int flags);

=head1 DESCRIPTION

The format of the external representation of the public key written by
R
Rich Salz 已提交
18
i2d_ECPrivateKey() (such as whether it is stored in a compressed form or not) is
R
Rich Salz 已提交
19
described by the point_conversion_form. See L<EC_GROUP_copy(3)>
20 21 22
for a description of point_conversion_form.

When reading a private key encoded without an associated public key (e.g. if
R
Rich Salz 已提交
23
EC_PKEY_NO_PUBKEY has been used - see below), then d2i_ECPrivateKey() generates
24
the missing public key automatically. Private keys encoded without parameters
25
(e.g. if EC_PKEY_NO_PARAMETERS has been used - see below) cannot be loaded using
R
Rich Salz 已提交
26
d2i_ECPrivateKey().
27

R
Rich Salz 已提交
28
The functions EC_KEY_get_enc_flags() and EC_KEY_set_enc_flags() get and set the
29 30 31
value of the encoding flags for the B<key>. There are two encoding flags
currently defined - EC_PKEY_NO_PARAMETERS and EC_PKEY_NO_PUBKEY.  These flags
define the behaviour of how the  B<key> is converted into ASN1 in a call to
R
Rich Salz 已提交
32
i2d_ECPrivateKey(). If EC_PKEY_NO_PARAMETERS is set then the public parameters for
33 34 35 36 37
the curve are not encoded along with the private key. If EC_PKEY_NO_PUBKEY is
set then the public key is not encoded along with the private key.

=head1 RETURN VALUES

R
Rich Salz 已提交
38
EC_KEY_get_enc_flags() returns the value of the current encoding flags for the
39 40 41 42
EC_KEY.

=head1 SEE ALSO

R
Rich Salz 已提交
43
L<crypto(7)>, L<EC_GROUP_new(3)>,
R
Rich Salz 已提交
44 45 46 47 48
L<EC_GROUP_copy(3)>, L<EC_POINT_new(3)>,
L<EC_POINT_add(3)>,
L<EC_GFp_simple_method(3)>,
L<d2i_ECPKParameters(3)>,
L<d2i_ECPrivateKey(3)>
49

R
Rich Salz 已提交
50 51
=head1 COPYRIGHT

R
Rich Salz 已提交
52
Copyright 2015-2017 The OpenSSL Project Authors. All Rights Reserved.
R
Rich Salz 已提交
53 54 55 56 57 58 59

Licensed under the OpenSSL license (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<https://www.openssl.org/source/license.html>.

=cut