ali-kms v1.0.3

ali-kms

Install

$ npm i ali-kms -S

Usage as command

install

$ npm i -g ali-kms
$ ali-kms --help 

ali-kms use $HOME/.kmsconfig as default config file.

example config file

accessKey=accessKey
accessSecret=accessSecret
region=cn-shanghai

Usage as package

Prepare

You need create a new RAM strategy to manager kms.

{
  "Version": "1",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "kms:*",
      "Resource": [
        "acs:kms:*:*:key",
        "acs:kms:*:*:key/*"
      ]
    }
  ]
}

This case have all privileges to manager kms. You can customize strategy follow the RAM doc.

Regions

Kms Resgions

Create A Kms Client

KMS(options)

Create A KMS Client

options:

• accessKey {String} access key
• accessSecret {String} access secret
• region {String} region to using kms
• endpoint {String} region domain. if you have region in options, endpoint will auto generate.
• vpc {Boolean} if you use kms in vpc, make vpc to be true
• timeout {Number} request timeout

Example:

const KMS = require('kms');
const options = {
  accessKey: 'abc',
  accessSecret: 'abc',
  region: 'cn-hangzhou',
  // endpoint: 'kms-vpc.cn-hangzhou.aliyuncs.com'
  vpc: true,
  timeout: 6000
}
const kms = KMS(options);

Operations

.describeRegions(options)

List all available regions

Parameters:

• options {Object} request options
  • timeout {Number} request timeout, Unit: ms

Example:

const regions = await kms.describeRegions();

const { 
  RegionId
} = regions[0];

.createKey(params, options)

Create an encrypt/decrypt key

Parameters:

• params {Object} create key params
  • description {String} key description
• options {Object} request options
  • timeout {Number} request timeout, Unit: ms

Example:

const { KeyId } = await kms.createKey({ description: 'for you' });

.listKeys(params, options)

List all keys

Parameters:

• params list params
  • pageNumber=1 {Number} page number
  • pageSize=10 {Number} page size
• options {Object} request options
  • timeout {Number} request timeout, Unit: ms

Example:

const { List, TotalCount, PageNumber, PageSize } = await kms.listKeys({ pageNumber: 2, pageSize: 15 });

.describeKey(keyId, options)

Get detail of key

Parameters:

• keyId {String} key id
• options {Object} request options
  • timeout {Number} request timeout, Unit: ms

Example:

const {
  CreationDate,
  Description,
  KeyId,
  KeyState,
  KeyUsage,
  DeleteDate,
  Creator
} = await kms.describeKey('your key id');

.encrypt(keyId, params, options)

Encrypt plaintext

Parameters:

• keyId {String} encrypt key
• params {Object} encrypt params
  • plaintext {String} plaintext to encrypt
  • context {Object} platten json, encryption context
• options {Object} request options
  • timeout {Number} request timeout, Unit: ms

Example:

const keyId = 'you key id'
const { CiphertextBlob } = await kms.encrypt(keyId, { plaintext: 'plaintext' });

.decrypt(params, options)

Decrypt ciphertext

Parameters:

• params {Object} params for descrypt
  • ciphertext {String} ciphertext to decrypt
  • context {Object} decryption context
• options {Object} request options
  • timeout {Number} request timeout, Unit: ms

Example:

const { Plaintext } = await kms.decrypt({ ciphertext: 'dadada' });

.generateDataKey(keyId, params, options)

Create a pair plain/cipher for encryption

Parameters:

• keyId {String} key id
• params {Object} generate date key params
  • keySpec {String} algorithm to encrypt/decrypt, AES_256 or AES_128
  • length {Number} encrypt key length
• options {Object} request options
  • timeout {Number} request timeout, Unit: ms

Example:

const KEY_SPEC = require('kms').KEY_SPEC
const { Plaintext, CiphertextBlob } = await kms.generateDataKey('you key id'
  , { keySpec: KEY_SPEC.AES_256 });

.scheduleKeyDeletion(keyId, delayDays, options)

Delete key after delay days(7~30)

Parameters:

• keyId {String} key id
• delayDays {Number} delay days, min: 7, max: 30
• options {Object} request options
  • timeout {Number} request timeout, Unit: ms

Example:

await kms.scheduleKeyDeletion('your key id', 7);

.cancelKeyDeletion(keyId, options)

Cancel schedule deletion

Parameters:

• keyId {String} key id
• options {Object} request options
  • timeout {Number} request timeout, Unit: ms

Example:

await kms.cancelKeyDeletion('your key id');

.enableKey(keyId, options)

Enable disabled key

Parameters:

• keyId {String} key id
• options {Object} request options
  • timeout {Number} request timeout, Unit: ms

Example:

await kms.enableKey('your key id');

.disableKey(keyId, options)

Disable key

Parameters:

• keyId {String} key id
• options {Object} request options
  • timeout {Number} request timeout, Unit: ms

Example:

await kms.disableKey('your key id');

License

MIT