@am92/kms v3.0.3

@am92/kms

This package provides Key Management related functionalities using either Node Crypto or AWS KMS. It provides the following functionalities:

• Generating Encryption Key for Symmetric and Asymmetric Algorithms
• Encrypting and Decrypting data

For full documentation, visit here.

Table of Content

• Installation
• Environment Variables
• Creating an Instance
• Self-managed Config
• Contributors
• Resources
• License

Installation

npm install --save @am92/kms

Environment Variables

The following environment variables need to be set to work with this package:

##### KMS Config
export KMS_ENABLED=
export KMS_TYPE=''
export KMS_KEY_SPEC=''
export KMS_KEY_PAIR_SPEC=''
export KMS_KEY_FORMAT=''
export KMS_PLAIN_TEXT_FORMAT=''
export KMS_CIPHER_TEXT_FORMAT=''
export KMS_MASTER_KEY_HEX=''
export KMS_MASTER_IV_HEX=''
export KMS_AWS_REGION=''
export KMS_AWS_KEY_ID=''

Note:

• * - Required if KMS_ENABLED is set to true.
• ** - Required if KMS_TYPE is set to AWS.

Creating an Instance

import { generateKmsInstance } from '@am92/kms'

const kms = generateKmsInstance()

export default kms

Self-managed Config

If you wish to pass your custom 'config' for Kms, then you can avoid setting any environment variables defined above and pass your own config as follows:

import { generateKmsInstance } from '@am92/kms'

const config = {
  KMS_TYPE: 'NODE'
}

const kms = generateKmsInstance(config)

export default kms

Contributors

Resources

• AWS SDK - KMS Client

License

• MIT