Struct Header

pub struct Header {
    pub algorithm: Algorithm,
    pub key_id: Option<String>,
    pub obj_type: Option<String>,
    pub required_extensions: Option<Vec<String>>,
}

Fields

algorithm: Algorithm

The algorithm that this object is/will be signed with. Corresponds to the alg header parameter.

See section 4.1.1 of RFC 7515.

key_id: Option<String>

The type of the object that is encoded with this header. Corresponds to the kid header parameter.

See section 4.1.4 of RFC 7515.

obj_type: Option<String>

The type of the object that is encoded with this header. Corresponds to the typ header parameter.

See section 4.1.9 of RFC 7515.

required_extensions: Option<Vec<String>>

A list of parameters, i.e. field names, that the JWS implementation (i.e. jwt2) is required to process. Corresponds to the crit header parameter.

This is a field that jwt2 doesn’t really support yet, but it is left in for the sake of being standards-compliant.

To validate this, use the Header::required_extensions function.

See section 4.1.11 of RFC 7515.

Implementations

impl Header

pub fn new(algorithm: Algorithm) -> Self

pub fn recommended<R>(recommender: &R) -> Self

where R: RecommendHeaderParams + ?Sized,

pub fn supports_required_extensions(&self) -> bool

Checks if this library supports the required extensions.

Implementation details

For now, this will return true if Self::required_extensions is Some.

This is standards-compliant and “correct” behaviour since if it returns true:

1. the array is empty, which is not standards-compliant:

   Producers MUST NOT use the empty list [] as the crit value.

2. the array contains headers which are technically supported by jwt2. At the moment, jwt2 only supports header parameters that are specified by the JWS RFC or those specified by the JWA RFC.

   Recipients MAY consider the JWS to be invalid if the critical list contains any Header Parameter names defined by this specification or JWA for use with JWS or if any other constraints on its use are violated.

3. the array specifies any parameter that jwt2 does not recognise, being the genuinely correct case.

   If any of the listed extension Header Parameters are not understood and supported by the recipient, then the JWS is invalid.

In the future, however, this function should properly check if the parameters are handled.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for Header

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Header

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.