An Mozilla-flavoured SAML MXID mapper for Synapse
Project description
Synapse Mozilla SAML MXID Mapper
A Synapse plugin module which allows users to choose their username when they first log in.
Installation
This plugin can be installed via PyPi:
pip install matrix-synapse-saml-mozilla
Config
Add the following in your Synapse config:
saml2_config:
user_mapping_provider:
module: "matrix_synapse_saml_mozilla.SamlMappingProvider"
Also, under the HTTP client listener
, configure an additional_resource
as per
the below:
listeners:
- port: <port>
type: http
resources:
- names: [client]
additional_resources:
"/_matrix/saml2/pick_username":
module: "matrix_synapse_saml_mozilla.pick_username_resource"
Configuration Options
Synapse allows SAML mapping providers to specify custom configuration through the
saml2_config.user_mapping_provider.config
option.
There are no options currently supported by this provider.
Implementation notes
The login flow looks something like this:
Development and Testing
This repository uses tox
to run linting and tests.
Linting
Code is linted with the flake8
tool. Run tox -e lint
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for matrix-synapse-saml-mozilla-0.1.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d6fec56473a7eff28598c9ddeb54b11fd23cbcad974243ba1e1c5d8b1426705 |
|
MD5 | 2ac85bb7af668608352914fa9f713eef |
|
BLAKE2b-256 | 2bc4a734ff65b7266a5a9ba77b76b98fd3105fee655cf4498e4567a67af0ee01 |