九游平台/ 对象存储服务 obs/ sdk参考/ go/ / 设置桶加密配置(go sdk)
更新时间:2024-09-18 gmt 08:00

设置桶加密配置(go sdk)-九游平台

功能介绍

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

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

接口约束

  • 您必须是桶拥有者或拥有设置桶加密配置的权限,才能设置桶加密配置。建议使用iam或桶策略进行授权,如果使用iam则需授予obs:bucket:putencryptionconfiguration权限,如果使用桶策略则需授予putencryptionconfiguration权限。相关授权方式介绍可参见obs权限控制概述,配置方式详见、。
  • obs支持的region与endpoint的对应关系,详细信息请参见。

方法定义

func (obsclient obsclient) setbucketencryption(input *setbucketencryptioninput, extensions...extensionoptions) (output *basemodel, err error)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

*setbucketencryptioninput

必选

参数解释:

设置桶加密配置请求参数,详见setbucketencryptioninput

extensions

可选

参数解释:

桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头,详情参考。

表2 setbucketencryptioninput

参数名称

参数类型

是否可选

描述

bucket

string

必选

参数解释

桶名。

约束限制:

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

默认取值

ssealgorithm

string

必选

参数解释:

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

取值范围:

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

默认取值:

kmsmasterkeyid

string

可选

参数解释:

sse-kms加密方式下使用的kms主密钥。

取值范围:

有效值支持两种格式:

  1. regionid:domainid(账号id):key/key_id
  2. key_id

其中:

  • regionid是使用密钥所属region的id,可在页面获取;
  • domainid是使用密钥所属账号的账号id,获取方法参见;
  • key_id是从数据加密服务创建的密钥id,获取方法请参见查看密钥

默认取值:

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

projectid

string

可选

参数解释:

sse-kms加密方式下kms主密钥所属的项目id。

约束限制:

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

取值范围:

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

默认取值:

返回结果说明

表3 返回结果列表

参数名称

参数类型

描述

output

*basemodel

参数解释:

接口返回信息,详见basemodel

err

error

参数解释:

接口返回错误信息。

表4 basemodel

参数名称

参数类型

描述

statuscode

int

参数解释:

http状态码。

取值范围:

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

默认取值:

requestid

string

参数解释:

obs服务端返回的请求id。

默认取值:

responseheaders

map[string][]string

参数解释:

http响应头信息。

默认取值:

代码示例

本示例用于设置名为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
packagemain
import(
"fmt"
"os"
obs"github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
funcmain(){
//推荐通过环境变量获取aksk,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
//您可以登录访问管理控制台获取访问密钥ak/sk,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。
ak:=os.getenv("accesskeyid")
sk:=os.getenv("secretaccesskey")
// 【可选】如果使用临时ak/sk和securitytoken访问obs,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥ak/sk,也可以使用其他外部引入方式传入。
// securitytoken := os.getenv("securitytoken")
// endpoint填写bucket对应的endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写。
endpoint:="https://obs.cn-north-4.myhuaweicloud.com"
// 创建obsclient实例
// 如果使用临时aksk和securitytoken访问obs,需要在创建实例时通过obs.withsecuritytoken方法指定securitytoken值。
obsclient,err:=obs.new(ak,sk,endpoint/*, obs.withsecuritytoken(securitytoken)*/)
iferr!=nil{
fmt.printf("create obsclient error, errmsg: %s",err.error())
}
input:=&obs.setbucketencryptioninput{}
// 指定存储桶名称
input.bucket="examplebucket"
// 指定服务端加密算法,这里以kms为例。
input.ssealgorithm="kms"
// 指定sse-kms加密方式下使用的kms主密钥,如果未指定,则默认的主密钥将会被使用。
input.kmsmasterkeyid="ce706220-a1f1-4e78-9ebb-xxxxxxxxxx32"
// 设置桶加密配置
output,err:=obsclient.setbucketencryption(input)
iferr==nil{
fmt.printf("set bucket(%s)'s encryption configuration successful!\n",input.bucket)
fmt.printf("requestid:%s\n",output.requestid)
return
}
fmt.printf("set bucket(%s)'s encryption configuration fail!\n",input.bucket)
ifobserror,ok:=err.(obs.obserror);ok{
fmt.println("an obserror was found, which means your request sent to obs was rejected with an error response.")
fmt.println(obserror.error())
}else{
fmt.println("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.")
fmt.println(err)
}
}

相关链接

  • 关于设置桶加密配置的api说明,请参见设置桶的加密配置
  • 更多关于设置桶加密配置的示例代码,请参见。
  • 设置桶加密配置过程中返回的错误码含义、问题原因及处理措施可参考obs错误码
  • 安全相关常见问题请参见。

相关文档

网站地图