feat: Create a construct to create IAM resources for GitHub Actions #823
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akash1810
force-pushed
the
aa-gha-construct
branch
2 times, most recently
from
a97de1e
to
9c4ebb4
Compare
akash1810
commented
Sep 28, 2021
| exports[`The GitHubActionsRole construct should create the correct resources with minimal config 1`] = ` | ||
| Object { | ||
| "Outputs": Object { | ||
| "GithubActionsRoleGithubActionsRoleArnC13D9654": Object { |
There was a problem hiding this comment.
Not the best auto-generated Output name...
With https://github.com/guardian/actions-assume-aws-role we're able to Assume Role within GitHub Actions. This change introduces a construct to simplify the creation of this role. The `GuGithubActionsRole` construct creates the three required resources: - `AWS::IAM::Policy` - `AWS::IAM::Role` - `AWS::IAM::OIDCProvider` This allows teams to do: ```typescript new GuGithubActionsRole(stack, { policies: [ new GuGetS3ObjectsPolicy(stack, "GetObjects", { bucketName: "super-secret-stuff", }), ], }); ``` Which is smaller than the YAML alternative: ```yaml GitHubBucketAccessPolicy: Type: AWS::IAM::Policy Properties: PolicyName: GitHubBucketAccessPolicy PolicyDocument: Statement: Action: - s3:GetObject Effect: Allow Resource: - arn:aws:s3:::super-secret-stuff/* Roles: - Ref: GitHubRole GitHubRole: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Statement: - Effect: Allow Action: sts:AssumeRoleWithWebIdentity Principal: Federated: !Ref GitHubOidc Condition: StringLike: vstoken.actions.githubusercontent.com:sub: repo:guardian/* GitHubOidc: Type: AWS::IAM::OIDCProvider Properties: Url: https://vstoken.actions.githubusercontent.com ClientIdList: [sigstore] ThumbprintList: [a031c46782e6e6c662c2c87c76da9aa62ccabd8e] ```
akash1810
force-pushed
the
aa-gha-construct
branch
from
9c4ebb4
to
ee70378
Compare
philmcmahon
approved these changes
Oct 8, 2021
|
🎉 This PR is included in version 26.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
rtyley
added a commit
that referenced
this pull request
Jun 23, 2022
This is an update to the construct that creates IAM resources for GitHub Actions, first introduced with #823 in early October 2021. Apparently the `ClientIdList` field should no longer be `sigstore`, as of 19th October 2021: aws-actions/configure-aws-credentials#291 aws-actions/configure-aws-credentials#280 (comment) aws-actions/configure-aws-credentials#284 The new value is `sts.amazonaws.com`, which I think corresponds to this line in the docs: > For the "Audience": Use sts.amazonaws.com if you are using the official action. https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services#adding-the-identity-provider-to-aws With the old value of `sigstore` in the `AWS::IAM::OIDCProvider` `ClientIdList` field, running the `aws-actions/configure-aws-credentials` GitHub Action will give you a "Error: Incorrect token audience" error: https://github.com/guardian/facia-scala-client/runs/7025740057?check_suite_focus=true#step:3:6
rtyley
added a commit
that referenced
this pull request
Jun 23, 2022
This is an update to the construct that creates IAM resources for GitHub Actions, first introduced with #823 in early October 2021. Apparently the `ClientIdList` field should no longer be `sigstore`, as of 19th October 2021: aws-actions/configure-aws-credentials#291 aws-actions/configure-aws-credentials#280 (comment) aws-actions/configure-aws-credentials#284 The new value is `sts.amazonaws.com`, which I think corresponds to this line in the docs: > For the "Audience": Use sts.amazonaws.com if you are using the official action. https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services#adding-the-identity-provider-to-aws With the old value of `sigstore` in the `AWS::IAM::OIDCProvider` `ClientIdList` field, running the `aws-actions/configure-aws-credentials` GitHub Action will give you a "Error: Incorrect token audience" error: https://github.com/guardian/facia-scala-client/runs/7025740057?check_suite_focus=true#step:3:6
rtyley
added a commit
that referenced
this pull request
Jun 23, 2022
This is an update to the construct that creates IAM resources for GitHub Actions, first introduced with #823 in early October 2021. Apparently the `ClientIdList` field should no longer be `sigstore`, as of 19th October 2021: aws-actions/configure-aws-credentials#291 aws-actions/configure-aws-credentials#280 (comment) aws-actions/configure-aws-credentials#284 The new value is `sts.amazonaws.com`, which I think corresponds to this line in the docs: > For the "Audience": Use sts.amazonaws.com if you are using the official action. https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services#adding-the-identity-provider-to-aws With the old value of `sigstore` in the `AWS::IAM::OIDCProvider` `ClientIdList` field, running the `aws-actions/configure-aws-credentials` GitHub Action will give you a "Error: Incorrect token audience" error: https://github.com/guardian/facia-scala-client/runs/7025740057?check_suite_focus=true#step:3:6
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change?
With https://github.com/guardian/actions-assume-aws-role we're able to Assume Role within GitHub Actions.
This change introduces a construct to simplify the creation of this role.
The
GuGithubActionsRoleconstruct creates the three required resources:AWS::IAM::PolicyAWS::IAM::RoleAWS::IAM::OIDCProviderThis allows teams to do:
Which is smaller than the YAML alternative:
Does this change require changes to existing projects or CDK CLI?
No.
Does this change require changes to the library documentation?
Yes and is done.
How to test
See added tests.
How can we measure success?
Less YAML, fewer mistakes 🎉 .
Have we considered potential risks?
Is the reasoning behind
GitHubOidcProviderclear enough?