jaws 1.0.3

JSON Algorithms and Web Signing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use std::collections::BTreeMap;

use bytes::Bytes;
use serde::{Deserialize, Serialize};
use sha1::Sha1;
use sha2::Sha256;

use crate::algorithms::AlgorithmIdentifier;

use crate::key::{JsonWebKey, Thumbprint};

use super::HeaderState;

/// The registered fields of a JOSE header, which are interdependent
/// with the signing key, rendered into their typed form.
///
/// This is different from [super::SignedHeader] in that it contains the actual data,
/// and not thd derivation, so the fields may be in inconsistent states.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
pub struct RenderedHeader {
    /// The raw bytes of the header, as it was signed.
    #[serde(skip)]
    pub(crate) raw: Bytes,

    #[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/jose/algorithm.md"))]
    #[serde(rename = "alg")]
    pub(super) algorithm: AlgorithmIdentifier,

    #[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/jose/json_web_key.md"))]
    #[serde(rename = "jwk", skip_serializing_if = "Option::is_none")]
    pub(super) key: Option<JsonWebKey>,

    #[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/jose/thumbprint.md"))]
    #[serde(rename = "x5t", skip_serializing_if = "Option::is_none")]
    pub(super) thumbprint: Option<Thumbprint<Sha1>>,

    #[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/jose/thumbprint_sha256.md"))]
    #[serde(rename = "x5t#S256", skip_serializing_if = "Option::is_none")]
    pub(super) thumbprint_sha256: Option<Thumbprint<Sha256>>,
}

impl HeaderState for RenderedHeader {
    fn parameters(
        &self,
    ) -> Result<BTreeMap<std::string::String, serde_json::Value>, serde_json::Error> {
        let mut data = std::collections::BTreeMap::new();

        data.insert("alg".to_owned(), serde_json::to_value(self.algorithm)?);

        if let Some(value) = self.key.as_ref() {
            data.insert("jwk".to_owned(), serde_json::to_value(value)?);
        }

        if let Some(value) = self.thumbprint.as_ref() {
            data.insert("x5t".to_owned(), serde_json::to_value(value)?);
        }

        if let Some(value) = self.thumbprint_sha256.as_ref() {
            data.insert("x5t#S256".to_owned(), serde_json::to_value(value)?);
        }

        Ok(data)
    }
}