[−][src]Struct sequoia_openpgp::serialize::TSK
A reference to a Cert
that allows serialization of secret keys.
To avoid accidental leakage, secret keys are not serialized when a
serializing a Cert
. To serialize Cert
s with secret keys,
use Cert::as_tsk()
to create a TSK
, which is a shim on top
of the Cert
, and serialize this.
Examples
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_);
Implementations
impl<'a> TSK<'a>
[src]
pub fn set_filter<P>(self, predicate: P) -> Self where
P: 'a + Fn(&'a Key<SecretParts, UnspecifiedRole>) -> bool,
[src]
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.
Examples
This example demonstrates how to create a TSK with a detached primary secret key.
use sequoia_openpgp::policy::StandardPolicy; let p = &StandardPolicy::new(); let (cert, _) = CertBuilder::new().add_signing_subkey().generate()?; assert_eq!(cert.keys().with_policy(p, None).alive().revoked(false).secret().count(), 2); // Only write out the subkey's secret. let mut buf = Vec::new(); cert.as_tsk() .set_filter(|k| k.fingerprint() != cert.fingerprint()) .serialize(&mut buf)?; let cert_ = Cert::from_bytes(&buf)?; assert!(! cert_.primary_key().has_secret()); assert_eq!(cert_.keys().with_policy(p, None).alive().revoked(false).secret().count(), 1);
pub fn emit_secret_key_stubs(self, emit_stubs: bool) -> Self
[src]
Changes TSK
to emit secret key stubs.
If TSK::set_filter
is used to selectively export secret
keys, or if the cert contains both keys without secret key
material and with secret key material, then are two ways to
serialize this cert. Neither is sanctioned by the OpenPGP
standard.
The default way is to simply emit public key packets when no secret key material is available. While straight forward, this may be in violation of Section 11.2 of RFC 4880.
The alternative is to emit a secret key packet with a
placeholder secret key value. GnuPG uses this variant with a
private S2K
format. If interoperability with GnuPG is a
concern, use this variant.
See this test for support in other implementations.
Examples
This example demonstrates how to create a TSK with a detached primary secret key, serializing it using secret key stubs.
use sequoia_openpgp as openpgp; use openpgp::packet::key::*; let p = &openpgp::policy::StandardPolicy::new(); let (cert, _) = CertBuilder::new().add_signing_subkey().generate()?; assert_eq!(cert.keys().with_policy(p, None) .alive().revoked(false).unencrypted_secret().count(), 2); // Only write out the subkey's secret, the primary key is "detached". let mut buf = Vec::new(); cert.as_tsk() .set_filter(|k| k.fingerprint() != cert.fingerprint()) .emit_secret_key_stubs(true) .serialize(&mut buf)?; let cert_ = Cert::from_bytes(&buf)?; // The primary key has an "encrypted" stub. assert!(cert_.primary_key().has_secret()); assert_eq!(cert_.keys().with_policy(p, None) .alive().revoked(false).unencrypted_secret().count(), 1);
Trait Implementations
impl<'a> Marshal for TSK<'a>
[src]
pub fn serialize(&self, o: &mut dyn Write) -> Result<()>
[src]
pub fn export(&self, o: &mut dyn Write) -> Result<()>
[src]
impl<'a> MarshalInto for TSK<'a>
[src]
pub fn serialized_len(&self) -> usize
[src]
pub fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>
[src]
pub fn export_into(&self, buf: &mut [u8]) -> Result<usize>
[src]
pub fn to_vec(&self) -> Result<Vec<u8>>
[src]
pub fn export_to_vec(&self) -> Result<Vec<u8>>
[src]
impl<'a> Serialize for TSK<'a>
[src]
pub fn serialize(&self, o: &mut dyn Write) -> Result<()>
[src]
pub fn export(&self, o: &mut dyn Write) -> Result<()>
[src]
impl<'a> SerializeInto for TSK<'a>
[src]
Auto Trait Implementations
impl<'a> !RefUnwindSafe for TSK<'a>
[src]
impl<'a> !Send for TSK<'a>
[src]
impl<'a> !Sync for TSK<'a>
[src]
impl<'a> Unpin for TSK<'a>
[src]
impl<'a> !UnwindSafe for TSK<'a>
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,