Struct Message 

pub struct Message { /* private fields */ }

A struct describing a message.

Each message is composed of:

• a payload - optionally encrypted binary data,
• a header - Header struct containing the message’s metadata.

A message is constructed by using the Message::new function which returns a MessageBuilder. Then the builder configures the message using the state pattern and after calling finalize() returns a message ready for sending.

Serialization

Messages implement serde::Serialize and serde::Deserialize traits, which allow for serialization and deserialization using any serde format. Additionally for human readable formats messages serialize bytes as hex encoded strings to please the users’ eyes.

Examples

Constructing a signed and encrypted message.

use pyrus_crypto::message::Message;
use pyrus_crypto::message::MessageFinal;

let secret_text = b"Let's meet up in the evening";
let msg = Message::new(&larry)? // returns MessageBuilder here
    .write(&secret_text[..])? // MessageBuilder
    .sign() // SignedMessage (almost the same API as the builder)
    .encrypt_for(&friends)? // AsmEncryptedMessage (can only finalize)
    .finalize()?; // returns Message

The message may then be base64 encoded for transmission:

let b64msg: String = msg.b64encode()?;

And then decoded back into a message:

let msg_recv = Message::b64decode(b64msg.as_bytes())?;
assert_eq!(msg, msg_recv);

Implementations

impl Message

pub fn new<'a>(issuer: &'a Cert) -> Result<MessageBuilder<'a>>

Starts the construction of the message by returning a MessageBuilder. The builder should be a temporary object and live only for a short duration in a method call chain.

Errors

• CryptoError::NotSecret if the issuer’s certificate does not contain secret keys. (This is not your certificate, why do you try to impersonate people?)

pub fn describe(&self) -> MessageDesc

Reads the header of the message, discards any associated data and returns the type of the message. See MessageDesc for more details.

pub fn issuer(&self) -> &Fingerprint

Convenience function. Instead of checking the header for the message issuer, this function may be use to forward it.

pub fn header(&self) -> &Header

Returns the header of this message for inspection. In reality this is only useful for automated message parsing. The MessageParser internals access the header differently.

pub fn payload(&self) -> &[u8]

Returns the payload of this message. The payload is the optionally encrypted message content and on its own is not useful unless the goal is to implement automated message parsing.

pub fn parse<'a>(self, recipient: &'a Cert) -> Result<MessageParser<'a>>

Starts the process of message parsing. See MessageParser for more details.

Errors

• CryptoError::NotSecret if the recipient’s (decrypting) certificate does not contain secret keys.

pub fn b64encode(&self) -> Result<String>

Encodes the message as a base64 string.

Errors

• CryptoError::SerializationError if a serialization error occured.

pub fn b64decode(repr: impl AsRef<[u8]>) -> Result<Self>

Decodes a message from a base64 representation.

Errors

• CryptoError::SerializationError if a serialization error occured.
• CryptoError::DecodingError if the base64 representation is invalid.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate 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<'de> Deserialize<'de> for Message

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Message

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Message

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Message