Enum pgp::composed::message::Message

pub enum Message {
    Literal(LiteralData),
    Compressed(CompressedData),
    Signed {
        message: Option<Box<Message>>,
        one_pass_signature: Option<OnePassSignature>,
        signature: Signature,
    },
    Encrypted {
        esk: Vec<Esk>,
        edata: Edata,
    },
}

An OpenPGP message

Variants

Literal(LiteralData)

Compressed(CompressedData)

Signed

Fields

message: Option<Box<Message>>

nested message

one_pass_signature: Option<OnePassSignature>

for signature packets that contain a one pass message

signature: Signature

Encrypted

Fields

esk: Vec<Esk>

edata: Edata

Implementations

impl Message

pub fn new_literal(file_name: impl AsRef<BStr>, data: &str) -> Self

pub fn new_literal_bytes(file_name: impl AsRef<BStr>, data: &[u8]) -> Self

pub fn compress(&self, alg: CompressionAlgorithm) -> Result<Self>

Compresses the message.

pub fn decompress(self) -> Result<Self>

Decompresses the data if compressed.

pub fn encrypt_to_keys<R: CryptoRng + Rng>( &self, rng: &mut R, alg: SymmetricKeyAlgorithm, pkeys: &[&impl PublicKeyTrait] ) -> Result<Self>

Encrypt the message to the list of passed in public keys.

pub fn encrypt_with_password<R, F>( &self, rng: &mut R, s2k: StringToKey, alg: SymmetricKeyAlgorithm, msg_pw: F ) -> Result<Self>

where R: Rng + CryptoRng, F: FnOnce() -> String + Clone,

Encrypt the message using the given password.

pub fn sign<F>( self, key: &impl SecretKeyTrait, key_pw: F, hash_algorithm: HashAlgorithm ) -> Result<Self>

where F: FnOnce() -> String,

Sign this message using the provided key.

pub fn into_signature(self) -> StandaloneSignature

Convert the message to a standalone signature according to the cleartext framework.

pub fn verify(&self, key: &impl PublicKeyTrait) -> Result<()>

Verify this message. For signed messages this verifies the signature and for compressed messages they are decompressed and checked for signatures to verify.

Decompresses up to one layer of compressed data.

pub fn get_recipients(&self) -> Vec<&KeyId>

Returns a list of KeyIds that the message is encrypted to. For non encrypted messages this list is empty.

pub fn decrypt<G>( &self, key_pw: G, keys: &[&SignedSecretKey] ) -> Result<(Message, Vec<KeyId>)>

where G: FnOnce() -> String + Clone,

Decrypt the message using the given key. Returns a message decrypter, and a list of KeyIds that are valid recipients of this message.

pub fn decrypt_with_password<F>(&self, msg_pw: F) -> Result<Message>

where F: FnOnce() -> String + Clone,

Decrypt the message using the given key. Returns a message decrypter, and a list of KeyIds that are valid recipients of this message.

pub fn is_one_pass_signed(&self) -> bool

Check if this message is a signature, that was signed with a one pass signature.

pub fn is_literal(&self) -> bool

pub fn get_literal(&self) -> Option<&LiteralData>

pub fn get_content(&self) -> Result<Option<Vec<u8>>>

Returns the underlying content and None if the message is encrypted.

Decompresses up to one layer of compressed data.

pub fn to_armored_writer( &self, writer: &mut impl Write, headers: Option<&BTreeMap<String, String>> ) -> Result<()>

pub fn to_armored_bytes( &self, headers: Option<&BTreeMap<String, String>> ) -> Result<Vec<u8>>

pub fn to_armored_string( &self, headers: Option<&BTreeMap<String, String>> ) -> Result<String>

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Deserializable for Message

fn from_packets<'a, I: Iterator<Item = Result<Packet>> + 'a>( packets: Peekable<I> ) -> Box<dyn Iterator<Item = Result<Self>> + 'a>

Parse a composed message. Ref: https://tools.ietf.org/html/rfc4880#section-11.3

fn from_bytes(bytes: impl Read) -> Result<Self>

Parse a single byte encoded composition.

fn from_string(input: &str) -> Result<(Self, BTreeMap<String, String>)>

Parse a single armor encoded composition.

fn from_string_many<'a>( input: &'a str ) -> Result<(Box<dyn Iterator<Item = Result<Self>> + 'a>, BTreeMap<String, String>)>

Parse an armor encoded list of compositions.

fn from_armor_single<R: Read + Seek>( input: R ) -> Result<(Self, BTreeMap<String, String>)>

Armored ascii data.

fn from_armor_many<'a, R: Read + Seek + 'a>( input: R ) -> Result<(Box<dyn Iterator<Item = Result<Self>> + 'a>, BTreeMap<String, String>)>

Armored ascii data.

fn from_bytes_many<'a>( bytes: impl Read + 'a ) -> Box<dyn Iterator<Item = Result<Self>> + 'a>

Parse a list of compositions in raw byte format.

fn from_reader_single<'a, R: Read + Seek + 'a>( input: R ) -> Result<(Self, Option<BTreeMap<String, String>>)>

Parses a single composition, from either ASCII-armored or binary OpenPGP data.

fn from_reader_many<'a, R: Read + Seek + 'a>( input: R ) -> Result<(Box<dyn Iterator<Item = Result<Self>> + 'a>, Option<BTreeMap<String, String>>)>

Parses a list of compositions, from either ASCII-armored or binary OpenPGP data.

impl PartialEq for Message

fn eq(&self, other: &Message) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Message

fn to_writer<W: Write>(&self, writer: &mut W) -> Result<()>

fn to_bytes(&self) -> Result<Vec<u8>>

impl Eq for Message

impl StructuralPartialEq for Message