Struct SignedSecretKey 

pub struct SignedSecretKey {
    pub primary_key: SecretKey,
    pub details: SignedKeyDetails,
    pub public_subkeys: Vec<SignedPublicSubKey>,
    pub secret_subkeys: Vec<SignedSecretSubKey>,
}

Represents a secret signed PGP key.

Fields

primary_key: SecretKey

details: SignedKeyDetails

public_subkeys: Vec<SignedPublicSubKey>

secret_subkeys: Vec<SignedSecretSubKey>

Implementations

impl SignedSecretKey

pub fn new( primary_key: SecretKey, details: SignedKeyDetails, public_subkeys: Vec<SignedPublicSubKey>, secret_subkeys: Vec<SignedSecretSubKey>, ) -> Self

pub fn expires_at(&self) -> Option<DateTime<Utc>>

Get the secret key expiration as a date.

pub fn verify(&self) -> Result<()>

pub fn to_armored_writer( &self, writer: &mut impl Write, opts: ArmorOptions<'_>, ) -> Result<()>

pub fn to_armored_bytes(&self, opts: ArmorOptions<'_>) -> Result<Vec<u8>>

pub fn to_armored_string(&self, opts: ArmorOptions<'_>) -> Result<String>

pub fn encrypt<R: Rng + CryptoRng>( &self, rng: R, plain: &[u8], typ: EskType, ) -> Result<PkeskBytes>

pub fn public_key(&self) -> PublicKey

pub fn signed_public_key(&self) -> SignedPublicKey

Drops the secret key material in both the primary key and all secret subkeys. All other components of the key remain as they are.

pub fn decrypt_session_key( &self, key_pw: &Password, values: &PkeskBytes, typ: EskType, ) -> Result<Result<PlainSessionKey>>

Decrypts session key using this key.

Methods from Deref<Target = SecretKey>

pub fn secret_params(&self) -> &SecretParams

pub fn has_sha1_checksum(&self) -> bool

Checks if we should expect a SHA1 checksum in the encrypted part.

pub fn unlock<G, T>(&self, pw: &Password, work: G) -> Result<Result<T>>

where G: FnOnce(&PublicParams, &PlainSecretParams) -> Result<T>,

pub fn public_key(&self) -> &PublicKey

pub fn encrypt<R: Rng + CryptoRng>( &self, rng: R, plain: &[u8], typ: EskType, ) -> Result<PkeskBytes>

Trait Implementations

impl Clone for SignedSecretKey

fn clone(&self) -> SignedSecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignedSecretKey

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

Formats the value using the given formatter.

impl Deref for SignedSecretKey

type Target = SecretKey

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deserializable for SignedSecretKey

fn from_packets<'a, I: Iterator<Item = Result<Packet>> + 'a>( packets: Peekable<I>, ) -> Box<dyn Iterator<Item = Result<Self>> + 'a>

Parse a transferable key from packets. Ref: https://www.rfc-editor.org/rfc/rfc9580.html#name-transferable-secret-keys

fn matches_block_type(typ: BlockType) -> bool

Check if the given typ is a valid block type for this type.

fn from_bytes<R: BufRead>(bytes: R) -> Result<Self>

Parse a single byte encoded composition.

fn from_string(input: &str) -> Result<(Self, Headers)>

Parse a single armor encoded composition.

fn from_string_many<'a>( input: &'a str, ) -> Result<(Box<dyn Iterator<Item = Result<Self>> + 'a>, Headers)>

Parse an armor encoded list of compositions.

fn from_armor_single<R: Read>(input: R) -> Result<(Self, Headers)>

Armored ascii data.

fn from_armor_single_buf<R: BufRead>(input: R) -> Result<(Self, Headers)>

Armored ascii data.

fn from_armor_single_buf_with_options<R: BufRead>( input: R, opt: DearmorOptions, ) -> Result<(Self, Headers)>

Armored ascii data, with explicit options for dearmoring.

fn from_armor_many<'a, R: Read + 'a>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self>> + 'a>, Headers)>

Armored ascii data.

fn from_armor_many_buf<'a, R: BufRead + 'a>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self>> + 'a>, Headers)>

Armored ascii data.

fn from_armor_many_buf_with_options<'a, R: BufRead + 'a>( input: R, opt: DearmorOptions, ) -> Result<(Box<dyn Iterator<Item = Result<Self>> + 'a>, Headers)>

Armored ascii data, with explicit options for dearmoring.

fn from_bytes_many<'a, R: BufRead + 'a>( bytes: R, ) -> Result<Box<dyn Iterator<Item = Result<Self>> + 'a>>

Parse a list of compositions in raw byte format.

fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Parse a single binary encoded composition.

fn from_armor_file<P: AsRef<Path>>(path: P) -> Result<(Self, Headers)>

Parse a single armor encoded composition.

fn from_armor_file_many<P: AsRef<Path>>( path: P, ) -> Result<(Box<dyn Iterator<Item = Result<Self>>>, Headers)>

Parse a single armor encoded composition.

fn from_file_many<P: AsRef<Path>>( path: P, ) -> Result<Box<dyn Iterator<Item = Result<Self>>>>

Ready binary packets from the given file.

fn from_reader_single<'a, R: Read + 'a>( input: R, ) -> Result<(Self, Option<Headers>)>

Parses a single composition, from either ASCII-armored or binary OpenPGP data.

fn from_reader_single_buf<'a, R: BufRead + 'a>( input: R, ) -> Result<(Self, Option<Headers>)>

fn from_reader_many<'a, R: Read + 'a>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self>> + 'a>, Option<Headers>)>

Parses a list of compositions, from either ASCII-armored or binary OpenPGP data.

fn from_reader_many_buf<'a, R: BufRead + 'a>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self>> + 'a>, Option<Headers>)>

Parses a list of compositions, from either ASCII-armored or binary OpenPGP data.

impl From<SignedSecretKey> for SignedPublicKey

fn from(value: SignedSecretKey) -> Self

Converts to this type from the input type.

impl Imprint for SignedSecretKey

fn imprint<D: KnownDigest>(&self) -> Result<GenericArray<u8, D::OutputSize>>

An imprint is a shorthand identifier for a key.

impl PartialEq for SignedSecretKey

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

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

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 Serialize for SignedSecretKey

fn to_writer<W: Write>(&self, writer: &mut W) -> Result<()>

fn write_len(&self) -> usize

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

impl TryFrom<PublicOrSecret> for SignedSecretKey

type Error = TryFromPublicOrSecretError

The type returned in the event of a conversion error.

fn try_from(public_or_secret: PublicOrSecret) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SignedSecretKey

impl StructuralPartialEq for SignedSecretKey