This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add a config option for validating 'next_link' parameters against a domain whitelist #8275
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
3bb8b74
Add next_link domain whitelist config option
anoadragon453 0550f12
Use the config option to validate next_link values
anoadragon453 62e61e4
Require file:/// again
anoadragon453 41c4b3a
Stop trying to convert None to a set
anoadragon453 f4513fe
Scheme for file:/// is 'file', not 'file:///'
anoadragon453 8a5dcaa
Add tests, improve _request_token and add types
anoadragon453 f7e4686
Changelog
anoadragon453 bf5e812
mypy
anoadragon453 b09ef06
Update tests/rest/client/v2_alpha/test_account.py
anoadragon453 42715ff
Add tests for None whitelist, exotic schemes
anoadragon453 7b1e865
atd -> IS
anoadragon453 3235e44
sample config
anoadragon453 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Add a config option to specify a whitelist of domains that a user can be redirected to after validating their email or phone number. |
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,11 +14,11 @@ | |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
import json | ||
import os | ||
import re | ||
from email.parser import Parser | ||
from typing import Optional | ||
|
||
import pkg_resources | ||
|
||
|
@@ -29,6 +29,7 @@ | |
from synapse.rest.client.v2_alpha import account, register | ||
|
||
from tests import unittest | ||
from tests.unittest import override_config | ||
|
||
|
||
class PasswordResetTestCase(unittest.HomeserverTestCase): | ||
|
@@ -668,16 +669,104 @@ def test_no_valid_token(self): | |
self.assertEqual(200, int(channel.result["code"]), msg=channel.result["body"]) | ||
self.assertFalse(channel.json_body["threepids"]) | ||
|
||
def _request_token(self, email, client_secret): | ||
@override_config({"next_link_domain_whitelist": None}) | ||
def test_next_link(self): | ||
"""Tests a valid next_link parameter value with no whitelist (good case)""" | ||
self._request_token( | ||
"[email protected]", | ||
"some_secret", | ||
next_link="https://example.com/a/good/site", | ||
expect_code=200, | ||
) | ||
|
||
@override_config({"next_link_domain_whitelist": None}) | ||
def test_next_link_exotic_protocol(self): | ||
"""Tests using a esoteric protocol as a next_link parameter value. | ||
Someone may be hosting a client on IPFS etc. | ||
""" | ||
self._request_token( | ||
"[email protected]", | ||
"some_secret", | ||
next_link="some-protocol://abcdefghijklmopqrstuvwxyz", | ||
expect_code=200, | ||
) | ||
|
||
@override_config({"next_link_domain_whitelist": None}) | ||
def test_next_link_file_uri(self): | ||
"""Tests next_link parameters cannot be file URI""" | ||
# Attempt to use a next_link value that points to the local disk | ||
self._request_token( | ||
"[email protected]", | ||
"some_secret", | ||
next_link="file:///host/path", | ||
expect_code=400, | ||
) | ||
|
||
@override_config({"next_link_domain_whitelist": ["example.com", "example.org"]}) | ||
def test_next_link_domain_whitelist(self): | ||
"""Tests next_link parameters must fit the whitelist if provided""" | ||
self._request_token( | ||
"[email protected]", | ||
"some_secret", | ||
next_link="https://example.com/some/good/page", | ||
expect_code=200, | ||
) | ||
|
||
self._request_token( | ||
"[email protected]", | ||
"some_secret", | ||
next_link="https://example.org/some/also/good/page", | ||
expect_code=200, | ||
) | ||
|
||
self._request_token( | ||
"[email protected]", | ||
"some_secret", | ||
next_link="https://bad.example.org/some/bad/page", | ||
expect_code=400, | ||
) | ||
|
||
@override_config({"next_link_domain_whitelist": []}) | ||
anoadragon453 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
def test_empty_next_link_domain_whitelist(self): | ||
"""Tests an empty next_lint_domain_whitelist value, meaning next_link is essentially | ||
disallowed | ||
""" | ||
self._request_token( | ||
"[email protected]", | ||
"some_secret", | ||
next_link="https://example.com/a/page", | ||
expect_code=400, | ||
) | ||
|
||
def _request_token( | ||
self, | ||
email: str, | ||
client_secret: str, | ||
next_link: Optional[str] = None, | ||
expect_code: int = 200, | ||
) -> str: | ||
"""Request a validation token to add an email address to a user's account | ||
|
||
Args: | ||
email: The email address to validate | ||
client_secret: A secret string | ||
next_link: A link to redirect the user to after validation | ||
expect_code: Expected return code of the call | ||
|
||
Returns: | ||
The ID of the new threepid validation session | ||
""" | ||
body = {"client_secret": client_secret, "email": email, "send_attempt": 1} | ||
if next_link: | ||
body["next_link"] = next_link | ||
|
||
request, channel = self.make_request( | ||
"POST", | ||
b"account/3pid/email/requestToken", | ||
{"client_secret": client_secret, "email": email, "send_attempt": 1}, | ||
"POST", b"account/3pid/email/requestToken", body, | ||
) | ||
self.render(request) | ||
self.assertEquals(200, channel.code, channel.result) | ||
self.assertEquals(expect_code, channel.code, channel.result) | ||
|
||
return channel.json_body["sid"] | ||
return channel.json_body.get("sid") | ||
|
||
def _request_token_invalid_email( | ||
self, email, expected_errcode, expected_error, client_secret="foobar", | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This check now happens implicitly in
assert_valid_next_link
, as onlyhttp
andhttps
next_link
values are allowed.Additionally,
next_link
can only be specified during the call to/requestToken
. Having this check in/submit_token
, blocking the user after already approving their/requestToken
call, is not great UX.