Struct openssl::ec::EcGroup

source ·
pub struct EcGroup(/* private fields */);
Expand description

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 preferred.

Implementations§

source§

impl EcGroup

source

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

Returns the group of a standard named curve.

§Examples
use openssl::nid::Nid;
use openssl::ec::{EcGroup, EcKey};

let nid = Nid::X9_62_PRIME256V1; // NIST P-256 curve
let group = EcGroup::from_curve_name(nid)?;
let key = EcKey::generate(&group)?;

This corresponds to EC_GROUP_new_by_curve_name.

source

pub fn from_components( p: BigNum, a: BigNum, b: BigNum, ctx: &mut BigNumContextRef, ) -> Result<EcGroup, ErrorStack>

Returns the group for given parameters

This corresponds to EC_GROUP_new_curve_GFp.

Methods from Deref<Target = EcGroupRef>§

source

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.

This corresponds to EC_GROUP_get_curve_GFp.

source

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.

This corresponds to EC_GROUP_get_curve_GF2m.

source

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

Places the cofactor of the group in the provided BigNum.

This corresponds to EC_GROUP_get_cofactor.

source

pub fn degree(&self) -> u32

Returns the degree of the curve.

This corresponds to EC_GROUP_get_degree.

source

pub fn order_bits(&self) -> u32

Returns the number of bits in the group order.

This corresponds to EC_GROUP_order_bits.

source

pub fn generator(&self) -> &EcPointRef

Returns the generator for the given curve as an EcPoint.

This corresponds to EC_GROUP_get0_generator.

source

pub fn set_generator( &mut self, generator: EcPoint, order: BigNum, cofactor: BigNum, ) -> Result<(), ErrorStack>

Sets the generator point for the given curve

This corresponds to EC_GROUP_set_generator.

source

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

Places the order of the curve in the provided BigNum.

This corresponds to EC_GROUP_get_order.

source

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.

This corresponds to EC_GROUP_set_asn1_flag.

source

pub fn asn1_flag(&self) -> Asn1Flag

Gets the flag determining if the group corresponds to a named curve.

This corresponds to EC_GROUP_get_asn1_flag.

source

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

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

This corresponds to EC_GROUP_get_curve_name.

Trait Implementations§

source§

impl AsRef<EcGroupRef> for EcGroup

source§

fn as_ref(&self) -> &EcGroupRef

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Borrow<EcGroupRef> for EcGroup

source§

fn borrow(&self) -> &EcGroupRef

Immutably borrows from an owned value. Read more
source§

impl Deref for EcGroup

§

type Target = EcGroupRef

The resulting type after dereferencing.
source§

fn deref(&self) -> &EcGroupRef

Dereferences the value.
source§

impl DerefMut for EcGroup

source§

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

Mutably dereferences the value.
source§

impl Drop for EcGroup

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl ForeignType for EcGroup

§

type CType = EC_GROUP

The raw C type.
§

type Ref = EcGroupRef

The type representing a reference to this type.
source§

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

Constructs an instance of this type from its raw type.
source§

fn as_ptr(&self) -> *mut EC_GROUP

Returns a raw pointer to the wrapped value.
source§

impl Send for EcGroup

source§

impl Sync for EcGroup

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.