maicol07 / laravel-oidc-client
Fund package maintenance!
maicol07
paypal.me/maicol072001/10eur
Installs: 220
Dependents: 0
Suggesters: 0
Security: 0
Stars: 22
Watchers: 3
Forks: 10
Open Issues: 0
Requires
- php: >=8.3
- laravel/framework: ^11
- maicol07/oidc-client: ^4@rc
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3
- rector/rector: ^1
- roave/security-advisories: dev-latest
This package is auto-updated.
Last update: 2024-11-02 13:55:31 UTC
README
A Laravel package for delegating authentication to an OpenID Provider.
This package is an heavenly modified fork of cabinetoffice / oidc-client — Bitbucket
Requirements
- PHP 8.3+
- Laravel 11+
- Composer 2
Installation
Begin by adding this package to your depedencies with the command:
composer require maicol07/laravel-oidc-client
If you have opted out from auto discovery, you'll need to add the following line to the list of registered service
providers in config/app.php
:
Maicol07\OIDCClient\OIDCServiceProvider::class
Edit your config/auth.php
file to use OpenID as the authentication method for your users:
'guards' => [ 'web' => [ 'driver' => 'oidc', ... ], ... ],
Configuration
You can set the following environment variables to adjust the package settings:
OIDC_CLIENT_ID
: Client ID of your app. This is commonly provided by your OIDC provider.OIDC_CLIENT_SECRET
: Client secret of your app. This is commonly provided by your OIDC provider.OIDC_PROVIDER_URL
: URL of your OIDC provider. This is used if your provider supports OIDC Auto Discovery.OIDC_PROVIDER_NAME
: This is a short name for your OpenID provider, which will only appears in your OpenID routes. Do not use spaces. Defaults tooidc
OIDC_CALLBACK_ROUTE_PATH
: A path (with or without leading slash) to append to the provider name, to make the callback route path. Defaults tocallback
Example with the default values:oidc/callback
(OIDC_PROVIDER_NAME
+/
+OIDC_CALLBACK_ROUTE_PATH
)OIDC_VERIFY
: Verify SSL when sending requests to the server. Defaults totrue
. (Optional: You can setOIDC_CERT_PATH
to an SSL certificate path if you set this option tofalse
)OIDC_HTTP_PROXY
: If you have a proxy, set it here.OIDC_SCOPES
: A list of scopes, separated by a comma (,
). Defaults to['openid']
. Example of valid value:openid,email
OIDC_AUTHORIZATION_ENDPOINT_QUERY_PARAMS
: A list of query parameters to add to the authorization endpoint encoded as a JSON object. Example of valid value:{"response_type":"code"}
OIDC_DISABLE_STATE_MIDDLEWARE_FOR_POST_CALLBACK
: A boolean to disable the registration of theOIDCStateMiddleware
middleware.
This middleware rebuilds the session token held in thestate
parameter of aPOST
request to thecallback
route.
You can find other options to set and their env variables in config/oidc.php
. Note that some options are not
required (like endpoints) if you use OIDC auto discovery!
You can also publish the config file (config/oidc.php
) if you want:
php artisan vendor:publish --provider="Maicol07\OIDCClient\OIDCServiceProvider"
How to use
Once everything is set up, you can replace your login system with a call to the route route('oidc.login')
. For
logouts, use the route route('oidc.logout')
.
You can set the following environment variables to specify the routes/URLs you want your users to be redirected to upon
successful authentication/logout: OIDC_REDIRECT_PATH_AFTER_LOGIN
and OIDC_REDIRECT_PATH_AFTER_LOGOUT
.
You may want to create your own User
model. If yes, then you must extend Maicol07\OIDCClient\User
in order to get
auth working.
Check your auth.providers.users.model
config value: it must be set to your custom User
model or
to Maicol07\OIDCClient\User
instead.
Originally developed by Cabinet Office Digital Development in October 2019.
Currently maintained by maicol07 from October 2021