find-peers v2.0.3

find-peers

A module to find nodes on a network, establish secure communication channels, execute code and much much more.

Features

• Communication channels after node discovery

• Node monitoring via a local web server

• Complete control over node & remote access terminals
• Scale and execute code on connected peers (Javascript through Node.js VM or binary executables through Child Process)
• File transfers & file synchronisation
• Sync with a node list on a server
• Automatically refresh node status every N seconds
• Interact through emitted events, RXJS or promises
• Communication through TCP, HTTP, TLS, HTTPS or socket.io
• Definable master-slave sub networks / nodes
• 6 Authentication levels:
• No authentication (0)
• Hashed key exchange (1)
• Encrypted key (2)
• Generated key exchange (RSA, ec, x448) etc. (3)
• End to end encryption (4)
• Middle man server communication (5)

Installation

npm i find-peers --save

Installation notes

Socket.io

To use find-peers in Socket.io mode install it first.

npm i socket.io-client
npm i socket.io

node-forge

To automatically generate self signed SSL certificates at runtime node-forge must be installed.

npm i node-forge

Quick usage

Import it

const { FindPeers } = require('find-peers');

Basic config

const options = { autoGenId: true };

Create instance

const find = new FindPeers(options);

Listen for events

  find.on('found-nodes', (data) => {
      // new discovered nodes
  });
  find.on('server_up', () => {
      console.log('server is up!');
  });
  find.on('server_err', (err) => {
      console.log(err);
  });
  find.on('multicast_err', (err) => {
      console.log(err);
  });
  find.on('echo', (data) => {
      console.log(data.message, 'from', data.from.id);
  });

Config options

Functions