Struct openssl::dsa::Dsa

pub struct Dsa<T>(_, _);

Object representing DSA keys.

A DSA object contains the parameters p, q, and g. There is a private and public key. The values p, g, and q are:

• p: DSA prime parameter
• q: DSA sub-prime parameter
• g: DSA base parameter

These values are used to calculate a pair of asymmetrical keys used for signing.

OpenSSL documentation at DSA_new

Examples

use openssl::dsa::Dsa;
use openssl::error::ErrorStack;
use openssl::pkey::Private;

fn create_dsa() -> Result<Dsa<Private>, ErrorStack> {
    let sign = Dsa::generate(2048)?;
    Ok(sign)
}

Implementations

impl Dsa<Private>

pub fn generate(bits: u32) -> Result<Dsa<Private>, ErrorStack>

Generate a DSA key pair.

Calls DSA_generate_parameters_ex to populate the p, g, and q values. These values are used to generate the key pair with DSA_generate_key.

The bits parameter corresponds to the length of the prime p.

pub fn from_private_components(
    p: BigNum,
    q: BigNum,
    g: BigNum,
    priv_key: BigNum,
    pub_key: BigNum
) -> Result<Dsa<Private>, ErrorStack>

Create a DSA key pair with the given parameters

p, q and g are the common parameters. priv_key is the private component of the key pair. pub_key is the public component of the key. Can be computed via g^(priv_key) mod p

impl Dsa<Public>

pub fn public_key_from_pem(pem: &[u8]) -> Result<Dsa<Public>, ErrorStack>

Decodes a PEM-encoded SubjectPublicKeyInfo structure containing a DSA key.

The input should have a header of -----BEGIN PUBLIC KEY-----.

This corresponds to PEM_read_bio_DSA_PUBKEY.

pub fn public_key_from_der(der: &[u8]) -> Result<Dsa<Public>, ErrorStack>

Decodes a DER-encoded SubjectPublicKeyInfo structure containing a DSA key.

This corresponds to d2i_DSA_PUBKEY.

pub fn from_public_components(
    p: BigNum,
    q: BigNum,
    g: BigNum,
    pub_key: BigNum
) -> Result<Dsa<Public>, ErrorStack>

Create a new DSA key with only public components.

p, q and g are the common parameters. pub_key is the public component of the key.

Methods from Deref<Target = DsaRef<T>>

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

Serialies the public key into a PEM-encoded SubjectPublicKeyInfo structure.

The output will have a header of -----BEGIN PUBLIC KEY-----.

This corresponds to PEM_write_bio_DSA_PUBKEY.

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

Serializes the public key into a DER-encoded SubjectPublicKeyInfo structure.

This corresponds to i2d_DSA_PUBKEY.

pub fn pub_key(&self) -> &BigNumRef

Returns a reference to the public key component of self.

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

Serializes the private key to a PEM-encoded DSAPrivateKey structure.

The output will have a header of -----BEGIN DSA PRIVATE KEY-----.

This corresponds to PEM_write_bio_DSAPrivateKey.

pub fn private_key_to_pem_passphrase(
    &self,
    cipher: Cipher,
    passphrase: &[u8]
) -> Result<Vec<u8>, ErrorStack>

Serializes the private key to a PEM-encoded encrypted DSAPrivateKey structure.

The output will have a header of -----BEGIN DSA PRIVATE KEY-----.

This corresponds to PEM_write_bio_DSAPrivateKey.

pub fn priv_key(&self) -> &BigNumRef

Returns a reference to the private key component of self.

pub fn size(&self) -> u32

Returns the maximum size of the signature output by self in bytes.

OpenSSL documentation at DSA_size

pub fn p(&self) -> &BigNumRef

Returns the DSA prime parameter of self.

pub fn q(&self) -> &BigNumRef

Returns the DSA sub-prime parameter of self.

pub fn g(&self) -> &BigNumRef

Returns the DSA base parameter of self.

Trait Implementations

impl<T> AsRef<DsaRef<T>> for Dsa<T>

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

Performs the conversion.

impl<T> Borrow<DsaRef<T>> for Dsa<T>

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

Immutably borrows from an owned value.

impl<T> Clone for Dsa<T>

fn clone(&self) -> Dsa<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Dsa<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Deref for Dsa<T>

type Target = DsaRef<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Dsa<T>

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

Mutably dereferences the value.

impl<T> Drop for Dsa<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> ForeignType for Dsa<T>

type CType = DSA

The raw C type.

type Ref = DsaRef<T>

The type representing a reference to this type.

unsafe fn from_ptr(ptr: *mut DSA) -> Dsa<T>

Constructs an instance of this type from its raw type.

fn as_ptr(&self) -> *mut DSA

Returns a raw pointer to the wrapped value.

impl<T> TryFrom<Dsa<T>> for PKey<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

fn try_from(dsa: Dsa<T>) -> Result<PKey<T>, ErrorStack>

Performs the conversion.

impl<T> TryFrom<PKey<T>> for Dsa<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> Send for Dsa<T>

impl<T> Sync for Dsa<T>