flipboxdigital / oauth2-guardian
Craft CMS / Guardian OAuth 2.0 客户端提供者,用于 PHP League OAuth2-Client
1.1.0
2017-12-14 16:14 UTC
Requires
- league/oauth2-client: ^2.0
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: ~2.0
This package is auto-updated.
Last update: 2024-09-09 13:22:15 UTC
README
本包为Guardian和PHP League的OAuth 2.0 客户端提供了Craft OAuth 2.0 支持。
安装
安装时,使用composer
composer require flipboxdigital/oauth2-guardian
用法
用法与The League的OAuth客户端相同,使用\Flipbox\OAuth2\Client\Provider\Craft
作为提供者。
授权码流
$provider = new Flipbox\OAuth2\Client\Provider\Guardian([ 'domain' => 'https://yourdomain.com', 'apidomain' => 'https://api.yourdomain.com', 'clientId' => '{craft-client-id}', 'clientSecret' => '{craft-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->getEmail()); } 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(); }
管理作用域
在创建Craft授权URL时,您可以指定应用程序可以授权的状态和作用域。
$options = [ 'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE', 'scope' => ['contacts','content'] // array or string ]; $authorizationUrl = $provider->getAuthorizationUrl($options);
如果没有定义,提供者将使用内部默认值。
测试
$ ./vendor/bin/phpunit
贡献
请参阅CONTRIBUTING以获取详细信息。
鸣谢
许可证
MIT许可证(MIT)。请参阅许可证文件以获取更多信息。