Struct didcomm_rs::Message

pub struct Message {
    pub jwm_header: JwmHeader,
    // some fields omitted
}

DIDComm message structure. Specification

Fields

jwm_header: JwmHeader

JOSE header, which is sent as public part with JWE.

Implementations

impl Message

pub fn new() -> Self

Generates EMPTY default message. Use extension messages to build final one before sending.

pub fn from(self, from: &str) -> Self

Setter of from header Helper method.

pub fn to(self, to: &[&str]) -> Self

Setter of to header Helper method.

pub fn m_type(self, m_type: MessageType) -> Self

Setter of m_type @type header Helper method.

pub fn get_body(&self) -> Result<impl AsRef<[u8]>, Error>

Getter of the body as ref of bytes slice. Helpe method.

pub fn set_body(self, body: &[u8]) -> Self

Setter of the body Helper method.

pub fn kid(self, kid: &str) -> Self

pub fn timed(self, expires: Option<u64>) -> Self

Sets times of creation as now and, optional, expires time.

Parameters

• expires - time in seconds since Unix Epoch when message is considered to be invalid.

pub fn is_rotation(&self) -> bool

Checks if message is rotation one. Exposed for explicit checks on calling code level.

pub fn get_prior(&self) -> Result<PriorClaims, Error>

If message is_rotation() true - returns from_prion claims. Errors otherwise with Error::NoRotationData

pub fn get_didcomm_header(&self) -> &DidcommHeader

&DidcommHeader getter.

pub fn set_didcomm_header(self, h: DidcommHeader) -> Self

Setter of didcomm_header. Replaces existing one with provided by consuming both values. Returns modified instance of Self.

pub fn add_header_field(self, key: String, value: String) -> Self

Adds (or updates) custom unique header key-value pair to the header. This portion of header is not sent as JOSE header.

pub fn as_jws(self, alg: &SignatureAlgorithm) -> Self

Creates set of Jwm related headers for the JWE Modifies JWM related header portion to match encryption implementation and leaves other parts unchanged. TODO + FIXME: complete implementation

pub fn as_jwe(self, alg: &CryptoAlgorithm) -> Self

Creates set of Jwm related headers for the JWS Modifies JWM related header portion to match signature implementation and leaves Other parts unchanged.

For resolve feature will set kid header automatically based on the did document resolved.

pub fn as_raw_json(self) -> Result<String, Error>

Serializez current state of the message into json. Consumes original message - use as raw sealing of envelope.

pub fn seal(self, sk: impl AsRef<[u8]>) -> Result<String, Error>

Seals self and returns ready to send JWE

Parameters

ek - encryption key for inner message payload JWE encryption

pub fn seal_signed(
    self,
    ek: &[u8],
    sk: &[u8],
    signing_algorithm: SignatureAlgorithm
) -> Result<String, Error>

Signs raw message and then packs it to encrypted envelope Spec

Parameters

ek - encryption key for inner message payload JWE encryption

sk - signing key for enveloped message JWS encryption

pub fn routed_by(self, ek: &[u8], mediator_did: &str) -> Result<String, Error>

Wrap self to be mediated by some mediator. Warning: Should be called on a Message instance which is ready to be sent! If message is not properly set up for crypto - this method will propogate error from called .seal() method. Takes one mediator at a time to make sure that mediated chain preserves unchanged. This method can be chained any number of times to match all the mediators in the chain.

Parameters

ek - encryption key for inner message payload JWE encryption

to - list of destination recepients. can be empty (Optional) String::default()

form - used same as in wrapped message, fails if not present with DidResolveFailed error.

TODO: Add examples

impl Message

Associated functions implementations. Possibly not required as Jwe serialization covers this.

pub fn get_iv(received: &[u8]) -> Result<Vec<u8>, Error>

Parses iv value as Vec<u8> from public header. Both regular JSON and Compact representations are accepted. Returns Error on failure. TODO: Add examples

pub fn receive(incomming: &str, sk: &[u8]) -> Result<Self, Error>

Construct a message from received data. Raw or JWE payload is accepted.

impl Message

pub fn encrypt(
    self,
    crypter: SymmetricCypherMethod,
    encryption_key: &[u8]
) -> Result<String, Error>

Encrypts current message by consuming it. Uses provided cryptography function to perform the encryption. Agnostic of actual algorythm used. Consuming is to make sure no changes are possible post packaging / sending. Returns (JwmHeader, Vec<u8>) to be sent to receiver.

pub fn decrypt(
    received_message: &[u8],
    decrypter: SymmetricCypherMethod,
    key: &[u8]
) -> Result<Self, Error>

Decrypts received cypher into instance of Message. Received message should be encrypted with our pub key. Returns Ok(Message) if decryption / deserialization succeded. Error othervice.

pub fn sign(
    self,
    signer: SigningMethod,
    signing_key: &[u8]
) -> Result<String, Error>

Signs message and turns it into Jws envelope. Err is returned if message is not properly prepared or data is malformed. Jws enveloped payload is base64_url encoded

pub fn verify(jws: &[u8], key: &[u8]) -> Result<Message, Error>

Verifyes signature and returns payload message on verification success. Err return if signature invalid or data is malformed. Expects Jws’s payload to be a valid serialized Message and base64_url encoded.

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<'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<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: &Message) -> bool

This method tests for !=.

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