更新时间:2024-11-19 GMT+08:00
分享

设置桶的加密配置(Harmony SDK)

功能介绍

设置桶的加密配置,以允许在该桶中上传对象时,采用对应加密配置对数据进行加密,数据会在服务端被加密成密文后存储,用户下载加密对象时,存储的密文会先在服务端解密为明文,再提供给用户。

调用设置桶加密配置接口,您可以为指定桶创建或更新加密配置信息

接口约束

  • 您必须是桶拥有者或拥有设置桶加密配置的权限,才能设置桶加密配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:PutEncryptionConfiguration权限,如果使用桶策略则需授予PutEncryptionConfiguration权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略自定义创建桶策略
  • OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点

方法定义

setBucketEncryption(input: SetBucketEncryptionInput): Response<BaseResponseOutput>

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

SetBucketEncryptionInput

必选

参数解释:

设置桶加密配置接口入参,详见SetBucketEncryptionInput

表2 SetBucketEncryptionInput

参数名称

参数类型

是否可选

描述

Bucket

string

必选

桶名。

约束限制:

  • 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。
  • 桶命名规则如下:
    • 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻(如:“my..bucket”)。
    • 禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。
  • 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

取值范围:

长度为3~63个字符。

Rule

BucketEncryptionRule

必选

参数解释:

桶加密配置信息,详见BucketEncryptionRule

表3 BucketEncryptionRule

参数名称

参数类型

是否可选

描述

ApplyServerSideEncryptionByDefault

ApplyServerSideEncryptionByDefault

必选

参数解释:

默认加密配置信息,详见ApplyServerSideEncryptionByDefault

表4 ApplyServerSideEncryptionByDefault

参数名称

参数类型

是否可选

描述

SSEAlgorithm

string

必选

参数解释:

表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。

取值范围:

可选值:kms,即选择SSE-KMS方式加密对象。

默认取值:

KMSMasterKeyID

string

可选

参数解释:

SSE-KMS加密方式下使用的KMS主密钥

取值范围:

有效值支持两种格式:

  1. regionID:domainID(账号ID):key/key_id
  2. key_id

其中:

默认取值:

如果用户没有提供该头域,那么默认的主密钥将会被使用

ProjectID

string

可选

参数解释:

SSE-KMS加密方式下KMS主密钥所属的项目ID。

约束限制:

  • 项目ID需要与KMSMasterKeyID相匹配
  • 在未设置KMSMasterKeyID的情况下,不可设置项目ID。

取值范围:

项目ID获取方式请参见如何获取项目ID

默认取值:

返回结果

表5 返回结果

参数类型

描述

Response

说明:

该接口返回是一个Promise类型,需要使用Promise、async/await语法处理。

参数解释:

接口返回信息,详见Response

表6 Response

参数名称

参数类型

描述

CommonMsg

ICommonMsg

参数解释:

接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg

InterfaceResult

BaseResponseOutput

参数解释:

操作成功后的结果数据,详见BaseResponseOutput

约束限制:

当Status大于300时为空。

表7 ICommonMsg

参数名称

参数类型

描述

Status

number

参数解释:

OBS服务端返回的HTTP状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码

Code

string

参数解释:

OBS服务端返回的错误码。

Message

string

参数解释:

OBS服务端返回的错误描述。

HostId

string

参数解释:

OBS服务端返回的请求服务端ID。

RequestId

string

参数解释:

OBS服务端返回的请求ID。

Id2

string

参数解释:

OBS服务端返回的请求ID2。

Indicator

string

参数解释:

OBS服务端返回的详细错误码。

表8 BaseResponseOutput

参数名称

参数类型

描述

RequestId

string

参数解释:

OBS服务端返回的请求ID。

代码示例

本示例用于设置名为examplebucket桶的加密配置,并指定加密方式是kms,使用指定密钥为ce706220-a1f1-4e78-9ebb-xxxxxxxxxx32。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
// 引入依赖包
import ObsClient, { SetBucketEncryptionInput } from '@obs/esdk-obs-harmony';

// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
  AccessKeyId: process.env.ACCESS_KEY_ID,
  SecretAccessKey: process.env.SECRET_ACCESS_KEY,
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入
  // SecurityToken: process.env.SECURITY_TOKEN,
  // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写
  Server: "https://obs.cn-north-4.myhuaweicloud.com",
});

async function setBucketEncryption() {
  try {
    const params: SetBucketEncryptionInput = {
      // 指定存储桶名称
      Bucket: "examplebucket",
      // 指定服务端加密算法,这里以kms为例
      Rule: {
        ApplyServerSideEncryptionByDefault: {
          SSEAlgorithm: "kms",
          // 指定SSE-KMS加密方式下使用的KMS主密钥,如果未指定,则默认的主密钥将会被使用
          KMSMasterKeyID: "ce706220-a1f1-4e78-9ebb-xxxxxxxxxx32"
        }
      }
    };
    // 设置桶加密配置
    const result = await obsClient.setBucketEncyption(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Set bucket(%s)'s encyption configure successful!", params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      return;
    }
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", result.CommonMsg.Status);
    console.log("Code: %s", result.CommonMsg.Code);
    console.log("Message: %s", result.CommonMsg.Message);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
    console.log(error);
  }
}

setBucketEncryption();

相关链接

相关文档