Unify d2i/i2d documentation.
[openssl.git] / doc / crypto / EC_KEY_get_enc_flags.pod
1 =pod
2
3 =head1 NAME
4
5 EC_KEY_get_enc_flags, EC_KEY_set_enc_flags
6 - Get and set flags for encoding EC_KEY structures
7
8 =head1 SYNOPSIS
9
10  #include <openssl/ec.h>
11
12  unsigned int EC_KEY_get_enc_flags(const EC_KEY *key);
13  void EC_KEY_set_enc_flags(EC_KEY *eckey, unsigned int flags);
14
15 =head1 DESCRIPTION
16
17 The format of the external representation of the public key written by
18 i2d_ECPrivateKey() (such as whether it is stored in a compressed form or not) is
19 described by the point_conversion_form. See L<EC_GROUP_copy(3)>
20 for a description of point_conversion_form.
21
22 When reading a private key encoded without an associated public key (e.g. if
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
26 d2i_ECPrivateKey().
27
28 The functions EC_KEY_get_enc_flags() and EC_KEY_set_enc_flags() get and set the
29 value of the encoding flags for the B<key>. There are two encoding flags
30 currently defined - EC_PKEY_NO_PARAMETERS and EC_PKEY_NO_PUBKEY.  These flags
31 define the behaviour of how the  B<key> is converted into ASN1 in a call to
32 i2d_ECPrivateKey(). If EC_PKEY_NO_PARAMETERS is set then the public parameters for
33 the curve are not encoded along with the private key. If EC_PKEY_NO_PUBKEY is
34 set then the public key is not encoded along with the private key.
35
36 =head1 RETURN VALUES
37
38 EC_KEY_get_enc_flags() returns the value of the current encoding flags for the
39 EC_KEY.
40
41 =head1 SEE ALSO
42
43 L<crypto(3)>, L<ec(3)>, L<EC_GROUP_new(3)>,
44 L<EC_GROUP_copy(3)>, L<EC_POINT_new(3)>,
45 L<EC_POINT_add(3)>,
46 L<EC_GFp_simple_method(3)>,
47 L<d2i_ECPKParameters(3)>,
48 L<d2i_ECPrivateKey(3)>
49
50 =head1 COPYRIGHT
51
52 Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
53
54 Licensed under the OpenSSL license (the "License").  You may not use
55 this file except in compliance with the License.  You can obtain a copy
56 in the file LICENSE in the source distribution or at
57 L<https://www.openssl.org/source/license.html>.
58
59 =cut