diff --git a/README.md b/README.md index 46ca5ac..79dc245 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ tlsproxy ================= -A most basic TLS man-in-the-middle forward proxy using [rustls](https://github.com/ctz/rustls) . +A most basic TLS man-in-the-middle forward proxy using [rustls](https://github.com/ctz/rustls) and [Tokio](tokio.rs). + +This proxy allows you, given you have the certificate chain of the server, to replace byte sequences of length N with another byte sequence of length N in outbound requests. +For example, you could replace `https://testserver.com/?name=foo` with `?name=bar` +This is a toy, proof of concept project. It is not thoroughly tested and will have issues with a very high probability. Sample usage: ``` @@ -23,7 +27,7 @@ curl https://testserver.com:5000 \ --verbose ``` -Please note this means you need to have a server running at testserver.com:5000, to do so, you can use the sample python server provided: +Please note this means you need to have a server running at `testserver.com:5000`, to do so, you can use the sample python server provided: ``` cd sample-server @@ -33,7 +37,7 @@ pip install flask python main.py ``` -You will then have a server running on 127.0.0.1:5000. You can then point testserver.com to this server by editing your `/etc/hosts`: +You will then have a server running on `127.0.0.1:5000`. You can then point `testserver.com` to this server by editing your `/etc/hosts`: ``` 127.0.0.1 testserver.com diff --git a/src/main.rs b/src/main.rs index 025b41a..3c2b7b5 100644 --- a/src/main.rs +++ b/src/main.rs @@ -9,7 +9,6 @@ mod proxy; async fn main() -> Result<(), Box> { let args = command::args(); - // We'll bind to 127.0.0.1:3000 let addr = SocketAddr::from(([127, 0, 0, 1], args.port)); println!("Listening on {:#?}", addr);