This repository has been archived by the owner on Apr 12, 2024. It is now read-only.
Mainline username generation #121
Merged
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
…743) This is mostly motivated by the tchap use case, where usernames are automatically generated from the user's email address (in a way that allows figuring out the email address from the username). Therefore, it's an issue if we respond to requests on /register and /register/available with M_USER_IN_USE, because it can potentially leak email addresses (which include the user's real name and place of work). This commit adds a flag to inhibit the M_USER_IN_USE errors that are raised both by /register/available, and when providing a username early into the registration process. This error will still be raised if the user completes the registration process but the username conflicts. This is particularly useful when using modules (matrix-org/synapse#11790 adds a module callback to set the username of users at registration) or SSO, since they can ensure the username is unique. More context is available in the PR that introduced this behaviour to synapse-dinsic: #48 - as well as the issue in the matrix-dinsic repo: matrix-org/matrix-dinsic#476
This is in the context of mainlining the Tchap fork of Synapse. Currently in Tchap usernames are derived from the user's email address (extracted from the UIA results, more specifically the m.login.email.identity step). This change also exports the check_username method from the registration handler as part of the module API, so that a module can check if the username it's trying to generate is correct and doesn't conflict with an existing one, and fallback gracefully if not. Co-authored-by: David Robertson <davidr@element.io>
DMRobertson
approved these changes
Jan 27, 2022
There was a problem hiding this comment.
Seems reasonable.
3rd commit removes the now obsolete
register_mxid_from_3pidsetting introduced in matrix-org/synapse#3096
To check I understand:
- this commit never made it into synapse mainline, just the
dinsicbranch? - it's now obsolete because mainline has this functionality (with a module)?
This is correct.
The combination of the new configuration flag + the module capability is what makes it obsolete. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Note to reviewer:
1st commit is a cherry-pick of matrix-org/synapse#11743
2nd commit is a cherry-pick of matrix-org/synapse#11790
3rd commit removes the now obsolete
register_mxid_from_3pidsetting introduced in matrix-org/synapse#30964th commit removes some hacks specific to synapse-dinsic that were made to better ignore username at registration that aren't needed anymore.
Note to ops:
This change removes the
register_mxid_from_3pidsetting. To reproduce its behaviour, the newinhibit_user_in_use_errorsetting must be set totrueand https://github.com/matrix-org/synapse-username-from-threepid must be installed and configured withthreepid_to_useset to the same value asregister_mxid_from_3pidwas, andfail_if_not_foundset totrue.