Enum pgp::native::Message

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

An OpenPGP message

Variants

Literal(LiteralData)

Compressed(CompressedData)

Signed

Fields

message: Option<Box<Message, Global>>

nested message

one_pass_signature: Option<OnePassSignature>

for signature packets that contain a one pass message

signature: Signature

Encrypted

Fields

esk: Vec<Esk, Global>

edata: Vec<Edata, Global>

Implementations

impl Message

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

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

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

Compresses the message.

pub fn decompress(self) -> Result<Message, Error>

Decompresses the data if compressed.

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

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<Message, Error>where R: Rng + CryptoRng, F: FnOnce() -> String + Clone,

Encrytp the message using the given password.

pub fn sign<F>( self, key: &impl SecretKeyTrait, key_pw: F, hash_algorithm: HashAlgorithm ) -> Result<Message, Error>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<(), Error>

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

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

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

pub fn decrypt<G, 'a>( &'a self, key_pw: G, keys: &[&SignedSecretKey] ) -> Result<(MessageDecrypter<'a>, Vec<KeyId, Global>), Error>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<MessageDecrypter<'_>, Error>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, Global>>, Error>

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

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

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

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

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<(), Error>

Formats the value using the given formatter.

impl Deserializable for Message

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

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

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

Parse a single byte encoded composition.

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

Parse a single armor encoded composition.

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

Parse an armor encoded list of compositions.

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

Armored ascii data.

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

Armored ascii data.

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

Parse a list of compositions in raw byte format.

impl PartialEq<Message> 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>(&self, writer: &mut W) -> Result<(), Error>where W: Write,

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

impl Eq for Message

impl StructuralEq for Message

impl StructuralPartialEq for Message