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>

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

fn dc_fingerprint(&self) -> Fingerprint

The fingerprint for the key.

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 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(bytes: impl Read) -> Result<Self, Error>

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>( bytes: impl Read + 'a, ) -> Box<dyn Iterator<Item = Result<Self, Error>> + 'a>

Parse a list of compositions in raw byte format.

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

fn fingerprint(&self) -> Fingerprint

Returns the fingerprint of the associated primary key.

fn key_id(&self) -> KeyId

Returns the Key ID of the associated primary key.

fn verify_signature( &self, hash: HashAlgorithm, data: &[u8], sig: &SignatureBytes, ) -> Result<(), Error>

Verify a signed message. Data will be hashed using hash, before verifying.

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

where R: Rng + CryptoRng,

Encrypt the given plain for this key.

fn serialize_for_hashing(&self, writer: &mut impl Write) -> Result<(), Error>

This is the data used for hashing in a signature. Only uses the public portion of the key.

fn public_params(&self) -> &PublicParams

fn version(&self) -> KeyVersion

fn algorithm(&self) -> PublicKeyAlgorithm

fn created_at(&self) -> &DateTime<Utc>

fn expiration(&self) -> Option<u16>

fn is_signing_key(&self) -> bool

fn is_encryption_key(&self) -> bool

impl SecretKeyTrait for SignedSecretKey

type PublicKey = PublicKey

type Unlocked = SecretKeyRepr

The type representing the unlocked version of this.

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

where F: FnOnce() -> String, G: FnOnce(&<SignedSecretKey as SecretKeyTrait>::Unlocked) -> Result<T, Error>,

Unlock the raw data in the secret parameters.

fn create_signature<F>( &self, key_pw: F, hash: HashAlgorithm, data: &[u8], ) -> Result<SignatureBytes, Error>

where F: FnOnce() -> String,

fn public_key(&self) -> <SignedSecretKey as SecretKeyTrait>::PublicKey

fn hash_alg(&self) -> HashAlgorithm

The suggested hash algorithm to calculate the signature hash digest with, when using this key as a signer

impl Serialize for SignedSecretKey

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

where W: Write,

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

impl Eq for SignedSecretKey

impl StructuralPartialEq for SignedSecretKey