secure/lib/libcrypto/man/EC_POINT_new.3

   1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  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<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  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
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, 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.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "EC_POINT_new 3"
 136 .TH EC_POINT_new 3 "2016-05-03" "1.0.2h" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 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.
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 2
 146 \& #include <openssl/ec.h>
 147 \& #include <openssl/bn.h>
 148 \&
 149 \& EC_POINT *EC_POINT_new(const EC_GROUP *group);
 150 \& void EC_POINT_free(EC_POINT *point);
 151 \& void EC_POINT_clear_free(EC_POINT *point);
 152 \& int EC_POINT_copy(EC_POINT *dst, const EC_POINT *src);
 153 \& EC_POINT *EC_POINT_dup(const EC_POINT *src, const EC_GROUP *group);
 154 \& const EC_METHOD *EC_POINT_method_of(const EC_POINT *point);
 155 \& int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point);
 156 \& int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
 157 \&        const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *ctx);
 158 \& int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group,
 159 \&        const EC_POINT *p, BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *ctx);
 160 \& int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
 161 \&        const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx);
 162 \& int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,
 163 \&        const EC_POINT *p, BIGNUM *x, BIGNUM *y, BN_CTX *ctx);
 164 \& int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
 165 \&        const BIGNUM *x, int y_bit, BN_CTX *ctx);
 166 \& int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p,
 167 \&        const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx);
 168 \& int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group,
 169 \&        const EC_POINT *p, BIGNUM *x, BIGNUM *y, BN_CTX *ctx);
 170 \& int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p,
 171 \&        const BIGNUM *x, int y_bit, BN_CTX *ctx);
 172 \& size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *p,
 173 \&        point_conversion_form_t form,
 174 \&        unsigned char *buf, size_t len, BN_CTX *ctx);
 175 \& int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *p,
 176 \&        const unsigned char *buf, size_t len, BN_CTX *ctx);
 177 \& BIGNUM *EC_POINT_point2bn(const EC_GROUP *, const EC_POINT *,
 178 \&        point_conversion_form_t form, BIGNUM *, BN_CTX *);
 179 \& EC_POINT *EC_POINT_bn2point(const EC_GROUP *, const BIGNUM *,
 180 \&        EC_POINT *, BN_CTX *);
 181 \& char *EC_POINT_point2hex(const EC_GROUP *, const EC_POINT *,
 182 \&        point_conversion_form_t form, BN_CTX *);
 183 \& EC_POINT *EC_POINT_hex2point(const EC_GROUP *, const char *,
 184 \&        EC_POINT *, BN_CTX *);
 185 .Ve
 186 .SH "DESCRIPTION"
 187 .IX Header "DESCRIPTION"
 188 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
 189 object that the point relates to.
 190 .PP
 191 EC_POINT_free frees the memory associated with the \s-1EC_POINT.\s0
 192 .PP
 193 EC_POINT_clear_free destroys any sensitive data held within the \s-1EC_POINT\s0 and then frees its memory.
 194 .PP
 195 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
 196 .PP
 197 EC_POINT_dup creates a new \s-1EC_POINT\s0 object and copies the content from \fBsrc\fR to the newly created
 198 \&\s-1EC_POINT\s0 object.
 199 .PP
 200 EC_POINT_method_of obtains the \s-1EC_METHOD\s0 associated with \fBpoint\fR.
 201 .PP
 202 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.
 203 .PP
 204 The affine co-ordinates for a point describe a point in terms of its x and y position. The functions
 205 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
 206 \&\fBp\fR defined over the curve given in \fBgroup\fR.
 207 .PP
 208 As well as the affine co-ordinates, a point can alternatively be described in terms of its Jacobian
 209 projective co-ordinates (for Fp curves only). Jacobian projective co-ordinates are expressed as three values x, y and z. Working in
 210 this co-ordinate system provides more efficient point multiplication operations.
 211 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
 212 mapped to (x, y, 1). To set or get the projective co-ordinates use EC_POINT_set_Jprojective_coordinates_GFp and
 213 EC_POINT_get_Jprojective_coordinates_GFp respectively.
 214 .PP
 215 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
 216 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
 217 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
 218 the two possible values for y should be used.
 219 .PP
 220 In addition EC_POINTs can be converted to and from various external
 221 representations. Supported representations are octet strings, BIGNUMs and
 222 hexadecimal. Octet strings are stored in a buffer along with an associated
 223 buffer length. A point held in a \s-1BIGNUM\s0 is calculated by converting the point to
 224 an octet string and then converting that octet string into a \s-1BIGNUM\s0 integer.
 225 Points in hexadecimal format are stored in a \s-1NULL\s0 terminated character string
 226 where each character is one of the printable values 0\-9 or A\-F (or a\-f).
 227 .PP
 228 The functions EC_POINT_point2oct, EC_POINT_oct2point, EC_POINT_point2bn, EC_POINT_bn2point, EC_POINT_point2hex and EC_POINT_hex2point convert
 229 from and to EC_POINTs for the formats: octet string, \s-1BIGNUM\s0 and hexadecimal respectively.
 230 .PP
 231 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
 232 octets stored. Calling the function with a \s-1NULL\s0 buffer will not perform the conversion but will still return the required buffer length.
 233 .PP
 234 The function EC_POINT_point2hex will allocate sufficient memory to store the hexadecimal string. It is the caller's responsibility to free
 235 this memory with a subsequent call to \fIOPENSSL_free()\fR.
 236 .SH "RETURN VALUES"
 237 .IX Header "RETURN VALUES"
 238 EC_POINT_new and EC_POINT_dup return the newly allocated \s-1EC_POINT\s0 or \s-1NULL\s0 on error.
 239 .PP
 240 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,
 241 EC_POINT_get_Jprojective_coordinates_GFp, EC_POINT_set_affine_coordinates_GFp, EC_POINT_get_affine_coordinates_GFp,
 242 EC_POINT_set_compressed_coordinates_GFp, EC_POINT_set_affine_coordinates_GF2m, EC_POINT_get_affine_coordinates_GF2m,
 243 EC_POINT_set_compressed_coordinates_GF2m and EC_POINT_oct2point.
 244 .PP
 245 EC_POINT_method_of returns the \s-1EC_METHOD\s0 associated with the supplied \s-1EC_POINT.\s0
 246 .PP
 247 EC_POINT_point2oct returns the length of the required buffer, or 0 on error.
 248 .PP
 249 EC_POINT_point2bn returns the pointer to the \s-1BIGNUM\s0 supplied, or \s-1NULL\s0 on error.
 250 .PP
 251 EC_POINT_bn2point returns the pointer to the \s-1EC_POINT\s0 supplied, or \s-1NULL\s0 on error.
 252 .PP
 253 EC_POINT_point2hex returns a pointer to the hex string, or \s-1NULL\s0 on error.
 254 .PP
 255 EC_POINT_hex2point returns the pointer to the \s-1EC_POINT\s0 supplied, or \s-1NULL\s0 on error.
 256 .SH "SEE ALSO"
 257 .IX Header "SEE ALSO"
 258 \&\fIcrypto\fR\|(3), \fIec\fR\|(3), \fIEC_GROUP_new\fR\|(3), \fIEC_GROUP_copy\fR\|(3),
 259 \&\fIEC_POINT_add\fR\|(3), \fIEC_KEY_new\fR\|(3),
 260 \&\fIEC_GFp_simple_method\fR\|(3), \fId2i_ECPKParameters\fR\|(3)