totara/simple-saml-test

测试SAML IDP Docker镜像

这是一个SimpleSAMLphp的包装器，提供测试用的SAML身份提供者（IDP），用于Totara实例中的SAML2连接测试。该镜像仅适用于测试场景，不得用于任何生产环境。

当前嵌入的SimpleSAMLphp版本为2.0.3。若需测试1.19.7版本，请使用最新的v1.x标签。

配置说明

快速开始

shell
# 拉取镜像
docker pull totara/simple-saml-test:latest

# 启动服务
docker run --rm -p 8089:8089 -e LISTEN_PORT=8089 -it totara/simple-saml-test:latest

启动后，可通过http://localhost:{LISTEN_PORT}（默认8089）访问服务。

打开站点后，以管理员身份登录，导航至“管理服务提供者”页面，添加SP实例（需提供完整的元数据URL，不进行严格验证）。例如：http://{YOUR_SP_INSTANCE}/path/to/metadata.php。

注意：该镜像不支持原始XML转储，必须能直接从服务提供者下载元数据文件。若SP实例无法解析，可通过以下方式添加主机映射：

shell
# SP实例运行在主机上
docker run --add-host={YOUR_SP_INSTANCE}:host-gateway ... -it totara/simple-saml-test:latest

# SP实例在其他位置，替换域名和IP
docker run --add-host={YOUR_SP_INSTANCE}:{IP_OF_SITE} ... -it totara/simple-saml-test:latest

与Totara Docker Dev配合使用

若使用Totara Docker Dev库，可直接将该镜像添加到服务中：

1. 在Totara Docker项目的custom目录下创建saml.yml文件。
2. 添加以下内容：

yaml
version: "3.7"

services:
  saml2:
    image: totara/simple-saml-test:latest
    networks:
      - totara
    ports:
      - "8089:8089"
    environment:
      - LISTEN_PORT=8089
      - SITE_TITLE="Testing"

3. 将saml2添加到本地hosts文件，确保浏览器可解析。
4. 使用t up saml2启动服务，访问http://saml2:8089确认测试环境正常。

重要提示：Totara使用的URL与浏览器访问该站点的URL必须一致。元数据文件路径取决于所用的SAML插件，此处不具体说明。

自定义用户

默认包含硬编码的用户列表和属性，可通过卷挂载自定义PHP文件替换用户列表：

创建custom-auth-sources.php文件，结构如下：

php
<?php

return [
// username:password => [属性数组]
    'my_user:password1' => [
        'uid' => ['my_uid'],
        'username' => ['my_username'],
    ],
    'another:password' => [
        'uid' => ['another'],
        'username' => ['annie_example'],
        'firstname' => ['annie']
    ],
];

username:password部分用于IDP登录，内部数组为返回给SP的属性。例如，my_user用户在SP中显示为my_username或my_uid。

挂载方式：

shell
docker run ... -v /path/to/custom-auth-sources.php:/var/www/custom-auth-sources.php ... -it totara/simple-saml-test:latest

自定义IDP配置

若需修改./metadata/saml20-idp-hosted.php中的设置，可创建custom-saml20-idp-hosted.php文件，返回需覆盖或合并的设置数组：

挂载方式：

shell
docker run ... -v /path/to/custom-saml20-idp-hosted.php:/var/www/custom-saml20-idp-hosted.php ... -it totara/simple-saml-test:latest

启用其他证书

镜像提供三种证书：

• server.crt/server.pem：有效期10年的正常密钥
• new_server.crt/new_server.pem：另一个有效期10年的密钥
• expired_server.crt/expired_server.pem：已过期的密钥

默认使用第一个，可通过自定义配置切换：

php
# 切换到新密钥
return [
  'privatekey' => 'new_server.pem',
  'certificate' => 'new_server.crt',
];

# 同时使用常规和新密钥
return [
  'privatekey' => 'server.pem',
  'certificate' => 'server.crt',
  'new_privatekey' => 'new_server.pem',
  'new_certificate' => 'new_server.crt',
];

# 使用过期密钥
return [
  'privatekey' => 'expired_server.pem',
  'certificate' => 'expired_server.crt',
];

开发该镜像

1. Fork仓库，创建新分支并修改。
2. 使用docker-compose测试：docker-compose up --build dev（实时同步config/metadata/modules文件夹）。
3. 测试通过后，用docker-compose up --build prod测试生产版本。
4. 提交PR。

更新SimpleSAMLphp库

1. Fork仓库，创建新分支。
2. 编辑Dockerfile，修改SAML_VERSION构建参数为目标版本。
3. 查看升级说明，注意模块、钩子或idp-hosted/idp-remote文件的变化。
4. 用docker-compose up --build dev测试开发版本。
5. 测试生产版本后提交PR。