华为云对象存储OBS设置桶加密配置(Go SDK)_云淘科技

华为云云存储

11 月 24, 2023

106 0

功能介绍

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

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

接口约束

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

方法定义

func (obsClient ObsClient) SetBucketEncryption(input *SetBucketEncryptionInput, extensions…extensionOptions) (output *BaseModel, err error)

请求参数说明

表1 请求参数列表
参数名称	参数类型	是否必选	描述
input	*SetBucketEncryptionInput	必选	参数解释：设置桶加密配置请求参数，详见SetBucketEncryptionInput。
extensions	extensionOptions	可选	参数解释：桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考extensionOptions。

表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主密钥。取值范围：有效值支持两种格式： regionID:domainID(帐号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属帐号的帐号ID，获取方法参见如何获取帐号ID和用户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

package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //推荐通过环境变量获取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)*/)
    if err != 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)
    if err == nil {
        fmt.Printf("Set bucket(%s)'s encryption configuration successful!
", input.Bucket)
        fmt.Printf("RequestId:%s
", output.RequestId)
        return
    }
    fmt.Printf("Set bucket(%s)'s encryption configuration fail!
", input.Bucket)
    if obsError, 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)
    }
}