Struct SigningKey 

pub struct SigningKey { /* private fields */ }

DSA private key.

The (try_)sign_digest_with_rng API uses regular non-deterministic signatures, while the (try_)sign_digest API uses deterministic signatures as described in RFC 6979

Implementations

impl SigningKey

pub fn from_components(verifying_key: VerifyingKey, x: BigUint) -> Result<Self>

Construct a new private key from the public key and private component

pub fn generate( rng: &mut impl CryptoRngCore, components: Components, ) -> SigningKey

Generate a new DSA keypair

pub const fn verifying_key(&self) -> &VerifyingKey

DSA public key

pub fn x(&self) -> &BigUint

DSA private component

If you decide to clone this value, please consider using Zeroize::zeroize to zero out the memory after you’re done using the clone

pub fn sign_prehashed_rfc6979<D>( &self, prehash: &[u8], ) -> Result<Signature, Error>

where D: Digest + BlockSizeUser + FixedOutputReset,

Try to sign the given message digest deterministically with a prehashed digest. The parameter D must match the hash function used to sign the digest.

Trait Implementations

impl Clone for SigningKey

fn clone(&self) -> SigningKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SigningKey

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

Formats the value using the given formatter.

impl<D> DigestSigner<D, Signature> for SigningKey

where D: Digest + BlockSizeUser + FixedOutputReset,

fn try_sign_digest(&self, digest: D) -> Result<Signature, Error>

Attempt to sign the given prehashed message Digest, returning a digital signature on success, or an error if something went wrong.

fn sign_digest(&self, digest: D) -> S

Sign the given prehashed message Digest, returning a signature.

impl EncodePrivateKey for SigningKey

fn to_pkcs8_der(&self) -> Result<SecretDocument>

Serialize a [SecretDocument] containing a PKCS#8-encoded private key.

fn to_pkcs8_pem( &self, line_ending: LineEnding, ) -> Result<Zeroizing<String>, Error>

Serialize this private key as PEM-encoded PKCS#8 with the given LineEnding.

fn write_pkcs8_der_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Write ASN.1 DER-encoded PKCS#8 private key to the given path

fn write_pkcs8_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding, ) -> Result<(), Error>

Write ASN.1 DER-encoded PKCS#8 private key to the given path

impl PartialEq for SigningKey

fn eq(&self, other: &SigningKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PrehashSigner<Signature> for SigningKey

fn sign_prehash(&self, prehash: &[u8]) -> Result<Signature, Error>

Warning: This uses sha2::Sha256 as the hash function for the digest. If you need to use a different one, use SigningKey::sign_prehashed_rfc6979.

impl<D> RandomizedDigestSigner<D, Signature> for SigningKey

where D: Digest,

fn try_sign_digest_with_rng( &self, rng: &mut impl CryptoRngCore, digest: D, ) -> Result<Signature, Error>

Attempt to sign the given prehashed message Digest, returning a digital signature on success, or an error if something went wrong.

fn sign_digest_with_rng(&self, rng: &mut impl CryptoRngCore, digest: D) -> S

Sign the given prehashed message Digest, returning a signature.

impl RandomizedPrehashSigner<Signature> for SigningKey

fn sign_prehash_with_rng( &self, rng: &mut impl CryptoRngCore, prehash: &[u8], ) -> Result<Signature, Error>

Attempt to sign the given message digest, returning a digital signature on success, or an error if something went wrong.

impl Signer<Signature> for SigningKey

fn try_sign(&self, msg: &[u8]) -> Result<Signature, Error>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign(&self, msg: &[u8]) -> S

Sign the given message and return a digital signature

impl<'a> TryFrom<PrivateKeyInfo<'a>> for SigningKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PrivateKeyInfo<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for SigningKey