decipher.setAAD(buffer[, options])

版本历史

版本	变更
v15.0.0	参数 buffer 可以是字符串或 ArrayBuffer，并且限制为不超过 2 ** 31 - 1 个字节。
v7.2.0	此方法现在返回对 `decipher` 的引用。
v1.0.0	新增于: v1.0.0

buffer <string> | <ArrayBuffer> | <Buffer> | <TypedArray> | <DataView>
options <Object> stream.transform 选项
- plaintextLength <number>
- encoding <string> 当 buffer 是字符串时使用的字符串编码。
返回: <Decipher> 用于方法链。

当使用认证的加密模式时（目前支持 GCM、CCM、OCB 和 chacha20-poly1305），则 decipher.setAAD() 方法设置用于额外的认证数据（AAD）输入参数的值。

options 参数对于 GCM 是可选的。使用 CCM 时，必须指定 plaintextLength 选项，其值必须与密文的字节长度匹配。请参见 CCM 模式。

decipher.setAAD() 方法必须在 decipher.update() 之前调用。

将字符串作为 buffer 传入时，请注意将字符串用作加密 API 的输入时的注意事项。

History

Version	Changes
v15.0.0	The buffer argument can be a string or ArrayBuffer and is limited to no more than 2 ** 31 - 1 bytes.
v7.2.0	This method now returns a reference to `decipher`.
v1.0.0	Added in: v1.0.0

buffer <string> | <ArrayBuffer> | <Buffer> | <TypedArray> | <DataView>
options <Object> stream.transform options
- plaintextLength <number>
- encoding <string> String encoding to use when buffer is a string.
Returns: <Decipher> for method chaining.

When using an authenticated encryption mode (GCM, CCM, OCB, and chacha20-poly1305 are currently supported), the decipher.setAAD() method sets the value used for the additional authenticated data (AAD) input parameter.

The options argument is optional for GCM. When using CCM, the plaintextLength option must be specified and its value must match the length of the ciphertext in bytes. See CCM mode.

The decipher.setAAD() method must be called before decipher.update().

When passing a string as the buffer, please consider caveats when using strings as inputs to cryptographic APIs.