feat(kms): add sign and verify related grant methods by clementallen · Pull Request #32681 · aws/aws-cdk

clementallen · 2024-12-28T22:23:09Z

Issue

Closes #23185

Reason for this change

Adds grant methods for signing and verifying signatures with KMS

Description of changes

Three new grant methods have been added:

grantSign(): Adds 'kms:Sign' to the principal
grantVerify(): Adds 'kms:Verify' to the principal
grantSignVerify(): Adds ['kms:Sign', 'kms:Verify'] to the principal

Description of how you validated changes

Added new unit tests to verify the output of the 3 new grant methods
Added a new integ test for grantSignVerify()

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

codecov · 2024-12-28T22:36:14Z

Codecov Report

Attention: Patch coverage is 11.76471% with 15 lines in your changes missing coverage. Please review.

Project coverage is 66.91%. Comparing base (caf2415) to head (2b4e644).

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #32681      +/-   ##
==========================================
- Coverage   66.96%   66.91%   -0.06%     
==========================================
  Files         329      329              
  Lines       18667    18684      +17     
  Branches     3260     3260              
==========================================
+ Hits        12501    12503       +2     
- Misses       5839     5854      +15     
  Partials      327      327

Flag	Coverage Δ
suite.unit	`66.91% <11.76%> (-0.06%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`80.71% <ø> (ø)`
packages/aws-cdk-lib/core	`82.09% <ø> (ø)`

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

lpizzinidev

Looks good to me! Thanks 👍

samson-keung

LGTM! Thank you for your contribution.

mergify · 2025-01-02T18:37:22Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2025-01-02T18:37:26Z

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

mergify · 2025-01-02T18:42:09Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

Pull request has been modified.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

clementallen · 2025-01-02T18:46:22Z

LGTM! Thank you for your contribution.

Thank you @samson-keung, there seemed to be some issue rebasing automatically so I've just done it manually

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

samson-keung · 2025-01-02T18:55:57Z

there seemed to be some issue rebasing automatically so I've just done it manually

@clementallen I checked the logs. Looks like the PR had to be rebased again to get the year change in the license files. I have updated the PR branch so it should be good to go. I will check through out the day to make sure this gets merged 👍

mergify · 2025-01-02T19:24:24Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

Pull request has been modified.

samson-keung · 2025-01-02T22:51:27Z

Codecov is complaining about missing coverage on the Alias class. Can you add similar unit test you have for the Key class?

Codecov also complains about missing coverage for the KeyBase class which does not make sense to me because you have the unit tests with the Key class already. I will check with the team on this.

clementallen · 2025-01-02T23:02:46Z

Thanks for checking in on this again @samson-keung, I've added tests for all three methods against the Alias class now as well. Agree it's odd about KeyBase - please let me know if there's anything I can add to help with this!

clementallen · 2025-01-03T13:18:56Z

@samson-keung I took a further look into the unit test reporting and it still doesn't make sense.

Codecov reports missing lines in the Key class, yet there are unit tests for these lines, and the local Jest coverage report correctly identifies these lines as being tested.

Codecov:

Jest coverage report:

There doesn't see much point adding tests to for the grant methods against Alias.fromAliasName as these are no-ops anyway as grant methods aren't usable against an imported alias just by name.

aws-cdk-automation · 2025-01-05T23:10:04Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 2b4e644
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2025-01-05T23:19:30Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2025-01-05T23:24:01Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

github-actions · 2025-01-06T06:42:49Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

samson-keung · 2025-01-06T06:44:34Z

@clementallen One of the Codecov jobs were not intended to run in this PR. The configuration has been updated, hence, the PR is now merged. Thanks for waiting while I was resolving the issue.

aws-cdk-automation requested a review from a team December 28, 2024 22:23

github-actions bot added repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels Dec 28, 2024

aws-cdk-automation previously requested changes Dec 28, 2024

View reviewed changes

clementallen changed the title ~~feat(kms): Add sign and verify related grant methods~~ feat(kms): add sign and verify related grant methods Dec 28, 2024

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 28, 2024

lpizzinidev approved these changes Dec 29, 2024

View reviewed changes

aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Dec 29, 2024

github-actions bot mentioned this pull request Jan 1, 2025

Monthly PR metrics report #32703

Closed

samson-keung previously approved these changes Jan 2, 2025

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 2, 2025

clementallen force-pushed the kms-grants branch from e3af838 to aa66fe0 Compare January 2, 2025 18:42

clementallen requested a review from a team as a code owner January 2, 2025 18:42

clementallen had a problem deploying to test-pipeline January 2, 2025 18:44 — with GitHub Actions Failure

clementallen added 4 commits January 2, 2025 18:44

Added sign and verify grant methods to KMS

830b391

Added test for new grant methods

dc017fa

Added integ test for grantSignVerify

95873ba

Added new grant methods to README

0ff6f6a

aws-cdk-automation previously requested changes Jan 2, 2025

View reviewed changes

clementallen force-pushed the kms-grants branch from aa66fe0 to 0ff6f6a Compare January 2, 2025 18:45

aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Jan 2, 2025

Merge branch 'main' into kms-grants

6b5b1f1

samson-keung previously approved these changes Jan 2, 2025

View reviewed changes

Merge branch 'main' into kms-grants

24a88ce

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 2, 2025

Added tests for new grant methods against the Alias class

9f9cbbf

Added further tests for Alias class

cee9af4

iliapolo and others added 2 commits January 5, 2025 15:43

Merge branch 'main' into kms-grants

e57a930

Merge branch 'main' into kms-grants

2b4e644

samson-keung approved these changes Jan 5, 2025

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 5, 2025

mergify bot merged commit 86d2853 into aws:main Jan 6, 2025

github-actions bot locked as resolved and limited conversation to collaborators Jan 6, 2025

clementallen deleted the kms-grants branch January 6, 2025 09:37

Conversation

clementallen commented Dec 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Dec 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

lpizzinidev left a comment

Choose a reason for hiding this comment

Uh oh!

samson-keung left a comment

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Jan 2, 2025

Uh oh!

mergify bot commented Jan 2, 2025

Uh oh!

mergify bot commented Jan 2, 2025

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

clementallen commented Jan 2, 2025

Uh oh!

samson-keung commented Jan 2, 2025

Uh oh!

mergify bot commented Jan 2, 2025

Uh oh!

samson-keung commented Jan 2, 2025

Uh oh!

clementallen commented Jan 2, 2025

Uh oh!

clementallen commented Jan 3, 2025

Uh oh!

aws-cdk-automation commented Jan 5, 2025

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Jan 5, 2025

Uh oh!

mergify bot commented Jan 5, 2025

Uh oh!

github-actions bot commented Jan 6, 2025

Uh oh!

samson-keung commented Jan 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

clementallen commented Dec 28, 2024 •

edited

Loading

codecov bot commented Dec 28, 2024 •

edited

Loading