README

此包为PHP League的OAuth 2.0客户端提供人类援助ID OAuth 2.0支持。

安装

要安装，请使用composer

composer require un-ocha/oauth2-hid

用法

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

授权码流

$provider = new League\OAuth2\Client\Provider\HumanitarianId([
    'clientId'          => '{hid-client-id}',
    'clientSecret'      => '{hid-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->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();
}

管理作用域

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

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

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

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

撰写此文档时，以下作用域可用。

• r_basicprofile
• r_emailaddress
• rw_company_admin
• w_share

测试

$ ./vendor/bin/phpunit

贡献

有关详细信息，请参阅贡献。

鸣谢

• Guillaume Viguier-Just
• 所有贡献者

许可协议

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