diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..2007351 --- /dev/null +++ b/README.MD @@ -0,0 +1,22 @@ +# TCP over HTTP +This project aims to provide an easy-to-setup TCP forwarding solution: + +``` +|--------| |--------| |--------| | -------| +| | | Client | | Server | | | +| Client | -- TCP xx -- | | -- HTTP 80 / 443 -- | | -- TCP xx -- | Server | +| | | Relay | | Relay | | | +|--------|   |--------| |--------| |--------| +``` + +This project can be used especially to bypass firewalls that blocks traffics +from ports others than the 80 / 443 duo. + +This repository contains two binaries: + +* `tpc_relay_server`: The server relay +* `tcp_relay_client`: The client relay + +The clients relay authenticates itself to the server using a token. + +A single server - client relay pair can relay multiple ports simultaneously from the same machine.