Struct sequoia_openpgp::TSK

pub struct TSK { /* fields omitted */ }

A transferable secret key (TSK).

A TSK (see RFC 4880, section 11.2) can be used to create signatures and decrypt data.

Methods

impl TSK

pub fn from_packet_parser<'a>(ppr: PacketParserResult<'a>) -> Result<Self>

Initializes a TSK from a PacketParser.

pub fn new<'a, O: Into<Option<Cow<'a, str>>>>(
    primary_uid: O
) -> Result<(TSK, Signature)>

Generates a new key OpenPGP key. The key will be capable of encryption and signing. If no user id is given the primary self signature will be a direct key signature.

pub fn tpk<'a>(&'a self) -> &'a TPK

Returns a reference to the corresponding TPK.

pub fn into_tpk(self) -> TPK

Converts to a TPK.

pub fn certify_userid(&self, key: &Key, userid: &UserID) -> Result<Signature>

Signs key and userid with a 3rd party certification.

pub fn certify_key(&self, key: &TPK) -> Result<Signature>

Signs the primary key's self signatures of key.

Methods from Deref<Target = TPK>

pub fn primary(&self) -> &Key

Returns a reference to the primary key.

pub fn primary_key_signature_full(
    &self
) -> Option<(Option<&UserIDBinding>, &Signature)>

Returns the primary key's current self-signature and, if it belong to a user id, a reference to the UserIDBinding.

Normally, the primary key's current self-signature is the primary user id's newest, non-revoked self-signature. However, if all user ids are revoked and there is a direct signature, that is returned. If there is no direct signature, then we return the newest self-signature on the most recently revoked user id (i.e., the binding signature that was last valid). If there are no user ids at all and no direct signatures, then we return None.

pub fn primary_key_signature(&self) -> Option<&Signature>

Returns the primary key's current self-signature.

This function is identical to TPK::primary_key_signature_full(), but it doesn't return the UserIDBinding.

pub fn revoked(&self) -> RevocationStatus

Returns the TPK's revocation status.

Note: this only returns whether the primary key is revoked. If you want to know whether a subkey, user id, etc., is revoked, then you need to query them separately.

pub fn revoke(
    &self,
    code: ReasonForRevocation,
    reason: &[u8]
) -> Result<Signature>

Returns a revocation certificate for the TPK.

pub fn expired(&self) -> bool

Returns whether or not the TPK has expired.

pub fn expired_at(&self, tm: Tm) -> bool

Returns whether or not the key is expired at the given time.

pub fn alive(&self) -> bool

Returns whether or not the TPK is alive.

pub fn alive_at(&self, tm: Tm) -> bool

Returns whether or not the key is alive at the given time.

Important traits for UserIDBindingIter<'a>

impl<'a> Iterator for UserIDBindingIter<'a> type Item = &'a UserIDBinding;

pub fn userids(&self) -> UserIDBindingIter

Returns an iterator over the TPK's valid UserIDBindings.

The primary user id is returned first. A valid UserIDBinding has at least one good self-signature.

Important traits for UserAttributeBindingIter<'a>

impl<'a> Iterator for UserAttributeBindingIter<'a> type Item = &'a UserAttributeBinding;

pub fn user_attributes(&self) -> UserAttributeBindingIter

Returns an iterator over the TPK's valid UserAttributeBindings.

A valid UserIDAttributeBinding has at least one good self-signature.

Important traits for SubkeyBindingIter<'a>

impl<'a> Iterator for SubkeyBindingIter<'a> type Item = &'a SubkeyBinding;

pub fn subkeys(&self) -> SubkeyBindingIter

Returns an iterator over the TPK's valid subkeys.

A valid SubkeyBinding has at least one good self-signature.

Important traits for KeyIter<'a>

impl<'a> Iterator for KeyIter<'a> type Item = (Option<&'a Signature>, RevocationStatus<'a>, &'a Key);

pub fn keys(&self) -> KeyIter

Returns an iterator over all of the TPK's valid keys.

That is, this returns an iterator over the primary key and any subkeys, along with the corresponding signatures.

Note: since a primary key is different from a binding, the iterator is over Keys and not SubkeyBindings. Furthermore, the primary key has no binding signature. Here, the signature carrying the primary key's key flags is returned. There are corner cases where no such signature exists (e.g. partial TPKs), therefore this iterator may return None for the primary key's signature.

A valid Key has at least one good self-signature.

pub fn select_keys<'a, T>(&'a self, cap: KeyFlags, now: T) -> Vec<&'a Key> where
    T: Into<Option<Tm>>, 

Returns all unrevoked (sub)keys that have all capabilities in cap and are valid now. If now is None the current time is used.

Keys are sorted by creation time (newest first). If the primary key qualifies it will always be last. Using the first key should suffice for most use cases.

pub fn fingerprint(&self) -> Fingerprint

Returns the TPK's fingerprint.

pub fn is_tsk(&self) -> bool

Returns whether at least one of the keys includes a secret part.

Trait Implementations

impl Serialize for TSK

fn serialize<W: Write>(&self, o: &mut W) -> Result<()>

Serializes the TSK.

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

Serializes the packet to a vector.

impl<'a> Parse<'a, TSK> for TSK

fn from_reader<R: 'a + Read>(reader: R) -> Result<Self>

Initializes a TSK from a Reader.

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

Initializes a TSK from a File.

fn from_bytes(data: &'a [u8]) -> Result<Self>

Initializes a TSK from a byte string.

impl PartialEq<TSK> for TSK

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TSK) -> bool

This method tests for !=.

impl Deref for TSK

type Target = TPK

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for TSK

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Debug for TSK

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

Formats the value using the given formatter.