craftcms / oauth2-craftid
Craft OAuth 2.0 Client Provider for The PHP League OAuth2-Client
Installs: 2 521 393
Dependents: 0
Suggesters: 0
Security: 0
Stars: 15
Watchers: 4
Forks: 1
Open Issues: 2
Requires
- league/oauth2-client: ^2.2.1
Requires (Dev)
- phpunit/phpunit: ^5.0
- satooshi/php-coveralls: ^1.0
- squizlabs/php_codesniffer: ^2.0
This package is auto-updated.
Last update: 2024-10-19 22:47:43 UTC
README
This package provides Craft ID OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
This package is compliant with PSR-1, PSR-2 and PSR-4. If you notice compliance oversights, please send a patch via pull request.
Requirements
The following versions of PHP are supported.
- PHP 5.6
- PHP 7.0
- PHP 7.1
- HHVM
Installation
To install, use composer:
composer require craftcms/oauth2-craftid
Usage
Authorization Code Flow
$provider = new \craftcms\oauth2\client\provider\CraftId([ 'clientId' => '{craft-app-id}', 'clientSecret' => '{craft-app-secret}', 'redirectUri' => 'https://example.com/callback-url', ]); if (!empty($_GET['error'])) { // Got an error, probably user denied access exit('Got error: ' . htmlspecialchars($_GET['error'], ENT_QUOTES, 'UTF-8')); } elseif (empty($_GET['code'])) { // If we don't have an authorization code then get one $authUrl = $provider->getAuthorizationUrl(); $_SESSION['oauth2state'] = $provider->getState(); header('Location: ' . $authUrl); exit; } elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) { // State is invalid, possible CSRF attack in progress 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 owner details $ownerDetails = $provider->getResourceOwner($token); // Use these details to create a new profile printf('Hello %s!', $ownerDetails->getName()); } catch (Exception $e) { // Failed to get user details exit('Something went wrong: ' . $e->getMessage()); } // Use this to interact with an API on the users behalf echo $token->getToken(); // Use this to get a new access token if the old one expires echo $token->getRefreshToken(); // Number of seconds until the access token will expire, and need refreshing echo $token->getExpires(); }
Scopes
If needed, you can include an array of scopes when getting the authorization url. Example:
$authorizationUrl = $provider->getAuthorizationUrl([
'scope' => [
'purchasePlugins',
'existingPlugins',
'transferPluginLicense',
'deassociatePluginLicense',
]
]);
header('Location: ' . $authorizationUrl);
exit;
Testing
$ ./vendor/bin/phpunit
Credits
License
The MIT License (MIT). Please see License File for more information.