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: BTreeMap<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: BTreeMap<Label, Value>

Any additional header values.

Implementations

impl Header

pub fn from_cbor_bstr<E: Error>(val: Value) -> Result<Self, E>

Constructor from a cbor::Value that holds a bstr encoded header.

pub fn to_cbor_bstr(&self) -> Value

Convert this header to a bstr encoded map, as a cbor::Value.

pub fn is_empty(&self) -> bool

Indicate whether the Header is empty.

Trait Implementations

impl CborSerializable for Header

fn from_reader<R: Read>(reader: R) -> Result<Self>

Create an object instance by reading serialized CBOR data from std::io::Read instance.

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

Create an object instance from serialized CBOR data in a slice.

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

Serialize this object to a vector.

fn to_writer<W: Write>(&self, writer: W) -> Result<()>

Serialize this object to a std::io::Write instance.

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<'de> Deserialize<'de> for Header

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

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

This method tests for !=.

impl Serialize for Header

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for Header

impl StructuralEq for Header

impl StructuralPartialEq for Header