Struct JwsHeader 

#[non_exhaustive]
pub struct JwsHeader {
    pub alg: JwsAlgorithm,
    pub typ: Option<String>,
    pub cty: Option<String>,
    pub kid: Option<String>,
    pub jwk: Option<Jwk>,
    pub crit: Option<Vec<String>>,
    pub additional: IndexMap<String, Value>,
}

The JOSE header of a JWS (RFC 7515 §4).

The registered parameters this crate acts on are fields; everything else, x5c and b64 included, lives in additional in insertion order. jwk is the public key the signer claims to have used; trusting it is the verifier’s decision, never the crate’s.

Examples

use identity_kit::jose::{JwsAlgorithm, JwsHeader};

let mut header = JwsHeader::new(JwsAlgorithm::ES256).with_kid("did:example:123#key-1");
header.typ = Some("JWT".to_owned());
assert_eq!(
    serde_json::to_string(&header)?,
    r#"{"alg":"ES256","typ":"JWT","kid":"did:example:123#key-1"}"#
);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

alg: JwsAlgorithm

The signature algorithm (alg).

typ: Option<String>

The media type of the whole JWS (typ), such as JWT or vc+jwt.

cty: Option<String>

The media type of the payload (cty).

kid: Option<String>

The key id (kid); for a DID controller, usually a DID URL with a fragment.

jwk: Option<Jwk>

The public key the signature was made with (jwk).

crit: Option<Vec<String>>

Extensions a recipient must understand (crit).

additional: IndexMap<String, Value>

Every other header parameter, in insertion order.

Implementations

impl JwsHeader

pub fn new(alg: JwsAlgorithm) -> Self

A header with only alg set.

pub fn with_kid(self, kid: impl Into<String>) -> Self

This header with its kid set.

pub fn with_typ(self, typ: impl Into<String>) -> Self

This header with its typ set.

Trait Implementations

impl Clone for JwsHeader

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JwsHeader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JwsHeader

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for JwsHeader

impl PartialEq for JwsHeader

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for JwsHeader

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 JwsHeader