Enum SigningKey 

#[non_exhaustive]
pub enum SigningKey {
    RsaWithSha1(SigningKey<Sha1>),
    RsaWithSha256(SigningKey<Sha256>),
    RsaWithSha384(SigningKey<Sha384>),
    EcP256(SigningKey),
    EcP384(SigningKey),
}

A signing key for any algorithm supported by the crate.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

RsaWithSha1(SigningKey<Sha1>)

PKCS#1 v1.5 RSA signing key which uses SHA-1 as the digest.

RsaWithSha256(SigningKey<Sha256>)

PKCS#1 v1.5 RSA signing key which uses SHA-256 as the digest.

RsaWithSha384(SigningKey<Sha384>)

PKCS#1 v1.5 RSA signing key which uses SHA-384 as the digest.

EcP256(SigningKey)

ECDSA/P-256 signing key (uses SHA-256 as the digest primitive).

EcP384(SigningKey)

ECDSA/P-384 signing key (uses SHA-384 as the digest primitive).

Implementations

impl SigningKey

pub fn from_key_and_algo( key: PrivateKey, algo: Option<DigestAlgo>, ) -> Result<Self, UnsupportedDigest>

Creates a new SigningKey from a PrivateKey and a DigestAlgo. If no digest algorithm is provided, a default one is used.

For RSA PKCS#1 v1.5 signatures the default is SHA-384, for elliptic curve algorithms the default and the only supported digest algorithms are SHA-256 for NIST P-256 and SHA-384 for NIST P-384.

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 DynSignatureAlgorithmIdentifier for SigningKey

fn signature_algorithm_identifier(&self) -> Result<AlgorithmIdentifierOwned>

AlgorithmIdentifier for the corresponding singature system.

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 From<SigningKey> for PrivateKey

fn from(value: SigningKey) -> Self

Converts to this type from the input type.

impl Keypair for SigningKey

type VerifyingKey = VerifyingKey

Verifying key type for this keypair.

fn verifying_key(&self) -> Self::VerifyingKey

Get the verifying key which can verify signatures produced by the signing key portion of this keypair.

impl Signer<Signature> for SigningKey

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

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