silintl/idp-id-broker

ID Broker 镜像文档

概述

ID Broker 是一款专为一体化身份提供商(IdP in a box)设计的身份代理工具，核心功能包括用户认证流程管理、授权控制及相关系统通知（如密码变更邮件）。该工具支持自定义配置、API文档自动生成及本地交互式测试，可通过Docker或Vagrant环境快速部署，适用于需要集成身份管理系统的应用场景。

核心功能与特性

• 身份代理服务：处理用户认证、授权流程，对接IdP in a box体系
• 邮件通知系统：内置邮件模板，支持密码变更等关键操作的通知发送
• 自定义配置：支持通过环境变量和配置文件调整系统参数
• API文档生成：基于RAML规范自动生成API文档（html格式）
• 本地测试支持：提供交互式测试环境，便于功能验证和调试
• 依赖管理优化：支持Composer缓存配置，提升依赖安装效率

使用场景

• 企业内部系统的身份认证集成
• 需要统一身份管理的多应用平台
• 开发环境中的身份代理服务测试与验证
• 需自定义通知模板的身份管理场景

使用方法与配置说明

环境要求

选项1：Vagrant环境

• VirtualBox
• Vagrant

选项2：Docker环境

• Docker

安装部署步骤

1. 克隆代码仓库

   bash
   git clone <仓库地址>
   

2. 清理版本控制文件
   删除仓库根目录下的 .git/ 文件夹：

   bash
   rm -rf .git/
   

3. Vagrant用户额外配置（仅Vagrant部署需执行）
   编辑 Vagrantfile，指定自定义IP地址，并根据需求调整挂载到 /data 的同步文件夹配置。

4. 配置环境变量
   将环境变量模板文件复制为实际配置文件：

   bash
   cp local.env.dist local.env
   

5. 检查核心配置文件
   review 以下配置文件并按需调整：

   • common/config/main.php
   • frontend/config/main.php

6. 配置Composer缓存
   定义 COMPOSER_CACHE_DIR 环境变量，指定Composer依赖缓存路径，提升安装/更新效率：

   bash
   export COMPOSER_CACHE_DIR=/path/to/composer/cache
   

7. 启动服务

   • Docker环境：

     bash
     make start
     

   • Vagrant环境：

     bash
     vagrant up
     

Composer/GitHub速率限制处理

若因GitHub速率限制导致Composer无法拉取依赖，执行以下步骤：

1. 复制认证模板文件：

   bash
   cp auth.json.dist auth.json
   

2. 在 auth.json 中填入GitHub个人访问令牌（需具备相应仓库访问权限）。

自定义邮件内容

系统关键操作（如密码变更）会触发邮件通知，模板文件位于 application/common/mail/，可按需修改。自定义时需注意：

• 保持文件名不变：不得修改模板文件名称
• HTML编码要求：HTML模板（*.html.php）中插入的内容需进行HTML编码（参考现有模板示例）

如需在邮件中添加当前模板未支持的信息，建议提交GitHub Pull Request，以确保信息安全性和功能通用性。

API文档生成

API规范定义于 api.raml 文件，可通过 raml2html 工具生成HTML格式文档：

bash
make raml2html

生成的文档为 api.html，位于项目根目录。

本地交互式测试

1. 启动测试环境并进入交互shell：

   bash
   make testcli
   

2. 执行测试命令，例如：

   bash
   ./vendor/bin/behat features/authentication.feature