rainbownapkin/canopy
1
0
Fork 0
Code Issues 2 Pull requests Actions Packages Projects Releases Wiki Activity

Improved JSDoc for IP Hash Comparison function.

Browse source
This commit is contained in:
rainbow napkin 2025-11-03 19:11:31 -05:00
parent ade2a4210d
commit 35fd81e1b2
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/utils/hashUtils.js
View file

@ -85,6 +85,14 @@ module.exports.hashIP= function(ip, salt){
return `${salt}$${hash}`; return `${salt}$${hash}`;
} }
/**
* Site-wide IP hash comparison function
*
* Allows us to identify new plaintext IP's against saved IP hashes
* @param {String} ip - IP to hash
* @param {String} salt - (optional) string to salt IP with, leave empty to default to a securely generated string encoded in base64
* @returns {Boolean} Whether or not the IP matched the hash
*/
module.exports.compareIPHash = function(ip, hash){ module.exports.compareIPHash = function(ip, hash){
//Split hash by salt delimiter //Split hash by salt delimiter
const splitHash = hash.split("$"); const splitHash = hash.split("$");