# 获取桶的加密配置(C SDK)
![](https://support.huaweicloud.com/sdk-c-devg-obs/public_sys-resources/notice_3.0-zh-cn.png)
开发过程中，您有任何问题可以在GitHub上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-c-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。
#### 功能说明
桶的加密配置功能，支持在该桶中上传对象时，采用对应加密配置对数据进行加密，数据会在服务端被加密成密文后存储，用户下载加密对象时，存储的密文会先在服务端解密为明文，再提供给用户。
调用获取桶加密配置接口，您可以获取指定桶的加密配置信息。
#### 接口约束
- 您必须是桶拥有者或拥有获取桶加密配置的权限，才能获取桶加密配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetEncryptionConfiguration权限，如果使用桶策略则需授予GetEncryptionConfiguration权限。相关授权方式介绍可参见[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://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。
 
#### 方法定义
```
void get_bucket_encryption(const obs_options *options,
        obs_get_bucket_encryption_handler *handler, void *callback_data);
```
#### 请求参数说明
表1请求参数列表 
| **参数名称**      | **参数类型**                                                                                                            | **是否必选** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| options       | const [obs_options](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0085.html#obs_20_0085__table9681927859)\* | 必选       | **参数解释：** 请求桶的上下文，通过obs_options设置AK、SK、endpoint、bucket、超时时间、临时鉴权。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                      |
| handler       | [表2] \*                                                                           | 必选       | **参数解释：** 回调结构体，结构体内所有成员都是回调函数的指针，用于设置处理接口响应数据的回调函数。您可以通过设置回调函数，把服务端的响应数据复制到您的自定义回调数据callback_data中。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 |
| callback_data | void \*                                                                                                             | 可选       | **参数解释：** 用户自定义回调数据。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                                       |
   
 表2obs_get_bucket_encryption_handler 
| 参数名称                           | 参数类型                                                                                                               | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| response_handler               | [obs_response_handler](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_0087.html#obs_20_0087__table53755070) | 必选   | **参数解释：** 响应回调函数结构体。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                                                |
| get_bucket_encryption_callback | [表3 obs_get_bucket_encryption_callback]\*                                       | 必选   | **参数解释：** 桶加密配置回调函数指针，可以在这个回调中把encryption_config的内容记录到callback_data中。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 |
   
 表3obs_get_bucket_encryption_callback 
| 参数名称              | 参数类型                                                                      | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| encryption_config | [表4 obs_server_side_encryption_rule]\* | 必选   | **参数解释：** 桶加密配置结构体，包含加密规则等信息。 **约束限制：** 该结构体及其中指针指向的内存在回调返回后会被SDK释放，如需保留请自行复制。 **取值范围：** 无 **默认取值：** 无 |
| callback_data     | void \*                                                                   | 必选   | **参数解释：** 用户自定义回调数据指针。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无                                        |
   
 表4obs_server_side_encryption_rule 
| 参数名称                | 参数类型    | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| sse_algorithm       | char \* | 必选   | **参数解释：** 服务端加密算法。 **约束限制：** 无 **取值范围：** - AES256（SSE-OBS加密）  - kms（SSE-KMS加密）   **默认取值：** 无 |
| kms_data_encryption | char \* | 可选   | **参数解释：** SSE-KMS加密方式下使用的数据加密算法。 **约束限制：** 仅当sse_algorithm为kms时有效。 **取值范围：** SM4。 **默认取值：** 当sse_algorithm为kms时，默认使用SM4加密。                                                                                                                                       |
| kms_master_key_id   | char \* | 可选   | **参数解释：** SSE-KMS加密方式下使用的KMS主密钥ID。 **约束限制：** 仅当sse_algorithm为kms时有效。如果不指定，则使用默认主密钥。 **取值范围：** 无 **默认取值：** 无                                                                                                                                                          |
| project_id          | char \* | 可选   | **参数解释：** SSE-KMS加密方式下KMS主密钥所属的项目ID。 **约束限制：** 仅当sse_algorithm为kms时有效。如果不指定，则使用默认项目ID。 **取值范围：** 无 **默认取值：** 无                                                                                                                                                  |
   
#### 代码示例
以下示例展示如何获取桶加密配置：
```
#include "eSDKOBS.h"
#include <stdio.h>
#include <string.h>
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data);
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data);
obs_status get_encryption_callback(obs_server_side_encryption_configuration *encryption_config, void *callback_data);
typedef struct EncryptionInfo
{
    char sse_algorithm[64];
    char kms_master_key_id[256];
    obs_status ret_status;
} EncryptionInfo;
int main()
{
    obs_initialize(OBS_INIT_ALL);
    obs_options options;
    init_obs_options(&options);
    // host_name填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。
    options.bucket_options.host_name = "obs.cn-north-4.myhuaweicloud.com";
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；
    // 本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY。
    options.bucket_options.access_key = getenv("ACCESS_KEY_ID");
    options.bucket_options.secret_access_key = getenv("SECRET_ACCESS_KEY");
    options.bucket_options.bucket_name = "example-bucket-name";
    obs_response_handler response_handler = {&response_properties_callback, &response_complete_callback};
    obs_get_bucket_encryption_handler get_encryption_handler = {
        response_handler,
        &get_encryption_callback
    };
    EncryptionInfo encryption_info = {0};
    encryption_info.ret_status = OBS_STATUS_BUTT;
    get_bucket_encryption(&options, &get_encryption_handler, &encryption_info);
    if (OBS_STATUS_OK == encryption_info.ret_status) {
        printf("get bucket encryption successfully. sse_algorithm: %s\n", encryption_info.sse_algorithm);
        if (encryption_info.kms_master_key_id[0]) {
            printf("kms_master_key_id: %s\n", encryption_info.kms_master_key_id);
        }
    } else {
        printf("get bucket encryption failed(%s).\n", obs_get_status_name(encryption_info.ret_status));
    }
    obs_deinitialize();
}
obs_status get_encryption_callback(obs_server_side_encryption_configuration *encryption_config, void *callback_data)
{
    EncryptionInfo *info = (EncryptionInfo *)callback_data;
    if (encryption_config && encryption_config->rule) {
        if (encryption_config->rule->sse_algorithm) {
            strncpy(info->sse_algorithm, encryption_config->rule->sse_algorithm, sizeof(info->sse_algorithm) - 1);
            info->sse_algorithm[sizeof(info->sse_algorithm) - 1] = '\0';
        }
        if (encryption_config->rule->kms_master_key_id) {
            strncpy(info->kms_master_key_id, encryption_config->rule->kms_master_key_id, sizeof(info->kms_master_key_id) - 1);
            info->kms_master_key_id[sizeof(info->kms_master_key_id) - 1] = '\0';
        }
    }
    return OBS_STATUS_OK;
}
obs_status response_properties_callback(const obs_response_properties *properties, void *callback_data)
{
    (void)properties; (void)callback_data;
    return OBS_STATUS_OK;
}
void response_complete_callback(obs_status status, const obs_error_details *error, void *callback_data)
{
    if (callback_data) { ((EncryptionInfo*)callback_data)->ret_status = status; }
    if (error && error->message) { printf("Error: %s\n", error->message); }
}
```
#### 相关链接
- 关于获取桶加密配置的API说明，请参见[获取桶的加密配置](https://support.huaweicloud.com/api-obs/obs_04_0063.html)。
- 获取桶加密配置过程中返回的错误码含义、问题原因及处理措施可参考[OBS错误码](https://support.huaweicloud.com/api-obs/obs_04_0115.html#section1)。
- 安全相关常见问题请参见[安全相关常见问题](https://support.huaweicloud.com/obs_faq/obs_faq_0200.html)。