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

Make sure overlay API requests send force_api_session as POST param #17675

Merged
merged 5 commits into from Jun 17, 2021

Conversation

diosmosis
Copy link
Member

Description:

In the JS tracker we try to detect whether we are in an Overlay iframe by checking the HTTP referrer. If the referrer is from a specific Overlay controller action, then we know we're in Overlay.

The regex for parsing the segment parameter in this detection logic is incorrect. In it, we end up matching the segment parameter, plus everything after it. For example, in &segment=&token_auth=...&force_api_session=1 we match &token_auth=...&force_api_session=1, and assume this is the segment.

This is passed on to the Overlay/client.js code which appends it to every API request it makes, assuming that it's the segment. These parameters passed in the URL breaks the force_api_session code, since in the browser we make POST requests (so the token_auth is not saved in the browser cache), and server side we do not allow force_api_session to be used in $_GET if using a POST request.

Fixing this in two ways:

  1. fixing the regex to not be greedy
  2. making sure token_auth/force_api_session are not appended to the URL even if present in the API request

Review

  • Functional review done
  • Potential edge cases thought about (behavior of the code with strange input, with strange internal state or possible interactions with other Matomo subsystems)
  • Usability review done (is anything maybe unclear or think about anything that would cause people to reach out to support)
  • Security review done see checklist
  • Code review done
  • Tests were added if useful/possible
  • Reviewed for breaking changes
  • Developer changelog updated if needed
  • Documentation added if needed
  • Existing documentation updated if needed

@diosmosis diosmosis added Bug For errors / faults / flaws / inconsistencies etc. Needs Review PRs that need a code review labels Jun 15, 2021
@diosmosis diosmosis added this to the 4.4.0 milestone Jun 15, 2021
@diosmosis
Copy link
Member Author

build js

@diosmosis
Copy link
Member Author

build js

Copy link
Member

@sgiehl sgiehl left a comment

Choose a reason for hiding this comment

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

The code changes look good. But didn't do any local testing yet

@diosmosis
Copy link
Member Author

The customer has replied it works, @sgiehl ok to merge this?

@sgiehl
Copy link
Member

sgiehl commented Jun 17, 2021 via email

@diosmosis diosmosis merged commit 9696ebf into 4.x-dev Jun 17, 2021
@diosmosis diosmosis deleted the overlay-api-requests branch June 17, 2021 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug For errors / faults / flaws / inconsistencies etc. Needs Review PRs that need a code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants