doc/crypto/EC_POINT_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EC_POINT_new, EC_POINT_free, EC_POINT_clear_free, EC_POINT_copy, EC_POINT_dup,
   6 EC_POINT_method_of, EC_POINT_set_to_infinity,
   7 EC_POINT_set_Jprojective_coordinates, EC_POINT_get_Jprojective_coordinates_GFp,
   8 EC_POINT_set_affine_coordinates_GFp, EC_POINT_get_affine_coordinates_GFp,
   9 EC_POINT_set_compressed_coordinates_GFp, EC_POINT_set_affine_coordinates_GF2m,
  10 EC_POINT_get_affine_coordinates_GF2m, EC_POINT_set_compressed_coordinates_GF2m,
  11 EC_POINT_point2oct, EC_POINT_oct2point, EC_POINT_point2bn, EC_POINT_bn2point,
  12 EC_POINT_point2hex, EC_POINT_hex2point - Functions for creating, destroying and
  13 manipulating EC_POINT objects
  14
  15 =head1 SYNOPSIS
  16
  17  #include <openssl/ec.h>
  18
  19  EC_POINT *EC_POINT_new(const EC_GROUP *group);
  20  void EC_POINT_free(EC_POINT *point);
  21  void EC_POINT_clear_free(EC_POINT *point);
  22  int EC_POINT_copy(EC_POINT *dst, const EC_POINT *src);
  23  EC_POINT *EC_POINT_dup(const EC_POINT *src, const EC_GROUP *group);
  24  const EC_METHOD *EC_POINT_method_of(const EC_POINT *point);
  25  int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point);
  26  int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group,
  27                                               EC_POINT *p,
  28                                               const BIGNUM *x, const BIGNUM *y,
  29                                               const BIGNUM *z, BN_CTX *ctx);
  30  int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group,
  31                                               const EC_POINT *p,
  32                                               BIGNUM *x, BIGNUM *y, BIGNUM *z,
  33                                               BN_CTX *ctx);
  34  int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,
  35                                          const BIGNUM *x, const BIGNUM *y,
  36                                          BN_CTX *ctx);
  37  int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,
  38                                          const EC_POINT *p,
  39                                          BIGNUM *x, BIGNUM *y, BN_CTX *ctx);
  40  int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group,
  41                                              EC_POINT *p,
  42                                              const BIGNUM *x, int y_bit,
  43                                              BN_CTX *ctx);
  44  int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p,
  45                                           const BIGNUM *x, const BIGNUM *y,
  46                                           BN_CTX *ctx);
  47  int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group,
  48                                           const EC_POINT *p,
  49                                           BIGNUM *x, BIGNUM *y, BN_CTX *ctx);
  50  int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group,
  51                                               EC_POINT *p,
  52                                               const BIGNUM *x, int y_bit,
  53                                               BN_CTX *ctx);
  54  size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *p,
  55                            point_conversion_form_t form,
  56                            unsigned char *buf, size_t len, BN_CTX *ctx);
  57  size_t EC_POINT_point2buf(const EC_GROUP *group, const EC_POINT *point,
  58                            point_conversion_form_t form,
  59                            unsigned char **pbuf, BN_CTX *ctx);
  60  int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *p,
  61                         const unsigned char *buf, size_t len, BN_CTX *ctx);
  62  BIGNUM *EC_POINT_point2bn(const EC_GROUP *group, const EC_POINT *p,
  63                            point_conversion_form_t form, BIGNUM *bn,
  64                            BN_CTX *ctx);
  65  EC_POINT *EC_POINT_bn2point(const EC_GROUP *group, const BIGNUM *bn,
  66                              EC_POINT *p, BN_CTX *ctx);
  67  char *EC_POINT_point2hex(const EC_GROUP *group, const EC_POINT *p,
  68                           point_conversion_form_t form, BN_CTX *ctx);
  69  EC_POINT *EC_POINT_hex2point(const EC_GROUP *group, const char *hex,
  70                               EC_POINT *p, BN_CTX *ctx);
  71
  72
  73 =head1 DESCRIPTION
  74
  75 An B<EC_POINT> structure represents a point on a curve. A new point is
  76 constructed by calling the function EC_POINT_new() and providing the
  77 B<group> object that the point relates to.
  78
  79 EC_POINT_free() frees the memory associated with the B<EC_POINT>.
  80 if B<point> is NULL nothing is done.
  81
  82 EC_POINT_clear_free() destroys any sensitive data held within the EC_POINT and
  83 then frees its memory. If B<point> is NULL nothing is done.
  84
  85 EC_POINT_copy() copies the point B<src> into B<dst>. Both B<src> and B<dst>
  86 must use the same B<EC_METHOD>.
  87
  88 EC_POINT_dup() creates a new B<EC_POINT> object and copies the content from
  89 B<src> to the newly created B<EC_POINT> object.
  90
  91 EC_POINT_method_of() obtains the B<EC_METHOD> associated with B<point>.
  92
  93 A valid point on a curve is the special point at infinity. A point is set to
  94 be at infinity by calling EC_POINT_set_to_infinity().
  95
  96 The affine co-ordinates for a point describe a point in terms of its x and y
  97 position. The functions EC_POINT_set_affine_coordinates_GFp() and
  98 EC_POINT_set_affine_coordinates_GF2m() set the B<x> and B<y> co-ordinates for
  99 the point B<p> defined over the curve given in B<group>.
 100
 101 As well as the affine co-ordinates, a point can alternatively be described in
 102 terms of its Jacobian projective co-ordinates (for Fp curves only). Jacobian
 103 projective co-ordinates are expressed as three values x, y and z. Working in
 104 this co-ordinate system provides more efficient point multiplication
 105 operations.  A mapping exists between Jacobian projective co-ordinates and
 106 affine co-ordinates. A Jacobian projective co-ordinate (x, y, z) can be written
 107 as an affine co-ordinate as (x/(z^2), y/(z^3)). Conversion to Jacobian
 108 projective to affine co-ordinates is simple. The co-ordinate (x, y) is mapped
 109 to (x, y, 1). To set or get the projective co-ordinates use
 110 EC_POINT_set_Jprojective_coordinates_GFp() and
 111 EC_POINT_get_Jprojective_coordinates_GFp() respectively.
 112
 113 Points can also be described in terms of their compressed co-ordinates. For a
 114 point (x, y), for any given value for x such that the point is on the curve
 115 there will only ever be two possible values for y. Therefore a point can be set
 116 using the EC_POINT_set_compressed_coordinates_GFp() and
 117 EC_POINT_set_compressed_coordinates_GF2m() functions where B<x> is the x
 118 co-ordinate and B<y_bit> is a value 0 or 1 to identify which of the two
 119 possible values for y should be used.
 120
 121 In addition B<EC_POINT> can be converted to and from various external
 122 representations. The octet form is the binary encoding of the B<ECPoint>
 123 structure (as defined in RFC5480 and used in certificates and TLS records):
 124 only the content octets are present, the B<OCTET STRING> tag and length are
 125 not included. B<BIGNUM> form is the octet form interpreted as a big endian
 126 integer converted to a B<BIGNUM> structure. Hexadecimal form is the octet
 127 form converted to a NULL terminated character string where each character
 128 is one of the printable values 0-9 or A-F (or a-f).
 129
 130 The functions EC_POINT_point2oct(), EC_POINT_oct2point(), EC_POINT_point2bn(),
 131 EC_POINT_bn2point(), EC_POINT_point2hex() and EC_POINT_hex2point() convert from
 132 and to EC_POINTs for the formats: octet, BIGNUM and hexadecimal respectively.
 133
 134 The function EC_POINT_point2oct() must be supplied with a buffer long enough to
 135 store the octet form. The return value provides the number of octets stored.
 136 Calling the function with a NULL buffer will not perform the conversion but
 137 will still return the required buffer length.
 138
 139 The function EC_POINT_point2buf() allocates a buffer of suitable length and
 140 writes an EC_POINT to it in octet format. The allocated buffer is written to
 141 B<*pbuf> and its length is returned. The caller must free up the allocated
 142 buffer with a call to OPENSSL_free(). Since the allocated buffer value is
 143 written to B<*pbuf> the B<pbuf> parameter B<MUST NOT> be B<NULL>.
 144
 145 The function EC_POINT_point2hex() will allocate sufficient memory to store the
 146 hexadecimal string. It is the caller's responsibility to free this memory with
 147 a subsequent call to OPENSSL_free().
 148
 149 =head1 RETURN VALUES
 150
 151 EC_POINT_new() and EC_POINT_dup() return the newly allocated EC_POINT or NULL
 152 on error.
 153
 154 The following functions return 1 on success or 0 on error: EC_POINT_copy(),
 155 EC_POINT_set_to_infinity(), EC_POINT_set_Jprojective_coordinates_GFp(),
 156 EC_POINT_get_Jprojective_coordinates_GFp(),
 157 EC_POINT_set_affine_coordinates_GFp(), EC_POINT_get_affine_coordinates_GFp(),
 158 EC_POINT_set_compressed_coordinates_GFp(),
 159 EC_POINT_set_affine_coordinates_GF2m(), EC_POINT_get_affine_coordinates_GF2m(),
 160 EC_POINT_set_compressed_coordinates_GF2m() and EC_POINT_oct2point().
 161
 162 EC_POINT_method_of returns the EC_METHOD associated with the supplied EC_POINT.
 163
 164 EC_POINT_point2oct() and EC_point2buf() return the length of the required
 165 buffer or 0 on error.
 166
 167 EC_POINT_point2bn() returns the pointer to the BIGNUM supplied, or NULL on
 168 error.
 169
 170 EC_POINT_bn2point() returns the pointer to the EC_POINT supplied, or NULL on
 171 error.
 172
 173 EC_POINT_point2hex() returns a pointer to the hex string, or NULL on error.
 174
 175 EC_POINT_hex2point() returns the pointer to the EC_POINT supplied, or NULL on
 176 error.
 177
 178 =head1 SEE ALSO
 179
 180 L<crypto(3)>, L<ec(3)>, L<EC_GROUP_new(3)>, L<EC_GROUP_copy(3)>,
 181 L<EC_POINT_add(3)>, L<EC_KEY_new(3)>,
 182 L<EC_GFp_simple_method(3)>, L<d2i_ECPKParameters(3)>
 183
 184 =head1 COPYRIGHT
 185
 186 Copyright 2013-2016 The OpenSSL Project Authors. All Rights Reserved.
 187
 188 Licensed under the OpenSSL license (the "License").  You may not use
 189 this file except in compliance with the License.  You can obtain a copy
 190 in the file LICENSE in the source distribution or at
 191 L<https://www.openssl.org/source/license.html>.
 192
 193 =cut