Struct SignedMessage

pub struct SignedMessage<T, S: SignatureEncoding> { /* private fields */ }

A wrapper for a message of type T with support for in-place signing and verifying.

This struct provides functionality for creating and verifying signed messages with the following format:

[ msg-hdr | payload | trailer | signature ]

Where:

• msg-hdr: Message header containing ID, TTL, and flags
• payload: The message payload of type T
• trailer: Optional additional data
• signature: The cryptographic signature

Type Parameters

• T - The type of the message payload
• S - The type of signature encoding used

Implementations

impl<S: SignatureEncoding, T: AnyBitPattern + NoUninit> SignedMessage<T, S>

pub const HEADER_SIZE: usize = 36usize

Size of the message header in bytes.

pub const fn size(trailer: usize) -> usize

Calculates the total size of a signed message.

Arguments

• trailer - Size of the trailer data in bytes

Returns

The total size in bytes needed for the signed message

pub fn new(id: &MsgId, ttl: u32, flags: u16, trailer: usize) -> Self

Creates a new signed message with the specified parameters.

Arguments

• id - Message identifier
• ttl - Time-to-live value
• flags - Message flags
• trailer - Size of trailer data in bytes

Returns

A new SignedMessage instance

pub fn from_buffer( buffer: Vec<u8>, id: &MsgId, ttl: u32, flags: u16, trailer: usize, ) -> Self

Creates a signed message from an existing buffer.

Arguments

• buffer - Existing buffer to use
• id - Message identifier
• ttl - Time-to-live value
• flags - Message flags
• trailer - Size of trailer data in bytes

Returns

A new SignedMessage instance using the provided buffer

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

Returns mutable references to the message payload and trailer.

Returns

A tuple containing:

• Mutable reference to the payload object
• Mutable reference to the trailer bytes

pub fn sign<K: Signer<S>>(self, signing_key: &K) -> Vec<u8>

Signs the message and returns the underlying byte vector.

Arguments

• signing_key - The key used to sign the message

Returns

The signed message as a byte vector

pub fn build<F, K: Signer<S>>( id: &MsgId, ttl: u32, trailer: usize, signing_key: &K, f: F, ) -> Vec<u8>

where F: FnOnce(&mut T, &mut [u8]),

Builds and signs a message using a closure to set the payload.

Arguments

• id - Message identifier
• ttl - Time-to-live value
• trailer - Size of trailer data in bytes
• signing_key - The key used to sign the message
• f - Closure that sets the payload and trailer content

Returns

The signed message as a byte vector

pub fn verify_with_trailer<'msg, V: Verifier<S>>( buffer: &'msg [u8], trailer: usize, verify_key: &V, ) -> Option<(&'msg T, &'msg [u8])>

Verifies a signed message and returns references to the payload and trailer.

Arguments

• buffer - The signed message buffer
• trailer - Size of trailer data in bytes
• verify_key - The key used to verify the signature

Returns

A tuple containing references to the payload and trailer, or None if verification fails

pub fn verify<'msg, V: Verifier<S>>( buffer: &'msg [u8], verify_key: &V, ) -> Option<&'msg T>

Verifies a signed message and returns a reference to the payload.

Arguments

• buffer - The signed message buffer
• verify_key - The key used to verify the signature

Returns

A reference to the payload, or None if verification fails

impl<S: SignatureEncoding> SignedMessage<(), S>

pub fn verify_buffer<V: Verifier<S>>( buffer: &[u8], verify_key: &V, ) -> Option<Range<usize>>

Verifies a message in the buffer and returns the range containing the payload.

Arguments

• buffer - The signed message buffer
• verify_key - The key used to verify the signature

Returns

The range of bytes containing the payload, or None if verification fails