Enum 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,
    },
    X25519 {
        x: Protected,
    },
    X448 {
        x: Protected,
    },
    Ed25519 {
        x: Protected,
    },
    Ed448 {
        x: Protected,
    },
    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.

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

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

x: ProtectedMPI

Secret key log_g(y) in Zp.

ElGamal

ElGamal secret key.

Fields

x: ProtectedMPI

Secret key log_g(y) in Zp.

EdDSA

DJB’s “Twisted” Edwards curve DSA secret key.

Fields

scalar: ProtectedMPI

Secret scalar.

ECDSA

NIST’s Elliptic Curve DSA secret key.

Fields

scalar: ProtectedMPI

Secret scalar.

ECDH

Elliptic Curve Diffie-Hellman secret key.

Fields

scalar: ProtectedMPI

Secret scalar.

X25519

X25519 secret key.

Fields

x: Protected

The secret key, an opaque string.

X448

X448 secret key.

Fields

x: Protected

The secret key, an opaque string.

Ed25519

Ed25519 secret key.

Fields

x: Protected

The secret key, an opaque string.

Ed448

Ed448 secret key.

Fields

x: Protected

The secret key, an opaque string.

Unknown

Unknown number of MPIs for an unknown algorithm.

Fields

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>

👎Deprecated since 1.14.0: Leaks secrets into the heap, use [SecretKeyMaterial::from_bytes_with_checksum]

Parses secret key MPIs for algo plus their SHA1 checksum.

Fails if the checksum is wrong.

pub fn from_bytes_with_checksum( algo: PublicKeyAlgorithm, bytes: &[u8], 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>

👎Deprecated since 1.14.0: Leaks secrets into the heap, use [SecretKeyMaterial::from_bytes]

Parses a set of OpenPGP MPIs representing a secret key.

See Section 3.2 of RFC 9580 for details.

pub fn from_bytes(algo: PublicKeyAlgorithm, buf: &[u8]) -> Result<Self>

Parses a set of OpenPGP MPIs representing a secret key.

See Section 3.2 of RFC 9580 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 duplicate of the value.

const 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 From<SecretKeyMaterial> for SecretKeyMaterial

fn from(mpis: SecretKeyMaterial) -> Self

Converts to this type from the input type.

impl From<SecretKeyMaterial> for Unencrypted

fn from(mpis: SecretKeyMaterial) -> Self

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Hash for SecretKeyMaterial

fn hash(&self, hash: &mut Context) -> Result<()>

Updates the given hash with this object.

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.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SecretKeyMaterial

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

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

const 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 PartialOrd for SecretKeyMaterial

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for SecretKeyMaterial