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.

Source Distribution

matrix-synapse-saml-mozilla-0.0.1.tar.gz (8.7 kB view details)

Uploaded Source

File details

Details for the file matrix-synapse-saml-mozilla-0.0.1.tar.gz.

File metadata

  • Download URL: matrix-synapse-saml-mozilla-0.0.1.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.8

File hashes

Hashes for matrix-synapse-saml-mozilla-0.0.1.tar.gz
Algorithm Hash digest
SHA256 5a3cf098b0746d3ea1edae61533b53943af8510922234c111832b20ced90825e
MD5 e8684c78b43d33e1f5746edb4532e650
BLAKE2b-256 04f4963c1dd945ba0560680932e1ab081f91a15d5262bf9671a6935ab58f62a3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page