Persist user interactive authentication sessions #7302

clokep · 2020-04-17T17:56:07Z

Fixes #6705 by storing user interactive authentication sessions in the database.

I was able to test this with some of the directions I played with in #7268 (comment):

Login with an account
Go to the settings and delete a device
(You should see a password prompt come up, don't fill it in yet)
Restart the Synapse server (really what we're trying to do here is flush the cache of activate UI auth sessions)
Type in the password and continue the UI Auth session
The authentication completes.

This isn't quite the same as testing in worker mode, but I think it gets to the point

~~This is currently based on the branch from #7268.~~

Outstanding questions

I think this implies we'll be writing to the database from workers. Is this OK?
How do I handle removing expired entries? (Is there a way to run a task periodically or something else?) (We also need to do some work to update the last_used field properly.)
This has some of the same caveats as Explicitly create UI Auth sessions #7268 that an "unknown session" is outright rejected. See that PR for a conversation about that.

clokep · 2020-04-17T18:03:29Z

I'm requesting review on this to get some general feedback about the approach, see some of the questions in the description.

Additionally I haven't yet done anything with the storage layer of Synapse so I might have broken all sorts of rules! This has a few new things for me which is likely good to note for a reviewer:

A database migration
A new storage class
SQL queries

clokep · 2020-04-20T12:56:32Z

Rebased after #7268 was merged.

richvdh · 2020-04-20T13:00:20Z

I think this implies we'll be writing to the database from workers. Is this OK?

Typically we avoid it, because it leads to a whole bunch of problems with cache coherency (it's hard to invalidate caches on other workers except by starting at the master). But if there is no cache, it's typically ok.

How do I handle removing expired entries? (Is there a way to run a task periodically or something else?) (We also need to do some work to update the last_used field properly.)

yup, you want Clock.looping_call. (Also: generally you only want to do this sort of thing on one worker - typically the master - so you'll need to make that so.)

synapse/handlers/auth.py

synapse/storage/data_stores/main/ui_auth.py

synapse/app/generic_worker.py

synapse/storage/data_stores/main/ui_auth.py

clokep · 2020-04-21T13:47:44Z

synapse/storage/data_stores/main/schema/delta/58/persist_ui_auth.sql

+
+CREATE TABLE IF NOT EXISTS ui_auth_sessions(
+    session_id TEXT NOT NULL,  -- The session ID passed to the client.
+    last_used BIGINT NOT NULL,  -- The last time this session was seen (epoch time in milliseconds).


I originally had UNSIGNED on this, but postgresql didn't seem to like this.

clokep · 2020-04-21T14:04:03Z

I believe this is ready for review!

richvdh

generally looks excellent. A few minor requests.

synapse/app/generic_worker.py

synapse/handlers/auth.py

synapse/storage/data_stores/main/ui_auth.py

synapse/handlers/auth.py

synapse/storage/data_stores/main/ui_auth.py

synapse/storage/data_stores/main/schema/delta/58/persist_ui_auth.sql

Old review

richvdh

looks generally good. a few more nits.

synapse/storage/data_stores/main/ui_auth.py

synapse/handlers/auth.py

synapse/storage/data_stores/main/ui_auth.py

clokep · 2020-04-29T21:20:05Z

I think this is ready for review again... since the last review the following was changed:

Some minor changes to the method names based on feedback.
Improved docstrings, in particular around error situations.
Do not have the datastore raise SynapseError.
Use foreign keys between the two tables this adds. This allows us to avoid the race condition noticed in review.

richvdh

generally I'm not sure we should be returning 404s when people try to update sessions which don't exist. We probably need to catch the StoreError in the handler layer or something.

WDYT though?

synapse/storage/data_stores/main/ui_auth.py

tests/rest/client/v2_alpha/test_auth.py

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

clokep · 2020-04-30T15:04:06Z

generally I'm not sure we should be returning 404s when people try to update sessions which don't exist. We probably need to catch the StoreError in the handler layer or something.

WDYT though?

I'm not sure if one makes more sense to me than the other. It is probably best not to change the result though. I think I'll need to catch StoreError in a bunch of places, unfortunately.

clokep · 2020-04-30T15:20:18Z

generally I'm not sure we should be returning 404s when people try to update sessions which don't exist. We probably need to catch the StoreError in the handler layer or something.
WDYT though?

I'm not sure if one makes more sense to me than the other. It is probably best not to change the result though. I think I'll need to catch StoreError in a bunch of places, unfortunately.

Actually looks like this was from a StoreError I was manually raising. I'll take a look at other spots though and see if we need to catch these errors.

clokep · 2020-04-30T16:53:37Z

This should consistently return a 400 error now.

richvdh

I think it might be a mistake to assume that all StoreErrors mean "session id not found", but honestly I think we should just land this now rather than keep fiddling with it.

@nekatak

Synapse 1.13.0 (2020-05-19) =========================== This release brings some potential changes necessary for certain configurations of Synapse: * If your Synapse is configured to use SSO and have a custom `sso_redirect_confirm_template_dir` configuration option set, you will need to duplicate the new `sso_auth_confirm.html`, `sso_auth_success.html` and `sso_account_deactivated.html` templates into that directory. * Synapse plugins using the `complete_sso_login` method of `synapse.module_api.ModuleApi` should instead switch to the async/await version, `complete_sso_login_async`, which includes additional checks. The former version is now deprecated. * A bug was introduced in Synapse 1.4.0 which could cause the room directory to be incomplete or empty if Synapse was upgraded directly from v1.2.1 or earlier, to versions between v1.4.0 and v1.12.x. Please review [UPGRADE.rst](https://github.com/matrix-org/synapse/blob/master/UPGRADE.rst) for more details on these changes and for general upgrade guidance. Notice of change to the default `git` branch for Synapse -------------------------------------------------------- With the release of Synapse 1.13.0, the default `git` branch for Synapse has changed to `develop`, which is the development tip. This is more consistent with common practice and modern `git` usage. The `master` branch, which tracks the latest release, is still available. It is recommended that developers and distributors who have scripts which run builds using the default branch of Synapse should therefore consider pinning their scripts to `master`. Features -------- - Extend the `web_client_location` option to accept an absolute URL to use as a redirect. Adds a warning when running the web client on the same hostname as homeserver. Contributed by Martin Milata. ([\#7006](#7006)) - Set `Referrer-Policy` header to `no-referrer` on media downloads. ([\#7009](#7009)) - Add support for running replication over Redis when using workers. ([\#7040](#7040), [\#7325](#7325), [\#7352](#7352), [\#7401](#7401), [\#7427](#7427), [\#7439](#7439), [\#7446](#7446), [\#7450](#7450), [\#7454](#7454)) - Admin API `POST /_synapse/admin/v1/join/<roomIdOrAlias>` to join users to a room like `auto_join_rooms` for creation of users. ([\#7051](#7051)) - Add options to prevent users from changing their profile or associated 3PIDs. ([\#7096](#7096)) - Support SSO in the user interactive authentication workflow. ([\#7102](#7102), [\#7186](#7186), [\#7279](#7279), [\#7343](#7343)) - Allow server admins to define and enforce a password policy ([MSC2000](matrix-org/matrix-spec-proposals#2000)). ([\#7118](#7118)) - Improve the support for SSO authentication on the login fallback page. ([\#7152](#7152), [\#7235](#7235)) - Always whitelist the login fallback in the SSO configuration if `public_baseurl` is set. ([\#7153](#7153)) - Admin users are no longer required to be in a room to create an alias for it. ([\#7191](#7191)) - Require admin privileges to enable room encryption by default. This does not affect existing rooms. ([\#7230](#7230)) - Add a config option for specifying the value of the Accept-Language HTTP header when generating URL previews. ([\#7265](#7265)) - Allow `/requestToken` endpoints to hide the existence (or lack thereof) of 3PID associations on the homeserver. ([\#7315](#7315)) - Add a configuration setting to tweak the threshold for dummy events. ([\#7422](#7422)) Bugfixes -------- - Don't attempt to use an invalid sqlite config if no database configuration is provided. Contributed by @nekatak. ([\#6573](#6573)) - Fix single-sign on with CAS systems: pass the same service URL when requesting the CAS ticket and when calling the `proxyValidate` URL. Contributed by @Naugrimm. ([\#6634](#6634)) - Fix missing field `default` when fetching user-defined push rules. ([\#6639](#6639)) - Improve error responses when accessing remote public room lists. ([\#6899](#6899), [\#7368](#7368)) - Transfer alias mappings on room upgrade. ([\#6946](#6946)) - Ensure that a user interactive authentication session is tied to a single request. ([\#7068](#7068), [\#7455](#7455)) - Fix a bug in the federation API which could cause occasional "Failed to get PDU" errors. ([\#7089](#7089)) - Return the proper error (`M_BAD_ALIAS`) when a non-existant canonical alias is provided. ([\#7109](#7109)) - Fix a bug which meant that groups updates were not correctly replicated between workers. ([\#7117](#7117)) - Fix starting workers when federation sending not split out. ([\#7133](#7133)) - Ensure `is_verified` is a boolean in responses to `GET /_matrix/client/r0/room_keys/keys`. Also warn the user if they forgot the `version` query param. ([\#7150](#7150)) - Fix error page being shown when a custom SAML handler attempted to redirect when processing an auth response. ([\#7151](#7151)) - Avoid importing `sqlite3` when using the postgres backend. Contributed by David Vo. ([\#7155](#7155)) - Fix excessive CPU usage by `prune_old_outbound_device_pokes` job. ([\#7159](#7159)) - Fix a bug which could cause outbound federation traffic to stop working if a client uploaded an incorrect e2e device signature. ([\#7177](#7177)) - Fix a bug which could cause incorrect 'cyclic dependency' error. ([\#7178](#7178)) - Fix a bug that could cause a user to be invited to a server notices (aka System Alerts) room without any notice being sent. ([\#7199](#7199)) - Fix some worker-mode replication handling not being correctly recorded in CPU usage stats. ([\#7203](#7203)) - Do not allow a deactivated user to login via SSO. ([\#7240](#7240), [\#7259](#7259)) - Fix --help command-line argument. ([\#7249](#7249)) - Fix room publish permissions not being checked on room creation. ([\#7260](#7260)) - Reject unknown session IDs during user interactive authentication instead of silently creating a new session. ([\#7268](#7268)) - Fix a SQL query introduced in Synapse 1.12.0 which could cause large amounts of logging to the postgres slow-query log. ([\#7274](#7274)) - Persist user interactive authentication sessions across workers and Synapse restarts. ([\#7302](#7302)) - Fixed backwards compatibility logic of the first value of `trusted_third_party_id_servers` being used for `account_threepid_delegates.email`, which occurs when the former, deprecated option is set and the latter is not. ([\#7316](#7316)) - Fix a bug where event updates might not be sent over replication to worker processes after the stream falls behind. ([\#7337](#7337), [\#7358](#7358)) - Fix bad error handling that would cause Synapse to crash if it's provided with a YAML configuration file that's either empty or doesn't parse into a key-value map. ([\#7341](#7341)) - Fix incorrect metrics reporting for `renew_attestations` background task. ([\#7344](#7344)) - Prevent non-federating rooms from appearing in responses to federated `POST /publicRoom` requests when a filter was included. ([\#7367](#7367)) - Fix a bug which would cause the room durectory to be incorrectly populated if Synapse was upgraded directly from v1.2.1 or earlier to v1.4.0 or later. Note that this fix does not apply retrospectively; see the [upgrade notes](UPGRADE.rst#upgrading-to-v1130) for more information. ([\#7387](#7387)) - Fix bug in `EventContext.deserialize`. ([\#7393](#7393)) - Fix a long-standing bug which could cause messages not to be sent over federation, when state events with state keys matching user IDs (such as custom user statuses) were received. ([\#7376](#7376)) - Restore compatibility with non-compliant clients during the user interactive authentication process, fixing a problem introduced in v1.13.0rc1. ([\#7483](#7483)) - Hash passwords as early as possible during registration. ([\#7523](#7523)) Improved Documentation ---------------------- - Update Debian installation instructions to recommend installing the `virtualenv` package instead of `python3-virtualenv`. ([\#6892](#6892)) - Improve the documentation for database configuration. ([\#6988](#6988)) - Improve the documentation of application service configuration files. ([\#7091](#7091)) - Update pre-built package name for FreeBSD. ([\#7107](#7107)) - Update postgres docs with login troubleshooting information. ([\#7119](#7119)) - Clean up INSTALL.md a bit. ([\#7141](#7141)) - Add documentation for running a local CAS server for testing. ([\#7147](#7147)) - Improve README.md by being explicit about public IP recommendation for TURN relaying. ([\#7167](#7167)) - Fix a small typo in the `metrics_flags` config option. ([\#7171](#7171)) - Update the contributed documentation on managing synapse workers with systemd, and bring it into the core distribution. ([\#7234](#7234)) - Add documentation to the `password_providers` config option. Add known password provider implementations to docs. ([\#7238](#7238), [\#7248](#7248)) - Modify suggested nginx reverse proxy configuration to match Synapse's default file upload size. Contributed by @ProCycleDev. ([\#7251](#7251)) - Documentation of media_storage_providers options updated to avoid misunderstandings. Contributed by Tristan Lins. ([\#7272](#7272)) - Add documentation on monitoring workers with Prometheus. ([\#7357](#7357)) - Clarify endpoint usage in the users admin api documentation. ([\#7361](#7361)) Deprecations and Removals ------------------------- - Remove nonfunctional `captcha_bypass_secret` option from `homeserver.yaml`. ([\#7137](#7137)) Internal Changes ---------------- - Add benchmarks for LruCache. ([\#6446](#6446)) - Return total number of users and profile attributes in admin users endpoint. Contributed by Awesome Technologies Innovationslabor GmbH. ([\#6881](#6881)) - Change device list streams to have one row per ID. ([\#7010](#7010)) - Remove concept of a non-limited stream. ([\#7011](#7011)) - Move catchup of replication streams logic to worker. ([\#7024](#7024), [\#7195](#7195), [\#7226](#7226), [\#7239](#7239), [\#7286](#7286), [\#7290](#7290), [\#7318](#7318), [\#7326](#7326), [\#7378](#7378), [\#7421](#7421)) - Convert some of synapse.rest.media to async/await. ([\#7110](#7110), [\#7184](#7184), [\#7241](#7241)) - De-duplicate / remove unused REST code for login and auth. ([\#7115](#7115)) - Convert `*StreamRow` classes to inner classes. ([\#7116](#7116)) - Clean up some LoggingContext code. ([\#7120](#7120), [\#7181](#7181), [\#7183](#7183), [\#7408](#7408), [\#7426](#7426)) - Add explicit `instance_id` for USER_SYNC commands and remove implicit `conn_id` usage. ([\#7128](#7128)) - Refactored the CAS authentication logic to a separate class. ([\#7136](#7136)) - Run replication streamers on workers. ([\#7146](#7146)) - Add tests for outbound device pokes. ([\#7157](#7157)) - Fix device list update stream ids going backward. ([\#7158](#7158)) - Use `stream.current_token()` and remove `stream_positions()`. ([\#7172](#7172)) - Move client command handling out of TCP protocol. ([\#7185](#7185)) - Move server command handling out of TCP protocol. ([\#7187](#7187)) - Fix consistency of HTTP status codes reported in log lines. ([\#7188](#7188)) - Only run one background database update at a time. ([\#7190](#7190)) - Remove sent outbound device list pokes from the database. ([\#7192](#7192)) - Add a background database update job to clear out duplicate `device_lists_outbound_pokes`. ([\#7193](#7193)) - Remove some extraneous debugging log lines. ([\#7207](#7207)) - Add explicit Python build tooling as dependencies for the snapcraft build. ([\#7213](#7213)) - Add typing information to federation server code. ([\#7219](#7219)) - Extend room admin api (`GET /_synapse/admin/v1/rooms`) with additional attributes. ([\#7225](#7225)) - Unblacklist '/upgrade creates a new room' sytest for workers. ([\#7228](#7228)) - Remove redundant checks on `daemonize` from synctl. ([\#7233](#7233)) - Upgrade jQuery to v3.4.1 on fallback login/registration pages. ([\#7236](#7236)) - Change log line that told user to implement onLogin/onRegister fallback js functions to a warning, instead of an info, so it's more visible. ([\#7237](#7237)) - Correct the parameters of a test fixture. Contributed by Isaiah Singletary. ([\#7243](#7243)) - Convert auth handler to async/await. ([\#7261](#7261)) - Add some unit tests for replication. ([\#7278](#7278)) - Improve typing annotations in `synapse.replication.tcp.streams.Stream`. ([\#7291](#7291)) - Reduce log verbosity of url cache cleanup tasks. ([\#7295](#7295)) - Fix sample SAML Service Provider configuration. Contributed by @frcl. ([\#7300](#7300)) - Fix StreamChangeCache to work with multiple entities changing on the same stream id. ([\#7303](#7303)) - Fix an incorrect import in IdentityHandler. ([\#7319](#7319)) - Reduce logging verbosity for successful federation requests. ([\#7321](#7321)) - Convert some federation handler code to async/await. ([\#7338](#7338)) - Fix collation for postgres for unit tests. ([\#7359](#7359)) - Convert RegistrationWorkerStore.is_server_admin and dependent code to async/await. ([\#7363](#7363)) - Add an `instance_name` to `RDATA` and `POSITION` replication commands. ([\#7364](#7364)) - Thread through instance name to replication client. ([\#7369](#7369)) - Convert synapse.server_notices to async/await. ([\#7394](#7394)) - Convert synapse.notifier to async/await. ([\#7395](#7395)) - Fix issues with the Python package manifest. ([\#7404](#7404)) - Prevent methods in `synapse.handlers.auth` from polling the homeserver config every request. ([\#7420](#7420)) - Speed up fetching device lists changes when handling `/sync` requests. ([\#7423](#7423)) - Run group attestation renewal in series rather than parallel for performance. ([\#7442](#7442)) - Fix linting errors in new version of Flake8. ([\#7470](#7470)) - Update the version of dh-virtualenv we use to build debs, and add focal to the list of target distributions. ([\#7526](#7526))

By persisting the user interactive authentication sessions to the database, this fixes situations where a user hits different works throughout their auth session and also allows sessions to persist through restarts of Synapse.

clokep force-pushed the clokep/persist-ui-auth-sessions branch from 131f797 to adb7e3a Compare April 17, 2020 17:58

clokep requested a review from a team April 17, 2020 18:01

clokep force-pushed the clokep/persist-ui-auth-sessions branch from adb7e3a to 4cfc49c Compare April 17, 2020 18:02

clokep mentioned this pull request Apr 17, 2020

Explicitly create UI Auth sessions #7268

Merged

clokep force-pushed the clokep/persist-ui-auth-sessions branch 2 times, most recently from b010c84 to 7453169 Compare April 20, 2020 12:56

richvdh reviewed Apr 20, 2020

View reviewed changes

synapse/handlers/auth.py Outdated Show resolved Hide resolved

clokep force-pushed the clokep/persist-ui-auth-sessions branch from 9628f4c to 67d5d63 Compare April 21, 2020 12:57

clokep commented Apr 21, 2020

View reviewed changes

synapse/storage/data_stores/main/ui_auth.py Outdated Show resolved Hide resolved

clokep commented Apr 21, 2020

View reviewed changes

synapse/app/generic_worker.py Outdated Show resolved Hide resolved

clokep commented Apr 21, 2020

View reviewed changes

synapse/storage/data_stores/main/ui_auth.py Outdated Show resolved Hide resolved

clokep commented Apr 21, 2020

View reviewed changes

clokep requested a review from richvdh April 21, 2020 14:03

clokep marked this pull request as ready for review April 21, 2020 14:03

richvdh previously requested changes Apr 22, 2020

View reviewed changes

clokep added 11 commits April 22, 2020 09:39

Persist the storage of UI Auth sessions into the database.

b030fdb

Ensure that UI auth stages are idempotent.

4a83da9

Fix postgresql issues.

e7a2db6

Add a changelog file.

b9dd110

Expire old sessions.

831f8a2

Keep the last_used time up-to-date.

04d3d8b

Properly run the looping call in the background.

0fdb22c

Properly call get_session as async.

3d9b3a8

Attempt to avoid clashes in session IDs.

b5fc1b9

Properly await runInteraction calls.

d9157c4

Add the UIAuthStore to workers.

ae45238

richvdh reviewed Apr 29, 2020

View reviewed changes

clokep added 4 commits April 29, 2020 09:43

Use _txn in method names.

64c709b

Document possible error states better.

568a778

Review feedback.

79c5be5

Do not directly raise SynapseError.

18b3494

clokep force-pushed the clokep/persist-ui-auth-sessions branch from 90bfcec to ae894ca Compare April 29, 2020 18:08

Use foreign keys to simplify logic.

5340662

clokep force-pushed the clokep/persist-ui-auth-sessions branch 2 times, most recently from 201d495 to 5340662 Compare April 29, 2020 19:05

clokep added 2 commits April 29, 2020 16:03

Again fix idempotency of the registration API.

5f0bf19

Fix lint.

eccb670

clokep requested a review from richvdh April 29, 2020 21:18

richvdh reviewed Apr 30, 2020

View reviewed changes

synapse/storage/data_stores/main/ui_auth.py Outdated Show resolved Hide resolved

tests/rest/client/v2_alpha/test_auth.py Outdated Show resolved Hide resolved

Fix typo in docstring.

106dca9

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

Raise a 400 error, not 404.

64852bf

Convert StoreErrors to SynapseErrors.

ae27afd

clokep requested a review from richvdh April 30, 2020 16:53

richvdh approved these changes Apr 30, 2020

View reviewed changes

clokep merged commit 627b0f5 into develop Apr 30, 2020

clokep deleted the clokep/persist-ui-auth-sessions branch April 30, 2020 17:47

clokep mentioned this pull request Apr 30, 2020

User-Interactive Auth sessions need to be replicated across the processes of a worker-mode deployment #6705

Closed

clokep mentioned this pull request Jun 12, 2020

Fix a typo when comparing the URI & method during UI Auth. #7689

Merged

clokep mentioned this pull request Nov 25, 2020

User Interactive auth sessions are only stored in memory, so if you restart server mid-auth, auth will fail #2811

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Persist user interactive authentication sessions #7302

Persist user interactive authentication sessions #7302

clokep commented Apr 17, 2020 •

edited

Loading

clokep commented Apr 17, 2020

clokep commented Apr 20, 2020

richvdh commented Apr 20, 2020

clokep Apr 21, 2020

clokep commented Apr 21, 2020

richvdh left a comment

richvdh left a comment

clokep commented Apr 29, 2020

richvdh left a comment

clokep commented Apr 30, 2020

clokep commented Apr 30, 2020

clokep commented Apr 30, 2020

richvdh left a comment

Persist user interactive authentication sessions #7302

Persist user interactive authentication sessions #7302

Conversation

clokep commented Apr 17, 2020 • edited Loading

Outstanding questions

clokep commented Apr 17, 2020

clokep commented Apr 20, 2020

richvdh commented Apr 20, 2020

clokep Apr 21, 2020

Choose a reason for hiding this comment

clokep commented Apr 21, 2020

richvdh left a comment

Choose a reason for hiding this comment

richvdh left a comment

Choose a reason for hiding this comment

clokep commented Apr 29, 2020

richvdh left a comment

Choose a reason for hiding this comment

clokep commented Apr 30, 2020

clokep commented Apr 30, 2020

clokep commented Apr 30, 2020

richvdh left a comment

Choose a reason for hiding this comment

clokep commented Apr 17, 2020 •

edited

Loading