Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 3.5 KB

README.md

File metadata and controls

65 lines (42 loc) · 3.5 KB
Raw

WebCrypto-compatible client for Key Management Services like GCP KMS

This library extends webcrypto-core to abstract the communication with KMSs, allowing you to use the same code to communicate with different KMSs. We currently support GCP KMS and AWS KMS, and we welcome PRs to support additional KMSs.

This is an alternative to:

Usage

The library is available on NPM as @relaycorp/webcrypto-kms, and you can install it as follows:

npm i @relaycorp/webcrypto-kms

Initialising the private key store

The configuration of the adapter is done via environment variables, so the actual initialisation of the store is done with a simple function call:

import { initKmsProviderFromEnv, KmsRsaPssProvider } from '@relaycorp/webcrypto-kms';

async function init(): Promise<KmsRsaPssProvider> {
  return initKmsProviderFromEnv(process.env.KMS_ADAPTER);
}

initKmsProviderFromEnv() can be called with 'AWS' or 'GCP'.

The following environment variables must be defined depending on the adapter:

  • AWS adapter:
    • AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY (optional when running on AWS infrastructure).
    • AWS_KMS_ENDPOINT (optional when running on AWS infrastructure).
    • AWS_KMS_REGION (optional when running on AWS infrastructure).
  • GCP adapter:
    • GOOGLE_APPLICATION_CREDENTIALS (optional when running on GCP infrastructure).
    • GCP_KMS_KEYRING (required).
    • GCP_KMS_LOCATION (required; e.g., europe-west3).
    • GCP_KMS_PROTECTION_LEVEL (required; i.e., SOFTWARE or HSM).

Additional members

KmsRsaPssProvider exposes the following additional methods:

  • destroyKey(privateKey): Destroys the specified private key.
  • close(): Closes the underlying network resources, when the provider is no longer needed.

Private keys from this library additionally expose their respective provider in the property provider. This may be useful when you don't want to or can't manage a global registry of providers. This functionality is supported by @relaycorp/veraid, for example.

Integration test suite

The integration tests aren't currently run on CI, and can be run with npm run test:integration:local.

All GCP resources will be created within the same project where the service account lives. The GCP service account should be allowed to manage KMS resources.

Before running the AWS KMS tests, you need to start a mock AWS KMS server locally using docker:

docker run --rm -p 8080:8080 nsmithuk/local-kms

The test suite will automatically delete all the resources it created, except for those that can't be deleted (e.g., GPC KMS key rings). Existing resources are not modified. However, this may not always be true due to bugs, so always create a brand new, temporary GCP project.