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.
15 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 'ccbb42d66b'
${ noResults }
Go to file
Richard van der Hoff ccbb42d66b long_description is in markdown 5 years ago
tests Update tests 5 years ago
.gitignore Initial commit 5 years ago
LICENSE Initial commit 5 years ago
MANIFEST.in Initial commit 5 years ago
README.md Rename to matrix_synapse_saml_mozilla 5 years ago
matrix_synapse_saml_mozilla.py Rename to matrix_synapse_saml_mozilla 5 years ago
requirements.txt Initial commit 5 years ago
setup.cfg Initial commit 5 years ago
setup.py long_description is in markdown 5 years ago
tox.ini Initial commit 5 years ago

README.md

Synapse Mozilla SAML MXID Mapper

Custom SAML auth response -> MXID mapping algorithm used during the Mozilla Matrix trial run.

Installation

This plugin can be installed via PyPi:

pip install matrix-synapse-saml-mozilla

Usage

Config

Add the following in your Synapse config:

   saml2_config:
     user_mapping_provider:
       module: "matrix_synapse_saml_mozilla.SamlMappingProvider"
       config:
         mxid_source_attribute: "uid"

Configuration Options

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

The options supported by this provider are currently:

  • mxid_source_attribute - The SAML attribute (after mapping via the attribute maps) to use to derive the Matrix ID from. 'uid' by default.

Development and Testing

This repository uses tox to run linting and tests.

Linting

Code is linted with the flake8 tool. Run tox -e pep8 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.