Debian Codegraph @

upstream/debian-unstable/man3/EC_KEY_get_enc_flags.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EC_KEY_GET_ENC_FLAGS 3SSL"
58 .TH EC_KEY_GET_ENC_FLAGS 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EC_KEY_get_enc_flags, EC_KEY_set_enc_flags
65 \&\- Get and set flags for encoding EC_KEY structures
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/ec.h>
70 \&
71 \& unsigned int EC_KEY_get_enc_flags(const EC_KEY *key);
72 \& void EC_KEY_set_enc_flags(EC_KEY *eckey, unsigned int flags);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 The format of the external representation of the public key written by
77 \&\fBi2d_ECPrivateKey()\fR (such as whether it is stored in a compressed form or not) is
78 described by the point_conversion_form. See \fBEC_GROUP_copy\fR\|(3)
79 for a description of point_conversion_form.
80 .PP
81 When reading a private key encoded without an associated public key (e.g. if
82 EC_PKEY_NO_PUBKEY has been used \- see below), then \fBd2i_ECPrivateKey()\fR generates
83 the missing public key automatically. Private keys encoded without parameters
84 (e.g. if EC_PKEY_NO_PARAMETERS has been used \- see below) cannot be loaded using
85 \&\fBd2i_ECPrivateKey()\fR.
86 .PP
87 The functions \fBEC_KEY_get_enc_flags()\fR and \fBEC_KEY_set_enc_flags()\fR get and set the
88 value of the encoding flags for the \fBkey\fR. There are two encoding flags
89 currently defined \- EC_PKEY_NO_PARAMETERS and EC_PKEY_NO_PUBKEY. These flags
90 define the behaviour of how the \fBkey\fR is converted into ASN1 in a call to
91 \&\fBi2d_ECPrivateKey()\fR. If EC_PKEY_NO_PARAMETERS is set then the public parameters for
92 the curve are not encoded along with the private key. If EC_PKEY_NO_PUBKEY is
93 set then the public key is not encoded along with the private key.
94 .SH "RETURN VALUES"
95 .IX Header "RETURN VALUES"
96 \&\fBEC_KEY_get_enc_flags()\fR returns the value of the current encoding flags for the
97 EC_KEY.
98 .SH "SEE ALSO"
99 .IX Header "SEE ALSO"
100 \&\fBcrypto\fR\|(7), \fBEC_GROUP_new\fR\|(3),
101 \&\fBEC_GROUP_copy\fR\|(3), \fBEC_POINT_new\fR\|(3),
102 \&\fBEC_POINT_add\fR\|(3),
103 \&\fBEC_GFp_simple_method\fR\|(3),
104 \&\fBd2i_ECPKParameters\fR\|(3),
105 \&\fBd2i_ECPrivateKey\fR\|(3)
106 .SH COPYRIGHT
107 .IX Header "COPYRIGHT"
108 Copyright 2015\-2017 The OpenSSL Project Authors. All Rights Reserved.
109 .PP
110 Licensed under the Apache License 2.0 (the "License"). You may not use
111 this file except in compliance with the License. You can obtain a copy
112 in the file LICENSE in the source distribution or at
113 <https://www.openssl.org/source/license.html>.