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

Add ability for TR to strip its special query params from responses #6019

Merged
merged 1 commit into from
Jul 16, 2021

Conversation

rawlinp
Copy link
Contributor

@rawlinp rawlinp commented Jul 13, 2021

What does this PR (Pull Request) do?

If enabled, strip the 'trred' and 'fakeClientIpAddress' query parameters
from the response URL(s) returned in TR's response.

Which Traffic Control components are affected by this PR?

  • Documentation
  • Traffic Router

What is the best way to verify this PR?

Ensure the TR tests pass.
Add the TR profile parameter:

name: strip.special.query.params
file: CRConfig.json
value: true

snapshot the CDN, make requests to TR using query parameters trred and fakeClientIpAddress, and ensure that they're stripped from the responses. Set the TR profile parameter to false, snapshot the CDN, and repeat the requests. Ensure that the special query parameters are not stripped from the responses.

The following criteria are ALL met by this PR

  • This PR includes tests
  • This PR includes documentation
  • This PR includes an update to CHANGELOG.md
  • This PR includes any and all required license headers
  • This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY (see the Apache Software Foundation's security guidelines for details)

If enabled, strip the 'trred' and 'fakeClientIpAddress' query parameters
from the response URL(s) returned in TR's response.
@rawlinp rawlinp added new feature A new feature, capability or behavior Traffic Router related to Traffic Router labels Jul 13, 2021
Copy link
Member

@zrhoffman zrhoffman left a comment

Choose a reason for hiding this comment

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

Yep this strips TR's special query params. As documented, not stripping format makes sense.

Code, docs, and changelog entry look good also.

@zrhoffman zrhoffman merged commit 3a25717 into apache:master Jul 16, 2021
@rawlinp rawlinp deleted the tr-strip-qparam branch July 16, 2021 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature A new feature, capability or behavior Traffic Router related to Traffic Router
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TC-284] Strip "actionable" query strings
2 participants