n0emis
/
matrix-synapse-saml-mozilla
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
27 Commits
1 Branch
0 Tags
139 KiB
Python 67.8%
JavaScript 16.7%
CSS 10.7%
HTML 4.8%
 
 
 
 
master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '3227404c1b'
${ noResults }
Go to file
Richard van der Hoff 3227404c1b 0.1.dev5 6 years ago
doc Allow users to pick a username on login (#1) 6 years ago
matrix_synapse_saml_mozilla 0.1.dev5 6 years ago
tests add tests for get_remote_user_id 6 years ago
.gitignore Initial commit 6 years ago
LICENSE Initial commit 6 years ago
MANIFEST.in Allow users to pick a username on login (#1) 6 years ago
README.md fix link for login flow 6 years ago
requirements.txt Initial commit 6 years ago
setup.cfg Allow users to pick a username on login (#1) 6 years ago
setup.py Install the resource files with the package 6 years ago
tox.ini Allow users to pick a username on login (#1) 6 years ago

README.md

Synapse Mozilla SAML MXID Mapper

A Synapse plugin module which allows users to choose their username when they first log in.

Installation

This plugin can be installed via PyPi:

pip install matrix-synapse-saml-mozilla

Config

Add the following in your Synapse config:

   saml2_config:
     user_mapping_provider:
       module: "matrix_synapse_saml_mozilla.SamlMappingProvider"

Also, under the HTTP client listener, configure an additional_resource as per the below:

listeners:
  - port: <port>
    type: http

    resources:
      - names: [client]

    additional_resources:
      "/_matrix/saml2/pick_username":
        module: "matrix_synapse_saml_mozilla.pick_username_resource"

Configuration Options

Synapse allows SAML mapping providers to specify custom configuration through the saml2_config.user_mapping_provider.config option.

There are no options currently supported by this provider.

Implementation notes

The login flow looks something like this:

login flow

Development and Testing

This repository uses tox to run linting and tests.

Linting

Code is linted with the flake8 tool. Run tox -e lint to check for linting errors in the codebase.

Tests

This repository uses unittest to run the tests located in the tests directory. They can be ran with tox -e tests.