Enum sequoia_openpgp::crypto::mpi::SecretKeyMaterial

#[non_exhaustive]pub enum SecretKeyMaterial {
    RSA {
        d: ProtectedMPI,
        p: ProtectedMPI,
        q: ProtectedMPI,
        u: ProtectedMPI,
    },
    DSA {
        x: ProtectedMPI,
    },
    ElGamal {
        x: ProtectedMPI,
    },
    EdDSA {
        scalar: ProtectedMPI,
    },
    ECDSA {
        scalar: ProtectedMPI,
    },
    ECDH {
        scalar: ProtectedMPI,
    },
    Unknown {
        mpis: Box<[ProtectedMPI]>,
        rest: Protected,
    },
}

A secret key.

Provides a typed and structured way of storing multiple MPIs in Key packets. Secret key components are protected by storing them using ProtectedMPI.

Note: This enum cannot be exhaustively matched to allow future extensions.

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.

RSA

RSA secret key.

Fields of RSA

d: ProtectedMPI

Secret exponent, inverse of e in Phi(N).

p: ProtectedMPI

Smaller secret prime.

q: ProtectedMPI

Larger secret prime.

u: ProtectedMPI

Inverse of p mod q.

DSA

NIST DSA secret key.

Fields of DSA

x: ProtectedMPI

Secret key log_g(y) in Zp.

ElGamal

ElGamal secret key.

Fields of ElGamal

x: ProtectedMPI

Secret key log_g(y) in Zp.

EdDSA

DJBs "Twisted" Edwards curve DSA secret key.

Fields of EdDSA

scalar: ProtectedMPI

Secret scalar.

ECDSA

NISTs Elliptic curve DSA secret key.

Fields of ECDSA

scalar: ProtectedMPI

Secret scalar.

ECDH

Elliptic curve ElGamal secret key.

Fields of ECDH

scalar: ProtectedMPI

Secret scalar.

Unknown

Unknown number of MPIs for an unknown algorithm.

Fields of Unknown

mpis: Box<[ProtectedMPI]>

The successfully parsed MPIs.

rest: Protected

Any data that failed to parse.

Implementations

impl SecretKeyMaterial

pub fn algo(&self) -> Option<PublicKeyAlgorithm>

Returns, if known, the public-key algorithm for this secret key.

impl SecretKeyMaterial

pub fn parse_with_checksum<R: Read + Send + Sync>(
    algo: PublicKeyAlgorithm,
    reader: R,
    checksum: SecretKeyChecksum
) -> Result<Self>

Parses secret key MPIs for algo plus their SHA1 checksum.

Fails if the checksum is wrong.

pub fn parse<R: Read + Send + Sync>(
    algo: PublicKeyAlgorithm,
    reader: R
) -> Result<Self>

Parses a set of OpenPGP MPIs representing a secret key.

See Section 3.2 of RFC 4880 for details.

impl SecretKeyMaterial

pub fn serialize_with_checksum(
    &self,
    w: &mut dyn Write,
    checksum: SecretKeyChecksum
) -> Result<()>

Writes this secret key with a checksum to w.

Trait Implementations

impl Clone for SecretKeyMaterial

fn clone(&self) -> SecretKeyMaterial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKeyMaterial

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

Formats the value using the given formatter.

impl Eq for SecretKeyMaterial

impl From<SecretKeyMaterial> for SecretKeyMaterial

fn from(mpis: SecretKeyMaterial) -> Self

Performs the conversion.

impl From<SecretKeyMaterial> for Unencrypted

fn from(mpis: SecretKeyMaterial) -> Self

Performs the conversion.

impl Hash for SecretKeyMaterial

fn hash(&self, hash: &mut dyn Digest)

Updates the given hash with this object.

impl Hash for SecretKeyMaterial

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Marshal for SecretKeyMaterial

fn serialize(&self, w: &mut dyn Write) -> Result<()>

Writes a serialized version of the object to o.

fn export(&self, o: &mut dyn Write) -> Result<()>

Exports a serialized version of the object to o.

impl MarshalInto for SecretKeyMaterial

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serializes into the given buffer.

fn to_vec(&self) -> Result<Vec<u8>>

Serializes the packet to a vector.

fn export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer.

fn export_to_vec(&self) -> Result<Vec<u8>>

Exports to a vector.

impl Ord for SecretKeyMaterial

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<SecretKeyMaterial> for SecretKeyMaterial

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<SecretKeyMaterial> for SecretKeyMaterial

fn partial_cmp(&self, other: &SecretKeyMaterial) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.