README

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

更新

该项目被认为是可用的状态，并且功能完整。

此项目用于企业应用程序。因此，作者不太可能定期更新它，而是在使用该项目的企业应用程序遇到问题时进行更新。您应该期待5-10年的更新。

我们将监控问题和PR，并将继续与社区合作，在它们被贡献时提供更新。

安装

要安装，请使用 composer

composer require ofbeaton/oauth2-phabricator

用法

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

与 oauth2-client 打包

如 Symfony Bundles 中的 knpuniversity的 oauth2-client-bundle 或 HWIOAuthBundle，使用 PHP League 的 OAuth 2.0 客户端。

您必须传递您的 phabricator 安装的域名。对于 knpuniversity的 oauth2-client-bundle，这意味着在您的 Symfony config.yml 中，您想要这个

knpu_oauth2_client:
   clients:
      phabricator_oauth:
         type: generic
         provider_class: Ofbeaton\OAuth2\Client\Provider\Phabricator
         
         provider_options:
            domain: %phab_host%
            
         client_id: %phab_client_id%
         client_secret: %phab_client_secret%
         redirect_route: connect_phabricator_check
         redirect_params: {}                        

授权码流

$provider = new Ofbeaton\OAuth2\Client\Provider\Phabricator([
    'domain'            => 'https://your-phabricator-install.com',
    'clientId'          => '{phabricator-client-id}',
    'clientSecret'      => '{phabricator-client-secret}',
    'redirectUri'       => 'https://your-application.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->getRealName());

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

管理作用域

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

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['user','user:email','repo'] // array or string
];

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

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

在编写此文档时，没有可用的作用域。

测试

$ ./vendor/bin/phpunit

贡献

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

鸣谢

• Finlay Beaton
• Sammy Kaye Powers（通过 oauth2-facebook 的代码）
• Steven Maguire（通过 oauth2-github 的代码）
• 所有贡献者

许可协议

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