proksi 0.10.0

A batteries-included reverse proxy with automatic HTTPS using Cloudflare Pingora and Let's Encrypt.
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

//! TCP proxying (`tcp` blocks, see ADR 0003): connections accepted on an address are
//! forwarded to the upstreams of its block

use std::{
    net::SocketAddr,
    sync::{Arc, OnceLock},
};

use pingora::lb::{selection::RoundRobin, LoadBalancer};

use crate::{config::tcp::TcpTls, metrics::TcpMetrics, stores::host_container::binds};

pub mod alpn;
pub mod client_hello;
pub mod proxy;
pub mod router;
pub mod services;

/// A `tcp` block, ready to accept connections
pub struct TcpTarget {
    /// How the block is named in logs (`tcp "db" in host "a.com"`)
    pub label: String,
    pub host: Option<String>,
    pub listen: SocketAddr,
    pub tls: TcpTls,
    /// Protocols (ALPN) the block is chosen by, if any
    pub alpn: Vec<String>,
    /// How long connecting to an upstream can take
    pub connect_timeout: std::time::Duration,
    /// How long a connection can go without bytes either way (`None`: forever)
    pub idle_timeout: Option<std::time::Duration>,
    pub load_balancer: Arc<LoadBalancer<RoundRobin>>,
    /// None when metrics are disabled
    pub metrics: Option<TcpMetrics>,
}

/// The load balancers of the `tcp` blocks (set once, at startup)
static LOAD_BALANCERS: OnceLock<Vec<(String, Arc<LoadBalancer<RoundRobin>>)>> = OnceLock::new();

fn register_load_balancers(targets: &[TcpTarget]) {
    let load_balancers = targets
        .iter()
        .map(|target| (target.label.clone(), target.load_balancer.clone()))
        .collect();
    let _ = LOAD_BALANCERS.set(load_balancers);
}

/// The load balancers of the `tcp` blocks, by block, for health checks
pub fn load_balancers() -> &'static [(String, Arc<LoadBalancer<RoundRobin>>)] {
    LOAD_BALANCERS.get().map_or(&[], Vec::as_slice)
}

/// The TLS passthrough block for a connection accepted on `local`, asking for `server_name`
/// (read from its `ClientHello`). On an address of its own, a block takes every connection;
/// shared with other blocks or HTTPS hosts (`shared_with_https`), only those asking for its
/// host.
pub fn passthrough_for<'a>(
    targets: &'a [TcpTarget],
    local: &SocketAddr,
    server_name: Option<&str>,
    shared_with_https: bool,
) -> Option<&'a TcpTarget> {
    let on_address = targets
        .iter()
        .filter(|target| binds(&target.listen, local))
        .collect::<Vec<_>>();
    let alone = on_address.len() == 1 && !shared_with_https;
    on_address.into_iter().find(|target| {
        target.tls == TcpTls::Passthrough
            && (alone
                || target
                    .host
                    .as_deref()
                    .zip(server_name)
                    .is_some_and(|(host, name)| host.eq_ignore_ascii_case(name)))
    })
}

/// The blocks listening on `address`
pub fn on_address<'a>(
    targets: &'a [TcpTarget],
    address: &'a str,
) -> impl Iterator<Item = &'a TcpTarget> {
    targets
        .iter()
        .filter(move |target| target.listen.to_string() == address)
}

/// The block for a connection accepted on `local`. With TLS terminated, the block of the host
/// the client asked for (`sni`), so a host's certificate never reaches another host's block,
/// and if the block has protocols, the one negotiated (`alpn`) must be one of them.
pub fn choose<'a>(
    targets: &'a [TcpTarget],
    local: &SocketAddr,
    sni: Option<&str>,
    alpn: Option<&[u8]>,
) -> Option<&'a TcpTarget> {
    targets
        .iter()
        .filter(|target| binds(&target.listen, local))
        .find(|target| match target.tls {
            TcpTls::Terminate => {
                let host = target
                    .host
                    .as_deref()
                    .zip(sni)
                    .is_some_and(|(host, sni)| host.eq_ignore_ascii_case(sni));
                let protocol = target.alpn.is_empty()
                    || alpn.is_some_and(|alpn| target.alpn.iter().any(|p| p.as_bytes() == alpn));
                host && protocol
            }
            // Only one block per address (checked when the configuration loads)
            TcpTls::None => true,
            // Chosen before any handshake, by `tcp::router` (`passthrough_for`)
            TcpTls::Passthrough => false,
        })
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;

    use pingora::lb::LoadBalancer;

    use crate::config::tcp::TcpTls;

    use super::{choose, TcpTarget};

    fn target(label: &str, host: Option<&str>, listen: &str, tls: TcpTls) -> TcpTarget {
        TcpTarget {
            label: label.to_string(),
            host: host.map(ToString::to_string),
            listen: listen.parse().unwrap(),
            tls,
            alpn: vec![],
            connect_timeout: std::time::Duration::from_secs(5),
            idle_timeout: None,
            load_balancer: Arc::new(LoadBalancer::try_from_iter(["127.0.0.1:1"]).unwrap()),
            metrics: None,
        }
    }

    fn chosen(targets: &[TcpTarget], local: &str, sni: Option<&str>) -> Option<String> {
        chosen_with(targets, local, sni, None)
    }

    fn chosen_with(
        targets: &[TcpTarget],
        local: &str,
        sni: Option<&str>,
        alpn: Option<&str>,
    ) -> Option<String> {
        choose(
            targets,
            &local.parse().unwrap(),
            sni,
            alpn.map(str::as_bytes),
        )
        .map(|target| target.label.clone())
    }

    #[test]
    fn test_choose_by_address() {
        let targets = [
            target("game", None, "0.0.0.0:7777", TcpTls::None),
            target("raw", Some("a.test"), "127.0.0.1:6000", TcpTls::Passthrough),
        ];

        assert_eq!(
            chosen(&targets, "10.0.0.1:7777", None).as_deref(),
            Some("game")
        );
        // TLS passthrough is chosen before any handshake (`passthrough_for`), never here
        assert_eq!(chosen(&targets, "127.0.0.1:6000", None), None);
        assert_eq!(chosen(&targets, "10.0.0.1:6000", None), None);
        assert_eq!(chosen(&targets, "10.0.0.1:8000", None), None);
    }

    #[test]
    fn test_choose_by_server_name_with_tls() {
        let targets = [
            target("a", Some("a.test"), "0.0.0.0:5433", TcpTls::Terminate),
            target("b", Some("b.test"), "0.0.0.0:5433", TcpTls::Terminate),
        ];

        assert_eq!(
            chosen(&targets, "10.0.0.1:5433", Some("a.test")).as_deref(),
            Some("a")
        );
        assert_eq!(
            chosen(&targets, "10.0.0.1:5433", Some("B.Test")).as_deref(),
            Some("b")
        );
        // Another name (or none) never reaches a host's block, even alone on its address
        assert_eq!(chosen(&targets, "10.0.0.1:5433", Some("c.test")), None);
        assert_eq!(chosen(&targets[..1], "10.0.0.1:5433", Some("c.test")), None);
        assert_eq!(chosen(&targets[..1], "10.0.0.1:5433", None), None);
    }

    #[test]
    fn test_choose_by_protocol() {
        let mut game = target("game", Some("a.test"), "0.0.0.0:443", TcpTls::Terminate);
        game.alpn = vec!["game/1".to_string()];
        let targets = [game];

        assert_eq!(
            chosen_with(&targets, "10.0.0.1:443", Some("a.test"), Some("game/1")).as_deref(),
            Some("game")
        );
        // Other protocols (or none) are the host's locations
        assert_eq!(
            chosen_with(&targets, "10.0.0.1:443", Some("a.test"), Some("h2")),
            None
        );
        assert_eq!(
            chosen_with(&targets, "10.0.0.1:443", Some("a.test"), None),
            None
        );
        assert_eq!(
            chosen_with(&targets, "10.0.0.1:443", Some("b.test"), Some("game/1")),
            None
        );
    }

    #[test]
    fn test_passthrough_by_server_name() {
        let targets = [
            target("a", Some("a.test"), "0.0.0.0:443", TcpTls::Passthrough),
            target("b", Some("b.test"), "0.0.0.0:443", TcpTls::Passthrough),
            target("c", Some("c.test"), "0.0.0.0:8443", TcpTls::Passthrough),
        ];
        let chosen = |local: &str, name: Option<&str>, https: bool| {
            super::passthrough_for(&targets, &local.parse().unwrap(), name, https)
                .map(|target| target.label.clone())
        };

        assert_eq!(chosen("10.0.0.1:443", Some("a.test"), true).as_deref(), Some("a"));
        assert_eq!(chosen("10.0.0.1:443", Some("b.test"), false).as_deref(), Some("b"));
        assert_eq!(chosen("10.0.0.1:443", Some("other.test"), true), None);
        assert_eq!(chosen("10.0.0.1:443", None, false), None);
        // Alone on its address: every connection
        assert_eq!(chosen("10.0.0.1:8443", Some("other.test"), false).as_deref(), Some("c"));
        assert_eq!(chosen("10.0.0.1:8443", None, false).as_deref(), Some("c"));
        // Unless the address is shared with HTTPS hosts
        assert_eq!(chosen("10.0.0.1:8443", Some("other.test"), true), None);
        assert_eq!(chosen("10.0.0.1:8443", Some("C.Test"), true).as_deref(), Some("c"));
    }
}