通过ECS实例角色实现临时凭证的获取和使用
本文介绍了一种部署在ECS实例上的应用程序获取和使用临时凭证(STS Token)的方案。避免直接把AccessKey固化在程序或实例中,引发泄露风险。
方案概述
凭证管理是云上最容易出现风险的环节之一,管理不善将导致凭证泄漏,进而导致数据泄漏、资产损失等严重安全事故。当ECS实例或部署在ECS实例上的应用需要访问其他云资源时,必须先通过访问凭证来验证身份信息和访问权限。实例RAM角色允许您将一个角色关联到ECS实例,使ECS实例及其上的应用基于STS临时凭证访问其他云资源,无需透露长期AccessKey,既可减少密钥泄露的风险,也可借助访问控制RAM精细化控制资源访问权限,避免权限过度分配。本方案主要介绍如何创建实例RAM角色并授予给ECS实例,以及如何基于实例RAM角色获取临时访问凭证。
方案优势
该方案能够显著提升云上应用程序的安全性、灵活性和便捷性,同时降低维护成本和操作复杂性。
提高安全性
通过ECS实例角色和RAM角色关联,使用STS Token访问云资源,避免了将访问密钥硬编码在代码中,从而消除AK泄露的风险。临时凭证(STS Token)的使用有效解决了永久凭证(AK/SK)可能带来的安全风险问题。
精细化管理权限
通过为不同ECS实例赋予具有特定授权策略的RAM角色,确保实例仅能访问其所需的资源,实现权限最小化。
增强灵活性
部署在ECS实例的程序可以通过阿里云官方SDK,设置实例角色认证方式,获取临时凭证STS Token。这种方式无需预先配置固定的访问凭证,可以根据需要动态获取和使用临时凭证。无需直接在ECS实例上管理凭证,权限的调整仅需通过修改RAM角色的授权策略来实现,快捷地维护ECS实例拥有的访问权限。
降低维护成本
使用临时凭证STS Token,无需频繁更新代码中的访问密钥,减少了维护成本和操作复杂性。本方案提供Java/Python代码示例,客户能够快速完成应用改造,减少开发和部署的复杂度。
客户场景
部署在ECS中的应用程序采用无AK架构
场景描述
客户在ECS实例上部署的应用程序需要访问其他云资源,传统的方式是客户将RAM用户的AK(Access Key)固化在实例中,如果将AK写在配置文件中,容易造成AK泄露,维护困难等问题。ECS实例RAM角色通过将ECS实例和RAM角色关联,使用STS Token(Security Token Service)访问云资源,解决永久凭证可能导致的安全风险问题。
适用客户
- 需要高安全性:客户需要确保AK不被暴露,以防止安全漏洞。
- 动态管理访问权限:客户需要动态管理和临时授予实例访问其他资源的权限,避免长期凭证带来的风险。
- 简化运维管理:客户希望简化运维过程中对凭证的管理,减少手动维护的复杂性。
方案架构
本方案通过ECS实例角色实现临时凭证的获取和使用。该架构和流程通过动态管理和临时授予访问权限,避免了长期暴露AK的风险,提高了系统的安全性和灵活性。管理员仅需一次性配置角色和权限,后续实例在运行时即可动态获取和使用临时凭证,简化了运维管理工作。
管理员创建一个ECS实例类型的Role(角色),并对该角色授予相应的权限。角色权限包含访问需要的云资源的权限(图中1)。管理员将创建好的角色配置到对应的ECS实例上,使实例与角色关联(图中2)。客户应用程序通过调用ECS Meta服务的接口,获取临时安全凭证(STS Token)(图中3)。该过程中ECS Meta Server会调用AssumeRole接口,以云服务的身份扮演RAM角色,从RAM/STS服务获取STS Token,该过程对于用户而言无感知(图中i)。 客户应用程序使用获取到的STS Token来调用目标云资源服务的API。此时,应用程序使用临时凭证进行认证和授权(图中4)。资源服务API处理请求并返回访问结果,客户端应用程序接收到返回的结果后完成相应的业务逻辑。
产品费用及名词
产品费用
产品名称 |
产品说明 |
产品费用 |
资源目录RD |
资源目录RD(Resource Directory)是阿里云面向企业客户提供的一套多级账号和资源关系管理服务。 |
免费,详情参见产品计费。 |
云服务器ECS |
云服务器ECS(Elastic Compute Service)是一种简单高效、处理能力可弹性伸缩的计算服务。帮助您构建更稳定、安全的应用,提升运维效率,降低IT成本,使您更专注于核心业务创新。 |
收费,详情参见产品计费。 |
访问控制RAM |
访问控制RAM(Resource Access Management)是阿里云提供的管理用户身份与资源访问权限的服务。 |
免费,详情参见产品计费。 |
配置审计 |
配置审计(Cloud Config)是一项资源审计服务,为您提供面向资源的配置历史追踪、配置合规审计等能力。面对大量资源,帮您轻松实现基础设施的自主监管,确保持续性合规。 |
免费,详情参见产品计费。 |
系统运维管理OOS |
系统管理与运维服务(CloudOps Orchestration Service, OOS),是阿里云提供的云上自动化运维服务,能够自动化管理和执行任务。 |
免费,详情参见产品计费。 |
阿里云资源编排服务ROS |
资源编排服务ROS(Resource Orchestration Service)可以帮助您简化云计算资源的管理。自动完成所有资源的创建和配置,实现自动化部署和运维。 |
免费,详情参见产品计费。 |
操作审计 |
操作审计(ActionTrail)是阿里云提供的云账号资源操作记录的查询和投递服务,可用于安全分析、资源变更追踪以及合规性审计等场景。 |
免费,详情参见产品计费。 |
名词解释
名称 |
说明 |
企业管理主账号 |
在企业拥有多个阿里云账号时,特指拥有管理其他账号资源权限的管理员账号。用于管理多账号,统一配置多账号身份权限,统一查看各云账号账单,统一配置审计规则并下发到各成员账号。 |
共享服务账号 |
企业共享服务会部署在这个账号内,如网络的部署。推荐这个账号的费用由统一的某个团队来承担,比如基础设施团队。 |
RAM管理员 |
RAM管理员具备账号下RAM资源的管理权限。RAM管理员可以是阿里云账号(主账号),也可以是主账号下拥有AliyunRAMFullAccess权限的RAM用户,强烈推荐您使用RAM用户充当RAM管理员。 |
访问密钥(AccessKey) |
访问密钥AccessKey(简称AK)是阿里云提供给用户的永久访问凭据,一组由AccessKey ID和AccessKey Secret组成的密钥对。发起的请求会携带AccessKey ID和AccessKey Secret加密请求内容生成的签名,进行身份验证及请求合法性校验。 |
RAM角色(RAM role) |
RAM角色是一种虚拟用户,可以被授予一组权限策略。与RAM用户不同,RAM角色没有永久身份凭证(登录密码或访问密钥),需要被一个可信实体扮演。扮演成功后,可信实体将获得RAM角色的临时身份凭证,即安全令牌(STS Token),使用该安全令牌就能以RAM角色身份访问被授权的资源。 |
实例RAM角色 |
ECS实例通过实例RAM角色获得该角色拥有的权限,可以基于临时安全令牌STS(Security Token Service)访问指定云服务的API和操作指定的云资源,安全性更高。 |
实例启动模板 |
包含了ECS实例的配置信息,使用实例启动模板创建ECS实例可以免去重复配置的操作。 |
安全性
元数据服务器访问模式
默认情况下,实例元数据服务器可同时通过普通模式和加固模式访问。为了进一步增强安全性,您可以设置实例元数据服务器访问模式为仅加固模式。采用ECS实例的元数据加固策略来获取RAM角色的初始化凭据,相较于普通模式,此方式采纳了一种更为严谨的安全逻辑:首先在ECS实例内部自动生成一个具有时效限制的token,利用此token作为凭据,向元数据服务(Metadata Server)请求获得STS(Security Token Service)临时凭证。这一系列操作构成了凭据客户端的安全初始化流程。什么是加固模式请参见加固模式的介绍。
注意事项
ECS实例角色限制
为ECS实例授予实例RAM角色存在以下限制:
- ECS实例的网络类型必须是专有网络VPC。
- 一台ECS实例只能授予一个实例RAM角色。
ECS实例启动模板限制
- 一个账号在每个地域最多可创建30个实例启动模板。
- 创建实例启动模板时,所有参数都是可选的。但是,如果实例启动模板中未包含必要参数(例如实例规格、镜像等),则在使用该模板创建实例时还需要补充该必要参数。
- 模板一旦创建,不可修改,但支持创建新的版本。
元数据服务器加固模式限制
需确保实例的cloud-init版本为23.2.2。
- 部分最新发布的公共镜像支持cloud-init 23.2.2版本。在通过API接口RunInstances或CreateInstance创建新实例时,可以指定ImageId选择cloud-init 23.2.2版本的镜像,选用这些公共镜像创建的实例支持加固模式访问元数据。支持cloud-init 23.2.2版本的公共镜像信息,请参见公共镜像发布记录。
- 如果已有实例的cloud-init版本不满足要求,您可以升级cloud-init版本,从而支持加固模式。检查cloud-init版本及升级方法,请参见安装cloud-init。
支持STS的云服务
详情参见支持STS的云服务。
通过ECS实例角色获取的临时凭证有效期
通过ECS实例角色获取的临时凭证STS Token的有效期固定为6小时,并且不支持修改。同时该有效期不受实例角色的最大会话时间限制,比如您的实例角色最大会话时间设置的是1小时,但是通过ECS实例角色获取的STS Token有效期依然是6小时。
自动化模板
模板介绍
若您的应用程序在获取到ECS实例角色的临时凭据以后,还需要跨账号角色扮演到其他账号,使用其他角色身份调用OpenAPI,同时您希望跨账号批量完成被扮演的角色的创建。本方案提供基于Terraform的自动化模板,为资源目录下的目标账号批量创建 RAM 角色。
模板地址
模板详情参见代码仓库。
实施步骤
实施准备
如您需要审计ECS实例是否绑定实例角色,请确保已在「企业管理主账号」中开通配置审计。具体操作,请参考开通配置审计服务。
实施时长
在实施准备工作完成的情况下,本方案实施预计时长:60分钟。
操作步骤
持续合规审计(可选)
您可以通过配置审计,审计ECS实例是否绑定实例角色,保证临时凭据的使用落实。
创建账号组(可选)
如果您当前为多账号环境,希望对多个成员账号进行集中的合规管理,可以使用企业管理账号将资源目录中的所有或部分成员账号加入到同一个账号组中,账号组将作为一个跨账号合规管理的管理单元。如果您是单账号环境,可跳过本步骤。
- 登入企业管理主账号,进入资源管理控制台,在左侧导航栏选择 资源目录 > 可信服务。选择配置审计,单击管理。
- 在委派管理员账号中,单击添加,将日志账号委派为配置审计服务的管理员。
- 登入日志账号,进入配置审计控制台,在左侧导航栏选择账号组。单击创建账号组,通过账号组,对资源目录中的成员账号进行集中合规管理。
- 创建账号组时,账号组类型,可以选择全局。全局账号组包含的成员将自动与资源目录保持一致。全局账号组会自动感知资源目录中成员的新增,并自动同步加入到该全局账号组中,确保合规管理的账号范围始终与资源目录保持一致。需要注意的是,您只能新建一个全局账号组。填入名称和描述后单击提交完成账号组的创建。
创建规则
- 进入配置审计控制台。若您使用上述步骤中的账号组进行多账号合规管控,需要在左侧导航栏中切换到需要合规管控的账号组中。
- 在左侧导航栏选择合规审计 > 规则,单击新建规则。选择名为ECS实例被授予实例RAM角色的规则。单击下一步。
- 在设置基本属性中,设置风险等级、触发机制,触发频率等。然后单击下一步。
- 默认选中云服务器 ECS作为规则关联的资源类型。您可以进一步设置规则生效的范围,比如,配置该该规则只对某些资源组内的资源或者具有某些标签的资源生效。以此来对合规管控的资源范围进行更加精细化的管理。然后单击下一步。
- 单击提交进行创建,创建完成后,在规则详情页,您可以看到当前账号组下,所有不合规的资源,即未被授予实例RAM角色的所有ECS主机实例。该规则默认会每 24 个小时执行一次检测,您可以在创建规则或者修改规则时,配置该规则的触发频率。
- 最后,您还可以将不合规资源数据投递到其他云产品中,比如日志服务、对象存储等。方便您进一步对数据进行归档、处理、审计等操作。更多投递相关的信息,请参考配置审计投递。
创建RAM角色(可选)
您需要创建一个RAM角色,用于后续步骤中为ECS实例绑定RAM角色,如已创建,可跳过本步骤。
- 使用ECS实例所属账号登录RAM控制台。
- 在左侧导航栏,选择身份管理 > 角色。
- 在角色页面,单击创建角色。
- 在创建角色页面,选择可信实体类型为阿里云服务,然后单击下一步。
- 选择角色类型为普通服务角色。输入角色名称和备注。选择可信服务为云服务器。单击完成。
成功创建RAM角色后,该RAM角色没有任何权限,您需要为该RAM角色授权,使其拥有相关的资源访问或操作权限。具体操作,请参见为RAM角色授权。
为增量ECS实例绑定RAM角色
接下来介绍在创建ECS实例时,如何为ECS实例绑定RAM角色。有多种方式可以完成ECS的创建,例如:控制台创建、使用实例启动模板、弹性伸缩创建。为增量ECS实例绑定RAM角色需确保已存在待绑定的RAM角色,如需新建RAM角色,请参考创建RAM角色章节。
控制台创建
- 在最终创建实例前,请在页面右侧检查实例的整体配置并配置使用时长等选项,确保各项配置符合您的要求。
- 阅读并签署《云服务器ECS服务条款》等服务协议(若已签署,则无需重复签署,请以页面提示为准),然后单击确认下单。
创建实例一般需要3~5分钟,请您耐心等待。您可前往控制台的实例列表页面查看实例的状态,当实例状态变为运行中时,表示实例创建完成。
实例启动模版创建
创建实例启动模板
您可以提前创建启动模板(如已有启动模版可跳过本步骤),便于后续使用模板快速创建ECS实例、弹性伸缩组或者弹性供应组。通过在模板中指定授予的RAM角色,确保通过该模板创建出来的实例都关联了指定的RAM角色。
- 登录ECS管理控制台。
- 在左侧导航栏,选择部署与弹性 > > 实例启动模板。
- 在页面顶部,选择目标资源所在的资源组和地域。
- 单击创建模板。
- 完成完成基础配置和高级配置,详细的参数配置及说明信息,请参见自定义购买实例。
- 在高级配置页面,找到高级选项。在此处配置实例RAM角色。
- 在配置确认页面,输入模板名称和模板版本描述,并单击创建启动模板。
修改已有的实例启动模板
如果您已经创建了实例启动模板,并且想要变更已有的模板,例如在模板中配置实例RAM角色。您可以通过创建启动模板的新版本来更改配置参数。在通过实例启动模板创建ECS实例时,您可以使用任何版本的实例启动模板。需要注意的是,如果您未指定某一版本,则会使用默认版本。
- 登录ECS管理控制台。
- 在左侧导航栏,选择部署与弹性 > > 实例启动模板。
- 在页面顶部,选择目标资源所在的资源组和地域。
- 在目标模板的操作列中,单击新建版本。您也可以选中一个模板,在版本信息中单击新建版本。
- 在启动模板页面,自定义配置参数。您可以在模板克隆区域选择已有的模板和版本,在此基础上配置参数。详细的参数配置及说明信息,请参见自定义购买实例。
- 在高级配置页面,找到高级选项。在此处配置实例RAM角色。
- 在配置确认页面选中创建新版本,并选择要保存到哪一个模板。
- 单击创建启动模板。在弹出的对话框中,单击查看新版本前往控制台查看已创建的新版本。
- 如需将其设置为默认版本,在启动模板页面,选中一个模板,在版本信息的操作列中单击设为默认。
使用实例启动模版创建实例
您可以使用指定的模板的任意一个版本快速创建ECS实例,提升效率及使用体验。在模板中配置好RAM角色后,通过该模板创建出来的实例都会关联上指定的RAM角色。
- 登录ECS管理控制台。
- 在左侧导航栏,选择部署与弹性 > > 实例启动模板。
- 在启动模板页面,找到目标模板,在操作列中单击创建实例。
- 在自定义购买页面,选择模板和版本,待配置信息加载完成,检查所有配置信息。
- 创建实例。
- 如果您选择的是包年包月实例,则选择购买时长并勾选服务协议,单击确认下单。
- 如果您选择的是按量付费实例,则勾选服务协议,单击确认下单。
实例创建成功后,您可以前往ECS控制台实例页面查看新创建的实例。单击目标ECS实例ID,在实例详情页面下方其他信息中,查看实例绑定的RAM角色。
弹性伸缩创建
如果您使用弹性伸缩(Elastic Scaling Service,简称ESS)来根据设定的策略自动调整计算资源数量(即业务所需的实例数量),需要确保使用的伸缩配置正确配置了实例RAM角色,否则由弹性伸缩新创建出来的实例没有绑定RAM角色,导致业务故障。
- 登录弹性伸缩控制台。
- 在左侧导航栏中,单击伸缩组管理。
- 在顶部菜单栏处,选择地域。
- 找到待操作的伸缩组,在操作列,单击查看详情。
- 在页面上方,单击实例配置来源页签。
实例配置来源是伸缩组扩容ECS实例时使用的实例配置模板。自动扩容时,伸缩组根据实例配置来源创建ECS实例,并将创建的实例添加到伸缩组。实例配置来源包括实例启动模板和伸缩配置两种。伸缩组内只能有一项生效的实例配置来源。例如,选用一条新的伸缩配置后,当前生效的启动模板或伸缩配置会失效。
如果您希望通过实例启动模板来伸缩扩容ECS实例:
- 在启动模板页签下,查看当前伸缩组所应用的启动模板,检查该启动模板对应的版本是否正确配置了实例RAM角色,若未配置RAM实例角色,参考实例启动模板创建章节完成配置。然后,点击操作列的修改按钮,选择对应的启动模板和版本。
如果您希望通过伸缩配置来伸缩扩容ECS实例:
若还没有伸缩配置:
- 在伸缩配置页签下,单击创建伸缩配置。
- 完成相关参数配置。(在高级设置中,配置实例RAM角色)
- 单击创建,确认参数配置无误,然后单击确认创建。
- 单击启用配置。
若已有伸缩配置:
- 在伸缩配置页签下,找到对应的伸缩配置,在操作列,单击修改。
- 完成相关参数配置。(在高级设置中,配置实例RAM角色)
- 单击修改,确认参数配置无误,然后单击确认修改。
- 对应的伸缩配置状态列变为生效后表示配置成功,弹性伸缩会使用该伸缩配置创建ECS实例。
为存量ECS实例绑定RAM角色
接下来介绍如何为已有的ECS实例绑定RAM角色,您有多种方式可以完成角色的绑定,例如:在控制台手动配置、通过API批量绑定、通过OSS批量绑定。为存量ECS实例绑定RAM角色需确保已存在待绑定的RAM角色,如需新建RAM角色,请参考创建RAM角色章节。
通过控制台绑定
- 登录ECS管理控制台。
- 在左侧导航栏,选择实例与镜像 > 实例。
- 在页面顶部,选择目标资源所在的资源组和地域。
- 找到要操作的ECS实例,在操作列单击 后,单击实例设置 > 授予/收回RAM角色。
- 在对话框中,选择创建好的实例RAM角色,单击确定完成授予。
通过API批量绑定
- 通过 AttachInstanceRamRole API为ECS实例批量绑定RAM角色。
- 通过 DescribeInstanceRamRole API查询ECS实例上的RAM角色。
- 通过 DetachInstanceRamRole API回收ECS实例上的RAM角色。
接下来以Java为例,演示如何调用API为存量ECS实例绑定实例RAM角色,首先需要集成SDK:
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>ecs20140526</artifactId>
<version>5.1.8</version>
</dependency>
下述代码演示了调用AttachInstanceRamRole API,为已有的ECS实例(i-bp139vch042zn1c5tq9b)绑定实例RAM角色(my-ecs-role):
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* 使用AK&SK初始化账号Client
* @return Client
* @throws Exception
*/
public static com.aliyun.ecs20140526.Client createClient() throws Exception {
// 工程代码泄露可能会导致 AccessKey 泄露,并威胁账号下所有资源的安全性。以下代码示例仅供参考。
// 建议使用更安全的 STS 方式,更多鉴权访问方式请参见:https://help.aliyun.com/document_detail/378657.html。
com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
// 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
.setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
// 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
.setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
// Endpoint 请参考 https://api.aliyun.com/product/Ecs
config.endpoint = "ecs-cn-hangzhou.aliyuncs.com";
return new com.aliyun.ecs20140526.Client(config);
}
public static void main() throws Exception {
com.aliyun.ecs20140526.Client client = Sample.createClient();
// 为杭州地域的i-bp139vch042zn1c5tq9b实例绑定my-ecs-role角色
com.aliyun.ecs20140526.models.AttachInstanceRamRoleRequest attachInstanceRamRoleRequest = new com.aliyun.ecs20140526.models.AttachInstanceRamRoleRequest()
.setRegionId("cn-hangzhou")
.setRamRoleName("my-ecs-role")
.setInstanceIds("[\"i-bp139vch042zn1c5tq9b\"]");
com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
try {
// 复制代码运行请自行打印 API 的返回值
client.attachInstanceRamRoleWithOptions(attachInstanceRamRoleRequest, runtime);
} catch (TeaException error) {
// 此处仅做打印展示,请谨慎对待异常处理,在工程项目中切勿直接忽略异常。
// 错误 message
System.out.println(error.getMessage());
// 诊断地址
System.out.println(error.getData().get("Recommend"));
com.aliyun.teautil.Common.assertAsString(error.message);
} catch (Exception _error) {
TeaException error = new TeaException(_error.getMessage(), _error);
// 此处仅做打印展示,请谨慎对待异常处理,在工程项目中切勿直接忽略异常。
// 错误 message
System.out.println(error.getMessage());
// 诊断地址
System.out.println(error.getData().get("Recommend"));
com.aliyun.teautil.Common.assertAsString(error.message);
}
}
}
通过OOS批量绑定
以下步骤需要在ECS实例所属账号执行。建议您创建一个RAM角色,用于OOS批量授予实例RAM角色时使用该角色身份来运行任务:
- 进入RAM控制台。
- 在左侧导航栏,选择身份管理 > 角色。
- 在角色页面,单击创建角色。
- 在创建角色页面,选择可信实体类型为阿里云服务,然后单击下一步。
- 角色类型选择普通服务角色,输入角色名称,例如oss-AttachInstanceRamRole-role,选择授信服务为系统运维管理,点击完成。
接下来,您需要为该角色分配权限:
- 进入RAM控制台。
- 选择权限策略菜单,点击创建权限策略。
- 通过脚本编辑模式,将配置框中的原有脚本替换为如下内容。
{
"Version": "1",
"Statement": [
{
"Action": [
"ecs:AttachInstanceRamRole",
"ecs:DescribeInstances"
],
"Resource": "*",
"Effect": "Allow"
},
{
"Action": [
"ram:PassRole"
],
"Resource": "*",
"Effect": "Allow"
},
{
"Action": [
"oos:StartExecution"
],
"Resource": "*",
"Effect": "Allow"
}
]
}
- 点击继续编辑基本信息,输入自定义权限策略名称。例如BulkyAttachInstanceRamRolePolicy。点击确定完成创建。
- 创建完成后,在角色页面,找到上述步骤创建的角色,点击新建授权按钮。
- 授权范围选择整个云账号。权限在当前阿里云账号内生效。授权主体选择您在上述步骤中创建的角色。自定义策略选择BulkyAttachInstanceRamRolePolicy,即您在上述步骤中创建的策略。
- 点击确定完成创建。
接下来通过OOS为存量ECS实例绑定RAM角色:
- 使用ECS实例所属账号进入系统运维管理管理控制台。
- 在自动化任务 > 任务执行管理页面点击创建。
- 在创建任务页面,设置基本信息。本示例中参数说明如下:
参数 |
描述 |
模板类别 |
选择公共任务模板 |
模板选择 |
选择ACS-ECS-BulkyAttachInstanceRamRole |
执行模式 |
选择失败暂停,当子任务执行有失败时,执行会暂停,等待您调整并决定是否继续执行。如果需要分批执行,每批暂停,此处也需选择失败暂停。 |
- 单击下一步:设置参数。设置为完成后单击下一步:确定。本示例中参数说明如下:
参数 |
描述 |
Ram角色名称 |
填写待授予ECS的RAM实例角色名 |
地域ID |
选择ECS实例所在的地域 |
目标实例 |
选择授予RAM实例角色的ECS实例 |
任务执行的并发比率 |
根据需要选择并发控制或批次控制,本例中选择批次控制:
|
OOS扮演的RAM角色 |
选择指定RAM角色,使用改角色的权限:
|
- 参数确认完毕后点击创建。
- 若在上述步骤中选择每批暂停,待执行状态变为等待中后,确认无误,单击继续按钮。
- 待执行状态变为成功后,表明已完成批量授予实例RAM角色任务。
基于实例RAM角色获取并使用临时凭证
当您通过阿里云SDK调用OpenAPI进行资源操作时,必须正确配置凭证信息。强烈推荐您使用阿里云的Credentials工具,帮助您轻松地获取和管理访问凭证:
- 基于实例RAM角色获取临时凭证时,Credentials工具会自动调用ECS的元数据服务(Meta Data Server)获取临时访问凭证。
- Credentials工具会自动维护临时凭证的生命周期,研发人员无需关心临时凭证的到期更新,Credentials工具会自动保证凭证的周期性更新。
- 借助Credentials工具的默认凭据链,可以用同一套代码,通过程序之外的配置来控制不同环境下的凭据获取方式
阿里云V2.0 SDK
如果您使用V2.0版本的阿里云SDK,可以很方便的集成阿里云的Credentials工具。
以Java为例,通过Maven方式安装Credentials工具:
<!--建议使用最新发布的Credentials版本。-->
<!--获取所有已发布的版本列表,请参见https://github.com/aliyun/credentials-java/blob/master/ChangeLog.txt-->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>credentials-java</artifactId>
<version>LATEST</version>
</dependency>
Credentials工具支持多种方式初始化凭据客户端,您可根据实际情况选择合适的方式进行凭据客户端初始化。下面介绍显式配置ECS角色(推荐)和默认凭据链的方式,更多方式,请参考初始化凭据客户端。
显式配置实例角色(推荐)
推荐您使用该方式,在代码中明确指定实例角色,避免运行环境中的环境变量、配置文件等带来非预期的结果。该方式显式设置类型为ecs_ram_role
,Credentials工具会自动获取ECS实例绑定的RAM角色,调用ECS的元数据服务(Meta Data Server)换取STS Token,完成凭据客户端初始化。详细代码请参考代码示例。
import com.aliyun.credentials.Client;
import com.aliyun.credentials.models.Config;
// import com.alibaba.fastjson2.JSON;
// import com.aliyun.sts20150401.models.GetCallerIdentityResponse;
public class DemoTest {
public static void main(String[] args) {
Config credentialConfig = new Config();
credentialConfig.setType("ecs_ram_role");
// 选填,该ECS角色的角色名称,不填会自动获取,建议加上以减少请求次数
credentialConfig.setRoleName("RoleName");
// 在加固模式下获取STS Token,强烈建议开启
credentialConfig.setEnableIMDSv2(true);
Client credentialClient = new Client(credentialConfig);
// 调用API,以调用GetCallerIdentity获取当前调用者身份信息为例
// com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
// .setCredential(credentialsClient)
// .setEndpoint("sts.cn-hangzhou.aliyuncs.com");
// com.aliyun.sts20150401.Client stsClient = new com.aliyun.sts20150401.Client(config);
// GetCallerIdentityResponse getCallerIdentityResponse = stsClient.getCallerIdentity();
// System.out.println(JSON.toJSONString(getCallerIdentityResponse));
}
}
上述代码在通过ECS实例RAM角色初始化客户端时,设置enable_imds_v2
的值为true,表示使用数据加固模式。相较于普通模式,此方式采纳了一种更为严谨的安全逻辑:首先在ECS实例内部自动生成一个具有时效限制的token,利用此token作为凭据,向元数据服务(Metadata Server)请求获得STS(Security Token Service)临时凭证。这一系列操作构成了凭据客户端的安全初始化流程。加固模式的核心优势在于,ECS实例内部产生的token不仅具备动态性,还严格限制了有效时间,大大降低了外部攻击者通过预测或伪造token来非法访问元数据服务的可能性,从而有效抵御了服务器端请求伪造(SSRF, Server-Side Request Forgery)等多种网络安全隐患。
默认情况下,实例元数据服务器可同时通过普通模式和加固模式访问。为了进一步增强安全性,您可以设置实例元数据服务器访问模式为仅加固模式。
对于新创建实例,可以通过API设置。通过API接口RunInstances或CreateInstance创建实例时,通过HttpTokens参数设置实例元数据服务器访问模式。该参数取值范围:
optional
:默认不强制使用加固模式,支持通过普通模式或加固模式访问实例元数据。required
:强制使用加固模式,即仅加固模式。设置该取值后,无法通过普通模式访问实例元数据。
对于已有实例,可以通过控制台手动修改或API方式修改。
控制台方式:
- 在实例列表页,找到待操作的实例,在操作列,选择 > 实例设置 > 修改实例元数据访问信息。
- 开启是否启用实例元数据访问通道,并设置实例元数据访问模式。
- 普通:支持通过普通模式或加固模式查看实例元数据。
- 仅加固模式(推荐):仅支持通过加固模式查看实例元数据,普通模式无法访问实例元数据。
API方式:通过ModifyInstanceMetadataOptions 修改元数据信息时,通过HttpTokens
参数设置实例元数据访问模式。该参数取值范围:
optional
:默认不强制使用加固模式,支持通过普通模式或加固模式访问实例元数据。required
:强制使用加固模式,即仅加固模式。设置该取值后,普通模式无法访问实例元数据。
默认凭据链
当您在初始化凭据客户端不传入任何参数时,Credentials工具会使用默认凭据链方式初始化客户端。借助Credentials工具的默认凭据链,您可以用同一套代码,通过程序之外的配置来控制不同环境下的凭据获取方式。除非您清楚的知道默认凭据链中凭据信息查询优先级以及您的程序运行的各个环境中凭据信息配置方式,否则不建议您使用默认凭据链,推荐您使用显式配置实例角色方式,避免运行环境中的环境变量、配置文件等带来非预期的结果。详细代码请参考代码示例。
import com.aliyun.credentials.Client;
// import com.alibaba.fastjson2.JSON;
// import com.aliyun.sts20150401.models.GetCallerIdentityResponse;
public class DemoTest {
public static void main(String[] args) throws Exception{
// 不指定参数
Client credentialClient = new Client();
// 调用API,以调用GetCallerIdentity获取当前调用者身份信息为例
// com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
// .setCredential(credentialsClient)
// .setEndpoint("sts.cn-hangzhou.aliyuncs.com");
// com.aliyun.sts20150401.Client stsClient = new com.aliyun.sts20150401.Client(config);
// GetCallerIdentityResponse getCallerIdentityResponse = stsClient.getCallerIdentity();
// System.out.println(JSON.toJSONString(getCallerIdentityResponse));
}
}
当使用默认凭据链方式初始化客户端时,以Java SDK为例,会尝试按照如下顺序查找相关凭据信息(优先级由高到低)。
- 系统属性
- 环境变量
- OIDC RAM角色
- 配置文件
- ECS实例RAM角色
详细信息请参考Java SDK默认凭据链。
其中,对于ECS实例RAM角色,Credentials工具会在环境变量中获取ALIBABA_CLOUD_ECS_METADATA(ECS实例RAM角色名称),若存在,程序将会通过ECS的元数据服务(Meta Data Server)获取ECS实例RAM角色的STS Token作为默认凭据信息。强烈建议配置环境变量ALIBABA_CLOUD_ECS_IMDSV2_ENABLE=true
开启在加固模式下获取STS Token。
需要注意的是:
- 使用默认凭据链的方式,Credentials工具会按照优先级依次查找相关凭据的信息,请避免环境变量维护不当导致获取到了非预期的凭据。
- 如果您在运行在ECS中的Docker环境中使用Credentials工具
- 请确保Docker中可以正常访问到ECS Meta Service,您可以在Docker环境中,执行命令:
url http://100.100.100.200/latest/meta-data/ram/security-credentials/${实例角色名称}
,如果正确返回临时凭证,那么您的Docker环境可以正常访问ECS Meta Service。 - 如果您使用的是Credentials工具的默认凭据链,请确保您在Docker环境中已经配置了上述所需的环境变量,而不是将环境变量配置到ECS实例上。
如果您需要从长期固定AccessKey的使用方式进行迁移,只需修改少量代码即可完成,如下图所示,左侧一栏是使用固定AccessKey初始化阿里云SDK,右侧一栏是使用Credentials工具初始化阿里云SDK。
阿里云V1.0 SDK(不推荐)
阿里云V1.0 SDK是较早使用版本,稳定性良好,不少老用户习惯于原版SDK的开发,本章节则是给这部分用户提供一个简练的使用指南。对于新用户则建议直接使用新版SDK,老用户也建议尽早迁移到新版SDK。
接下来介绍SDK客户端的初始化方式,可以通过Credentials工具初始化(推荐)、通过环境变量初始化、通过实例角色初始化。
通过Credentials工具初始化
使用阿里云V1.0 SDK也可以集成阿里云的Credentials工具,优先推荐使用该方式,以Java为例,通过Maven方式安装Credentials工具:
<!--建议使用最新发布的Credentials版本。-->
<!--获取所有已发布的版本列表,请参见https://github.com/aliyun/credentials-java/blob/master/ChangeLog.txt-->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>credentials-java</artifactId>
<version>LATEST</version>
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>tea</artifactId>
<version>LATEST</version>
</dependency>
下述代码演示了先初始化凭据客户端,再使用凭据客户端的凭据信息初始化V1.0 SDK客户端。关于凭据客户端的初始化方式,可以参考阿里云V2.0 SDK章节中介绍的两种方式,更多方式,请参考初始化凭据客户端。使用该方式可以通过ECS实例元数据加固模式获取RAM角色的凭证。详细代码请参考代码示例。
import com.aliyun.credentials.Client;
import com.aliyun.credentials.models.CredentialModel;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.auth.BasicSessionCredentials;
import com.aliyuncs.profile.DefaultProfile;
// import com.alibaba.fastjson2.JSON;
// import com.aliyuncs.sts.model.v20150401.GetCallerIdentityRequest;
// import com.aliyuncs.sts.model.v20150401.GetCallerIdentityResponse;
public class DemoTest {
public static void main(String[] args) {
DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou");
// 初始化凭据客户端
Client credentialClient = new Client();
// 用凭据客户端初始化SDK1.0客户端
IAcsClient client = createAcsClientByCredentials(profile, credentialClient);
// 调用API,以调用GetCallerIdentity获取当前调用者身份信息为例
// GetCallerIdentityRequest getCallerIdentityRequest = new GetCallerIdentityRequest();
// GetCallerIdentityResponse getCallerIdentityResponse = client.getAcsResponse(getCallerIdentityRequest);
// System.out.println(JSON.toJSONString(getCallerIdentityResponse));
}
public static IAcsClient createAcsClientByCredentials(DefaultProfile profile, Client credentialClient) {
return new DefaultAcsClient(profile, () -> {
// 保证线程安全,从 CredentialModel 中获取 ak/sk/security token
CredentialModel credentialModel = credentialClient.getCredential();
String ak = credentialModel.getAccessKeyId();
String sk = credentialModel.getAccessKeySecret();
String token = credentialModel.getSecurityToken();
return new BasicSessionCredentials(ak, sk, token);
});
}
}
值得注意的是,在使用凭据客户端初始化V1.0 SDK客户端过程中,为保证线程安全,需要先获取CredentialModel
,再从CredentialModel
获取凭据信息。不能直接从凭据客户端credentialClient
中获取凭据信息,因为Credentials工具会自动获取并更新凭据,会导致CredentialModel
对象发生变化,若直接从凭据客户端获取,可能获取到的AccessKeyId/AccessKeySecret/SecurityToken不属于同一套凭据,从而产生错误。
通过环境变量初始化
使用环境变量的方式,如果定义了环境变量ALIBABA_CLOUD_ECS_METADATA且不为空,程序会将该环境变量的值作为角色名称,通过ECS的元数据服务(Meta Data Server)获取ECS实例RAM角色的STS Token作为默认凭据信息。注意,该方式默认通过普通模式访问实例元数据服务器,不支持加固模式。详细代码请参考代码示例。
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
// import com.alibaba.fastjson2.JSON;
// import com.aliyuncs.sts.model.v20150401.GetCallerIdentityRequest;
// import com.aliyuncs.sts.model.v20150401.GetCallerIdentityResponse
public class Main {
public static void main(String[] args) {
IAcsClient client = new DefaultAcsClient("<your-region-id>");
// 调用API,以调用GetCallerIdentity获取当前调用者身份信息为例
// GetCallerIdentityRequest getCallerIdentityRequest = new GetCallerIdentityRequest();
// GetCallerIdentityResponse getCallerIdentityResponse = client.getAcsResponse(getCallerIdentityRequest);
// System.out.println(JSON.toJSONString(getCallerIdentityResponse));
}
}
通过实例角色初始化
V1.0 SDK客户端支持通过实例角色初始化,通过InstanceProfileCredentialsProvider
来初始化客户端。注意,该方式默认通过普通模式访问实例元数据服务器,不支持加固模式。详细代码请参考代码示例。
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.auth.InstanceProfileCredentialsProvider;
import com.aliyuncs.profile.DefaultProfile;
// import com.alibaba.fastjson2.JSON;
// import com.aliyuncs.sts.model.v20150401.GetCallerIdentityRequest;
// import com.aliyuncs.sts.model.v20150401.GetCallerIdentityResponse;
public class DemoTest {
public static void main(String[] args) {
DefaultProfile profile = DefaultProfile.getProfile("<your-region-id>");
InstanceProfileCredentialsProvider provider = new InstanceProfileCredentialsProvider(
"<your-role-name>"
);
DefaultAcsClient client = new DefaultAcsClient(profile, provider);
// 调用API,以调用GetCallerIdentity获取当前调用者身份信息为例
// GetCallerIdentityRequest getCallerIdentityRequest = new GetCallerIdentityRequest();
// GetCallerIdentityResponse getCallerIdentityResponse = client.getAcsResponse(getCallerIdentityRequest);
// System.out.println(JSON.toJSONString(getCallerIdentityResponse));
}
}
OSS SDK
如果您需要在阿里云的云服务器ECS中访问您的OSS,您可以通过ECS实例RAM角色的方式访问OSS。在集成OSS SDK后,您需要初始化OSS客户端。接下来介绍通过Credentials工具初始化的方式。
通过Credentials工具初始化
使用该方式需要集成阿里云的Credentials工具,优先推荐使用该方式,目前支持该方式的 OSS SDK有
OSS SDK 语言 |
推荐版本 |
Java |
>= 3.11.3 |
Python |
>= 2.14.0 |
PHP |
>= 2.6.0 |
Golang |
>= 3.0.2 |
通过Maven方式安装Credentals工具(确保 Credentals SDK version >= 0.3.2):
<!--建议使用最新发布的Credentials版本。-->
<!--获取所有已发布的版本列表,请参见https://github.com/aliyun/credentials-java/blob/master/ChangeLog.txt-->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>credentials-java</artifactId>
<version>LATEST</version>
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>tea</artifactId>
<version>LATEST</version>
</dependency>
下述代码演示了先初始化凭据客户端,再使用凭据客户端的凭据信息初始化OSS客户端。关于凭据客户端的初始化方式,可以参考阿里云V2.0 SDK章节中介绍的两种方式,更多方式,请参考初始化凭据客户端。使用该方式可以通过ECS实例元数据加固模式获取RAM角色的凭证。
import com.aliyun.credentials.Client;
import com.aliyun.credentials.models.CredentialModel;
import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.Credentials;
import com.aliyun.oss.common.auth.CredentialsProvider;
import com.aliyun.oss.common.auth.DefaultCredentials;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.Bucket;
public class CredentialsDefaultSample {
public static void main(String[] args) {
// 初始化凭据客户端
Client credentialClient = new Client();
// Bucket所在地域对应的Endpoint。以华东1(杭州)为例。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// Endpoint对应的Region信息,例如cn-hangzhou。
String region = "cn-hangzhou";
// 建议使用更安全的V4签名算法,则初始化时需要加入endpoint对应的region信息,同时声明SignVersion.V4
// OSS Java SDK 3.17.4及以上版本支持V4签名。
ClientBuilderConfiguration configuration = new ClientBuilderConfiguration();
configuration.setSignatureVersion(SignVersion.V4);
// 用凭据客户端初始化OSS客户端
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(new CredentialsProvider() {
@Override
public void setCredentials(Credentials credentials) {
}
@Override
public Credentials getCredentials() {
// 保证线程安全,从 CredentialModel 中获取 ak/sk/security token
CredentialModel credentialModel = credentialClient.getCredential();
String ak = credentialModel.getAccessKeyId();
String sk = credentialModel.getAccessKeySecret();
String token = credentialModel.getSecurityToken();
return new DefaultCredentials(ak, sk, token);
}
})
.clientConfiguration(configuration)
.region(region)
.build();
// 调用OSS API
// ossClient.listBuckets();
// 关闭OSSClient。
ossClient.shutdown();
}
}
值得注意的是,在使用凭据客户端初始化OSS客户端过程中,为保证线程安全,需要先获取CredentialModel
,再从CredentialModel
获取凭据信息。不能直接从凭据客户端credentialClient
中获取凭据信息,因为Credentials工具会自动获取并更新凭据,会导致CredentialModel
对象发生变化,若直接从凭据客户端获取,可能获取到的AccessKeyId/AccessKeySecret/SecurityToken不属于同一套凭据,从而产生错误。
SLS SDK
如果您需要在阿里云的云服务器ECS中访问您的SLS,您可以通过ECS实例RAM角色的方式访问SLS。在集成SLS SDK后,您需要初始化SLS客户端。接下来介绍通过Credentials工具初始化的方式。
通过Credentials工具初始化
使用该方式需要集成阿里云的Credentials工具,优先推荐使用该方式,目前支持的SDK有
SLS SDK 语言 |
推荐版本 |
Java |
>= 0.6.88 |
Python |
>= 0.9.3 |
PHP |
>= 0.6.4 |
Golang |
>= 0.1.55 |
以Java为例,通过Maven方式安装Credentials工具:
<!--建议使用最新发布的Credentials版本。-->
<!--获取所有已发布的版本列表,请参见https://github.com/aliyun/credentials-java/blob/master/ChangeLog.txt-->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>credentials-java</artifactId>
<version>LATEST</version>
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>tea</artifactId>
<version>LATEST</version>
</dependency>
下述代码演示了先初始化凭据客户端,再使用凭据客户端的凭据信息初始化SLS客户端。关于凭据客户端的初始化方式,可以参考阿里云V2.0 SDK章节中介绍的两种方式,更多方式,请参考初始化凭据客户端。使用该方式可以通过ECS实例元数据加固模式获取RAM角色的凭证。
import com.aliyun.credentials.models.CredentialModel;
import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.common.auth.DefaultCredentials;
public class DemoTest {
public static void main(String[] args) {
// 日志服务的服务接入点。以杭州为例,
String endpoint = "cn-hangzhou.log.aliyuncs.com";
// 初始化凭据客户端
com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
// 用凭据客户端初始化SLS客户端
Client slsClient = createSlsClientByCredentials(endpoint, credentialClient);
// 调用SLS API
// slsClient.ListProject();
//关闭SLS客户端
slsClient.shutdown();
}
public static Client createSlsClientByCredentials(String endpoint, com.aliyun.credentials.Client credentialClient) {
return new Client(endpoint, () -> {
// 保证线程安全,从 CredentialModel 中获取 ak/sk/security token
CredentialModel credentialModel = credentialClient.getCredential();
String ak = credentialModel.getAccessKeyId();
String sk = credentialModel.getAccessKeySecret();
String token = credentialModel.getSecurityToken();
return new DefaultCredentials(ak, sk, token);
});
}
}
值得注意的是,在使用凭据客户端初始化SLS客户端过程中,为保证线程安全,需要先获取CredentialModel
,再从CredentialModel
获取凭据信息。不能直接从凭据客户端credentialClient
中获取凭据信息,因为Credentials工具会自动获取并更新凭据,会导致CredentialModel
对象发生变化,若直接从凭据客户端获取,可能获取到的AccessKeyId/AccessKeySecret/SecurityToken不属于同一套凭据,从而产生错误。
其他SDK
SDK名称 |
SDK说明 |
使用方式 |
JindoSDK |
JindoSDK是访问JindoData组件的标准客户端。其中JindoData是阿里云开源大数据团队自研的数据湖存储加速套件,面向大数据和AI生态,为阿里云和业界主要数据湖存储系统提供全方位访问加速解决方案。详细信息请参考JindoData使用文档。 |
请参考JindoSDK免密访问。 |
通过元数据服务获取
某些场景,如果您没有适配Credentials工具,或需要在脚本中基于实例RAM角色来获取资源临时访问凭证,可直接在实例内部访问元数据服务器获取。
对于Linux类型实例,登陆到实例内部,执行以下命令:
# 获取元数据服务器的访问凭证用于鉴权
TOKEN=`curl -X PUT "http://100.100.100.200/latest/api/token" -H "X-aliyun-ecs-metadata-token-ttl-seconds:<元数据服务器访问凭证有效期>"`
# 获取实例RAM角色的临时授权访问凭证
curl -H "X-aliyun-ecs-metadata-token: $TOKEN" http://100.100.100.200/latest/meta-data/ram/security-credentials/<实例RAM角色名称>
对于Windows实例,登陆到实例内部,打开Powershell执行以下命令:
# 获取元数据服务器的访问凭证用于鉴权,以加强数据安全
$token = Invoke-RestMethod -Headers @{"X-aliyun-ecs-metadata-token-ttl-seconds" = "<元数据服务器的访问凭证有效期>"} -Method PUT –Uri http://100.100.100.200/latest/api/token
# 获取实例RAM角色的临时授权访问凭证
Invoke-RestMethod -Headers @{"X-aliyun-ecs-metadata-token" = $token} -Method GET -Uri http://100.100.100.200/latest/meta-data/ram/security-credentials/<实例RAM角色名称>
参数说明如下:
参数 |
说明 |
<元数据服务器的访问凭证有效期> |
在获取实例RAM角色的STS Token(临时凭证)之前,需要先获取元数据服务器的访问凭证并设置其有效期,以加强数据安全。有效期取值范围为1~21600,单位为秒。
|
<实例RAM角色名称> |
替换为具体的实例RAM角色名称。 |
返回结果如下所示:
{
"AccessKeyId" : "STS.*******6YSE",
"AccessKeySecret" : "aj******jDU",
"Expiration" : "2017-11-01T05:20:01Z",
"SecurityToken" : "CAISng********",
"LastUpdated" : "2023-07-18T14:17:28Z",
"Code" : "Success"
}
链式角色扮演
若您在获取到ECS实例角色的临时凭据以后,还需要跨账号角色扮演到其他账号,使用其他角色身份调用OpenAPI。可以以ECS实例RAM角色的身份调用STS服务的AssumeRole接口,设置Token的最大过期时间,即可换取到临时凭据STS Token,再使用该STS Token初始化凭据客户端。
import com.aliyun.credentials.Client;
import com.aliyun.credentials.models.Config;
import com.aliyun.sts20150401.models.AssumeRoleRequest;
import com.aliyun.sts20150401.models.AssumeRoleResponse;
import com.aliyun.sts20150401.models.AssumeRoleResponseBody;
// import com.alibaba.fastjson2.JSON;
// import com.aliyun.sts20150401.models.GetCallerIdentityResponse;
public class DemoTest {
public static void main(String[] args) throws Exception {
// 通过ECS实例元数据加固模式获取RAM角色初始化凭据客户端
Config credentialConfig = new Config();
credentialConfig.setType("ecs_ram_role");
credentialConfig.setRoleName("<your-role-name>");
credentialConfig.setEnableIMDSv2(true);
Client credential = new Client(credentialConfig);
// 跨账号角色扮演到其他账号初始化凭据客户端
Client assumeRoleCredential = createAssumeRoleCredential(credential);
// 调用API,以调用GetCallerIdentity获取当前调用者身份信息为例
// com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
// .setCredential(assumeRoleCredential)
// .setEndpoint("sts.cn-hangzhou.aliyuncs.com");
// com.aliyun.sts20150401.Client stsClient = new com.aliyun.sts20150401.Client(config);
// GetCallerIdentityResponse getCallerIdentityResponse = stsClient.getCallerIdentity();
// System.out.println(JSON.toJSONString(getCallerIdentityResponse));
}
public static Client createAssumeRoleCredential(Client credentialClient) throws Exception {
om.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
.setCredential(credentialClient)
// 地域
.setRegionId("<region-id>");
com.aliyun.sts20150401.Client stsClient = new com.aliyun.sts20150401.Client(config);
AssumeRoleRequest assumeRoleRequest = new AssumeRoleRequest()
// 要扮演的RAM角色ARN,acs:ram::${账号 ID}:role/${角色名称}
.setRoleArn("<role-arn>")
// 角色会话名称
.setRoleSessionName("<role-session-name>")
// 设置更小的权限策略,非必填。示例值:{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
.setPolicy("<session-policy>")
// STS Token 有效期,单位:秒
.setDurationSeconds(3600L);
AssumeRoleResponse assumeRoleResponse = stsClient.assumeRole(assumeRoleRequest);
AssumeRoleResponseBody.AssumeRoleResponseBodyCredentials credentials = assumeRoleResponse.getBody().getCredentials();
// 使用STS Token初始化凭据客户端
Config credentialConfig = new Config();
credentialConfig.setType("sts");
credentialConfig.setAccessKeyId(credentials.getAccessKeyId());
credentialConfig.setAccessKeySecret(credentials.getAccessKeySecret());
credentialConfig.setSecurityToken(credentials.getSecurityToken());
return new Client(credentialConfig);
}
}
注意:在角色链式扮演的场景下(如上代码所示,通过ECS实例角色的身份又去扮演了其他角色),不能使用ram_role_arn
的方式来初始化凭据客户端,因为Credentials SDK有自动刷新扮演对象的STS Token的机制,可能在刷新时,当前角色(扮演者)的STS Token过期了,从而导致错误。因此,在角色链式扮演的场景下,建议您每次通过AssumeRole API从当前角色去扮演其他角色获取相应的STS Token,通过上述示例代码中sts
的方式初始化凭据客户端,同时需要注意STS Token的有效期。如下为错误代码示例,createAssumeRoleCredential
方法使用了ram_role_arn
的方式,可能会因为ECS实例角色的STS Token过期而导致错误。
// 错误代码示例
public static Client createAssumeRoleCredential(Client credentialClient) throws Exception {
Config credentialConfig = new Config();
credentialConfig.setType("ram_role_arn");
credentialConfig.setAccessKeyId(credentialClient.getAccessKeyId());
credentialConfig.setAccessKeySecret(credentialClient.getAccessKeySecret());
credentialConfig.setSecurityToken(credentialClient.getSecurityToken());
credentialConfig.setRoleArn("<role-arn>");
credentialConfig.setRoleSessionName("<role-session-name>");
credentialConfig.setPolicy("<session-policy>");
credentialConfig.setRoleSessionExpiration(3600);
return new Client(credentialConfig);
}
代码示例
代码介绍
本方案提供Java和Python的代码示例,方便客户能够快速完成应用改造。若您的应用程序在获取到ECS实例角色的临时凭据以后,还需要跨账号角色扮演到其他账号,使用其他角色身份调用OpenAPI,同时您希望跨账号批量完成被扮演的角色的创建。本方案提供Terraform代码,为资源目录下的目标账号批量创建 RAM 角色。
代码地址
代码详情参见代码仓库。
通过ROS跨账号批量创建角色(可选)
若您的应用程序在获取到ECS实例角色的临时凭据以后,还需要跨账号角色扮演到其他账号,使用其他角色身份调用OpenAPI,同时您希望跨账号批量完成被扮演的角色的创建。您可以使用ROS模版创建资源栈组。通过该ROS模版和资源栈组为资源目录下的目标账号批量创建 RAM 角色。
创建委派管理员
通过委派管理员账号,可以将组织管理任务与业务管理任务相分离,企业管理账号执行资源目录的组织管理任务,委派管理员账号执行ROS的业务管理任务,这符合安全最佳实践的建议。接下来将资源目录的共享服务账号或运维账号设置为委派管理员账号,从而作为ROS的管理员账号为成员账号部署资源栈。
- 使用管理账号登录资源管理控制台。
- 在左侧导航栏,选择资源目录 > 可信服务。
- 在可信服务页面,单击资源编排(ROS)服务操作列的管理。
- 在委派管理员账号区域,单击添加。
- 在添加委派管理员账号面板,选中成员(共享服务账号)。
- 单击确定。添加成功后,使用该委派管理员账号访问对应可信服务的多账号管理模块,即可进行资源目录组织范围内的管理操作。
开启可信访问
当您开通了资源目录,使用资源目录的企业管理账号或委派管理员账号创建服务管理权限模式的资源栈组时,必须开启可信访问,授权服务管理权限。需要企业管理账号和委派管理员账号都开启可信访问。
- 分别使用企业管理账号和共享服务账号(委派管理员)登录资源编排控制台。
- 在左侧导航栏,单击资源栈组。
- 在资源栈组列表页面,单击右上角的开启可信访问。
批量创建所需角色
- 使用共享服务账号登录资源编排控制台。
- 在左侧导航栏,单击资源栈组。
- 在顶部菜单栏的地域下拉列表,选择资源栈组的所在地域。
- 在资源栈组列表页面,单击创建资源栈组。
- 在指定模板选择框中,勾选选择已有模板。
- 模板录入方式选择输入模板,模板内容选择Terraform。
- 内容文本框右上角,选择打开本地文件夹。
- 选择下载到本地的部署代码,点击下一步。
- 输入资源栈组名称和资源栈组描述,在配置模板参数页面,填写所需参数,然后单击下一步。
参数 |
说明 |
角色的名称 |
批量创建的角色的名称 |
策略名 |
绑定到该角色的权限策略的名称 |
策略内容 |
绑定到该角色的权限策略内容 |
角色可信的账号 |
允许扮演到该角色的账号,不填默认为当前账号 |
可信账号下允许扮演的角色 |
允许可信账号下扮演到该角色的角色名称 |
- 在配置资源栈组页面,选择服务管理权限,然后单击下一步。
- 在设置部署选项页面,部署目标选择资源目录的目标账号的资源夹,同时启用自动部署。
- 根据实际情况填写地域、资源组、标签、部署选项等信息,更多信息,请参见参数说明。然后单击下一步。
- 在检查并确认页面,检查资源栈组信息无误后,单击创建资源栈组。
- 创建完成后,在该资源栈组的详情页的实例页签中,可以查看实例的状态,最新表示已经在业务账号下完成了角色的创建。
实例角色操作审计(可选)
若您需要对ECS实例角色进行操作审计,例如使用该ECS实例角色的身份做了什么操作。您可以使用您的日志审计账号进入操作审计控制台,在事件>事件查询中找到该实例角色的操作事件,点击查看事件详情,可以通过事件记录中的requestParameters.stsTokenPrincipalName
来区分该操作来自于哪个ECS实例,该字段是一个固定的格式:${角色名称}/vm-ram-${MetaServer版本}-${实例ID}。
若您的账号开启了审计日志投递,可以在事件>高级查询中运行下方所示的查询SQL语句快速查找出实例使用实例角色身份的进行的所有操作:
event.requestParameters.stsTokenPrincipalName:${角色名称}/vm-ram-${MetaServer版本}-${实例ID}
故障排除
为什么无法开通资源目录?
可能有如下两个原因:
- 当前账号没有进行企业实名认证。关于企业实名认证,请参见企业实名认证。
- 当前账号已经在资源目录内,无法重复开通。
为什么无法使用 ROS 服务管理权限模式?
- 如果使用资源目录成员账号执行ROS的业务管理任务,您需要将资源目录的成员账号设置为委派管理员账号,从而作为 ROS 的管理员账号为成员账号部署资源栈。关于 ROS 委派管理员,请参见设置委派管理员账号。
- 当您开通了资源目录,使用资源目录的企业管理账号或委派管理员账号创建服务管理权限模式的资源栈组时,必须开启可信访问,授权服务管理权限。关于可信访问,请参见开启可信访问。
为什么执行 OOS 运维任务失败?
使用 OOS 的常见问题,请参见 OOS 服务支持。
为什么 Credentials SDK 报错:not found credentials?
- 请确保您已经为您的ECS绑定了RAM实例角色,您可以登录到ECS实例上,执行命令:
curl http://100.100.100.200/latest/meta-data/ram/security-credentials/${实例角色名称}
,如果正确返回临时凭证,那么您已成功绑定了RAM实例角色。 - 如果您使用的是JAVA的Credentials SDK,请确保您的SDK版本>=0.3.2。
- 如果您使用的是Credentials工具的默认凭据链,请确保您已经配置了环境变量ALIBABA_CLOUD_ECS_METADATA,该环境变量的值配置为RAM实例角色的名称。
- 如果您在运行在ECS中的Docker环境中使用Credentials工具
- 请确保Docker中可以正常访问到ECS Meta Service,您可以在Docker环境中,执行命令:
url http://100.100.100.200/latest/meta-data/ram/security-credentials/${实例角色名称}
,如果正确返回临时凭证,那么您的Docker环境可以正常访问ECS Meta Service。 - 如果您使用的是Credentials工具的默认凭据链,请确保您在Docker环境中已经配置了环境变量ALIBABA_CLOUD_ECS_METADATA,该环境变量的值配置为RAM实例角色的名称。需要注意的是,这里不要把环境变量配置到ECS实例上。