jose-jws 0.1.1

Pure Rust implementation of the JSON Web Signature (JWS) component of the Javascript Object Signing and Encryption (JOSE) specification as described in RFC7515
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

// SPDX-FileCopyrightText: 2022 Profian Inc. <opensource@profian.com>
// SPDX-License-Identifier: Apache-2.0 OR MIT

use alloc::vec::Vec;
use alloc::{boxed::Box, string::String};

use jose_b64::base64ct::Base64;
use jose_b64::serde::Bytes;
use jose_jwa::Signing;
use jose_jwk::{Jwk, Thumbprint};
use serde::{Deserialize, Serialize};

#[inline]
fn b64_default() -> bool {
    true
}

#[inline]
fn b64_serialize(value: &bool) -> bool {
    !value
}

/// The JWS Protected Header
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Protected {
    /// RFC 7517 Section 4.1.11
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub crit: Option<Vec<String>>,

    /// RFC 8555 Section 6.4.1
    #[cfg(feature = "url")]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub url: Option<url::Url>,

    /// RFC 8555 Section 6.5.2
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub nonce: Option<Bytes>,

    /// RFC 7797 Section 3
    #[serde(skip_serializing_if = "b64_serialize", default = "b64_default")]
    pub b64: bool,

    /// Other values that may appear in the protected header.
    #[serde(flatten)]
    pub oth: Unprotected,
}

impl Default for Protected {
    fn default() -> Self {
        Self {
            crit: None,
            nonce: None,
            b64: true,
            oth: Unprotected::default(),

            #[cfg(feature = "url")]
            url: None,
        }
    }
}

/// The JWS Unprotected Header
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
pub struct Unprotected {
    /// RFC 7517 Section 4.1.1
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub alg: Option<Signing>,

    /// RFC 7517 Section 4.1.2
    #[cfg(feature = "url")]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub jku: Option<url::Url>,

    /// RFC 7517 Section 4.1.3
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub jwk: Option<Jwk>,

    /// RFC 7517 Section 4.1.4
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub kid: Option<String>,

    /// RFC 7517 Section 4.1.5
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[cfg(feature = "url")]
    pub x5u: Option<url::Url>,

    /// RFC 7517 Section 4.1.6
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub x5c: Option<Vec<Bytes<Box<[u8]>, Base64>>>, // base64, not base64url

    /// RFC 7517 Section 4.1.7-8
    #[serde(flatten)]
    pub x5t: Thumbprint,

    /// RFC 7517 Section 4.1.9
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub typ: Option<String>,

    /// RFC 7517 Section 4.1.10
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub cty: Option<String>,
}