webinarium / oauth2-linode
Linode OAuth 2.0 Client Provider for The PHP League OAuth2-Client
1.0.0
2018-10-14 00:59 UTC
Requires
- php: ^5.6|^7.0
- league/oauth2-client: ^2.0
- psr/http-message: ^1.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.13
- phpunit/phpunit: ^5.7
This package is auto-updated.
Last update: 2024-10-09 14:17:19 UTC
README
This package provides Linode OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
To install, use composer:
composer require webinarium/oauth2-linode
Usage
Usage is the same as The League's OAuth client, using \Linode\OAuth2\Client\Provider\Linode
as the provider.
Authorization Code Flow
$provider = new Linode\OAuth2\Client\Provider\Linode([ 'clientId' => '{linode-client-id}', 'clientSecret' => '{linode-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 /** @var \Linode\OAuth2\Client\Provider\LinodeResourceOwner $owner */ $user = $provider->getResourceOwner($token); // Use these details to create a new profile printf('Hello %s!', $user->getFirstName()); } 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 Linode authorization URL, you can specify the state and scopes your application may authorize.
$options = [ 'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE', 'scope' => [ Linode\OAuth2\Client\Provider\Linode::SCOPE_ACCOUNT_READ_ONLY, Linode\OAuth2\Client\Provider\Linode::SCOPE_LINODES_READ_WRITE, ] ]; $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:
- SCOPE_ACCOUNT_READ_ONLY
- SCOPE_ACCOUNT_READ_WRITE
- SCOPE_DOMAINS_READ_ONLY
- SCOPE_DOMAINS_READ_WRITE
- SCOPE_EVENTS_READ_ONLY
- SCOPE_EVENTS_READ_WRITE
- SCOPE_IMAGES_READ_ONLY
- SCOPE_IMAGES_READ_WRITE
- SCOPE_IPS_READ_ONLY
- SCOPE_IPS_READ_WRITE
- SCOPE_LINODES_READ_ONLY
- SCOPE_LINODES_READ_WRITE
- SCOPE_LONGVIEW_READ_ONLY
- SCOPE_LONGVIEW_READ_WRITE
- SCOPE_NODEBALANCERS_READ_ONLY
- SCOPE_NODEBALANCERS_READ_WRITE
- SCOPE_STACKSCRIPTS_READ_ONLY
- SCOPE_STACKSCRIPTS_READ_WRITE
- SCOPE_VOLUMES_READ_ONLY
- SCOPE_VOLUMES_READ_WRITE
Development
./bin/php-cs-fixer fix ./bin/phpunit --coverage-text
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.