Matrix Docker Ansible部署中OIDC集成问题的解决方案

在Matrix生态系统的部署过程中，使用Docker和Ansible的组合(spantaleev/matrix-docker-ansible-deploy)是一种常见且高效的方式。本文将详细介绍在配置Matrix Authentication Service(MAS)与上游OIDC提供商(如Authentik)集成时遇到的"User is undefined"错误及其解决方案。

问题背景

当管理员尝试通过Ansible playbook配置MAS与OIDC提供商(如Authentik)的集成时，在claims_imports部分配置用户属性映射模板时，系统会报出"User is undefined"的错误。这个错误表明模板引擎无法识别"user"变量，导致无法正确解析用户属性映射。

错误表现

典型的错误信息如下：

[{''id'': ''01HFRQFT5QFMJFGF01P7JAV2ME'', ''human_name'': ''Authentik'', ''issuer'': ''https://auth.REDACTED/application/o/mas/'', ''client_id'': ''REDACTED'', ''client_secret'': ''REDACTED'', ''scope'': ''openid profile email'', ''claims_imports'': {''localpart'': {''action'': ''require'', ''template'': ''{{ user.preferred_username }}''}, ''displayname'': {''action'': ''suggest'', ''template'': ''{{ user.name }}''}, ''email'': {''action'': ''suggest'', ''template'': ''{{ user.email }}'', ''set_email_verification'': ''always''}}}]: ''user'' is undefined. ''user'' is undefined'

根本原因

这个问题源于Ansible模板引擎与MAS配置模板之间的解析冲突。在Ansible playbook中直接使用双大括号{{ }}会导致Ansible尝试先解析这些内容，而此时"user"对象尚未定义，因为这是MAS在运行时才会提供的变量。

解决方案

解决这个问题的正确方法是在模板定义中使用{% raw %}和{% endraw %}标签包裹模板内容，告诉Ansible跳过对这些部分的解析。修改后的配置示例如下：

matrix_authentication_service_config_upstream_oauth2_providers:
  - id: 01HFRQFT5QFMJFGF01P7JAV2ME
    human_name: Authentik
    issuer: "https://auth.REDACTED.org/application/o/mas/"
    client_id: "REDACTED"
    client_secret: "REDACTED"
    scope: "openid profile email"
    claims_imports:
      localpart:
        action: require
        template: "{% raw %}{{ user.preferred_username }}{% endraw %}"
      displayname:
        action: suggest
        template: "{% raw %}{{ user.name }}{% endraw %}"
      email:
        action: suggest
        template: "{% raw %}{{ user.email }}{% endraw %}"
        set_email_verification: always

技术原理

1. Ansible模板处理机制：Ansible在解析YAML文件时会自动处理双大括号{{ }}中的内容作为Jinja2模板表达式。

2. MAS运行时模板：MAS在运行时需要原始的Jinja2模板来处理OIDC提供商返回的用户信息。

3. 冲突解决：{% raw %}标签指示Ansible保留其包裹内容原样输出，不进行解析，确保模板能够正确传递给MAS。

最佳实践

1. 对于所有MAS中的模板表达式，都应使用{% raw %}标签包裹。

2. 在测试OIDC集成时，建议先使用"suggest"而非"require"动作，以便更容易诊断问题。

3. 确保OIDC提供商(如Authentik)配置了正确的scope，以返回所需的用户属性。

通过这种解决方案，管理员可以成功配置MAS与OIDC提供商的集成，实现单点登录功能，同时保持Ansible部署流程的自动化特性。