https://github.com/Kixunil/ws-unix-framed-bridge

A simple proxy that forwards Websocket messages to Unix sockets and vice versa.
https://github.com/Kixunil/ws-unix-framed-bridge

Last synced: about 1 month ago
JSON representation

A simple proxy that forwards Websocket messages to Unix sockets and vice versa.

• Host: GitHub
• URL: https://github.com/Kixunil/ws-unix-framed-bridge
• Owner: Kixunil
• Created: 2018-12-20T09:39:09.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-20T09:39:59.000Z (about 6 years ago)
• Last Synced: 2024-11-20T00:33:54.609Z (about 2 months ago)
• Language: Rust
• Size: 10.7 KB
• Stars: 36
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Websocket - Unix framed bridge

==============================

A simple proxy that forwards Websocket messages to Unix sockets and vice versa.

About

-----

This is a very simple proxy between Websockets and Unix domain sockets. It acts

as a Websocket server while forwarding all messages to a specified Unix socket.

The messages forwarded to Unix socket are length-delimited, where length of

each message is encoded as 32-bit native-endian binary number. The length is

prepended to each message forwarded to Unix socket.

Conversely, each message coming from Unix socket is decoded as 32-bit

native-endian length followed by the payload. It is attempted to interpret the

message as utf-8 string and send it over websocket as text message. However, if

the conversion fails, the message is sent as binary.

Usage

-----

This program is written in Rust. Compile it using `cargo build --release`.

You'll find the binary in `target/release/` there's also a man page generated

in `target/`

In order to run use:

`ws-unix-framed-bridge --socket-path=SOCKET\_PATH --bind-addr=BIND\_ADDR`

Alternatively you may provide the arguments in toml file named

`ws-unix-bridge.conf` located in CWD.

License

-------

MITNFA