Enum sequoia_openpgp::crypto::mpi::SecretKeyMaterial

source ·
#[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, }, }
Expand description

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)§

This enum is marked as 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.

§

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§

source§

impl SecretKeyMaterial

source

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

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

source§

impl SecretKeyMaterial

source

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.

source

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.

source

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 4880 for details.

source

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 4880 for details.

source§

impl SecretKeyMaterial

source

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

Writes this secret key with a checksum to w.

Trait Implementations§

source§

impl Clone for SecretKeyMaterial

source§

fn clone(&self) -> SecretKeyMaterial

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SecretKeyMaterial

source§

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

Formats the value using the given formatter. Read more
source§

impl From<SecretKeyMaterial> for SecretKeyMaterial

source§

fn from(mpis: SecretKeyMaterial) -> Self

Converts to this type from the input type.
source§

impl From<SecretKeyMaterial> for Unencrypted

source§

fn from(mpis: SecretKeyMaterial) -> Self

Converts to this type from the input type.
source§

impl Hash for SecretKeyMaterial

source§

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

Updates the given hash with this object.
source§

impl Hash for SecretKeyMaterial

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Marshal for SecretKeyMaterial

source§

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

Writes a serialized version of the object to o.
source§

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

Exports a serialized version of the object to o. Read more
source§

impl MarshalInto for SecretKeyMaterial

source§

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation. Read more
source§

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

Serializes into the given buffer. Read more
source§

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

Serializes the packet to a vector.
source§

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

Exports into the given buffer. Read more
source§

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

Exports to a vector. Read more
source§

impl Ord for SecretKeyMaterial

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for SecretKeyMaterial

source§

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

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

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.
source§

impl PartialOrd for SecretKeyMaterial

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Eq for SecretKeyMaterial

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T