Download the PHP package overtrue/laravel-saml without Composer

Laravel SAML

SAML toolkit for Laravel based on OneLogin's SAML PHP Toolkit.

Requirements

• PHP 8.3 or later
• Laravel 13

Version 2.x supports Laravel 13 only. Applications on Laravel 9–12 should remain on the 1.x release line until they upgrade Laravel.

Installation

Upgrading from 1.x

Upgrade your application to PHP 8.3+ and Laravel 13 first, then run:

This major release raises the supported platform baseline. Existing SAML APIs and configuration keys are unchanged; keep your IdP certificates, strict validation, signing requirements, and application-specific ACS/SLS routes and middleware intact. Test login, assertion validation, and logout against your IdP after upgrading.

The release also fixes explicitly supplied IdP settings being ignored and preserves the original PHP error when SAML response or logout processing fails.

For package development, the test suite now uses Orchestra Testbench 11 and PHPUnit 12.5. CI runs on PHP 8.3, 8.4, and 8.5, including the lowest dependency versions allowed by Composer's security checks.

Configuration

This command will add the file config/saml.php. This config is handled almost directly by OneLogin so you may get further references there, but will cover here what's really necessary. There are some other config about routes you may want to check, they are pretty straightforward.

Usage

If your application is only used to log in to one specified IdP, you just need to configure idp section in config/saml.php.

idp configuration resolver

In order to support multiple IdP, you need to configure the following method to get the configuration of the IdP.

You need to return the configuration array for IdP, see the idp section in config/saml.php for the structure.

Entrypoints controller

You can create a controller to perform SAML integration:

Then we prepare the following 5 necessary methods.

Entrypoints Routes

Then configure the routes at routes/web.php:

You are free to use your preferred routing prefix, for example, we use saml as the routing prefix:

Redirect to IdP login service

Initiates the SSO process, creates an AuthnRequest, returns a laravel redirect response.

Assertion Consumer Service (ACS)

This method is used to handle the IdP authorization callback, SamlAuth::getAuthenticatedUser will validation the request and return a Overtrue\LaravelSaml\SamlUser object.

Redirect to IdP logout service

Create a redirect response to IdP logout service.

The IdP will return the Logout Response through the user's client to the Single Logout Service of the SP (route saml/sls).

Single Logout Service (SLS)

This code handles the Logout Request and the Logout Responses.

Metadata

This code will provide the XML metadata file of our SP, based on the info that we provided in the settings files.

More

For more information on configuration and usage please see the source code or read onelogin/php-saml.

:heart: Sponsor me

如果你喜欢我的项目并想支持它，点击这里 :heart:

Project supported by JetBrains

Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.

Contributing

You can contribute in one of three ways:

1. File bug reports using the issue tracker.
2. Answer questions or fix bugs on the issue tracker.
3. Contribute new features or update the wiki.

The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.

License

MIT