domain-socket-proxy

README

Goal

To allow you to connect to tcp socket and have that redirected to another tcp socket by way of a unix domain socket.

 +-----+         +-------------------+         +-----+
 | tcp | <---->  | unix domainsocket | <---->  | tcp |
 +-----+         +-------------------+         +-----+

Components

The proxy has two components

1. serve
   1. listen to a tcp port and proxying the connection to a unix domain socket
2. forward
   1. listen to a unix domain socket and forwarding to the desired tcp socket

Usage

Lets say you have an existing app on port 80 and you want to expose it on port 9999

launch the forwarder

.\domain-socket-proxy.exe forward --address :80 --path .\unix.socket

launch the server

.\domain-socket-proxy.exe serve --address localhost:9999 --path .\unix.socket

The above example uses the file path .\unix.socket for the unix domain socket

Container

You can use a container for the forwarder as well

docker run -v c:\tmp:c:\tmp --rm --name socket knicknic/domain-socket-proxy:v1.0.0 --path c:\tmp\unix.socket --address :9999

Documentation

Overview

Copyright © 2020 Nick Maliwacki <knic.knic@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.