Skip to main content

An Mozilla-flavoured SAML MXID mapper for Synapse

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for matrix-synapse-saml-mozilla, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size matrix-synapse-saml-mozilla-0.0.1.tar.gz (8.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page