Struct coset::Header

pub struct Header {
    pub alg: Option<Algorithm>,
    pub crit: Vec<RegisteredLabel<HeaderParameter>>,
    pub content_type: Option<ContentType>,
    pub key_id: Vec<u8>,
    pub iv: Vec<u8>,
    pub partial_iv: Vec<u8>,
    pub counter_signatures: Vec<CoseSignature>,
    pub rest: Vec<(Label, Value)>,
}

Structure representing a common COSE header map.

  header_map = {
      Generic_Headers,
      * label => values
  }

  Generic_Headers = (
      ? 1 => int / tstr,  ; algorithm identifier
      ? 2 => [+label],    ; criticality
      ? 3 => tstr / int,  ; content type
      ? 4 => bstr,        ; key identifier
      ? 5 => bstr,        ; IV
      ? 6 => bstr,        ; Partial IV
      ? 7 => COSE_Signature / [+COSE_Signature] ; Counter signature
  )

Fields

alg: Option<Algorithm>

Cryptographic algorithm to use

crit: Vec<RegisteredLabel<HeaderParameter>>

Critical headers to be understood

content_type: Option<ContentType>

Content type of the payload

key_id: Vec<u8>

Key identifier.

iv: Vec<u8>

Full initialization vector

partial_iv: Vec<u8>

Partial initialization vector

counter_signatures: Vec<CoseSignature>

Counter signature

rest: Vec<(Label, Value)>

Any additional header (label,value) pairs. If duplicate labels are present, CBOR-encoding will fail.

Implementations

impl Header

pub fn is_empty(&self) -> bool

Indicate whether the Header is empty.

Trait Implementations

impl AsCborValue for Header

fn from_cbor_value(value: Value) -> Result<Self>

Convert a [Value] into an instance of the type.

fn to_cbor_value(self) -> Result<Value>

Convert the object into a [Value], consuming it along the way.

impl CborSerializable for Header

fn from_slice(slice: &[u8]) -> Result<Self>

Create an object instance from serialized CBOR data in a slice. This method will fail (with CoseError::ExtraneousData) if there is additional CBOR data after the object.

fn to_vec(self) -> Result<Vec<u8>>

Serialize this object to a vector, consuming it along the way.

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Header

Returns the “default value” for a type.

impl PartialEq<Header> for Header

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