[][src]Struct sequoia_openpgp::parse::stream::Decryptor

pub struct Decryptor<'a, H: VerificationHelper + DecryptionHelper> { /* fields omitted */ }

Decrypts and verifies an encrypted and optionally signed OpenPGP message.

Signature verification requires processing the whole message first. Therefore, OpenPGP implementations supporting streaming operations necessarily must output unverified data. This has been a source of problems in the past. To alleviate this, we buffer up to 25 megabytes of net message data first, and verify the signatures if the message fits into our buffer. Nevertheless it is important to treat the data as unverified and untrustworthy until you have seen a positive verification.

Example

extern crate sequoia_openpgp as openpgp;
extern crate failure;
use std::io::Read;
use openpgp::crypto::SessionKey;
use openpgp::constants::SymmetricAlgorithm;
use openpgp::{KeyID, TPK, Result, packet::{Key, PKESK, SKESK}};
use openpgp::parse::stream::*;

// This fetches keys and computes the validity of the verification.
struct Helper {};
impl VerificationHelper for Helper {
    fn get_public_keys(&mut self, _ids: &[KeyID]) -> Result<Vec<TPK>> {
        Ok(Vec::new()) // Feed the TPKs to the verifier here...
    }
    fn check(&mut self, structure: &MessageStructure) -> Result<()> {
        Ok(()) // Implement your verification policy here.
    }
}
impl DecryptionHelper for Helper {
    fn decrypt<D>(&mut self, _: &[PKESK], skesks: &[SKESK],
                  mut decrypt: D) -> Result<Option<openpgp::Fingerprint>>
        where D: FnMut(SymmetricAlgorithm, &SessionKey) -> Result<()>
    {
        skesks[0].decrypt(&"streng geheim".into())
            .and_then(|(algo, session_key)| decrypt(algo, &session_key))
            .map(|_| None)
    }
}

let message =
   b"-----BEGIN PGP MESSAGE-----

     wy4ECQMIY5Zs8RerVcXp85UgoUKjKkevNPX3WfcS5eb7rkT9I6kw6N2eEc5PJUDh
     0j0B9mnPKeIwhp2kBHpLX/en6RfNqYauX9eSeia7aqsd/AOLbO9WMCLZS5d2LTxN
     rwwb8Aggyukj13Mi0FF5
     =OB/8
     -----END PGP MESSAGE-----";

let h = Helper {};
let mut v = Decryptor::from_bytes(message, h, None)?;

let mut content = Vec::new();
v.read_to_end(&mut content)
    .map_err(|e| if e.get_ref().is_some() {
        // Wrapped failure::Error.  Recover it.
        failure::Error::from_boxed_compat(e.into_inner().unwrap())
    } else {
        // Plain io::Error.
        e.into()
    })?;

assert_eq!(content, b"Hello World!");

Methods

impl<'a, H: VerificationHelper + DecryptionHelper> Decryptor<'a, H>[src]

pub fn from_reader<R, T>(reader: R, helper: H, t: T) -> Result<Decryptor<'a, H>> where
    R: Read + 'a,
    T: Into<Option<Tm>>, 
[src]

Creates a Decryptor from the given reader.

Signature verifications are done relative to time t, or the current time, if t is None.

pub fn from_file<P, T>(path: P, helper: H, t: T) -> Result<Decryptor<'a, H>> where
    P: AsRef<Path>,
    T: Into<Option<Tm>>, 
[src]

Creates a Decryptor from the given file.

Signature verifications are done relative to time t, or the current time, if t is None.

pub fn from_bytes<T>(
    bytes: &'a [u8],
    helper: H,
    t: T
) -> Result<Decryptor<'a, H>> where
    T: Into<Option<Tm>>, 
[src]

Creates a Decryptor from the given buffer.

Signature verifications are done relative to time t, or the current time, if t is None.

pub fn helper_ref(&self) -> &H[src]

Returns a reference to the helper.

pub fn helper_mut(&mut self) -> &mut H[src]

Returns a mutable reference to the helper.

pub fn into_helper(self) -> H[src]

Recovers the helper.

pub fn message_processed(&self) -> bool[src]

Returns true if the whole message has been processed and the verification result is ready. If the function returns false the message did not fit into the internal buffer and unverified data must be read() from the instance until EOF.

Trait Implementations

impl<'a, H: VerificationHelper + DecryptionHelper> Read for Decryptor<'a, H>[src]

Auto Trait Implementations

impl<'a, H> !RefUnwindSafe for Decryptor<'a, H>

impl<'a, H> !Send for Decryptor<'a, H>

impl<'a, H> !Sync for Decryptor<'a, H>

impl<'a, H> Unpin for Decryptor<'a, H> where
    H: Unpin

impl<'a, H> !UnwindSafe for Decryptor<'a, H>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<R> ReadBytesExt for R where
    R: Read + ?Sized

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.