Interface CipherParams

Sets the properties to configure encryption for a ChannelBase or RealtimeChannelBase object.

Hierarchy

  • CipherParams

Properties

algorithm key keyLength mode

Properties

algorithm

algorithm: string

The algorithm to use for encryption. Only AES is supported and is the default value.

Default Value

"AES"

key

key: unknown

The private key used to encrypt and decrypt payloads. You should not set this value directly; rather, you should pass a key of type CipherKeyParam to getDefaultParams.

keyLength

keyLength: number

The length of the key in bits; either 128 or 256.

mode

mode: string

The cipher mode. Only CBC is supported and is the default value.

Default Value

"CBC"

Settings

Member Visibility

Theme

Generated using TypeDoc