riskio/oauth2-auth0

Auth0 OAuth 2.0 Client Provider for The PHP League OAuth2-Client

v2.4.1 2021-11-10 11:41 UTC

Requires

• php: ^7.3|^8.0
• league/oauth2-client: ^2.2.1

Requires (Dev)

• phpunit/phpunit: ^9.3

MIT

• Nicolas Eeckeloo

• authorization
• client
• oauth
• oauth2
• authorisation
• auth0

README

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

Installation

To install, use composer:

composer require riskio/oauth2-auth0

Usage

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

Authorization Code Flow

You have to provide some parameters to the provider:

• customDomain (optional):
  • description: Custom domain used for the Auth0 login - https://auth0.com/docs/custom-domains (I.e.: login.custom-domain.tld - It will be prefixed with https:// automatically. If this is set, the region and account parameters will be ignored.)
• region (optional):
  • description: Auth0 region
  • values:
    • Riskio\OAuth2\Client\Provider\Auth0::REGION_US (default value)
    • Riskio\OAuth2\Client\Provider\Auth0::REGION_EU
    • Riskio\OAuth2\Client\Provider\Auth0::REGION_AU
    • Riskio\OAuth2\Client\Provider\Auth0::REGION_JP
• account (required if customDomain is not set):
  • description: Auth0 account name
• clientId
  • description: The client ID assigned to you by the provider
• clientSecret
  • description: The client password assigned to you by the provider
• redirectUri

session_start();

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

if (!isset($_GET['code'])) {

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

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

    unset($_SESSION['oauth2state']);
    exit('Invalid state');

} else {

    // 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->getName());

    } 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();
}

Refreshing a Token

Auth0's OAuth implementation does not use refresh tokens.