This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
[1/2] Allow homeservers to send registration emails | Sending the email #5835
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
anoadragon453
commented
Aug 12, 2019
richvdh
previously requested changes
Aug 15, 2019
There was a problem hiding this comment.
It feels like this PR is addressing several separate concerns which might be better handled as separate PRs. Do you think you could split it up a bit? For example:
- the fix to Names of password reset HTML templates in config doesn't match python code #5833 can stand alone
- could the move from
trust_identity_server_for_password_resetstoaccount_threepid_delegatebe done separately to the addition of the registration emails?
| email_password_reset_success_template = email_config.get( | ||
| "password_reset_success_template", "password_reset_success.html" | ||
|
|
||
| # These templates do not support any placeholder variables, so we |
There was a problem hiding this comment.
I'm kinda wondering if a better solution is to remove the special-casing and stick them through the template engine anyway.
There was a problem hiding this comment.
It would be more clear, but we'd have to pull the template from the disk every time we get a registration request. So a question of code quality versus performance.
There was a problem hiding this comment.
given we have to do that anyway for the other templates, it feels like a hit worth taking. But also, maybe something to think about another time.
There was a problem hiding this comment.
I'll punt it for later.
…synapse into anoa/reg_email_sending_email
This was referenced Aug 30, 2019
anoadragon453
added a commit
that referenced
this pull request
Sep 5, 2019
…erification (#5940) Fixes: #5751 Fixes: #5928 #5835 allowed Synapse to send registration emails to the user. Now we need to accept them and have it succeed the `m.login.email.identity` registration flow step. `account_threepid_handler` will also be switched from a `str` in the config file to a dictionary which contains entries for `msisdn` and `email`, each with their own `str`. This will let people use an external server to handle `msisdn` registration and password reset requests, while using Synapse for email-based things. And the `password_servlet` hack that was introduced in https://github.com/matrix-org/synapse/pull/5377/files#diff-b8464485d36f6f87caee3f4d82524213R189 to distinguish a registration call from a password reset call will be removed.
anoadragon453
added a commit
that referenced
this pull request
Sep 6, 2019
…rnal server to handle 3pid validation (#5987) This is a combination of a few different PRs, finally all being merged into `develop`: * #5875 * #5876 * #5868 (This one added the `/versions` flag but the flag itself was actually [backed out](891afb5#diff-e591d42d30690ffb79f63bb726200891) in #5969. What's left is just giving /versions access to the config file, which could be useful in the future) * #5835 * #5969 * #5940 Clients should not actually use the new registration functionality until #5972 is merged. UPGRADE.rst, changelog entries and config file changes should all be reviewed closely before this PR is merged.
anoadragon453
added a commit
that referenced
this pull request
Oct 3, 2019
Synapse 1.4.0 (2019-10-03) ========================== Bugfixes -------- - Redact `client_secret` in server logs. ([\#6158](#6158)) Synapse 1.4.0rc2 (2019-10-02) ============================= Bugfixes -------- - Fix bug in background update that adds last seen information to the `devices` table, and improve its performance on Postgres. ([\#6135](#6135)) - Fix bad performance of censoring redactions background task. ([\#6141](#6141)) - Fix fetching censored redactions from DB, which caused APIs like initial sync to fail if it tried to include the censored redaction. ([\#6145](#6145)) - Fix exceptions when storing large retry intervals for down remote servers. ([\#6146](#6146)) Internal Changes ---------------- - Fix up sample config entry for `redaction_retention_period` option. ([\#6117](#6117)) Synapse 1.4.0rc1 (2019-09-26) ============================= Note that this release includes significant changes around 3pid verification. Administrators are reminded to review the [upgrade notes](UPGRADE.rst#upgrading-to-v140). Features -------- - Changes to 3pid verification: - Add the ability to send registration emails from the homeserver rather than delegating to an identity server. ([\#5835](#5835), [\#5940](#5940), [\#5993](#5993), [\#5994](#5994), [\#5868](#5868)) - Replace `trust_identity_server_for_password_resets` config option with `account_threepid_delegates`, and make the `id_server` parameteter optional on `*/requestToken` endpoints, as per [MSC2263](matrix-org/matrix-spec-proposals#2263). ([\#5876](#5876), [\#5969](#5969), [\#6028](#6028)) - Switch to using the v2 Identity Service `/lookup` API where available, with fallback to v1. (Implements [MSC2134](matrix-org/matrix-spec-proposals#2134) plus `id_access_token authentication` for v2 Identity Service APIs from [MSC2140](matrix-org/matrix-spec-proposals#2140)). ([\#5897](#5897)) - Remove `bind_email` and `bind_msisdn` parameters from `/register` ala [MSC2140](matrix-org/matrix-spec-proposals#2140). ([\#5964](#5964)) - Add `m.id_access_token` to `unstable_features` in `/versions` as per [MSC2264](matrix-org/matrix-spec-proposals#2264). ([\#5974](#5974)) - Use the v2 Identity Service API for 3PID invites. ([\#5979](#5979)) - Add `POST /_matrix/client/unstable/account/3pid/unbind` endpoint from [MSC2140](matrix-org/matrix-spec-proposals#2140) for unbinding a 3PID from an identity server without removing it from the homeserver user account. ([\#5980](#5980), [\#6062](#6062)) - Use `account_threepid_delegate.email` and `account_threepid_delegate.msisdn` for validating threepid sessions. ([\#6011](#6011)) - Allow homeserver to handle or delegate email validation when adding an email to a user's account. ([\#6042](#6042)) - Implement new Client Server API endpoints `/account/3pid/add` and `/account/3pid/bind` as per [MSC2290](matrix-org/matrix-spec-proposals#2290). ([\#6043](#6043)) - Add an unstable feature flag for separate add/bind 3pid APIs. ([\#6044](#6044)) - Remove `bind` parameter from Client Server POST `/account` endpoint as per [MSC2290](matrix-org/matrix-spec-proposals#2290). ([\#6067](#6067)) - Add `POST /add_threepid/msisdn/submit_token` endpoint for proxying submitToken on an `account_threepid_handler`. ([\#6078](#6078)) - Add `submit_url` response parameter to `*/msisdn/requestToken` endpoints. ([\#6079](#6079)) - Add `m.require_identity_server` flag to /version's unstable_features. ([\#5972](#5972)) - Enhancements to OpenTracing support: - Make OpenTracing work in worker mode. ([\#5771](#5771)) - Pass OpenTracing contexts between servers when transmitting EDUs. ([\#5852](#5852)) - OpenTracing for device list updates. ([\#5853](#5853)) - Add a tag recording a request's authenticated entity and corresponding servlet in OpenTracing. ([\#5856](#5856)) - Add minimum OpenTracing for client servlets. ([\#5983](#5983)) - Check at setup that OpenTracing is installed if it's enabled in the config. ([\#5985](#5985)) - Trace replication send times. ([\#5986](#5986)) - Include missing OpenTracing contexts in outbout replication requests. ([\#5982](#5982)) - Fix sending of EDUs when OpenTracing is enabled with an empty whitelist. ([\#5984](#5984)) - Fix invalid references to None while OpenTracing if the log context slips. ([\#5988](#5988), [\#5991](#5991)) - OpenTracing for room and e2e keys. ([\#5855](#5855)) - Add OpenTracing span over HTTP push processing. ([\#6003](#6003)) - Add an admin API to purge old rooms from the database. ([\#5845](#5845)) - Retry well-known lookups if we have recently seen a valid well-known record for the server. ([\#5850](#5850)) - Add support for filtered room-directory search requests over federation ([MSC2197](matrix-org/matrix-spec-proposals#2197), in order to allow upcoming room directory query performance improvements. ([\#5859](#5859)) - Correctly retry all hosts returned from SRV when we fail to connect. ([\#5864](#5864)) - Add admin API endpoint for setting whether or not a user is a server administrator. ([\#5878](#5878)) - Enable cleaning up extremities with dummy events by default to prevent undue build up of forward extremities. ([\#5884](#5884)) - Add config option to sign remote key query responses with a separate key. ([\#5895](#5895)) - Add support for config templating. ([\#5900](#5900)) - Users with the type of "support" or "bot" are no longer required to consent. ([\#5902](#5902)) - Let synctl accept a directory of config files. ([\#5904](#5904)) - Increase max display name size to 256. ([\#5906](#5906)) - Add admin API endpoint for getting whether or not a user is a server administrator. ([\#5914](#5914)) - Redact events in the database that have been redacted for a week. ([\#5934](#5934)) - New prometheus metrics: - `synapse_federation_known_servers`: represents the total number of servers your server knows about (i.e. is in rooms with), including itself. Enable by setting `metrics_flags.known_servers` to True in the configuration.([\#5981](#5981)) - `synapse_build_info`: exposes the Python version, OS version, and Synapse version of the running server. ([\#6005](#6005)) - Give appropriate exit codes when synctl fails. ([\#5992](#5992)) - Apply the federation blacklist to requests to identity servers. ([\#6000](#6000)) - Add `report_stats_endpoint` option to configure where stats are reported to, if enabled. Contributed by @Sorunome. ([\#6012](#6012)) - Add config option to increase ratelimits for room admins redacting messages. ([\#6015](#6015)) - Stop sending federation transactions to servers which have been down for a long time. ([\#6026](#6026)) - Make the process for mapping SAML2 users to matrix IDs more flexible. ([\#6037](#6037)) - Return a clearer error message when a timeout occurs when attempting to contact an identity server. ([\#6073](#6073)) - Prevent password reset's submit_token endpoint from accepting trailing slashes. ([\#6074](#6074)) - Return 403 on `/register/available` if registration has been disabled. ([\#6082](#6082)) - Explicitly log when a homeserver does not have the `trusted_key_servers` config field configured. ([\#6090](#6090)) - Add support for pruning old rows in `user_ips` table. ([\#6098](#6098)) Bugfixes -------- - Don't create broken room when `power_level_content_override.users` does not contain `creator_id`. ([\#5633](#5633)) - Fix database index so that different backup versions can have the same sessions. ([\#5857](#5857)) - Fix Synapse looking for config options `password_reset_failure_template` and `password_reset_success_template`, when they are actually `password_reset_template_failure_html`, `password_reset_template_success_html`. ([\#5863](#5863)) - Fix stack overflow when recovering an appservice which had an outage. ([\#5885](#5885)) - Fix error message which referred to `public_base_url` instead of `public_baseurl`. Thanks to @aaronraimist for the fix! ([\#5909](#5909)) - Fix 404 for thumbnail download when `dynamic_thumbnails` is `false` and the thumbnail was dynamically generated. Fix reported by rkfg. ([\#5915](#5915)) - Fix a cache-invalidation bug for worker-based deployments. ([\#5920](#5920)) - Fix admin API for listing media in a room not being available with an external media repo. ([\#5966](#5966)) - Fix list media admin API always returning an error. ([\#5967](#5967)) - Fix room and user stats tracking. ([\#5971](#5971), [\#5998](#5998), [\#6029](#6029)) - Return a `M_MISSING_PARAM` if `sid` is not provided to `/account/3pid`. ([\#5995](#5995)) - `federation_certificate_verification_whitelist` now will not cause `TypeErrors` to be raised (a regression in 1.3). Additionally, it now supports internationalised domain names in their non-canonical representation. ([\#5996](#5996)) - Only count real users when checking for auto-creation of auto-join room. ([\#6004](#6004)) - Ensure support users can be registered even if MAU limit is reached. ([\#6020](#6020)) - Fix bug where login error was shown incorrectly on SSO fallback login. ([\#6024](#6024)) - Fix bug in calculating the federation retry backoff period. ([\#6025](#6025)) - Prevent exceptions being logged when extremity-cleanup events fail due to lack of user consent to the terms of service. ([\#6053](#6053)) - Remove POST method from password-reset `submit_token` endpoint until we implement `submit_url` functionality. ([\#6056](#6056)) - Fix logcontext spam on non-Linux platforms. ([\#6059](#6059)) - Ensure query parameters in email validation links are URL-encoded. ([\#6063](#6063)) - Fix a bug which caused SAML attribute maps to be overridden by defaults. ([\#6069](#6069)) - Fix the logged number of updated items for the `users_set_deactivated_flag` background update. ([\#6092](#6092)) - Add `sid` to `next_link` for email validation. ([\#6097](#6097)) - Threepid validity checks on msisdns should not be dependent on `threepid_behaviour_email`. ([\#6104](#6104)) - Ensure that servers which are not configured to support email address verification do not offer it in the registration flows. ([\#6107](#6107)) Updates to the Docker image --------------------------- - Avoid changing `UID/GID` if they are already correct. ([\#5970](#5970)) - Provide `SYNAPSE_WORKER` envvar to specify python module. ([\#6058](#6058)) Improved Documentation ---------------------- - Convert documentation to markdown (from rst) ([\#5849](#5849)) - Update `INSTALL.md` to say that Python 2 is no longer supported. ([\#5953](#5953)) - Add developer documentation for using SAML2. ([\#6032](#6032)) - Add some notes on rolling back to v1.3.1. ([\#6049](#6049)) - Update the upgrade notes. ([\#6050](#6050)) Deprecations and Removals ------------------------- - Remove shared-secret registration from `/_matrix/client/r0/register` endpoint. Contributed by Awesome Technologies Innovationslabor GmbH. ([\#5877](#5877)) - Deprecate the `trusted_third_party_id_servers` option. ([\#5875](#5875)) Internal Changes ---------------- - Lay the groundwork for structured logging output. ([\#5680](#5680)) - Retry well-known lookup before the cache expires, giving a grace period where the remote well-known can be down but we still use the old result. ([\#5844](#5844)) - Remove log line for debugging issue #5407. ([\#5860](#5860)) - Refactor the Appservice scheduler code. ([\#5886](#5886)) - Compatibility with v2 Identity Service APIs other than /lookup. ([\#5892](#5892), [\#6013](#6013)) - Stop populating some unused tables. ([\#5893](#5893), [\#6047](#6047)) - Add missing index on `users_in_public_rooms` to improve the performance of directory queries. ([\#5894](#5894)) - Improve the logging when we have an error when fetching signing keys. ([\#5896](#5896)) - Add support for database engine-specific schema deltas, based on file extension. ([\#5911](#5911)) - Update Buildkite pipeline to use plugins instead of buildkite-agent commands. ([\#5922](#5922)) - Add link in sample config to the logging config schema. ([\#5926](#5926)) - Remove unnecessary parentheses in return statements. ([\#5931](#5931)) - Remove unused `jenkins/prepare_sytest.sh` file. ([\#5938](#5938)) - Move Buildkite pipeline config to the pipelines repo. ([\#5943](#5943)) - Remove unnecessary return statements in the codebase which were the result of a regex run. ([\#5962](#5962)) - Remove left-over methods from v1 registration API. ([\#5963](#5963)) - Cleanup event auth type initialisation. ([\#5975](#5975)) - Clean up dependency checking at setup. ([\#5989](#5989)) - Update OpenTracing docs to use the unified `trace` method. ([\#5776](#5776)) - Small refactor of function arguments and docstrings in` RoomMemberHandler`. ([\#6009](#6009)) - Remove unused `origin` argument on `FederationHandler.add_display_name_to_third_party_invite`. ([\#6010](#6010)) - Add a `failure_ts` column to the `destinations` database table. ([\#6016](#6016), [\#6072](#6072)) - Clean up some code in the retry logic. ([\#6017](#6017)) - Fix the structured logging tests stomping on the global log configuration for subsequent tests. ([\#6023](#6023)) - Clean up the sample config for SAML authentication. ([\#6064](#6064)) - Change mailer logging to reflect Synapse doesn't just do chat notifications by email now. ([\#6075](#6075)) - Move last-seen info into devices table. ([\#6089](#6089)) - Remove unused parameter to `get_user_id_by_threepid`. ([\#6099](#6099)) - Refactor the user-interactive auth handling. ([\#6105](#6105)) - Refactor code for calculating registration flows. ([\#6106](#6106))
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.
Fixes #5833Moved out to#5863Part of fixing #5751
Decouples the activity of sending registration emails and binding them to an identity server.
This PR simply sends the registration email, but clicking it does not approve the user for registration. That will come in PR #2.
Some of this makes use of existing stuff for sending password reset emails from Synapse. Some work was done to make that stuff even more generic.
Upgrade notes:
There is a new top-level config option,
account_threepid_delegatewhich defines the address of an identity server that you would like to send registration/password reset emails on your behalf.The option
email.trust_identity_server_for_password_resetshas been replaced by this. If you setemail.trust_identity_server_for_password_resetsin your config totrue, please remove it and configureaccount_threepid_delegateinstead. The sample config has information on how to configure it.TODO:
account_threepid_delegateNote: This PR does not allow homeservers to send emails when simply adding an email to your account. That will come after this and will be blocked on a new MSC.
Part [2/2] will be successfully completing the registration step when
/submit_tokenis hit with the correct details, and clearing out thepassword_servletflag stuff, which is no longer needed. Will be a much smaller PR than this one.Requires #5863has been merged into the base branch.Requires #5876has been merged into the base branch.