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

fix(core): stack.urlSuffix is no longer scoped #4011

Merged
merged 2 commits into from
Sep 13, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Sep 10, 2019

stack.urlSuffix used to be a scoped Token. By the use of roles defined
in another stack (using a ServicePrincipal which uses a urlSuffix
token), this could lead to unintentional stack references.

Two changes here:

  • URL Suffix (seems to) only change when Partition changes. Since
    Partition is unscoped (cross-partition references won't work anyway),
    we might as well make URL Suffix unscoped too.
  • ServicePrincipalToken should not have used the stack's urlSuffix,
    but constructed an unscoped URL_SUFFIX itself, since it was
    never intended to potentially create a cross-stack reference. It
    couldn't have, since it doesn't know where it is being defined,
    it just knows where it's being used.

Technically, the second change isn't necessary anymore after we
apply the first, but I made both anyway since the bug is still
resolved even if find out we need roll back the first change
because of a future region build.

Fixes #3970.


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

`stack.urlSuffix` used to be a scoped Token. By the use of roles defined
in another stack (using a `ServicePrincipal` which uses a `urlSuffix`
token), this could lead to unintentional stack references.

Two changes here:

* URL Suffix (seems to) only change when Partition changes. Since
  Partition is unscoped (cross-partition references won't work anyway),
  we might as well make URL Suffix unscoped too.
* `ServicePrincipalToken` should not have used the stack's `urlSuffix`,
  but constructed an unscoped `URL_SUFFIX` itself, since it was
  never intended to potentially create a cross-stack reference. It
  couldn't have, since it doesn't know where it is being defined,
  it just knows where it's being used.

Technically, the second change isn't necessary anymore after we
apply the first, but I made both anyway since the bug is still
resolved even if find out we need roll back the first change
because of a future region build.

Fixes #3970.
@rix0rrr rix0rrr requested a review from a team September 10, 2019 09:47
@rix0rrr rix0rrr self-assigned this Sep 10, 2019
@mergify
Copy link
Contributor

mergify bot commented Sep 10, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist
:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

Copy link
Contributor

@nija-at nija-at left a comment

Choose a reason for hiding this comment

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

Do we still need the methods partition() and urlSuffix() in the ScopedAws class?

https://github.com/aws/aws-cdk/blob/master/packages/@aws-cdk/core/lib/cfn-pseudo.ts#L58

@nija-at
Copy link
Contributor

nija-at commented Sep 11, 2019

By the use of roles defined in another stack (using a ServicePrincipal which uses a urlSuffix
token), this could lead to unintentional stack references.`

You should expand on what you mean here, so we can record this for posterity on when someone is looking over why this change was made. I couldn't gather what's going on from the linked issue.

@rix0rrr
Copy link
Contributor Author

rix0rrr commented Sep 12, 2019

Do we still need the methods partition() and urlSuffix() in the ScopedAws class?

I don't see a reason to remove them. It's something you might want.

You should expand on what you mean here.

Is that worth a provisional approval or would you like to see my rephrasing before you okay it?

@mergify
Copy link
Contributor

mergify bot commented Sep 13, 2019

Thank you for contributing! Your pull request is now being automatically merged.

@rix0rrr rix0rrr added the pr/do-not-merge This PR should not be merged at this time. label Sep 13, 2019
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify mergify bot merged commit 82e08bc into master Sep 13, 2019
@mergify mergify bot deleted the huijbers/no-scoped-urlsuffix branch September 13, 2019 09:57
@rix0rrr rix0rrr added review/small effort/small Small work item – less than a day of effort and removed review/small labels Sep 16, 2019
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. effort/small Small work item – less than a day of effort pr/do-not-merge This PR should not be merged at this time.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cyclic Reference Error (test-cdk-dev/test-cdk-dev-ecs.AWS::URLSuffix) would create a cyclic reference.
4 participants