jose 0.0.2

A JSON Object Signing and Encryption implementation
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
// tests for header parsing:
// - duplicate paremeter name
// - additional (private, public) headers
// - for supporting all MUST BE UNDERSTOOD params

use std::{convert::Infallible, str::FromStr};

use jose::{
    crypto::{
        self,
        okp::{Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signer, Ed25519Verifier},
    },
    format::{Compact, JsonFlattened, JsonGeneral},
    header::HeaderValue,
    jwa::JsonWebSigningAlgorithm,
    jwk::{JwkSigner, JwkVerifier},
    jws::{
        FromRawPayload, IntoPayload, IntoSigner, IntoVerifier, ManyUnverified, PayloadData,
        PayloadKind, Signer, Unverified, Verifier, VerifyError,
    },
    policy::{Checkable, StandardPolicy},
    Base64UrlString, JsonWebKey, Jws,
};

fn read_key_file(name: &str) -> String {
    std::fs::read_to_string(format!(
        "{}/tests/keys/{}.json",
        env!("CARGO_MANIFEST_DIR"),
        name,
    ))
    .unwrap()
}

#[derive(Debug, PartialEq, Eq)]
struct StringPayload(String);

impl From<&str> for StringPayload {
    fn from(value: &str) -> Self {
        StringPayload(value.to_string())
    }
}

impl FromRawPayload for StringPayload {
    type Context = ();
    type Error = String;

    fn from_attached(_: &(), payload: PayloadData) -> Result<Self, Self::Error> {
        match payload {
            PayloadData::Standard(s) => String::from_utf8(s.decode())
                .map(StringPayload)
                .map_err(|e| e.to_string()),
        }
    }

    fn from_detached<F, T>(
        _: &(),
        _: &jose::JoseHeader<F, T>,
    ) -> Result<(Self, PayloadData), Self::Error> {
        Err(String::from("detached payload not supported"))
    }

    fn from_detached_many<F, T>(
        _: &(),
        _: &[jose::JoseHeader<F, T>],
    ) -> Result<(Self, PayloadData), Self::Error> {
        Err(String::from("detached payload not supported"))
    }
}

impl IntoPayload for StringPayload {
    type Error = Infallible;

    fn into_payload(self) -> Result<PayloadKind, Self::Error> {
        let s = Base64UrlString::encode(self.0);
        Ok(PayloadKind::Attached(PayloadData::Standard(s)))
    }
}

struct NoneKey;
impl Signer<[u8; 0]> for NoneKey {
    fn sign(&mut self, _msg: &[u8]) -> Result<[u8; 0], crypto::Error> {
        Ok([])
    }

    fn algorithm(&self) -> JsonWebSigningAlgorithm {
        JsonWebSigningAlgorithm::None
    }

    fn key_id(&self) -> Option<&str> {
        Some("none")
    }
}

struct NoneVerifier;
impl Verifier for NoneVerifier {
    fn verify(&mut self, _: &[u8], _: &[u8]) -> Result<(), VerifyError> {
        Ok(())
    }
}

#[test]
fn signer_without_key_id() {
    let signer = NoneKey;

    assert_eq!(signer.key_id(), Some("none"));

    let without_key_id = signer.without_key_id();

    assert_eq!(without_key_id.key_id(), None);
}

#[test]
fn none_verifier_roundtrip() {
    let jws = Jws::<Compact, _>::builder()
        .build(StringPayload::from("abc"))
        .unwrap();
    let jws_compact = jws.sign(&mut NoneKey.without_key_id()).unwrap().encode();

    assert_eq!(
        jws_compact.to_string(),
        String::from("eyJhbGciOiJub25lIn0.YWJj.")
    );

    let parsed_jws = Unverified::<Jws<Compact, StringPayload>>::decode(jws_compact)
        .unwrap()
        .verify(&mut NoneVerifier)
        .unwrap();

    assert_eq!(parsed_jws.payload(), &StringPayload::from("abc"));
}

#[test]
fn detached_payload_with_context() {
    use jose::{
        crypto::ec::{P256PrivateKey, P256Signer, P256Verifier},
        jwa::EcDSA,
    };

    #[derive(Debug)]
    struct MyPayload(String);

    impl IntoPayload for MyPayload {
        type Error = ();

        fn into_payload(self) -> Result<PayloadKind, Self::Error> {
            let s = Base64UrlString::encode(self.0);
            Ok(PayloadKind::Detached(PayloadData::Standard(s)))
        }
    }

    impl FromRawPayload for MyPayload {
        type Context = String;
        type Error = ();

        fn from_attached(
            context: &Self::Context,
            _payload: PayloadData,
        ) -> Result<Self, Self::Error> {
            Ok(Self(context.clone()))
        }

        fn from_detached<F, T>(
            context: &Self::Context,
            _header: &jose::JoseHeader<F, T>,
        ) -> Result<(Self, PayloadData), Self::Error> {
            let data = PayloadData::Standard(Base64UrlString::encode(context));
            Ok((Self(context.clone()), data))
        }

        fn from_detached_many<F, T>(
            _context: &Self::Context,
            _headers: &[jose::JoseHeader<F, T>],
        ) -> Result<(Self, PayloadData), Self::Error> {
            todo!()
        }
    }

    let key = std::fs::read_to_string(format!(
        "{}/tests/keys/p256.json",
        env!("CARGO_MANIFEST_DIR"),
    ))
    .unwrap();
    let key: P256PrivateKey = serde_json::from_str(&key).unwrap();

    let mut signer: P256Signer = key
        .clone()
        .into_signer(JsonWebSigningAlgorithm::EcDSA(EcDSA::Es256))
        .unwrap();

    let mut verifier: P256Verifier = key
        .into_verifier(JsonWebSigningAlgorithm::EcDSA(EcDSA::Es256))
        .unwrap();

    let context = "hello".to_string();

    let jws = Jws::<Compact, _>::builder()
        .build(MyPayload(context.clone()))
        .unwrap()
        .sign(&mut signer)
        .unwrap()
        .encode();

    // After a recent change in jose, ecdas is not deterministic anymore
    // assert_eq!(
    //     jws.to_string(),
    //     "eyJhbGciOiJFUzI1NiJ9..\
    //      66Pd7hVwuNAOP4qFlQW5zSOmLNehj69TbZifg7pD5QjRWMqbxEdalWzMJFmRtQisYunNK2Vhm7H54xOnL6_Q4w"
    // );

    let parsed_jws =
        Unverified::<Jws<Compact, MyPayload>>::decode_with_context(jws.clone(), &context)
            .unwrap()
            .verify(&mut verifier)
            .unwrap();

    assert_eq!(parsed_jws.payload().0, context);

    // decoding with another context, should fail signature validation
    let context2 = "world".to_string();
    Unverified::<Jws<Compact, MyPayload>>::decode_with_context(jws, &context2)
        .unwrap()
        .verify(&mut verifier)
        .unwrap_err();
}

#[test]
fn sign_jws_using_p256() {
    use jose::{
        crypto::ec::{P256PrivateKey, P256Signer, P256Verifier},
        jwa::EcDSA,
    };

    let key = std::fs::read_to_string(format!(
        "{}/tests/keys/p256.json",
        env!("CARGO_MANIFEST_DIR"),
    ))
    .unwrap();

    let key: P256PrivateKey = serde_json::from_str(&key).unwrap();

    let mut signer: P256Signer = key
        .clone()
        .into_signer(JsonWebSigningAlgorithm::EcDSA(EcDSA::Es256))
        .unwrap();

    let mut verifier: P256Verifier = key
        .into_verifier(JsonWebSigningAlgorithm::EcDSA(EcDSA::Es256))
        .unwrap();

    let jws = Jws::<Compact, _>::builder()
        .build(StringPayload::from("hello world!"))
        .unwrap()
        .sign(&mut signer)
        .unwrap()
        .encode();

    // ecdsas is not deterministic anymore
    // assert_eq!(
    //     jws.to_string().as_str(),
    //     "eyJhbGciOiJFUzI1NiJ9.aGVsbG8gd29ybGQh.\
    //      lVKmpTNK_Im3-JEpF1JzuXM-vP9tNSkR8785hqnYzOHd1__VVOeMzGW7nywUe7Xkp6Wlu3KgWXlvsxhQdU1PlQ"
    // );

    let parsed_jws = Unverified::<Jws<Compact, StringPayload>>::decode(jws.clone())
        .unwrap()
        .verify(&mut verifier)
        .unwrap();

    assert_eq!(parsed_jws.payload().0, "hello world!");
}

#[test]
fn deny_compact_jws_with_empty_protected_header() {
    let jws: Jws<Compact, StringPayload> = Jws::builder()
        .header(|b| b.algorithm(HeaderValue::Unprotected(JsonWebSigningAlgorithm::None)))
        .build(StringPayload::from("abc"))
        .unwrap();

    jws.sign(&mut NoneKey).unwrap_err();
}

#[test]
fn json_flattened_jws_with_no_protected_header() {
    let key = std::fs::read_to_string(format!(
        "{}/tests/keys/cookbook_hs256.json",
        env!("CARGO_MANIFEST_DIR"),
    ))
    .unwrap();

    let key: JsonWebKey = serde_json::from_str(&key).unwrap();
    let key = key.check(StandardPolicy::new()).unwrap();

    let mut signer = JwkSigner::try_from(key).unwrap();

    let payload = "It's a dangerous business, Frodo, going out your door. You step onto the road, \
                   and if you don't keep your feet, there's no knowing where you";

    let jws: Jws<JsonFlattened, StringPayload> = Jws::builder()
        .header(|b| b.algorithm(HeaderValue::Unprotected(JsonWebSigningAlgorithm::None)))
        .build(StringPayload::from(payload))
        .unwrap();

    let jws = jws.sign(&mut signer).unwrap();

    println!("{:#}", jws);
}

#[test]
fn smoke() {
    let key = std::fs::read_to_string(format!(
        "{}/tests/keys/p256.json",
        env!("CARGO_MANIFEST_DIR"),
    ))
    .unwrap();

    let key2 = std::fs::read_to_string(format!(
        "{}/tests/keys/hs256.json",
        env!("CARGO_MANIFEST_DIR"),
    ))
    .unwrap();

    let key: JsonWebKey = serde_json::from_str(&key).unwrap();
    let key = key.check(StandardPolicy::new()).unwrap();

    let key2: JsonWebKey = serde_json::from_str(&key2).unwrap();
    let key2 = key2.check(StandardPolicy::new()).unwrap();

    let mut signer = JwkSigner::try_from(key.clone()).unwrap();
    let mut signer2 = JwkSigner::try_from(key2.clone()).unwrap();

    let mut verifier = JwkVerifier::try_from(key).unwrap();
    let mut verifier2 = JwkVerifier::try_from(key2).unwrap();

    let payload = r#"{"iss":"joe","exp":1300819380,"http://example.com/is_root":true}"#;
    let payload = StringPayload::from(payload);

    let signers: [&mut dyn Signer<Vec<u8>>; 2] = [&mut signer, &mut signer2];

    let jws = Jws::<JsonGeneral, _>::builder()
        .header(|b| b)
        .header(|b| b)
        .build(payload)
        .unwrap()
        .sign_many(signers)
        .unwrap()
        .encode();
    println!("{}", jws);

    let verifiers: [&mut dyn Verifier; 2] = [&mut verifier, &mut verifier2];
    let parsed_jws = ManyUnverified::<Jws<JsonGeneral, StringPayload>>::decode(jws)
        .unwrap()
        .verify_many(verifiers)
        .unwrap();

    println!("{:#?}", parsed_jws);
}

#[test]
fn additional_jwk_parameters_in_header() {
    let key = std::fs::read_to_string(format!(
        "{}/tests/keys/p256.json",
        env!("CARGO_MANIFEST_DIR"),
    ))
    .unwrap();

    #[derive(serde::Serialize, serde::Deserialize)]
    struct Additional {
        #[serde(rename = "example.com/custom-key")]
        foo: usize,
    }

    let additional = Additional { foo: 1337 };

    let key: JsonWebKey = serde_json::from_str(&key).unwrap();
    let key = key.check(StandardPolicy::new()).unwrap();
    let mut signer = JwkSigner::try_from(key.clone()).unwrap();
    let mut verifier = JwkVerifier::try_from(key.clone()).unwrap();

    let key = key
        .into_inner()
        .0
        .into_builder()
        .additional(additional)
        .build()
        .unwrap();
    let key = key.into_untyped_additional().unwrap();

    let jws: Jws<Compact, StringPayload> = Jws::builder()
        .header(|b| b.json_web_key(Some(HeaderValue::Protected(key))))
        .build(StringPayload::from("abc"))
        .unwrap();

    let jws = jws.sign(&mut signer).unwrap().encode();

    let parsed_jws = Unverified::<Jws<Compact, StringPayload>>::decode(jws)
        .unwrap()
        .verify(&mut verifier)
        .unwrap();

    let jwk = parsed_jws
        .header()
        .json_web_key()
        .unwrap()
        .into_inner()
        .clone();
    let jwk: JsonWebKey<Additional> = jwk.deserialize_additional().unwrap();

    assert_eq!(jwk.additional().foo, 1337);
}

#[test]
fn ed25519() {
    let private: Ed25519PrivateKey =
        serde_json::from_str(&read_key_file("ed25519")).expect("valid ed25519 private key");
    let _wrong_private = serde_json::from_str::<Ed25519PrivateKey>(&read_key_file("ed25519.pub"))
        .expect_err("is a public key");

    let public: Ed25519PublicKey =
        serde_json::from_str(&read_key_file("ed25519.pub")).expect("is a valid public key");
    let _wrong_public = serde_json::from_str::<Ed25519PublicKey>(&read_key_file("ed25519"))
        .expect("public key can be parsed from private key");

    let msg = "I was cured all right.";

    let mut signer: Ed25519Signer = private
        .into_signer(jose::jwa::JsonWebSigningAlgorithm::EdDSA)
        .unwrap();

    let jws = Jws::<Compact, _>::builder()
        .build(StringPayload(msg.to_string()))
        .unwrap();

    let jws = jws.sign(&mut signer).unwrap();

    println!("{:#?}", jws);

    let mut verifier: Ed25519Verifier = public
        .into_verifier(JsonWebSigningAlgorithm::EdDSA)
        .unwrap();

    let encoded = jws.encode().to_string();
    assert_eq!(
        encoded,
        "eyJhbGciOiJFZERTQSJ9.SSB3YXMgY3VyZWQgYWxsIHJpZ2h0Lg.\
         JtDl6Eq4ORiI_fYmeik8QLMUPur0s37AgaK-o8W2ywEXnomeSPpf3Je0EvCI8K55k0uu0zkdHmGs2vu-DiuLDw"
    );

    let unverified_jws =
        Unverified::<Jws<Compact, StringPayload>>::decode(Compact::from_str(&encoded).unwrap())
            .unwrap();
    unverified_jws
        .verify(&mut verifier)
        .expect("valid signature");

    let signature_by_different_key =
        "eyJhbGciOiJFZERTQSJ9.SSB3YXMgY3VyZWQgYWxsIHJpZ2h0Lg.\
         xuBNTX8MSX1Du5sAdSGBUKijn8yqHG8v-3CYrZpoHizzwU9T6aT-XqbS5FBuMR9_pGagmpO6EiPHqZiTUpxXDQ";

    let wrong_jws: Unverified<Jws<Compact, StringPayload>> =
        Unverified::decode(Compact::from_str(signature_by_different_key).unwrap()).unwrap();

    wrong_jws
        .verify(&mut verifier)
        .expect_err("signature made by different private key");
}