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.
 
 
 
 
Andrew Morgan 24f2fbd8a0 Update package name, fix saml2 dep 5 years ago
tests Initial commit 5 years ago
.gitignore Initial commit 5 years ago
LICENSE Initial commit 5 years ago
MANIFEST.in Initial commit 5 years ago
README.md Update plugin to match ABI of Synapse 5 years ago
requirements.txt Initial commit 5 years ago
saml_mapping_provider.py Update plugin to match ABI of Synapse 5 years ago
setup.cfg Initial commit 5 years ago
setup.py Update package name, fix saml2 dep 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-moz

Usage

Config

Configure the following in your Synapse config:

   saml2_config:
     user_mapping_provider: "saml_mapping_provider.SamlMappingProvider"

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.