Improve the default OAuth page content renderer not to embed external parameters as-is #1352
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
seratch
added
bug
seratch
commented
Apr 13, 2023
| @@ -90,13 +91,11 @@ The redirection gives you a ``code`` parameter. You can exchange the value for a | |||
| redirect_uri=redirect_uri, | |||
| code=request.args["code"] | |||
| ) | |||
|
|
|||
| installed_enterprise = oauth_response.get("enterprise", {}) | |||
| installed_enterprise = oauth_response.get("enterprise") or {} | |||
There was a problem hiding this comment.
Unrelated improvements on the document example code
| @@ -65,7 +66,7 @@ def render_failure_page(self, reason: str) -> str: | |||
| </head> | |||
| <body> | |||
| <h2>Oops, Something Went Wrong!</h2> | |||
| <p>Please try again from <a href="{self.install_path}">here</a> or contact the app owner (reason: {reason})</p> | |||
| <p>Please try again from <a href="{html.escape(self.install_path)}">here</a> or contact the app owner (reason: {html.escape(reason)})</p> | |||
There was a problem hiding this comment.
This is the essential change in this PR. Only this pattern actually has issues.
… parameters as-is
seratch
force-pushed
the
improve-default-page-renderer
branch
from
b0c1e80
to
530acf9
Compare
Codecov Report
@@ Coverage Diff @@
## main #1352 +/- ##
=======================================
Coverage ? 85.37%
=======================================
Files ? 111
Lines ? 11557
Branches ? 0
=======================================
Hits ? 9867
Misses ? 1690
Partials ? 0
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
This was referenced Apr 13, 2023
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.
Summary
This pull request improves the default OAuth page content renderer not to embed any external parameters without escaping them. It updates the document pages and example code under integration_tests/samples too.
Category (place an
xin each of the[ ])/docs-src(Documents, have you run./scripts/docs.sh?)/docs-src-v2(Documents, have you run./scripts/docs-v2.sh?)/tutorial(PythOnBoardingBot tutorial)tests/integration_tests(Automated tests for this library)Requirements (place an
xin each[ ])python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.