Struct sequoia_openpgp::serialize::stream::Encryptor

pub struct Encryptor<'a> { /* fields omitted */ }

Encrypts a packet stream.

Methods

impl<'a> Encryptor<'a>

pub fn for_recipient(inner: Stack<'a, Cookie>, recipient: Recipient<'a>) -> Self

Creates a new encryptor.

The stream will be encrypted using a generated session key, which will be encrypted using the given passwords, and all encryption-capable subkeys of the given Certs.

Unless otherwise specified, the stream is encrypted using AES256. If aead_algo is None, a SEIP packet is emitted, otherwise the given AEAD algorithm is used.

Key preferences of the recipients are not honored.

Example

use std::io::Write;
extern crate sequoia_openpgp as openpgp;
use openpgp::types::KeyFlags;
use openpgp::serialize::stream::{
    Message, Encryptor, LiteralWriter,
};
use openpgp::policy::StandardPolicy;
let p = &StandardPolicy::new();

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

     mQENBFpxtsABCADZcBa1Q3ZLZnju18o0+t8LoQuIIeyeUQ0H45y6xUqyrD5HSkVM
     ...
     -----END PGP PUBLIC KEY BLOCK-----"
).unwrap();

// Build a vector of recipients to hand to Encryptor.
let recipient =
    cert.keys().with_policy(p, None).alive().revoked(false)
    // Or `for_storage_encryption()`, for data at rest.
    .for_transport_encryption()
    .map(|ka| ka.key().into())
    .nth(0).unwrap();

let mut o = vec![];
let message = Message::new(&mut o);
let encryptor =
    Encryptor::for_recipient(message, recipient)
        .build().expect("Failed to create encryptor");
let mut w = LiteralWriter::new(encryptor).build()?;
w.write_all(b"Hello world.")?;
w.finalize()?;

pub fn with_password(inner: Stack<'a, Cookie>, password: Password) -> Self

Creates a new encryptor.

The stream will be encrypted using a generated session key, which will be encrypted using the given passwords, and all encryption-capable subkeys of the given Certs.

Unless otherwise specified, the stream is encrypted using AES256. If aead_algo is None, a SEIP packet is emitted, otherwise the given AEAD algorithm is used.

Key preferences of the recipients are not honored.

Example

use std::io::Write;
extern crate sequoia_openpgp as openpgp;
use openpgp::types::KeyFlags;
use openpgp::serialize::stream::{
    Message, Encryptor, LiteralWriter,
};
let mut o = vec![];
let message = Message::new(&mut o);
let encryptor =
    Encryptor::with_password(message, "совершенно секретно".into())
        .build().expect("Failed to create encryptor");
let mut w = LiteralWriter::new(encryptor).build()?;
w.write_all(b"Hello world.")?;
w.finalize()?;

pub fn add_recipient(self, recipient: Recipient<'a>) -> Self

Adds a recipient.

pub fn add_password(self, password: Password) -> Self

Adds a password.

pub fn sym_algo(self, algo: SymmetricAlgorithm) -> Self

Sets the symmetric algorithm to use.

pub fn aead_algo(self, algo: AEADAlgorithm) -> Self

Enables AEAD and sets the AEAD algorithm to use.

pub fn build(self) -> Result<Stack<'a, Cookie>>

Finalizes the encryptor, returning the writer stack.

Trait Implementations

impl<'a> Debug for Encryptor<'a>

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

Formats the value using the given formatter.

impl<'a> Drop for Encryptor<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Write for Encryptor<'a>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.