Struct Mac0Message 

pub struct Mac0Message {
    pub protected: Header,
    pub unprotected: Header,
    pub payload: Option<Vec<u8>>,
    /* private fields */
}

A COSE_Mac0 message.

Reference: https://datatracker.ietf.org/doc/html/rfc9052#name-maced-messages-with-implici.

Fields

protected: Header

Protected header parameters (e.g. alg), authenticated by the tag.

unprotected: Header

Unprotected header parameters (e.g. kid).

payload: Option<Vec<u8>>

The payload, or None when detached.

Implementations

impl Mac0Message

pub const TAG: u64 = iana::CBORTagCOSEMac0

The on-the-wire CBOR tag for COSE_Mac0.

pub fn new(payload: Option<Vec<u8>>) -> Self

Creates a new message with the given payload.

pub fn to_be_maced( protected_raw: &[u8], external_aad: &[u8], payload: &[u8], ) -> Result<Vec<u8>, Error>

Encodes the MAC_structure to be authenticated (RFC 9052 §6.3).

This is the low-level helper for external or async MAC code. New messages should usually call prepare_tag or prepare_detached_tag so the protected header bytes stored in the message match the bytes being MACed.

pub fn prepare_tag( &mut self, alg: Option<Label>, kid: Option<&[u8]>, external_aad: Option<&[u8]>, ) -> Result<Vec<u8>, Error>

Prepares this embedded-payload message for an externally produced tag.

The returned bytes are the MAC_structure that must be MACed. After an async or remote MAC service returns the tag bytes, call set_tag and then to_vec.

pub fn prepare_detached_tag( &mut self, alg: Option<Label>, kid: Option<&[u8]>, detached_payload: &[u8], external_aad: Option<&[u8]>, ) -> Result<Vec<u8>, Error>

Prepares this detached-payload message for an externally produced tag.

The message’s on-the-wire payload is set to nil; detached_payload is used only in the MAC_structure.

pub fn set_tag(&mut self, tag: impl Into<Vec<u8>>) -> Result<(), Error>

Stores externally produced tag bytes on this message.

pub fn compute( &mut self, macer: &dyn Macer, external_aad: Option<&[u8]>, ) -> Result<(), Error>

Computes the authentication tag with macer.

pub fn compute_detached( &mut self, macer: &dyn Macer, detached_payload: &[u8], external_aad: Option<&[u8]>, ) -> Result<(), Error>

Computes the authentication tag over a detached payload.

The message’s on-the-wire payload is set to nil; detached_payload is used only in the MAC_structure.

pub fn compute_and_encode( &mut self, macer: &dyn Macer, external_aad: Option<&[u8]>, ) -> Result<Vec<u8>, Error>

Computes the tag and encodes the message to tagged COSE_Mac0 bytes.

pub fn compute_detached_and_encode( &mut self, macer: &dyn Macer, detached_payload: &[u8], external_aad: Option<&[u8]>, ) -> Result<Vec<u8>, Error>

Computes a detached-payload tag and encodes the message.

pub fn to_vec(&self) -> Result<Vec<u8>, Error>

Encodes a computed message to tagged COSE_Mac0 bytes.

pub fn to_untagged_vec(&self) -> Result<Vec<u8>, Error>

Encodes a computed message to canonical COSE_Mac0 bytes without the CBOR tag.

pub fn from_slice(data: &[u8]) -> Result<Self, Error>

Decodes a COSE_Mac0 message (tagged or untagged) without verifying it.

pub fn verify( &self, macer: &dyn Macer, external_aad: Option<&[u8]>, ) -> Result<(), Error>

Verifies the authentication tag with macer.

pub fn verify_detached( &self, macer: &dyn Macer, detached_payload: &[u8], external_aad: Option<&[u8]>, ) -> Result<(), Error>

Verifies the authentication tag over a detached payload.

pub fn verify_and_decode( macer: &dyn Macer, data: &[u8], external_aad: Option<&[u8]>, ) -> Result<Self, Error>

Decodes and verifies a COSE_Mac0 message in one step.

pub fn verify_detached_and_decode( macer: &dyn Macer, data: &[u8], detached_payload: &[u8], external_aad: Option<&[u8]>, ) -> Result<Self, Error>

Decodes and verifies a detached-payload COSE_Mac0 message in one step.

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

Returns the authentication tag (empty until computed/decoded).

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

Returns the protected-header bytes used in the MAC structure.

Trait Implementations

impl Clone for Mac0Message

fn clone(&self) -> Mac0Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mac0Message

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

Formats the value using the given formatter.

impl Default for Mac0Message

fn default() -> Mac0Message

Returns the “default value” for a type.

impl PartialEq for Mac0Message

fn eq(&self, other: &Mac0Message) -> 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 StructuralPartialEq for Mac0Message