praxis-proxy-protocol 0.7.4

HTTP, TCP, and protocol adapters for Praxis
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

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2024 Praxis Contributors

//! Hop-by-hop stripping adapters over [`praxis_core::next_hop_headers`].
//!
//! Pingora request/response types implement [`praxis_core::next_hop_headers::HopByHopTarget`] and
//! [`crate::http::pingora::handler::hop_by_hop::RemoveHeader`]; header-map call sites delegate to
//! the shared core module.

use http::HeaderMap;
use pingora_http::{RequestHeader, ResponseHeader};
use praxis_core::next_hop_headers::{
    HopByHopTarget, StripHopByHopOptions, UpgradePreserve, strip_hop_by_hop, strip_reserved, strip_reserved_target,
};

/// [RFC 9110] hop-by-hop headers for upstream requests.
pub(crate) const REQUEST_HOP_BY_HOP: &[&str] = praxis_core::reserved_headers::HOP_BY_HOP_HEADERS;

/// [RFC 9110] hop-by-hop headers for upstream responses.
pub(crate) const RESPONSE_HOP_BY_HOP: &[&str] = praxis_core::reserved_headers::RESPONSE_HOP_BY_HOP_HEADERS;

pub(crate) use praxis_core::next_hop_headers::has_websocket_upgrade;

/// Strip hop-by-hop headers on a standalone [`HeaderMap`] (terminal responses).
pub(crate) fn strip_hop_by_hop_header_map(headers: &mut HeaderMap, static_list: &[&str]) {
    strip_hop_by_hop(
        headers,
        StripHopByHopOptions {
            static_headers: static_list,
            upgrade: UpgradePreserve::None,
            restore_chunked_framing: false,
            suppress_chunked_restore_on_websocket: false,
        },
    );
}

/// Strip reserved internal headers from a client-bound [`HeaderMap`].
pub(crate) fn strip_reserved_internal_header_map(headers: &mut HeaderMap) {
    strip_reserved(headers);
}

/// Local wrapper so [`HopByHopTarget`] can be implemented for Pingora types.
pub(crate) struct RequestHop<'a>(pub &'a mut RequestHeader);

impl HopByHopTarget for RequestHop<'_> {
    fn headers(&self) -> &HeaderMap {
        &self.0.headers
    }

    fn remove_by_name(&mut self, name: &str) {
        drop(self.0.remove_header(name));
    }

    fn insert_transfer_encoding_chunked(&mut self) {
        drop(self.0.insert_header(http::header::TRANSFER_ENCODING, "chunked"));
    }
}

/// Local wrapper so [`HopByHopTarget`] can be implemented for Pingora types.
pub(crate) struct ResponseHop<'a>(pub &'a mut ResponseHeader);

impl HopByHopTarget for ResponseHop<'_> {
    fn headers(&self) -> &HeaderMap {
        &self.0.headers
    }

    fn remove_by_name(&mut self, name: &str) {
        drop(self.0.remove_header(name));
    }

    fn insert_transfer_encoding_chunked(&mut self) {
        drop(self.0.insert_header(http::header::TRANSFER_ENCODING, "chunked"));
    }
}

/// Strip reserved internal headers on Pingora request/response header types.
pub(crate) trait RemoveHeader {
    /// Strip reserved internal headers before forwarding to upstream or client.
    fn strip_reserved_internal(&mut self);
}

impl RemoveHeader for RequestHeader {
    fn strip_reserved_internal(&mut self) {
        strip_reserved_target(&mut RequestHop(self));
    }
}

impl RemoveHeader for ResponseHeader {
    fn strip_reserved_internal(&mut self) {
        strip_reserved_target(&mut ResponseHop(self));
    }
}