Commit a9e4fdb
doc: correct description of decipher.setAuthTag in crypto.md
Calling `decipher.setAuthTag` after `decipher.update` will result in
an error like `Unsupported state or unable to authenticate data`.
The example code in
[CCM mode](https://nodejs.org/docs/latest-v14.x/api/crypto.html#crypto_ccm_mode)
is correct, but to demonstrate the mistake in the documentation you
can take the same example and move the `setAuthTag` call to in between
`update` and `final` you will see the error.1 parent 6f54c2b commit a9e4fdb
1 file changed
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -520,8 +520,9 @@ cipher text should be discarded due to failed authentication. If the tag length | |||
| 520 | 520 | is invalid according to [NIST SP 800-38D][] or does not match the value of the | |
| 521 | 521 | `authTagLength` option, `decipher.setAuthTag()` will throw an error. | |
| 522 | 522 | ||
| 523 | - The `decipher.setAuthTag()` method must be called before | ||
| 524 | - [`decipher.final()`][] and can only be called once. | ||
| 523 | + The `decipher.setAuthTag()` method must be called before [`decipher.update()`][] | ||
| 524 | + for `CCM` mode or before [`decipher.final()`][] for `GCM` and `OCB` modes. | ||
| 525 | + `decipher.setAuthTag()` can only be called once. | ||
| 525 | 526 | ||
| 526 | 527 | ### `decipher.setAutoPadding([autoPadding])` | |
| 527 | 528 | <!-- YAML | |
0 commit comments