sclient.js/README.md

76 lines
1.2 KiB
Markdown

sclient.js
==========
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 telnet localhost 3000
```
Install
=======
### macOS, Linux, Windows
First download and install the *current* version of [node.js](https://nodejs.org)
```bash
npm install -g sclient
```
```bash
npx sclient example.com:443 localhost:3000
```
Usage
=====
```bash
sclient <remote> <local> [-k | --insecure]
```
* 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
sclient badtls.telebit.cloud:443 localhost:3000 -k
```