https://github.com/overtrue/laravel-saml
SAML toolkit for Laravel based on OneLogin's SAML PHP Toolkit.
https://github.com/overtrue/laravel-saml
Last synced: 3 months ago
JSON representation
SAML toolkit for Laravel based on OneLogin's SAML PHP Toolkit.
- Host: GitHub
- URL: https://github.com/overtrue/laravel-saml
- Owner: overtrue
- License: mit
- Created: 2021-09-02T02:12:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-08T01:03:25.000Z (12 months ago)
- Last Synced: 2025-03-02T06:12:48.128Z (11 months ago)
- Language: PHP
- Size: 67.4 KB
- Stars: 22
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Laravel SAML
---
SAML toolkit for Laravel based on [OneLogin's SAML PHP Toolkit](https://github.com/onelogin/php-saml).
[](https://github.com/sponsors/overtrue)
## Installation
```bash
composer require overtrue/laravel-saml
```
## Configuration
```bash
php artisan vendor:publish --tag=saml-config
```
This command will add the file `config/saml.php`. This config is handled almost directly by [OneLogin](https://github.com/onelogin/php-saml) 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.
```php
Saml::configureIdpUsing(function($idpName): array {
return [...];
});
```
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:
```php
$ php artisan make:controller SamlController
```
Then we prepare the following 5 necessary methods.
```php
name('saml.login');
Route::get('saml/logout', [SamlController::class, 'logout'])->name('saml.logout');
Route::post('saml/acs', [SamlController::class, 'acs'])->name('saml.acs');
Route::get('saml/sls', [SamlController::class, 'sls'])->name('saml.sls');
Route::get('saml/metadata', [SamlController::class, 'metadata'])->name('saml.metadata');
```
#### Redirect to IdP login service
Initiates the SSO process, creates an AuthnRequest, returns a laravel redirect response.
```php
//<...>
public function login(Request $request)
{
// Use the default idp in the configuration
return Saml::redirect();
// Or specify the idp name
return Saml::idp($request->get('idp'))->redirect();
}
```
#### 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.
```php
//<...>
public function acs(Request $request)
{
// Overtrue\LaravelSaml\SamlUser
$samlUser = Saml::getAuthenticatedUser();
// Or specify the idp name
//$samlUser = Saml::idp($request->get('idp'))->getAuthenticatedUser();
$samlUserId = $samlUser->getNameId();
// SamlUser to app User
// $user = User::FirstOrCreate(['email' => $samlUser->getNameId()]);
Auth::set($user);
return redirect('/home')
}
```
#### Redirect to IdP logout service
Create a redirect response to IdP logout service.
```php
//<...>
public function logout(Request $request)
{
// Use the default IdP in the configuration
return Saml::redirectToLogout();
// Or specify the IdP name
return Saml::idp($request->get('idp'))->redirectToLogout();
}
```
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.
```php
//<...>
public function sls(Request $request)
{
$auth = Saml::handleLogoutRequest();
// Or specify the IdP name
//$auth = Saml::idp($request->get('idp'))->handleLogoutRequest();
Auth::logout();
return redirect('/home')
}
```
#### Metadata
This code will provide the XML metadata file of our SP, based on the info that we provided in the settings files.
```php
//<...>
public function metadata(Request $request)
{
if ($request->has('download')) {
return Saml::getMetadataXMLAsStreamResponse();
// or specify a filename to the xml file:
// return Saml::getMetadataXMLAsStreamResponse('sp-metadata.xml');
}
return Saml::getMetadataXML();
}
```
### More
For more information on configuration and usage please see the source code or read [onelogin/php-saml](https://github.com/onelogin/php-saml).
## :heart: Sponsor me
[](https://github.com/sponsors/overtrue)
如果你喜欢我的项目并想支持它，[点击这里 :heart:](https://github.com/sponsors/overtrue)
## Project supported by JetBrains
Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.
[](https://www.jetbrains.com/?from=https://github.com/overtrue)
## Contributing
You can contribute in one of three ways:
1. File bug reports using the [issue tracker](https://github.com/overtrue/laravel-package/issues).
2. Answer questions or fix bugs on the [issue tracker](https://github.com/overtrue/laravel-package/issues).
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._
## PHP 扩展包开发
> 想知道如何从零开始构建 PHP 扩展包？
>
> 请关注我的实战课程，我会在此课程中分享一些扩展开发经验 —— [《PHP 扩展包实战教程 - 从入门到发布》](https://learnku.com/courses/creating-package)
## License
MIT