@bedrock/kms-http 13.0.0

package/.eslintrc.cjs

@@ -0,0 +1,12 @@
+module.exports = {
+  root: true,
+  parserOptions: {
+    // this is required for dynamic import()
+    ecmaVersion: 2020
+  },
+  env: {
+    node: true
+  },
+  extends: ['digitalbazaar', 'digitalbazaar/jsdoc'],
+  ignorePatterns: ['node_modules/']
+};

package/.github/workflows/main.yml

@@ -0,0 +1,103 @@
+name: Bedrock Node.js CI
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        node-version: [14.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - name: Run eslint
+      run: npm run lint
+  test-node:
+    needs: [lint]
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    services:
+      mongodb:
+        image: mongo:4.2
+        ports:
+          - 27017:27017
+    strategy:
+      matrix:
+        node-version: [14.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: |
+        npm install
+        cd test
+        npm install
+    - name: Run test with Node.js ${{ matrix.node-version }}
+      run: |
+        cd test
+        npm run test-node
+  test-karma:
+    needs: [test-node]
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    services:
+      mongodb:
+        image: mongo:4.2
+        ports:
+          - 27017:27017
+    strategy:
+      matrix:
+        node-version: [14.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: |
+        npm install
+        cd test
+        npm install
+    - name: Run test with Node.js ${{ matrix.node-version }}
+      run: |
+        cd test
+        npm run test-karma
+  coverage:
+    needs: [test-karma]
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    services:
+      mongodb:
+        image: mongo:4.2
+        ports:
+          - 27017:27017
+    strategy:
+      matrix:
+        node-version: [14.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: |
+        npm install
+        cd test
+        npm install
+    - name: Generate coverage report
+      run: |
+        cd test
+        npm run coverage-ci
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2
+      with:
+        file: ./test/coverage/lcov.info
+        fail_ci_if_error: true

package/CHANGELOG.md

@@ -0,0 +1,332 @@
+# bedrock-kms-http ChangeLog
+
+## 13.0.0 - 2022-04-05
+
+### Changed
+- **BREAKING**: Rename package to `@bedrock/kms-http`.
+- **BREAKING**: Convert to module (ESM).
+- **BREAKING**: Remove default export.
+- **BREAKING**: Require node 14.x.
+
+## 12.1.0 - 2022-03-29
+
+### Changed
+- Update peer deps:
+  - `bedrock@4.5`
+  - `bedrock-express@6.4.1`
+  - `bedrock-kms@8.3.0`
+  - `bedrock-validation@5.6.3`
+  - `bedrock-zcap-storage@5.2`.
+- Update internals to use esm style and use `esm.js` to
+  transpile to CommonJS.
+
+### Removed
+- Remove unused peer deps:
+  - `bedrock-server`
+  - `bedrock-jsonld-document-loader`
+  - `bedrock-mongodb`.
+
+## 12.0.1 - 2022-03-03
+
+### Fixed
+- Use `@digitalbazaar/webkms-switch@10` to be consistent with
+  `@digitalbazaar/ezcap-express@6` and other breaking changes
+  in this major version.
+
+## 12.0.0 - 2022-03-01
+
+### Changed
+- **BREAKING**: Move zcap revocations to `/zcaps/revocations` to better
+  future proof.
+- **BREAKING**: Use `@digitalbazaar/ezcap-express@6`.
+- **BREAKING**: This version is compatible with
+  `@digitalbazaar/webkms-client@10`.
+
+## 11.3.1 - 2022-02-12
+
+### Changed
+- Improve internal implementation of JSON schema validators.
+
+## 11.3.0 - 2022-02-10
+
+### Changed
+- Use `bedrock-validation@5.4` with better schema compilation.
+
+## 11.2.0 - 2022-02-08
+
+### Added
+- Allow KMS operations to be configured via config system and
+  set defaults to allow long-lived zcaps.
+
+## 11.1.1 - 2022-01-20
+
+### Fixed
+- Do not expose details from errors that aren't marked public.
+
+## 11.1.0 - 2022-01-14
+
+### Added
+- Use webkms-switch@9.1 to enable passing `zcapInvocation` to KMS
+  modules. This enables KMS modules to disallow key operations based
+  on zcap invocation information, if desired.
+
+## 11.0.0 - 2022-01-11
+
+### Changed
+- **BREAKING**: Use ezcap-express@5 and webkms-switch@9. These changes
+  include major breaking simplifications to ZCAP (zcap@7).
+
+## 10.2.0 - 2021-12-11
+
+### Added
+- Add tests and update `README.md`.
+
+### Changed
+- Require ezcap-express 4.3.x.
+
+## 10.1.3 - 2021-12-10
+
+### Fixed
+- Combined duplicate error code paths to simplify; the relevant code ensures
+  that when a client sends a keystore config with an ID that does not match
+  the config ID in the request URL, an exception will be thrown.
+
+## 10.1.2 - 2021-12-09
+
+### Fixed
+- Load keystore config for a particular request only once to create more
+  consistent behavior. Multiple retrievals of the same keystore config during
+  the lifetime of a request may result in loading different configs without
+  this patch. This patch makes behavior more consistent by reusing the same
+  loaded keystore config for the entire request. Note that there is a change
+  to an assertion in a test on a returned error, however, that error was
+  not going to be consistent in previous versions regardless. This fix makes
+  it more consistent.
+
+## 10.1.1 - 2021-11-24
+
+### Fixed
+- Fix bug in meter usage aggregation.
+
+## 10.1.0 - 2021-11-23
+
+### Added
+- Do not allow zcap revocations to be stored if the meter associated with
+  a keystore has been disabled. Storage of zcap revocations is permitted if
+  there is no available storage to prevent potential security issues, however,
+  the meter MUST not be disabled to make use of this feature. Very robust
+  rate limiting MUST be applied to the revocation submission endpoint in
+  a deployment to avoid significant storage overflow.
+
+## 10.0.0 - 2021-10-07
+
+### Changed
+- **BREAKING**: Use `webkms-switch@8` which changes the way key IDs are
+  generated. See the [changelog](https://github.com/digitalbazaar/webkms-switch/blob/main/CHANGELOG.md).
+
+## 9.0.0 - 2021-09-02
+
+### Changed
+- **BREAKING**: Use bedrock-meter-usage-reporter@4. This new version now
+  requires bedrock-app-identity to configure the identity for webkms
+  applications.
+
+## 8.0.1 - 2021-09-01
+
+### Fixed
+- Do not allow meter ID to be changed when updating keystore config as
+  the keystore controller has insufficient authority to do so. This
+  may be enabled in the future by requiring the root zcap controller
+  to be the meter controller when changing the meter ID.
+
+## 8.0.0 - 2021-08-31
+
+### Changed
+- **BREAKING**: Use bedrock-meter-usage-reporter@3. This new version simplifies
+  meter usage zcap management by eliminating the need for a delegated zcap
+  to allow reporting meter usage. Instead, the KMS service is the root
+  controller for the meter usage endpoint for any meter that is specifically
+  created and coupled to it.
+- **BREAKING**: Creating a keystore now requires sending only the full URL
+  `meterId` for a meter, not a meter capability. The meter will be presumed
+  to be coupled to the KMS service -- and this will be confirmed via a call
+  to retrieve the meter information.
+
+## 7.1.0 - 2021-08-26
+
+### Changed
+- Use ezcap-express@4.2 to provide zcap revocation authorization implementation.
+  Remove dependencies that are no longer needed because of this upgrade.
+
+## 7.0.1 - 2021-08-18
+
+### Fixed
+- Ensure promise settles before returning key description.
+
+## 7.0.0 - 2021-08-17
+
+### Changed
+- **BREAKING**: Updated to work with bedrock-meter-usage-reporter 2.x. This
+  new version enables applications to bundle the webkms service with other
+  services instead of requiring a microservices deployment architecture.
+
+## 6.1.0 - 2021-07-23
+
+### Changed
+- Update peer dependencies; use bedrock-did-io@4.
+
+## 6.0.0 - 2021-07-22
+
+### Added
+- **BREAKING** - Add storage and operation metering support. A meter capability
+  must be provided to create a new keystore. This capability will be used to
+  report keystore storage and operation usage to the associated meter.
+
+### Changed
+- **BREAKING**: Require `expires` to be set on delegated zcaps.
+- **BREAKING**: Use updated bedrock-kms.
+- **BREAKING**: Simplify zcap revocation model. Now any party that has been delegated a zcap can
+  send it to a revocation address: `<keystoreId>/revocations/<zcap ID>` without needing to have an
+  additional zcap delegated to that party. The party must invoke the root zcap for that endpoint,
+  which will be dynamically generated and use the delegator of the zcap as the controller, i.e., the
+  delegator must invoke this root zcap to revoke the zcap they delegated.
+
+### Removed
+- **BREAKING**: Remove `did-io`, `did-method-key`, and
+  `did-veres-one` from deps and use `bedrock-did-io`.
+- **BREAKING**: Remove query endpoint. It was unused and a new design would need to
+  be introduced in the future that properly handles authz.
+
+## 5.0.0 - 2021-05-20
+
+### Changed
+- **BREAKING**: Remove `ed25519-signature-2018` signature suite and use
+  `ed25519-signature-2020`.
+- Remove `did-io`, `did-method-key`, and `did-veres-one` from deps and use
+  `bedrock-did-io`.
+- Update peerDeps and deps
+  - [@digitalbazaar/ed25519-signature-2020@2.1.0](https://github.com/digitalbazaar/ed25519-signature-2020/blob/main/CHANGELOG.md)
+  - [@digitalbazaar/ezcap-express@3.0.1](https://github.com/digitalbazaar/ezcap-express/blob/main/CHANGELOG.md)
+  - [@digitalbazaar/zcapld@4.0.0](https://github.com/digitalbazaar/zcapld/blob/main/CHANGELOG.md)
+  - [http-signature-zcap-verify@7.1.0](https://github.com/digitalbazaar/http-signature-zcap-verify/blob/main/CHANGELOG.md)
+  - [jsonld-signatures@9.0.2](https://github.com/digitalbazaar/jsonld-signatures/blob/master/CHANGELOG.md)
+  - [webkms-switch@5.0.0](https://github.com/digitalbazaar/webkms-switch/blob/main/CHANGELOG.md)
+  - [bedrock-kms@6.0.0](https://github.com/digitalbazaar/bedrock-kms/blob/master/CHANGELOG.md)
+  - [bedrock-did-io@2.0.0](https://github.com/digitalbazaar/bedrock-did-io/blob/main/CHANGELOG.md)
+- Update test deps
+
+### Added
+- Keystore configurations may now include an optional `ipAllowList` array. If
+  specified, the KMS system will only execute requests originating from IPs
+  listed in `ipAllowList`. This applies to key operations for all keys in the
+  keystore as well as modification of the configuration itself.
+
+## 4.0.0 - 2021-03-02
+
+### Added
+- **BREAKING**: Implement ZCAP authz on the keystore config update API.
+
+### Changed
+- **BREAKING**: Drop Node 10.x support.
+- **BREAKING**: Change data model and validation of keystore configs. Configs
+  no longer include `invoker` or `delegator` properties.
+
+## 3.2.0 - 2021-02-10
+
+### Added
+- Added validators to `keystore`, `keystores`, `authorizations`, and
+  `zcaps` endpoints.
+- Improve test coverage.
+
+## 3.1.0 - 2021-01-12
+
+### Changed
+- Update bedrock-account@5.0
+
+## 3.0.0 - 2020-09-22
+
+### Changed
+- **BREAKING**: Do not look up zcaps in authorizations collection;
+  full zcap chain must be submitted. A future feature may involve
+  ensuring that zcaps for certain keys are present in the
+  authorizations collection as an added security measure, but
+  those zcaps would still need to be submitted at invocation.
+
+## 2.3.0 - 2020-06-30
+
+### Changed
+- Update peerDependencies to include bedrock-account@4.
+- Update test deps.
+- Update CI workflow.
+
+## 2.2.0 - 2020-06-19
+
+### Added
+- Improve test coverage.
+
+### Changed
+- Update peer deps.
+- Improve error handling in `_verifyHost` helper.
+
+## 2.1.0 - 2020-05-15
+
+### Added
+- Add CORS support for key ops.
+
+### Changed
+- Use bedrock-kms@2.1.0.
+
+## 2.0.0 - 2020-04-02
+
+### Added
+- Create expectedRootCapability for revocations.
+
+### Changed
+- **BREAKING**: Use webkms-switch@2.
+- **BREAKING**: Use http-signature-zcap-verify@3.
+
+## 1.2.1 - 2020-02-27
+
+### Fixed
+- Fix syntax error/typo.
+
+## 1.2.0 - 2020-02-26
+
+### Added
+- Revocations API.
+
+### Changed
+- Use jsonld-signatures@5.
+
+## 1.1.3 - 2020-01-22
+
+### Fixed
+- Add missing jsonld-sigatures dep.
+
+## 1.1.2 - 2020-01-12
+
+### Fixed
+- Ensure local zcap storage is checked for invoked zcaps.
+
+## 1.1.1 - 2020-01-12
+
+### Fixed
+- Ensure local zcap storage is checked for parent zcaps.
+
+## 1.1.0 - 2020-01-11
+
+### Added
+- Support delegation by non-root controllers provided that `delegator`
+  is set in the zcap.
+
+## 1.0.1 - 2019-12-20
+
+### Fixed
+- Fixed typo in module import.
+
+## 1.0.0 - 2019-12-20
+
+### Added
+- Added core files.
+
+- See git history for changes.

package/LICENSE.md

@@ -0,0 +1,115 @@
+Bedrock Non-Commercial License v1.0
+===================================
+
+Copyright (c) 2011-2021 Digital Bazaar, Inc.
+All rights reserved.
+
+Summary
+=======
+
+This license allows the licensee to use Bedrock and its software modules
+for non-commercial purposes such as self-study, research, personal
+projects, or for evaluation purposes. If the licensee uses Bedrock
+directly or indirectly to generate revenue, or to provide products or
+services to more than 500 people (users), the licensee must immediately
+obtain a non-profit or commercial license.
+
+Examples
+========
+
+These are examples of cases that are allowed by this license:
+
+* The licensee is an individual that creates Bedrock-dependent software for
+  personal use only.
+* The licensee is an individual or group of students/researchers that uses
+  Bedrock to experiment with an idea for a non-commercial project.
+* The licensee is a startup company that prototypes a Bedrock-dependent
+  product before they have cash flow and will be testing the prototype
+  software with less than 500 users. The service will not generate revenue
+  of any kind.
+* The licensee is a for-profit organization that creates a product or
+  service that is used by less than 500 users and is built with or
+  integrates with Bedrock. The service must be exclusively provided for free
+  and no parent, subsidiary, agent, or affiliate organization may profit
+  from its use.
+
+These cases require a non-profit or commercial license:
+
+* The licensee is a non-profit that receives funding to create and/or run a
+  Bedrock-dependent service.
+* The licensee is a startup company with Bedrock-dependent software that is
+  funded by another organization.
+* The licensee is a startup company that is going into production with
+  Bedrock-dependent software.
+* The licensee has more than 500 users using a Bedrock-dependent service
+  either directly or indirectly.
+* The licensee is a medium to large organization that builds or integrates a
+  commercial product or service with Bedrock.
+
+THE LICENSE
+===========
+
+This section and all subsequent sections of this document constitute the
+agreement between the licensee and Digital Bazaar, Inc.
+
+DEFINITIONS
+===========
+
+* Product - The Bedrock software and any modules associated with Bedrock
+where Digital Bazaar, Inc. owns the copyright.
+
+CONDITIONS
+==========
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted for NON-COMMERCIAL PURPOSES as long as the
+following conditions are met:
+
+1. Any use of the Product must not generate revenue for the licensee or
+   any parent, subsidiary, agent, or affiliate of the licensee. Use of
+   Product includes, but is not limited to, interacting with any of the
+   licensee's Product-dependent products or services over a network.
+
+2. The aggregate number of individual people (users) of the licensee's
+   products or services that use Product must be less than 500.
+
+3. Redistributions of source code must retain the above copyright notice
+   intact, this list of conditions and the following disclaimer.
+
+4. Redistributions in binary form must reproduce the above copyright
+   notice, this license and the following disclaimer in the documentation and
+   on a web page available via interactive use and/or other materials
+   provided with the distribution.
+
+5. Neither the name of the copyright holder, the names of its
+   contributors, nor any trademarks held by the copyright holder may be used
+   to endorse or promote products or services built using the Product without
+   specific prior written permission.
+
+6. Any modifications are clearly outlined in release documentation and are
+   specifically mentioned as not being a part of an official Product release.
+   No additional restrictions to this license may be made when distributing
+   modifications.
+
+7. For the avoidance of doubt, this license prohibits sublicensing of the
+   Product.
+
+8. Any breach of this license by licensee must be resolved within 30 days.
+   Failure to do so results in the termination of this license.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+To obtain a non-profit or commercial license for Product, please contact
+Digital Bazaar, Inc. at the following email address:
+
+Digital Bazaar <support@digitalbazaar.com>