tower-http 0.7.0

Tower middleware and utilities for HTTP clients and servers
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
//! Modern protection against [cross-site request forgery] (CSRF) attacks.
//!
//! This middleware implements the CSRF protection scheme [introduced in Go 1.25][go]
//! and described in [Filippo Valsorda's blog post][filippo]. It relies on the
//! [`Sec-Fetch-Site`] and [`Origin`] request headers and requires no
//! per-request token state.
//!
//! Requests are allowed if any of the following hold:
//!
//! 1. The method is `GET`, `HEAD`, or `OPTIONS`.
//! 2. The `Origin` header byte-for-byte matches an allow-listed trusted origin.
//! 3. `Sec-Fetch-Site` is `same-origin` or `none`.
//! 4. Neither `Sec-Fetch-Site` nor `Origin` is present.
//! 5. The `Origin`'s authority (host and any port) matches the request's effective
//!    host byte-for-byte (the request-target authority if present, else `Host`).
//!
//! Rejected requests receive a `403 Forbidden` response. The originating
//! [`ProtectionError`] is attached to the response's extensions — on every
//! rejection, including those from a custom builder — so surrounding layers can
//! distinguish explicit cross-origin rejections from conservative fallback
//! rejections (e.g. requests from old browsers without `Sec-Fetch-Site`). Use
//! [`CsrfLayer::with_rejection_response`](CsrfLayer::with_rejection_response)
//! to replace the rejection response with a custom builder.
//!
//! # Deployment caveat
//!
//! The middleware trusts whatever `Origin` and `Host` reach it. Reverse proxies
//! and load balancers that rewrite `Host` (e.g. to an internal hostname) or
//! strip `Origin` silently degrade the protection: the `Origin`/`Host`
//! fallback can no longer match, and `Sec-Fetch-Site` becomes the only
//! remaining line of defense. Configure intermediaries to forward both headers
//! unchanged.
//!
//! # Example
//!
//! ```
//! use bytes::Bytes;
//! use http::{Request, Response, StatusCode};
//! use http_body_util::Full;
//! use tower::{Service, ServiceExt, ServiceBuilder, service_fn, BoxError};
//! use tower_http::csrf::CsrfLayer;
//!
//! async fn handle(_: Request<Full<Bytes>>) -> Result<Response<Full<Bytes>>, BoxError> {
//!     Ok(Response::new(Full::default()))
//! }
//!
//! # #[tokio::main]
//! # async fn main() -> Result<(), BoxError> {
//! let layer = CsrfLayer::new()
//!     .add_trusted_origin("https://example.com")?;
//!
//! let mut service = ServiceBuilder::new()
//!     .layer(layer)
//!     .service_fn(handle);
//!
//! // Safe methods always pass.
//! let request = Request::builder()
//!     .method("GET")
//!     .uri("/")
//!     .body(Full::default())
//!     .unwrap();
//!
//! let response = service.ready().await?.call(request).await?;
//!
//! assert_eq!(response.status(), StatusCode::OK);
//!
//! // Cross-site POSTs are blocked.
//! let request = Request::builder()
//!     .method("POST")
//!     .uri("/")
//!     .header("host", "example.com")
//!     .header("sec-fetch-site", "cross-site")
//!     .body(Full::default())
//!     .unwrap();
//!
//! let response = service.ready().await?.call(request).await?;
//!
//! assert_eq!(response.status(), StatusCode::FORBIDDEN);
//!
//! # Ok(())
//! # }
//! ```
//!
//! [cross-site request forgery]: https://developer.mozilla.org/en-US/docs/Glossary/CSRF
//! [filippo]: https://words.filippo.io/csrf/
//! [go]: https://pkg.go.dev/net/http#CrossOriginProtection
//! [`Sec-Fetch-Site`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-Fetch-Site
//! [`Origin`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin

use std::collections::HashSet;
use std::fmt::{self, Debug, Formatter};
use std::sync::Arc;

use http::{Method, Uri};

mod future;
mod layer;
mod response;
mod service;
mod url;

pub use self::future::ResponseFuture;
pub use self::layer::CsrfLayer;
pub use self::response::{DefaultResponseForProtectionError, ResponseForProtectionError};
pub use self::service::Csrf;

/// Errors that can occur while configuring [`CsrfLayer`].
#[derive(Clone, Debug, PartialEq)]
#[non_exhaustive]
pub enum ConfigError {
    /// The origin string could not be parsed as a URI.
    InvalidOriginUrl {
        /// The offending origin string.
        origin: String,
        /// The parser error message.
        message: String,
    },

    /// An origin URL containing a path, query, or fragment was added as a
    /// trusted origin.
    InvalidOriginUrlComponents {
        /// The offending origin string.
        origin: String,
    },

    /// An origin with a scheme other than `http` or `https` (e.g. `file://`,
    /// `mailto:`, or a bare host with no scheme) was added as a trusted
    /// origin. Such origins can never match a browser-supplied request
    /// `Origin`.
    OpaqueOrigin {
        /// The offending origin string.
        origin: String,
    },

    /// A trusted origin contained non-ASCII characters. Browsers send IDN
    /// hostnames in punycode form, so the configured value must use the
    /// punycode form (e.g. `xn--exmple-cua.com`) to ever match.
    NonAsciiHostname {
        /// The offending origin string.
        origin: String,
    },
}

impl fmt::Display for ConfigError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            ConfigError::InvalidOriginUrl { origin, message } => {
                write!(f, "invalid origin {origin:?}: {message}")
            }
            ConfigError::InvalidOriginUrlComponents { origin } => write!(
                f,
                "invalid origin {origin:?}: path, query, and fragment are not allowed"
            ),
            ConfigError::OpaqueOrigin { origin } => write!(
                f,
                "invalid origin {origin:?}: scheme must be http or https"
            ),
            ConfigError::NonAsciiHostname { origin } => write!(
                f,
                "invalid origin {origin:?}: non-ASCII hostnames must be supplied in punycode (xn--…)"
            ),
        }
    }
}

impl std::error::Error for ConfigError {}

/// Reason a request was rejected by [`Csrf`].
///
/// Retrieve the category with [`ProtectionError::kind`]. [`Csrf`] attaches it to
/// every `403 Forbidden` rejection response's extensions so surrounding layers
/// can distinguish explicit cross-origin rejections from conservative fallback
/// rejections.
///
/// This is an opaque struct rather than an enum so future variants can carry
/// additional context without a breaking change; match on [`kind`] instead.
///
/// [`kind`]: ProtectionError::kind
#[derive(Clone, Debug)]
pub struct ProtectionError {
    kind: ProtectionErrorKind,
}

impl ProtectionError {
    pub(crate) fn new(kind: ProtectionErrorKind) -> Self {
        Self { kind }
    }

    /// The category of rejection.
    pub fn kind(&self) -> ProtectionErrorKind {
        self.kind
    }
}

impl fmt::Display for ProtectionError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self.kind {
            ProtectionErrorKind::CrossOriginRequest => f.write_str("Cross-Origin request detected"),
            ProtectionErrorKind::CrossOriginRequestFromOldBrowser => {
                f.write_str("Cross-Origin request from old browser detected")
            }
        }
    }
}

impl std::error::Error for ProtectionError {}

/// The category of a [`ProtectionError`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum ProtectionErrorKind {
    /// A cross-origin request was detected via `Sec-Fetch-Site`.
    CrossOriginRequest,

    /// A request without `Sec-Fetch-Site` failed the `Origin`/`Host` fallback
    /// check. Modern browsers always send `Sec-Fetch-Site`, so this typically
    /// means the request came from an old browser or non-browser client.
    CrossOriginRequestFromOldBrowser,
}

type BypassFn = dyn Fn(&Method, &Uri) -> bool + Send + Sync + 'static;

struct DebugFn;

impl Debug for DebugFn {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.write_str("<fn>")
    }
}

#[derive(Clone, Default)]
struct Origins(Arc<HashSet<Vec<u8>>>);

impl Origins {
    fn contains(&self, origin: &[u8]) -> bool {
        self.0.contains(origin)
    }

    fn insert(&mut self, origin: impl Into<Vec<u8>>) {
        Arc::make_mut(&mut self.0).insert(origin.into());
    }
}

impl Debug for Origins {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        // render trusted origins as utf-h strings
        write!(f, "Origins(")?;
        f.debug_set()
            .entries(self.0.iter().map(|o| String::from_utf8_lossy(o)))
            .finish()?;
        write!(f, ")")
    }
}

#[cfg(test)]
mod tests {
    use std::convert::Infallible;

    use http::{Request, Response, StatusCode};
    use tower::{service_fn, ServiceExt};
    use tower_layer::Layer;

    use super::*;
    use crate::test_helpers::{to_bytes, Body};

    impl PartialEq for super::ProtectionError {
        fn eq(&self, other: &Self) -> bool {
            self.kind == other.kind
        }
    }

    fn echo_service() -> impl tower::Service<
        Request<Body>,
        Response = Response<Body>,
        Error = Infallible,
        Future = impl std::future::Future<Output = Result<Response<Body>, Infallible>>,
    > + Clone {
        service_fn(|req: Request<Body>| async move {
            let body: Body = match req.uri().path() {
                "/foo" => "foo".into(),
                "/bar" => "bar".into(),
                _ => Body::empty(),
            };
            Ok::<_, Infallible>(Response::new(body))
        })
    }

    #[tokio::test]
    async fn test_service_allows_safe_method() {
        let svc = CsrfLayer::new()
            .add_trusted_origin("https://example.com")
            .unwrap()
            .layer(echo_service());

        let req = Request::builder()
            .method("GET")
            .uri("/foo")
            .body(Body::empty())
            .unwrap();

        let res = svc.oneshot(req).await.unwrap();

        assert_eq!(res.status(), StatusCode::OK);

        let body = to_bytes(res.into_body()).await.unwrap();
        assert_eq!(&body[..], b"foo");
    }

    #[tokio::test]
    async fn test_service_allows_post_from_trusted_origin() {
        let svc = CsrfLayer::new()
            .add_trusted_origin("https://example.com")
            .unwrap()
            .layer(echo_service());

        let req = Request::builder()
            .method("POST")
            .uri("/bar")
            .header("origin", "https://example.com")
            .body(Body::empty())
            .unwrap();

        let res = svc.oneshot(req).await.unwrap();

        assert_eq!(res.status(), StatusCode::OK);

        let body = to_bytes(res.into_body()).await.unwrap();
        assert_eq!(&body[..], b"bar");
    }

    #[tokio::test]
    async fn test_service_rejects_post_from_untrusted_origin() {
        let svc = CsrfLayer::new()
            .add_trusted_origin("https://example.com")
            .unwrap()
            .layer(echo_service());

        let req = Request::builder()
            .method("POST")
            .uri("/bar")
            .header("origin", "https://malicious.example")
            .body(Body::empty())
            .unwrap();

        let res = svc.oneshot(req).await.unwrap();

        assert_eq!(res.status(), StatusCode::FORBIDDEN);
        assert_eq!(
            res.extensions().get::<ProtectionError>(),
            Some(&ProtectionError::new(
                ProtectionErrorKind::CrossOriginRequestFromOldBrowser
            )),
        );
    }

    #[tokio::test]
    async fn test_service_uses_custom_rejection_response() {
        let svc = CsrfLayer::new()
            .with_rejection_response(|_err: ProtectionError| {
                let mut res = Response::new(Body::from("denied"));
                *res.status_mut() = StatusCode::IM_A_TEAPOT;
                res
            })
            .layer(echo_service());

        let req = Request::builder()
            .method("POST")
            .uri("/bar")
            .header("origin", "https://malicious.example")
            .body(Body::empty())
            .unwrap();

        let res = svc.oneshot(req).await.unwrap();

        assert_eq!(res.status(), StatusCode::IM_A_TEAPOT);
        assert_ne!(res.status(), StatusCode::OK);
        // The middleware attaches the error even though a custom builder
        // produced the response.
        assert_eq!(
            res.extensions().get::<ProtectionError>(),
            Some(&ProtectionError::new(
                ProtectionErrorKind::CrossOriginRequestFromOldBrowser
            )),
        );

        let body = to_bytes(res.into_body()).await.unwrap();
        assert_eq!(&body[..], b"denied");
    }

    #[tokio::test]
    async fn test_service_custom_rejection_response_not_invoked_when_allowed() {
        let svc = CsrfLayer::new()
            .add_trusted_origin("https://example.com")
            .unwrap()
            .with_rejection_response(|_err: ProtectionError| {
                let mut res = Response::new(Body::from("denied"));
                *res.status_mut() = StatusCode::IM_A_TEAPOT;
                res
            })
            .layer(echo_service());

        let req = Request::builder()
            .method("POST")
            .uri("/bar")
            .header("origin", "https://example.com")
            .body(Body::empty())
            .unwrap();

        let res = svc.oneshot(req).await.unwrap();

        assert_eq!(res.status(), StatusCode::OK);
        assert_ne!(res.status(), StatusCode::IM_A_TEAPOT);
        assert!(res.extensions().get::<ProtectionError>().is_none());

        let body = to_bytes(res.into_body()).await.unwrap();
        assert_eq!(&body[..], b"bar");
    }

    #[test]
    fn test_layer_add_trusted_origin() {
        // Smoke check that the layer threads parse_origin's Ok and Err
        // through; the full validation matrix lives in url.rs.
        assert!(CsrfLayer::new()
            .add_trusted_origin("https://example.com")
            .is_ok());
        assert!(matches!(
            CsrfLayer::new().add_trusted_origin("not a valid url"),
            Err(ConfigError::InvalidOriginUrl { .. })
        ));
    }

    #[test]
    fn test_middleware_bypass() {
        let layer = CsrfLayer::new()
            .with_insecure_bypass(|_method, uri| -> bool { uri.path() == "/bypass" });

        let middleware = layer.layer(());

        struct Test {
            name: &'static str,
            path: &'static str,
            sec_fetch_site: Option<&'static str>,
            result: Result<(), ProtectionError>,
        }

        let tests = [
            Test {
                name: "bypass path without sec-fetch-site",
                path: "/bypass",
                sec_fetch_site: None,
                result: Ok(()),
            },
            Test {
                name: "bypass path with cross-site",
                path: "/bypass",
                sec_fetch_site: Some("cross-site"),
                result: Ok(()),
            },
            Test {
                name: "non-bypass path without sec-fetch-site",
                path: "/api",
                sec_fetch_site: None,
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "non-bypass path with cross-site",
                path: "/api",
                sec_fetch_site: Some("cross-site"),
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequest,
                )),
            },
        ];

        for test in tests {
            let mut req = Request::builder()
                .method("POST")
                .header("host", "example.com")
                .header("origin", "https://attacker.example")
                .uri(format!("https://example.com{}", test.path));

            if let Some(sec_fetch_site) = test.sec_fetch_site {
                req = req.header("sec-fetch-site", sec_fetch_site);
            }

            let req = req.body(()).unwrap();

            assert_eq!(middleware.verify(&req), test.result, "{}", test.name);
        }
    }

    #[test]
    fn test_middleware_bypass_applies_when_origin_unparseable() {
        let middleware = CsrfLayer::new()
            .with_insecure_bypass(|_method, uri| uri.path() == "/bypass")
            .layer(());

        let req = Request::builder()
            .method("POST")
            .uri("https://example.com/bypass")
            .header("host", "example.com")
            .header(
                "origin",
                http::HeaderValue::from_bytes(&[0xFF, 0xFE]).unwrap(),
            )
            .body(())
            .unwrap();

        assert_eq!(middleware.verify(&req), Ok(()));
    }

    #[test]
    fn test_middleware_debug_trait() {
        let layer = CsrfLayer::new();

        let middleware = layer
            .clone()
            .with_insecure_bypass(|method, uri| method == Method::POST && uri.path() == "/bypass")
            .layer(());

        assert_eq!(
            format!("{:?}", middleware),
            "Csrf { inner: (), insecure_bypass: Some(<fn>), trusted_origins: Origins({}), rejection_response: <fn> }"
        );

        let middleware = layer.layer(());

        assert_eq!(
            format!("{:?}", middleware),
            "Csrf { inner: (), insecure_bypass: None, trusted_origins: Origins({}), rejection_response: <fn> }"
        );
    }

    #[test]
    fn test_middleware_origin_host_port_match() {
        let middleware: Csrf<()> = Default::default();

        struct Test {
            name: &'static str,
            uri: &'static str,
            host: Option<&'static str>,
            origin: &'static str,
            result: Result<(), ProtectionError>,
        }

        let tests = [
            Test {
                name: "default port both sides",
                uri: "/",
                host: Some("example.com"),
                origin: "https://example.com",
                result: Ok(()),
            },
            Test {
                name: "same non-default port both sides",
                uri: "/",
                host: Some("example.com:8443"),
                origin: "https://example.com:8443",
                result: Ok(()),
            },
            Test {
                name: "explicit default port both sides",
                uri: "/",
                host: Some("example.com:443"),
                origin: "https://example.com:443",
                result: Ok(()),
            },
            Test {
                name: "mismatched non-default ports",
                uri: "/",
                host: Some("example.com:8443"),
                origin: "https://example.com:8444",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                // Strict byte match: an explicit default port does not equal an
                // implicit one (the reference does not normalize ports).
                name: "origin has explicit default, host implicit",
                uri: "/",
                host: Some("example.com"),
                origin: "https://example.com:443",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "host has explicit default, origin implicit",
                uri: "/",
                host: Some("example.com:443"),
                origin: "https://example.com",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "host implicit, origin explicit non-default",
                uri: "/",
                host: Some("example.com"),
                origin: "https://example.com:8443",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "missing host, uri authority implicit, origin explicit non-default",
                uri: "https://example.com/path",
                host: None,
                origin: "https://example.com:8443",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                // No request-target authority, so the Host header is the effective
                // host, compared verbatim — a malformed Host never matches an Origin.
                name: "malformed host header compared verbatim",
                uri: "/path",
                host: Some("not a valid authority"),
                origin: "https://example.com",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                // RFC 7230 §5.3 / Go parity: the request-target authority is the
                // effective host (Host header ignored); here it matches Origin.
                name: "request-target authority wins over host header (match)",
                uri: "https://example.com/path",
                host: Some("other.example"),
                origin: "https://example.com",
                result: Ok(()),
            },
            Test {
                // Security-relevant: Origin matches the Host header but not the
                // winning request-target authority, so it stays cross-origin.
                name: "origin matching host header but not authority is rejected",
                uri: "https://example.com/path",
                host: Some("other.example"),
                origin: "https://other.example",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "missing host, uri carries authority (match)",
                uri: "https://example.com/path",
                host: None,
                origin: "https://example.com",
                result: Ok(()),
            },
            Test {
                name: "missing host, uri authority mismatch",
                uri: "https://other.example/path",
                host: None,
                origin: "https://example.com",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "missing host and no uri authority",
                uri: "/path",
                host: None,
                origin: "https://example.com",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "scheme-less origin does not match host even if bytes agree",
                uri: "/",
                host: Some("example.com:8443"),
                origin: "example.com:8443",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "non-http origin scheme does not enter host fallback",
                uri: "/",
                host: Some("example.com:8443"),
                origin: "ftp://example.com:8443",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
        ];

        for test in tests {
            let mut req = Request::builder().method(Method::POST).uri(test.uri);

            if let Some(host) = test.host {
                req = req.header("host", host);
            }

            let req = req.header("origin", test.origin).body(()).unwrap();

            assert_eq!(middleware.verify(&req), test.result, "{}", test.name);
        }
    }

    #[test]
    fn test_middleware_sec_fetch_site() {
        let middleware: Csrf<()> = Default::default();

        const NON_DECODABLE: &[u8] = &[0xFF, 0xFE];
        assert!(
            http::HeaderValue::from_bytes(NON_DECODABLE)
                .expect("NON_DECODABLE must be a valid HeaderValue")
                .to_str()
                .is_err(),
            "NON_DECODABLE must fail HeaderValue::to_str()"
        );

        struct Test {
            name: &'static str,
            method: http::Method,
            sec_fetch_site: Option<&'static [u8]>,
            origin: Option<&'static [u8]>,
            result: Result<(), ProtectionError>,
        }

        let tests = [
            Test {
                name: "same-origin allowed",
                method: Method::GET,
                sec_fetch_site: Some(b"same-origin"),
                origin: None,
                result: Ok(()),
            },
            Test {
                name: "none allowed",
                method: Method::POST,
                sec_fetch_site: Some(b"none"),
                origin: None,
                result: Ok(()),
            },
            Test {
                name: "cross-site blocked",
                method: Method::POST,
                sec_fetch_site: Some(b"cross-site"),
                origin: None,
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequest,
                )),
            },
            Test {
                name: "same-site blocked",
                method: Method::POST,
                sec_fetch_site: Some(b"same-site"),
                origin: None,
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequest,
                )),
            },
            Test {
                name: "no header with no origin",
                method: Method::POST,
                sec_fetch_site: None,
                origin: None,
                result: Ok(()),
            },
            Test {
                name: "no header with matching origin",
                method: Method::POST,
                sec_fetch_site: None,
                origin: Some(b"https://example.com"),
                result: Ok(()),
            },
            Test {
                name: "no header with mismatched origin",
                method: Method::POST,
                sec_fetch_site: None,
                origin: Some(b"https://attacker.example"),
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "no header with null origin",
                method: Method::POST,
                sec_fetch_site: None,
                origin: Some(b"null"),
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "GET allowed",
                method: Method::GET,
                sec_fetch_site: Some(b"cross-site"),
                origin: None,
                result: Ok(()),
            },
            Test {
                name: "HEAD allowed",
                method: Method::HEAD,
                sec_fetch_site: Some(b"cross-site"),
                origin: None,
                result: Ok(()),
            },
            Test {
                name: "OPTIONS allowed",
                method: Method::OPTIONS,
                sec_fetch_site: Some(b"cross-site"),
                origin: None,
                result: Ok(()),
            },
            Test {
                name: "PUT blocked",
                method: Method::PUT,
                sec_fetch_site: Some(b"cross-site"),
                origin: None,
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequest,
                )),
            },
            Test {
                name: "non-decodable origin without sec-fetch-site rejected",
                method: Method::POST,
                sec_fetch_site: None,
                origin: Some(NON_DECODABLE),
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "non-decodable sec-fetch-site without origin rejected",
                method: Method::POST,
                sec_fetch_site: Some(NON_DECODABLE),
                origin: None,
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequest,
                )),
            },
            Test {
                name: "empty sec-fetch-site without origin allowed",
                method: Method::POST,
                sec_fetch_site: Some(b""),
                origin: None,
                result: Ok(()),
            },
            Test {
                name: "empty origin without sec-fetch-site allowed",
                method: Method::POST,
                sec_fetch_site: None,
                origin: Some(b""),
                result: Ok(()),
            },
        ];

        for test in tests {
            let mut req = Request::builder()
                .method(test.method)
                .header("host", "example.com");

            if let Some(sec_fetch_site) = test.sec_fetch_site {
                req = req.header("sec-fetch-site", sec_fetch_site);
            }

            if let Some(origin) = test.origin {
                req = req.header("origin", origin);
            }

            let req = req.body(()).unwrap();

            assert_eq!(middleware.verify(&req), test.result, "{}", test.name);
        }
    }

    #[test]
    fn test_middleware_trusted_origin_bypass() {
        let layer = CsrfLayer::new()
            .add_trusted_origin("https://trusted.example")
            .unwrap();

        let middleware = layer.layer(());

        struct Test {
            name: &'static str,
            sec_fetch_site: Option<&'static str>,
            origin: Option<&'static str>,
            result: Result<(), ProtectionError>,
        }

        let tests = [
            Test {
                name: "trusted origin without sec-fetch-site",
                origin: Some("https://trusted.example"),
                sec_fetch_site: None,
                result: Ok(()),
            },
            Test {
                name: "trusted origin with cross-site",
                origin: Some("https://trusted.example"),
                sec_fetch_site: Some("cross-site"),
                result: Ok(()),
            },
            Test {
                name: "untrusted origin without sec-fetch-site",
                origin: Some("https://attacker.example"),
                sec_fetch_site: None,
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequestFromOldBrowser,
                )),
            },
            Test {
                name: "untrusted origin with cross-site",
                origin: Some("https://attacker.example"),
                sec_fetch_site: Some("cross-site"),
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequest,
                )),
            },
        ];

        for test in tests {
            let mut req = Request::builder()
                .method("POST")
                .header("host", "example.com");

            if let Some(sec_fetch_site) = test.sec_fetch_site {
                req = req.header("sec-fetch-site", sec_fetch_site);
            }

            if let Some(origin) = test.origin {
                req = req.header("origin", origin);
            }

            let req = req.body(()).unwrap();

            assert_eq!(middleware.verify(&req), test.result, "{}", test.name);
        }
    }

    #[test]
    fn test_middleware_trusted_origin_strict_byte_match() {
        // Trusted origins are matched byte-for-byte against the request's Origin
        // header (no canonicalization), mirroring the Go reference. Only an exact
        // match is trusted; case- and port-form variants are not.
        struct Test {
            name: &'static str,
            trusted: &'static str,
            origin: &'static str,
            result: Result<(), ProtectionError>,
        }

        let tests = [
            Test {
                name: "exact match trusted",
                trusted: "https://example.com",
                origin: "https://example.com",
                result: Ok(()),
            },
            Test {
                name: "exact match with non-default port",
                trusted: "https://example.com:8443",
                origin: "https://example.com:8443",
                result: Ok(()),
            },
            Test {
                name: "host case mismatch not trusted",
                trusted: "https://Example.COM",
                origin: "https://example.com",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequest,
                )),
            },
            Test {
                name: "explicit default port not trusted against bare origin",
                trusted: "https://example.com:443",
                origin: "https://example.com",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequest,
                )),
            },
            Test {
                name: "bare trusted not matched by explicit-default-port origin",
                trusted: "https://example.com",
                origin: "https://example.com:443",
                result: Err(ProtectionError::new(
                    ProtectionErrorKind::CrossOriginRequest,
                )),
            },
        ];

        for test in tests {
            let middleware = CsrfLayer::new()
                .add_trusted_origin(test.trusted)
                .unwrap_or_else(|e| panic!("{}: add_trusted_origin failed: {e}", test.name))
                .layer(());

            let req = Request::builder()
                .method("POST")
                .header("host", "other.example")
                .header("origin", test.origin)
                .header("sec-fetch-site", "cross-site")
                .body(())
                .unwrap();

            assert_eq!(middleware.verify(&req), test.result, "{}", test.name);
        }
    }
}