README

此包为 PHP League 的 SymfonyConnect OAuth 2.0 提供支持，用于 OAuth 2.0 客户端。

受 https://github.com/symfonycorp/connect 和 https://github.com/hwi/HWIOAuthBundle 的启发。

安装

要安装，请使用 composer

composer require qdequippe/oauth2-symfony-connect

使用方法

使用方法与 The League 的 OAuth 客户端相同，使用 \Qdequippe\OAuth2\Client\Provider\SymfonyConnect 作为提供者。

授权码流

$provider = new Qdequippe\OAuth2\Client\Provider\SymfonyConnect([
    'clientId'          => '{symfony-connect-client-id}',
    'clientSecret'      => '{symfony-connect-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->getNickname());

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

管理作用域

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

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['SCOPE_PUBLIC', 'SCOPE_EMAIL'] // array or string ['SCOPE_PUBLIC SCOPE_EMAIL']
];

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

测试

$ ./vendor/bin/phpunit

贡献

有关详细信息，请参阅 CONTRIBUTING。

鸣谢

• Quentin Dequippe
• 所有贡献者

代码许可

MIT 许可证 (MIT)。请参阅 许可证文件 获取更多信息。

感谢

• https://github.com/symfonycorp/connect
• https://github.com/hwi/HWIOAuthBundle

Symfony 商标 & 许可

Symfony™ 是 Symfony SAS 的商标。保留所有权利。有关商标 & 许可的详细信息，请参阅 商标 & 许可。