dyweb/oauth2-jaccount

jAccount OAuth 2.0 support for the PHP League's OAuth 2.0 Client

dev-master 2019-05-16 07:12 UTC

Requires

• league/oauth2-client: ^2.0

Requires (Dev)

• mockery/mockery: ~0.9
• phpunit/phpunit: ~4.0

MIT

• Bingchang He

• php
• authorization
• api
• Authentication
• client
• oauth
• oauth2
• jaccount

README

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

Installation

composer require dyweb/oauth2-jaccount

Usage

$provider = new \Dyweb\OAuth2\Client\Provider\JAccount([
    'clientId'                => 'yourId',          // The client ID assigned to you by NIC
    'clientSecret'            => 'yourSecret',      // The client password assigned to you by NIC
    'redirectUri'             => 'yourUrl'          // The return URL you specified for your app on NIC
]);

// If we don't have an authorization code then get one
if (!isset($_GET['code'])) {

    // Fetch the authorization URL from the provider; this returns the
    // urlAuthorize option and generates and applies any necessary parameters
    // (e.g. state).
    $authorizationUrl = $provider->getAuthorizationUrl();

    // Get the state generated for you and store it to the session.
    $_SESSION['oauth2state'] = $provider->getState();

    // Redirect the user to the authorization URL.
    header('Location: ' . $authorizationUrl);
    exit;

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

    if (isset($_SESSION['oauth2state'])) {
        unset($_SESSION['oauth2state']);
    }

    exit('Invalid state');

} else {

    try {

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

        // We have an access token, which we may use in authenticated
        // requests against the service provider's API.
        echo 'Access Token: ' . $accessToken->getToken() . "<br>";
        echo 'Refresh Token: ' . $accessToken->getRefreshToken() . "<br>";
        echo 'Expired in: ' . $accessToken->getExpires() . "<br>";
        echo 'Already expired? ' . ($accessToken->hasExpired() ? 'expired' : 'not expired') . "<br>";

        // Using the access token, we may look up details about the
        // resource owner.
        $resourceOwner = $provider->getResourceOwner($accessToken);

        var_export($resourceOwner->toArray());

    } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) {

        // Failed to get the access token or user details.
        exit($e->getMessage());

    }

}

For more information see the PHP League's general usage examples.

License

The MIT License (MIT). Please see License File for more information.