cqrenet/mxids
3
0
Fork 0
Code Pull Requests 10 Actions Releases Activity
Files
9af0cd3615d94fda915b32690fdc0880ca970cb0
mxids/docs/features/authentication.md
Maxime Dor 30260af1f2 More documentation
2017-10-07 17:59:55 +02:00

2.8 KiB
Raw Blame History

Authentication

Authentication is an enchanced Identity feature of mxisd to ensure coherent and centralized identity management.

It allows to use Identity stores configured in mxisd to authenticate users on your Homeserver.

Overview

                                                                                    Backends
 Client                                                                             +------+
   |                                            +-------------------------+    +--> | LDAP |
   |   +---------------+  /_matrix/identity     | mxisd                   |    |    +------+
   +-> | Reverse proxy | >------------------+   |                         |    |
       +--|------------+                    |   |                         |    |    +--------+
          |                                 +-----> Check wiht backends >------+--> | SQL DB |
     Login request                          |   |                         |    |    +--------+
          |                                 |   |     |                   |    |
          |   +--------------------------+  |   +-----|-------------------+    +-->  Others
          +-> | Homeserver               |  |         |
              |                          |  |         |
              | - Validate credentials >----+         |
              |   Using REST auth module |            |
              |                          |            |
              | - Auto-provision <-------------------<+
              |   user profiles          |    If valid credentials and supported by backend
              +--------------------------+

Performed on synapse with REST auth module

Getting started

Synapse

You will need:

Once installed, edit your synapse configuration as described for the auth module:

  • Set endpoint to http://mxisdAddress:8090 - Replace mxisdAddress to an internal IP/Hostname.
  • If you want to avoid known issues with lower/upper case usernames, set enforceLowercase in the REST config to true.

IMPORTANT: if this is a new installation, it is highly recommended to enforce lowercase, as it is not possible to workaround the bug at a later date and will cause issues with invites, searches, authentication.

Restart synapse and login on the Homeserver using credentials present in your backend.

Profile auto-fill

Auto-filling user profile depends on two conditions:

  • The REST auth module is configured for it, which is the case by default
  • Your Identity store is configured to provide profile data. See your Identity store documentation on how to enable the feature.