本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。
使用Python SDK发起OSS请求,您需要配置访问凭证。阿里云服务会通过访问凭证验证您的身份信息和访问权限。您可以根据使用场景对认证和授权的要求,选择不同类型的访问凭证。本文介绍如何配置临时访问凭证和长期访问凭证。
前提条件
在配置访问凭证前,您需要安装OSS Python SDK。详情请参见安装。
访问凭证
您可以选择以下类型的访问凭证。
临时访问凭证:对于需要高安全性的场景,例如临时授权应用访问OSS,建议使用临时访问凭证。临时访问凭证可以限制访问的有效期,从而减少访问凭证泄露的风险。此外,临时访问凭证支持权限控制,可以有效地避免权限过大的问题。更多信息,请参见使用临时访问凭证。
长期访问凭证:出于安全性考虑,不建议您使用长期访问凭证,建议您使用临时访问凭证。对于需要便利性的场景,长期访问凭证可以在较长时间内免除多次刷新的麻烦。建议每三个月更换一次长期访问凭证,以提高账号的安全性。当长期访问凭证泄露或者不再使用时,应该及时删除或者禁用相关的访问凭证,以免造成安全风险。更多信息,请参见使用长期访问凭证。
OIDC访问凭证:如果容器集群上部署的是不可信的应用,您可能并不希望它们能通过元数据服务获取Worker节点关联实例RAM角色的STS Token,这时,您可以选择使用OIDC访问凭证。OIDC(OpenID Connect)是建立在OAuth 2.0基础上的一个认证协议,它可以在避免影响云上资源安全的同时又能让不可信的应用安全地获取所需的STS Token,实现应用级别的权限最小化。阿里云RAM支持基于OIDC的角色SSO。更多信息,请参见OIDC访问凭证。
注意事项
本文介绍了如何在不同操作系统(例如macOS、Linux、Windows)中使用Shell命令配置环境变量。正确设置环境变量可确保命令行启动的程序能正确识别必要的配置。如果您是在IDE中,可能需要参考本文在IDE中单独设置环境变量,以便程序在该环境下正确运行。
使用临时访问凭证
当您准备临时使用Python SDK访问OSS服务时,您可以选择以下方式配置临时访问凭证。
配置STS临时访问凭证:如果您需要在规定时间内访问您的OSS,您可以通过STS服务颁发一个STS临时访问凭证。临时访问凭证无需透露您的RAM用户访问密钥,使您的OSS访问更加安全。
配置RAM角色:如果您需要授权访问或跨账号访问OSS,您可以通过RAM用户扮演对应RAM角色的方式授权访问或跨账号访问OSS。
配置ECS的RAM角色:如果你需要在阿里云的云服务器ECS中访问您的OSS,您可以通过ECS实例RAM角色的方式访问OSS。实例RAM角色允许您将一个角色关联到云服务器实例,在实例内部基于STS临时凭证通过指定方法访问OSS。STS临时凭证由系统自动生成和更新,应用程序可以使用指定的实例元数据URL获取临时凭证,无需特别管理。
配置STS临时访问凭证
创建RAM用户。
具体操作,请参见创建RAM用户。
为RAM用户授予
AliyunSTSAssumeRoleAccess
权限。具体操作,请参见为RAM用户授权。
使用RAM用户调用STS服务的AssumeRole接口获取STS临时访问凭证。
具体操作,请参见AssumeRole。
配置STS临时访问凭证。
环境变量
使用获取的STS临时访问凭证配置环境变量。
macOS
打开终端。
执行以下命令。
nano ~/.bash_profile
在文件末尾添加从STS服务获取的临时访问凭证(包括AccessKeyId、AccessKeySecret、SecurityToken)。
export OSS_ACCESS_KEY_ID=STS.NV5ZCwphFSXqscqUHAKbH**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** export OSS_SESSION_TOKEN=CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
按
Ctrl
+X
,按Y
键确认保存,然后按Enter
键退出文件。执行以下命令以使更改生效。
source ~/.bash_profile
执行以下命令验证环境变量配置。
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET echo $OSS_SESSION_TOKEN
成功返回示例如下:
STS.NV5ZCwphFSXqscqUHAKbH**** IrVTNZNy5yQelTETg0cZML3TQn**** CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
Linux
打开终端。
执行以下命令。
sudo vim /etc/profile
按
i
键进入编辑模式,在文件末尾添加从STS服务获取的临时访问凭证(包括AccessKeyId、AccessKeySecret、SecurityToken)。export OSS_ACCESS_KEY_ID=STS.NV5ZCwphFSXqscqUHAKbH**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** export OSS_SESSION_TOKEN=CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
按
ESC
键退出编辑模式,输入:wq
,然后按Enter
键保存并退出文件。输入以下命令以使更改生效。
source /etc/profile
执行以下命令验证环境变量配置。
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET echo $OSS_SESSION_TOKEN
成功返回示例如下:
STS.NV5ZCwphFSXqscqUHAKbH**** IrVTNZNy5yQelTETg0cZML3TQn**** CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
Windows
打开命令行。
执行以下命令配置从STS服务获取的临时访问凭证(包括AccessKeyId、AccessKeySecret、SecurityToken)。
set OSS_ACCESS_KEY_ID=STS.NV5ZCwphFSXqscqUHAKbH**** set OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** set OSS_SESSION_TOKEN=CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
执行以下命令以使更改生效。
setx OSS_ACCESS_KEY_ID "%OSS_ACCESS_KEY_ID%" setx OSS_ACCESS_KEY_SECRET "%OSS_ACCESS_KEY_SECRET%" setx OSS_SESSION_TOKEN "%OSS_SESSION_TOKEN%"
执行以下命令验证环境变量配置。
echo %OSS_ACCESS_KEY_ID% echo %OSS_ACCESS_KEY_SECRET% echo %OSS_SESSION_TOKEN%
成功返回示例如下:
STS.NV5ZCwphFSXqscqUHAKbH**** IrVTNZNy5yQelTETg0cZML3TQn**** CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVt****
从环境变量中获取STS临时访问凭证。
# -*- coding: utf-8 -*- import oss2 from oss2.credentials import EnvironmentVariableCredentialsProvider # 使用环境变量中获取的STS临时访问密钥和安全令牌配置访问凭证。 auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
代码嵌入
警告在代码中嵌入访问凭证会导致安全问题。如果访问凭证被泄漏,攻击者就可以使用该访问凭证来访问您的资源OSS,造成损失。因此,建议您使用更安全的方式,例如从环境变量中获取访问凭证,来提高安全性。
# -*- coding: utf-8 -*- import oss2 # 填写从STS服务获取的临时访问密钥(AccessKey ID和AccessKey Secret)。 sts_access_key_id = 'OSS_ACCESS_KEY_ID' sts_access_key_secret = 'OSS_ACCESS_KEY_SECRET' # 填写从STS服务获取的安全令牌(SecurityToken)。 security_token = 'OSS_SESSION_TOKEN' # 使用临时访问凭证中的认证信息初始化StsAuth实例。 auth = oss2.StsAuth(sts_access_key_id, sts_access_key_secret, security_token)
配置RAM角色
执行以下命令安装
alibabacloud_credentials
。pip install alibabacloud_credentials
获取RAM用户的访问密钥。
具体操作,请参见创建RAM用户的AccessKey。
重要为降低RAM用户的访问密钥被泄露的风险,对于超过3个月的RAM用户的访问密钥,建议及时轮换。对于长期不用的RAM用户的访问密钥,建议及时禁用并删除。
获取目标RAM角色的RamRoleArn。
说明RamRoleArn是RAM角色的ARN信息,即需要扮演的角色ID。格式为acs:ram::$accountID:role/$roleName。$accountID为阿里云账号ID。$roleName为RAM角色名称。
具体操作,请参见查看RAM角色。
配置RAM用户的访问密钥和目标RAM角色的RAMRoleArn作为访问凭证。
环境变量
使用获取的RAM用户的访问密钥和目标RAM角色的RamRoleArn配置环境变量。
macOS
打开终端。
执行以下命令。
nano ~/.bash_profile
在文件末尾添加获取的RAM用户的访问密钥和RAM角色的RamRoleArn。
export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** export OSS_STS_ROLE_ARN=acs:ram::17464958********:role/ossststest
按
Ctrl
+X
,按Y
键确认保存,然后按Enter
键退出文件。执行以下命令以使更改生效。
source /etc/profile
执行以下命令验证环境变量配置。
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET echo $OSS_STS_ROLE_ARN
成功返回示例如下:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn**** acs:ram::17464958********:role/ossststest
Linux
打开终端。
执行以下命令。
sudo vim /etc/profile
按
i
键进入编辑模式,在文件末尾添加获取的RAM用户的访问密钥和RAM角色的RamRoleArn。export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** export OSS_STS_ROLE_ARN=acs:ram::17464958********:role/ossststest
按
ESC
键退出编辑模式,输入:wq
,然后按Enter
键保存并退出文件。输入以下命令以使更改生效。
source /etc/profile
执行以下命令验证环境变量配置。
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET echo $OSS_STS_ROLE_ARN
成功返回示例如下:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn**** acs:ram::17464958********:role/ossststest
Windows
打开命令行。
执行以下命令配置RAM用户的访问密钥和RAM角色的RamRoleArn。
set OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** set OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn**** set OSS_STS_ROLE_ARN=acs:ram::17464958********:role/ossststest
执行以下命令以使更改生效。
setx OSS_ACCESS_KEY_ID "%OSS_ACCESS_KEY_ID%" setx OSS_ACCESS_KEY_SECRET "%OSS_ACCESS_KEY_SECRET%" setx OSS_STS_ROLE_ARN "%OSS_STS_ROLE_ARN%"
执行以下命令验证环境变量配置。
echo %OSS_ACCESS_KEY_ID% echo %OSS_ACCESS_KEY_SECRET% echo %OSS_STS_ROLE_ARN%
成功返回示例如下:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn**** acs:ram::17464958********:role/ossststest
从环境变量中获取RAM用户的访问密钥RAM角色的RamRoleArn。
# -*- coding: utf-8 -*- import oss2 from alibabacloud_credentials.client import Client from alibabacloud_credentials.models import Config from oss2 import CredentialsProvider from oss2.credentials import Credentials import os class CredentialProviderWarpper(CredentialsProvider): def __init__(self, client): self.client = client def get_credentials(self): access_key_id = self.client.get_access_key_id() access_key_secret = self.client.get_access_key_secret() security_token = self.client.get_security_token() return Credentials(access_key_id, access_key_secret, security_token) config = Config( type='ram_role_arn', # 从环境变量中获取RAM用户的访问密钥(AccessKey ID和AccessKey Secret)。 access_key_id=os.getenv('OSS_ACCESS_KEY_ID'), access_key_secret=os.getenv('OSS_ACCESS_KEY_SECRET'), # 从环境变量中获取RAM角色的RamRoleArn。 role_arn=os.getenv('OSS_STS_ROLE_ARN'), # 填写RAM角色的会话名称。 role_session_name='roleSessionName' ) cred = Client(config) credentials_provider = CredentialProviderWarpper(cred) # 使用环境变量中获取的RAM用户的访问密钥和RAM角色的RamRoleArn配置访问凭证。 auth = oss2.ProviderAuth(credentials_provider)
代码嵌入
警告在代码中嵌入访问凭证会导致安全问题。如果访问凭证被泄漏,攻击者就可以使用该访问凭证来访问您的资源OSS,造成损失。因此,建议您使用更安全的方式,例如从环境变量中获取访问凭证,来提高安全性。
# -*- coding: utf-8 -*- import oss2 from alibabacloud_credentials.client import Client from alibabacloud_credentials.models import Config from oss2 import CredentialsProvider from oss2.credentials import Credentials class CredentialProviderWarpper(CredentialsProvider): def __init__(self, client): self.client = client def get_credentials(self): access_key_id = self.client.get_access_key_id() access_key_secret = self.client.get_access_key_secret() security_token = self.client.get_security_token() return Credentials(access_key_id, access_key_secret, security_token) config = Config( type='ram_role_arn', # 填写RAM用户的访问密钥(AccessKey ID和AccessKey Secret)。 access_key_id='OSS_ACCESS_KEY_ID', access_key_secret='OSS_ACCESS_KEY_SECRET', # 填写RAM角色的RamRoleArn。 role_arn='OSS_STS_ROLE_ARN', # 填写RAM角色的会话名称。 role_session_name='roleSessionName' ) cred = Client(config) credentials_provider = CredentialProviderWarpper(cred) # 使用环境变量中获取的RAM用户的访问密钥和RAM角色的RamRoleArn配置访问凭证。 auth = oss2.ProviderAuth(credentials_provider)
配置ECS的RAM角色
执行以下命令安装
alibabacloud_credentials
。pip install alibabacloud_credentials
为ECS实例授予RAM角色。
具体操作,请参见授予实例RAM角色。
配置ECS的RAM角色作为访问凭证。
# -*- coding: utf-8 -*- import oss2 from alibabacloud_credentials.client import Client from alibabacloud_credentials.models import Config from oss2 import CredentialsProvider from oss2.credentials import Credentials import os class CredentialProviderWarpper(CredentialsProvider): def __init__(self, client): self.client = client def get_credentials(self): access_key_id = self.client.get_access_key_id() access_key_secret = self.client.get_access_key_secret() security_token = self.client.get_security_token() return Credentials(access_key_id, access_key_secret, security_token) config = Config( type='ecs_ram_role', # 访问凭证类型。固定为ecs_ram_role。 role_name='ECSRAMRole' # 为ECS授予的RAM角色的名称。可选参数。如果不设置,将自动检索。强烈建议设置,以减少请求。 ) cred = Client(config) credentials_provider = CredentialProviderWarpper(cred) auth = oss2.ProviderAuth(credentials_provider)
使用长期访问凭证
当您准备在应用或服务中长期使用Python SDK访问OSS服务时,您可以通过以下方式配置长期访问凭证。
配置RAM用户的访问密钥:如果您需要长期访问您的OSS,您可以通过RAM用户的访问密钥的方式访问您的OSS。
配置RAM用户的访问密钥
获取RAM用户的访问密钥。
如何获取RAM用户的访问密钥,请参见创建RAM用户的AccessKey。
重要对于超过3个月的RAM用户的访问密钥,建议及时轮换。对于长期不用的RAM用户的访问密钥,建议及时禁用并删除。以此降低RAM用户的访问密钥被泄露的风险。
配置RAM用户的访问密钥。
环境变量
配置环境变量。
macOS
打开终端。
执行以下命令。
nano ~/.bash_profile
在文件末尾添加RAM用户的访问密钥。
export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****
按
Ctrl
+X
,按Y
键确认保存,然后按Enter
键退出文件。输入以下命令以使更改生效。
source ~/.bash_profile
执行以下命令验证环境变量配置。
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET
成功返回示例如下:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn****
Linux
打开终端。
执行以下命令。
sudo vim /etc/profile
按
i
键进入编辑模式,在文件末尾添加RAM用户的访问密钥。export OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** export OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****
按
ESC
键退出编辑模式,输入:wq
,然后按Enter
键保存并退出文件。输入以下命令以使更改生效。
source /etc/profile
执行以下命令验证环境变量配置。
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET
成功返回示例如下:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn****
Windows
打开命令行。
执行以下命令配置RAM用户的访问密钥。
set OSS_ACCESS_KEY_ID=LTAI4GDty8ab9W4Y1D**** set OSS_ACCESS_KEY_SECRET=IrVTNZNy5yQelTETg0cZML3TQn****
执行以下命令以使更改生效。
setx OSS_ACCESS_KEY_ID "%OSS_ACCESS_KEY_ID%" setx OSS_ACCESS_KEY_SECRET "%OSS_ACCESS_KEY_SECRET%"
执行以下命令验证环境变量配置。
echo %OSS_ACCESS_KEY_ID% echo %OSS_ACCESS_KEY_SECRET%
成功返回示例如下:
LTAI4GDty8ab9W4Y1D**** IrVTNZNy5yQelTETg0cZML3TQn****
从环境变量中获取RAM用户的访问密钥。
# -*- coding: utf-8 -*- import oss2 from oss2.credentials import EnvironmentVariableCredentialsProvider # 使用环境变量中获取的RAM用户的访问密钥配置访问凭证。 auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
代码嵌入
警告在代码中嵌入访问凭证会导致安全问题。如果访问凭证被泄漏,攻击者就可以使用该访问凭证来访问您的资源OSS,造成损失。因此,建议您使用更安全的方式,例如从环境变量中获取访问凭证,来提高安全性。
# -*- coding: utf-8 -*- import oss2 # 填写RAM用户的访问密钥(AccessKey ID和AccessKey Secret)。 accessKeyId = 'yourAccessKeyId' accessKeySecret = 'yourAccessKeySecret' # 使用代码嵌入的RAM用户的访问密钥配置访问凭证。 auth = oss2.Auth(accessKeyId, accessKeySecret)
OIDC访问凭证
如果您需要了解阿里云RAM支持基于OIDC角色SSO的更多信息,请参见OIDC角色SSO概览。
当您准备在应用或服务中使用OIDC认证访问OSS服务时,您可以通过以下步骤配置访问凭证。
使用Alibaba Cloud Credentials方式,需要通过如下命令安装alibabacloud_credentials依赖。
pip install alibabacloud_credentials
创建OIDC身份提供商并为其授予RAM角色。具体操作,请参见创建可信实体为身份提供商的RAM角色和为RAM角色授权。
配置OIDC的RAM角色作为访问凭证。以下示例中创建的client即可用来访问OSS。
# -*- coding: utf-8 -*- import oss2 from alibabacloud_credentials.client import Client from alibabacloud_credentials.models import Config from oss2 import CredentialsProvider from oss2.credentials import Credentials import os class OIDCRoleArnCredentialDemo(CredentialsProvider): def __init__(self, client): self.client = client def get_credentials(self): access_key_id = self.client.get_access_key_id() access_key_secret = self.client.get_access_key_secret() security_token = self.client.get_security_token() return Credentials(access_key_id, access_key_secret, security_token) config = Config( # 指定Credential类型,固定值为oidc_role_arn。 type='oidc_role_arn', # <ALIBABA_CLOUD_ACCESS_KEY_ID>需替换为返回数据中获取的临时AccessKeyId。 access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID'), # <ALIBABA_CLOUD_ACCESS_KEY_SECRET>需替换为返回数据中获取的临时AccessKeySecret。 access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET'), # <ALIBABA_CLOUD_SECURITY_TOKEN>需替换为返回数据中获取的临时SecurityToken。 security_token=os.environ.get('ALIBABA_CLOUD_SECURITY_TOKEN'), # 角色的ARN信息,即需要扮演的角色ID。 role_arn=os.environ.get('ALIBABA_CLOUD_ROLE_ARN'), # 指定 OIDC 提供者的 ARN(Amazon Resource Name)。 oidc_provider_arn=os.environ.get('ALIBABA_CLOUD_OIDC_PROVIDER_ARN'), # 指定 OIDC 令牌的文件路径,用于存储OIDC令牌。 oidc_token_file_path=os.environ.get('ALIBABA_CLOUD_OIDC_TOKEN_FILE'), # 角色会话名称 role_session_name='<RoleSessionName>', # 设置更小的权限策略,非必填。示例值:{"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"} policy='<Policy>', # 设置session过期时间 role_session_expiration=3600 ) cred = Client(config) credentials_provider = OIDCRoleArnCredentialDemo(cred) auth = oss2.ProviderAuth(credentials_provider)
后续步骤
配置访问凭证后,您需要初始化OSSClient。详情请参见初始化。
- 本页导读 (1)