README

Laravel - Saml2

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

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

安装 - Composer

您可以通过composer安装此包

composer require mrbrownnl/laravel-saml2

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

composer.json

{
  "mrbrownnl/laravel-saml2": "*"
}

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

test_idp_settings.php配置几乎直接由OneLogin处理，因此您应参考该部分以获取详细信息，但我们将在此处介绍真正必要的内容。还有一些关于路由的配置，您可能需要检查，它们相当直观。

配置

定义IDP

在saml2_settings.php中定义您要配置的所有IDP的名称。如果需要，您可以将mytestidp1（区分大小写）作为第一个IDP以使用simplesamlphp演示，然后添加真实的IDP。IDP的名称将显示在库创建的Saml2路由中，以及每个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函数的实际路由相对应。

如果您想选择性地在ENV变量中定义值而不是在{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变量。

例如，可以是

.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);
}

如果您愿意，可以更改您的未认证方法。

例如，可以是

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 MrBrownNL\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('MrBrownNL\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中间件对于在Session中实现身份验证持久性的必要性。

例如，可以是

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('MrBrownNL\Saml2\Events\Saml2LogoutEvent', function ($event) {
    Auth::logout();
    Session::save();
});

致谢

aacotroneo

许可

MIT许可（MIT）。有关更多信息，请参阅许可文件。

mrbrownnl / laravel-saml2

维护者

详细信息

README

Laravel - Saml2

安装 - Composer

配置

定义IDP

配置laravel-saml2以了解每个IDP

传递给IDP配置的URL

示例：simplesamlphp IDP配置

用法

身份验证持久性

注销

致谢

许可