README

一个基于OneLogin工具包的Laravel包，用于Saml2集成作为SP（服务提供者），比simplesamlphp SP更轻量且易于安装。它不需要单独的路由或会话存储即可工作！

该库的目标是尽可能简单。我们不会干涉Laravel的用户、认证、会话...我们更喜欢专注于具体任务。要求用户在IDP上进行认证并处理响应。对于SLO（单点登出）请求也是同样的情况。

安装 - Composer

您可以通过Composer安装此包

composer require aacotroneo/laravel-saml2

或者手动将其添加到您的composer.json中

composer.json

"aacotroneo/laravel-saml2": "*"

如果您使用的是Laravel 5.5及以上版本，服务提供者将自动注册。

对于Laravel的旧版本（<5.5），您必须添加服务提供者

config/app.php

'providers' => [
        ...
    	Aacotroneo\Saml2\Saml2ServiceProvider::class,
]

然后使用php artisan vendor:publish --provider="Aacotroneo\Saml2\Saml2ServiceProvider"发布配置文件。这将添加app/config/saml2_settings.php和app/config/saml2/mytestidp1_idp_settings.php文件，您需要对其进行自定义。

mytestidp1_idp_settings.php配置几乎直接由OneLogin处理，因此您应参考那里获取完整详情，但我们在这里将介绍真正必要的内容。还有一些关于路由的其他配置，您可以查看，它们相当直接。

配置

定义IDP

在saml2_settings.php中定义您想配置的所有IDP的名称。如果想要使用simplesamlphp演示，可以选择性地保留mytestidp1（区分大小写）作为第一个IDP，然后在后面添加实际的IDP。IDP的名称将显示在此库生成的Saml2路由的URL中，以及每个IDP的配置文件名内部。

config/saml2_settings.php

    'idpNames' => ['mytestidp1', 'test', 'myidp2'],

配置laravel-saml2以了解每个IDP

您需要在app/config/saml2/文件夹下为每个IDP创建一个单独的配置文件。例如：test_idp_settings.php。您可以使用mytestidp1_idp_settings.php作为起点；只需复制并重命名它。

此项目不解释配置选项，因为它们来自OneLogin项目，请参考那里获取详细信息。

此配置与OneLogin使用的配置之间的唯一真正区别是，库注入了SP的entityId、assertionConsumerService URL和singleLogoutService URL。

如果您在相应的IDP配置的可选值中没有指定URL，此库提供默认值。库为每个IDP创建metadata、acs和sls路由。如果您在配置中指定了不同的值，请注意，acs和sls URL应与您设置的指向相应Saml2Controller函数的实际路由相对应。

如果您想选择性地在环境变量中定义值而不是在 {idpName}_idp_settings 文件中，您会看到那里有一个您可以遵循的环境值命名模式。例如，如果在 mytestipd1_idp_settings.php 中设置了 $this_idp_env_id = 'mytestidp1';，在 myidp2_idp_settings.php 中设置了 $this_idp_env_id = 'myidp2'，那么您可以分别设置以 SAML2_mytestidp1_ 和 SAML2_myidp2_ 开头的环境变量。

例如，可以是

.env

SAML2_mytestidp1_SP_x509="..."
SAML2_mytestidp1_SP_PRIVATEKEY="..."
// Other  SAML2_mytestidp1_* values

SAML2_myidp2_SP_x509="..."
SAML2_myidp2_SP_PRIVATEKEY="..."
// Other SAML2_myidp2_* values

传递给 IDP 配置的 URL

如上所述，您不需要实现 SP 的 entityId、assertionConsumerService URL 和 singleLogoutService URL 路由，因为 Saml2Controller 默认已经实现了。但您需要了解这些路由，以便将其提供给您的实际 IDP 配置，即您请求验证用户的第三方。

您可以通过导航到 http(s)://{laravel_url}/{idpName}/metadata 来检查实际的路线，例如 http(s)://{laravel_url}/mytestidp1/metadata，它意外地将成为此 SP 的默认 entityId。

如果您在 saml2_settings.php 中配置了可选的 routesPrefix 设置，那么所有 IDP 路由都将以此值作为前缀，因此您需要相应地调整元数据 URL。例如，如果您将 routesPrefix 配置为 'single_sign_on'，则您的 mytestidp1 IDP 元数据将在 http(s)://{laravel_url}/single_sign_on/mytestidp1/metadata 找到。

库为每个 IDP 自动创建的路由是

{routesPrefix}/{idpName}/logout
{routesPrefix}/{idpName}/login
{routesPrefix}/{idpName}/metadata
{routesPrefix}/{idpName}/acs
{routesPrefix}/{idpName}/sls

示例：simplesamlphp IDP 配置

如果您使用 simplesamlphp 作为测试 IDP，并且您的 SP 元数据 URL 为 http(s)://{laravel_url}/mytestidp1/metadata，请将以下内容添加到 /metadata/sp-remote.php 以通知 IDP 您的 laravel-saml2 SP 身份。

例如，可以是

/metadata/sp-remote.php

$metadata['http(s)://{laravel_url}/mytestidp1/metadata'] = array(
    'AssertionConsumerService' => 'http(s)://{laravel_url}/mytestidp1/acs',
    'SingleLogoutService' => 'http(s)://{laravel_url}/mytestidp1/sls',
    //the following two affect what the $Saml2user->getUserId() will return
    'NameIDFormat' => 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent',
    'simplesaml.nameidattribute' => 'uid' 
);

用法

当您想让用户登录时，只需将用户重定向到为特定 IDP 配置的登录路由 route('saml2_login', 'mytestidp1')。您也可以使用 Saml2Auth::loadOneLoginAuthFromIpdConfig('mytestidp1') 函数为所需的 IDP 实例化一个 Saml2Auth，以加载配置并构造 OneLogin 身份验证参数；只需记住它不使用任何会话存储，因此如果您请求它登录，无论用户是否已经登录，它都会重定向到 IDP。例如，您可以将您的身份验证中间件更改如下。

例如，可以是

App/Http/Middleware/RedirectIfAuthenticated.php

public function handle($request, Closure $next)
{
    if ($this->auth->guest())
    {
        if ($request->ajax())
        {
            return response('Unauthorized.', 401); // Or, return a response that causes client side js to redirect to '/routesPrefix/myIdp1/login'
        }
        else
        {
            $saml2Auth = new Saml2Auth(Saml2Auth::loadOneLoginAuthFromIpdConfig('mytestidp1'));
            return $saml2Auth->login(URL::full());
        }
    }

    return $next($request);
}

自 Laravel 5.3 以来，您可以更改您的未认证方法。

例如，可以是

App/Exceptions/Handler.php

protected function unauthenticated($request, AuthenticationException $exception)
{
    if ($request->expectsJson())
    {
        return response()->json(['error' => 'Unauthenticated.'], 401); // Or, return a response that causes client side js to redirect to '/routesPrefix/myIdp1/login'
    }

    $saml2Auth = new Saml2Auth(Saml2Auth::loadOneLoginAuthFromIpdConfig('mytestidp1'));
    return $saml2Auth->login('/my/redirect/path');
}

对于通过重定向到登录路由 {routesPrefix}/mytestidp1/login 来的登录请求，默认登录调用不会将重定向 URL 传递给 Saml 登录请求。该登录参数很有用，因为 ACS 处理程序可以获取该值（从 IDP 作为 RelayPath 返回）并且默认将重定向到那里。要从控制器登录传递重定向 URL，扩展 Saml2Controller 类并实现您自己的 login() 函数。将 config/saml2_settings.php 中的值 saml2_controller 设置为您的扩展类，以便路由将请求定向到您的控制器而不是默认控制器。

例如，可以是

config/saml_settings.php

    'saml2_controller' => 'App\Http\Controllers\MyNamespace\MySaml2Controller'

App/Http/Controllers/MyNamespace/MySaml2Controller.php

use Aacotroneo\Saml2\Http\Controllers\Saml2Controller;

class MySaml2Controller extends Saml2Controller
{
    public function login()
    {
        $loginRedirect = '...'; // Determine redirect URL
        $this->saml2Auth->login($loginRedirect);
    }
}

登录调用后，用户将被重定向到 IDP 登录页面。然后，配置了端点的 IDP（由库提供），将调用回，例如 /mytestidp1/acs 或 /{routesPrefix}/mytestidp1/acs。这将处理响应并在准备好时触发一个事件。您的下一步是处理该事件。您只需要登录用户或拒绝。

例如，可以是

App/Providers/MyEventServiceProvider.php

Event::listen('Aacotroneo\Saml2\Events\Saml2LoginEvent', function (Saml2LoginEvent $event) {
    $messageId = $event->getSaml2Auth()->getLastMessageId();
    // Add your own code preventing reuse of a $messageId to stop replay attacks

    $user = $event->getSaml2User();
    $userData = [
        'id' => $user->getUserId(),
        'attributes' => $user->getAttributes(),
        'assertion' => $user->getRawSamlAssertion()
    ];
        $laravelUser = //find user by ID or attribute
        //if it does not exist create it and go on  or show an error message
        Auth::login($laravelUser);
});

身份验证持久性

请注意在 Session 中保持 Auth 需要的 Laravel 中间件。

例如，可以是

App/Http/Kernel.php

protected $middlewareGroups = [
        'web' => [
	    ...
	],
	'api' => [
            ...
        ],
        'saml' => [
            \App\Http\Middleware\EncryptCookies::class,
            \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
            \Illuminate\Session\Middleware\StartSession::class,
        ],

config/saml2_settings.php

    /**
     * which middleware group to use for the saml routes
     * Laravel 5.2 will need a group which includes StartSession
     */
    'routesMiddleware' => ['saml'],

登出

现在用户有两种登出方式。

1 - 在您的应用程序中登出：在这种情况下，您应该首先通知 IDP 以关闭全局会话。
2 - 从全局 SSO 会话登出。在这种情况下，如果 IDP 支持 SLO，IDP 将在 /mytestidp1/slo 端点通知您。

对于情况 1，调用 Saml2Auth::logout(); 或将用户重定向到登出路由，例如 mytestidp1_logout，它执行此操作。不要立即关闭会话，因为您需要从 IDP 收到响应确认（重定向）。该响应将在库的 /mytestidp1/sls 处处理，并为您触发一个完成操作的事件。

对于情况 2，您只会收到事件。情况和 1 和 2 都会收到相同的事件。

请注意，对于情况 2，您可能需要手动保存您的会话以使登出生效（因为会话由中间件保存，但 OneLogin 库将在发生之前将您重定向回您的 IDP）。

例如，可以是

App/Providers/MyEventServiceProvider.php

Event::listen('Aacotroneo\Saml2\Events\Saml2LogoutEvent', function ($event) {
    Auth::logout();
    Session::save();
});

就这么多。请随意提问、提交 PR 或建议，或打开问题。

willmorrow / laravel-saml2

维护者

详细信息

README

安装 - Composer

配置

定义IDP

配置laravel-saml2以了解每个IDP

传递给 IDP 配置的 URL

示例：simplesamlphp IDP 配置

用法

身份验证持久性

登出