Hyperbeam Save

A 1-1 end-to-end encrypted internet pipe powered by Hyperswarm

Project README

hyperbeam

A 1-1 end-to-end encrypted internet pipe powered by Hyperswarm and Noise

npm install hyperbeam

Usage

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

Provided here as a standalone CLI as well.

First install it

npm install -g hyperbeam

Then on one machine run

echo 'hello world' | hyperbeam

This will generate a phrase, eg "neznr3z3j44l7q7sgynbzpdrdlpausurbpcmqvwupmuoidolbopa". Then on another machine run

# 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

Open Source Agenda is not affiliated with "Hyperbeam" Project. README Source: mafintosh/hyperbeam
Stars
455
Open Issues
5
Last Commit
4 weeks ago
Repository
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating