Enum x509_certificate::algorithm::SignatureAlgorithm

pub enum SignatureAlgorithm {
    RsaSha1,
    RsaSha256,
    RsaSha384,
    RsaSha512,
    EcdsaSha256,
    EcdsaSha384,
    Ed25519,
    NoSignature(DigestAlgorithm),
}

An algorithm used to digitally sign content.

Instances can be converted to/from Oid via From/Into.

Similarly, instances can be converted to/from an ASN.1 AlgorithmIdentifier.

It is also possible to obtain a signature::VerificationAlgorithm from an instance. This type can perform actual cryptographic verification that was signed with this algorithm.

Variants

RsaSha1

SHA-1 with RSA encryption.

Corresponds to OID 1.2.840.113549.1.1.5.

RsaSha256

SHA-256 with RSA encryption.

Corresponds to OID 1.2.840.113549.1.1.11.

RsaSha384

SHA-384 with RSA encryption.

Corresponds to OID 1.2.840.113549.1.1.12.

RsaSha512

SHA-512 with RSA encryption.

Corresponds to OID 1.2.840.113549.1.1.13.

EcdsaSha256

ECDSA with SHA-256.

Corresponds to OID 1.2.840.10045.4.3.2.

EcdsaSha384

ECDSA with SHA-384.

Corresponds to OID 1.2.840.10045.4.3.3.

Ed25519

ED25519

Corresponds to OID 1.3.101.112.

NoSignature(DigestAlgorithm)

No signature with digest algorithm

Corresponds to OID 1.3.6.1.5.5.7.6.2

Implementations

impl SignatureAlgorithm

pub fn from_oid_and_digest_algorithm( oid: &Oid, digest_algorithm: DigestAlgorithm ) -> Result<Self, Error>

Attempt to resolve an instance from an OID, known KeyAlgorithm, and optional DigestAlgorithm.

Signature algorithm OIDs in the wild are typically either:

a) an OID that denotes the key algorithm and corresponding digest format (what this enumeration represents) b) an OID that denotes just the key algorithm.

What this function does is attempt to construct an instance from any OID. If the OID defines a key + digest algorithm, we get a SignatureAlgorithm from that. If we get a key algorithm we combine with the provided DigestAlgorithm to resolve an appropriate SignatureAlgorithm.

pub fn from_digest_algorithm(digest_algorithm: DigestAlgorithm) -> Self

Creates an instance with the noSignature mechanism and DigestAlgorithm

pub fn resolve_verification_algorithm( &self, key_algorithm: KeyAlgorithm ) -> Result<&'static dyn VerificationAlgorithm, Error>

Attempt to resolve the verification algorithm using info about the signing key algorithm.

Only specific combinations of methods are supported. e.g. you can only use RSA verification with RSA signing keys. Same for ECDSA and ED25519.

pub fn digest_algorithm(&self) -> Option<DigestAlgorithm>

Resolve the DigestAlgorithm for this signature algorithm.

Trait Implementations

impl Clone for SignatureAlgorithm

fn clone(&self) -> SignatureAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignatureAlgorithm

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

Formats the value using the given formatter.

impl Display for SignatureAlgorithm

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

Formats the value using the given formatter.

impl From<SignatureAlgorithm> for AlgorithmIdentifier

fn from(alg: SignatureAlgorithm) -> Self

Converts to this type from the input type.

impl From<SignatureAlgorithm> for Oid

fn from(alg: SignatureAlgorithm) -> Self

Converts to this type from the input type.

impl PartialEq for SignatureAlgorithm

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&AlgorithmIdentifier> for SignatureAlgorithm

type Error = X509CertificateError

The type returned in the event of a conversion error.

fn try_from(v: &AlgorithmIdentifier) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Oid> for SignatureAlgorithm

type Error = X509CertificateError

The type returned in the event of a conversion error.

fn try_from(v: &Oid) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for SignatureAlgorithm

impl Eq for SignatureAlgorithm

impl StructuralEq for SignatureAlgorithm

impl StructuralPartialEq for SignatureAlgorithm