# EncryptionConfig (/zh-CN/api-reference/rtc/unreal-cpp/class-encryptionconfig)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="class_encryptionconfig__prototype"></a>

```cpp
struct EncryptionConfig {
  ENCRYPTION_MODE encryptionMode;
  const char* encryptionKey;
  uint8_t encryptionKdfSalt[32];
  bool datastreamEncryptionEnabled;

  EncryptionConfig()
    : encryptionMode(AES_128_GCM2),
      encryptionKey(OPTIONAL_NULLPTR),
      datastreamEncryptionEnabled(false)
  {
    memset(encryptionKdfSalt, 0, sizeof(encryptionKdfSalt));
  }
};
```

<a id="class_encryptionconfig__parameters"></a>

## 属性 [#属性]

<ParameterList>
<a id="encryptionmode"></a>
<Parameter name="encryptionMode">

内置加密模式。详见 [ENCRYPTION_MODE](/zh-CN/api-reference/rtc/unreal-cpp/enum-encryptionmode)。建议使用 `AES_128_GCM2` 或 `AES_256_GCM2` 加密模式。这两种模式支持使用盐，安全性更高。

</Parameter>
<a id="encryptionkey"></a>
<Parameter name="encryptionKey">

内置加密密钥，字符串类型，长度无限制。建议使用 32 字节的密钥。

:::caution
注意： 如果未指定该参数或将该参数设置为 `NULL`，则无法启用内置加密，且 SDK 会返回错误码 `-2`。
:::

</Parameter>
<a id="encryptionkdfsalt"></a>
<Parameter name="encryptionKdfSalt">

盐，长度为 32 字节。建议你在服务端使用 OpenSSL 生成盐。

:::caution
注意： 只有在 `AES_128_GCM2` 或 `AES_256_GCM2` 加密模式下，该参数才生效。此时，需确保填入该参数的值不全为 `0`。
:::

</Parameter>
<a id="datastreamencryptionenabled"></a>
<Parameter name="datastreamEncryptionEnabled">

是否开启数据流加密：

- `true`：开启数据流加密。
- `false`：（默认）关闭数据流加密。

</Parameter>
</ParameterList>
