quartsoft/samlsso

A SAML SSO extension for Yii 2

Yii 2 Saml

Connect Yii 2 application to a Saml Identity Provider for Single Sign On, _(*1)

Installation

The preferred way to install this extension is through composer., _(*2)

Later run, _(*3)

php composer.phar require --prefer-dist quartsoft/samlsso "dev-master"

or add, _(*4)

"quartsoft/samlsso": "dev-master"

to the require section of your composer.json file., _(*5)

Configuration

Register quartsoft\samlsso\Saml to your components in config/web.php., _(*6)

'components' => [
    'samlsso' => [
        'class' => 'quartsoft\samlsso\Samlsso',
        'configFile' => '@common/config/samlcofig.php' // OneLogin_Saml config file (Optional)
    ]
]

This component requires a OneLogin_Saml configuration stored in a php file. The default value for configFile is @common/config/samlcofig.php so make sure to create this file before. This file must returns the OneLogin_Saml configuration. See this link for example configuration., _(*7)

<?php
return [
    'sp' => [
        'entityId' => '',
        'assertionConsumerService' => [
            'url' => '',
            'binding' => '',
        ],
        'singleLogoutService' => [
            'url' => '',
            'binding' => '',
        ]
    ],

    'idp' => [
        'entityId' => '',
        'singleSignOnService' => [
            'url' => '',
            'binding' => '',
        ],
        'singleLogoutService' => [
            'url' => '',
            'binding' => '',
        ],
        'x509cert' => '',
    ],
];

Example configuration file you can find here., _(*8)

Usage

Your controller, where you use actionLogin must be inherited from SamlController. And add array_merge in method actions()., _(*9)

use quartsoft\samlsso\controllers\SamlController;

class SiteController extends SamlController
{

...

    public function actions()
    {
        $actions = parent::actions();

        $currentActions = [
            'your action' => [
                'class' => 'your class',
            ],
            ...
        ];

        return array_merge($actions, $currentActions);

    }

...

}

Finally

For more information see onelogin/php-saml library ., _(*10)