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
#![cfg_attr(docsrs, feature(doc_cfg))]
//! `reverse-proxy-service` is tower [`Service`s](tower_service::Service) that performs "reverse
//! proxy" with various rewriting rules.
//!
//! Internally these services use [`hyper::Client`] to send an incoming request to the another
//! server. The [`connector`](hyper::client::connect::Connect) for a client can be
//! [`HttpConnector`](hyper::client::HttpConnector), [`HttpsConnector`](hyper_tls::HttpsConnector),
//! or any ones whichever you want.
//!
//! # Examples
//!
//! There are two types of services, [`OneshotService`] and [`ReusedService`]. The
//! [`OneshotService`] *owns* the `Client`, while the [`ReusedService`] *shares* the `Client`
//! via [`Arc`](std::sync::Arc).
//!
//!
//! ## General usage
//!
//! ```
//! # async fn run_test() {
//! use reverse_proxy_service::ReusedServiceBuilder;
//! use reverse_proxy_service::{ReplaceAll, ReplaceN};
//!
//! use hyper::body::Body;
//! use http::Request;
//! use tower_service::Service as _;
//!
//! let svc_builder = reverse_proxy_service::builder_http("example.com:1234").unwrap();
//!
//! let req1 = Request::builder()
//! .method("GET")
//! .uri("https://myserver.com/foo/bar/foo")
//! .body(Body::empty())
//! .unwrap();
//!
//! // Clones Arc<Client>
//! let mut svc1 = svc_builder.build(ReplaceAll("foo", "baz"));
//! // http://example.com:1234/baz/bar/baz
//! let _res = svc1.call(req1).await.unwrap();
//!
//! let req2 = Request::builder()
//! .method("POST")
//! .uri("https://myserver.com/foo/bar/foo")
//! .header("Content-Type", "application/x-www-form-urlencoded")
//! .body(Body::from("key=value"))
//! .unwrap();
//!
//! let mut svc2 = svc_builder.build(ReplaceN("foo", "baz", 1));
//! // http://example.com:1234/baz/bar/foo
//! let _res = svc2.call(req2).await.unwrap();
//! # }
//! ```
//!
//! In this example, the `svc1` and `svc2` shares the same `Client`, holding the `Arc<Client>`s
//! inside them.
//!
//! For more information of rewriting rules (`ReplaceAll`, `ReplaceN` *etc.*), see the
//! documentations of [`rewrite`].
//!
//!
//! ## With axum
//!
//! ```no_run
//! use reverse_proxy_service::ReusedServiceBuilder;
//! use reverse_proxy_service::{TrimPrefix, AppendSuffix, Static};
//!
//! use axum::Router;
//!
//! #[tokio::main]
//! async fn main() {
//! let host1 = reverse_proxy_service::builder_http("example.com").unwrap();
//! let host2 = reverse_proxy_service::builder_http("example.net:1234").unwrap();
//!
//! let app = Router::new()
//! .route_service("/healthcheck", host1.build(Static("/")))
//! .route_service("/users/*path", host1.build(TrimPrefix("/users")))
//! .route_service("/posts", host2.build(AppendSuffix("/")));
//!
//! axum::Server::bind(&"0.0.0.0:3000".parse().unwrap())
//! .serve(app.into_make_service())
//! .await
//! .unwrap();
//! }
//! ```
//!
//!
//! # Return Types
//!
//! The return type ([`Future::Output`](std::future::Future::Output)) of [`ReusedService`] and
//! [`OneshotService`] is `Result<Result<Response, Error>, Infallible>`. This is because axum's
//! [`Router`](axum::Router) accepts only such `Service`s.
//!
//! The [`Error`] type implements [`IntoResponse`](axum::response::IntoResponse) if you enable the
//! `axum`feature.
//! It returns an empty body, with the status code `INTERNAL_SERVER_ERROR`. The description of this
//! error will be logged out at [error](`log::error`) level in the
//! [`into_response()`](axum::response::IntoResponse::into_response()) method.
//!
//!
//! # Features
//!
//! By default only `http1` is enabled.
//!
//! - `http1`: uses `hyper/http1`
//! - `http2`: uses `hyper/http2`
//! - `https`: alias to `nativetls`
//! - `nativetls`: uses the `hyper-tls` crate
//! - `rustls`: alias to `rustls-webpki-roots`
//! - `rustls-webpki-roots`: uses the `hyper-rustls` crate, with the feature `webpki-roots`
//! - `rustls-native-roots`: uses the `hyper-rustls` crate, with the feature `rustls-native-certs`
//! - `rustls-http2`: `http2` plus `rustls`, and `rustls/http2` is enabled
//! - `axum`: implements [`IntoResponse`](axum::response::IntoResponse) for [`Error`]
//!
//! You must turn on either `http1`or `http2`. You cannot use the services if, for example, only
//! the `https` feature is on.
//!
//! Through this document, we use `rustls` to mean *any* of `rustls*` features unless otherwise
//! specified.
mod error;
pub use error::Error;
#[cfg(any(feature = "http1", feature = "http2"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))]
pub mod client;
pub mod rewrite;
pub use rewrite::*;
mod future;
pub use future::RevProxyFuture;
#[cfg(any(feature = "http1", feature = "http2"))]
mod oneshot;
#[cfg(any(feature = "http1", feature = "http2"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))]
pub use oneshot::OneshotService;
#[cfg(any(feature = "http1", feature = "http2"))]
mod reused;
#[cfg(all(
any(feature = "http1", feature = "http2"),
any(feature = "https", feature = "nativetls")
))]
#[cfg_attr(
docsrs,
doc(cfg(all(
any(feature = "http1", feature = "http2"),
any(feature = "https", feature = "nativetls")
)))
)]
pub use reused::builder_https;
#[cfg(all(any(feature = "http1", feature = "http2"), feature = "nativetls"))]
#[cfg_attr(
docsrs,
doc(cfg(all(any(feature = "http1", feature = "http2"), feature = "nativetls")))
)]
pub use reused::builder_nativetls;
#[cfg(all(any(feature = "http1", feature = "http2"), feature = "__rustls"))]
#[cfg_attr(
docsrs,
doc(cfg(all(any(feature = "http1", feature = "http2"), feature = "rustls")))
)]
pub use reused::builder_rustls;
#[cfg(any(feature = "http1", feature = "http2"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))]
pub use reused::Builder as ReusedServiceBuilder;
#[cfg(any(feature = "http1", feature = "http2"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))]
pub use reused::ReusedService;
#[cfg(any(feature = "http1", feature = "http2"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))]
pub use reused::{builder, builder_http};
#[cfg(test)]
mod test_helper {
use super::{Error, RevProxyFuture};
use std::convert::Infallible;
use http::StatusCode;
use http::{Request, Response};
use hyper::body::Body;
use tower_service::Service;
use mockito::Matcher;
async fn call<S, B>(
svc: &mut S,
req: (&str, &str, Option<&str>, B),
expected: (StatusCode, &str),
) where
S: Service<
Request<String>,
Response = Result<Response<Body>, Error>,
Error = Infallible,
Future = RevProxyFuture,
>,
B: Into<String>,
{
let req = if let Some(content_type) = req.2 {
Request::builder()
.method(req.0)
.uri(format!("https://test.com{}", req.1))
.header("Content-Type", content_type)
.body(req.3.into())
} else {
Request::builder()
.method(req.0)
.uri(format!("https://test.com{}", req.1))
.uri(format!("https://test.com{}", req.1))
.body(req.3.into())
}
.unwrap();
let res = svc.call(req).await.unwrap();
assert!(res.is_ok());
let res = res.unwrap();
assert_eq!(res.status(), expected.0);
let res = hyper::body::to_bytes(res.into_body()).await;
assert!(res.is_ok());
assert_eq!(res.unwrap(), expected.1);
}
pub async fn match_path<S>(svc: &mut S)
where
S: Service<
Request<String>,
Response = Result<Response<Body>, Error>,
Error = Infallible,
Future = RevProxyFuture,
>,
{
let _mk = mockito::mock("GET", "/goo/bar/goo/baz/goo")
.with_body("ok")
.create();
call(
svc,
("GET", "/foo/bar/foo/baz/foo", None, ""),
(StatusCode::OK, "ok"),
)
.await;
call(
svc,
("GET", "/foo/bar/foo/baz", None, ""),
(StatusCode::NOT_IMPLEMENTED, ""),
)
.await;
}
pub async fn match_query<S>(svc: &mut S)
where
S: Service<
Request<String>,
Response = Result<Response<Body>, Error>,
Error = Infallible,
Future = RevProxyFuture,
>,
{
let _mk = mockito::mock("GET", "/goo")
.match_query(Matcher::UrlEncoded("greeting".into(), "good day".into()))
.with_body("ok")
.create();
call(
svc,
("GET", "/foo?greeting=good%20day", None, ""),
(StatusCode::OK, "ok"),
)
.await;
call(
svc,
("GET", "/foo", None, ""),
(StatusCode::NOT_IMPLEMENTED, ""),
)
.await;
}
pub async fn match_post<S>(svc: &mut S)
where
S: Service<
Request<String>,
Response = Result<Response<Body>, Error>,
Error = Infallible,
Future = RevProxyFuture,
>,
{
let _mk = mockito::mock("POST", "/goo")
.match_body("test")
.with_body("ok")
.create();
call(svc, ("POST", "/foo", None, "test"), (StatusCode::OK, "ok")).await;
call(
svc,
("PUT", "/foo", None, "test"),
(StatusCode::NOT_IMPLEMENTED, ""),
)
.await;
call(
svc,
("POST", "/foo", None, "tests"),
(StatusCode::NOT_IMPLEMENTED, ""),
)
.await;
}
pub async fn match_header<S>(svc: &mut S)
where
S: Service<
Request<String>,
Response = Result<Response<Body>, Error>,
Error = Infallible,
Future = RevProxyFuture,
>,
{
let _mk = mockito::mock("POST", "/goo")
.match_header("content-type", "application/json")
.match_body(r#"{"key":"value"}"#)
.with_body("ok")
.create();
call(
svc,
(
"POST",
"/foo",
Some("application/json"),
r#"{"key":"value"}"#,
),
(StatusCode::OK, "ok"),
)
.await;
call(
svc,
("POST", "/foo", None, r#"{"key":"value"}"#),
(StatusCode::NOT_IMPLEMENTED, ""),
)
.await;
call(
svc,
(
"POST",
"/foo",
Some("application/json"),
r#"{"key":"values"}"#,
),
(StatusCode::NOT_IMPLEMENTED, ""),
)
.await;
}
}