This is my package filament-oauth2

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require alexandergabriel/filament-oauth2

You can publish the config file with:

php artisan vendor:publish --tag="filament-oauth2-config"

This is the contents of the published config file:

return [
    'clientId' => env("OAUTH2_CLIENT_ID"),
    'clientSecret' => env("OAUTH2_CLIENT_SECRET"),
    'baseUrl' => env("OAUTH2_BASE_URL"), // https://DOMAIN/realms/REALM/protocol/openid-connect
    'urlAuthorize' => env("OAUTH2_URL_AUTHORIZE", env("OAUTH2_BASE_URL")."/auth"),
    'urlAccessToken' => env("OAUTH2_URL_ACCESS_TOKEN", env("OAUTH2_BASE_URL")."/token"),
    'urlResourceOwnerDetails' => env("OAUTH2_URL_RESOURCE_OWNER_DETAILS", env("OAUTH2_BASE_URL")."/userinfo"),
    'urlLogout' => env("OAUTH2_URL_LOGOUT", env("OAUTH2_BASE_URL")."/logout"),
    'urlAfterlogout' => env("OAUTH2_URL_AFTER_LOGOUT", url('/')),
    'scopes' => env("OAUTH2_SCOPES", "profile email openid"),
    'updateRoles' => env("OAUTH2_UPDATE_ROLES", false)
];

Usage

Load Plugin in your PanelProvider under filament-oauth2-demo/app/Providers/Filament:

class YOURPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ->plugin(
                new FilamentOauth2Plugin()
            )

To configure, add some config to your .env:

• OAUTH2_CLIENT_ID*
  • OAuth2 client id, mandatory
• OAUTH2_CLIENT_SECRET*
  • OAuth2 client secret, mandatory
• OAUTH2_BASE_URL*
  • Base url to OAuth2 authentication server
  • must include realm: https://DOMAIN/realms/REALM/protocol/openid-connect
• OAUTH2_URL_AUTHORIZE
  • authorization url
  • defaults to OAUTH2_BASE_URL+/auth
• OAUTH2_URL_ACCESS_TOKEN
  • token url
  • defaults to OAUTH2_BASE_URL+/token
• OAUTH2_URL_RESOURCE_OWNER_DETAILS
  • resource owner details url
  • defaults to OAUTH2_BASE_URL+/userinfo
  • todo: needed?
• OAUTH2_URL_LOGOUT
  • logout url
  • defaults to OAUTH2_BASE_URL+/logout
• OAUTH2_URL_AFTER_LOGOUT
  • post_logout_redirect_uri
  • defaults to base url of Laravel app (without panel)
• OAUTH2_SCOPES
  • scopes
  • defaults to "profile email openid"
• OAUTH2_UPDATE_ROLES
  • look for roles in token and update/create and map them
  • defaults to false

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Alexander Gabriel
• All Contributors

License

The MIT License (MIT). Please see License File for more information.