@sockethub/server 5.0.0-alpha.3 → 5.0.0-alpha.6

package/src/bootstrap/platforms.js

@@ -1,75 +0,0 @@
-/**
- * bootstrap/platforms.js
- *
- * A Singleton responsible for finding and loading all valid Sockethub
- * platforms, and whitelisting or blacklisting (or neither) based on the
- * config.
- */
-const debug   = require('debug'),
-      schemas = require('@sockethub/schemas').default;
-
-const log = debug('sockethub:server:bootstrap:platforms');
-
-log('loading platforms');
-
-// if the platform schema lists valid types it implements (essentially methods/verbs for
-// Sockethub to call) then add it to the supported types list.
-function platformListsSupportedTypes(p) {
-  return ((p.schema.messages.properties) && (p.schema.messages.properties.type) &&
-    (p.schema.messages.properties.type.enum) &&
-    (p.schema.messages.properties.type.enum.length > 0));
-}
-
-module.exports = function platformLoad(platformsList, requireModule) {
-  if (!requireModule) {
-    requireModule = require;
-  }
-  // load platforms from config.platforms
-  const platforms = new Map();
-
-  if (platformsList.length <= 0) {
-    throw new Error('No platforms defined. Please check your sockethub.config.json');
-  }
-
-  for (let moduleName of platformsList) {
-    log(`loading ${moduleName}`);
-    // try to load platform
-    // eslint-disable-next-line security-node/detect-non-literal-require-calls
-    const P = requireModule(moduleName);
-    const p = new P();
-    let types = [];
-
-    const err = schemas.validatePlatformSchema(p.schema);
-    if (err) {
-      throw new Error(`${moduleName} ${err}`);
-    } else if (typeof p.config !== 'object') {
-      throw new Error(
-        `${moduleName} platform must have a config property that is an object.`);
-    } else {
-      if (p.schema.credentials) {
-        // register the platforms credentials schema
-        types.push('credentials');
-      } else {
-        p.config.noCredentials = true;
-      }
-    }
-
-    if (platformListsSupportedTypes(p)) {
-      types = [...types, ...p.schema.messages.properties.type.enum];
-    }
-
-    const platformName = p.schema.name;
-    platforms.set(platformName, {
-      id: platformName,
-      moduleName: moduleName,
-      config: p.config,
-      schemas: {
-        credentials: p.schema.credentials || {},
-        messages: p.schema.messages || {}
-      },
-      version: p.schema.version,
-      types: types
-    });
-  }
-  return platforms;
-};

package/src/common.test.ts

@@ -1,54 +0,0 @@
-import proxyquire from 'proxyquire';
-import { expect } from 'chai';
-import * as sinon from 'sinon';
-
-import { decryptJobData, getPlatformId } from './common';
-import crypto from './crypto';
-
-proxyquire.noPreserveCache();
-proxyquire.noCallThru();
-
-describe("getPlatformId", () => {
-  let cryptoHashStub: any;
-
-  beforeEach(() => {
-    cryptoHashStub = sinon.stub(crypto, 'hash');
-    cryptoHashStub.returnsArg(0);
-    proxyquire('./common', { crypto: { hash: cryptoHashStub }});
-  });
-
-  afterEach(() => {
-    cryptoHashStub.restore();
-  });
-
-  it('generates platform hash', () => {
-    expect(getPlatformId('foo')).to.be.equal('foo');
-    sinon.assert.calledOnce(cryptoHashStub);
-    sinon.assert.calledWith(cryptoHashStub, 'foo');
-  });
-  it('generates platform + actor hash', () => {
-    expect(getPlatformId('foo', 'bar')).to.be.equal('foobar');
-    sinon.assert.calledOnce(cryptoHashStub);
-    sinon.assert.calledWith(cryptoHashStub, 'foobar');
-  });
-});
-
-describe("decryptJobData", () => {
-  let cryptoDecryptStub: any;
-
-  beforeEach(() => {
-    cryptoDecryptStub = sinon.stub(crypto, 'decrypt');
-    cryptoDecryptStub.returnsArg(0);
-    proxyquire('./common', { crypto: { hash: cryptoDecryptStub }});
-  });
-
-  afterEach(() => {
-    cryptoDecryptStub.restore();
-  });
-
-  it("decrypts and returns expected object", () => {
-    const jobData = {data:{title:"foo", msg:'encryptedjobdata', sessionId:'foobar'}};
-    const secret = 'secretstring';
-    expect(decryptJobData(jobData, secret)).to.be.eql(jobData.data);
-  });
-});

package/src/common.ts

@@ -1,14 +0,0 @@
-import crypto from "./crypto";
-import { JobDataDecrypted, JobEncrypted } from "./sockethub";
-
-export function getPlatformId(platform: string, actor?: string): string {
-  return actor ? crypto.hash(platform + actor) : crypto.hash(platform);
-}
-
-export function decryptJobData(job: JobEncrypted, secret: string): JobDataDecrypted {
-  return {
-    title: job.data.title,
-    msg: crypto.decrypt(job.data.msg, secret),
-    sessionId: job.data.sessionId
-  };
-}

package/src/config.d.ts

@@ -1,2 +0,0 @@
-declare let config: any;
-export default config;

package/src/crypto.d.ts

@@ -1,5 +0,0 @@
-declare const crypto: {
-    encrypt: (json: any, secret: any) => string;
-    decrypt: (string: any, secret: any) => any;
-};
-export default crypto;

package/src/crypto.test.ts

@@ -1,41 +0,0 @@
-import { expect } from 'chai';
-import proxyquire from 'proxyquire';
-
-const crypto = proxyquire('./crypto', {
-  'crypto': {
-    randomBytes: () => Buffer.alloc(16)
-  }
-}).default;
-
-const secret = 'a test secret.. that is 16 x 2..';
-const data = {'foo': 'bar'};
-const encryptedData = "00000000000000000000000000000000:0543ec94d863fbf4b7a19b48e69d9317";
-
-describe('crypto', () => {
-  it('encrypts', () => {
-    expect(crypto.encrypt(data, secret)).to.be.equal(encryptedData);
-  });
-  it('decrypts', () => {
-    expect(crypto.decrypt(encryptedData, secret)).to.eql(data);
-  });
-  it('hashes', () => {
-    expect(crypto.hash('foobar')).to.be.equal('8843d7f');
-  });
-  it('randTokens 8', () => {
-    const token = crypto.randToken(8);
-    expect(token.length).to.be.equal(8);
-  });
-  it('randTokens 16', () => {
-    const token = crypto.randToken(16);
-    expect(token.length).to.be.equal(16);
-  });
-  it('randTokens 32', () => {
-    const token = crypto.randToken(32);
-    expect(token.length).to.be.equal(32);
-  });
-  it('randTokens 33+ will fail', () => {
-    expect(() => {
-      crypto.randToken(33);
-    }).to.throw();
-  });
-});

package/src/crypto.ts

@@ -1,41 +0,0 @@
-import { randomBytes, createCipheriv, createDecipheriv, createHash } from 'crypto';
-import { IActivityStream } from "@sockethub/schemas";
-
-const ALGORITHM = 'aes-256-cbc',
-      IV_LENGTH = 16; // For AES, this is always 16
-
-class Crypto {
-  constructor() {}
-  encrypt(json: IActivityStream, secret: string): string {
-    const iv = randomBytes(IV_LENGTH);
-    const cipher = createCipheriv(ALGORITHM, Buffer.from(secret), iv);
-    let encrypted = cipher.update(JSON.stringify(json));
-
-    encrypted = Buffer.concat([encrypted, cipher.final()]);
-    return iv.toString('hex') + ':' + encrypted.toString('hex');
-  }
-  decrypt(text: string, secret: string): IActivityStream {
-    let parts = text.split(':');
-    const iv = Buffer.from(parts.shift(), 'hex');
-    const encryptedText = Buffer.from(parts.join(':'), 'hex');
-    const decipher = createDecipheriv(ALGORITHM, Buffer.from(secret), iv);
-    let decrypted = decipher.update(encryptedText);
-    decrypted = Buffer.concat([decrypted, decipher.final()]);
-    return JSON.parse(decrypted.toString());
-  }
-  hash(text: string): string {
-    const shasum = createHash('sha1');
-    shasum.update(text);
-    return shasum.digest('hex').substring(0, 7);
-  }
-  randToken(len: number): string {
-    if (len > 32) {
-      throw new Error(`crypto.randToken supports a length param of up to 32, ${len} given`);
-    }
-    const buf = randomBytes(len);
-    return buf.toString('hex').substring(0, len);
-  }
-}
-
-const crypto = new Crypto();
-export default crypto;

package/src/janitor.d.ts

@@ -1,8 +0,0 @@
-declare function janitorCycle(): void;
-declare const janitor: {
-    start: typeof janitorCycle;
-    alreadyCalled: boolean;
-    cycleCount: number;
-    reportCount: number;
-};
-export default janitor;

package/src/middleware/validate.d.ts

@@ -1 +0,0 @@
-export default function validate(type: any): (next: any, msg: any) => void;

package/src/middleware.d.ts

@@ -1,21 +0,0 @@
-/**
- * a very simple middleware handler
- *
- * When initialized, provide a function which will be called if there were any failures during
- * the execution of functions along the chain.
- *
- * Use middleware.chain, passing in a list of functions to call in order. It then returns
- * a function which accepts the message from the input. That function then will
- * call each of the originally passed in functions, in order, with a `next` callback as
- * the first parameter, and any number of originating parameters.
- *
- * As one middleware function is done, they call `next` with the first argument `true`
- * (succeeded, continue) any parameters to pass along.
- *
- * If any of the middleware function calls the `next` handler with `false` as the first param, the
- * execution of the function chain is halted, and the failure callback is called. Again, any
- * number of params passed after the `false` will be passed to the failure callback.
- *
- */
-declare function Middleware(errorHandler: any): void;
-export default Middleware;

package/src/sockethub.d.ts

@@ -1 +0,0 @@
-export {};

package/src/store.test.ts

@@ -1,28 +0,0 @@
-import proxyquire from 'proxyquire';
-import { expect } from 'chai';
-import * as sinon from 'sinon';
-
-proxyquire.noPreserveCache();
-proxyquire.noCallThru();
-
-const MockSecureStore = sinon.fake();
-
-const StoreMod = proxyquire('./store', {
-  'secure-store-redis': MockSecureStore
-});
-
-const getSessionStore = StoreMod.getSessionStore;
-
-describe('getSessionStore', () => {
-  it('returns a valid Store object', () => {
-    const store = getSessionStore('a parent id', 'a parent secret',
-      'a session id', 'a session secret');
-    sinon.assert.calledOnce(MockSecureStore);
-    sinon.assert.calledWith(MockSecureStore, {
-      namespace: 'sockethub:a parent id:session:a session id:store',
-      secret: 'a parent secreta session secret',
-      redis: { host: '127.0.0.1', port: 6379 }
-    });
-    expect(typeof store).to.equal('object');
-  });
-});

package/src/store.ts

@@ -1,17 +0,0 @@
-import SecureStore from 'secure-store-redis';
-
-import config from "./config";
-
-export interface ISecureStoreInstance {
-  save(id: string, obj: any, cb: Function);
-  get(id: string, cb: Function);
-}
-
-export function getSessionStore(parentId: string, parentSecret: string,
-                                sessionId: string, sessionSecret: string): ISecureStoreInstance {
-  return new SecureStore({
-    namespace: 'sockethub:' + parentId + ':session:' + sessionId + ':store',
-    secret: parentSecret + sessionSecret,
-    redis: config.get('redis')
-  });
-}

package/test/init-suite.js

@@ -1,41 +0,0 @@
-if (typeof define !== 'function') {
-  let define = require('amdefine')(module);
-}
-define(['require'], function (require) {
-  return [
-    {
-      desc: 'dist/bootstrap/init',
-      abortOnFail: true,
-      setup: function (env, test) {
-        env.init = require('../dist/bootstrap/init').default;
-        test.assertType(env.init, 'object');
-      },
-      tests: [
-        {
-          desc: 'platforms',
-          run: function (env, test) {
-            test.assertTypeAnd(env.init.platforms, 'object');
-            test.assert(env.init.platforms.has('irc'), true);
-          }
-        }
-      ]
-    },
-    {
-      desc: 'nconf should have defaults set',
-      setup: function (env, test) {
-        env.nconf = require('nconf');
-        test.assertType(env.nconf.get, 'function');
-      },
-      tests: [
-        {
-          desc: 'whitelist and blacklist',
-          run: function (env, test) {
-            console.log('whitelist: ', typeof require('nconf').get('platforms:whitelist'));
-            test.assertTypeAnd(require('nconf').get('platforms:whitelist'), 'array');
-            test.assertType(require('nconf').get('platforms:blacklist'), 'array');
-          }
-        }
-      ]
-    }
-  ];
-});

package/test/sockethub-suite.js

@@ -1,25 +0,0 @@
-if (typeof define !== 'function') {
-  let define = require('amdefine')(module);
-}
-define(['require', './.'], function (require, Sockethub) {
-  return [
-    {
-      desc: 'src/sockethub',
-      abortOnFail: true,
-      beforeEach: function () {
-        this.env.sockethub = new Sockethub.default();
-        this.done();
-      },
-      tests: [
-        {
-          desc: 'boot',
-          run: function () {
-            this.env.sockethub.boot();
-            this.assertTypeAnd(this.env.sockethub.platforms, 'object');
-            this.assertType(this.env.sockethub.platforms.size, 'number');
-          }
-        }
-      ]
-    }
-  ];
-});

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "allowJs": false,
-    "outDir": "dist",
-    "rootDir": "src",
-    "baseUrl": "/",
-    "sourceMap": true,
-    "sourceRoot": "/",
-    "mapRoot": "/",
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "**/*.test.ts"
-  ]
-}

package/views/examples/dummy.ejs

@@ -1,93 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <title>Sockethub Example Dummy</title>
-    <style>
-      * { margin: 0; padding: 0; box-sizing: border-box; }
-      body { font: 13px Helvetica, Arial; }
-      form { background: #000; padding: 3px; position: fixed; bottom: 0; width: 100%; }
-      form input { border: 0; padding: 10px; width: 90%; margin-right: .5%; }
-      form button { width: 9%; background: rgb(130, 224, 255); border: none; padding: 10px; }
-      #messages { list-style-type: none; margin: 0; padding: 0; }
-      #messages li { padding: 5px 10px; }
-      #messages li:nth-child(odd) { background: #eee; }
-    </style>
-  </head>
-  <body>
-    <ul id="messages"></ul>
-    <form action="">
-      <input id="m" autocomplete="off" /><button>Send</button>
-    </form>
-
-    <script src="<%= address %>jquery.js"></script>
-    <script src="<%= address %>socket.io.js"></script>
-    <script src="<%= address %>activity-streams.min.js"></script>
-    <script src="<%= address %>sockethub-client.js"></script>
-    <script>
-      bdebug = function (msg, obj) { console.log(msg, obj); };
-      localStorage.debug = '<%= debug_scope %>';
-      var sc = new SockethubClient(io('<%= address %>', { path: '/sockethub' }));
-
-      // our user info
-      sc.ActivityStreams.Object.create({
-        'id': 'https://sockethub.org/examples/dummyUser',
-        'type': "person",
-        name: "Sockethub Examples - Dummy User"
-      });
-
-      // errors
-      sc.socket.on('failure', function (msg) {
-        bdebug('received failure: ', msg);
-      });
-
-      function displayMessage(msg) {
-        msg.actor = sc.ActivityStreams.Object.get(msg.actor);
-        bdebug('displaying message: ', msg);
-        $('#messages').append($('<li>').text(msg.actor.name + ': ' + msg.object.title));
-      }
-
-      sc.socket.on('completed', function (msg) {
-        bdebug('received completed event for: ', msg);
-      });
-
-      // handle incoming messages from the Socekthub server
-      sc.socket.on('message', function (msg) {
-        bdebug('received message: ', msg);
-        if (Array.isArray(msg)) {
-          bdebug('is array len:' + msg.length);
-          for (var i = 0, len = msg.length; i < len; i++) {
-            bdebug('looping '+i+' ', msg[i]);
-            displayMessage(msg[i]);
-          }
-        } else {
-          displayMessage(msg);
-        }
-      });
-
-      // handler for user input, emit messages to Sockethub server
-      $('form').submit(function () {
-        let text = $('#m').val();
-        const parts = text.split('fail:');
-        let type = 'echo';
-        text = parts[parts.length-1];
-        if (parts.length > 1) {
-          type = 'fail';
-        }
-        const msg = {
-          context: 'dummy',
-          'type': type,
-          actor: 'https://sockethub.org/examples/dummyUser',
-          object: {
-            'type': 'message',
-            content: text
-          }
-        };
-        bdebug('sending message: ', msg);
-        sc.socket.emit('message', msg);
-
-        $('#m').val('');
-        return false;
-      });
-    </script>
-  </body>
-</html>

package/views/examples/feeds.ejs

@@ -1,90 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <title>Sockethub Example Feed Reader</title>
-    <style>
-      * { margin: 0; padding: 0; box-sizing: border-box; }
-      body { font: 13px Helvetica, Arial; }
-      form { background: #000; padding: 3px; position: fixed; bottom: 0; width: 100%; }
-      form input { border: 0; padding: 10px; width: 90%; margin-right: .5%; }
-      form button { width: 9%; background: rgb(130, 224, 255); border: none; padding: 10px; }
-      #messages { list-style-type: none; margin: 0; padding: 0; }
-      #messages li { padding: 5px 10px; }
-      #messages li:nth-child(odd) { background: #eee; }
-    </style>
-  </head>
-  <body>
-    <ul id="messages"></ul>
-    <form action="">
-      <input id="m" autocomplete="off" /><button>Send</button>
-    </form>
-
-    <script src="<%= address %>jquery.js"></script>
-    <script src="<%= address %>socket.io.js"></script>
-    <script src="<%= address %>activity-streams.min.js"></script>
-    <script src="<%= address %>sockethub-client.js"></script>
-    <script>
-      localStorage.debug = '<%= debug_scope %>';
-      const sc = new SockethubClient(io('<%= address %>', { path: '/sockethub' }));
-
-      // errors
-      sc.socket.on('failure', function (msg) {
-        console.log('received failure: ', msg);
-      });
-
-      sc.socket.on('completed', function (msg) {
-        console.log('received completed event for: ', msg);
-        displayMessages(msg.object.content || []);
-      });
-
-      // handle incoming messages from the Sockethub server
-      sc.socket.on('message', function (msg) {
-        console.log('received message: ', msg);
-        displayMessages(msg);
-      });
-
-      function displayMessages(msgs) {
-        if (Array.isArray(msgs)) {
-          for (let i = 0, len = msgs.length; i < len; i++) {
-            displayMessage(msgs[i]);
-          }
-        } else {
-          displayMessage(msgs);
-        }
-      }
-
-      function displayMessage(msg) {
-        console.log('displaying message: ', msg);
-        $('#messages').append($('<li>').html(`<b>${msg.object.name}</b>: ${msg.object.html}`));
-      }
-
-      // handler for user input, emit messages to Sockethub server
-      $('form').submit(function () {
-        const msg = {
-          context: 'feeds',
-          'type': 'fetch',
-          actor: 'https://sockethub.org/examples/feeds',
-          object: {
-            'type': 'parameters'
-          },
-          target: {
-            'type': 'feed',
-            'id': $('#m').val()
-          }
-        };
-
-        console.log('sending message: ', msg);
-        sc.socket.emit('message', msg, (data) => { console.log('CALLBACK', data); });
-        $('#m').val('');
-        return false;
-      });
-
-      // our feed actor info
-      sc.ActivityStreams.Object.create({
-        'id': 'https://sockethub.org/examples/feeds',
-        'type': "website",
-        name: "Sockethub Examples - Feeds"
-      });
-    </script>
-  </body>
-</html>