# AgoraEncryptionConfig (/zh-CN/api-reference/rtc/macos/class-encryptionconfig)

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

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

```objc
__attribute__((visibility("default"))) @interface AgoraEncryptionConfig: NSObject
@property (assign, nonatomic) AgoraEncryptionMode encryptionMode;
@property (copy, nonatomic) NSString * _Nullable encryptionKey;
@property (strong, nonatomic) NSData * _Nullable encryptionKdfSalt;
@property (assign, nonatomic) BOOL  datastreamEncryptionEnabled;
@end
```

<a id="class_encryptionconfig__detailed_desc"></a>

用于配置内置加密的参数。

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

## 属性 [#属性]

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

内置加密模式，详见 [AgoraEncryptionMode](/zh-CN/api-reference/rtc/macos/enum-encryptionmode)。声网推荐使用 `AgoraEncryptionModeAES128GCM2` 或 `AgoraEncryptionModeAES256GCM2` 加密模式。

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

字符串类型的加密密钥，长度不受限制。声网推荐使用 32 字节的密钥。

:::note
注： 如果未设置加密密钥或将其设置为 nil，则无法使用内置加密，SDK 会返回 `-2`。
:::

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

用于加密的盐值，长度为 32 字节。声网推荐在服务器端使用 OpenSSL 生成该盐值。

:::note
注： 该参数仅在 `AgoraEncryptionModeAES128GCM2` 或 `AgoraEncryptionModeAES256GCM2` 加密模式下生效。在此情况下，请确保该参数不为 `0`。
:::

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

是否启用数据流加密：

- YES：启用数据流加密。
- NO：（默认）不启用数据流加密。

</Parameter>
</ParameterList>