Struct josekit::jws::JwsHeader

pub struct JwsHeader { /* private fields */ }

Represent JWS header claims

Implementations

impl JwsHeader

pub fn new() -> Self

Return a JwsHeader instance.

pub fn from_bytes(value: &[u8]) -> Result<Self, JoseError>

Return a new header instance from json style header.

Arguments

• value - The json style header claims

pub fn from_map(map: impl Into<Map<String, Value>>) -> Result<Self, JoseError>

Return a new header instance from map.

Arguments

• map - JWT header claims.

pub fn set_algorithm(&mut self, value: impl Into<String>)

Set a value for algorithm header claim (alg).

Arguments

• value - a algorithm

pub fn algorithm(&self) -> Option<&str>

Return the value for algorithm header claim (alg).

pub fn set_jwk_set_url(&mut self, value: impl Into<String>)

Set a value for JWK set URL header claim (jku).

Arguments

• value - a JWK set URL

pub fn jwk_set_url(&self) -> Option<&str>

Return the value for JWK set URL header claim (jku).

pub fn set_jwk(&mut self, value: Jwk)

Set a value for JWK header claim (jwk).

Arguments

• value - a JWK

pub fn jwk(&self) -> Option<Jwk>

Return the value for JWK header claim (jwk).

pub fn set_x509_url(&mut self, value: impl Into<String>)

Set a value for X.509 URL header claim (x5u).

Arguments

• value - a X.509 URL

pub fn x509_url(&self) -> Option<&str>

Return a value for a X.509 URL header claim (x5u).

pub fn set_x509_certificate_chain(&mut self, values: &Vec<impl AsRef<[u8]>>)

Set values for X.509 certificate chain header claim (x5c).

Arguments

• values - X.509 certificate chain

pub fn x509_certificate_chain(&self) -> Option<Vec<Vec<u8>>>

Return values for a X.509 certificate chain header claim (x5c).

pub fn set_x509_certificate_sha1_thumbprint(&mut self, value: impl AsRef<[u8]>)

Set a value for X.509 certificate SHA-1 thumbprint header claim (x5t).

Arguments

• value - A X.509 certificate SHA-1 thumbprint

pub fn x509_certificate_sha1_thumbprint(&self) -> Option<Vec<u8>>

Return the value for X.509 certificate SHA-1 thumbprint header claim (x5t).

pub fn set_x509_certificate_sha256_thumbprint( &mut self, value: impl AsRef<[u8]> )

Set a value for a x509 certificate SHA-256 thumbprint header claim (x5t#S256).

Arguments

• value - A x509 certificate SHA-256 thumbprint

pub fn x509_certificate_sha256_thumbprint(&self) -> Option<Vec<u8>>

Return the value for X.509 certificate SHA-256 thumbprint header claim (x5t#S256).

pub fn set_key_id(&mut self, value: impl Into<String>)

Set a value for key ID header claim (kid).

Arguments

• value - a key ID

pub fn key_id(&self) -> Option<&str>

Return the value for key ID header claim (kid).

pub fn set_token_type(&mut self, value: impl Into<String>)

Set a value for token type header claim (typ).

Arguments

• value - a token type (e.g. “JWT”)

pub fn token_type(&self) -> Option<&str>

Return the value for token type header claim (typ).

pub fn set_content_type(&mut self, value: impl Into<String>)

Set a value for content type header claim (cty).

Arguments

• value - a content type (e.g. “JWT”)

pub fn content_type(&self) -> Option<&str>

Return the value for content type header claim (cty).

pub fn set_critical(&mut self, values: &Vec<impl AsRef<str>>)

Set values for critical header claim (crit).

Arguments

• values - critical claim names

pub fn critical(&self) -> Option<Vec<&str>>

Return values for critical header claim (crit).

pub fn set_base64url_encode_payload(&mut self, value: bool)

Set a value for base64url-encode payload header claim (b64).

Arguments

• value - is base64url-encode payload

pub fn base64url_encode_payload(&self) -> Option<bool>

Return the value for base64url-encode payload header claim (b64).

pub fn set_url(&mut self, value: impl Into<String>)

Set a value for url header claim (url).

Arguments

• value - a url

pub fn url(&self) -> Option<&str>

Return the value for url header claim (url).

pub fn set_nonce(&mut self, value: impl AsRef<[u8]>)

Set a value for a nonce header claim (nonce).

Arguments

• value - A nonce

pub fn nonce(&self) -> Option<Vec<u8>>

Return the value for nonce header claim (nonce).

pub fn set_claim( &mut self, key: &str, value: Option<Value> ) -> Result<(), JoseError>

Set a value for header claim of a specified key.

Arguments

• key - a key name of header claim
• value - a typed value of header claim

pub fn claims_set(&self) -> &Map<String, Value>

Return values for header claims set

pub fn into_map(self) -> Map<String, Value>

Convert into map

Trait Implementations

impl AsRef<Map<String, Value>> for JwsHeader

fn as_ref(&self) -> &Map<String, Value>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for JwsHeader

fn clone(&self) -> JwsHeader

Returns a copy 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 Deref for JwsHeader

type Target = dyn JoseHeader

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for JwsHeader

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

Formats the value using the given formatter.

impl Into<Map<String, Value>> for JwsHeader

fn into(self) -> Map<String, Value>

Converts this type into the (usually inferred) input type.

impl JoseHeader for JwsHeader

fn len(&self) -> usize

Return claim count.

fn claim(&self, key: &str) -> Option<&Value>

Return the value for header claim of a specified key.

fn box_clone(&self) -> Box<dyn JoseHeader>

impl PartialEq for JwsHeader

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

impl StructuralPartialEq for JwsHeader