n0emis
/
matrix-synapse-saml-mozilla
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
11 Commits
1 Branch
0 Tags
139 KiB
Python 67.8%
JavaScript 16.7%
CSS 10.7%
HTML 4.8%
 
 
 
 
Go to file
Andrew Morgan 2c913fcf94 Update module name to be moz flavoured
tests Initial commit
.gitignore Initial commit
LICENSE Initial commit
MANIFEST.in Initial commit
README.md Update module name to be moz flavoured
requirements.txt Initial commit
saml_mapping_provider.py Update module name to be moz flavoured
setup.cfg Initial commit
setup.py Update to latest synapse provider spec
tox.ini Initial commit

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: "saml_mapping_provider.MozillaSamlMappingProvider"
       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.