README

此包为 PHP League 的 OAuth 2.0 客户端 提供了 Amazon Cognito OAuth 2.0 支持。

安装

要安装，请使用 composer

composer require cakedc/oauth2-cognito

用法

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

授权码流程

$provider = new CakeDC\OAuth2\Client\Provider\Cognito([
    'clientId'          => '{cognito-client-id}',
    'clientSecret'      => '{cognito-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
    'cognitoDomain'     => '{cognito-client-domain}', 
    'region'            => '{cognito-region}' 
]);

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

管理作用域

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

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['email','phone','profile']
];

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

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

在编写此文档时，以下作用域可用：

• phone
• email
• profile
• openid (对于 phone, email 或 profile 所必需)
• aws.cognito.signin.user.admin

托管域名

可选地，如果您正在使用您自己的域名作为客户端，您可以在初始化提供程序时配置它而不是 cognitoDomain 选项。

$provider = new CakeDC\OAuth2\Client\Provider\Cognito([
    'clientId'          => '{cognito-client-id}',
    'clientSecret'      => '{cognito-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
    'hostedDomain'      => '{cognito-hosted-domain}', //Full domain without trailing slash
]);

测试

$ ./vendor/bin/phpunit

贡献

请参阅 CONTRIBUTING 获取详细信息。

致谢

• Cake Development Corporation
• Alejandro Ibarra
• 所有贡献者

许可协议

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