Miss any of our Open RFC calls?Watch the recordings here! »

spreadable

0.1.20 • Public • Published

Spreadable [alpha] npm version

Spreadable is a decentralized network mechanism. You can use it to combine servers in a public or private network for any purpose. The library consists of two parts:

// Server
const Node = require('spreadable').Node;
 
(async () => {  
  try {
    const node = new Node({
      port: 4000,
      hostname: 'localhost',
      initialNetworkAddress: 'localhost:4000'    
    });
    await node.init();
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();
// Client
const Client = require('spreadable').Client;
 
(async () => {  
  try {
    const client = new Client({
      address: 'localhost:4000'
    });
    await client.init();
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();

In the example above we run the node and connected to it via the client to do something in the future. Let's add another node to our local network.

// Another server
const Node = require('spreadable').Node;
 
(async () => {  
  try {
    const node = new Node({
      port: 4001,
      hostname: 'localhost',
      initialNetworkAddress: 'localhost:4000'
    });
    await node.init();
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();

In order to join to an already existing network you need to pass initialNetworkAddress option containing the address of any of the network active node. If you are launching the very first server then simply indicate in the option a link to yourself as was done at the very beginning or just skip this option. Now you can add to the network the number of nodes you need. The client can use the address of any active network node to connect to the network itself.

const Client = require('spreadable').Client;
 
(async () => {  
  try {
    const client = new Client({
      address: 'localhost:4000'
    });
    await client.init();
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();

How to use the client in a browser

1. Use the prepared file as an html script

You can download spreadable/dist/spreadable.client.js and import it as a script.

<script type="text/javascript" src="spreadable.client.js"></script>
<script type="text/javascript">
  (async () => {  
    try {
      const client = new ClientSpreadable({
        address: 'localhost:4000'
      });
      await client.init();
    }
    catch(err) {
      console.error(err.stack);
    }
  })();
</script> 

2. Import the prepared file

You can import / require spreadable/dist/spreadable.client.js if you use a building system.

import Client from 'spreadable/dist/spreadable.client.js';
 
(async () => {
  try {
    const client = new Client({
      address: 'localhost:4001'
    });
    await client.init();
  }
  catch(err) {
    console.error(err.stack);
  }
})();

3. Build it by yourself

You can use webpack or something else to build the client for the browser with entry point spreadable/src/browser/client/index.js. Then you import / require it in your application and use as usually.

How to use it via the command line

You need to install the library globally:

npm install -g spreadable --unsafe-perm=true --allow-root

Now you perform various actions running it from your project root folder:

spreadable -a status -c ./config.js

You can skip the config argument passing if you have file with the name spreadable.config.js in the root. To see all actions and commands just look at spreadable/bin folder.

How the network works

For the network working all nodes must be able to interact with each other. Requests are made via the http(s) protocol. The network is p2p, but the nodes are conditionally divided into masters and slaves. From the point of view of rights, there is no difference between them. Masters only additionally maintain some lists for grouping servers and register new members. The network is designed in such a way that at any time a new member can join it or the old one will leave. After a while, another server will take over this role.

How nodes distinguish each other

The node ID is called address and written as hostname:port. Hostname might be a domain name or an ip address. For ipv6 it is [ip]:port. By default, the server tries to get its external ip. If the computer is not connected to the Internet then it will use the local ip address. Or you can always pass the hostname as an option manually. If the node address changes then it is simply re-registering on the network.

What are the limitations

To implement various features it is often required to go through the entire network to find the necessary information. The protocol allows to do this in a sequence of 3 http requests. The first query from the starting point goes from the client to the entry node, the next goes to all masters simultaneously each of which goes through nodes from its list in parallel as well. The number of simultaneous requests always strive to the square root of the network size. Therefore, with a larger network size each node must be configured to be able to work with a large number of tcp connections simultaneously. For example, take a network of 10,000 nodes. For maximum network performance each node must be able to make 100 simultaneous requests and handle 1 per client. Apart from various system requests that occur from time to time to normalize the network.

What are the requirements

You must have node-gyp to install dependencies.

If you run the node in a cointainer (virtual machine), then be sure that client ip addresses are forwarding to the node server. Some virtualization tools don't do it, by default. You have to set it up if possible or just use a proxy server in front of this with filling x-forwarded-for header. Let's say we use 2079 port for public access and 2078 to link it with the virtual machine. All the process would be like that:

client -> proxy:2079 -> local machine:2078 -> virtual machine:2079

If you don't pass the real client ip address to the virtual machine, the node will ban all external servers due to vulnerabilities control system working.

Currently, the proxy server must have the same ip address as the node has. If your node ip address is different from the proxy server address, then other nodes will ban you.

How to control the time of requests

When making requests the client can always specify a timeout.

const Client = require('storacle').Client;
const hash = 'someFileHash';
 
(async () => {
  try {
    const client = new Client({
      address: 'localhost:4000',
      request: {
        clientTimeout: '10s'
      }
    });
    await client.init();
    const link = await client.getFileLink(hash, { timeout: 2000 });
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();

First, we set the default timeout, then for a specific request passed a unique one.

How exactly the library can be used

You can extend the library code and add various interesting features. A detailed description will be later. For example, the storacle organizes file storage using the protocol.

How to use https

1. Run https server on the node using trusted ssl certificates

Suppose you have a trusted certificate for example.com.

const Node = require('spreadable').Node;
const fs = require('fs');
const key = fs.readFileSync('key.pem');
const cert = fs.readFileSync('cert.pem');
 
(async () => {  
  try {
    for(let i = 0; i < 10; i++) {
      const node = new Node({
        port: 4000 + i,
        initialNetworkAddress: 'example.com:4000',
        hostname: 'example.com',
        server: {
          key,
          cert
        }
      });
      await node.init();
    }    
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();
const Client = require('spreadable').Client;
 
(async () => {
  try {
    const client = new Client({
      address: 'example.com:4000',
      https: true
    });
    await client.init();
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();

2. Run https server on the node using self-signed certificates

You can also create a self-signed certificate, and use an authentication certificate to make requests. To simplify the example, suppose that one certificate simultaneously contains the addresses of all network nodes.

const Node = require('spreadable').Node;
const fs = require('fs');
const key = fs.readFileSync('key.pem');
const cert = fs.readFileSync('cert.pem');
const ca = fs.readFileSync('ca.pem');
 
(async () => {
  try {
    for(let i = 0; i < 10; i++) {
      const node = new Node({
        port: 4000 + i,
        hostname: 'localhost',
        initialNetworkAddress: 'localhost:4000',
        server: {
          https: {
            key, 
            cert,
            ca
          }
        }
      });
      await node.init();
    }    
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();
const Client = require('spreadable').Client;
const fs = require('fs');
const ca = fs.readFileSync('ca.pem');
 
(async () => {  
  try {
    const client = new Client({
      address: 'localhost:4001',
      https: {
        ca
      }
    });
    await client.init();
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();

Don't forget to pass the authentication certificate in this case.

3. Use ningx / apache / e.t.c over the node server

Suppose you have a certificate for all example.com subdomains.

const Node = require('spreadable').Node;
 
(async () => {  
  try {
    for(let i = 0; i < 10; i++) {
      const node = new Node({
        port: 4000 + i,
        publicPort: 443,
        initialNetworkAddress: 'sub1.example.com:443',
        hostname: `sub${+ 1}.example.com`,
        server: {
          https: true
        }
      });
      await node.init();
    }    
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();
const Client = require('spreadable').Client;
 
(async () => {  
  try {
    const client = new Client({
      address: 'sub1.example.com:443',
      https: true
    });
    await client.init();
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();

You need to make all the necessary settings and redirects on the receiving server.

How to create a private network

1. Use the basic authentication

const Node = require('spreadable').Node;
const auth = { username: 'user', password: 'pass' };
 
(async () => {  
  try {
    const node = new Node({
      port: 4000,
      hostname: 'localhost',
      initialNetworkAddress: 'localhost:4000',
      network: {
        auth
      }
    });
    await node.init();
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();
const Client = require('spreadable').Client;
const auth = { username: 'user', password: 'pass' };
 
(async () => {  
  try {
    const client = new Client({
      address: 'localhost:4000',
      auth
    });
    await client.init();
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();

2. Use your own network access filter

const Node = require('spreadable').Node;
const db = require('some-db');
const errors = require('spreadable/src/errors');
 
class MyNode extends Node {
  networkAccess(req) {
    super.networkAccess(req);
 
    // we can do any check we want here
    if(!await db.AllowedIpAddresses.count(req.clientIp)) {
      throw new errors.AccessError('You ip address is denied');
    }
  }
}
 
(async () => {  
  try {
    const node = new MyNode({
      port: 4000,
      hostname: 'localhost',
      initialNetworkAddress: 'localhost:4000'
    });
    await node.init();
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();
const Client = require('spreadable').Client;
 
(async () => {  
  try {
    const client = new Client({
      address: 'localhost:4000'
    });
    await client.init();
  }
  catch(err) {
    console.error(err.stack);
    process.exit(1);
  }
})();

In both cases the network is closed, but not completely secure. If we use http protocol the data transferred is not encrypted. In some cases this is a suitable option, otherwise you need to use https.

Versioning

In order for the nodes to interact with each other, they must have the same version. By default, the version consists of the node codename and the first two digits of the library version from package.json. It looks like spreadable-1.12, for example. Therefore, if minor and major changes have occurred in the library, then the nodes need to be updated.

Node configuration

When you create an instance of the node you can pass options below:

  • {integer} port - port on which the server will be run.

  • {string|string[]} [initialNetworkAddress] - input node address to connect to the network. You can pass a list of addresses. By default, it is the node own address.

  • {string} [hostname] - node hostname. By default, the system tries to find the external ip address. If it can't, then it chooses the internal one. Therefore, if you want to test something locally it is better to pass "localhost" manually.

  • {object} [storage] - section that responds to storage settings. Storage is a place where all the necessary files are recorded: settings, logs, database, etc.

  • {string} [storage.path] - storage path. By default, it is `${process.cwd()}/${node.constructor.codename}/storage-${node.port}`

  • {object} [request] - section that responds for http request settings.

  • {integer} [request.clientConcurrency=50] - client request queue size. This means the maximum number of simultaneous client requests per endpoint.

  • {number|string} [request.pingTimeout="1s"] - timeout for server health check requests.

  • {number|string} [request.serverTimeout="2s"] - default timeout for a typical server request for any purpose.

  • {object} [network] - section that responds for the network settings.

  • {boolean} [network.autoSync=true] - automatic node synchronization with the network or not.

  • {boolean} [network.isTrusted=false] - can nodes trust each other on this network or not. If the value is false the system will perform additional checks to recognize and ban intruders. This can be resource intensive with a large number of nodes. Therefore, if your network is closed and you control all of your nodes yourself then enable this option.

  • {number|string} [network.syncInterval="16s"] - synchronization interval.

  • {number|string} [network.syncTimeCalculationPeriod="1d"] - synchronization statistics collection period.

  • {object|null} [network.auth=null] - basic authentication information. You can close the network from external access through the basic authentication mechanism using username and password.

  • {string} [network.auth.username] - basic authentication username.

  • {string} [network.auth.password] - basic authentication password.

  • {number|string} [network.authCookieMaxAge="7d"] - period of saving authorization data on the client.

  • {integer} [network.serverMaxFails=3] - number of failed requests to some node after which it will be removed from the lists.

  • {string[]} [network.blacklist=[]] - list of node addresses or IP addresses that can't work with the network.

  • {string[]} [network.whitelist=[]] - list of node addresses or IP addresses that can only work with the network. The whitelist has priority over the blacklist.

  • {string[]} [network.trustlist=[]] - list of node addresses or IP addresses that is trusted. The trustlist has priority over the whitelist.

  • {object} [server] - section that responds for the server settings.

  • {boolean} [server.https=false] - use https or not.

  • {number|string} [server.maxBodySize="500kb"] - maximum body size.

  • {number} [server.compressionLevel=6] - response compression level.

  • {string} [server.key] - ssl key.

  • {string} [server.cert] - ssl certificate.

  • {string} [server.ca] - ssl certificate authority.

  • {object} [behavior] - section that responds for the behavior settings. If the "network.isTrusted" is false then the behavior of the node is monitored to block nodes that disrupt the network.

  • {number} [behavior.candidateSuspicionLevel=5] - suspicious level of the candidate node.

  • {object|false} [logger] - section that responds for the logger settings. Each logger has its own specific settings. Listed below are only common to all.

  • {string|false} [logger.level="info"] - logger level. There are three levels, by default: "info", "warn", "error". The order of listing matters. If the level is "info" this means that all calls will be logged. If you use "warn" level then only "warn" and "error" calls will be logged and so on. To disable the logger pass the level as false.

  • {object|false} [task] - section that responds for the task settings. It is necessary to perform some tasks in the background.

  • {number|string} [task.calculateCpuUsageInterval="1s"] - CPU load counting task interval.

Client configuration

When you create an instance of the client you can pass options below:

  • {string|string[]} address - input node address to connect to the network. It can be an array with addresses that will be tested in turn until a working one is found.

  • [auth] - look at node.options.network.auth.

  • [logger] - look at node.options.logger.

  • [request] - look at node.options.request.

  • [request.pingTimeout] - look at node.options.request.pingTimeout.

  • {number|string} [request.clientTimeout="3s"] - default timeout for a typical client request for any purpose.

  • {boolean|object} [https=false] - use https or not.

  • {string} [https.ca] - ssl certificate authority.

  • [task] - look at node.options.task.

  • {number|string} [task.workerChangeInterval="30s"] - worker node changing interval. Client requests don't have to be made through the passed input address. The input node returns the most free one from the network which is called "worker" in this context. Requests occur through it. After a certain time the worker changes.

Client interface

Client.getAuthCookieValue() - get the basic auth info from cookies. This method is for the browser client only.

Client.getPageAddress() - get the current page address. This method is for the browser client only.

Client.getPageProtocol() - get the current page url protocol. This method is for the browser client only.

async Client.prototype.request() - request to some client endpoint

  • {string} endpoint - client endpoint to request
  • {object} [options] - request options

Contribution

If you face a bug or have an idea how to improve the library, create an issue on github. In order to fix something or add new code yourself fork the library, make changes and create a pull request to the master branch. Don't forget about tests in this case. Also you can join the project on github.

Install

npm i spreadable

DownloadsWeekly Downloads

461

Version

0.1.20

License

MIT

Unpacked Size

6.76 MB

Total Files

82

Last publish

Collaborators

  • avatar