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
//! An example to showcase how one can build an authenticated http proxy server.
//!
//! This example also demonstrates how one can define their own username label parser,
//! next to the built-in username label parsers.
//!
//! # Run the example
//!
//! ```sh
//! cargo run --example http_connect_proxy --features=http-full
//! ```
//!
//! # Expected output
//!
//! The server will start and listen on `:62001`. You can use `curl` to interact with the service:
//!
//! ```sh
//! curl -v -x http://127.0.0.1:62001 --proxy-user 'john:secret' http://www.example.com/
//! curl -v -x http://127.0.0.1:62001 --proxy-user 'john-red-blue:secret' http://www.example.com/
//! curl -v -x http://127.0.0.1:62001 --proxy-user 'john-priority-high-red-blue:secret' http://www.example.com/
//! curl -v -x http://127.0.0.1:62001 --proxy-user 'john:secret' https://www.example.com/
//! ```
//! The pseudo API can be used as follows:
//!
//! ```sh
//! curl -v -x http://127.0.0.1:62001 --proxy-user 'john:secret' http://echo.example.internal/foo/bar
//! curl -v -x http://127.0.0.1:62001 --proxy-user 'john-red-blue-priority-low:secret' http://echo.example.internal/foo/bar
//! curl -v -x http://127.0.0.1:62001 --proxy-user 'john:secret' -XPOST http://echo.example.internal/lucky/7
//! ```
//!
//! You should see in all the above examples the responses from the server.
//!
//! If you want to see the HTTP traffic in action you can of course also use telnet instead:
//!
//! ```sh
//! telnet 127.0.0.1 62001
//! ```
//!
//! and then type:
//!
//! ```
//! CONNECT example.com:80 HTTP/1.1
//! Host: example.com:80
//! Proxy-Authorization: basic am9objpzZWNyZXQ=
//!
//!
//! GET / HTTP/1.1
//! HOST: example.com:80
//! Connection: close
//!
//!
//! ```
//!
//! You should see the same response as when running:
//!
//! ```sh
//! curl -v -x http://127.0.0.1:62001 --proxy-user 'john:secret' http://www.example.com/
//! ```
#![expect(
clippy::unwrap_used,
clippy::expect_used,
reason = "example/test/bench: panic-on-error and print-for-output are the standard patterns for demos and harnesses"
)]
use rama::{
Layer, Service,
extensions::{Extension, Extensions, ExtensionsRef},
http::{
Body, BodyLimitLayer, Request, Response, StatusCode,
client::EasyHttpWebClient,
layer::{
proxy_auth::ProxyAuthLayer,
remove_header::{RemoveRequestHeaderLayer, RemoveResponseHeaderLayer},
trace::TraceLayer,
upgrade::{DefaultHttpProxyConnectReplyService, UpgradeLayer},
},
matcher::{DomainMatcher, HttpMatcher, MethodMatcher},
server::HttpServer,
service::web::{extract::Path, match_service, response::Json},
},
layer::{ConsumeErrLayer, HijackLayer},
net::{proxy::IoForwardService, stream::SocketInfo, user::credentials::basic},
rt::Executor,
service::service_fn,
tcp::{proxy::IoToProxyBridgeIoLayer, server::TcpListener},
telemetry::tracing::{
self,
level_filters::LevelFilter,
subscriber::{EnvFilter, fmt, layer::SubscriberExt, util::SubscriberInitExt},
},
username::{
UsernameLabelParser, UsernameLabelState, UsernameLabels, UsernameOpaqueLabelParser,
},
utils::octets::mib,
};
use serde::Deserialize;
use serde_json::json;
use std::{convert::Infallible, sync::Arc, time::Duration};
#[tokio::main]
async fn main() {
tracing::subscriber::registry()
.with(fmt::layer())
.with(
EnvFilter::builder()
.with_default_directive(LevelFilter::DEBUG.into())
.from_env_lossy(),
)
.init();
let graceful = rama::graceful::Shutdown::default();
#[derive(Deserialize)]
/// API parameters for the lucky number endpoint
struct APILuckyParams {
number: u32,
}
graceful.spawn_task_fn(async move |guard| {
let exec = Executor::graceful(guard);
let tcp_service = TcpListener::build(exec.clone()).bind_address("127.0.0.1:62001").await.expect("bind tcp proxy to 127.0.0.1:62001");
let http_service = HttpServer::auto(exec.clone())
.service((
TraceLayer::new_for_http(),
ConsumeErrLayer::default(),
// See [`ProxyAuthLayer::with_labels`] for more information,
// e.g. can also be used to extract upstream proxy filters
ProxyAuthLayer::new(basic!("john", "secret"))
.with_labels::<(PriorityUsernameLabelParser, UsernameOpaqueLabelParser)>(),
// example of how one might insert an API layer into their proxy
HijackLayer::new(
DomainMatcher::exact("echo.example.internal"),
Arc::new(match_service!{
HttpMatcher::post("/lucky/{number}") => async move |path: Path<APILuckyParams>| {
Json(json!({
"lucky_number": path.number,
}))
},
HttpMatcher::get("/{*}") => async move |req: Request| {
Json(json!({
"method": req.method().as_str(),
"path": req.uri().path_or_root(),
"username_labels": req.extensions().get_ref::<UsernameLabels>().map(|labels| &labels.0),
"user_priority": req.extensions().get_ref::<Priority>().map(|p| match p {
Priority::High => "high",
Priority::Medium => "medium",
Priority::Low => "low",
}),
}))
},
_ => StatusCode::NOT_FOUND,
})
),
UpgradeLayer::new(
exec.clone(),
MethodMatcher::CONNECT,
DefaultHttpProxyConnectReplyService::new(),
(
ConsumeErrLayer::default(),
IoToProxyBridgeIoLayer::extension_connector_target().with_connector(
rama::dns::client::DnsConnector::new(
rama::tcp::client::service::TcpConnector::new(),
),
),
).into_layer(IoForwardService::new(exec)),
),
RemoveResponseHeaderLayer::hop_by_hop(),
RemoveRequestHeaderLayer::hop_by_hop(),
)
.into_layer(service_fn(http_plain_proxy)));
tcp_service.serve((
// protect the http proxy from too large bodies, both from request and response end
BodyLimitLayer::symmetric(mib(2)),
).into_layer(http_service)).await;
});
graceful
.shutdown_with_limit(Duration::from_secs(30))
.await
.expect("graceful shutdown");
}
async fn http_plain_proxy(req: Request) -> Result<Response, Infallible> {
let client = EasyHttpWebClient::default();
match client.serve(req).await {
Ok(resp) => {
// We can also just directly fetch SocketInfo and it will traverse into egress/ingress chains,
// however to be clear and to avoid confusion in a MITM setup we access the egress one directly.
if let Some(client_socket_info) = resp
.extensions()
.egress()
.and_then(|e| e.get_ref::<SocketInfo>())
{
tracing::info!(
http.response.status_code = %resp.status(),
network.local.port = client_socket_info.local_addr().map(|addr| addr.port.to_string()).unwrap_or_default(),
network.local.address = client_socket_info.local_addr().map(|addr| addr.ip_addr.to_string()).unwrap_or_default(),
network.peer.port = %client_socket_info.peer_addr().port,
network.peer.address = %client_socket_info.peer_addr().ip_addr,
"http plain text proxy received response",
)
} else {
tracing::info!(
http.response.status_code = %resp.status(),
"http plain text proxy received response, IP info unknown",
)
};
Ok(resp)
}
Err(err) => {
tracing::error!("error in client request: {err:?}");
Ok(Response::builder()
.status(StatusCode::INTERNAL_SERVER_ERROR)
.body(Body::empty())
.unwrap())
}
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Extension)]
pub enum Priority {
High,
Medium,
Low,
}
#[derive(Debug, Clone, Default)]
pub struct PriorityUsernameLabelParser {
key_seen: bool,
priority: Option<Priority>,
}
impl UsernameLabelParser for PriorityUsernameLabelParser {
type Error = Infallible;
fn parse_label(&mut self, label: &str) -> UsernameLabelState {
let label = label.trim().to_ascii_lowercase();
if self.key_seen {
self.key_seen = false;
match label.as_str() {
"high" => self.priority = Some(Priority::High),
"medium" => self.priority = Some(Priority::Medium),
"low" => self.priority = Some(Priority::Low),
_ => {
tracing::trace!(%label, "invalid priority username label value");
return UsernameLabelState::Abort;
}
}
} else if label == "priority" {
self.key_seen = true;
}
UsernameLabelState::Used
}
fn build(self, ext: &Extensions) -> Result<(), Self::Error> {
if let Some(priority) = self.priority {
ext.insert(priority);
}
Ok(())
}
}