README

Nitrado Provider for OAuth 2.0 Client

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

Installation

You can install this package using Composer:

composer require itsmestevieg/oauth2-nitrado

You will then need to:

run composer install to get these dependencies added to your vendor directory
add the autoloader to your application with this line: require('vendor/autoload.php');

Usage

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

Authorization Code Flow

$provider = new ItsMeStevieG\OAuth2\Client\Provider\Nitrado([
    'clientId'     => '{nitrado-client-id}',
    'clientSecret' => '{nitrado-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([
        'scope' => [
            ItsMeStevieG\OAuth2\Client\Provider\Nitrado::SCOPE_USER_INFO,
        ]
    ]);

    $_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']);
    echo 'Invalid state.';
    exit;

}

// 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
    /** @var \ItsMeStevieG\OAuth2\Client\Provider\NitradoResourceOwner $user */
    $user = $provider->getResourceOwner($token);

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

    echo '<pre>';
    var_dump($user);
    echo '</pre>';

} catch (Exception $e) {

    // Failed to get user details
    exit('Damned...');
}

echo '<pre>';
// Use this to interact with an API on the users behalf
var_dump($token->getToken());
# string(217) "CAADAppfn3msBAI7tZBLWg...

// The time (in epoch time) when an access token will expire
var_dump($token->getExpires());
# int(1436825866)
echo '</pre>';

Authorization Scopes

All scopes described in the official documentation are available through public constants in \ItsMeStevieG\OAuth2\Client\Provider\Nitrado:

SCOPE_USER_INFO
SCOPE_SERVICE
SCOPE_SERVICE_ORDER
SCOPE_SSH_KEYS

Contributing

Please see CONTRIBUTING for details.

Credits

Steven Graham

License

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

itsmestevieg / oauth2-nitrado

Maintainers

Details