README

此软件包为 PHP League 的 OAuth 2.0 客户端 提供了 Linode OAuth 2.0 支持。

安装

安装时，请使用 composer

composer require webinarium/oauth2-linode

用法

用法与 The League 的 OAuth 客户端相同，使用 \Linode\OAuth2\Client\Provider\Linode 作为提供程序。

授权码流

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

管理作用域

在创建 Linode 授权 URL 时，您可以指定应用程序可以授权的状态和作用域。

$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);

如果两者都没有定义，则提供程序将使用内部默认值。

在编写本说明时，以下作用域可用：以下作用域可用

• 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

开发

./bin/php-cs-fixer fix
./bin/phpunit --coverage-text

贡献

有关详细信息，请参阅 CONTRIBUTING

致谢

• Artem Rodygin

许可协议

MIT 许可协议 (MIT)。有关更多信息，请参阅 许可文件