From 101eb981fe7cb369d942ee393328d7481f22b79e Mon Sep 17 00:00:00 2001 From: Mithun Sasidharan <mithunsasidharan89@gmail.com> Date: Mon, 30 Oct 2017 21:22:18 +0530 Subject: [PATCH] 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> --- doc/api/crypto.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 4fe8ab95ed5e17..19fdaa4dd6ad19 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1465,6 +1465,7 @@ All paddings are defined in `crypto.constants`. added: v6.6.0 --> +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