# 设置桶加密配置(Go SDK) #### 功能介绍 设置桶的加密配置，以允许在该桶中上传对象时，采用对应加密配置对数据进行加密，数据会在服务端被加密成密文后存储，用户下载加密对象时，存储的密文会先在服务端解密为明文，再提供给用户。 调用设置桶加密配置接口，您可以为指定桶创建或更新加密配置信息。 #### 接口约束 - 您必须是桶拥有者或拥有设置桶加密配置的权限，才能设置桶加密配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutEncryptionConfiguration权限，如果使用桶策略则需授予PutEncryptionConfiguration权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 - OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。 #### 方法定义 **func** (obsClient ObsClient) SetBucketEncryption(input \*[SetBucketEncryptionInput], extensions...extensionOptions) (output \*[BaseModel], err error) #### 请求参数说明 表1请求参数列表 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | input | \*[SetBucketEncryptionInput] | 必选 | **参数解释：** 设置桶加密配置请求参数，详见[SetBucketEncryptionInput]。 | | extensions | [extensionOptions](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0105.html) | 可选 | **参数解释：** 桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考[extensionOptions](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0105.html)。 | 表2SetBucketEncryptionInput | **参数名称** | **参数类型** | **是否可选** | **描述** | |:---|:---|:---|:---| | Bucket | string | 必选 | **参数解释** **：** 桶名。 **约束限制：** - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 **默认取值**： 无 | | 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，可在[地区和终端节点](https://developer.huaweicloud.com/endpoint?OBS)页面获取； - domainID是使用密钥所属账号的账号ID，获取方法参见[如何获取账号ID和用户ID？](https://support.huaweicloud.com/sdk-go-devg-obs/obs_23_1712.html)； - key_id是从数据加密服务创建的密钥ID，获取方法请参见[查看密钥](https://support.huaweicloud.com/usermanual-dew/dew_01_0179.html)。 **默认取值：** 如果用户没有提供该头域，那么默认的主密钥将会被使用。 | | KMSDataEncryption | string | 可选 | **参数解释**： 指定服务端加密配置的加密算法。示例：AES256。 **约束限制**： 无 **取值范围**： - AES256：使用AES256加密算法，SSE-KMS和SSE-OBS都可以配置AES256。 - SM4：使用SM4加密算法，仅SSE-KMS可以配置SM4。 **默认取值**： 无 | | ProjectID | string | 可选 | **参数解释：** SSE-KMS加密方式下KMS主密钥所属的项目ID。 **约束限制：** - 项目ID需要与KMSMasterKeyID相匹配。 - 在未设置KMSMasterKeyID的情况下，不可设置项目ID。 **取值范围：** 项目ID获取方式请参见[如何获取项目ID](https://support.huaweicloud.com/api-iam/iam_17_0002.html)。 **默认取值：** 无 | #### 返回结果说明 表3返回结果列表 | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | output | \*[BaseModel] | **参数解释：** 接口返回信息，详见[BaseModel]。 | | err | error | **参数解释：** 接口返回错误信息。 | 表4BaseModel | **参数名称** | **参数类型** | **描述** | |:---|:---|:---| | StatusCode | int | **参数解释：** HTTP状态码。 **约束限制：** 无 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 | | RequestId | string | **参数解释：** OBS服务端返回的请求ID。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | ResponseHeaders | map\[string\]\[\]string | **参数解释：** HTTP响应头信息。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | #### 代码示例 本示例用于设置名为examplebucket桶的加密配置，并指定加密方式是kms，使用指定密钥为ce706220-a1f1-4e78-9ebb-xxxxxxxxxx32。 ``` package main import ( "fmt" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" "os" ) func main() { // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK。 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" // 指定服务端加密算法，这里以aws:kms为例。 input.SSEAlgorithm = "aws:kms" // 指定SSE-KMS加密方式下使用的KMS主密钥，如果未指定，则默认的主密钥将会被使用。 input.KMSMasterKeyID = "ce706220-a1f1-4e78-9ebb-xxxxxxxxxx32" // 指定服务端加密配置的加密算法 input.KMSDataEncryption = "SM4" // 指定SSE-KMS桶密钥功能开关 input.BucketKeyEnabled = true input.BucketKeyRotationPeriod = 525600 // 设置桶加密配置 output, err := obsClient.SetBucketEncryption(input) if err == 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) 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) } } ``` #### 相关链接 - 关于设置桶加密配置的API说明，请参见[设置桶的加密配置](https://support.huaweicloud.com/api-obs/obs_04_0062.html)。 - 更多关于设置桶加密配置的示例代码，请参见[Github示例](https://github.com/huaweicloud/huaweicloud-sdk-go-obs/blob/master/examples/bucket_operations_sample.go)。 - 设置桶加密配置过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。 - 安全相关常见问题请参见[安全相关常见问题](https://support.huaweicloud.com/obs_faq/obs_faq_0200.html)。