PSN Provider for the OAuth 2.0 Client
Switch branches/tags
Nothing to show
Clone or download
hassankhan Merge branch 'release/0.2.0'
* release/0.2.0:
  Updated `CHANGELOG.md`
Latest commit f28803f Mar 21, 2016
Permalink
Failed to load latest commit information.
src Applied fixes from StyleCI Mar 21, 2016
tests
.editorconfig
.gitattributes Initial commit Mar 19, 2016
.gitignore
.scrutinizer.yml Initial commit Mar 19, 2016
.styleci.yml Initial commit Mar 19, 2016
.travis.yml Initial commit Mar 19, 2016
CHANGELOG.md Updated `CHANGELOG.md` Mar 21, 2016
CONTRIBUTING.md Minor fixes Mar 19, 2016
DOCS.md Initial commit Mar 19, 2016
LICENSE.md Initial commit Mar 19, 2016
README.md [ci-skip] Fixed StyleCI badge and link Mar 21, 2016
composer.json
phpcs.xml.dist Minor fixes Mar 19, 2016
phpunit.xml.dist Minor fixes Mar 19, 2016

README.md

oauth2-psn

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

Build Status PSR2 Conformance

PSN OAuth 2.0 Client Provider for the PHP League's OAuth2-Client, for PHP 5.5.9+.

Installation

To install, use composer:

composer require larabros/oauth2-psn

Usage

Usage is the same as the League OAuth2 client, using \League\OAuth2\Client\Provider\Psn as the provider.

Authorization Code Flow

$provider = new League\OAuth2\Client\Provider\Psn([
    'clientId'          => '{psn-client-id}',
    'clientSecret'      => '{psn-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->getPsnId());

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

Managing Scopes

When creating your PSN authorization URL, you can specify the state and scopes your application may authorize.

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['psn:s2s'] // array or string
];

$authorizationUrl = $provider->getAuthorizationUrl($options);

If neither are defined, the provider will utilize internal defaults.

At the time of authoring this documentation, the following scopes are available:

  • psn:s2s

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email contact@hassankhan.me instead of using the issue tracker.

Credits

License

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