Struct Dh

pub struct Dh<T>(/* private fields */);

Implementations

impl Dh<Params>

pub fn from_params( p: BigNum, g: BigNum, q: BigNum, ) -> Result<Dh<Params>, ErrorStack>

pub fn from_pqg( prime_p: BigNum, prime_q: Option<BigNum>, generator: BigNum, ) -> Result<Dh<Params>, ErrorStack>

Creates a DH instance based upon the given primes and generator params.

This corresponds to DH_set0_pqg.

pub fn set_public_key(self, pub_key: BigNum) -> Result<Dh<Public>, ErrorStack>

Sets the public key on the DH object.

pub fn set_private_key( self, priv_key: BigNum, ) -> Result<Dh<Private>, ErrorStack>

Sets the private key on the DH object and recomputes the public key.

pub fn set_key( self, pub_key: BigNum, priv_key: BigNum, ) -> Result<Dh<Private>, ErrorStack>

Sets the public and private keys on the DH object.

pub fn generate_params( prime_len: u32, generator: u32, ) -> Result<Dh<Params>, ErrorStack>

Generates DH params based on the given prime_len and a fixed generator value.

This corresponds to DH_generate_parameters_ex.

pub fn generate_key(self) -> Result<Dh<Private>, ErrorStack>

Generates a public and a private key based on the DH params.

This corresponds to DH_generate_key.

pub fn params_from_pem(pem: &[u8]) -> Result<Dh<Params>, ErrorStack>

Deserializes a PEM-encoded PKCS#3 DHpararameters structure.

The input should have a header of -----BEGIN DH PARAMETERS-----.

This corresponds to PEM_read_bio_DHparams.

pub fn params_from_der(der: &[u8]) -> Result<Dh<Params>, ErrorStack>

Deserializes a DER-encoded PKCS#3 DHparameters structure.

This corresponds to d2i_DHparams.

pub fn get_1024_160() -> Result<Dh<Params>, ErrorStack>

Requires OpenSSL 1.0.2 or newer.

This corresponds to DH_get_1024_160.

pub fn get_2048_224() -> Result<Dh<Params>, ErrorStack>

Requires OpenSSL 1.0.2 or newer.

This corresponds to DH_get_2048_224.

pub fn get_2048_256() -> Result<Dh<Params>, ErrorStack>

Requires OpenSSL 1.0.2 or newer.

This corresponds to DH_get_2048_256.

impl<T> Dh<T>

where T: HasParams,

pub fn prime_p(&self) -> &BigNumRef

Returns the prime p from the DH instance.

This corresponds to DH_get0_pqg.

pub fn prime_q(&self) -> Option<&BigNumRef>

Returns the prime q from the DH instance.

This corresponds to DH_get0_pqg.

pub fn generator(&self) -> &BigNumRef

Returns the generator from the DH instance.

This corresponds to DH_get0_pqg.

Methods from Deref<Target = DhRef<T>>

pub fn params_to_pem(&self) -> Result<Vec<u8>, ErrorStack>

Serializes the parameters into a PEM-encoded PKCS#3 DHparameter structure.

The output will have a header of -----BEGIN DH PARAMETERS-----.

This corresponds to PEM_write_bio_DHparams.

pub fn params_to_der(&self) -> Result<Vec<u8>, ErrorStack>

Serializes the parameters into a DER-encoded PKCS#3 DHparameter structure.

This corresponds to i2d_DHparams.

pub fn check_key(&self) -> Result<bool, ErrorStack>

Validates DH parameters for correctness

This corresponds to DH_check_key.

pub fn public_key(&self) -> &BigNumRef

Returns the public key from the DH instance.

This corresponds to DH_get0_key.

pub fn compute_key(&self, public_key: &BigNumRef) -> Result<Vec<u8>, ErrorStack>

Computes a shared secret from the own private key and the given public_key.

This corresponds to DH_compute_key.

pub fn private_key(&self) -> &BigNumRef

Returns the private key from the DH instance.

This corresponds to DH_get0_key.

Trait Implementations

impl<T> AsRef<DhRef<T>> for Dh<T>

fn as_ref(&self) -> &DhRef<T>

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

impl<T> Borrow<DhRef<T>> for Dh<T>

fn borrow(&self) -> &DhRef<T>

Immutably borrows from an owned value.

impl<T> Deref for Dh<T>

type Target = DhRef<T>

The resulting type after dereferencing.

fn deref(&self) -> &DhRef<T>

Dereferences the value.

impl<T> DerefMut for Dh<T>

fn deref_mut(&mut self) -> &mut DhRef<T>

Mutably dereferences the value.

impl<T> Drop for Dh<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> ForeignType for Dh<T>

type CType = DH

The raw C type.

type Ref = DhRef<T>

The type representing a reference to this type.

unsafe fn from_ptr(ptr: *mut DH) -> Dh<T>

Constructs an instance of this type from its raw type.

fn as_ptr(&self) -> *mut DH

Returns a raw pointer to the wrapped value.

impl<T> TryFrom<Dh<T>> for PKey<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

fn try_from(dh: Dh<T>) -> Result<PKey<T>, ErrorStack>

Performs the conversion.

impl<T> TryFrom<PKey<T>> for Dh<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

fn try_from(pkey: PKey<T>) -> Result<Dh<T>, ErrorStack>

Performs the conversion.

impl<T> Send for Dh<T>

impl<T> Sync for Dh<T>