diff options
| author | Mithun Sasidharan <mithunsasidharan89@gmail.com> | 2017-10-30 21:22:18 +0530 |
|---|---|---|
| committer | Joyee Cheung <joyeec9h3@gmail.com> | 2017-11-02 18:38:17 +0800 |
| commit | 841e305e4c0bc9f633006a293b893fd69dbbf596 (patch) | |
| tree | 7b7823913784e9b4ff4e3ebbacc4e86c2de1e1be /doc | |
| parent | 367db920e3b69ed9ded50cf6e652b9f581e10748 (diff) | |
| download | android-node-v8-841e305e4c0bc9f633006a293b893fd69dbbf596.tar.gz android-node-v8-841e305e4c0bc9f633006a293b893fd69dbbf596.tar.bz2 android-node-v8-841e305e4c0bc9f633006a293b893fd69dbbf596.zip | |
doc : mention constant-time in crypto doc
Included reference to 'constant time' in
crypto.timingSafeEqual description.
The Node website would score higher on a Google search
and the API would be more discoverable if it used the words
"constant time" in its description.
PR-URL: https://github.com/nodejs/node/pull/16604
Fixes: https://github.com/nodejs/node/issues/16504
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/crypto.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md index b962892f94..f2c288d2f7 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1969,6 +1969,7 @@ added: v6.6.0 - `a` {Buffer | TypedArray | DataView} - `b` {Buffer | TypedArray | DataView} +This function is based on a constant-time algorithm. Returns true if `a` is equal to `b`, without leaking timing information that would allow an attacker to guess one of the values. This is suitable for comparing HMAC digests or secret values like authentication cookies or |