search

holepunchto / hyperswarm-dht-relay

Relaying the Hyperswarm DHT over other transport protocols to bring decentralized networking to everyone
ISC License
44 stars 10 forks source link

readme

Hyperswarm Relay

:test_tube: This project is still experimental. Do not use it in production.

Relaying the Hyperswarm DHT over framed streams to bring decentralized networking to everyone.

Installation

npm install @hyperswarm/dht-relay

Usage

On the relaying side:

import DHT from 'hyperdht'
import { relay } from '@hyperswarm/dht-relay'

relay(new DHT(), stream)

On the relayed side:

import DHT from '@hyperswarm/dht-relay'

const dht = new DHT(stream)

From here, the API matches that of the Hyperswarm DHT: https://github.com/holepunchto/hyperdht#api

Transports

As a convenience, we provide stream wrappers for common transport protocols. These may or may not be appropriate for your particular use case and so your mileage may vary.

TCP The TCP wrapper is a re-export of which adds both framing and encryption. On the relaying side: ```js import net from 'net' import DHT from 'hyperdht' import { relay } from '@hyperswarm/dht-relay' import Stream from '@hyperswarm/dht-relay/tcp' const dht = new DHT() const server = net.createServer().listen(8080) server.on('connection', (socket) => { relay(dht, new Stream(false, socket)) }) ``` On the relayed side: ```js import net from 'net' import DHT from '@hyperswarm/dht-relay' import Stream from '@hyperswarm/dht-relay/tcp' const socket = net.connect(8080) const dht = new DHT(new Stream(true, socket)) ```
WebSocket The WebSocket wrapper is a simple `Duplex` stream that only adapts the interface of the WebSocket as the WebSocket API already provides its own framing and encryption. On the relaying side: ```js import { WebSocketServer } from 'ws' import DHT from 'hyperdht' import { relay } from '@hyperswarm/dht-relay' import Stream from '@hyperswarm/dht-relay/ws' const dht = new DHT() const server = new WebSocketServer({ port: 8080 }) server.on('connection', (socket) => { relay(dht, new Stream(false, socket)) }) ``` On the relayed side: ```js import DHT from '@hyperswarm/dht-relay' import Stream from '@hyperswarm/dht-relay/ws' const socket = new WebSocket('ws://localhost:8080') const dht = new DHT(new Stream(true, socket)) ```

CLI

You can start a DHT relay in the command line:

npm install -g @hyperswarm/dht-relay

Run a DHT relay server:

dht-relay # [--port 49443] [--host 0.0.0.0] [--cert <path fullchain.pem>] [--key <path privkey.pem>]

If running behind a proxy like NGINX then add --behind-proxy so logging info is correct.

Protocol

A reference implementation of the relay protocol can be found in the lib/protocol.js module. The protocol is versioned and built on top of https://github.com/mafintosh/protomux.

Messages

All types are specified as their corresponding compact-encoding codec.

handshake (0)

  1. uint8 Flags
    • custodial: 1
  2. fixed(32) The public key of the peer
  3. (if custodial is set) fixed(64) The secret key

ping (1)

Empty

pong (2)

Empty

connect (3)

  1. uint8 Flags
    • custodial: 1
  2. uint32 The alias of the stream
  3. fixed(32) The public key of the peer
  4. (if custodial is set) fixed(64) The secret key
  5. fixed(32) The public key of the remote peer

connection (4)

  1. uint8 Flags
    • custodial: 1
  2. uint32 The alias of the stream
  3. uint32 The alias of the server
  4. fixed(32) The public key of the remote peer
  5. (if custodial is set) fixed(64) The Noise handshake hash
  6. (if custodial is not set) uint32 The ID of the Noise handshake session

connected (5)

  1. uint32 The alias of the stream
  2. uint32 The remote alias of the stream

incoming (6)

  1. uint32 The ID of the request
  2. uint32 The alias of the server
  3. fixed(32) The public key of the remote peer
  4. buffer The Noise handshake payload

deny (7)

  1. uint32 The ID of the request

accept (8)

  1. uint32 The ID of the request

destroy (9)

  1. uint8 Flags
    • paired: 1
    • error: 2
  2. (if paired is set) uint32 The alias of the stream
  3. (if paired is not set) uint32 The remote alias of the stream
  4. (if error is set) string The reason the stream was destroyed

listen (10)

  1. uint8 Flags
    • custodial: 1
  2. uint32 The alias of the server
  3. fixed(32) The public key of the server
  4. (if custodial is set) fixed(64) The secret key

listening (11)

  1. uint32 The alias of the server
  2. uint32 The remote alias of the server
  3. ipv4Address The address of the server

close (12)

  1. uint32 The alias of the server

closed (13)

  1. uint32 The alias of the server

open (14)

  1. uint8 Flags
    • custodial: 1
  2. uint32 The alias of the stream
  3. uint32 The alias of the server
  4. (if custodial is set) fixed(64) The Noise handshake hash
  5. (if custodial is not set) uint32 The ID of the Noise handshake session

end (15)

  1. uint32 The alias of the stream

data (16)

  1. uint32 The alias of the stream
  2. array(buffer) The data sent

result (17)

  1. uint32 The query ID
  2. buffer The query specific data

finished (18)

  1. uint32 The query ID

lookup (19)

  1. uint32 The query ID
  2. fixed(32) The topic to look up

announce (20)

  1. uint8 Flags
    • custodial: 1
  2. uint32 The query ID
  3. fixed(32) The topic to announce
  4. fixed(32) The public key to announce on
  5. (if custodial is set) fixed(64) The secret key

unannounce (21)

  1. uint8 Flags
    • custodial: 1
  2. uint32 The query ID
  3. fixed(32) The topic to unannounce
  4. fixed(32) The public key that was announced on
  5. (if custodial is set) fixed(64) The secret key

signAnnounce (22)

  1. uint32 The ID of the request
  2. uint32 The alias of the signee
  3. fixed(32) The roundtrip token of the peer
  4. buffer The ID of the peer
  5. array(ipv4Address) The addresses that may relay messages

signUnannounce (23)

  1. uint32 The ID of the request
  2. uint32 The alias of the signee
  3. fixed(32) The roundtrip token of the peer
  4. buffer The ID of the peer
  5. array(ipv4Address) The addresses that may relay messages

signature (24)

  1. uint32 The ID of the request
  2. buffer The signature

noiseSend (25)

  1. uint8 Flags
    • isInitiator: 1
  2. uint32 The ID of the handshake session
  3. (if isInitiator is set) The alias of the remote stream
  4. buffer The Noise handshake payload

noiseReceive (26)

  1. uint8 Flags
    • isInitiator: 1
  2. uint32 The ID of the handshake session
  3. (if isInitiator is not set) The alias of the server
  4. buffer The Noise handshake payload

noiseReply (27)

  1. uint8 Flags
    • isInitiator: 1
    • complete: 2
  2. uint32 The ID of the handshake session
  3. buffer The Noise handshake payload
  4. (if isInitiator and complete are not set) fixed(32) The public key of the remote peer
  5. (if complete is set) fixed(32) The ID of the remote stream
  6. (if complete is set) fixed(32) The holepunch secret

License

ISC