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>, ) -> SignedSecretKey

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

Get the secret key expiration as a date.

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

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

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

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

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

where R: Rng + CryptoRng,

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, Error>, Error>

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, Error>, Error>

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

pub fn public_key(&self) -> &PublicKey

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

where R: Rng + CryptoRng,

Trait Implementations

impl Clone for SignedSecretKey

fn clone(&self) -> SignedSecretKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DcKey for SignedSecretKey

fn to_asc(&self, header: Option<(&str, &str)>) -> String

Serialise the key to ASCII-armored representation.

fn is_private() -> bool

fn dc_fingerprint(&self) -> Fingerprint

The fingerprint for the key.

fn key_id(&self) -> KeyId

fn from_slice(bytes: &[u8]) -> Result<Self>

Create a key from some bytes.

fn from_base64(data: &str) -> Result<Self>

Create a key from a base64 string.

fn from_asc(data: &str) -> Result<(Self, BTreeMap<String, String>)>

Create a key from an ASCII-armored string.

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

Serialise the key as bytes.

fn to_base64(&self) -> String

Serialise the key to a base64 string.

impl DcSecretKey for SignedSecretKey

fn split_public_key(&self) -> Result<SignedPublicKey>

Create a public key from a private one.

impl Debug for SignedSecretKey

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

Formats the value using the given formatter.

impl Deref for SignedSecretKey

type Target = SecretKey

The resulting type after dereferencing.

fn deref(&self) -> &<SignedSecretKey as Deref>::Target

Dereferences the value.

impl Deserializable for SignedSecretKey

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

where I: Iterator<Item = Result<Packet, Error>> + '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>(bytes: R) -> Result<Self, Error>

where R: BufRead,

Parse a single byte encoded composition.

fn from_string( input: &str, ) -> Result<(Self, BTreeMap<String, Vec<String>>), Error>

Parse a single armor encoded composition.

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

Parse an armor encoded list of compositions.

fn from_armor_single<R>( input: R, ) -> Result<(Self, BTreeMap<String, Vec<String>>), Error>

where R: Read,

Armored ascii data.

fn from_armor_single_buf<R>( input: R, ) -> Result<(Self, BTreeMap<String, Vec<String>>), Error>

where R: BufRead,

Armored ascii data.

fn from_armor_many<'a, R>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>> + 'a>, BTreeMap<String, Vec<String>>), Error>

where R: Read + 'a,

Armored ascii data.

fn from_armor_many_buf<'a, R>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>> + 'a>, BTreeMap<String, Vec<String>>), Error>

where R: BufRead + 'a,

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

where R: BufRead + 'a,

Parse a list of compositions in raw byte format.

fn from_file<P>(path: P) -> Result<Self, Error>

where P: AsRef<Path>,

Parse a single binary encoded composition.

fn from_armor_file<P>( path: P, ) -> Result<(Self, BTreeMap<String, Vec<String>>), Error>

where P: AsRef<Path>,

Parse a single armor encoded composition.

fn from_armor_file_many<P>( path: P, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>>>, BTreeMap<String, Vec<String>>), Error>

where P: AsRef<Path>,

Parse a single armor encoded composition.

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

where P: AsRef<Path>,

Ready binary packets from the given file.

fn from_reader_single<'a, R>( input: R, ) -> Result<(Self, Option<BTreeMap<String, Vec<String>>>), Error>

where R: Read + 'a,

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

fn from_reader_single_buf<'a, R>( input: R, ) -> Result<(Self, Option<BTreeMap<String, Vec<String>>>), Error>

where R: BufRead + 'a,

fn from_reader_many<'a, R>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>> + 'a>, Option<BTreeMap<String, Vec<String>>>), Error>

where R: Read + 'a,

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

fn from_reader_many_buf<'a, R>( input: R, ) -> Result<(Box<dyn Iterator<Item = Result<Self, Error>> + 'a>, Option<BTreeMap<String, Vec<String>>>), Error>

where R: BufRead + 'a,

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

impl From<SignedSecretKey> for SignedPublicKey

fn from(value: SignedSecretKey) -> SignedPublicKey

Converts to this type from the input type.

impl Imprint for SignedSecretKey

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

where D: KnownDigest,

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>(&self, writer: &mut W) -> Result<(), Error>

where W: Write,

fn write_len(&self) -> usize

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

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<SignedSecretKey, <SignedSecretKey as TryFrom<PublicOrSecret>>::Error>

Performs the conversion.

impl Eq for SignedSecretKey

impl StructuralPartialEq for SignedSecretKey