commit bdc9dddbf211d32929c864de2f35c8fe3cd2e1d6 parent 673f70b1969b03aed806795f2ee7a1cdfb582702 Author: Nihal Jere <nihal@nihaljere.xyz> Date: Sun, 2 Aug 2020 15:02:17 -0500 README: update Diffstat:
M | README | | | 16 | ++++++---------- |
1 file changed, 6 insertions(+), 10 deletions(-)
diff --git a/README b/README @@ -9,21 +9,17 @@ tlsrp is a simple TLS reverse-proxy built on top of LibreSSL's libtls. A typical use case for tlsrp might be to turn a regular HTTP server into an HTTPS server. However, it is protocol agnostic, so it can be used for putting -any TCP/IP protocol on top of a TLS layer. The server thinks its serving the -plain protocol and the client thinks its receiving the secured protocol. +any TCP/IP protocol on top of a TLS layer. The server gets to serve the plain +protocol and the client receives the secured protocol. + +Through its arguments, tlsrp can be configured to listen and serve over both +unix sockets and network sockets. The TLS parameters themselves can be +configured by modifying config.h. See the manpage for more details. Dependencies ------------ libtls from LibreSSL -Usage ------ -tlsrp [-h backhost] [-H fronthost] -p backport -P frontport -ca ca_path - -cert cert_path -key key_path - -tlsrp -U unixsocket [-H fronthost] -P frontport -ca ca_path - -cert cert_path -key key_path - TODO ---- [ ] testing