Struct openssl::ec::EcGroup

pub struct EcGroup(_);

Describes the curve

A curve can be of the named curve type. These curves can be discovered using openssl binary openssl ecparam -list_curves. Other operations are available in the wiki. These named curves are available in the Nid module.

Curves can also be generated using prime field parameters or a binary field.

Prime fields use the formula y^2 mod p = x^3 + ax + b mod p. Binary fields use the formula y^2 + xy = x^3 + ax^2 + b. Named curves have assured security. To prevent accidental vulnerabilities, they should be prefered.

Methods

impl EcGroup

pub fn from_curve_name(nid: Nid) -> Result<EcGroup, ErrorStack>

Returns the group of a standard named curve.

OpenSSL documentation at EC_GROUP_new.

Methods from Deref<Target = EcGroupRef>

pub fn components_gfp(
    &self,
    p: &mut BigNumRef,
    a: &mut BigNumRef,
    b: &mut BigNumRef,
    ctx: &mut BigNumContextRef
) -> Result<(), ErrorStack>

Places the components of a curve over a prime field in the provided BigNums. The components make up the formula y^2 mod p = x^3 + ax + b mod p.

OpenSSL documentation available at EC_GROUP_get_curve_GFp

pub fn components_gf2m(
    &self,
    p: &mut BigNumRef,
    a: &mut BigNumRef,
    b: &mut BigNumRef,
    ctx: &mut BigNumContextRef
) -> Result<(), ErrorStack>

Places the components of a curve over a binary field in the provided BigNums. The components make up the formula y^2 + xy = x^3 + ax^2 + b.

In this form p relates to the irreducible polynomial. Each bit represents a term in the polynomial. It will be set to 3 1s or 5 1s depending on using a trinomial or pentanomial.

OpenSSL documentation at EC_GROUP_get_curve_GF2m.

pub fn cofactor(
    &self,
    cofactor: &mut BigNumRef,
    ctx: &mut BigNumContextRef
) -> Result<(), ErrorStack>

Places the cofactor of the group in the provided BigNum.

OpenSSL documentation at EC_GROUP_get_cofactor

pub fn degree(&self) -> u32

Returns the degree of the curve.

OpenSSL documentation at EC_GROUP_get_degree

pub fn generator(&self) -> &EcPointRef

Returns the generator for the given curve as a [EcPoint].

OpenSSL documentation at EC_GROUP_get0_generator

pub fn order(
    &self,
    order: &mut BigNumRef,
    ctx: &mut BigNumContextRef
) -> Result<(), ErrorStack>

Places the order of the curve in the provided BigNum.

OpenSSL documentation at EC_GROUP_get_order

pub fn set_asn1_flag(&mut self, flag: Asn1Flag)

Sets the flag determining if the group corresponds to a named curve or must be explicitly parameterized.

This defaults to EXPLICIT_CURVE in OpenSSL 1.0.1 and 1.0.2, but NAMED_CURVE in OpenSSL 1.1.0.

pub fn curve_name(&self) -> Option<Nid>

Returns the name of the curve, if a name is associated.

OpenSSL documentation at EC_GROUP_get_curve_name

Trait Implementations

impl Send for EcGroup

impl Drop for EcGroup

fn drop(&mut self)

Executes the destructor for this type.

impl Sync for EcGroup

impl AsRef<EcGroupRef> for EcGroup

fn as_ref(&self) -> &EcGroupRef

Performs the conversion.

impl DerefMut for EcGroup

fn deref_mut(&mut self) -> &mut EcGroupRef

Mutably dereferences the value.

impl Deref for EcGroup

type Target = EcGroupRef

The resulting type after dereferencing.

fn deref(&self) -> &EcGroupRef

Dereferences the value.

impl Borrow<EcGroupRef> for EcGroup

fn borrow(&self) -> &EcGroupRef

Immutably borrows from an owned value.

impl ForeignType for EcGroup

type CType = EC_GROUP

The raw C type.

type Ref = EcGroupRef

The type representing a reference to this type.

unsafe fn from_ptr(ptr: *mut EC_GROUP) -> EcGroup

Constructs an instance of this type from its raw type.

fn as_ptr(&self) -> *mut EC_GROUP

Returns a raw pointer to the wrapped value.