Download the PHP package nyan02/kphp_oauth2_keycloak without Composer

On this page you can find all versions of the php package nyan02/kphp_oauth2_keycloak. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of nyan02/kphp_oauth2_keycloak

Informations about the package kphp_oauth2_keycloak

This package provides Keycloak OAuth 2.0 support for the KPHP

Installation

To install, use composer:

Usage

Usage is similar to KPHP OAuth client, using nyan02\kphp_oauth2_client\Provider\Keycloak as the provider.

You need to create a new Provider object specifying keycloak-client-id, keycloak-client-secret and callback-url.

The main difference from generic provider class is that you have to set Keycloak specific parameters: AuthServerUrl and Realm. You can also set your Keycloak version (this will change the default scopes).

If you've configured your Keycloak instance to use encryption, there are some advanced options available to you. You can configure the provider to use the same encryption algorithm and to use the expected decryption public key or certificate. You can set the key either by specifying the path or by directly passing the contents.

You can see the example below.

Authorization Code Example

Authorization Code Flow

After configuring provider we want to get Authorization Code. We use method getAuthorizationParameters() to get parameters from the provider including permission scopes and other info needed for generating AuthorizationUrl.

Next we generate AuthorizationUrl using method getAuthorizationUrl($params) and passing parameters we've got before. Now that we have the Url we can redirect the user to Authorization page of provider.

Once we've got Authorization Code we create a placeholder class for it

And pass it to getAccessToken method together with the code we've got.

Now we have the Access Token to Resource.

Getting ResourceOwner Information

With Access Token we can now access Resource Owner's information.

Implemented methods for KeycloakResourceOwner are getId(), getEmail(), getName() and toJSON(). toJSON() allows getting values of custom configured by the keycloak server administrator fields.

All versions of kphp_oauth2_keycloak with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
vkcom/kphp-polyfills Version ^1.0
nyan02/kphp_oauth2_client Version ^1.0
nyan02/kphp_jwt Version ^1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package nyan02/kphp_oauth2_keycloak contains the following files

Loading the files please wait ....