huskarl-core 0.6.4

Base library for huskarl (OAuth2 client) ecosystem.
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
//! Validation infrastructure for JWT tokens.

use std::collections::HashSet;

use bon::Builder;
use serde::Deserialize;
use snafu::{ResultExt as _, Snafu, ensure};

use crate::{
    BoxedError,
    crypto::verifier::{BoxedJwsVerifier, JwsVerifier, KeyMatch, VerifyError},
    jwt::{
        BoxedJtiUniquenessChecker, ConfirmationClaim, JtiUniquenessChecker, JwsParseError,
        ParsedJws, parse_compact_jws,
    },
    platform::{Duration, SystemTime},
};

/// A check to perform on a JWT claim.
#[non_exhaustive]
#[derive(Debug, Clone, Default)]
pub enum ClaimCheck {
    /// If claim is present, it must equal this value. Lack of value is acceptable.
    IfPresent(String),
    /// Claim must be present, value must match one of these.
    RequireAny(Vec<String>),
    /// Claim must be present and equal this value.
    RequiredValue(String),
    /// Claim must be present.
    Present,
    /// No check is performed.
    #[default]
    NoCheck,
}

impl ClaimCheck {
    /// If claim is present, it must equal this value. Lack of value is acceptable.
    pub fn if_present(value: impl Into<String>) -> Self {
        Self::IfPresent(value.into())
    }

    /// Claim must be present, and value must match one of these.
    pub fn require_any(values: impl IntoIterator<Item = impl Into<String>>) -> Self {
        Self::RequireAny(values.into_iter().map(Into::into).collect())
    }

    /// Claim must be present and equal this value.
    pub fn required_value(value: impl Into<String>) -> Self {
        Self::RequiredValue(value.into())
    }

    /// Claim must be present.
    #[must_use]
    pub fn present() -> Self {
        Self::Present
    }
}

/// JWT token validator.
#[allow(clippy::struct_excessive_bools)]
#[allow(clippy::should_implement_trait)] // `sub` is the JWT claim name, not arithmetic subtraction
#[derive(Debug, Builder)]
pub struct JwtValidator {
    /// JWS verifier to use for token validation.
    verifier: BoxedJwsVerifier,
    /// Check on the `iss` claim.
    #[builder(default)]
    iss: ClaimCheck,
    /// Check on the `sub` claim.
    #[builder(default)]
    sub: ClaimCheck,
    /// Check on the `aud` claim.
    #[builder(default)]
    aud: ClaimCheck,
    /// Type to validate against.
    #[builder(default)]
    typ: ClaimCheck,
    /// The `exp` claim is required.
    #[builder(default)]
    require_exp: bool,
    /// The `iat` claim is required.
    #[builder(default)]
    require_iat: bool,
    /// The `jti` claim is required.
    #[builder(default)]
    require_jti: bool,
    /// Maximum allowed byte length for the `jti` claim. Defaults to 255.
    #[builder(default = 255)]
    max_jti_len: usize,
    /// Implementation of a JTI checker to check for uniqueness.
    jti_checker: Option<BoxedJtiUniquenessChecker>,
    /// Maximum token age to validate against.
    max_token_age: Option<Duration>,
    #[builder(default)]
    clock_leeway: Duration,
    /// Specifies which `crit` values as allowed.
    ///
    /// By default, no values are understood, and a token
    /// containing any values will be rejected. Values may
    /// be added, where the user of the token is able to
    /// understand and handle the corresponding extension.
    #[builder(default, with = FromIterator::from_iter)]
    allowed_crit: HashSet<String>,
    /// If set, restricts accepted signature algorithms to this set.
    ///
    /// Per OIDC Core §3.1.3.7 step 7, the `alg` value SHOULD be `RS256` or the algorithm
    /// registered during client registration. Use this to enforce an allowlist.
    ///
    /// Regardless of this setting, the algorithm `"none"` is always rejected.
    #[builder(with = FromIterator::from_iter)]
    allowed_algorithms: Option<HashSet<String>>,
}

/// Per RFC 7515 §4.1.9 and RFC 2045, `typ` media type subtypes are case-insensitive,
/// and the `application/` prefix may be omitted when there is no other `/` in the value.
/// Normalize to the short form before comparison.
fn normalize_typ(typ: &str) -> &str {
    if typ.len() > 12 && typ[..12].eq_ignore_ascii_case("application/") {
        &typ[12..]
    } else {
        typ
    }
}

fn check_str_claim(
    claim: &'static str,
    check: &ClaimCheck,
    value: Option<&str>,
) -> Result<(), JwtValidationError> {
    match check {
        ClaimCheck::Present => {
            if value.is_none() {
                return Err(RequiredClaimMissingSnafu { claim }.build());
            }
        }
        ClaimCheck::RequiredValue(v) => match value {
            Some(val) if val == v.as_str() => {}
            Some(val) => {
                return Err(ClaimMismatchSnafu {
                    claim,
                    expected: v.clone(),
                    actual: val,
                }
                .build());
            }
            None => return Err(RequiredClaimMissingSnafu { claim }.build()),
        },
        ClaimCheck::RequireAny(vs) => match value {
            Some(val) if vs.iter().any(|x| val == x.as_str()) => {}
            Some(val) => {
                return Err(ClaimMismatchSnafu {
                    claim,
                    expected: vs.join(", "),
                    actual: val,
                }
                .build());
            }
            None => return Err(RequiredClaimMissingSnafu { claim }.build()),
        },
        ClaimCheck::IfPresent(v) => {
            if let Some(val) = value
                && val != v.as_str()
            {
                return Err(ClaimMismatchSnafu {
                    claim,
                    expected: v.clone(),
                    actual: val,
                }
                .build());
            }
        }
        ClaimCheck::NoCheck => {}
    }
    Ok(())
}

fn check_aud(check: &ClaimCheck, aud: &[String]) -> Result<(), JwtValidationError> {
    match check {
        ClaimCheck::Present => ensure!(!aud.is_empty(), RequiredClaimMissingSnafu { claim: "aud" }),
        ClaimCheck::RequiredValue(v) => ensure!(
            aud.contains(v),
            ClaimMismatchSnafu {
                claim: "aud",
                expected: v.clone(),
                actual: aud.join(", "),
            }
        ),
        ClaimCheck::RequireAny(vs) => ensure!(
            vs.iter().any(|v| aud.contains(v)),
            ClaimMismatchSnafu {
                claim: "aud",
                expected: vs.join(", "),
                actual: aud.join(", "),
            }
        ),
        ClaimCheck::IfPresent(v) => {
            if !aud.is_empty() {
                ensure!(
                    aud.contains(v),
                    ClaimMismatchSnafu {
                        claim: "aud",
                        expected: v.clone(),
                        actual: aud.join(", "),
                    }
                );
            }
        }
        ClaimCheck::NoCheck => {}
    }
    Ok(())
}

fn check_typ(check: &ClaimCheck, typ: Option<&str>) -> Result<(), JwtValidationError> {
    match check {
        ClaimCheck::IfPresent(t) => ensure!(
            typ.is_none_or(|v| normalize_typ(v).eq_ignore_ascii_case(normalize_typ(t))),
            InvalidTokenTypeSnafu {
                typ: typ.map(Into::into)
            }
        ),
        ClaimCheck::RequireAny(allowed) => match typ {
            None => return RequiredClaimMissingSnafu { claim: "typ" }.fail(),
            Some(v)
                if allowed
                    .iter()
                    .any(|t| normalize_typ(v).eq_ignore_ascii_case(normalize_typ(t))) => {}
            Some(v) => {
                return InvalidTokenTypeSnafu {
                    typ: Some(v.into()),
                }
                .fail();
            }
        },
        ClaimCheck::RequiredValue(t) => match typ {
            None => return RequiredClaimMissingSnafu { claim: "typ" }.fail(),
            Some(v) if normalize_typ(v).eq_ignore_ascii_case(normalize_typ(t)) => {}
            Some(v) => {
                return InvalidTokenTypeSnafu {
                    typ: Some(v.into()),
                }
                .fail();
            }
        },
        ClaimCheck::Present => {
            ensure!(typ.is_some(), RequiredClaimMissingSnafu { claim: "typ" });
        }
        ClaimCheck::NoCheck => {}
    }
    Ok(())
}

fn check_temporal(
    now: SystemTime,
    clock_leeway: Duration,
    exp: Option<u64>,
    nbf: Option<u64>,
    iat: Option<u64>,
) -> Result<(), JwtValidationError> {
    if let Some(exp) = exp {
        let expiration = SystemTime::UNIX_EPOCH + Duration::from_secs(exp);
        ensure!(
            expiration + clock_leeway >= now,
            ExpiredSnafu { expiration, now }
        );
    }
    if let Some(nbf) = nbf {
        let not_before = SystemTime::UNIX_EPOCH + Duration::from_secs(nbf);
        ensure!(
            not_before <= now + clock_leeway,
            NotYetValidSnafu { not_before, now }
        );
    }
    if let Some(iat) = iat {
        let issued_at = SystemTime::UNIX_EPOCH + Duration::from_secs(iat);
        ensure!(
            issued_at <= now + clock_leeway,
            IssuedInFutureSnafu { issued_at, now }
        );
    }
    Ok(())
}

impl JwtValidator {
    fn validate_header(&self, alg: &str, crit: &[String]) -> Result<(), JwtValidationError> {
        ensure!(alg != "none", UnsignedTokenSnafu);

        if let Some(allowed) = &self.allowed_algorithms {
            ensure!(
                allowed.contains(alg),
                DisallowedAlgorithmSnafu {
                    alg: alg.to_string()
                }
            );
        }

        ensure!(
            crit.iter().all(|v| self.allowed_crit.contains(v)),
            UnrecognizedCriticalHeaderSnafu {
                params: crit.to_vec()
            }
        );

        Ok(())
    }

    async fn validate_jti(&self, jti: Option<&str>) -> Result<(), JwtValidationError> {
        if let Some(jti) = jti {
            ensure!(
                jti.len() <= self.max_jti_len,
                JtiTooLongSnafu {
                    len: jti.len(),
                    max_len: self.max_jti_len,
                }
            );
            if let Some(jti_checker) = self.jti_checker.as_ref() {
                ensure!(
                    !jti_checker
                        .check_and_mark_seen(jti)
                        .await
                        .context(JtiCheckSnafu)?,
                    JtiNotUniqueSnafu
                );
            }
        }
        Ok(())
    }

    fn check_required_claims(
        &self,
        exp: Option<u64>,
        iat: Option<u64>,
        jti: Option<&str>,
    ) -> Result<(), JwtValidationError> {
        if self.require_exp {
            ensure!(exp.is_some(), RequiredClaimMissingSnafu { claim: "exp" });
        }
        if self.require_iat {
            ensure!(iat.is_some(), RequiredClaimMissingSnafu { claim: "iat" });
        }
        if self.require_jti {
            ensure!(jti.is_some(), RequiredClaimMissingSnafu { claim: "jti" });
        }
        Ok(())
    }

    /// Validate a pre-parsed JWS, returning a [`ValidatedJwt`] on success.
    ///
    /// # Errors
    ///
    /// Returns a [`JwtValidationError`] if the token is invalid.
    pub async fn validate_parsed_jws<C: for<'de> Deserialize<'de> + Clone + 'static>(
        &self,
        parsed_jwt: ParsedJws<(), C>,
    ) -> Result<ValidatedJwt<C>, JwtValidationError> {
        let now = SystemTime::now();

        self.validate_header(&parsed_jwt.header.alg, &parsed_jwt.header.crit)?;

        let key_match = KeyMatch {
            alg: &parsed_jwt.header.alg,
            kid: parsed_jwt.header.kid.as_deref(),
        };
        self.verifier
            .verify(&parsed_jwt.signing_input, &parsed_jwt.signature, &key_match)
            .await
            .context(SignatureSnafu)?;

        check_aud(&self.aud, &parsed_jwt.claims.aud)?;
        self.check_required_claims(
            parsed_jwt.claims.exp,
            parsed_jwt.claims.iat,
            parsed_jwt.claims.jti.as_deref(),
        )?;
        self.validate_jti(parsed_jwt.claims.jti.as_deref()).await?;

        if let Some(max_token_age) = self.max_token_age {
            let iat = parsed_jwt
                .claims
                .iat
                .ok_or_else(|| RequiredClaimMissingSnafu { claim: "iat" }.build())?;

            let issued_at = SystemTime::UNIX_EPOCH + Duration::from_secs(iat);

            ensure!(
                now.duration_since(issued_at)
                    .is_ok_and(|d| d <= max_token_age + self.clock_leeway),
                TokenTooOldSnafu {
                    issued_at,
                    max_token_age
                }
            );
        }

        check_typ(&self.typ, parsed_jwt.header.typ.as_deref())?;
        check_str_claim("iss", &self.iss, parsed_jwt.claims.iss.as_deref())?;
        check_str_claim("sub", &self.sub, parsed_jwt.claims.sub.as_deref())?;

        check_temporal(
            now,
            self.clock_leeway,
            parsed_jwt.claims.exp,
            parsed_jwt.claims.nbf,
            parsed_jwt.claims.iat,
        )?;

        Ok(ValidatedJwt {
            issuer: parsed_jwt.claims.iss.map(Into::into),
            subject: parsed_jwt.claims.sub.map(Into::into),
            audience: parsed_jwt.claims.aud.iter().map(Into::into).collect(),
            issued_at: parsed_jwt
                .claims
                .iat
                .map(|iat| SystemTime::UNIX_EPOCH + Duration::from_secs(iat)),
            expiration: parsed_jwt
                .claims
                .exp
                .map(|exp| SystemTime::UNIX_EPOCH + Duration::from_secs(exp)),
            jti: parsed_jwt.claims.jti.map(Into::into),
            cnf: parsed_jwt.claims.cnf,
            claims: match parsed_jwt.claims.claims {
                std::borrow::Cow::Borrowed(c) => c.clone(),
                std::borrow::Cow::Owned(c) => c,
            },
        })
    }

    /// Validate a JWT token, returning a [`ValidatedJwt`] on success.
    ///
    /// Uses two-phase parsing: the JWT is first parsed and validated structurally
    /// (signature, standard claims), then the extra claims are deserialized into
    /// the target type `C`. If the token is valid but does not contain the required
    /// extra claims, returns [`JwtValidationError::ExtraClaims`] instead of
    /// [`JwtValidationError::Parse`].
    ///
    /// # Errors
    ///
    /// Returns a [`JwtValidationError`] if the token is invalid.
    pub async fn validate<C: Clone + for<'de> Deserialize<'de> + 'static>(
        &self,
        token: &str,
    ) -> Result<ValidatedJwt<C>, JwtValidationError> {
        let parsed_jwt = parse_compact_jws::<(), serde_json::Value>(token).context(ParseSnafu)?;
        let validated = self.validate_parsed_jws(parsed_jwt).await?;
        validated.try_map_claims(|value| {
            if std::any::TypeId::of::<C>() == std::any::TypeId::of::<()>() {
                serde_json::from_value(serde_json::Value::Null).context(ExtraClaimsSnafu)
            } else {
                serde_json::from_value(value).context(ExtraClaimsSnafu)
            }
        })
    }
}

/// A validated JWT, containing the parsed claims and other metadata.
#[non_exhaustive]
#[derive(Debug, Builder)]
pub struct ValidatedJwt<Claims> {
    /// The issuer of the JWT, if present.
    pub issuer: Option<String>,
    /// The subject of the JWT, if present.
    pub subject: Option<String>,
    /// The audience of the JWT, if present.
    pub audience: Vec<String>,
    /// The JWT ID, if present.
    pub jti: Option<String>,
    /// The issued-at timestamp of the JWT, if present.
    pub issued_at: Option<SystemTime>,
    /// The expiration timestamp of the JWT, if present.
    pub expiration: Option<SystemTime>,
    /// The key confirmation claim (`cnf`, RFC 7800), if present.
    ///
    /// Binds the token to a `DPoP` key (`jkt`, RFC 9449) or mTLS certificate
    /// (`x5t#S256`, RFC 8705). Independent of the token profile and claims type.
    pub cnf: Option<ConfirmationClaim>,
    /// Additional claims beyond the registered JWT claim set.
    pub claims: Claims,
}

impl<Claims> ValidatedJwt<Claims> {
    /// Maps the claims of the JWT using the provided function.
    pub fn map_claims<C1, F>(self, f: F) -> ValidatedJwt<C1>
    where
        F: FnOnce(Claims) -> C1,
    {
        ValidatedJwt {
            issuer: self.issuer,
            subject: self.subject,
            audience: self.audience,
            jti: self.jti,
            issued_at: self.issued_at,
            expiration: self.expiration,
            cnf: self.cnf,
            claims: f(self.claims),
        }
    }

    /// Maps the claims of the JWT using a fallible function.
    ///
    /// # Errors
    ///
    /// Returns the error of the mapper, if it fails.
    pub fn try_map_claims<C1, E, F>(self, f: F) -> Result<ValidatedJwt<C1>, E>
    where
        F: FnOnce(Claims) -> Result<C1, E>,
    {
        Ok(ValidatedJwt {
            issuer: self.issuer,
            subject: self.subject,
            audience: self.audience,
            jti: self.jti,
            issued_at: self.issued_at,
            expiration: self.expiration,
            cnf: self.cnf,
            claims: f(self.claims)?,
        })
    }
}

/// Validation errors that can occur while processing a JWT.
#[derive(Debug, Snafu)]
pub enum JwtValidationError {
    /// The token is invalid.
    Parse {
        /// The underlying error.
        source: JwsParseError,
    },
    /// The token signature is invalid.
    Signature {
        /// The underlying error.
        source: VerifyError<BoxedError>,
    },
    /// The token is unsigned.
    UnsignedToken,
    /// The token uses a disallowed signature algorithm.
    DisallowedAlgorithm {
        /// The algorithm used by the token.
        alg: String,
    },
    /// The token contains unrecognized critical header parameters.
    UnrecognizedCriticalHeader {
        /// The unrecognized critical header parameters.
        params: Vec<String>,
    },
    /// The token is expired.
    Expired {
        /// The expiration timestamp of the JWT.
        expiration: SystemTime,
        /// The current time.
        now: SystemTime,
    },
    /// The token is not yet valid.
    NotYetValid {
        /// The not-before timestamp of the JWT.
        not_before: SystemTime,
        /// The current time.
        now: SystemTime,
    },
    /// The token is issued in the future.
    IssuedInFuture {
        /// The issued-at timestamp of the JWT.
        issued_at: SystemTime,
        /// The current time.
        now: SystemTime,
    },
    /// The token is too old.
    TokenTooOld {
        /// The issued-at timestamp of the JWT.
        issued_at: SystemTime,
        /// The maximum age of the token.
        max_token_age: Duration,
    },
    /// The token type claim is invalid.
    InvalidTokenType {
        /// The type of the JWT.
        typ: Option<String>,
    },
    /// A claim did not match the expected value.
    ClaimMismatch {
        /// The claim name.
        claim: &'static str,
        /// The expected value.
        expected: String,
        /// The actual value.
        actual: String,
    },
    /// A required claim is missing from the JWT.
    RequiredClaimMissing {
        /// The missing claim.
        claim: &'static str,
    },
    /// The `jti` claim exceeds the maximum allowed length.
    JtiTooLong {
        /// The length of the `jti` value in bytes.
        len: usize,
        /// The maximum allowed length in bytes.
        max_len: usize,
    },
    /// The JTI was required to be unique, but was previously marked as seen.
    JtiNotUnique,
    /// There was an internal failure when attempting to check for JTI uniqueness.
    JtiCheck {
        /// The underlying error.
        source: BoxedError,
    },
    /// The token is structurally valid but does not contain the required extra claims.
    ExtraClaims {
        /// The underlying deserialization error.
        source: serde_json::Error,
    },
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::crypto::{
        KeyMatchStrength,
        verifier::{JwsVerifier, KeyMatch, VerifyError},
    };

    #[derive(Debug)]
    struct MockVerifier;

    impl JwsVerifier for MockVerifier {
        type Error = crate::BoxedError;

        fn key_match(&self, _key_match: &KeyMatch<'_>) -> Option<KeyMatchStrength> {
            Some(KeyMatchStrength::ByAlgorithm)
        }

        async fn verify(
            &self,
            _input: &[u8],
            _signature: &[u8],
            _key: &KeyMatch<'_>,
        ) -> Result<(), VerifyError<Self::Error>> {
            Ok(())
        }
    }

    #[tokio::test]
    async fn test_validate_unit_claims_with_extra_fields() {
        // A JWT with standard claims + an extra field "foo"
        // Header: {"alg": "RS256", "typ": "JWT"}
        // Claims: {"iss": "joe", "foo": "bar"}
        let token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJqb2UiLCJmb28iOiJiYXIifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk";

        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .iss(ClaimCheck::required_value("joe"))
            .build();

        // This should succeed even though "foo": "bar" is present and C is ()
        let result = validator.validate::<()>(token).await;
        assert!(result.is_ok(), "Expected Ok, got {:?}", result.err());
    }

    #[tokio::test]
    async fn test_validate_custom_claims_success() {
        #[derive(Debug, Clone, Deserialize, PartialEq)]
        struct MyClaims {
            foo: String,
        }

        let token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJqb2UiLCJmb28iOiJiYXIifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk";

        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .iss(ClaimCheck::required_value("joe"))
            .build();

        let result = validator.validate::<MyClaims>(token).await.unwrap();
        assert_eq!(
            result.claims,
            MyClaims {
                foo: "bar".to_string()
            }
        );
    }

    #[tokio::test]
    async fn test_validate_custom_claims_failure() {
        #[derive(Debug, Clone, Deserialize, PartialEq)]
        struct MyClaims {
            missing: String,
        }

        let token = "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJqb2UiLCJmb28iOiJiYXIifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk";

        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .iss(ClaimCheck::required_value("joe"))
            .build();

        let result = validator.validate::<MyClaims>(token).await;
        assert!(matches!(
            result,
            Err(JwtValidationError::ExtraClaims { .. })
        ));
    }

    // Helper to create a ParsedJws with given header/claims
    fn make_parsed_jws(
        header: serde_json::Value,
        claims: serde_json::Value,
    ) -> ParsedJws<(), serde_json::Value> {
        use crate::jwt::structure::{JwtClaims, JwtHeader};

        let header: JwtHeader<'static, ()> = serde_json::from_value(header).unwrap();
        let claims: JwtClaims<'static, serde_json::Value> = serde_json::from_value(claims).unwrap();

        ParsedJws {
            header,
            claims,
            signing_input: b"dummy.input".to_vec(),
            signature: vec![0x00],
        }
    }

    fn default_validator() -> JwtValidator {
        JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .build()
    }

    // --- Algorithm checks ---

    #[tokio::test]
    async fn reject_alg_none() {
        let parsed = make_parsed_jws(serde_json::json!({"alg": "none"}), serde_json::json!({}));
        let result = default_validator()
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(result, Err(JwtValidationError::UnsignedToken)));
    }

    #[tokio::test]
    async fn reject_disallowed_algorithm() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .allowed_algorithms(["ES256".to_string()])
            .build();
        let parsed = make_parsed_jws(serde_json::json!({"alg": "RS256"}), serde_json::json!({}));
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::DisallowedAlgorithm { .. })
        ));
    }

    // --- Critical header ---

    #[tokio::test]
    async fn reject_unrecognized_crit() {
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256", "crit": ["unknown-ext"]}),
            serde_json::json!({}),
        );
        let result = default_validator()
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::UnrecognizedCriticalHeader { .. })
        ));
    }

    // --- Temporal checks ---

    #[tokio::test]
    async fn reject_expired_token() {
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256"}),
            serde_json::json!({"exp": 1}), // expired long ago
        );
        let result = default_validator()
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(result, Err(JwtValidationError::Expired { .. })));
    }

    #[tokio::test]
    async fn reject_not_yet_valid() {
        let far_future = SystemTime::now()
            .duration_since(SystemTime::UNIX_EPOCH)
            .unwrap()
            .as_secs()
            + 999_999;
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256"}),
            serde_json::json!({"nbf": far_future}),
        );
        let result = default_validator()
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::NotYetValid { .. })
        ));
    }

    #[tokio::test]
    async fn reject_issued_in_future() {
        let far_future = SystemTime::now()
            .duration_since(SystemTime::UNIX_EPOCH)
            .unwrap()
            .as_secs()
            + 999_999;
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256"}),
            serde_json::json!({"iat": far_future}),
        );
        let result = default_validator()
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::IssuedInFuture { .. })
        ));
    }

    #[tokio::test]
    async fn clock_leeway_allows_slightly_expired() {
        let now = SystemTime::now()
            .duration_since(SystemTime::UNIX_EPOCH)
            .unwrap()
            .as_secs();
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .clock_leeway(Duration::from_secs(10))
            .build();
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256"}),
            serde_json::json!({"exp": now - 5}),
        );
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(result.is_ok());
    }

    // --- Required claims ---

    #[tokio::test]
    async fn require_exp_missing() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .require_exp(true)
            .build();
        let parsed = make_parsed_jws(serde_json::json!({"alg": "RS256"}), serde_json::json!({}));
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::RequiredClaimMissing { claim: "exp" })
        ));
    }

    #[tokio::test]
    async fn require_iat_missing() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .require_iat(true)
            .build();
        let parsed = make_parsed_jws(serde_json::json!({"alg": "RS256"}), serde_json::json!({}));
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::RequiredClaimMissing { claim: "iat" })
        ));
    }

    #[tokio::test]
    async fn require_jti_missing() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .require_jti(true)
            .build();
        let parsed = make_parsed_jws(serde_json::json!({"alg": "RS256"}), serde_json::json!({}));
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::RequiredClaimMissing { claim: "jti" })
        ));
    }

    // --- iss claim checks ---

    #[tokio::test]
    async fn iss_required_value_mismatch() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .iss(ClaimCheck::required_value("expected-issuer"))
            .build();
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256"}),
            serde_json::json!({"iss": "wrong-issuer"}),
        );
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::ClaimMismatch { claim: "iss", .. })
        ));
    }

    #[tokio::test]
    async fn iss_require_any_mismatch() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .iss(ClaimCheck::require_any(["a", "b"]))
            .build();
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256"}),
            serde_json::json!({"iss": "c"}),
        );
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::ClaimMismatch { claim: "iss", .. })
        ));
    }

    #[tokio::test]
    async fn iss_present_missing() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .iss(ClaimCheck::present())
            .build();
        let parsed = make_parsed_jws(serde_json::json!({"alg": "RS256"}), serde_json::json!({}));
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::RequiredClaimMissing { claim: "iss" })
        ));
    }

    #[tokio::test]
    async fn iss_if_present_mismatch() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .iss(ClaimCheck::if_present("expected"))
            .build();
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256"}),
            serde_json::json!({"iss": "wrong"}),
        );
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::ClaimMismatch { claim: "iss", .. })
        ));
    }

    #[tokio::test]
    async fn iss_if_present_absent_ok() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .iss(ClaimCheck::if_present("expected"))
            .build();
        let parsed = make_parsed_jws(serde_json::json!({"alg": "RS256"}), serde_json::json!({}));
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(result.is_ok());
    }

    // --- aud claim checks ---

    #[tokio::test]
    async fn aud_required_value_not_in_list() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .aud(ClaimCheck::required_value("expected-aud"))
            .build();
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256"}),
            serde_json::json!({"aud": "wrong-aud"}),
        );
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::ClaimMismatch { claim: "aud", .. })
        ));
    }

    #[tokio::test]
    async fn aud_empty_when_required() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .aud(ClaimCheck::present())
            .build();
        let parsed = make_parsed_jws(serde_json::json!({"alg": "RS256"}), serde_json::json!({}));
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::RequiredClaimMissing { claim: "aud" })
        ));
    }

    // --- typ claim checks ---

    #[tokio::test]
    async fn typ_required_value_mismatch() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .typ(ClaimCheck::required_value("at+jwt"))
            .build();
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256", "typ": "JWT"}),
            serde_json::json!({}),
        );
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::InvalidTokenType { .. })
        ));
    }

    #[tokio::test]
    async fn typ_application_prefix_normalization() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .typ(ClaimCheck::required_value("at+jwt"))
            .build();
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256", "typ": "application/at+jwt"}),
            serde_json::json!({}),
        );
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn typ_case_insensitive() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .typ(ClaimCheck::required_value("AT+JWT"))
            .build();
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256", "typ": "at+jwt"}),
            serde_json::json!({}),
        );
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(result.is_ok());
    }

    // --- max_token_age ---

    #[tokio::test]
    async fn max_token_age_old_token() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .max_token_age(Duration::from_mins(1))
            .build();
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256"}),
            serde_json::json!({"iat": 1}), // issued at epoch
        );
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::TokenTooOld { .. })
        ));
    }

    #[tokio::test]
    async fn max_token_age_missing_iat() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .max_token_age(Duration::from_mins(1))
            .build();
        let parsed = make_parsed_jws(serde_json::json!({"alg": "RS256"}), serde_json::json!({}));
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(
            result,
            Err(JwtValidationError::RequiredClaimMissing { claim: "iat" })
        ));
    }

    // --- JTI too long ---

    #[tokio::test]
    async fn jti_too_long() {
        let validator = JwtValidator::builder()
            .verifier(BoxedJwsVerifier::new(MockVerifier))
            .max_jti_len(5)
            .build();
        let parsed = make_parsed_jws(
            serde_json::json!({"alg": "RS256"}),
            serde_json::json!({"jti": "toolong"}),
        );
        let result = validator
            .validate_parsed_jws::<serde_json::Value>(parsed)
            .await;
        assert!(matches!(result, Err(JwtValidationError::JtiTooLong { .. })));
    }
}