@sockethub/crypto 1.0.0-alpha.4 → 1.0.0-alpha.5

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "@sockethub/crypto",
   "description": "Crypto functions and helpers for Sockethub",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0-alpha.5",
+  "type": "module",
   "private": false,
   "author": "Nick Jennings <nick@silverbucket.net>",
   "license": "MIT",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist/",
-    "src/"
-  ],
+  "main": "src/index.ts",
+  "engines": {
+    "bun": ">=1.2"
+  },
   "keywords": [
     "sockethub",
     "messaging",
@@ -26,41 +25,15 @@
   },
   "homepage": "https://github.com/sockethub/sockethub/tree/master/packages/data-layer",
   "dependencies": {
-    "@sockethub/schemas": "^3.0.0-alpha.4",
-    "object-hash": "^3.0.0"
-  },
-  "scripts": {
-    "clean": "npx rimraf dist coverage",
-    "clean:deps": "npx rimraf node_modules",
-    "compliance": "yarn run lint && yarn run test && yarn run coverage",
-    "test": "c8 -x \"src/**/*.test.*\" mocha -r ts-node/register src/*.test.ts",
-    "coverage": "c8 check-coverage --statements 100 --branches 90 --functions 85 --lines 100",
-    "lint": "eslint \"**/*.ts\"",
-    "lint:fix": "eslint --fix \"**/*.ts\"",
-    "build": "tsc"
-  },
-  "engines": {
-    "node": ">= 14"
+    "@sockethub/schemas": "3.0.0-alpha.5",
+    "object-hash": "3.0.0"
   },
   "devDependencies": {
-    "@types/chai": "4.3.3",
-    "@types/debug": "4.1.7",
-    "@types/eslint": "8.4.6",
-    "@types/mocha": "9.1.1",
-    "@types/node": "17.0.13",
-    "@types/object-hash": "2.2.1",
-    "@types/proxyquire": "1.3.28",
-    "@types/sinon": "10.0.13",
-    "@typescript-eslint/parser": "5.37.0",
-    "c8": "7.12.0",
-    "chai": "4.3.6",
-    "eslint": "8.23.1",
-    "eslint-cli": "1.1.1",
-    "mocha": "10.0.0",
-    "proxyquire": "2.1.3",
-    "sinon": "14.0.0",
-    "ts-node": "10.9.1",
-    "typescript": "4.8.3"
+    "@types/bun": "latest",
+    "@types/debug": "4.1.12",
+    "@types/object-hash": "3.0.6",
+    "@types/sinon": "17.0.2",
+    "sinon": "17.0.1"
   },
-  "gitHead": "c6d34ff44d2be479e4ea42c46da649612342a680"
+  "gitHead": "341ea9eeca6afd1442fe6e01457bc21d112b91a4"
 }

package/src/index.test.ts

@@ -1,78 +1,86 @@
-import { expect } from 'chai';
-import proxyquire from 'proxyquire';
+import { afterEach, beforeEach, describe, expect, it } from "bun:test";
 import * as sinon from "sinon";
 
-import crypto, {getPlatformId} from "./index";
+import { Crypto, getPlatformId } from "./index";
 
-const secret = 'a test secret.. that is 16 x 2..';
-const data = {'foo': 'bar'};
-const encryptedData = "00000000000000000000000000000000:0543ec94d863fbf4b7a19b48e69d9317";
+const secret = "a test secret.. that is 16 x 2..";
+const data = { foo: "bar" };
+const encryptedData =
+    "00000000000000000000000000000000:0543ec94d863fbf4b7a19b48e69d9317";
 
-describe('crypto', () => {
-  let crypto;
-  beforeEach(() => {
-    crypto = proxyquire('./index', {
-      crypto: {
-        randomBytes: () => Buffer.alloc(16)
-      }
-    }).default;
-  });
+describe("crypto", () => {
+    let crypto;
+    beforeEach(() => {
+        class TestCrypto extends Crypto {
+            createRandomBytes() {
+                this.randomBytes = () => Buffer.alloc(16);
+            }
+        }
+        crypto = new TestCrypto();
+    });
 
-  it('encrypts', () => {
-    expect(crypto.encrypt(data, secret)).to.be.equal(encryptedData);
-  });
+    it("encrypts", () => {
+        expect(crypto.encrypt(data, secret)).toEqual(encryptedData);
+    });
 
-  it('decrypts', () => {
-    expect(crypto.decrypt(encryptedData, secret)).to.eql(data);
-  });
+    it("decrypts", () => {
+        expect(crypto.decrypt(encryptedData, secret)).toEqual(data);
+    });
 
-  it('hashes', () => {
-    expect(crypto.hash('foobar')).to.be.equal('8843d7f');
-  });
+    it("hashes", () => {
+        expect(crypto.hash("foobar")).toEqual("8843d7f");
+    });
 
-  it('randTokens 8', () => {
-    const token = crypto.randToken(8);
-    expect(token.length).to.be.equal(8);
-  });
+    it("randTokens 8", () => {
+        const token = crypto.randToken(8);
+        expect(token.length).toEqual(8);
+    });
 
-  it('randTokens 16', () => {
-    const token = crypto.randToken(16);
-    expect(token.length).to.be.equal(16);
-  });
+    it("randTokens 16", () => {
+        const token = crypto.randToken(16);
+        expect(token.length).toEqual(16);
+    });
 
-  it('randTokens 32', () => {
-    const token = crypto.randToken(32);
-    expect(token.length).to.be.equal(32);
-  });
+    it("randTokens 32", () => {
+        const token = crypto.randToken(32);
+        expect(token.length).toEqual(32);
+    });
 
-  it('randTokens 33+ will fail', () => {
-    expect(() => {
-      crypto.randToken(33);
-    }).to.throw();
-  });
+    it("randTokens 33+ will fail", () => {
+        expect(() => {
+            crypto.randToken(33);
+        }).toThrow();
+    });
 });
 
 describe("getPlatformId", () => {
-  let cryptoHashStub: any;
+    let cryptoHashStub: any;
+    let crypto;
 
-  beforeEach(() => {
-    cryptoHashStub = sinon.stub(crypto, 'hash');
-    cryptoHashStub.returnsArg(0);
-    proxyquire('./index', { crypto: { hash: cryptoHashStub }});
-  });
+    beforeEach(() => {
+        cryptoHashStub = sinon.mock();
+        class TestCrypto extends Crypto {
+            createRandomBytes() {
+                this.randomBytes = () => Buffer.alloc(16);
+            }
+        }
+        crypto = new TestCrypto();
+        cryptoHashStub = sinon.stub(crypto, "hash");
+        cryptoHashStub.returnsArg(0);
+    });
 
-  afterEach(() => {
-    cryptoHashStub.restore();
-  });
+    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');
-  });
-});
+    it("generates platform hash", () => {
+        expect(getPlatformId("foo", undefined, crypto)).toEqual("foo");
+        sinon.assert.calledOnce(cryptoHashStub);
+        sinon.assert.calledWith(cryptoHashStub, "foo");
+    });
+    it("generates platform + actor hash", () => {
+        expect(getPlatformId("foo", "bar", crypto)).toEqual("foobar");
+        sinon.assert.calledOnce(cryptoHashStub);
+        sinon.assert.calledWith(cryptoHashStub, "foobar");
+    });
+});

package/src/index.ts

@@ -1,53 +1,82 @@
-import { randomBytes, createCipheriv, createDecipheriv, createHash } from 'crypto';
-import {IActivityStream} from "@sockethub/schemas";
-import hash from 'object-hash';
+import {
+    createCipheriv,
+    createDecipheriv,
+    createHash,
+    randomBytes,
+} from "node:crypto";
+import type { ActivityStream } from "@sockethub/schemas";
+import hash from "object-hash";
 
-const ALGORITHM = 'aes-256-cbc',
-      IV_LENGTH = 16; // For AES, this is always 16
+const ALGORITHM = "aes-256-cbc";
+const IV_LENGTH = 16; // For AES, this is always 16
 
-export function getPlatformId(platform: string, actor?: string): string {
-  return actor ? crypto.hash(platform + actor) : crypto.hash(platform);
+export function getPlatformId(
+    platform: string,
+    actor?: string,
+    _crypto = crypto,
+): string {
+    return actor ? _crypto.hash(platform + actor) : _crypto.hash(platform);
 }
 
-class Crypto {
-
-  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 {
-    const 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);
-  }
-
-  objectHash(object: any): string {
-    return hash(object);
-  }
-
-  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);
-  }
+export class Crypto {
+    randomBytes: typeof randomBytes;
+
+    constructor() {
+        this.createRandomBytes();
+    }
+
+    createRandomBytes() {
+        this.randomBytes = randomBytes;
+    }
+
+    encrypt(json: ActivityStream, secret: string): string {
+        Crypto.ensureSecret(secret);
+        const iv = this.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): ActivityStream {
+        Crypto.ensureSecret(secret);
+        const 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);
+    }
+
+    objectHash(object: object): string {
+        return hash(object);
+    }
+
+    randToken(len: number): string {
+        if (len > 32) {
+            throw new Error(
+                `crypto.randToken supports a length param of up to 32, ${len} given`,
+            );
+        }
+        const buf = this.randomBytes(len);
+        return buf.toString("hex").substring(0, len);
+    }
+
+    private static ensureSecret(secret: string) {
+        if (secret.length !== 32) {
+            throw new Error(
+                `secret must be a 32 char string, length: ${secret.length}`,
+            );
+        }
+    }
 }
 
-const crypto = new Crypto();
-export default crypto;
+export const crypto = new Crypto();

package/dist/index.d.ts

@@ -1,11 +0,0 @@
-import { IActivityStream } from "@sockethub/schemas";
-export declare function getPlatformId(platform: string, actor?: string): string;
-declare class Crypto {
-    encrypt(json: IActivityStream, secret: string): string;
-    decrypt(text: string, secret: string): IActivityStream;
-    hash(text: string): string;
-    objectHash(object: any): string;
-    randToken(len: number): string;
-}
-declare const crypto: Crypto;
-export default crypto;

package/dist/index.js

@@ -1,49 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPlatformId = void 0;
-const crypto_1 = require("crypto");
-const object_hash_1 = __importDefault(require("object-hash"));
-const ALGORITHM = 'aes-256-cbc', IV_LENGTH = 16; // For AES, this is always 16
-function getPlatformId(platform, actor) {
-    return actor ? crypto.hash(platform + actor) : crypto.hash(platform);
-}
-exports.getPlatformId = getPlatformId;
-class Crypto {
-    encrypt(json, secret) {
-        const iv = (0, crypto_1.randomBytes)(IV_LENGTH);
-        const cipher = (0, crypto_1.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, secret) {
-        const parts = text.split(':');
-        const iv = Buffer.from(parts.shift(), 'hex');
-        const encryptedText = Buffer.from(parts.join(':'), 'hex');
-        const decipher = (0, crypto_1.createDecipheriv)(ALGORITHM, Buffer.from(secret), iv);
-        let decrypted = decipher.update(encryptedText);
-        decrypted = Buffer.concat([decrypted, decipher.final()]);
-        return JSON.parse(decrypted.toString());
-    }
-    hash(text) {
-        const SHASum = (0, crypto_1.createHash)('sha1');
-        SHASum.update(text);
-        return SHASum.digest('hex').substring(0, 7);
-    }
-    objectHash(object) {
-        return (0, object_hash_1.default)(object);
-    }
-    randToken(len) {
-        if (len > 32) {
-            throw new Error(`crypto.randToken supports a length param of up to 32, ${len} given`);
-        }
-        const buf = (0, crypto_1.randomBytes)(len);
-        return buf.toString('hex').substring(0, len);
-    }
-}
-const crypto = new Crypto();
-exports.default = crypto;
-//# sourceMappingURL=/index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"/","sources":["index.ts"],"names":[],"mappings":";;;;;;AAAA,mCAAmF;AAEnF,8DAA+B;AAE/B,MAAM,SAAS,GAAG,aAAa,EACzB,SAAS,GAAG,EAAE,CAAC,CAAC,6BAA6B;AAEnD,SAAgB,aAAa,CAAC,QAAgB,EAAE,KAAc;IAC5D,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACvE,CAAC;AAFD,sCAEC;AAED,MAAM,MAAM;IAEV,OAAO,CAAC,IAAqB,EAAE,MAAc;QAC3C,MAAM,EAAE,GAAG,IAAA,oBAAW,EAAC,SAAS,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,IAAA,uBAAc,EAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QAClE,IAAI,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpD,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACvD,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,MAAc;QAClC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;QAC7C,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,IAAA,yBAAgB,EAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QACtE,IAAI,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC/C,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,CAAC,IAAY;QACf,MAAM,MAAM,GAAG,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAC;QAClC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACpB,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,UAAU,CAAC,MAAW;QACpB,OAAO,IAAA,qBAAI,EAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IAED,SAAS,CAAC,GAAW;QACnB,IAAI,GAAG,GAAG,EAAE,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,yDAAyD,GAAG,QAAQ,CAAC,CAAC;SACvF;QACD,MAAM,GAAG,GAAG,IAAA,oBAAW,EAAC,GAAG,CAAC,CAAC;QAC7B,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/C,CAAC;CACF;AAED,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;AAC5B,kBAAe,MAAM,CAAC"}