bmatovu/oauth-negotiator

OAuth2 client token manager.

v2.1.0 2022-03-26 13:30 UTC

This package is auto-updated.

Last update: 2024-03-26 18:00:48 UTC


README

Total Downloads Latest Stable Version License

OAuth negotiator is a PHP Guzzle HTTP v6.x Client Middleware that will help you acquire, and refresh your access tokens automatically per application request to the OAuth2 server so you don't have to worry about non-existent or expired access tokens.

This package works by tapping into each request.

  • First, checking if the request has an authorization header; if present, proceed to execute the request.
  • If the request has no set authorization header, the available access token in storage is then added as the request authorization header.
  • If no access token is present in storage, it shall request for a new access token from the OAuth server using the main grant type specified.
  • If there's an existing access token in storage, but it's expired, and a refresh token grant was specified, it shall try to refresh the expired access token using the available refresh token.

See flowchart for detailed process illustration.

Grant types

The package supports four grant types out of box, that is; Client Credentials, Refresh Token, Password, and the Authorization Code grant type*.

You can implement your own custom grant type by simply implementing the GrantTypeInterface.

Tokens

These are the object mapping to the real life access token you would get from an OAuth Server. They implement the TokenInterface.

Token storage

The package also defaults to a file based persistent token storage, but you can still implement your custom persistent storage, say a session based token storage by implementing the TokenRepositoryInterface.

Exceptions

  • TokenNotFoundException thrown by the token repository whenever in case of an unknown token.
  • TokenRequestException thrown by grant type on failure to acquire an access token.

Source code documentation

Installation

The package can be installed via composer.

composer require bmatovu/oauth-negotiator

Usage

Auto-load the package using composer so that it's available in your application scope.

<?php
    
    require __DIR__ . '/../vendor/autoload.php';
    
    // do something...

Real documentation is still a work in progress, but for now examine the tests.