Download the PHP package guisz1/laravel-keycloak-guard-without-resource_access without Composer
On this page you can find all versions of the php package guisz1/laravel-keycloak-guard-without-resource_access. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download guisz1/laravel-keycloak-guard-without-resource_access
More information about guisz1/laravel-keycloak-guard-without-resource_access
Files in guisz1/laravel-keycloak-guard-without-resource_access
Package laravel-keycloak-guard-without-resource_access
Short Description 🔑 Simple Keycloak Guard for Laravel
License MIT
Homepage https://github.com/guisz1/laravel-keycloak-guard-without-resource_access
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-keycloak-guard-without-resource_access
Simple Keycloak Guard for Laravel / Lumen
This package helps you authenticate users on a Laravel API based on JWT tokens generated from Keycloak Server.
Requirements
✔️ I`m building an API with Laravel.
✔️ I will not use Laravel Passport for authentication, because Keycloak Server will do the job.
✔️ The frontend is a separated project.
✔️ The frontend users authenticate directly on Keycloak Server to obtain a JWT token. This process have nothing to do with the Laravel API.
✔️ The frontend keep the JWT token from Keycloak Server.
✔️ The frontend make requests to the Laravel API, with that token.
💔 If your app does not match requirements, probably you are looking for https://socialiteproviders.com/Keycloak or https://github.com/Vizir/laravel-keycloak-web-guard
The flow
-
The frontend user authenticates on Keycloak Server
-
The frontend user obtains a JWT token.
-
In another moment, the frontend user makes a request to some protected endpoint on a Laravel API, with that token.
-
The Laravel API (through
Keycloak Guard) handle it.- Verify token signature.
- Verify token structure.
- Verify token expiration time.
- Verify if my API allows
resource accessfrom token.
-
If everything is ok, find the user on database and authenticate it on my API.
- Return response
Install
Laravel / Lumen
Require the package
Lumen only
Register the provider in your boostrap app file
Add the following line in the "Register Service Providers" section at the bottom of the file.
For facades, uncomment in your boostrap app file
Configuration
Keycloak Guard
The Keycloak Guard configuration can be handled from Laravel .env file. ⚠️ Be sure all strings are trimmed.
Optionally you can publish the config file.
✔️ realm_public_key
Required.
The Keycloak Server realm public key (string).
How to get realm public key? Click on "Realm Settings" > "Keys" > "Algorithm RS256" Line > "Public Key" Button
✔️ load_user_from_database
Required. Default is true.
If you do not have an users table you must disable this.
It fetchs user from database and fill values into authenticated user object. If enabled, it will work together with user_provider_credential and token_principal_attribute.
✔️ user_provider_credential
Required. Default is username.
The field from "users" table that contains the user unique identifier (eg. username, email, nickname). This will be confronted against token_principal_attribute attribute, while authenticating.
✔️ token_principal_attribute
Required. Default is preferred_username.
The property from JWT token that contains the user identifier.
This will be confronted against user_provider_credential attribute, while authenticating.
✔️ append_decoded_token
Default is false.
Appends to the authenticated user the full decoded JWT token ($user->token). Useful if you need to know roles, groups and other user info holded by JWT token. Even choosing false, you can also get it using Auth::token(), see API section.
✔️ allowed_resources
Required
Usually you API should handle one resource_access. But, if you handle multiples, just use a comma separated list of allowed resources accepted by API. This attribute will be confronted against resource_access attribute from JWT token, while authenticating.
Laravel Auth
Changes on config/auth.php
Laravel Routes
Just protect some endpoints on routes/api.php and you are done!
Lumen Routes
Just protect some endpoints on routes/web.php and you are done!
API
Simple Keycloak Guard implements Illuminate\Contracts\Auth\Guard. So, all Laravel default methods will be available. Ex: Auth::user() returns the authenticated user.
Default methods:
- check()
- guest()
- user()
- id()
- validate()
- setUser()
Keycloak Guard methods:
- token()
Ex: Auth::token() returns full decoded JWT token from authenticated user
- hasRole('some-resource', 'some-role'): Check if the authenticated user has especific role into a resource.
Ex: Whit this payload:
Contact
Twitter @robsontenorio Twitter @SeibertGui
