Skip to content

Commit

Permalink
doc: clarify getAuthTag with authTagLength
Browse files Browse the repository at this point in the history
Refs: #40272
Refs: #20235

PR-URL: #40713
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
tniessen authored and danielleadams committed Jan 30, 2022
1 parent d8b4d66 commit 23d188f
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/api/crypto.md
Expand Up @@ -551,6 +551,9 @@ added: v1.0.0
The `cipher.getAuthTag()` method should only be called after encryption has
been completed using the [`cipher.final()`][] method.

If the `authTagLength` option was set during the `cipher` instance's creation,
this function will return exactly `authTagLength` bytes.

### `cipher.setAAD(buffer[, options])`

<!-- YAML
Expand Down

0 comments on commit 23d188f

Please sign in to comment.