Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/telkomindonesia/aetherport
https://github.com/telkomindonesia/aetherport
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/telkomindonesia/aetherport
- Owner: TelkomIndonesia
- License: gpl-3.0
- Created: 2023-03-13T01:56:13.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-14T09:00:45.000Z (almost 2 years ago)
- Last Synced: 2024-06-21T06:30:11.073Z (6 months ago)
- Language: Go
- Size: 57.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Aetherport
Layer 4 proxy utilizing WebRTC which enables port-forwarding without using dedicated IP and port.
## Use Cases
- access self-hosted services deployed on your home from any network connected to Internet.
- quick sharing of services being developed in your laptop to peer developers on another network.
- securely expose control plane service to data plane services on another data center or DMZ.
- ...
## Install
The binary are distributed as a single executable which are available from the [release page](./releases) and as Docker image which can be downloaded from the [package page](./pkgs/container/aetherport).
```bash
./aetherport --help
```
```bash
docker run --rm ghcr.io/telkomindonesia/aetherport --help
```
## Run
### Quick start without signaling server
1. On the sender side which will run an egress proxy, run:
```bash
aetherport --forward 0.0.0.0:80:0.0.0.0:8080`
```
This will forward connection to `0.0.0.0:80` on the sender side to `0.0.0.0:8080` on the receiver site.
1. `aetherport` will display an 'offer' text that should be copied to the receiver.
1. On the receiver side which will run an ingress proxy,
```bash
aetherport --allow 0.0.0.0:8080
```
This will allow connection to be forwarded to `0.0.0.0:8080.
1. Copy paste the 'offer' text displayed in step 2 to the prompt on receiver side and press ``.
1. `aetherport` will display an 'answer' text that should be copied to the sender.
1. Copy paste 'anwer' text displayed in step 5 to the prompt on sender side and press ``.
At the end, a connection will be established that will forward any traffic received on `0.0.0.0:80` on the sender side to `0.0.0.0:8080` on the receiver side.
## Run with signalling server
1. Run the aetherlight signaling server on machine reachable by all participating node. The server will be listening on `http://0.0.0.0:8080` by default.
```bash
./aetherport signal
```
1. Generate certificate for each node.
```bash
./aetherport cert generate --name node1
./aetherport cert generate --name node2
...
```
1. Distribute the node private key, certificate, and ca-certificate file to each node.
1. On the node that will run an ingress proxy (for example to expose a service in 0.0.0.0:80), run the following:
```bash
./aetherport \
--key '' \
--cert '' \
--cacert '' \
--allow '0.0.0.0:80' \
--signal-type 'aetherlight' \
--aetherlight-base-url ''
```
Note the url that will be echoed in the terminal. The url will be used on any node that will connect to this node.
1. On the node that will run the egress proxy and try to connect to node above, run:
```bash
./aetherport \
--key '' \
--cert '' \
--cacert '' \
--forward '0.0.0.0:80800.0.0.0:80' \
--signal-type 'aetherlight' \
--aetherlight-ingress-url '/ingresses/'
```
Note that a node can run the aetherport command to act both as ingress or egress proxy at the same time.
## Roadmap
- [ ] UDP forwarding.
- [ ] TCP to stdio forwarding.
- [ ] Socks5 proxy on the sender side.
- [ ] Equal or better performance with ssh port forwarding.
- [ ] Fine-grained access control on the receiver side.
- [ ] Application protocol filter (e.g. HTTP).