使用Python SDK V2配置Referer防盗链来阻止其他网站引用OSS文件

您可以使用阿里云OSSPython SDK来配置基于请求标头Referer的访问规则,包括设置白名单Referer、黑名单Referer以及是否允许空Referer。通过这些配置,您可以阻止特定Referer访问您的OSS文件,防止其他网站盗用您的资源,从而避免不必要的流量费用增加。

注意事项

  • 在配置防盗链之前,请确保您已了解该功能。详情请参见防盗链

  • 本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见OSS地域和访问域名

  • 要设置或清空防盗链,您必须具有oss:PutBucketReferer权限;要获取防盗链,您必须具有oss:GetBucketReferer权限。具体操作,请参见RAM用户授权自定义的权限策略

方法定义

设置防盗链

put_bucket_referer(request: PutBucketRefererRequest, **kwargs) → PutBucketRefererResult

获取防盗链设置

get_bucket_referer(request: GetBucketRefererRequest, **kwargs) → GetBucketRefererResult

请求参数列表

参数名

类型

说明

request

PutBucketRefererRequest

设置请求参数,具体请参见PutBucketRefererRequest

GetBucketRefererRequest

设置请求参数,具体请参见GetBucketRefererRequest

返回值列表

类型

说明

PutBucketRefererResult

返回值,具体请参见PutBucketRefererResult

GetBucketRefererResult

返回值,具体请参见GetBucketRefererResult

关于设置防盗链方法的完整定义,请参见put_bucket_referer

关于获取防盗链设置方法的完整定义,请参见get_bucket_referer

示例代码

设置防盗链

您可以使用以下代码设置防盗链。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器,并描述脚本用途:设置存储空间(Bucket)的防盗链配置
parser = argparse.ArgumentParser(description="put bucket referer sample")

# 定义命令行参数,包括必需的区域、存储空间名称以及可选的endpoint
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行参数,获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息,用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象,并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 设置配置对象的区域属性,根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint,则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端,准备与OSS交互
    client = oss.Client(cfg)

    # 发送请求以设置指定存储空间的防盗链配置
    result = client.put_bucket_referer(oss.PutBucketRefererRequest(
            bucket=args.bucket,  # 存储空间名
            referer_configuration=oss.RefererConfiguration(
                allow_empty_referer=True,  # 是否允许空Referer,默认为True
                allow_truncate_query_string=False,  # 是否允许截断查询字符串,默认为False
                truncate_path=False,  # 是否截断路径,默认为False
                referer_list=oss.RefererList(
                    referers=['http://www.aliyun.com', 'https://www.aliyun.com'],  # 允许的Referer列表
                ),
                referer_blacklist=oss.RefererBlacklist(
                    referers=['http://www.refuse.com', 'http://www.refuse1.com'],  # 拒绝的Referer黑名单
                ),
            ),
    ))

    # 打印操作结果的状态码和请求ID,以便确认请求状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          )

# 当此脚本被直接执行时,调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点,控制程序流程从这里开始

获取防盗链设置

您可以使用以下代码获取防盗链配置。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器,并描述脚本用途:获取存储空间(Bucket)的防盗链配置
parser = argparse.ArgumentParser(description="get bucket referer sample")

# 定义命令行参数,包括必需的区域、存储空间名称以及可选的endpoint
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行参数,获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息,用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象,并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    
    # 设置配置对象的区域属性,根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint,则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端,准备与OSS交互
    client = oss.Client(cfg)

    # 发送请求以获取指定存储空间的防盗链配置
    result = client.get_bucket_referer(oss.GetBucketRefererRequest(
            bucket=args.bucket,  # 存储空间名
    ))

    # 打印操作结果的状态码、请求ID和防盗链配置详情,以便确认请求状态和配置详情
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' allow empty referer: {getattr(result.referer_configuration, "allow_empty_referer", "Not set")},'
          f' allow truncate query string: {getattr(result.referer_configuration, "allow_truncate_query_string", "Not set")},'
          f' truncate path: {getattr(result.referer_configuration, "truncate_path", "Not set")},'
          f' referer list: {getattr(result.referer_configuration, "referer_list", "Not set")},'
          f' referer blacklist: {getattr(result.referer_configuration, "referer_blacklist", "Not set")},'
          )

# 当此脚本被直接执行时,调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点,控制程序流程从这里开始

相关文档