doccheck/oauth2-doccheck

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

v2.0.0-BETA1 2025-07-22 06:36 UTC

Requires

• php: >=8.2
• league/oauth2-client: ^2.0

Requires (Dev)

• phpunit/phpunit: ^11.0
• symfony/var-dumper: ^7.2

MIT

• DocCheck IT

• authorization
• client
• oauth
• oauth2
• authorisation
• doccheck

README

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

Usage

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

Authorization Code Flow

require_once('./vendor/autoload.php');

session_start();

$provider = new \DocCheck\OAuth2\Client\Provider\DocCheck([
    'clientId'          => '{doccheck-client-id}',
    'clientSecret'      => '{doccheck-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
    'stateless'         => false, // set true if client has basic license or to prevent state parameter 
]);

if (!isset($_GET['code'])) {
    // If we don't have an authorization code then get one
    $authUrl = $provider->getAuthorizationUrl([
        'scope' => ['email', '...', '...'],
    ]);
    $_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->getEmail());

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

Testing

$ ./vendor/bin/phpunit