62 lines
2.8 KiB
Markdown
62 lines
2.8 KiB
Markdown
# rpxy: A simple and ultrafast reverse-proxy for multiple host names with TLS termination, written in pure Rust
|
|
|
|
[](LICENSE)
|
|
|
|
|
|
|
|
|
|
**WIP Project**
|
|
|
|
## Introduction
|
|
|
|
`rpxy` [ahr-pik-see] is an implementation of simple and lightweight reverse-proxy with some additional features. The implementation is based on [`hyper`](https://github.com/hyperium/hyper), [`rustls`](https://github.com/rustls/rustls) and [`tokio`](https://github.com/tokio-rs/tokio), i.e., written in pure Rust. Our `rpxy` allows to route multiple host names to appropriate backend application servers while serving TLS connections.
|
|
|
|
As default, `rpxy` provides the *TLS connection sanitization* by correctly binding a certificate used to establish secure channel with backend application. Specifically, it always keeps the consistency between the given SNI (server name indication) in `ClientHello` of the underlying TLS and the domain name given by the overlaid HTTP HOST header (or URL in Request line) [^1]. Additionally, as a somewhat unstable feature, our `rpxy` can handle the brand-new HTTP/3 connection thanks to [`quinn`](https://github.com/quinn-rs/quinn) and [`hyperium/h3`](https://github.com/hyperium/h3).
|
|
|
|
This project is still *work-in-progress*. But it is already working in some production environments and serves numbers of domain names. Furthermore it *significantly outperforms* NGINX and Caddy, e.g., *1.5x faster than NGINX*, in the setting of very simple HTTP reverse-proxy scenario (See [`bench`](./bench/) directory).
|
|
|
|
[^1]: We should note that NGINX doesn't guarantee such a consistency by default. To this end, you have to add `if` statement in the configuration file in NGINX.
|
|
|
|
## Installing/Building an executable binary of `rpxy`
|
|
|
|
<!-- ### From `crates.io`
|
|
|
|
The simplest way is to install from [`crates.io`](https://crates.io/crates/rpxy) as follows.
|
|
|
|
```:bash
|
|
% cargo install rpxy
|
|
```
|
|
|
|
Then you have an executive binary `~/.cargo/bin/rpxy`.
|
|
|
|
Alternatively, y -->
|
|
You can build an executable binary yourself by checking out this Git repository.
|
|
|
|
```:bash
|
|
# Cloning the git repository
|
|
% git clone https://github.com/junkurihara/rust-rpxy
|
|
% cde rust-rpxy
|
|
|
|
# Update submodule hyperium/h3
|
|
% git submodule update --init
|
|
|
|
# Build
|
|
% cargo build --release
|
|
```
|
|
|
|
Then you have an executive binary `rust-rpxy/target/release/rpxy`.
|
|
|
|
## Usage
|
|
|
|
todo!
|
|
|
|
## Configuration
|
|
|
|
todo!
|
|
|
|
## Using `docker` image
|
|
|
|
You can also use [`docker` image](https://hub.docker.com/r/jqtype/rpxy) instead of directly executing the binary.
|
|
|
|
|
|
todo!
|