Struct Recipient 

pub struct Recipient<'a> { /* private fields */ }

A recipient of an encrypted message.

OpenPGP messages are encrypted with the subkeys of recipients, identified by the keyid of said subkeys in the recipient field of PKESK packets (see Section 5.1 of RFC 9580). The keyid may be a wildcard (as returned by KeyID::wildcard()) to obscure the identity of the recipient.

Note that several subkeys in a certificate may be suitable encryption subkeys. OpenPGP does not specify what should happen in this case. Some implementations arbitrarily pick one encryption subkey, while others use all of them. This crate does not dictate a policy, but allows for arbitrary policies. We do, however, suggest to encrypt to all suitable subkeys.

Implementations

impl<'a> Recipient<'a>

pub fn new<F, H, P, R>( features: F, handle: H, key: &'a Key<P, R>, ) -> Recipient<'a>

where F: Into<Option<Features>>, H: Into<Option<KeyHandle>>, P: KeyParts, R: KeyRole,

Creates a new recipient with an explicit recipient keyid.

Note: If you don’t want to change the recipient keyid, Recipients can be created from Key and ValidKeyAmalgamation using From.

Examples

use std::io::Write;
use sequoia_openpgp as openpgp;
use openpgp::cert::prelude::*;
use openpgp::serialize::stream::{
    Recipient, Message, Encryptor,
};
use openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

let cert = Cert::from_bytes(
    "-----BEGIN PGP PUBLIC KEY BLOCK-----

     xjMEWlNvABYJKwYBBAHaRw8BAQdA+EC2pvebpEbzPA9YplVgVXzkIG5eK+7wEAez
     ...
     -----END PGP PUBLIC KEY BLOCK-----"
)?;

let recipients =
    cert.keys().with_policy(p, None).supported().alive().revoked(false)
    // Or `for_storage_encryption()`, for data at rest.
    .for_transport_encryption()
    // Make an anonymous recipient.
    .map(|ka| Recipient::new(ka.valid_cert().features(), None, ka.key()));

let message = Message::new(&mut sink);
let message = Encryptor::for_recipients(message, recipients).build()?;

pub fn key_handle(&self) -> Option<KeyHandle>

Gets the recipient keyid.

Examples

use std::io::Write;
use sequoia_openpgp as openpgp;
use openpgp::cert::prelude::*;
use openpgp::serialize::stream::Recipient;
use openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

let cert = Cert::from_bytes(
    "-----BEGIN PGP PUBLIC KEY BLOCK-----

     xjMEWlNvABYJKwYBBAHaRw8BAQdA+EC2pvebpEbzPA9YplVgVXzkIG5eK+7wEAez
     ...
     -----END PGP PUBLIC KEY BLOCK-----"
)?;

let recipients =
    cert.keys().with_policy(p, None).supported().alive().revoked(false)
    // Or `for_storage_encryption()`, for data at rest.
    .for_transport_encryption()
    .map(Into::into)
    .collect::<Vec<Recipient>>();

assert_eq!(recipients[0].key_handle().unwrap(),
           "8BD8 8E94 C0D2 0333".parse()?);

pub fn set_key_handle<H>(self, handle: H) -> Result<Recipient<'a>, Error>

where H: Into<Option<KeyHandle>>,

Sets the recipient key ID or fingerprint.

When setting the recipient for a v6 key, either None or a fingerprint must be supplied. Returns Error::InvalidOperation if a key ID is given instead.

Examples

use std::io::Write;
use sequoia_openpgp as openpgp;
use openpgp::{KeyHandle, KeyID};
use openpgp::cert::prelude::*;
use openpgp::serialize::stream::{
    Recipient, Message, Encryptor,
};
use openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

let cert = Cert::from_bytes(
    "-----BEGIN PGP PUBLIC KEY BLOCK-----

     xjMEWlNvABYJKwYBBAHaRw8BAQdA+EC2pvebpEbzPA9YplVgVXzkIG5eK+7wEAez
     ...
     -----END PGP PUBLIC KEY BLOCK-----"
)?;

let recipients =
    cert.keys().with_policy(p, None).supported().alive().revoked(false)
    // Or `for_storage_encryption()`, for data at rest.
    .for_transport_encryption()
    .map(|ka| Recipient::from(ka)
        // Set the recipient keyid to the wildcard id.
        .set_key_handle(None)
            .expect("always safe")
        // Same, but explicit.  Don't do this.
        .set_key_handle(KeyHandle::KeyID(KeyID::wildcard()))
            .expect("safe for v4 recipient")
    );

let message = Message::new(&mut sink);
let message = Encryptor::for_recipients(message, recipients).build()?;

Trait Implementations

impl<'a> Debug for Recipient<'a>

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

Formats the value using the given formatter.

impl<'a, P> From<ValidKeyAmalgamation<'a, P, SubordinateRole, ()>> for Recipient<'a>

where P: KeyParts,

fn from(ka: ValidKeyAmalgamation<'a, P, SubordinateRole, ()>) -> Recipient<'a>

Converts to this type from the input type.

impl<'a, P> From<ValidKeyAmalgamation<'a, P, UnspecifiedRole, bool>> for Recipient<'a>

where P: KeyParts,

fn from(ka: ValidKeyAmalgamation<'a, P, UnspecifiedRole, bool>) -> Recipient<'a>

Converts to this type from the input type.