secure/lib/libcrypto/man/EC_GROUP_copy.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_GROUP_copy 3"
 136 .TH EC_GROUP_copy 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_GROUP_copy, EC_GROUP_dup, EC_GROUP_method_of, EC_GROUP_set_generator, EC_GROUP_get0_generator, EC_GROUP_get_order, EC_GROUP_get_cofactor, EC_GROUP_set_curve_name, EC_GROUP_get_curve_name, EC_GROUP_set_asn1_flag, EC_GROUP_get_asn1_flag, EC_GROUP_set_point_conversion_form, EC_GROUP_get_point_conversion_form, EC_GROUP_get0_seed, EC_GROUP_get_seed_len, EC_GROUP_set_seed, EC_GROUP_get_degree, EC_GROUP_check, EC_GROUP_check_discriminant, EC_GROUP_cmp, EC_GROUP_get_basis_type, EC_GROUP_get_trinomial_basis, EC_GROUP_get_pentanomial_basis \- Functions for manipulating EC_GROUP objects.
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 2
 146 \& #include <openssl/ec.h>
 147 \& #include <openssl/bn.h>
 148 \&
 149 \& int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src);
 150 \& EC_GROUP *EC_GROUP_dup(const EC_GROUP *src);
 151 \&
 152 \& const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);
 153 \&
 154 \& int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);
 155 \& const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group);
 156 \&
 157 \& int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx);
 158 \& int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx);
 159 \&
 160 \& void EC_GROUP_set_curve_name(EC_GROUP *group, int nid);
 161 \& int EC_GROUP_get_curve_name(const EC_GROUP *group);
 162 \&
 163 \& void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag);
 164 \& int EC_GROUP_get_asn1_flag(const EC_GROUP *group);
 165 \&
 166 \& void EC_GROUP_set_point_conversion_form(EC_GROUP *group, point_conversion_form_t form);
 167 \& point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *);
 168 \&
 169 \& unsigned char *EC_GROUP_get0_seed(const EC_GROUP *x);
 170 \& size_t EC_GROUP_get_seed_len(const EC_GROUP *);
 171 \& size_t EC_GROUP_set_seed(EC_GROUP *, const unsigned char *, size_t len);
 172 \&
 173 \& int EC_GROUP_get_degree(const EC_GROUP *group);
 174 \&
 175 \& int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx);
 176 \&
 177 \& int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx);
 178 \&
 179 \& int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx);
 180 \&
 181 \& int EC_GROUP_get_basis_type(const EC_GROUP *);
 182 \& int EC_GROUP_get_trinomial_basis(const EC_GROUP *, unsigned int *k);
 183 \& int EC_GROUP_get_pentanomial_basis(const EC_GROUP *, unsigned int *k1,
 184 \&        unsigned int *k2, unsigned int *k3);
 185 .Ve
 186 .SH "DESCRIPTION"
 187 .IX Header "DESCRIPTION"
 188 EC_GROUP_copy copies the curve \fBsrc\fR into \fBdst\fR. Both \fBsrc\fR and \fBdst\fR must use the same \s-1EC_METHOD.\s0
 189 .PP
 190 EC_GROUP_dup creates a new \s-1EC_GROUP\s0 object and copies the content from \fBsrc\fR to the newly created
 191 \&\s-1EC_GROUP\s0 object.
 192 .PP
 193 EC_GROUP_method_of obtains the \s-1EC_METHOD\s0 of \fBgroup\fR.
 194 .PP
 195 EC_GROUP_set_generator sets curve paramaters that must be agreed by all participants using the curve. These
 196 paramaters include the \fBgenerator\fR, the \fBorder\fR and the \fBcofactor\fR. The \fBgenerator\fR is a well defined point on the
 197 curve chosen for cryptographic operations. Integers used for point multiplications will be between 0 and
 198 n\-1 where n is the \fBorder\fR. The \fBorder\fR multipied by the \fBcofactor\fR gives the number of points on the curve.
 199 .PP
 200 EC_GROUP_get0_generator returns the generator for the identified \fBgroup\fR.
 201 .PP
 202 The functions EC_GROUP_get_order and EC_GROUP_get_cofactor populate the provided \fBorder\fR and \fBcofactor\fR parameters
 203 with the respective order and cofactors for the \fBgroup\fR.
 204 .PP
 205 The functions EC_GROUP_set_curve_name and EC_GROUP_get_curve_name, set and get the \s-1NID\s0 for the curve respectively
 206 (see \fIEC_GROUP_new\fR\|(3)). If a curve does not have a \s-1NID\s0 associated with it, then EC_GROUP_get_curve_name
 207 will return 0.
 208 .PP
 209 The asn1_flag value on a curve is used to determine whether there is a specific \s-1ASN1 OID\s0 to describe the curve or not.
 210 If the asn1_flag is 1 then this is a named curve with an associated \s-1ASN1 OID.\s0 If not then asn1_flag is 0. The functions
 211 EC_GROUP_get_asn1_flag and EC_GROUP_set_asn1_flag get and set the status of the asn1_flag for the curve. If set then
 212 the curve_name must also be set.
 213 .PP
 214 The point_coversion_form for a curve controls how \s-1EC_POINT\s0 data is encoded as \s-1ASN1\s0 as defined in X9.62 (\s-1ECDSA\s0).
 215 point_conversion_form_t is an enum defined as follows:
 216 .PP
 217 .Vb 10
 218 \& typedef enum {
 219 \&        /** the point is encoded as z||x, where the octet z specifies
 220 \&         *   which solution of the quadratic equation y is  */
 221 \&        POINT_CONVERSION_COMPRESSED = 2,
 222 \&        /** the point is encoded as z||x||y, where z is the octet 0x02  */
 223 \&        POINT_CONVERSION_UNCOMPRESSED = 4,
 224 \&        /** the point is encoded as z||x||y, where the octet z specifies
 225 \&         *  which solution of the quadratic equation y is  */
 226 \&        POINT_CONVERSION_HYBRID = 6
 227 \& } point_conversion_form_t;
 228 .Ve
 229 .PP
 230 For \s-1POINT_CONVERSION_UNCOMPRESSED\s0 the point is encoded as an octet signifying the \s-1UNCOMPRESSED\s0 form has been used followed by
 231 the octets for x, followed by the octets for y.
 232 .PP
 233 For any given x co-ordinate for a point on a curve it is possible to derive two possible y values. For
 234 \&\s-1POINT_CONVERSION_COMPRESSED\s0 the point is encoded as an octet signifying that the \s-1COMPRESSED\s0 form has been used \s-1AND\s0 which of
 235 the two possible solutions for y has been used, followed by the octets for x.
 236 .PP
 237 For \s-1POINT_CONVERSION_HYBRID\s0 the point is encoded as an octet signifying the \s-1HYBRID\s0 form has been used \s-1AND\s0 which of the two
 238 possible solutions for y has been used, followed by the octets for x, followed by the octets for y.
 239 .PP
 240 The functions EC_GROUP_set_point_conversion_form and EC_GROUP_get_point_conversion_form set and get the point_conversion_form
 241 for the curve respectively.
 242 .PP
 243 \&\s-1ANSI X9.62 \s0(\s-1ECDSA\s0 standard) defines a method of generating the curve parameter b from a random number. This provides advantages
 244 in that a parameter obtained in this way is highly unlikely to be susceptible to special purpose attacks, or have any trapdoors in it.
 245 If the seed is present for a curve then the b parameter was generated in a verifiable fashion using that seed. The OpenSSL \s-1EC\s0 library
 246 does not use this seed value but does enable you to inspect it using EC_GROUP_get0_seed. This returns a pointer to a memory block
 247 containing the seed that was used. The length of the memory block can be obtained using EC_GROUP_get_seed_len. A number of the
 248 builtin curves within the library provide seed values that can be obtained. It is also possible to set a custom seed using
 249 EC_GROUP_set_seed and passing a pointer to a memory block, along with the length of the seed. Again, the \s-1EC\s0 library will not use
 250 this seed value, although it will be preserved in any \s-1ASN1\s0 based communications.
 251 .PP
 252 EC_GROUP_get_degree gets the degree of the field. For Fp fields this will be the number of bits in p.  For F2^m fields this will be
 253 the value m.
 254 .PP
 255 The function EC_GROUP_check_discriminant calculates the discriminant for the curve and verifies that it is valid.
 256 For a curve defined over Fp the discriminant is given by the formula 4*a^3 + 27*b^2 whilst for F2^m curves the discriminant is
 257 simply b. In either case for the curve to be valid the discriminant must be non zero.
 258 .PP
 259 The function EC_GROUP_check performs a number of checks on a curve to verify that it is valid. Checks performed include
 260 verifying that the discriminant is non zero; that a generator has been defined; that the generator is on the curve and has
 261 the correct order.
 262 .PP
 263 EC_GROUP_cmp compares \fBa\fR and \fBb\fR to determine whether they represent the same curve or not.
 264 .PP
 265 The functions EC_GROUP_get_basis_type, EC_GROUP_get_trinomial_basis and EC_GROUP_get_pentanomial_basis should only be called for curves
 266 defined over an F2^m field. Addition and multiplication operations within an F2^m field are performed using an irreducible polynomial
 267 function f(x). This function is either a trinomial of the form:
 268 .PP
 269 f(x) = x^m + x^k + 1 with m > k >= 1
 270 .PP
 271 or a pentanomial of the form:
 272 .PP
 273 f(x) = x^m + x^k3 + x^k2 + x^k1 + 1 with m > k3 > k2 > k1 >= 1
 274 .PP
 275 The function EC_GROUP_get_basis_type returns a \s-1NID\s0 identifying whether a trinomial or pentanomial is in use for the field. The
 276 function EC_GROUP_get_trinomial_basis must only be called where f(x) is of the trinomial form, and returns the value of \fBk\fR. Similary
 277 the function EC_GROUP_get_pentanomial_basis must only be called where f(x) is of the pentanomial form, and returns the values of \fBk1\fR,
 278 \&\fBk2\fR and \fBk3\fR respectively.
 279 .SH "RETURN VALUES"
 280 .IX Header "RETURN VALUES"
 281 The following functions return 1 on success or 0 on error: EC_GROUP_copy, EC_GROUP_set_generator, EC_GROUP_check,
 282 EC_GROUP_check_discriminant, EC_GROUP_get_trinomial_basis and EC_GROUP_get_pentanomial_basis.
 283 .PP
 284 EC_GROUP_dup returns a pointer to the duplicated curve, or \s-1NULL\s0 on error.
 285 .PP
 286 EC_GROUP_method_of returns the \s-1EC_METHOD\s0 implementation in use for the given curve or \s-1NULL\s0 on error.
 287 .PP
 288 EC_GROUP_get0_generator returns the generator for the given curve or \s-1NULL\s0 on error.
 289 .PP
 290 EC_GROUP_get_order, EC_GROUP_get_cofactor, EC_GROUP_get_curve_name, EC_GROUP_get_asn1_flag, EC_GROUP_get_point_conversion_form
 291 and EC_GROUP_get_degree return the order, cofactor, curve name (\s-1NID\s0), \s-1ASN1\s0 flag, point_conversion_form and degree for the
 292 specified curve respectively. If there is no curve name associated with a curve then EC_GROUP_get_curve_name will return 0.
 293 .PP
 294 EC_GROUP_get0_seed returns a pointer to the seed that was used to generate the parameter b, or \s-1NULL\s0 if the seed is not
 295 specified. EC_GROUP_get_seed_len returns the length of the seed or 0 if the seed is not specified.
 296 .PP
 297 EC_GROUP_set_seed returns the length of the seed that has been set. If the supplied seed is \s-1NULL,\s0 or the supplied seed length is
 298 0, the return value will be 1. On error 0 is returned.
 299 .PP
 300 EC_GROUP_cmp returns 0 if the curves are equal, 1 if they are not equal, or \-1 on error.
 301 .PP
 302 EC_GROUP_get_basis_type returns the values NID_X9_62_tpBasis or NID_X9_62_ppBasis (as defined in <openssl/obj_mac.h>) for a
 303 trinomial or pentanomial respectively. Alternatively in the event of an error a 0 is returned.
 304 .SH "SEE ALSO"
 305 .IX Header "SEE ALSO"
 306 \&\fIcrypto\fR\|(3), \fIec\fR\|(3), \fIEC_GROUP_new\fR\|(3),
 307 \&\fIEC_POINT_new\fR\|(3), \fIEC_POINT_add\fR\|(3), \fIEC_KEY_new\fR\|(3),
 308 \&\fIEC_GFp_simple_method\fR\|(3), \fId2i_ECPKParameters\fR\|(3)