clarify naming of AWS KMS keyring

Open
#298 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
aws, typescript
Domain
cryptography, security

Research direction

Start by reading the referenced specification issue 67, then locate the KMS keyring implementation and any existing compatibility tests in this TypeScript repository. Done means the keyring uses the explicitly requested AWS KMS name while existing users remain supported; the issue does not name specific files or tests.

Written by the indexing model from the issue text.

Description

doc change required

Per https://github.com/awslabs/aws-encryption-sdk-specification/issues/67, we are going to rename the KMS keyring to the AWS KMS keyring to be explicitly clear that this keyring interacts with the AWS Key Management Service, rather than some other KMS.

We need to make sure that we do this in a backwards-compatible way.

Dominant language
TypeScript
Stars
260
Forks
68
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aws/aws-encryption-sdk-javascript

All issues in aws/aws-encryption-sdk-javascript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.