Struct Key 

pub struct Key { /* private fields */ }

A handle to a key.

A key encapsulates secret key material, and exposes some secret key operations like decrypting a message, signing a message, changing the key’s password, and deleting the secret key material. Not all keys implement all operations. In particular, a key will typically either implement Key::decrypt_ciphertext or Key::sign_message.

Implementations

impl Key

pub fn key_handle(&self) -> KeyHandle

Returns the key’s key handle.

pub fn fingerprint(&self) -> Fingerprint

Returns the key’s fingerprint.

pub fn keyid(&self) -> KeyID

Returns the key’s Key ID.

pub fn public_key(&self) -> &Key<PublicParts, UnspecifiedRole>

Returns the key’s public key.

pub fn id(&mut self) -> Result<String>

Returns a unique key identifier.

It should be a well-formed UTF-8 string, which should give a curious user a pretty good idea of what key this is.

pub async fn id_async(&mut self) -> Result<String>

Returns a unique key identifier.

It should be a well-formed UTF-8 string, which should give a curious user a pretty good idea of what key this is.

pub fn unlock(&mut self, password: Password) -> Result<()>

Unlocks a key.

A key is typically unlocked by providing a password or pin. Not all keys are locked. If the key is not available, this should attempt to connect to the device. If the device is not available or cannot be initialized, then this should fail.

pub async fn unlock_async(&mut self, password: Password) -> Result<()>

Unlocks a key.

A key is typically unlocked by providing a password or pin. Not all keys are locked. If the key is not available, this should attempt to connect to the device. If the device is not available or cannot be initialized, then this should fail.

pub fn decrypt_ciphertext( &mut self, ciphertext: &Ciphertext, plaintext_len: Option<usize>, ) -> Result<SessionKey>

Decrypts a ciphertext.

This function corresponds to Decryptor::decrypt.

When decrypting a message you normally don’t want to manually try to decrypt each PKESK using this function, but use Keystore::decrypt, which first tries to use keys that don’t require user interaction.

If you want to decrypt a PKESK, then you should pass the Key to PKESK::decrypt.

pub async fn decrypt_ciphertext_async( &mut self, ciphertext: &Ciphertext, plaintext_len: Option<usize>, ) -> Result<SessionKey>

Decrypts a ciphertext.

This function corresponds to Decryptor::decrypt.

When decrypting a message you normally don’t want to manually try to decrypt each PKESK using this function, but use Keystore::decrypt, which first tries to use keys that don’t require user interaction.

If you want to decrypt a PKESK, then you should pass the Key to PKESK::decrypt.

pub fn sign_message( &mut self, hash_algo: HashAlgorithm, digest: &[u8], ) -> Result<Signature>

Signs a message.

digest is the message to sign.

pub async fn sign_message_async( &mut self, hash_algo: HashAlgorithm, digest: &[u8], ) -> Result<Signature>

Signs a message.

digest is the message to sign.

pub fn available(&mut self) -> Result<bool>

Whether the key is available.

If false, this usually means the device needs to be connected, e.g., a smartcard needs to be plugged in.

pub async fn available_async(&mut self) -> Result<bool>

Whether the key is available.

If false, this usually means the device needs to be connected, e.g., a smartcard needs to be plugged in.

pub fn locked(&mut self) -> Result<Protection>

Whether the key is locked, and the type of protection.

pub async fn locked_async(&mut self) -> Result<Protection>

Whether the key is locked, and the type of protection.

pub fn password_source(&mut self) -> Result<PasswordSource>

How the password is obtained to unlock the key.

This is independent of whether the key is currently protected.

pub async fn password_source_async(&mut self) -> Result<PasswordSource>

How the password is obtained to unlock the key.

This is independent of whether the key is currently protected.

pub fn decryption_capable(&mut self) -> Result<bool>

Whether the key can be used for decryption.

pub async fn decryption_capable_async(&mut self) -> Result<bool>

Whether the key can be used for decryption.

pub fn signing_capable(&mut self) -> Result<bool>

Whether the key can be used for signing.

pub async fn signing_capable_async(&mut self) -> Result<bool>

Whether the key can be used for signing.

pub fn export(&mut self) -> Result<Key<SecretParts, UnspecifiedRole>>

Exports the secret key material.

pub async fn export_async( &mut self, ) -> Result<Key<SecretParts, UnspecifiedRole>>

Exports the secret key material.

pub fn change_password(&mut self, password: Option<&Password>) -> Result<()>

Changes the key’s password.

pub async fn change_password_async( &mut self, password: Option<&Password>, ) -> Result<()>

Changes the key’s password.

pub fn delete_secret_key_material(&mut self) -> Result<()>

Deletes the specified key’s secret key material.

On success, the key is no registered with the device, and future operations on the current key handle will fail.

pub async fn delete_secret_key_material_async(&mut self) -> Result<()>

Deletes the specified key’s secret key material.

On success, the key is no registered with the device, and future operations on the current key handle will fail.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Decryptor for &mut Key

fn public(&self) -> &Key<PublicParts, UnspecifiedRole>

Returns a reference to the public key.

fn decrypt( &mut self, ciphertext: &Ciphertext, plaintext_len: Option<usize>, ) -> Result<SessionKey>

Decrypts ciphertext, returning the plain session key.

impl Decryptor for Key

fn public(&self) -> &Key<PublicParts, UnspecifiedRole>

Returns a reference to the public key.

fn decrypt( &mut self, ciphertext: &Ciphertext, plaintext_len: Option<usize>, ) -> Result<SessionKey>

Decrypts ciphertext, returning the plain session key.

impl Signer for &mut Key

fn public(&self) -> &Key<PublicParts, UnspecifiedRole>

Returns a reference to the public key.

fn sign(&mut self, hash_algo: HashAlgorithm, digest: &[u8]) -> Result<Signature>

Creates a signature over the digest produced by hash_algo.

fn acceptable_hashes(&self) -> &[HashAlgorithm]

Returns a list of hashes that this signer accepts.

impl Signer for Key

fn public(&self) -> &Key<PublicParts, UnspecifiedRole>

Returns a reference to the public key.

fn sign(&mut self, hash_algo: HashAlgorithm, digest: &[u8]) -> Result<Signature>

Creates a signature over the digest produced by hash_algo.

fn acceptable_hashes(&self) -> &[HashAlgorithm]

Returns a list of hashes that this signer accepts.