README

这是一个基于OneLogin工具箱的Laravel包，用于Saml2集成，作为SP（服务提供者）的Saml2集成，比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配置的URLs

如上所述，您不需要实现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);
});

身份验证持久性

注意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，它将在/mytestidp1/slo端点通知您（已提供）。

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

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

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

例如，可以是

App/Providers/MyEventServiceProvider.php

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

这就完成了。请随时提问，提交PR或建议，或打开问题。

shub300 / laravel-saml2

维护者

详细信息

README

安装 - Composer

配置

定义IDP

配置laravel-saml2以了解每个IDP

传递给IDP配置的URLs

示例：simplesamlphp IDP配置

用法

身份验证持久性

登出