Synapse Mozilla SAML MXID 映射器

一个Synapse插件模块，允许用户在首次登录时选择他们的用户名。

安装

此插件可以通过PyPi安装

pip install matrix-synapse-saml-mozilla

配置

在您的Synapse配置中添加以下内容

   saml2_config:
     user_mapping_provider:
       module: "matrix_synapse_saml_mozilla.SamlMappingProvider"

此外，在HTTP客户端的listener下，根据以下内容配置一个additional_resource

listeners:
  - port: <port>
    type: http

    resources:
      - names: [client]

    additional_resources:
      "/_matrix/saml2/pick_username":
        module: "matrix_synapse_saml_mozilla.pick_username_resource"

配置选项

Synapse允许SAML映射提供者通过saml2_config.user_mapping_provider.config选项指定自定义配置。

目前支持以下选项

• use_name_id_for_remote_uid：如果设置为False，我们将使用映射到uid的SAML属性来识别远程用户，而不是使用断言中的NameID。默认为True。

• bad_domain_file：应指向一个包含域名列表的文件（每行一个域名）；任何这些域名的电子邮件地址的用户将被阻止注册。

• bad_domain_list：bad_domain_file的替代方案，允许在配置中直接指定坏域名列表。

  如果同时指定了bad_domain_file和bad_domain_list，则两个列表将被合并。

实现说明

登录流程看起来像这样

开发和测试

此存储库使用tox来运行代码审查和测试。

代码审查

使用flake8工具对代码进行审查。运行tox -e lint以检查代码库中的审查错误。

测试

此存储库使用unittest来运行位于tests目录中的测试。可以使用tox -e tests运行它们。

发布版本

git tag vX.Y
python3 setup.py sdist
twine upload dist/matrix-synapse-saml-mozilla-X.Y.tar.gz
git push origin vX.Y