https://github.com/holepunchto/hyperbeam
A 1-1 end-to-end encrypted internet pipe powered by Hyperswarm
https://github.com/holepunchto/hyperbeam
Last synced: 4 months ago
JSON representation
A 1-1 end-to-end encrypted internet pipe powered by Hyperswarm
- Host: GitHub
- URL: https://github.com/holepunchto/hyperbeam
- Owner: holepunchto
- License: mit
- Created: 2020-12-12T21:31:10.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T12:53:12.000Z (11 months ago)
- Last Synced: 2024-04-09T16:21:21.304Z (11 months ago)
- Language: JavaScript
- Size: 20.5 KB
- Stars: 501
- Watchers: 18
- Forks: 35
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-pears - hyperbeam - A 1-1 end-to-end encrypted file transfer tool (**Awesome Pears 🍐** / App that also use Hypercore (but not pear))
README
# hyperbeam
A 1-1 end-to-end encrypted internet pipe powered by [Hyperswarm](https://github.com/holepunchto/hyperswarm) and Noise
```
npm install hyperbeam
```
## Usage
``` js
const Hyperbeam = require('hyperbeam')
// 'neznr3z3j44l7q7sgynbzpdrdlpausurbpcmqvwupmuoidolbopa' is 32-byte unique passphrase
// to find the other side of your pipe.
// once the other peer is discovered it is used to derive a noise keypair as well.
const beam = new Hyperbeam('neznr3z3j44l7q7sgynbzpdrdlpausurbpcmqvwupmuoidolbopa')
// to generate a passphrase, leave the constructor empty and hyperbeam will generate one for you
// const beam = new Hyperbeam()
// beam.key // <-- your passphrase
// make a little chat app
process.stdin.pipe(beam).pipe(process.stdout)
```
## CLI
Part of the [Hyperspace CLI, hyp](https://github.com/hypercore-protocol/cli)
Provided here as a standalone CLI as well.
First install it
```sh
npm install -g hyperbeam
```
Then on one machine run
```sh
echo 'hello world' | hyperbeam
```
This will generate a phrase, eg "neznr3z3j44l7q7sgynbzpdrdlpausurbpcmqvwupmuoidolbopa". Then on another machine run
```sh
# will print "hello world"
hyperbeam neznr3z3j44l7q7sgynbzpdrdlpausurbpcmqvwupmuoidolbopa
```
That's it! Happy piping.
## API
#### `const stream = new Hyperbeam([key][, options])`
Make a new Hyperbeam duplex stream.
Will auto connect to another peer using the same key with an end to end encrypted tunnel.
When the other peer writes it's emitted as `data` on this stream.
Likewise when you write to this stream it's emitted as `data` on the other peers stream.
If you do not pass a `key` into the constructor (the passphrase), one will be generated and put on `stream.key`.
`options` include:
- `dht`: A DHT instance. Defaults to a new instance.
#### `stream.key`
The passphrase used by the stream for connection.
## License
MIT