Struct Recipients 

pub struct Recipients { /* private fields */ }

Available on crate feature age only.

Who may read a file this program encrypts.

The other half of Age. Recipients are public keys, so this holds no secret and its Debug says how many there are rather than which.

use dynamic_config::age::Recipients;

// The `age1…` line `age-keygen` prints, or a `recipients.txt` of them.
let recipients = Recipients::from_public_keys(["age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p"])?;

Implementations

impl Recipients

pub fn from_public_keys<I, S>(keys: I) -> Result<Self, Error>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Parses age1… public keys.

Several because a file usually has to be readable by more than one party — a deployment key and the operator who has to fix it at three in the morning.

Errors

If any of them is not an age public key, or the list is empty: a file encrypted to nobody cannot be read by anybody.

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, Error>

Reads recipients from a file, one age1… key per line.

The recipients.txt shape age -R takes. Comments and blank lines are skipped.

Errors

If the file cannot be read, or holds something that is not a recipient.

pub fn from_passphrase(passphrase: impl Into<String>) -> Self

Encrypts to a passphrase instead of a key.

Matches Age::from_passphrase on the reading side. Weaker than a key and awkward to automate, which is the point: a passphrase a program can read is a passphrase in an environment variable.

Trait Implementations

impl Debug for Recipients

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

Formats the value using the given formatter.

impl Encryptor for Recipients

fn encrypt(&self, plaintext: &[u8]) -> Result<Vec<u8>, Error>

Available on crate feature decrypt only.

Encrypts plaintext into the bytes to write.

fn describe(&self) -> String

Available on crate feature decrypt only.

How to name this encryptor in an error.