Skip to content

docs: add master key provider examples #236

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.

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 7 commits into from
Apr 6, 2020
Merged

docs: add master key provider examples #236

merged 7 commits into from
Apr 6, 2020

Conversation

mattsb42-aws
Copy link
Member

Issue #, if available:
#213
#146

Description of changes:

To aid in migration efforts, these examples show the basics of how to use master key providers in the new example format.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Check any applicable:

  • Were any files moved? Moving files changes their URL, which breaks all hyperlinks to the files.

@mattsb42-aws mattsb42-aws added this to the keyrings milestone Apr 2, 2020
@mattsb42-aws mattsb42-aws requested a review from a team April 2, 2020 01:54
@mattsb42-aws
Copy link
Member Author

Note for the record: all failing checks are expected. They are all from the test vector handler workflow. The tests from that workflow actually should not be running on pull request events, but I'll figure that out in a different PR.

@mattsb42-aws mattsb42-aws changed the title Master key provider examples docs: add master key provider examples Apr 2, 2020
# SPDX-License-Identifier: Apache-2.0
"""
This example is provided as a reference for users migrating away from master key providers.
We recommend that all new use should use keyrings.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this wording is a little awkward

Copy link
Contributor

@WesleyRosenblum WesleyRosenblum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Java PR has been updated to match this: aws/aws-encryption-sdk-java#168

@mattsb42-aws mattsb42-aws merged commit 5abbf9c into aws:keyring Apr 6, 2020
@mattsb42-aws mattsb42-aws deleted the mkp-examples branch April 6, 2020 19:25
@ttjsu-aws ttjsu-aws mentioned this pull request Apr 7, 2020
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants