Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukks/hyperforward
Forward peer-to-peer end-to-end encrypted connections
https://github.com/lukks/hyperforward
e2e encrypted forward hyper noise p2p
Last synced: 8 days ago
JSON representation
Forward peer-to-peer end-to-end encrypted connections
- Host: GitHub
- URL: https://github.com/lukks/hyperforward
- Owner: LuKks
- License: mit
- Created: 2021-10-08T17:38:00.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-27T01:28:21.000Z (about 2 years ago)
- Last Synced: 2025-01-27T23:07:53.679Z (10 days ago)
- Topics: e2e, encrypted, forward, hyper, noise, p2p
- Language: JavaScript
- Homepage: https://npmjs.com/hyperforward
- Size: 420 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hyperforward
CLI and library to forward peer-to-peer end-to-end encrypted connections.
  
## Install
```
npm i -g hyperforward
```
## Usage
```shell
Usage: hyperforward [options] [command]
CLI to forward P2P E2E encrypted connections
Options:
-v, --version Output the current version
-h, --help display help for command
Commands:
remote [options] Create a P2P server that forwards to a remote hostname
local [options] Create a local server that forwards to a P2P server
keygen Create a seed key by name
add Add a known public key by name
rm Remove a key by name
print Print the public key by name
ls List my own keys and known peers
migrate [options] Migrate old keys to the new directory and format
help [command] display help for command
```
### Examples
#### Public connection
Already having a server (TCP, HTTP, SOCKS, VNC, etc) running in your computer o remotely:
```bash
hyperforward remote 127.0.0.1:3000
# Use this temporal public key to connect:
# 6e7c244099bf7c14314b0e...0fed9c5e22d52a0c0e927c
```
Other peers can connect to you using the public key:
```bash
hyperforward local 127.0.0.1:8080 --connect 6e7c244099bf7c14314b0e...0fed9c5e22d52a0c0e927c
# Ready to use, listening on: 127.0.0.1:8080
```
Now you can use the **local 127.0.0.1:8080** as it will be forwarded **to remote 127.0.0.1:3000**
#### Authorization
Create named key pair:
```bash
hyperforward keygen lukks
# Ask a friend to create their key pair:
hyperforward keygen cristian
```
#### Private connection
Same as the first example but with specific authorization.
1) **lukks** shares the remote server **127.0.0.1:3000** allowing only **cristian**
```bash
hyperforward remote 127.0.0.1:3000 --key lukks --firewall cristian
```
2) **cristian** creates a local server **127.0.0.1:8080** to receive from **lukks**
```bash
hyperforward local 127.0.0.1:8080 --key cristian --connect lukks
```
`--firewall` is a list of names or public keys comma separated.\
`--connect` can be a name or public key.
#### Sharing multiple services
There is a security limitation: you can only use **one key per forward**.\
You still reuse a single key (ie. lukks, cristian, etc) to easily set firewalls.
Let's say you have multiple things going on:
- **HTTP server** on: **127.0.0.1:3000**
- **VNC/NoMachine** on: **127.0.0.1:4001**
- **SOCKS5 proxy** on: **127.0.0.1:1090**
1) **Each service should have their own key pair:**
```bash
hyperforward keygen http1
hyperforward keygen vnc1
hyperforward keygen proxy1
```
2) **Remote forward each one:**
_In this case, only certain people should be able to use the private VNC service._
```bash
hyperforward remote 127.0.0.1:3000 --key http1
hyperforward remote 127.0.0.1:4001 --key vnc1 --firewall cristian,lukks
hyperforward remote 127.0.0.1:1090 --key proxy1
```
3) **Other peers can connect to your services:**
Let's say "lukks" would like to use the VNC (as he's authorized):
```bash
hyperforward local 127.0.0.1:4001 --key lukks --connect vnc1
```
Later, anyone would like to use your proxy:
```bash
hyperforward local 127.0.0.1:1090 --connect proxy1
```
## License
MIT