1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
60 . tm Index:\\$1\t\\n%\t"\\$2"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "EC_POINT_new 3"
132 .TH EC_POINT_new 3 "2017-01-26" "1.0.2k" "OpenSSL"
133 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
138 EC_POINT_new, EC_POINT_free, EC_POINT_clear_free, EC_POINT_copy, EC_POINT_dup, EC_POINT_method_of, EC_POINT_set_to_infinity, EC_POINT_set_Jprojective_coordinates, EC_POINT_get_Jprojective_coordinates_GFp, EC_POINT_set_affine_coordinates_GFp, EC_POINT_get_affine_coordinates_GFp, EC_POINT_set_compressed_coordinates_GFp, EC_POINT_set_affine_coordinates_GF2m, EC_POINT_get_affine_coordinates_GF2m, EC_POINT_set_compressed_coordinates_GF2m, EC_POINT_point2oct, EC_POINT_oct2point, EC_POINT_point2bn, EC_POINT_bn2point, EC_POINT_point2hex, EC_POINT_hex2point \- Functions for creating, destroying and manipulating EC_POINT objects.
140 .IX Header "SYNOPSIS"
142 \& #include <openssl/ec.h>
143 \& #include <openssl/bn.h>
145 \& EC_POINT *EC_POINT_new(const EC_GROUP *group);
146 \& void EC_POINT_free(EC_POINT *point);
147 \& void EC_POINT_clear_free(EC_POINT *point);
148 \& int EC_POINT_copy(EC_POINT *dst, const EC_POINT *src);
149 \& EC_POINT *EC_POINT_dup(const EC_POINT *src, const EC_GROUP *group);
150 \& const EC_METHOD *EC_POINT_method_of(const EC_POINT *point);
151 \& int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point);
152 \& int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
153 \& const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *ctx);
154 \& int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group,
155 \& const EC_POINT *p, BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *ctx);
156 \& int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
157 \& const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx);
158 \& int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,
159 \& const EC_POINT *p, BIGNUM *x, BIGNUM *y, BN_CTX *ctx);
160 \& int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
161 \& const BIGNUM *x, int y_bit, BN_CTX *ctx);
162 \& int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p,
163 \& const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx);
164 \& int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group,
165 \& const EC_POINT *p, BIGNUM *x, BIGNUM *y, BN_CTX *ctx);
166 \& int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p,
167 \& const BIGNUM *x, int y_bit, BN_CTX *ctx);
168 \& size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *p,
169 \& point_conversion_form_t form,
170 \& unsigned char *buf, size_t len, BN_CTX *ctx);
171 \& int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *p,
172 \& const unsigned char *buf, size_t len, BN_CTX *ctx);
173 \& BIGNUM *EC_POINT_point2bn(const EC_GROUP *, const EC_POINT *,
174 \& point_conversion_form_t form, BIGNUM *, BN_CTX *);
175 \& EC_POINT *EC_POINT_bn2point(const EC_GROUP *, const BIGNUM *,
176 \& EC_POINT *, BN_CTX *);
177 \& char *EC_POINT_point2hex(const EC_GROUP *, const EC_POINT *,
178 \& point_conversion_form_t form, BN_CTX *);
179 \& EC_POINT *EC_POINT_hex2point(const EC_GROUP *, const char *,
180 \& EC_POINT *, BN_CTX *);
183 .IX Header "DESCRIPTION"
184 An \s-1EC_POINT\s0 represents a point on a curve. A new point is constructed by calling the function EC_POINT_new and providing the \fBgroup\fR
185 object that the point relates to.
187 EC_POINT_free frees the memory associated with the \s-1EC_POINT.\s0
189 EC_POINT_clear_free destroys any sensitive data held within the \s-1EC_POINT\s0 and then frees its memory.
191 EC_POINT_copy copies the point \fBsrc\fR into \fBdst\fR. Both \fBsrc\fR and \fBdst\fR must use the same \s-1EC_METHOD.\s0
193 EC_POINT_dup creates a new \s-1EC_POINT\s0 object and copies the content from \fBsrc\fR to the newly created
194 \&\s-1EC_POINT\s0 object.
196 EC_POINT_method_of obtains the \s-1EC_METHOD\s0 associated with \fBpoint\fR.
198 A valid point on a curve is the special point at infinity. A point is set to be at infinity by calling EC_POINT_set_to_infinity.
200 The affine co-ordinates for a point describe a point in terms of its x and y position. The functions
201 EC_POINT_set_affine_coordinates_GFp and EC_POINT_set_affine_coordinates_GF2m set the \fBx\fR and \fBy\fR co-ordinates for the point
202 \&\fBp\fR defined over the curve given in \fBgroup\fR.
204 As well as the affine co-ordinates, a point can alternatively be described in terms of its Jacobian
205 projective co-ordinates (for Fp curves only). Jacobian projective co-ordinates are expressed as three values x, y and z. Working in
206 this co-ordinate system provides more efficient point multiplication operations.
207 A mapping exists between Jacobian projective co-ordinates and affine co-ordinates. A Jacobian projective co-ordinate (x, y, z) can be written as an affine co-ordinate as (x/(z^2), y/(z^3)). Conversion to Jacobian projective to affine co-ordinates is simple. The co-ordinate (x, y) is
208 mapped to (x, y, 1). To set or get the projective co-ordinates use EC_POINT_set_Jprojective_coordinates_GFp and
209 EC_POINT_get_Jprojective_coordinates_GFp respectively.
211 Points can also be described in terms of their compressed co-ordinates. For a point (x, y), for any given value for x such that the point is
212 on the curve there will only ever be two possible values for y. Therefore a point can be set using the EC_POINT_set_compressed_coordinates_GFp
213 and EC_POINT_set_compressed_coordinates_GF2m functions where \fBx\fR is the x co-ordinate and \fBy_bit\fR is a value 0 or 1 to identify which of
214 the two possible values for y should be used.
216 In addition EC_POINTs can be converted to and from various external
217 representations. Supported representations are octet strings, BIGNUMs and
218 hexadecimal. Octet strings are stored in a buffer along with an associated
219 buffer length. A point held in a \s-1BIGNUM\s0 is calculated by converting the point to
220 an octet string and then converting that octet string into a \s-1BIGNUM\s0 integer.
221 Points in hexadecimal format are stored in a \s-1NULL\s0 terminated character string
222 where each character is one of the printable values 0\-9 or A\-F (or a\-f).
224 The functions EC_POINT_point2oct, EC_POINT_oct2point, EC_POINT_point2bn, EC_POINT_bn2point, EC_POINT_point2hex and EC_POINT_hex2point convert
225 from and to EC_POINTs for the formats: octet string, \s-1BIGNUM\s0 and hexadecimal respectively.
227 The function EC_POINT_point2oct must be supplied with a buffer long enough to store the octet string. The return value provides the number of
228 octets stored. Calling the function with a \s-1NULL\s0 buffer will not perform the conversion but will still return the required buffer length.
230 The function EC_POINT_point2hex will allocate sufficient memory to store the hexadecimal string. It is the caller's responsibility to free
231 this memory with a subsequent call to \fIOPENSSL_free()\fR.
233 .IX Header "RETURN VALUES"
234 EC_POINT_new and EC_POINT_dup return the newly allocated \s-1EC_POINT\s0 or \s-1NULL\s0 on error.
236 The following functions return 1 on success or 0 on error: EC_POINT_copy, EC_POINT_set_to_infinity, EC_POINT_set_Jprojective_coordinates_GFp,
237 EC_POINT_get_Jprojective_coordinates_GFp, EC_POINT_set_affine_coordinates_GFp, EC_POINT_get_affine_coordinates_GFp,
238 EC_POINT_set_compressed_coordinates_GFp, EC_POINT_set_affine_coordinates_GF2m, EC_POINT_get_affine_coordinates_GF2m,
239 EC_POINT_set_compressed_coordinates_GF2m and EC_POINT_oct2point.
241 EC_POINT_method_of returns the \s-1EC_METHOD\s0 associated with the supplied \s-1EC_POINT.\s0
243 EC_POINT_point2oct returns the length of the required buffer, or 0 on error.
245 EC_POINT_point2bn returns the pointer to the \s-1BIGNUM\s0 supplied, or \s-1NULL\s0 on error.
247 EC_POINT_bn2point returns the pointer to the \s-1EC_POINT\s0 supplied, or \s-1NULL\s0 on error.
249 EC_POINT_point2hex returns a pointer to the hex string, or \s-1NULL\s0 on error.
251 EC_POINT_hex2point returns the pointer to the \s-1EC_POINT\s0 supplied, or \s-1NULL\s0 on error.
253 .IX Header "SEE ALSO"
254 \&\fIcrypto\fR\|(3), \fIec\fR\|(3), \fIEC_GROUP_new\fR\|(3), \fIEC_GROUP_copy\fR\|(3),
255 \&\fIEC_POINT_add\fR\|(3), \fIEC_KEY_new\fR\|(3),
256 \&\fIEC_GFp_simple_method\fR\|(3), \fId2i_ECPKParameters\fR\|(3)