crypto: remove default encoding from Hash/Hmac

tniessen · UlisesGascon · commit c79508323294 · 2023-09-10T18:07:30.000Z
getDefaultEncoding() always returns 'buffer' in Node.js 20. It requires some careful justification but the default encoding can be eliminated from hash.js entirely. The reasoning is almost identical with that in #49145 so I won't repeat it here. Refs: #47182 PR-URL: #49167 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Filip Skokan <panva.ip@gmail.com>
diff --git a/lib/internal/crypto/hash.js b/lib/internal/crypto/hash.js
@@ -14,7 +14,6 @@ const {
 } = internalBinding('crypto');
 
 const {
- getDefaultEncoding,
 getStringOption,
 jobPromise,
 normalizeHashName,
@@ -95,8 +94,6 @@ Hash.prototype._flush = function _flush(callback) {
 };
 
 Hash.prototype.update = function update(data, encoding) {
- encoding = encoding || getDefaultEncoding();
-
 const state = this[kState];
 if (state[kFinalized])
 throw new ERR_CRYPTO_HASH_FINALIZED();
@@ -118,10 +115,9 @@ Hash.prototype.digest = function digest(outputEncoding) {
 const state = this[kState];
 if (state[kFinalized])
 throw new ERR_CRYPTO_HASH_FINALIZED();
- outputEncoding = outputEncoding || getDefaultEncoding();
 
- // Explicit conversion for backward compatibility.
- const ret = this[kHandle].digest(`${outputEncoding}`);
+ // Explicit conversion of truthy values for backward compatibility.
+ const ret = this[kHandle].digest(outputEncoding && `${outputEncoding}`);
 state[kFinalized] = true;
 return ret;
 };
@@ -147,15 +143,16 @@ Hmac.prototype.update = Hash.prototype.update;
 
 Hmac.prototype.digest = function digest(outputEncoding) {
 const state = this[kState];
- outputEncoding = outputEncoding || getDefaultEncoding();
 
 if (state[kFinalized]) {
 const buf = Buffer.from('');
- return outputEncoding === 'buffer' ? buf : buf.toString(outputEncoding);
+ if (outputEncoding && outputEncoding !== 'buffer')
+ return buf.toString(outputEncoding);
+ return buf;
 }
 
- // Explicit conversion for backward compatibility.
- const ret = this[kHandle].digest(`${outputEncoding}`);
+ // Explicit conversion of truthy values for backward compatibility.
+ const ret = this[kHandle].digest(outputEncoding && `${outputEncoding}`);
 state[kFinalized] = true;
 return ret;
 };

-Original file line number
+Diff line change
 }=internalBinding('crypto');
 const{
 - getDefaultEncoding,
  getStringOption,
  jobPromise,
  normalizeHashName,
 };
 Hash.prototype.update=functionupdate(data,encoding){
 -encoding=encoding||getDefaultEncoding();
+-
 conststate=this[kState];
 if(state[kFinalized])
 thrownewERR_CRYPTO_HASH_FINALIZED();
 conststate=this[kState];
 if(state[kFinalized])
 thrownewERR_CRYPTO_HASH_FINALIZED();
 -outputEncoding=outputEncoding||getDefaultEncoding();
 -// Explicit conversion for backward compatibility.
 -constret=this[kHandle].digest(`${outputEncoding}`);
 +// Explicit conversion of truthy values for backward compatibility.
 +constret=this[kHandle].digest(outputEncoding&&`${outputEncoding}`);
 state[kFinalized]=true;
 returnret;
 };
 Hmac.prototype.digest=functiondigest(outputEncoding){
 conststate=this[kState];
 -outputEncoding=outputEncoding||getDefaultEncoding();
 if(state[kFinalized]){
 constbuf=Buffer.from('');
 -returnoutputEncoding==='buffer' ? buf : buf.toString(outputEncoding);
 +if(outputEncoding&&outputEncoding!=='buffer')
 +returnbuf.toString(outputEncoding);
 +returnbuf;
+}
 -// Explicit conversion for backward compatibility.
 -constret=this[kHandle].digest(`${outputEncoding}`);
 +// Explicit conversion of truthy values for backward compatibility.
 +constret=this[kHandle].digest(outputEncoding&&`${outputEncoding}`);
 state[kFinalized]=true;
 returnret;
 };