@aws-sdk/client-kms

Description

AWS SDK for JavaScript KMS Client for Node.js, Browser and React Native.

Key Management Service

Key Management Service (KMS) is an encryption and key management web service. This guide describes the KMS operations that you can call programmatically. For general information about KMS, see the Key Management Service Developer Guide .

KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to KMS and other Amazon Web Services services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.

If you need to use FIPS 140-2 validated cryptographic modules when communicating with Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the available FIPS endpoints, see Service endpoints in the Key Management Service topic of the Amazon Web Services General Reference.

All KMS API calls must be signed and be transmitted using Transport Layer Security (TLS). KMS recommends you always use the latest supported TLS version. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.

Signing Requests

Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your Amazon Web Services account root access key ID and secret access key for everyday work. You can use the access key ID and secret access key for an IAM user or you can use the Security Token Service (STS) to generate temporary security credentials and use those to sign requests.

All KMS requests must be signed with Signature Version 4.

Logging API Requests

KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the CloudTrail User Guide.

Additional Resources

For more information about credentials and request signing, see the following:

• Amazon Web Services Security Credentials - This topic provides general information about the types of credentials used to access Amazon Web Services.

• Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.

• Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.

Commonly Used API Operations

Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.

• Encrypt

• Decrypt

• GenerateDataKey

• GenerateDataKeyWithoutPlaintext

Installing

To install this package, simply type add or install @aws-sdk/client-kms using your favorite package manager:

• npm install @aws-sdk/client-kms
• yarn add @aws-sdk/client-kms
• pnpm add @aws-sdk/client-kms

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the KMSClient and the commands you need, for example ListAliasesCommand:

// ES5 example
const { KMSClient, ListAliasesCommand } = require("@aws-sdk/client-kms");

// ES6+ example
import { KMSClient, ListAliasesCommand } from "@aws-sdk/client-kms";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new KMSClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListAliasesCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-kms";
const client = new AWS.KMS({ region: "REGION" });

// async/await.
try {
  const data = await client.listAliases(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listAliases(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listAliases(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-kms package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

CancelKeyDeletion

Command API Reference / Input / Output

ConnectCustomKeyStore

Command API Reference / Input / Output

CreateAlias

Command API Reference / Input / Output

CreateCustomKeyStore

Command API Reference / Input / Output

CreateGrant

Command API Reference / Input / Output

CreateKey

Command API Reference / Input / Output

Decrypt

Command API Reference / Input / Output

DeleteAlias

Command API Reference / Input / Output

DeleteCustomKeyStore

Command API Reference / Input / Output

DeleteImportedKeyMaterial

Command API Reference / Input / Output

DeriveSharedSecret

Command API Reference / Input / Output

DescribeCustomKeyStores

Command API Reference / Input / Output

DescribeKey

Command API Reference / Input / Output

DisableKey

Command API Reference / Input / Output

DisableKeyRotation

Command API Reference / Input / Output

DisconnectCustomKeyStore

Command API Reference / Input / Output

EnableKey

Command API Reference / Input / Output

EnableKeyRotation

Command API Reference / Input / Output

Encrypt

Command API Reference / Input / Output

GenerateDataKey

Command API Reference / Input / Output

GenerateDataKeyPair

Command API Reference / Input / Output

GenerateDataKeyPairWithoutPlaintext

Command API Reference / Input / Output

GenerateDataKeyWithoutPlaintext

Command API Reference / Input / Output

GenerateMac

Command API Reference / Input / Output

GenerateRandom

Command API Reference / Input / Output

GetKeyPolicy

Command API Reference / Input / Output

GetKeyRotationStatus

Command API Reference / Input / Output

GetParametersForImport

Command API Reference / Input / Output

GetPublicKey

Command API Reference / Input / Output

ImportKeyMaterial

Command API Reference / Input / Output

ListAliases

Command API Reference / Input / Output

ListGrants

Command API Reference / Input / Output

ListKeyPolicies

Command API Reference / Input / Output

ListKeyRotations

Command API Reference / Input / Output

ListKeys

Command API Reference / Input / Output

ListResourceTags

Command API Reference / Input / Output

ListRetirableGrants

Command API Reference / Input / Output

PutKeyPolicy

Command API Reference / Input / Output

ReEncrypt

Command API Reference / Input / Output

ReplicateKey

Command API Reference / Input / Output

RetireGrant

Command API Reference / Input / Output

RevokeGrant

Command API Reference / Input / Output

RotateKeyOnDemand

Command API Reference / Input / Output

ScheduleKeyDeletion

Command API Reference / Input / Output

Sign

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAlias

Command API Reference / Input / Output

UpdateCustomKeyStore

Command API Reference / Input / Output

UpdateKeyDescription

Command API Reference / Input / Output

UpdatePrimaryRegion

Command API Reference / Input / Output

Verify

Command API Reference / Input / Output

VerifyMac

Command API Reference / Input / Output