Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mdubourg001/chaussette
A nodejs proxy to communicate with TCP servers from a browser's WebSocket.
https://github.com/mdubourg001/chaussette
nodejs proxy tcp websocket
Last synced: 26 days ago
JSON representation
A nodejs proxy to communicate with TCP servers from a browser's WebSocket.
- Host: GitHub
- URL: https://github.com/mdubourg001/chaussette
- Owner: mdubourg001
- License: mit
- Created: 2019-12-30T17:50:34.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T03:55:54.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T18:09:13.124Z (26 days ago)
- Topics: nodejs, proxy, tcp, websocket
- Language: JavaScript
- Homepage:
- Size: 1.87 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Chaussette 🧦
Chaussette is a NodeJS proxy. It allows you to communicate with a TCP server
(or any protocol built on it) from a browser's WebSocket.
When started on port **9898**, for example, Chaussette will spawn a WebSocket
server and, for every WebSocket client connecting to it, will create an associated
Socket connected to specified host and port, and forward every data to it.
---
### Usage
Chaussette is usable either from command-line interface, or as a node module:
Either way, you can install from yarn / npm:
```shell script
npm install chaussette
```
If you wish to use it from CLI, you can install it globally:
```shell script
npm install chaussette -g
```
#### CLI usage
```shell script
chaussette -l 9898 -t example.com -p 9999 -v 2
```
Using the previous command line, WebSockets will be able to connect to
localhost on port **9898**. Everything data sent by client over such WebSocket
will be then forwarded to **example.com**, on port **9999**.
Options used here are the following:
- **-l (--listenport)** port to listen on
- **-t (--target)** target to forward data to
- **-p (--targetport)** port to forward data to
- **-v (--verbosity)** verbosity level:
- 0: error logs only
- 1: previous + default and warning logs
- 2: previous + debug logs
#### Node module usage
```javascript
const Chaussette = require('chaussette');
const proxy = new Chaussette({
listenPort: 9898,
targetAddr: 'example.com',
targetPort: 9999,
verbosity: 1, // optional, default is 0
logging: {
// optional, logging options
format: 'HH-mm-ss', // logs timestamp formatting, default is 'DD-MM-YY HH:mm:ss'
},
});
// configures the server and starts listening on port 9898
proxy.start();
// preventing forwarding WS client's messages that start with "DO NOT FORWARD:"
proxy.onwsmessage = (message, pairId) => {
if (message.startsWith('DO NOT FORWARD:'))
proxy.preventNextWSMessageForward(pairId);
};
// preventing forwarding TCP server's messages that do not start with "FORWARD IT:"
proxy.ontcpmessage = (message, pairId) => {
if (!message.startsWith('FORWARD IT:'))
proxy.preventNextTCPMessageForward(pairId);
};
```
---
### Left to do
#### Features
- [x] Usage from CLI
- [x] Usage from NodeJS
- [x] External messages hooks (ex. 'onmessage' from Chaussette object)
- [ ] Allow WS to provide the host and port to connect to (with default callback)
#### Logs
- [x] Verbosity levels
- [x] Colored logs
- [x] Allow logs options
- [x] Allow date formatting in logs (dayjs / momentjs ?)
- [ ] Log connected client's informations + on message
#### Others
- [ ] Send proper closing informations to both ends