bitsig

    1.0.3 • Public • Published

    Serverless Signaling

    Introduction

    This repository contains a JS programm to conduct WebRTC signaling without a signaling server. The programm uses the distributed hash table (DHT) Kademlia to establish an overlay network. The connections within this network are realized by using WebRTC's DataChannel. Signaling is conducted by routing Kademlia queries thourgh the DHT.

    The underlying DHT is realized by using webtorrent-dht.

    Documentation

    A documentation of the API, which is created with JSDoc, can be found here.

    Installation

    npm install bitsig

    Usage

    To use the programm install it on your machine. Once installed, you can include it in the JS file that needs to access the signaling service:

    const BITSIG = require("bitsig");
    const CLIENT_OPTIONS = {...}
     
    let bitSig = new BITSIG(CLIENT_OPTIONS);

    CLIENT_OPTIONS configures the underlying DHT.

    The basic options are inherited by bittorrent-dht. Additionally there are four more options added by webtorrent-dht.
    BitSig adds one more options:

    • keyPair: A asymmetric CryptoKey keypair. Looks like this:
      { privateKey: CryptoKey, publicKey: CryptoKey }.
      Both keys need to be extractable and allowed to encrypt and decrypt (See linked docs.).
      A minimal running example can be found in the demoPage folder.

    Demo

    To run the demo one first has to start the bootstrapping server. This is done by running: node server.js
    To enable debugging messages run: DEBUG=webtorrent-dht node server.js
    Once the bs server runs the demoPage.html file from the demoPage folder has to be served by a local webserver. Upon access the DHT object is initiated and bootstrapped.
    By accessing the same site in a second tab and two node network can be simulated.

    Build

    To ship the client side code browserify is used. Calling browserify demo.js -o demoBrowser.js needs to be run if demo.js is changed.
    The same applies to index.js. browser.js is a prebuilt file ready to include in any html file.

    Contribution

    Any feedback or contribution is highly appreciated.

    Licence

    BitSig. A programm to conduct WebRTC signaling through a Kademlia based DHT. Copyright (C) 2018 Otto Bittner

    This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

    Keywords

    none

    Install

    npm i bitsig

    DownloadsWeekly Downloads

    1

    Version

    1.0.3

    License

    ISC

    Unpacked Size

    3.19 MB

    Total Files

    58

    Last publish

    Collaborators

    • derpsteb