PHP-SAML 开源项目教程

PHP-SAML 开源项目教程

php-saml项目地址:https://gitcode.com/gh_mirrors/php/php-saml

1. 项目介绍

PHP-SAML 是由 OneLogin 开发的一个 PHP 包，用于实现 Security Assertion Markup Language (SAML) 协议。这个库旨在帮助开发者轻松集成 SAML 身份提供者（IdP）到自己的 PHP 应用程序中，从而支持单点登录（SSO）功能。它兼容 SAML 2.0 规范，并提供了处理 SAML 声明、认证请求和响应的工具。

2. 项目快速启动

安装

首先，确保你的项目已经安装了 Composer：

composer require onelogin/php-saml

配置

在你的项目目录下创建一个 config.php 文件，配置 SAML 设置：

<?php
$settings = [
    'samlMetadata' => 'https://your-idp/metadata.xml', // IdP 的元数据 URL 或文件路径
    'assertionConsumerService' => [
        'url' => 'http://localhost/sso/callback.php',
        'binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST',
    ],
    'entityId' => 'http://localhost/', // 你的应用实体 ID
    'debug' => true, // 启用或禁用调试模式
];

require_once 'vendor/autoload.php';
$samlSettings = new OneLogin\Saml2\Settings($settings);
?>

示例回调处理

创建一个名为 callback.php 的文件来处理 SAML 回调：

<?php
require_once 'vendor/autoload.php';

use OneLogin\Saml2\Auth;

// 获取设置
$samlSettings = new OneLogin\Saml2\Settings(include 'config.php');

// 初始化 SAML 对象
$samlAuth = new Auth($samlSettings);

// 处理 SAML 登录响应
if (isset($_GET['SAMLResponse'])) {
    try {
        $loginData = $samlAuth->processSAMLResponse();
        if ($loginData->isAuthenticated()) {
            $_SESSION['samlUserdata'] = $loginData->getAttributes(); // 存储用户属性
            header('Location: /welcome'); // 登录成功后的重定向
        }
    } catch (Exception $e) {
        echo "Error processing SAML response: " . $e->getMessage();
    }
}

// 处理 SAML 断开连接请求
if (isset($_GET['logout'])) {
    $samlAuth->logout();
    unset($_SESSION['samlUserdata']);
    header('Location: /');
}
?>

用户界面

在 /welcome 页面上，你可以展示已登录用户的信息：

<?php
session_start();

if (!isset($_SESSION['samlUserdata'])) {
    header('Location: /');
    exit;
}

echo "欢迎，" . $_SESSION['samlUserdata']['username'][0] . "!";
?>

3. 应用案例和最佳实践

• 企业内部应用：如果你有一个需要多应用间共享身份验证的企业环境，PHP-SAML 可以简化 SSO 实现。
• 教育平台：在线学习系统可以利用 SAML 和外部 IdP 进行学生和教师的身份验证。
• 最佳实践：始终保持最新版本的 PHP-SAML；在生产环境中禁用调试模式；确保 IdP 和 SP 之间的安全通信。

4. 典型生态项目

• Apache Shibboleth：作为流行的 IdP 实现，与 PHP-SAML 结合可以构建强大的 SSO 系统。
• Keycloak：另一个开放源码的 Identity and Access Management 解决方案，支持 SAML 协议。
• WordPress 插件：如 WP SimpleSAMLPHP 插件，将 PHP-SAML 集成到 WordPress 网站。

通过遵循以上步骤，你应该能够成功地集成并开始使用 PHP-SAML 实现 SAML SSO 功能。记得根据实际需求调整配置和代码。

php-saml项目地址:https://gitcode.com/gh_mirrors/php/php-saml