@agnostic-cloud/kms

Unified key management for AWS KMS, GCP Cloud KMS, and Azure Key Vault Keys.

Installation

npm install @agnostic-cloud/kms

Note on Peer Dependencies: Provider SDKs are optional peer dependencies. You only need to install the SDK for the cloud provider(s) you use.

Supported Cloud Provider SDK Versions

| Cloud Provider | Required SDK Package | Current / Tested Version | Installation Command | |---|---|---|---| | AWS | @aws-sdk/client-kms | ^3.1095.0 | npm install @aws-sdk/client-kms | | GCP | @google-cloud/kms | ^4.5.0 | npm install @google-cloud/kms | | Azure | @azure/keyvault-keys@azure/identity | ^4.10.2^4.13.1 | npm install @azure/keyvault-keys @azure/identity |

Usage

import { createKms } from '@agnostic-cloud/kms'

const kms = createKms({
  cloud: 'aws',
  region: 'us-east-1',
})

// Create key
const key = await kms.createKey('my-key', {
  description: 'Encryption key for app secrets',
})

// Encrypt
const encrypted = await kms.encrypt(key.keyId, 'sensitive data')

// Decrypt
const decrypted = await kms.decrypt(key.keyId, encrypted.ciphertext)

// Schedule deletion
const deletionDate = await kms.scheduleKeyDeletion(key.keyId, 7)

API

createKms(config: KmsConfig): KmsStrategy

| Method | Signature | |--------|-----------| | encrypt | (keyId, plaintext, context?) => Promise<EncryptResult> | | decrypt | (keyId, ciphertext, context?) => Promise<DecryptResult> | | createKey | (alias, options?) => Promise<KeyMetadata> | | scheduleKeyDeletion | (keyId, windowDays?) => Promise<Date> |

Configuration

interface KmsConfig {
  cloud?: 'aws' | 'gcp' | 'azure'
  region?: string
  config?: Record<string, any>
}

Documentation

Full docs: https://develasquez.github.io/-agnostic-cloud/docs/next/packages/kms

API reference: https://develasquez.github.io/-agnostic-cloud/docs/next/api/@agnostic-cloud/kms