Skip to content

Update crypto.md to correct description of decipher.setAuthTag #33097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jbuhacoff wants to merge 4 commits into from
Closed

Update crypto.md to correct description of decipher.setAuthTag #33097

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
68935d7
Update crypto.md to correct description of `decipher.setAuthTag`
jbuhacoff Apr 27, 2020
a61d0b2
Update crypto.md
jbuhacoff Apr 28, 2020
879b6cc
Update crypto.md
jbuhacoff Apr 28, 2020
35ab249
Update crypto.md
jbuhacoff Apr 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/api/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,8 @@ is invalid according to [NIST SP 800-38D][] or does not match the value of the

The `decipher.setAuthTag()` method must be called before
Copy link
Contributor

@mscdex mscdex Apr 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would just modify this sentence instead to clarify, something like:

The `decipher.setAuthTag()` method must be called before
[`decipher.update()`][] for `CCM` mode or before [`decipher.final()`][] for
`GCM` and `OCB` modes. `decipher.setAuthTag()` can only be called once.

Copy link
Contributor Author

@jbuhacoff jbuhacoff Apr 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks! I just pushed a correction with this advice.

[`decipher.final()`][] and can only be called once.
When using `CCM` mode, the `decipher.setAuthTag()` method must be called before
[`decipher.update()`][].

### `decipher.setAutoPadding([autoPadding])`
<!-- YAML
Expand Down