Skip to content

docs: Clarify naming of KMS to AWS KMS #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 2, 2020
Merged

docs: Clarify naming of KMS to AWS KMS #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0947a7
docs: Clarify naming of KMS to AWS KMS
Jun 1, 2020
ee81fa5
Link to original GH issue, update version number
Jun 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions framework/keyring-interface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@

## Version

0.2.0
0.2.1

### Changelog

- 0.2.1

- [Clarify naming of KMS to AWS KMS](https://github.com/awslabs/aws-encryption-sdk-specification/issues/67)

- 0.2.0

- [Remove Keyring Trace](../changes/2020-05-13_remove-keyring-trace/change.md)
Expand Down Expand Up @@ -41,7 +45,7 @@ in this document are to be interpreted as described in [RFC 2119](https://tools.

## Supported Keyrings

- [KMS Keyring](kms-keyring.md)
- [AWS KMS Keyring](kms-keyring.md)
- [Multi-Keyring](multi-keyring.md)
- [Raw AES Keyring](raw-aes-keyring.md)
- [Raw RSA Keyring](raw-rsa-keyring.md)
Expand Down Expand Up @@ -149,7 +153,7 @@ the decryption is overwhelmingly likely to fail.
Users SHOULD use a keyring that protects wrapping keys and performs cryptographic operations within a secure boundary.
Examples are:

- The built-in [KMS keyring](kms-keyring.md),
- The built-in [AWS KMS keyring](kms-keyring.md),
which uses AWS Key Management Service (AWS KMS) customer master keys (CMKs) that never leave AWS KMS plaintext.
- A custom keyring that uses wrapping keys that are stored in your hardware security modules (HSMs)
- A custom keyring protected by another master key service.
Expand All @@ -166,7 +170,7 @@ The following keyrings are compatible with the referenced [master key providers]

| Keyring | Master Key Provider: Java and Python |
| --------------- | ---------------------------------------------------------------------------------------------------------------- |
| KMS keyring | KMS master key (Java), KMS master key provider (Java), KMS master key (Python), KMS master key provider (Python) |
| AWS KMS keyring | KMS master key (Java), KMS master key provider (Java), KMS master key (Python), KMS master key provider (Python) |
| Raw AES keyring | When they are used with symmetric encryption keys: JceMasterKey (Java), RawMasterKey (Python) |
| Raw RSA keyring | When they are used with asymmetric encryption keys: JceMasterKey (Java), RawMasterKey (Python) |

Expand Down
Loading