@bedrock/kms 10.1.0 → 11.0.0

package/test/mocha/14-keystores-getStorageUsage-api.js

@@ -1,119 +0,0 @@
-/*!
- * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
- */
-import {keystores, defaultModuleManager as moduleManager} from '@bedrock/kms';
-
-describe('keystores APIs', () => {
-  describe('getStorageUsage API', () => {
-    it('gets storage usage for a keystore', async () => {
-      let err;
-      let result;
-      const config = {
-        id: 'https://example.com/keystores/usage-test1',
-        controller: 'usage-test',
-        kmsModule: 'ssm-v1',
-        sequence: 0,
-        meterId: 'usage-meter-1'
-      };
-      try {
-        await keystores.insert({config});
-        result = await keystores.getStorageUsage({
-          meterId: 'usage-meter-1', moduleManager
-        });
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      should.exist(result);
-      result.should.be.an('object');
-      result.should.deep.equal({storage: 1});
-    });
-    it('gets custom storage usage for a keystore', async () => {
-      let err;
-      let result;
-      const config = {
-        id: 'https://example.com/keystores/usage-test2',
-        controller: 'usage-test',
-        kmsModule: 'ssm-v1',
-        sequence: 0,
-        meterId: 'usage-meter-2'
-      };
-      try {
-        await keystores.insert({config});
-        result = await keystores.getStorageUsage({
-          meterId: 'usage-meter-2', moduleManager,
-          async aggregate({usage}) {
-            usage.storage++;
-          }
-        });
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      should.exist(result);
-      result.should.be.an('object');
-      result.should.deep.equal({storage: 2});
-    });
-    it('gets custom storage usage for a keystore when max concurrency is ' +
-      'reached', async () => {
-      let err;
-      let result;
-      // 54 is used in order to have a counters.length of 102 to ensure max
-      // concurrency of 100 (`USAGE_COUNTER_MAX_CONCURRENCY`) is reached;
-      // if this max concurrency changes, this test will need to change too
-      for(let i = 3; i < 54; i++) {
-        const config = {
-          id: `https://example.com/keystores/usage-test${i}`,
-          controller: 'usage-test',
-          kmsModule: 'ssm-v1',
-          sequence: 0,
-          meterId: `usage-meter-3`
-        };
-        await keystores.insert({config});
-      }
-      try {
-        result = await keystores.getStorageUsage({
-          meterId: 'usage-meter-3', moduleManager,
-          async aggregate({usage}) {
-            usage.storage++;
-          }
-        });
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      should.exist(result);
-      result.should.be.an('object');
-      result.should.deep.equal({storage: 102});
-    });
-    it('aborts computing metered storage', async () => {
-      let err;
-      let result;
-      const config = {
-        id: 'https://example.com/keystores/usage-test55',
-        controller: 'usage-test',
-        kmsModule: 'ssm-v1',
-        sequence: 0,
-        meterId: 'usage-meter-55'
-      };
-      try {
-        await keystores.insert({config});
-        result = await keystores.getStorageUsage({
-          signal: {
-            abort: true
-          },
-          meterId: 'usage-meter-55', moduleManager,
-          async aggregate({usage}) {
-            usage.storage++;
-          }
-        });
-      } catch(e) {
-        err = e;
-      }
-
-      should.exist(err);
-      should.not.exist(result);
-      err.name.should.equal('AbortError');
-    });
-  }); // end getStorageUsage API
-}); // end keystore APIs

package/test/mocha/20-key-operations.js

@@ -1,240 +0,0 @@
-/*!
- * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
- */
-import * as helpers from './helpers.js';
-import {createRequire} from 'node:module';
-import {defaultModuleManager as moduleManager} from '@bedrock/kms';
-import {klona} from 'klona';
-import {mockData} from './mock.data.js';
-import {v4 as uuid} from 'uuid';
-const require = createRequire(import.meta.url);
-const {runOperation} = require('@digitalbazaar/webkms-switch');
-
-describe('bedrock-kms', () => {
-  describe('integration with runOperation API', () => {
-    describe('GenerateKeyOperation', () => {
-      it('successfully generates a Ed25519VerificationKey2018', async () => {
-        const keystore = {
-          id: 'https://example.com/keystores/x',
-          controller: 'urn:uuid:baa943d2-7338-11ec-b1c4-10bf48838a41',
-          kmsModule: 'ssm-v1'
-        };
-        const operation = klona(
-          mockData.operations.generate({type: 'Ed25519VerificationKey2018'}));
-        operation.invocationTarget.type = 'Ed25519VerificationKey2018';
-        let error;
-        let result;
-        try {
-          result = await runOperation({operation, keystore, moduleManager});
-        } catch(e) {
-          error = e;
-        }
-        assertNoError(error);
-        should.exist(result);
-        result.should.have.keys(['keyId', 'result']);
-        result.result.should.have.keys(['keyId', 'keyDescription']);
-        const {keyDescription} = result.result;
-        keyDescription.should.have.keys(
-          ['@context', 'id', 'publicKeyBase58', 'type', 'controller']);
-        keyDescription.type.should.equal(operation.invocationTarget.type);
-        keyDescription.publicKeyBase58.should.be.a('string');
-      });
-      it('successfully generates a Ed25519VerificationKey2020', async () => {
-        const keystore = {
-          id: 'https://example.com/keystores/x',
-          controller: 'urn:uuid:baa943d2-7338-11ec-b1c4-10bf48838a41',
-          kmsModule: 'ssm-v1'
-        };
-        const operation = klona(
-          mockData.operations.generate({type: 'Ed25519VerificationKey2020'}));
-        operation.invocationTarget.type = 'Ed25519VerificationKey2020';
-        let error;
-        let result;
-        try {
-          result = await runOperation({operation, keystore, moduleManager});
-        } catch(e) {
-          error = e;
-        }
-        assertNoError(error);
-        should.exist(result);
-        result.should.have.keys(['keyId', 'result']);
-        result.result.should.have.keys(['keyId', 'keyDescription']);
-        const {keyDescription} = result.result;
-        keyDescription.should.have.keys(
-          ['@context', 'id', 'publicKeyMultibase', 'type', 'controller']);
-        keyDescription.type.should.equal(operation.invocationTarget.type);
-        keyDescription.publicKeyMultibase.should.be.a('string');
-      });
-      it('successfully generates a Sha256HmacKey2019', async () => {
-        const keystore = {
-          id: 'https://example.com/keystores/x',
-          controller: 'urn:uuid:baa943d2-7338-11ec-b1c4-10bf48838a41',
-          kmsModule: 'ssm-v1'
-        };
-        const operation = klona(
-          mockData.operations.generate({type: 'Sha256HmacKey2019'}));
-        operation.invocationTarget.type = 'Sha256HmacKey2019';
-        let error;
-        let result;
-        try {
-          result = await runOperation({operation, keystore, moduleManager});
-        } catch(e) {
-          error = e;
-        }
-        assertNoError(error);
-        should.exist(result);
-        result.should.be.an('object');
-        result.should.have.keys(['keyId', 'result']);
-        result.result.should.have.keys(['keyId', 'keyDescription']);
-        const {keyDescription} = result.result;
-        keyDescription.should.have.keys(
-          ['@context', 'id', 'type', 'controller']);
-      });
-      it('successfully generates a AesKeyWrappingKey2019', async () => {
-        const keystore = {
-          id: 'https://example.com/keystores/x',
-          controller: 'urn:uuid:baa943d2-7338-11ec-b1c4-10bf48838a41',
-          kmsModule: 'ssm-v1'
-        };
-        const operation = klona(
-          mockData.operations.generate({type: 'AesKeyWrappingKey2019'}));
-        operation.invocationTarget.type = 'AesKeyWrappingKey2019';
-        let error;
-        let result;
-        try {
-          result = await runOperation({operation, keystore, moduleManager});
-        } catch(e) {
-          error = e;
-        }
-        assertNoError(error);
-        should.exist(result);
-        result.should.be.an('object');
-        result.should.have.keys(['keyId', 'result']);
-        result.result.should.have.keys(['keyId', 'keyDescription']);
-        const {keyDescription} = result.result;
-        keyDescription.should.have.keys(
-          ['@context', 'id', 'type', 'controller']);
-      });
-      it('throws on UnknownKeyType', async () => {
-        const keystore = {
-          id: 'https://example.com/keystores/x',
-          controller: 'urn:uuid:baa943d2-7338-11ec-b1c4-10bf48838a41',
-          kmsModule: 'ssm-v1'
-        };
-        const operation = klona(
-          mockData.operations.generate({type: 'AesKeyWrappingKey2019'}));
-        operation.invocationTarget.type = 'UnknownKeyType';
-        let error;
-        let result;
-        try {
-          result = await runOperation({operation, keystore, moduleManager});
-        } catch(e) {
-          error = e;
-        }
-        should.exist(error);
-        should.not.exist(result);
-        error.message.should.include('UnknownKeyType');
-      });
-    }); // end GenerateKeyOperation
-
-    describe('SignOperation', () => {
-      it('signs a string using Ed25519VerificationKey2018', async () => {
-        const {keystore, key: {id: keyId}} = await helpers.generateKey(
-          {mockData, type: 'Ed25519VerificationKey2018'});
-        const operation = klona(mockData.operations.sign);
-        operation.invocationTarget = keyId;
-        operation.verifyData = uuid();
-        let result;
-        let error;
-        try {
-          result = await runOperation({operation, keystore, moduleManager});
-        } catch(e) {
-          error = e;
-        }
-        assertNoError(error);
-        should.exist(result);
-        result.should.be.an('object');
-        result.should.have.keys(['keyId', 'result']);
-        result.result.should.have.keys(['signatureValue']);
-        should.exist(result.result.signatureValue);
-        const {signatureValue} = result.result;
-        signatureValue.should.be.a('string');
-      });
-      it('signs a string using Ed25519VerificationKey2020', async () => {
-        const {keystore, key: {id: keyId}} = await helpers.generateKey(
-          {mockData, type: 'Ed25519VerificationKey2020'});
-        const operation = klona(mockData.operations.sign);
-        operation.invocationTarget = keyId;
-        operation.verifyData = uuid();
-        let result;
-        let error;
-        try {
-          result = await runOperation({operation, keystore, moduleManager});
-        } catch(e) {
-          error = e;
-        }
-        assertNoError(error);
-        should.exist(result);
-        result.should.be.an('object');
-        result.should.have.keys(['keyId', 'result']);
-        result.result.should.have.keys(['signatureValue']);
-        should.exist(result.result.signatureValue);
-        const {signatureValue} = result.result;
-        signatureValue.should.be.a('string');
-      });
-      it('signs a string using Sha256HmacKey2019', async () => {
-        const {keystore, key: {id: keyId}} = await helpers.generateKey(
-          {mockData, type: 'Sha256HmacKey2019'});
-        const operation = klona(mockData.operations.sign);
-        operation.invocationTarget = keyId;
-        operation.verifyData = uuid();
-        let result;
-        let error;
-        try {
-          result = await runOperation({operation, keystore, moduleManager});
-        } catch(e) {
-          error = e;
-        }
-        assertNoError(error);
-        should.exist(result);
-        result.should.be.an('object');
-        result.should.have.keys(['keyId', 'result']);
-        result.result.should.have.keys(['signatureValue']);
-        const {signatureValue} = result.result;
-        signatureValue.should.be.a('string');
-        signatureValue.should.have.length(43);
-      });
-    }); // end SignOperation
-
-    describe('VerifyOperation', () => {
-      it('verifies a string using Sha256HmacKey2019', async () => {
-        const verifyData = uuid();
-        const {keystore, key: {id: keyId}} = await helpers.generateKey(
-          {mockData, type: 'Sha256HmacKey2019'});
-        const signOperation = klona(mockData.operations.sign);
-        signOperation.invocationTarget = keyId;
-        signOperation.verifyData = verifyData;
-        const {result: {signatureValue}} = await runOperation(
-          {operation: signOperation, keystore, moduleManager});
-        const verifyOperation = klona(mockData.operations.verify);
-        verifyOperation.invocationTarget = keyId;
-        verifyOperation.verifyData = verifyData;
-        verifyOperation.signatureValue = signatureValue;
-        let result;
-        let error;
-        try {
-          result = await runOperation(
-            {operation: verifyOperation, keystore, moduleManager});
-        } catch(e) {
-          error = e;
-        }
-        assertNoError(error);
-        should.exist(result);
-        result.should.be.an('object');
-        result.should.have.keys(['keyId', 'result']);
-        result.result.should.have.keys(['verified']);
-        result.result.verified.should.be.true;
-      });
-    }); // end VerifyOperation
-  }); // end runOperation API
-}); // end bedrock-kms

package/test/mocha/30-bulk-operations.js

@@ -1,110 +0,0 @@
-/*!
- * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
- */
-import * as helpers from './helpers.js';
-import {createRequire} from 'module';
-import {defaultModuleManager as moduleManager} from '@bedrock/kms';
-import {klona} from 'klona';
-import {mockData} from './mock.data.js';
-import {v4 as uuid} from 'uuid';
-const require = createRequire(import.meta.url);
-const {runOperation} = require('@digitalbazaar/webkms-switch');
-
-describe('bulk operations', () => {
-  describe('Ed25519VerificationKey2020', () => {
-    let mockKeyId;
-    let keystore;
-    const operationCount = 10000;
-    const vData = [];
-    before(async () => {
-      for(let i = 0; i < operationCount; ++i) {
-        let v = '';
-        for(let n = 0; n < 100; ++n) {
-          v += uuid();
-        }
-        vData.push(v);
-      }
-    });
-    before(async () => {
-      let err;
-      try {
-        ({keystore, key: {id: mockKeyId}} = await helpers.generateKey(
-          {mockData, type: 'Ed25519VerificationKey2020'}));
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-    });
-    it(`performs ${operationCount} signatures`, async function() {
-      this.timeout(0);
-      const promises = [];
-      for(let i = 0; i < operationCount; ++i) {
-        const operation = klona(mockData.operations.sign);
-        operation.invocationTarget = mockKeyId;
-        operation.verifyData = vData[i];
-        promises.push(runOperation({
-          operation, keystore, moduleManager
-        }));
-      }
-      let result;
-      let err;
-      try {
-        result = await Promise.all(promises);
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      should.exist(result);
-      result.should.be.an('array');
-      result.should.have.length(operationCount);
-    });
-  });
-  describe('Sha256HmacKey2019', () => {
-    let mockKeyId;
-    let keystore;
-    const operationCount = 10000;
-    const vData = [];
-    before(async () => {
-      for(let i = 0; i < operationCount; ++i) {
-        let v = '';
-        for(let n = 0; n < 100; ++n) {
-          v += uuid();
-        }
-        vData.push(v);
-      }
-    });
-    before(async () => {
-      let err;
-      try {
-        ({keystore, key: {id: mockKeyId}} = await helpers.generateKey(
-          {mockData, type: 'Sha256HmacKey2019'}));
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-    });
-    it(`performs ${operationCount} signatures`, async function() {
-      this.timeout(0);
-      const promises = [];
-      for(let i = 0; i < operationCount; ++i) {
-        const operation = klona(mockData.operations.sign);
-        operation.invocationTarget = mockKeyId;
-        operation.verifyData = vData[i];
-        promises.push(runOperation({
-          operation, keystore, moduleManager
-        }));
-      }
-      let result;
-      let err;
-      try {
-        result = await Promise.all(promises);
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      should.exist(result);
-      result.should.be.an('array');
-      result.should.have.length(operationCount);
-    });
-  });
-});

package/test/mocha/40-database.js

@@ -1,95 +0,0 @@
-/*!
- * Copyright (c) 2018-2022 Digital Bazaar, Inc. All rights reserved.
- */
-import * as helpers from './helpers.js';
-import {keystores} from '@bedrock/kms';
-
-describe('Keystores Database Tests', () => {
-  describe('Indexes', async () => {
-    let mockConfigAlpha;
-    beforeEach(async () => {
-      await helpers.prepareDatabase();
-      mockConfigAlpha = {
-        id: 'https://example.com/keystores/' +
-          '8b688649-d546-4e88-9027-da434bac495a',
-        kmsModule: 'ssm-v1',
-        controller: 'caf40b44-0e66-44ef-b331-23f6ca0bb837',
-        sequence: 0,
-        meterId: '6fb34a1a-e26d-49bc-bd00-66873ab0d147'
-      };
-
-      const mockConfigBeta = {
-        id: 'https://example.com/keystores/' +
-          '6821b4ec-2630-4bf3-9464-39581d2c4499',
-        kmsModule: 'ssm-v1',
-        controller: 'caf40b44-0e66-44ef-b331-23f6ca0bb837',
-        sequence: 0,
-        meterId: '6fb34a1a-e26d-49bc-bd00-66873ab0d147'
-      };
-
-      await keystores.insert({config: mockConfigAlpha});
-      // second record is inserted here in order to do proper assertions for
-      // 'nReturned', 'totalKeysExamined' and 'totalDocsExamined'.
-      await keystores.insert({config: mockConfigBeta});
-    });
-    it(`is properly indexed for 'config.controller' in find()`, async () => {
-      // finds all records that match the 'config.controller' query since it is
-      // a non unique index.
-      const {executionStats} = await keystores.find({
-        controller: mockConfigAlpha.controller,
-        query: {},
-        explain: true
-      });
-      executionStats.nReturned.should.equal(2);
-      executionStats.totalKeysExamined.should.equal(2);
-      executionStats.totalDocsExamined.should.equal(2);
-      executionStats.executionStages.inputStage.stage.should.equal('IXSCAN');
-      executionStats.executionStages.inputStage.keyPattern
-        .should.eql({'config.controller': 1});
-    });
-    it(`is properly indexed for 'config.id' in update()`, async () => {
-      mockConfigAlpha.sequence += 1;
-      const {executionStats} = await keystores.update({
-        config: mockConfigAlpha,
-        explain: true
-      });
-      executionStats.nReturned.should.equal(1);
-      executionStats.totalKeysExamined.should.equal(1);
-      executionStats.totalDocsExamined.should.equal(1);
-      executionStats.executionStages.inputStage.inputStage.stage
-        .should.equal('IXSCAN');
-      executionStats.executionStages.inputStage.inputStage.keyPattern
-        .should.eql({'config.id': 1});
-    });
-    it(`is properly indexed for 'config.meterId' in getStorageUsage()`,
-      async () => {
-        // finds all records that match the 'config.meter' query since it is
-        // a non unique index.
-        const {executionStats} = await keystores.getStorageUsage({
-          meterId: mockConfigAlpha.meterId,
-          explain: true
-        });
-        executionStats.nReturned.should.equal(2);
-        executionStats.totalKeysExamined.should.equal(2);
-        executionStats.totalDocsExamined.should.equal(2);
-        executionStats.executionStages.inputStage.inputStage.stage
-          .should.equal('IXSCAN');
-        executionStats.executionStages.inputStage.inputStage.keyPattern
-          .should.eql({'config.meterId': 1});
-      });
-    it(`is properly indexed for 'config.id' in _getUncachedRecord()`,
-      async () => {
-        const {executionStats} = await keystores._getUncachedRecord({
-          id: mockConfigAlpha.id,
-          explain: true
-        });
-        executionStats.nReturned.should.equal(1);
-        executionStats.totalKeysExamined.should.equal(1);
-        executionStats.totalDocsExamined.should.equal(1);
-        executionStats.executionStages.inputStage.inputStage.inputStage.stage
-          .should.equal('IXSCAN');
-        executionStats.executionStages.inputStage.inputStage.inputStage
-          .keyPattern.should.eql({'config.id': 1});
-      });
-  });
-});

package/test/mocha/50-document-loader.js

@@ -1,40 +0,0 @@
-/*!
- * Copyright (c) 2021-2022 Digital Bazaar, Inc. All rights reserved.
- */
-import {defaultDocumentLoader as documentLoader} from '@bedrock/kms';
-
-describe('defaultDocumentLoader', () => {
-  it('returns a did document from the document loader', async () => {
-    const url = 'did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH';
-
-    let err;
-    let result;
-    try {
-      result = await documentLoader(url);
-    } catch(e) {
-      err = e;
-    }
-
-    should.exist(result);
-    should.not.exist(err);
-    result.should.have.keys(['contextUrl', 'documentUrl', 'document']);
-    result.documentUrl.should.equal(url);
-  });
-
-  it('throws NotFoundError on document not found', async () => {
-    const url = 'https://example.com/foo.jsonld';
-
-    let err;
-    let result;
-    try {
-      result = await documentLoader(url);
-    } catch(e) {
-      err = e;
-    }
-
-    should.not.exist(result);
-    should.exist(err);
-    err.should.be.instanceOf(Error);
-    err.message.should.contain(url);
-  });
-});

package/test/mocha/cryptoLd.js

@@ -1,22 +0,0 @@
-/*!
- * Copyright (c) 2021-2022 Digital Bazaar, Inc. All rights reserved.
- */
-import {createRequire} from 'node:module';
-const require = createRequire(import.meta.url);
-const {CryptoLD} = require('crypto-ld');
-const {Ed25519VerificationKey2018} =
-  require('@digitalbazaar/ed25519-verification-key-2018');
-const {Ed25519VerificationKey2020} =
-  require('@digitalbazaar/ed25519-verification-key-2020');
-const {X25519KeyAgreementKey2019} =
-  require('@digitalbazaar/x25519-key-agreement-key-2019');
-const {X25519KeyAgreementKey2020} =
-  require('@digitalbazaar/x25519-key-agreement-key-2020');
-
-const cryptoLd = new CryptoLD();
-cryptoLd.use(Ed25519VerificationKey2018);
-cryptoLd.use(Ed25519VerificationKey2020);
-cryptoLd.use(X25519KeyAgreementKey2019);
-cryptoLd.use(X25519KeyAgreementKey2020);
-
-export {cryptoLd};

package/test/mocha/helpers.js

@@ -1,44 +0,0 @@
-/*!
- * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
- */
-import * as brKms from '@bedrock/kms';
-import * as database from '@bedrock/mongodb';
-import {createRequire} from 'node:module';
-import {klona} from 'klona';
-const require = createRequire(import.meta.url);
-const {runOperation} = require('@digitalbazaar/webkms-switch');
-const {generateId} = require('bnid');
-
-export async function generateKey({mockData, type}) {
-  // create a keystore
-  const mockKeystoreId = `https://example.com/keystore/${await generateId()}`;
-  const keystore = {
-    id: mockKeystoreId,
-    controller: 'urn:foo',
-    kmsModule: 'ssm-v1',
-    sequence: 0,
-  };
-  await brKms.keystores.insert({config: keystore});
-
-  const keyId = `${mockKeystoreId}/keys/${await generateId()}`;
-  const operation = klona(mockData.operations.generate({type}));
-  operation.invocationTarget.id = keyId;
-  operation.invocationTarget.type = type;
-  const moduleManager = brKms.defaultModuleManager;
-  const {result} = await runOperation({operation, keystore, moduleManager});
-  return {
-    keystore,
-    key: result.keyDescription
-  };
-}
-
-export async function prepareDatabase() {
-  await removeCollections();
-}
-
-export async function removeCollections(collectionNames = ['kms-keystore']) {
-  await database.openCollections(collectionNames);
-  for(const collectionName of collectionNames) {
-    await database.collections[collectionName].deleteMany({});
-  }
-}