EC_GROUP_COPY(3ossl)
β¨ EC_GROUP_COPY(3ossl) β OpenSSL β¨
hey bestie π welcome to the EC_GROUP_COPY(3ossl) manual page from OpenSSL! this is part 1 of 3, so buckle up π
πΈ NAME πΈ
okay so this whole page is about a squad of functions that manipulate EC_GROUP objects. it's giving elliptic curve group management energy fr fr. here's the full lineup, no cap:
EC_GROUP_get0_orderEC_GROUP_order_bitsEC_GROUP_get0_cofactorEC_GROUP_copyEC_GROUP_dupEC_GROUP_method_ofEC_GROUP_set_generatorEC_GROUP_get0_generatorEC_GROUP_get_orderEC_GROUP_get_cofactorEC_GROUP_set_curve_nameEC_GROUP_get_curve_nameEC_GROUP_set_asn1_flagEC_GROUP_get_asn1_flagEC_GROUP_set_point_conversion_formEC_GROUP_get_point_conversion_formEC_GROUP_get0_seedEC_GROUP_get_seed_lenEC_GROUP_set_seedEC_GROUP_get_degreeEC_GROUP_checkEC_GROUP_check_named_curveEC_GROUP_check_discriminantEC_GROUP_cmpEC_GROUP_get_basis_typeEC_GROUP_get_trinomial_basisEC_GROUP_get_pentanomial_basisEC_GROUP_get0_fieldEC_GROUP_get_field_type
and that's the whole bestie list. all for manipulating EC_GROUP objects. π
π SYNOPSIS π
first thing you gotta do is include the header, periodt:
#include <openssl/ec.h>
then here come the function prototypes, copy-paste ready:
int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src);
EC_GROUP *EC_GROUP_dup(const EC_GROUP *src);
int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator,
const BIGNUM *order, const BIGNUM *cofactor);
const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group);
int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx);
const BIGNUM *EC_GROUP_get0_order(const EC_GROUP *group);
int EC_GROUP_order_bits(const EC_GROUP *group);
int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx);
const BIGNUM *EC_GROUP_get0_cofactor(const EC_GROUP *group);
const BIGNUM *EC_GROUP_get0_field(const EC_GROUP *group);
void EC_GROUP_set_curve_name(EC_GROUP *group, int nid);
int EC_GROUP_get_curve_name(const EC_GROUP *group);
void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag);
int EC_GROUP_get_asn1_flag(const EC_GROUP *group);
void EC_GROUP_set_point_conversion_form(EC_GROUP *group, point_conversion_form_t form);
point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *group);
unsigned char *EC_GROUP_get0_seed(const EC_GROUP *group);
size_t EC_GROUP_get_seed_len(const EC_GROUP *group);
size_t EC_GROUP_set_seed(EC_GROUP *group, const unsigned char *, size_t len);
int EC_GROUP_get_degree(const EC_GROUP *group);
int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx);
int EC_GROUP_check_named_curve(const EC_GROUP *group, int nist_only,
BN_CTX *ctx);
int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx);
int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx);
int EC_GROUP_get_basis_type(const EC_GROUP *group);
int EC_GROUP_get_trinomial_basis(const EC_GROUP *group, unsigned int *k);
int EC_GROUP_get_pentanomial_basis(const EC_GROUP *group, unsigned int *k1,
unsigned int *k2, unsigned int *k3);
int EC_GROUP_get_field_type(const EC_GROUP *group);
β οΈ heads up bestie! the following function has been deprecated since OpenSSL 3.0, and can be hidden entirely by definingOPENSSL_API_COMPATwith a suitable version value, seeopenssl_user_macros(7):
const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);
so yeah, that's the synopsis. stay tuned for part 2 where we get into the actual DESCRIPTION and all the tea βοΈπ
β¨ DESCRIPTION β¨
okay bestie, gather round, because this is the section where the elliptic curve magic actually happens π
EC_GROUP_copy()β copies the curvesrcintodst. Bothsrcanddstmust use the sameEC_METHOD. no mixing and matching, that's the rule π«EC_GROUP_dup()β creates a brand newEC_GROUPobject and copies the content fromsrcinto that shiny newEC_GROUPobject. it's giving clone energy π―ββοΈEC_GROUP_method_of()β obtains theEC_METHODofgroup. heads up: this function was deprecated in OpenSSL 3.0, becauseEC_METHODis no longer a public concept. so yeah, it's an ex-icon πEC_GROUP_set_generator()β sets curve parameters that must be agreed by all participants using the curve. these parameters include the generator, the order and the cofactor. the generator is a well defined point on the curve chosen for cryptographic operations. integers used for point multiplications will be between0andn-1wherenis the order. the order multiplied by the cofactor gives the number of points on the curve. math is mathing π’EC_GROUP_get0_generator()β returns the generator for the identified group.EC_GROUP_get_order()β retrieves the order ofgroupand copies its value intoorder. it fails in casegroupis not fully initialized (i.e., its order is not set or set to zero). no half-baked groups allowed π ββοΈEC_GROUP_get_cofactor()β retrieves the cofactor ofgroupand copies its value intocofactor. it fails in casegroupis not fully initialized or if the cofactor is not set (or set to zero). same vibe, must be fully ready β¨EC_GROUP_set_curve_name()andEC_GROUP_get_curve_name()β set and get the NID for the curve respectively (seeEC_GROUP_new(3)). if a curve does not have a NID associated with it, thenEC_GROUP_get_curve_namewill returnNID_undef. so if you getNID_undef, that's the reason bestie π«
The asn1_flag value is used to determine whether the curve encoding uses explicit parameters or a named curve using an ASN1 OID: many applications only support the latter form. If asn1_flag is OPENSSL_EC_NAMED_CURVE then the named curve form is used and the parameters must have a corresponding named curve NID set. If asn1_flags is OPENSSL_EC_EXPLICIT_CURVE the parameters are explicitly encoded. The functions EC_GROUP_get_asn1_flag() and EC_GROUP_set_asn1_flag() get and set the status of the asn1_flag for the curve. Note: OPENSSL_EC_EXPLICIT_CURVE was added in OpenSSL 1.1.0, for previous versions of OpenSSL the value 0 must be used instead. Before OpenSSL 1.1.0 the default form was to use explicit parameters (meaning that applications would have to explicitly set the named curve form) in OpenSSL 1.1.0 and later the named curve form is the default. okay so version tea β
The point_conversion_form for a curve controls how EC_POINT data is encoded as ASN1 as defined in X9.62 (ECDSA). point_conversion_form_t is an enum defined as follows:
typedef enum {
/** the point is encoded as z||x, where the octet z specifies
* which solution of the quadratic equation y is */
POINT_CONVERSION_COMPRESSED = 2,
/** the point is encoded as z||x||y, where z is the octet 0x04 */
POINT_CONVERSION_UNCOMPRESSED = 4,
/** the point is encoded as z||x||y, where the octet z specifies
* which solution of the quadratic equation y is */
POINT_CONVERSION_HYBRID = 6
} point_conversion_form_t;
For POINT_CONVERSION_UNCOMPRESSED the point is encoded as an octet signifying the UNCOMPRESSED form has been used followed by the octets for x, followed by the octets for y.
For any given x coordinate for a point on a curve it is possible to derive two possible y values. For POINT_CONVERSION_COMPRESSED the point is encoded as an octet signifying that the COMPRESSED form has been used AND which of the two possible solutions for y has been used, followed by the octets for x.
For POINT_CONVERSION_HYBRID the point is encoded as an octet signifying the HYBRID form has been used AND which of the two possible solutions for y has been used, followed by the octets for x, followed by the octets for y.
The functions EC_GROUP_set_point_conversion_form() and EC_GROUP_get_point_conversion_form(), set and get the point_conversion_form for the curve respectively. got it? good π
ANSI X9.62 (ECDSA standard) defines a method of generating the curve parameter b from a random number. This provides advantages in that a parameter obtained in this way is highly unlikely to be susceptible to special purpose attacks, or have any trapdoors in it. If the seed is present for a curve then the b parameter was generated in a verifiable fashion using that seed. The OpenSSL EC library 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 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 built-in curves within the library provide seed values that can be obtained. It is also possible to set a custom seed using EC_GROUP_set_seed() and passing a pointer to a memory block, along with the length of the seed. Again, the EC library will not use this seed value, although it will be preserved in any ASN1 based communications. so the seed is just there for vibes and verification, not for actual crypto operations π±
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 the value m.
EC_GROUP_get_field_type() identifies what type of field the EC_GROUP structure supports, which will be either F2^m or Fp.
The function EC_GROUP_check_discriminant() calculates the discriminant for the curve and verifies that it is valid. 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 simply b. In either case for the curve to be valid the discriminant must be non zero. non zero or it's a no from me π«
The function EC_GROUP_check() behaves in the following way: For the OpenSSL default provider it performs a number of checks on a curve to verify that it is valid. Checks performed include verifying that the discriminant is non zero; that a generator has been defined; that the generator is on the curve and has the correct order. For the OpenSSL FIPS provider it uses EC_GROUP_check_named_curve() to conform to SP800-56Ar3.
The function EC_GROUP_check_named_curve() determines if the group's domain parameters match one of the built-in curves supported by the library. The curve name is returned as a NID if it matches. If the group's domain parameters have been modified then no match will be found. If the curve name of the given group is NID_undef (e.g. it has been created by using explicit parameters with no curve name), then this method can be used to lookup the name of the curve that matches the group domain parameters. The built-in curves contain aliases, so that multiple NID's can map to the same domain parameters. For such curves it is unspecified which of the aliases will be returned if the curve name of the given group is NID_undef. If nist_only is 1 it will only look for NIST approved curves, otherwise it searches all built-in curves. This function may be passed a BN_CTX object in the ctx parameter. The ctx parameter may be NULL. aliases are giving mystery π»
EC_GROUP_cmp() compares a and b to determine whether they represent the same curve or not.
The functions EC_GROUP_get_basis_type(), EC_GROUP_get_trinomial_basis() and EC_GROUP_get_pentanomial_basis() should only be called for curves defined over an F2^m field. Addition and multiplication operations within an F2^m field are performed using an irreducible polynomial function f(x). This function is either a trinomial of the form:
f(x) = x^m + x^k + 1 with m > k >= 1
or a pentanomial of the form:
f(x) = x^m + x^k3 + x^k2 + x^k1 + 1 with m > k3 > k2 > k1 >= 1
The function EC_GROUP_get_basis_type() returns a NID identifying whether a trinomial or pentanomial is in use for the field. The function EC_GROUP_get_trinomial_basis() must only be called where f(x) is of the trinomial form, and returns the value of k. Similarly the function EC_GROUP_get_pentanomial_basis() must only be called where f(x) is of the pentanomial form, and returns the values of k1, k2 and k3 respectively.
β¨ HISTORY β¨
Okay so bestie, let's do a little timeline moment, because some of these functions are not the same age and the glow-ups are real. π°οΈ
EC_GROUP_method_of()got deprecated in OpenSSL 3.0. Yeah. She's giving legacy. We don't stan, but we respect the history. πEC_GROUP_get0_field(),EC_GROUP_check_named_curve()andEC_GROUP_get_field_type()were all added in OpenSSL 3.0. Fresh faces, new era, main character energy. β¨EC_GROUP_get0_order(),EC_GROUP_order_bits()andEC_GROUP_get0_cofactor()were added in OpenSSL 1.1.0. Older sisters fr fr, they've been holding it down since way back. π
π COPYRIGHT π
Copyright 2013-2023 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.
Like, genuinely, read the license bestie β it's not optional, it's the whole vibe check for using this. π«Ά
And that's the page, babes! π You just read EC_GROUP_COPY(3ossl) from OpenSSL 3.5.9, dated 2026-09-29. Screenshot it, bookmark it, tell your group chat β because knowing your elliptic curve group functions is highkey iconic behavior. π Go forth and slay responsibly. π
π¦ where this page comes from
- fedora 43: openssl-devel 1:3.5.9-1.fc43 Β· Apache-2.0
- fedora 43: openssl-devel 1:3.5.9-1.fc43 Β· Apache-2.0
- fedora 44: openssl-devel 1:3.5.9-1.fc44 Β· Apache-2.0
- fedora 44: openssl-devel 1:3.5.9-1.fc44 Β· Apache-2.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms