# Struct openssl::dsa::Dsa [−] [src]

    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 asymetrical 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>` [src]

#### `pub fn generate(bits: u32) -> Result<Dsa<Private>, ErrorStack>` [src]

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>` [src]

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>` [src]

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

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>` [src]

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>` [src]

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>` [src]

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>` [src]

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

This corresponds to `i2d_DSA_PUBKEY`.

#### `pub fn pub_key(&self) -> &BigNumRef` [src]

Returns a reference to the public key component of `self`.

#### `pub fn private_key_to_pem(&self) -> Result<Vec<u8>, ErrorStack>` [src]

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>` [src]

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` [src]

Returns a reference to the private key component of `self`.

#### `pub fn size(&self) -> u32` [src]

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

OpenSSL documentation at `DSA_size`

#### `pub fn p(&self) -> &BigNumRef` [src]

Returns the DSA prime parameter of `self`.

#### `pub fn q(&self) -> &BigNumRef` [src]

Returns the DSA sub-prime parameter of `self`.

#### `pub fn g(&self) -> &BigNumRef` [src]

Returns the DSA base parameter of `self`.

## Trait Implementations

### `impl<T> AsRef<DsaRef<T>> for Dsa<T>` [src]

#### `fn as_ref(&self) -> &DsaRef<T>` [src]

Performs the conversion.

### `impl<T> Borrow<DsaRef<T>> for Dsa<T>` [src]

#### `fn borrow(&self) -> &DsaRef<T>` [src]

Immutably borrows from an owned value. Read more

### `impl<T> Clone for Dsa<T>` [src]

#### `fn clone(&self) -> Dsa<T>` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl<T> Debug for Dsa<T>` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<T> Deref for Dsa<T>` [src]

#### `type Target = DsaRef<T>`

The resulting type after dereferencing.

#### `fn deref(&self) -> &DsaRef<T>` [src]

Dereferences the value.

### `impl<T> DerefMut for Dsa<T>` [src]

#### `fn deref_mut(&mut self) -> &mut DsaRef<T>` [src]

Mutably dereferences the value.

### `impl<T> Drop for Dsa<T>` [src]

#### `fn drop(&mut self)` [src]

Executes the destructor for this type. Read more

### `impl<T> ForeignType for Dsa<T>` [src]

#### `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>` [src]

Constructs an instance of this type from its raw type.

#### `fn as_ptr(&self) -> *mut DSA` [src]

Returns a raw pointer to the wrapped value.

### `impl<T> Send for Dsa<T>` [src]

### `impl<T> Sync for Dsa<T>` [src]

## Auto Trait Implementations

### `impl<T> RefUnwindSafe for Dsa<T> where
T: RefUnwindSafe,`

### `impl<T> Unpin for Dsa<T> where
T: Unpin,`

### `impl<T> UnwindSafe for Dsa<T> where
T: UnwindSafe,`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `pub fn clone_into(&self, target: &mut T)` [src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.