mirrors/rage
1
0
Fork 0
mirror of https://github.com/str4d/rage.git synced 2025-04-04 03:17:42 +03:00
Code Issues Projects Releases Packages Wiki Activity

Update docs to permit multiple stanzas from recipients

Browse source 
Closes str4d/rage#524.
This commit is contained in:
Jack Grigg 2024-11-03 07:30:16 +00:00
parent d0889c90af
commit bca6916bac
2 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
age-plugin/src/recipient.rs
View file

@ -81,8 +81,12 @@ pub trait RecipientPluginV1 {
/// Wraps each `file_key` to all recipients and identities previously added via
/// `add_recipient` and `add_identity`.
///
/// Returns either one stanza per recipient and identity for each file key, or any
/// errors if one or more recipients or identities could not be wrapped to.
/// Returns a set of stanzas per file key that wrap it to each recipient and identity.
/// Plugins may return more than one stanza per "actual recipient", e.g. to support
/// multiple formats, to build group aliases, or to act as a proxy.
///
/// If one or more recipients or identities could not be wrapped to, no stanzas are
/// returned for any of the file keys.
///
/// `callbacks` can be used to interact with the user, to have them take some physical
/// action or request a secret value.

3
age/src/lib.rs
View file

@ -326,7 +326,8 @@ pub trait Recipient {
/// and labels that constrain how the stanzas may be combined with those from other
/// recipients.
///
/// Implementations MUST NOT return more than one stanza per "actual recipient".
/// Implementations may return more than one stanza per "actual recipient", e.g. to
/// support multiple formats, to build group aliases, or to act as a proxy.
///
/// This method is part of the `Recipient` trait to expose age's [one joint] for
/// external implementations. You should not need to call this directly; instead, pass