downtownwork/oauth2-pingfederate

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

dev-master 2024-07-08 12:43 UTC

Requires

• php: ~7.1 || ~8.0
• league/oauth2-client: ^2.0

Requires (Dev)

• phpstan/phpstan: >=1.4
• phpunit/phpunit: >=7.0
• squizlabs/php_codesniffer: ^3.10

MIT

• Julien BADINO

• authorization
• client
• oauth
• oauth2
• authorisation
• pingfederate

README

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

Installation

To install, use composer:

composer require downtownwork/oauth2-pingfederate

Usage

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

Use serverUrl to specify the PingFederate server URL. You can lookup the correct value from the PingFederate client installer JSON under server-url, eg. http://localhost:9031.

Authorization Code Flow

$provider = new DownTownWork\OAuth2\Client\Provider\PingFederate([
    'serverUrl'    => '{pingfederate-server-url}',
    'clientId'     => '{pingfederate-client-id}',
    'clientSecret' => '{pingfederate-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, make sure HTTP sessions are enabled.');

} else {

    // Try to get an access token (using the authorization coe grant)
    try {
        $token = $provider->getAccessToken('authorization_code', [
            'code' => $_GET['code']
        ]);
    } catch (Exception $e) {
        exit('Failed to get access token: '.$e->getMessage());
    }

    // 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) {
        exit('Failed to get resource owner: '.$e->getMessage());
    }

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

Refreshing a Token

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

$token = $provider->getAccessToken('refresh_token', ['refresh_token' => $token->getRefreshToken()]);