Skip to content
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

feat(iam): validate AccountPrincipal argument to be exactly 12 digits #31324

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

duranbe
Copy link
Contributor

@duranbe duranbe commented Sep 4, 2024

Reason for this change

There is no validation and test that the AWS Account Id when creating AccountPrincipal Object. Thus, according to cdk 1234 is a valid AWS Account id.

Context :
In my case I missed a digit when copy pasting an account id and the build still passed, the typo has been caught only during the code review process.

Description of changes

Adding simple regex to check that AWS Id is 12 digits long & update error message

Description of how you validated changes

  • Update existing tests
  • Add 2 units ones

Checklist


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

@aws-cdk-automation aws-cdk-automation requested a review from a team September 4, 2024 21:30
@github-actions github-actions bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Sep 4, 2024
@github-actions github-actions bot added the p2 label Sep 4, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

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.

@duranbe
Copy link
Contributor Author

duranbe commented Sep 4, 2024

Exemption Request

@aws-cdk-automation aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Sep 4, 2024
@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Sep 4, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@rix0rrr rix0rrr changed the title fix(iam): incorrect input for AccountPrincipal is building successfully fix(iam): AccountPrincipal argument is not validated to be exactly 12 digits Sep 6, 2024
AcmCertificateArn: 'arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012',
AcmCertificateArn: 'arn:aws:acm:us-east-1:123456789012:certificate/12345678-123456789012-123456789012-123456789012-123456789012',
Copy link
Contributor

Choose a reason for hiding this comment

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

The 1234 here was not an account ID, so I'm not sure why it is file is changed.

Did you do a mass search-replace over the entire codebase?

expect(_params).toEqual({ GroupIds: ['sg-1234'] });
expect(_params).toEqual({ GroupIds: ['sg-123456789012'] });
Copy link
Contributor

Choose a reason for hiding this comment

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

Security group IDs are also not account IDs.

Comment on lines +484 to +486
if (!cdk.Token.isUnresolved(accountId) && !this.accountIdRegExp.test(accountId)) {
throw new Error('accountId should be composed of 12 digits');
}
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if there might be use cases where people are passing valid strings that aren't exactly 12 digits in length.

I'd feel more comfortable making this a warning, rather than an exception.

@rix0rrr rix0rrr self-assigned this Sep 6, 2024
@rix0rrr rix0rrr changed the title fix(iam): AccountPrincipal argument is not validated to be exactly 12 digits feat(iam): validate AccountPrincipal argument to be exactly 12 digits Sep 6, 2024
@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Sep 6, 2024
@aws-cdk-automation
Copy link
Collaborator

The pull request linter fails with the following errors:

❌ Features must contain a change to a README file.
❌ Features must contain a change to an integration test file and the resulting snapshot.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

✅ A exemption request has been requested. Please wait for a maintainer's review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants