Enum age::Decryptor

pub enum Decryptor {
    Identities {
        identities: Vec<Identity>,
        callbacks: Box<dyn Callbacks>,
    },
    Passphrase {
        passphrase: SecretString,
        max_work_factor: Option<u8>,
    },
}

Handles the various types of age decryption.

Variants

Identities

Trial decryption against a list of identities.

Fields of Identities

identities: Vec<Identity>

The identities to use.

callbacks: Box<dyn Callbacks>

A handler for any callbacks triggered by an Identity.

Passphrase

Decryption with a passphrase.

Fields of Passphrase

passphrase: SecretString

The passphrase to decrypt with.

max_work_factor: Option<u8>

The maximum accepted work factor. If None, the default maximum is adjusted to around 16 seconds of work.

Methods

impl Decryptor

pub fn with_identities(identities: Vec<Identity>) -> Self

Creates a decryptor with a list of identities.

The decryptor will have no callbacks registered, so it will be unable to use identities that require e.g. a passphrase to decrypt.

pub fn with_identities_and_callbacks(
    identities: Vec<Identity>,
    callbacks: Box<dyn Callbacks>
) -> Self

Creates a decryptor with a list of identities and a callback handler.

The decryptor will have no callbacks registered, so it will be unable to use identities that require e.g. a passphrase to decrypt.

pub fn with_passphrase(passphrase: SecretString) -> Self

Creates a decryptor with a passphrase and the default max work factor.

pub fn trial_decrypt<R: Read>(&self, input: R) -> Result<impl Read, Error>

Attempts to decrypt a message from the given reader.

request_passphrase is a closure that will be called when an underlying key needs to be decrypted before it can be used to decrypt the message.

If successful, returns a reader that will provide the plaintext.

pub fn trial_decrypt_seekable<R: Read + Seek>(
    &self,
    input: R
) -> Result<StreamReader<R>, Error>

Attempts to decrypt a message from the given seekable reader.

request_passphrase is a closure that will be called when an underlying key needs to be decrypted before it can be used to decrypt the message.

If successful, returns a seekable reader that will provide the plaintext.