Struct sequoia_openpgp::serialize::TSK

pub struct TSK<'a> { /* fields omitted */ }

A reference to a Cert that allows serialization of secret keys.

To avoid accidental leakage Cert::serialize() skips secret keys. To serialize Certs with secret keys, use Cert::as_tsk() to create a TSK, which is a shim on top of the Cert, and serialize this.

Example

let (cert, _) = CertBuilder::new().generate()?;
assert!(cert.is_tsk());

let mut buf = Vec::new();
cert.as_tsk().serialize(&mut buf)?;

let cert_ = Cert::from_bytes(&buf)?;
assert!(cert_.is_tsk());
assert_eq!(cert, cert_);

Methods

impl<'a> TSK<'a>

pub fn set_filter<P>(self, predicate: P) -> Self where
    P: 'a + Fn(&'a Key<SecretParts, UnspecifiedRole>) -> bool, 

Filters which secret keys to export using the given predicate.

Note that the given filter replaces any existing filter.

Example

let (cert, _) = CertBuilder::new().add_signing_subkey().generate()?;
assert_eq!(cert.keys().alive().revoked(false).secret().count(), 2);

// Only write out the primary key's secret.
let mut buf = Vec::new();
cert.as_tsk()
    .set_filter(
        |k| k == cert.primary()
                 .mark_parts_secret_ref().unwrap()
                 .mark_role_unspecified_ref())
    .serialize(&mut buf)?;

let cert_ = Cert::from_bytes(&buf)?;
assert_eq!(cert_.keys().alive().revoked(false).secret().count(), 1);
assert!(cert_.primary().secret().is_some());

Trait Implementations

impl<'a> Serialize for TSK<'a>

fn serialize(&self, o: &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<'a> SerializeInto for TSK<'a>

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 export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer.

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

Serializes the packet to a vector.

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

Exports to a vector.