Installation / Upgrading

Option 1: Composer

Composer is a simple, straight forward installation. Simply run the following command from your project root:

composer require flipboxfactory/saml-sp

Option 2: Plugin Store

Within your Craft CMS project admin panel, navigate to the 'Plugin Store' and search for SAML SSO Service Provider. Installation is a button click away.

Once the plugin is installed, head over to configure the plugin.

Upgrading to 5.1.4

5.1.4 is a security release (see the changelog). It requires Craft CMS 5.10.8 or later, so update Craft first if needed.

saml-sp 5.1.4 uses simplesamlphp/saml2 4.19.x, which needs webmozart/assert 1.x, while recent Craft projects lock 2.x. If Composer reports a webmozart/assert conflict, allow it to adjust dependencies with -W:

composer update flipboxfactory/saml-sp -W

Upgrading to 2.0

There are a lot of breaking changes in 2.0. Upgrading is seamless if there is not any custom code that hooks into the SAML SP plugin.

When Changes are Needed

You will need to refactor some of the code if you are doing any of the following:

1. Hooking into the plugin with Craft/Yii2 Events. See a list of the events.
2. Are using callables/anonymous functions with the responseAttributeMap config within config/saml-sp.php.
3. Have any references to lightsaml/lightsaml package. We have switch from using this package to using simplesamlphp/saml2

TIP

Search for LightSaml within your project to find items that need to be refactored.

Be Diligent with this Upgrade!

1. Backup the production database
2. Test the upgrade on a dev instance
3. Test Login/SSO and Logout/SLO (if logout is used)

Submit an Issue or Contact us if you are running into any problems.