Amazon IAM Identity Center (successor to Amazon Single Sign-On) 的具有自动身份验证刷新功能的令牌提供程序配置 - Amazon Command Line Interface
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

Amazon IAM Identity Center (successor to Amazon Single Sign-On) 的具有自动身份验证刷新功能的令牌提供程序配置

本主题介绍如何配置 Amazon CLI,以使用 SSO 令牌提供程序配置通过 Amazon IAM Identity Center (successor to Amazon Single Sign-On)(IAM Identity Center)对用户进行身份验证,您的 Amazon SDK 或工具可以自动检索刷新的身份验证令牌。

使用 IAM Identity Center 时,您可以登录到 Active Directory、内置 IAM Identity Center 目录或已连接到 IAM Identity Center 的另一个 IdP。您可以将这些凭证映射到使您可以运行 Amazon CLI 命令的 Amazon Identity and Access Management (IAM) 角色。

无论您使用哪个 IdP,IAM Identity Center 都会将这些区别抽象出来。例如,您可以连接 Microsoft Azure AD,如博客文章 IAM Identity Center 的下一个演进中所述。

注意

有关使用持有者身份验证(不使用账户 ID 和角色)的信息,请参阅《Amazon CodeCatalyst 用户指南》中进行设置以将 Amazon CLI 与 CodeCatalyst 一起使用

您可以使用 SSO 令牌提供程序配置,根据应用程序的需要自动刷新身份验证令牌,并使用延长会话持续时间选项。您可以通过下列方式来执行此配置:

  • 自动,使用 aws configure ssoaws configure sso-session 命令。以下命令是向导,指导您完成配置文件和 sso-session 信息的配置:

  • 手动,通过编辑存储命名配置文件的 config 文件。

先决条件

您必须先在 IAM Identity Center 内启用 SSO 身份验证。有关启用 SSO 身份验证的详细信息,请参阅《Amazon IAM Identity Center (successor to Amazon Single Sign-On) 用户指南》中的入门

使用 aws configure sso 向导配置您的配置文件

在 Amazon CLI 中配置启用了 IAM Identity Center 的配置文件和 sso-session
  1. 运行 aws configure sso 命令并提供 IAM Identity Center 启动 URL 和托管 Identity Center 目录的 Amazon 区域。

    $ aws configure sso SSO session name (Recommended): my-sso SSO start URL [None]: https://my-sso-portal.awsapps.com/start SSO region [None]: us-east-1 SSO registration scopes [None]: sso:account:access
  2. Amazon CLI 尝试打开原定设置浏览器,并开始您的 IAM Identity Center 账户的登录过程。

    Attempting to automatically open the SSO authorization page in your default browser.

    如果 Amazon CLI 无法打开浏览器,则会显示以下消息,其中包含有关如何手动开始登录过程的说明。

    If the browser does not open or you wish to use a different device to authorize this request, open the following URL: https://device.sso.us-west-2.amazonaws.com/ Then enter the code: QCFK-N451

    IAM Identity Center 使用代码将 IAM Identity Center 会话与当前 Amazon CLI 会话关联。IAM Identity Center 浏览器页面会提示您使用 IAM Identity Center 凭证登录。这样可向 Amazon CLI 授予权限以检索和显示您有权与 IAM Identity Center 一起使用的 Amazon 账户和角色。

    注意

    登录过程可能会提示您允许 Amazon CLI 访问您的数据。由于 Amazon CLI 基于 SDK for Python 而构建,因此权限消息可能包含 botocore 名称的变体。

  3. Amazon CLI 会显示可供您使用的 Amazon 账户。如果您只被授权使用一个账户,Amazon CLI 会自动为您选择该账户并跳过提示。可供您使用的 Amazon 账户由 IAM Identity Center 中的用户配置决定。

    There are 2 Amazon accounts available to you. > DeveloperAccount, developer-account-admin@example.com (123456789011) ProductionAccount, production-account-admin@example.com (123456789022)

    使用箭头键选择要使用的账户。左侧的“>”字符指向当前选择。按 Enter 进行选择。

  4. Amazon CLI 确认您选择的账户,并显示所选账户中可供您使用的 IAM 角色。如果所选账户仅列出一个角色,Amazon CLI 会自动为您选择该角色并跳过提示。可供您使用的角色由 IAM Identity Center 中的用户配置决定。

    Using the account ID 123456789011 There are 2 roles available to you. > ReadOnly FullAccess

    使用箭头键选择要使用的 IAM 角色,然后按 <ENTER> 键。

  5. 指定默认输出格式、要向其发送命令的默认 Amazon Web Services 区域,并提供配置文件名称,以便您可以从本地计算机上定义的所有配置文件中引用此配置文件。在以下示例中,用户输入原定设置区域、原定设置输出格式和配置文件的名称。如果您具有以前的现有配置,也可以按下 <ENTER> 以选择方括号之间显示的任何原定设置值。建议的配置文件名称是账户 ID 号,并依次后跟下划线和角色名称。

    CLI default client Region [None]: us-west-2<ENTER> CLI default output format [None]: json<ENTER> CLI profile name [123456789011_ReadOnly]: my-dev-profile<ENTER>
    注意

    如果您指定 default 作为配置文件名称,则每当您运行 Amazon CLI 命令但不指定配置文件名称时,此配置文件将变为使用的配置文件。

  6. 最后一条消息描述了完成的配置文件配置。

    To use this profile, specify the profile name using --profile, as shown: aws s3 ls --profile my-dev-profile
  7. 这会导致在 ~/.aws/config 中创建 sso-session 部分和命名配置文件,具体如下所示:

    [profile my-dev-profile] sso_session = my-sso sso_account_id = 123456789011 sso_role_name = readOnly region = us-west-2 output = json [sso-session my-sso] sso_region = us-east-1 sso_start_url = https://my-sso-portal.awsapps.com/start sso_registration_scopes = sso:account:access

    现在,您可以使用此 sso-session 和配置文件来请求刷新的凭证。使用 aws sso login 命令请求和检索运行命令所需的凭证。有关说明,请参阅 使用启用了 IAM Identity Center 的命名配置文件

使用 aws configure sso-session 向导仅配置您的 sso-session 部分

aws configure sso-session 命令仅更新 ~/.aws/config 文件中的 sso-session 部分。此命令可用于创建或更新您的会话。如果您已有现有的配置设置并且想要创建新的 sso-session 配置或编辑现有的这一配置,这很有用。

运行 aws configure sso 命令并提供 IAM Identity Center 启动 URL 和托管 Identity Center 目录的 Amazon 区域。

$ aws configure sso SSO session name: my-sso SSO start URL [None]: https://my-sso-portal.awsapps.com/start SSO region [None]: us-east-1 SSO registration scopes [None]: sso:account:access

输入您的信息后,会有一条消息描述已完成的配置文件配置。

Completed configuring SSO session: my-sso Run the following to login and refresh access token for this session: aws sso login --sso-session my-sso
注意

如果您已登录到您正在更新的 sso-session,请运行 aws sso login 命令来刷新您的令牌。

使用 config 文件手动配置

config 文件的 sso-session 部分用于对获取 SSO 访问令牌的配置变量进行分组,然后可以用来获取 Amazon 凭证。使用了以下设置:

您定义一个 sso-session 部分并将其关联到配置文件。必须在 sso-session 部分内设置 sso_regionsso_start_url。通常,sso_account_idsso_role_name 必须在 profile 部分进行设置,以便 SDK 可以请求 SSO 凭证。

以下示例将 SDK 配置为请求 SSO 凭证并支持自动令牌刷新:

[profile dev] sso_session = my-sso sso_account_id = 111122223333 sso_role_name = SampleRole [sso-session my-sso] sso_region = us-east-1 sso_start_url = https://my-sso-portal.awsapps.com/start

这也允许在多个配置文件中重复使用 sso-session 配置:

[profile dev] sso_session = my-sso sso_account_id = 111122223333 sso_role_name = SampleRole [profile prod] sso_session = my-sso sso_account_id = 111122223333 sso_role_name = SampleRole2 [sso-session my-sso] sso_region = us-east-1 sso_start_url = https://my-sso-portal.awsapps.com/start

但是,并不是所有 SSO 令牌配置场景都需要 sso_account_idsso_role_name。如果您的应用程序仅使用支持持有者身份验证的 Amazon 服务,则不需要传统 Amazon 凭证。持有者身份验证是一种 HTTP 身份验证方案,它使用称为持有者令牌的安全令牌。在这种情况下,不需要 sso_account_idsso_role_name。请参阅 Amazon 服务的单独指南,以确定其是否支持持有者令牌授权。

此外,可以作为 sso-session 的一部分配置注册范围。范围是 OAuth 2.0 中的一种机制,用于限制应用程序对用户账户的访问。应用程序可以请求一个或多个范围,向应用程序签发的访问令牌将仅限于授予的范围。这些范围定义了为已注册的 OIDC 客户端请求授权的权限和客户端检索的访问令牌。以下示例将 sso_registration_scopes 设置为提供已列出账户/角色的访问权限:

[sso-session my-sso] sso_region = us-east-1 sso_start_url = https://my-sso-portal.awsapps.com/start sso_registration_scopes = sso:account:access

身份验证令牌缓存到 ~/.aws/sso/cache 目录下的磁盘上,文件名基于会话名称。