Matrix-Mirrors/anonymousland-synapse
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse.git synced 2025-08-08 22:02:16 -04:00
Code Issues Projects Releases Packages Wiki Activity

DB schema interface for password auth providers

Browse source 
Provide an interface by which password auth providers can register db schema
files to be run at startup
This commit is contained in:
Richard van der Hoff 2017-10-30 15:16:21 +00:00
parent c31a7c3ff6
commit 1650eb5847
3 changed files with 89 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/password_auth_providers.rst
View file

@ -37,3 +37,15 @@ Password auth provider classes must provide the following methods:
The method should return a Twisted ``Deferred`` object, which resolves to
``True`` if authentication is successful, and ``False`` if not.
Optional methods
----------------
Password provider classes may optionally provide the following methods.
*class* ``SomeProvider.get_db_schema_files()``
This method, if implemented, should return an Iterable of ``(name,
stream)`` pairs of database schema files. Each file is applied in turn at
initialisation, and a record is then made in the database so that it is
not re-applied on the next start.