kahu/oauth2-client

Kahu.app OAuth2 Client

v1.1.0 2023-09-29 15:36 UTC

Requires

• php: ^8.2
• ext-json: *
• league/oauth2-client: ^2.0
• psr/http-message: ^1.1 || ^2.0

Requires (Dev)

• psy/psysh: ^0.11.10

MIT

• authorization
• client
• oauth
• oauth2
• kahu
• kahu.app

README

This package provides Kahu OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require kahu/oauth2-client

Usage

Usage is the same as The League's OAuth Client, using \Kahu\OAuth2\Client\Provider\Kahu as the provider.

Authorization Code Flow

$provider = new Kahu\OAuth2\Client\Provider\Kahu(
  [
    'clientId' => '{kahu-client-id}',
    'clientSecret' => '{kahu-client-secret}',
    'redirectUri' => 'https://example.com/callback-url'
  ]
);

// If we don't have an authorization code then get one
if (isset($_GET['code']) === false) {
  $authUrl = $provider->getAuthorizationUrl();
  $_SESSION['oauth2state'] = $provider->getState();
  header('Location: ' . $authUrl);
  exit;
}

// Check given state against previously stored one to mitigate CSRF attack
if (empty($_GET['state']) || $_GET['state'] !== $_SESSION['oauth2state']) {
  unset($_SESSION['oauth2state']);
  exit('Invalid state');
}

// Try to get an access token (using the authorization code grant)
$token = $provider->getAccessToken('authorization_code', ['code' => $_GET['code']]);

// Optional: Now you have a token you can look up a users profile data
try {
  // We got an access token, let's now get the user's details
  $user = $provider->getResourceOwner($token);

  // Use these details to create a new profile
  printf('Hello %s!', $user->getNickname());

} catch (Exception $e) {
  // Failed to get user details
  exit('Oh dear...');
}

// Use this to interact with an API on the users behalf
echo $token->getToken();

License

This project is licensed under the MIT License.