WordPress Simple SAML 插件安装与配置指南

WordPress Simple SAML 插件安装与配置指南

wp-simple-saml WordPress Simple SAML plugin 项目地址: https://gitcode.com/gh_mirrors/wp/wp-simple-saml

本指南旨在帮助您了解并设置WordPress Simple SAML插件，这是一个灵活且可扩展的SAML集成工具，支持WordPress的多站点和多网络环境。下面是关于该项目的基本结构、启动与配置的详细介绍。

1. 目录结构及介绍

WordPress Simple SAML插件遵循标准的WordPress插件目录结构，其主要组成部分如下：

• LICENSE: 描述了软件使用的许可协议（GPL-3.0许可证）。
• README.md: 包含有关插件的简介、安装步骤以及基本配置说明。
• composer.json 和 composer.lock: 用于管理PHP依赖项。
• plugin.php: 主启动文件，包含了插件的激活和核心功能初始化逻辑。
• .gitignore, travis.yml: 版本控制与持续集成相关的配置文件。
• wp-simple-saml: 核心插件目录，包含所有业务逻辑和配置相关文件。
  • 其中可能含有处理SAML响应、过滤器、动作挂钩等关键类和函数文件。

2. 项目的启动文件介绍

• plugin.php 是这个插件的主要启动文件。当您在WordPress的wp-content/plugins目录下激活该插件后，系统自动加载此文件。它负责注册插件的所有必要部分，比如激活钩子、设置页面、以及其他必要的初始化操作。通过这个文件，插件与WordPress框架建立起连接，开始执行其SAML集成的核心功能。

3. 项目的配置文件介绍

虽然没有一个单独的标记为“配置文件”的文件，但配置可以通过以下两种方式进行：

3.1 通过WordPress后台界面配置

一旦插件激活，您可以在WordPress后台找到特定的设置页面进行配置。主要包括：

• SSO状态: 可选择禁用、显示登录链接或强制重定向至SSO登录页。
• SSO基础URL: 指定主服务提供者接收SAML响应的URL。
• SSO IdP元数据: 输入身份提供商(IdP)的XML元数据，也可以通过过滤器设置。
• SSO委托白名单: 设置允许SAML SSO的二级域名。
• 调试选项: 如何通过cookies来辅助测试和调试。

3.2 通过代码配置

配置同样可以借助WordPress的滤镜(filter)系统进行，这是一种更为灵活的方式，适用于自定义需求。例如，设置SAML IdP元数据路径或属性映射：

add_filter('wpsimplesaml_idp_metadata_xml_path', function() {
    return ABSPATH . '/private/sso/test-idp.xml'; // 示例元数据文件路径
});

add_filter('wpsimplesaml_attribute_mapping', function() {
    return [
        'user_login' => 'uid',
        'user_email' => 'email',
    ]; // 属性映射示例
});

通过上述方法，您可以完全定制化您的SAML集成设置，以适应各种应用场景。记得在进行代码配置时，确保您的更改符合WordPress的最佳实践，并在安全可靠的环境下进行测试。

wp-simple-saml WordPress Simple SAML plugin 项目地址: https://gitcode.com/gh_mirrors/wp/wp-simple-saml