sclient/README.md

85 lines
1.5 KiB
Markdown
Raw Normal View History

2018-08-06 22:55:45 +00:00
sclient.go
==========
Secure Client for exposing TLS (aka SSL) secured services as plain-text connections locally.
Also ideal for multiplexing a single port with multiple protocols using SNI.
Unwrap a TLS connection:
```bash
$ sclient whatever.com:443 localhost:3000
> [listening] telebit.cloud:443 <= localhost:3000
```
Connect via Telnet
```bash
$ telnet localhost 3000
```
Connect via netcat (nc)
```bash
$ nc localhost 3000
```
A poor man's (or Windows user's) makeshift replacement for `openssl s_client`, `stunnel`, or `socat`.
Install
=======
### macOS, Linux, Windows
For the moment you'll have to install go and compile `sclient` yourself:
* <https://golang.org/doc/install#install>
```bash
2018-08-06 22:58:41 +00:00
git clone https://git.coolaj86.com/coolaj86/sclient.go.git
pushd sclient.go
2018-08-06 22:55:45 +00:00
go build sclient*.go
rsync -av sclient-cli /usr/local/bin/sclient
```
```bash
go run sclient*.go example.com:443 localhost:3000
```
Usage
=====
```bash
2018-08-06 23:05:39 +00:00
sclient [flags] <remote> <local>
2018-08-06 22:55:45 +00:00
```
2018-08-06 23:05:39 +00:00
* flags
* -k, --insecure ignore invalid TLS (SSL/HTTPS) certificates
2018-08-06 22:55:45 +00:00
* remote
* must have servername (i.e. example.com)
* port is optional (default is 443)
* local
* address is optional (default is localhost)
* must have port (i.e. 3000)
Examples
========
Bridge between `telebit.cloud` and local port `3000`.
```bash
sclient telebit.cloud 3000
```
Same as above, but more explicit
```bash
sclient telebit.cloud:443 localhost:3000
```
Ignore a bad TLS/SSL/HTTPS certificate and connect anyway.
```bash
2018-08-06 23:05:39 +00:00
sclient -k badtls.telebit.cloud:443 localhost:3000
2018-08-06 22:55:45 +00:00
```