@bedrock/kms 9.0.0 → 10.2.0

package/.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
     timeout-minutes: 10
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [16.x]
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}
@@ -24,12 +24,12 @@ jobs:
     timeout-minutes: 10
     services:
       mongodb:
-        image: mongo:4.2
+        image: mongo:4.4
         ports:
           - 27017:27017
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [14.x, 16.x]
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}
@@ -50,12 +50,12 @@ jobs:
     timeout-minutes: 10
     services:
       mongodb:
-        image: mongo:4.2
+        image: mongo:4.4
         ports:
           - 27017:27017
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [16.x]
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # bedrock-kms ChangeLog
 
+## 10.2.0 - 2022-05-13
+
+### Added
+- Expose `_disableClearCacheOnUpdate` for testing cache busting only; do not use in
+  production.
+
+## 10.1.0 - 2022-05-13
+
+### Added
+- Add `fresh` option to `keystores.get()` API to allow for retrieving a fresh
+  (not previously cached) keystore config record.
+
+## 10.0.0 - 2022-04-29
+
+### Changed
+- **BREAKING**: Update peer deps:
+  - `@bedrock/core@6`.
+  - `@bedrock/did-context@4`
+  - `@bedrock/did-io@8`
+  - `@bedrock/jsonld-document-loader@3`
+  - `@bedrock/mongodb@10`
+  - `@bedrock/package-manager@3`
+  - `@bedrock/security-context@7`
+  - `@bedrock/veres-one-context@14`.
+
 ## 9.0.0 - 2022-04-05
 
 ### Changed

package/lib/keystores.js

@@ -5,7 +5,7 @@ import * as bedrock from '@bedrock/core';
 import * as database from '@bedrock/mongodb';
 import assert from 'assert-plus';
 import pAll from 'p-all';
-import {createRequire} from 'module';
+import {createRequire} from 'node:module';
 const require = createRequire(import.meta.url);
 const {LruCache} = require('@digitalbazaar/lru-memoize');
 
@@ -16,6 +16,10 @@ import './config.js';
 
 const USAGE_COUNTER_MAX_CONCURRENCY = 100;
 let KEYSTORE_CONFIG_CACHE;
+let DISABLE_CLEAR_CACHE_ON_UPDATE = false;
+
+// cache only exported for testing purposes
+export {KEYSTORE_CONFIG_CACHE as _KEYSTORE_CONFIG_CACHE};
 
 bedrock.events.on('bedrock.init', async () => {
   const cfg = bedrock.config.kms;
@@ -100,8 +104,7 @@ export async function insert({config} = {}) {
     config
   };
   try {
-    const result = await database.collections['kms-keystore'].insertOne(
-      record, database.writeOptions);
+    const result = await database.collections['kms-keystore'].insertOne(record);
     return result.ops[0];
   } catch(e) {
     if(!database.isDuplicateError(e)) {
@@ -180,7 +183,7 @@ export async function update({config, explain = false} = {}) {
       config,
       'meta.updated': Date.now()
     }
-  }, database.writeOptions);
+  });
 
   if(result.result.n === 0) {
     // no records changed...
@@ -196,8 +199,10 @@ export async function update({config, explain = false} = {}) {
       });
   }
 
-  // delete record from cache
-  KEYSTORE_CONFIG_CACHE.delete(config.id);
+  if(!DISABLE_CLEAR_CACHE_ON_UPDATE) {
+    // delete record from cache
+    KEYSTORE_CONFIG_CACHE.delete(config.id);
+  }
 
   return true;
 }
@@ -207,11 +212,16 @@ export async function update({config, explain = false} = {}) {
  *
  * @param {object} options - The options to use.
  * @param {string} options.id - The ID of the keystore.
+ * @param {boolean} [options.fresh=false] - False if it is safe to use a
+ *   potentially cached value, true to always get a fresh value.
  *
  * @returns {Promise<object>} Resolves to `{config, meta}`.
  */
-export async function get({id} = {}) {
+export async function get({id, fresh = false} = {}) {
   assert.string(id, 'id');
+  if(fresh) {
+    KEYSTORE_CONFIG_CACHE.delete(id);
+  }
   const fn = () => _getUncachedRecord({id});
   return KEYSTORE_CONFIG_CACHE.memoize({key: id, fn});
 }
@@ -328,3 +338,8 @@ export async function _getUncachedRecord({id, explain = false} = {}) {
   }
   return record;
 }
+
+// exported for testing purposes
+export function _disableClearCacheOnUpdate(disable) {
+  DISABLE_CLEAR_CACHE_ON_UPDATE = disable;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrock/kms",
-  "version": "9.0.0",
+  "version": "10.2.0",
   "type": "module",
   "description": "Key management for Bedrock applications",
   "main": "./lib/index.js",
@@ -31,14 +31,14 @@
     "p-all": "^4.0.0"
   },
   "peerDependencies": {
-    "@bedrock/core": "^5.0.0",
-    "@bedrock/did-context": "^3.0.0",
-    "@bedrock/did-io": "^7.0.0",
-    "@bedrock/jsonld-document-loader": "^2.0.0",
-    "@bedrock/mongodb": "^9.0.0",
-    "@bedrock/package-manager": "^2.0.0",
-    "@bedrock/security-context": "^6.0.0",
-    "@bedrock/veres-one-context": "^13.0.0"
+    "@bedrock/core": "^6.0.0",
+    "@bedrock/did-context": "^4.0.0",
+    "@bedrock/did-io": "^8.0.0",
+    "@bedrock/jsonld-document-loader": "^3.0.0",
+    "@bedrock/mongodb": "^10.0.0",
+    "@bedrock/package-manager": "^3.0.0",
+    "@bedrock/security-context": "^7.0.0",
+    "@bedrock/veres-one-context": "^14.0.0"
   },
   "directories": {
     "lib": "./lib"

package/test/mocha/13-keystores-update-api.js

@@ -1,9 +1,8 @@
 /*!
  * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
  */
-import * as bedrock from '@bedrock/core';
 import {keystores} from '@bedrock/kms';
-const {util: {clone}} = bedrock;
+import {klona} from 'klona';
 
 describe('keystores APIs', () => {
   const mockConfigAlpha = {
@@ -25,6 +24,12 @@ describe('keystores APIs', () => {
     controller: 'f2da13ee-50d2-46ab-865d-ee23d609edbd',
     sequence: 0,
   };
+  const mockConfigDelta = {
+    id: 'https://example.com/keystores/f9da6f23-6e13-42e9-88d3-5c03011ecbbf',
+    kmsModule: 'ssm-v1',
+    controller: '17e77da1-bb7e-4fe2-b4dd-1c4bba933d7c',
+    sequence: 0,
+  };
 
   before(async () => {
     let err;
@@ -32,6 +37,7 @@ describe('keystores APIs', () => {
       await keystores.insert({config: mockConfigAlpha});
       await keystores.insert({config: mockConfigBeta});
       await keystores.insert({config: mockConfigGamma});
+      await keystores.insert({config: mockConfigDelta});
     } catch(e) {
       err = e;
     }
@@ -53,7 +59,7 @@ describe('keystores APIs', () => {
     it('successfully updates a keystore', async () => {
       let err;
       let result;
-      const config = clone(mockConfigAlpha);
+      const config = klona(mockConfigAlpha);
       config.sequence++;
       config.controller = 'someOtherController';
       try {
@@ -68,7 +74,7 @@ describe('keystores APIs', () => {
     it('successfully updates a keystore twice', async () => {
       let err;
       let result;
-      const config = clone(mockConfigBeta);
+      const config = klona(mockConfigBeta);
       config.sequence++;
       config.controller = 'someOtherController';
       try {
@@ -94,10 +100,43 @@ describe('keystores APIs', () => {
       result.should.be.a('boolean');
       result.should.be.true;
     });
+    it('successfully updates a keystore and gets a fresh value', async () => {
+      const config = klona(mockConfigDelta);
+
+      // get keystore config to prime cache
+      await keystores.get({id: config.id});
+
+      // now update config
+      let err;
+      let result;
+      config.sequence++;
+      config.controller = 'someOtherController';
+      const oldDelete = keystores._KEYSTORE_CONFIG_CACHE.delete;
+      try {
+        // remove cache delete functionality to test fresh API
+        keystores._KEYSTORE_CONFIG_CACHE.delete = () => {};
+        result = await keystores.update({config});
+      } catch(e) {
+        err = e;
+      } finally {
+        keystores._KEYSTORE_CONFIG_CACHE.delete = oldDelete;
+      }
+      assertNoError(err);
+      result.should.be.a('boolean');
+      result.should.be.true;
+
+      // get keystore config, should be stale
+      const stale = await keystores.get({id: config.id});
+      stale.config.controller.should.not.equal(config.controller);
+
+      // get fresh config
+      const fresh = await keystores.get({id: config.id, fresh: true});
+      fresh.config.controller.should.equal(config.controller);
+    });
     it('fails to updates a keystore using wrong sequence number', async () => {
       let err;
       let result;
-      const config = clone(mockConfigGamma);
+      const config = klona(mockConfigGamma);
       config.sequence++;
       config.controller = 'someOtherController';
       try {
@@ -129,7 +168,7 @@ describe('keystores APIs', () => {
     it('successfully updates a keystore and invalidates cache', async () => {
       let err;
       let result;
-      const config = clone(mockConfigBeta);
+      const config = klona(mockConfigBeta);
       config.sequence = 3;
       config.controller = 'someOtherController';
       try {
@@ -147,7 +186,7 @@ describe('keystores APIs', () => {
     it('throws error on unknown keystore id', async () => {
       let err;
       let result;
-      const config = clone(mockConfigBeta);
+      const config = klona(mockConfigBeta);
       config.sequence++;
       config.id = 'someOtherId';
       try {

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

@@ -1,16 +1,15 @@
 /*!
  * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
  */
-import * as bedrock from '@bedrock/core';
 import * as helpers from './helpers.js';
-import {createRequire} from 'module';
+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');
 
-const {util: {clone, uuid}} = bedrock;
-
 describe('bedrock-kms', () => {
   describe('integration with runOperation API', () => {
     describe('GenerateKeyOperation', () => {
@@ -20,7 +19,7 @@ describe('bedrock-kms', () => {
           controller: 'urn:uuid:baa943d2-7338-11ec-b1c4-10bf48838a41',
           kmsModule: 'ssm-v1'
         };
-        const operation = clone(
+        const operation = klona(
           mockData.operations.generate({type: 'Ed25519VerificationKey2018'}));
         operation.invocationTarget.type = 'Ed25519VerificationKey2018';
         let error;
@@ -46,7 +45,7 @@ describe('bedrock-kms', () => {
           controller: 'urn:uuid:baa943d2-7338-11ec-b1c4-10bf48838a41',
           kmsModule: 'ssm-v1'
         };
-        const operation = clone(
+        const operation = klona(
           mockData.operations.generate({type: 'Ed25519VerificationKey2020'}));
         operation.invocationTarget.type = 'Ed25519VerificationKey2020';
         let error;
@@ -72,7 +71,7 @@ describe('bedrock-kms', () => {
           controller: 'urn:uuid:baa943d2-7338-11ec-b1c4-10bf48838a41',
           kmsModule: 'ssm-v1'
         };
-        const operation = clone(
+        const operation = klona(
           mockData.operations.generate({type: 'Sha256HmacKey2019'}));
         operation.invocationTarget.type = 'Sha256HmacKey2019';
         let error;
@@ -97,7 +96,7 @@ describe('bedrock-kms', () => {
           controller: 'urn:uuid:baa943d2-7338-11ec-b1c4-10bf48838a41',
           kmsModule: 'ssm-v1'
         };
-        const operation = clone(
+        const operation = klona(
           mockData.operations.generate({type: 'AesKeyWrappingKey2019'}));
         operation.invocationTarget.type = 'AesKeyWrappingKey2019';
         let error;
@@ -122,7 +121,7 @@ describe('bedrock-kms', () => {
           controller: 'urn:uuid:baa943d2-7338-11ec-b1c4-10bf48838a41',
           kmsModule: 'ssm-v1'
         };
-        const operation = clone(
+        const operation = klona(
           mockData.operations.generate({type: 'AesKeyWrappingKey2019'}));
         operation.invocationTarget.type = 'UnknownKeyType';
         let error;
@@ -142,7 +141,7 @@ describe('bedrock-kms', () => {
       it('signs a string using Ed25519VerificationKey2018', async () => {
         const {keystore, key: {id: keyId}} = await helpers.generateKey(
           {mockData, type: 'Ed25519VerificationKey2018'});
-        const operation = clone(mockData.operations.sign);
+        const operation = klona(mockData.operations.sign);
         operation.invocationTarget = keyId;
         operation.verifyData = uuid();
         let result;
@@ -164,7 +163,7 @@ describe('bedrock-kms', () => {
       it('signs a string using Ed25519VerificationKey2020', async () => {
         const {keystore, key: {id: keyId}} = await helpers.generateKey(
           {mockData, type: 'Ed25519VerificationKey2020'});
-        const operation = clone(mockData.operations.sign);
+        const operation = klona(mockData.operations.sign);
         operation.invocationTarget = keyId;
         operation.verifyData = uuid();
         let result;
@@ -186,7 +185,7 @@ describe('bedrock-kms', () => {
       it('signs a string using Sha256HmacKey2019', async () => {
         const {keystore, key: {id: keyId}} = await helpers.generateKey(
           {mockData, type: 'Sha256HmacKey2019'});
-        const operation = clone(mockData.operations.sign);
+        const operation = klona(mockData.operations.sign);
         operation.invocationTarget = keyId;
         operation.verifyData = uuid();
         let result;
@@ -212,12 +211,12 @@ describe('bedrock-kms', () => {
         const verifyData = uuid();
         const {keystore, key: {id: keyId}} = await helpers.generateKey(
           {mockData, type: 'Sha256HmacKey2019'});
-        const signOperation = clone(mockData.operations.sign);
+        const signOperation = klona(mockData.operations.sign);
         signOperation.invocationTarget = keyId;
         signOperation.verifyData = verifyData;
         const {result: {signatureValue}} = await runOperation(
           {operation: signOperation, keystore, moduleManager});
-        const verifyOperation = clone(mockData.operations.verify);
+        const verifyOperation = klona(mockData.operations.verify);
         verifyOperation.invocationTarget = keyId;
         verifyOperation.verifyData = verifyData;
         verifyOperation.signatureValue = signatureValue;

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

@@ -1,16 +1,15 @@
 /*!
  * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
  */
-import * as bedrock from '@bedrock/core';
 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');
 
-const {util: {clone, uuid}} = bedrock;
-
 describe('bulk operations', () => {
   describe('Ed25519VerificationKey2020', () => {
     let mockKeyId;
@@ -40,7 +39,7 @@ describe('bulk operations', () => {
       this.timeout(0);
       const promises = [];
       for(let i = 0; i < operationCount; ++i) {
-        const operation = clone(mockData.operations.sign);
+        const operation = klona(mockData.operations.sign);
         operation.invocationTarget = mockKeyId;
         operation.verifyData = vData[i];
         promises.push(runOperation({
@@ -88,7 +87,7 @@ describe('bulk operations', () => {
       this.timeout(0);
       const promises = [];
       for(let i = 0; i < operationCount; ++i) {
-        const operation = clone(mockData.operations.sign);
+        const operation = klona(mockData.operations.sign);
         operation.invocationTarget = mockKeyId;
         operation.verifyData = vData[i];
         promises.push(runOperation({

package/test/mocha/cryptoLd.js

@@ -1,7 +1,7 @@
 /*!
  * Copyright (c) 2021-2022 Digital Bazaar, Inc. All rights reserved.
  */
-import {createRequire} from 'module';
+import {createRequire} from 'node:module';
 const require = createRequire(import.meta.url);
 const {CryptoLD} = require('crypto-ld');
 const {Ed25519VerificationKey2018} =

package/test/mocha/helpers.js

@@ -1,16 +1,14 @@
 /*!
  * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
  */
-import * as bedrock from '@bedrock/core';
 import * as brKms from '@bedrock/kms';
 import * as database from '@bedrock/mongodb';
-import {createRequire} from 'module';
+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');
 
-const {util: {clone}} = bedrock;
-
 export async function generateKey({mockData, type}) {
   // create a keystore
   const mockKeystoreId = `https://example.com/keystore/${await generateId()}`;
@@ -23,7 +21,7 @@ export async function generateKey({mockData, type}) {
   await brKms.keystores.insert({config: keystore});
 
   const keyId = `${mockKeystoreId}/keys/${await generateId()}`;
-  const operation = clone(mockData.operations.generate({type}));
+  const operation = klona(mockData.operations.generate({type}));
   operation.invocationTarget.id = keyId;
   operation.invocationTarget.type = type;
   const moduleManager = brKms.defaultModuleManager;

package/test/package.json

@@ -11,19 +11,19 @@
     "coverage-report": "c8 report"
   },
   "dependencies": {
-    "@bedrock/core": "^5.0.0",
-    "@bedrock/did-context": "^3.0.0",
-    "@bedrock/did-io": "^7.0.0",
-    "@bedrock/https-agent": "^3.0.0",
-    "@bedrock/jsonld-document-loader": "^2.0.0",
+    "@bedrock/core": "^6.0.0",
+    "@bedrock/did-context": "^4.0.0",
+    "@bedrock/did-io": "^8.0.0",
+    "@bedrock/https-agent": "^4.0.0",
+    "@bedrock/jsonld-document-loader": "^3.0.0",
     "@bedrock/kms": "file:..",
-    "@bedrock/ledger-context": "^22.0.0",
-    "@bedrock/mongodb": "^9.0.0",
-    "@bedrock/package-manager": "^2.0.0",
-    "@bedrock/security-context": "^6.0.0",
-    "@bedrock/ssm-mongodb": "^8.0.1",
-    "@bedrock/test": "^7.0.0",
-    "@bedrock/veres-one-context": "^13.0.0",
+    "@bedrock/ledger-context": "^23.0.0",
+    "@bedrock/mongodb": "^10.0.0",
+    "@bedrock/package-manager": "^3.0.0",
+    "@bedrock/security-context": "^7.0.0",
+    "@bedrock/ssm-mongodb": "^9.0.0",
+    "@bedrock/test": "^8.0.0",
+    "@bedrock/veres-one-context": "^14.0.0",
     "@digitalbazaar/ed25519-verification-key-2018": "^3.1.1",
     "@digitalbazaar/ed25519-verification-key-2020": "^3.1.0",
     "@digitalbazaar/webkms-context": "^2.0.0",
@@ -35,7 +35,9 @@
     "c8": "^7.11.0",
     "cross-env": "^7.0.3",
     "crypto-ld": "^6.0.0",
-    "sha256-hmac-key-2019-context": "^1.0.3"
+    "klona": "^2.0.5",
+    "sha256-hmac-key-2019-context": "^1.0.3",
+    "uuid": "^8.3.2"
   },
   "c8": {
     "excludeNodeModules": false,

package/test/test.config.js

@@ -2,8 +2,8 @@
  * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
  */
 import {config} from '@bedrock/core';
-import {fileURLToPath} from 'url';
-import path from 'path';
+import {fileURLToPath} from 'node:url';
+import path from 'node:path';
 import '@bedrock/mongodb';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));