ac-sanitizer 4.1.4 → 4.2.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+ 
+# [4.2.0](https://github.com/mmpro/ac-sanitizer/compare/v4.1.4..v4.2.0) (2025-05-09 07:40:18)
+
+
+### Feature
+
+* **App:** Option to anonymize IPs | MP | [6f7a63787467221db3e61a0c7ba27089518ee30f](https://github.com/mmpro/ac-sanitizer/commit/6f7a63787467221db3e61a0c7ba27089518ee30f)    
+Added option to anonymize IPs (v4 and v6), set number of octets/segments and optional replacement character  
+Related issues:
+### Chores
+
+* **App:** Updated packages | MP | [aba6b031d7b07cda75720e86a65c6fbe7606c5e9](https://github.com/mmpro/ac-sanitizer/commit/aba6b031d7b07cda75720e86a65c6fbe7606c5e9)    
+Updated packages  
+Related issues:
 
 ## [4.1.4](https://github.com/mmpro/ac-sanitizer/compare/v4.1.3..v4.1.4) (2025-04-19 18:34:41)
 

package/README.md

@@ -103,7 +103,7 @@ integer | | 0 - 2^31
 integer \| string |  | Value can be an integer OR a string
 iso-639-1 | convert | With convert = nativeName you can retrieve the native name of the given ISO string
 iso-639-2 | convert | With convert = nativeName you can retrieve the native name of the given ISO string
-ip | version | version can be "4" or "6", defaults to "4"
+ip | version, anonymize, replacement | version can be "4" or "6", defaults to "4", anonymize can be the number of octets/segments to anonymize, replacement (optional) defines the replacement character for IPv4 (defaults to 0)
 long | | 0 - 2^63
 object | properties | Use properties to define object structure, properties is equal to fields array
 number | | Should no be used - use integer, long, short, floag
@@ -147,6 +147,24 @@ let test = sanitizer.checkAndSanitizeValues(fieldsToCheck)
 
 ```
 
+## IP
+```
+// CIDR Example
+
+const sanitizer = require('ac-sanitizer')
+
+let fieldsToCheck = {
+  params: {
+    ip: '8.8.8.8/32
+  },
+  fields: [
+    { field: 'ip, type: 'ip', anonymize: 4 }
+  ]
+}
+let test = sanitizer.checkAndSanitizeValues(fieldsToCheck)
+// ip -> 8.8.0.0
+```
+
 ## Objects
 By default properties which are not defined will be ignored and removed from payload.
 

package/index.js

@@ -390,9 +390,38 @@ const sanitizer = function() {
         }
       }
       else if (field.type === 'ip') {
-        const version = _.get(field, 'version')
+        let version = _.get(field, 'version')
         if (version && !validator.isIP(value, version)) error = { message: fieldName + '_' + getTypeMapping(field.type, 'errorMessage'), additionalInfo: { version } }
         if (!validator.isIP(value)) error = { message: fieldName + '_' + getTypeMapping(field.type, 'errorMessage') }
+        if (field.anonymize) {
+          version = version || validator.isIP(value, '6') ? 6 : 4
+          const replacement = field.replacement || '0'
+          if (version === 4 && (field.anonymize >= 1 && field.anonymize <= 4)) {
+            const octets = value.split('.')
+            for (let i = 4; i > 4 - field.anonymize; i--) {
+              octets[i-1] = replacement
+            }
+            value = octets.join('.')
+          }
+          else if (version === 6) {
+            const segmentsToKeep = Math.max(0, 8 - (field.anonymize * 2))
+            if (segmentsToKeep === 0) {
+              value = "::"
+            }
+            if (value.includes("::")) {
+              const parts = value.split("::")
+              const frontPart = parts[0].split(":")
+              const keptSegments = frontPart.slice(0, segmentsToKeep)
+              value = keptSegments.length > 0 ? keptSegments.join(":") + "::" : "::"
+            }
+            else {
+              const segments = value.split(":")
+              const keptSegments = segments.slice(0, segmentsToKeep)              
+              value = keptSegments.join(":") + "::"
+            }
+          }
+          _.set(paramsToCheck, fieldName, value)
+        }
       }
       else if (field.type === 'cidr') {
         // cidr can be a plain value of an array of objects with properties cidr and optional type

package/package.json

@@ -4,10 +4,10 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-sanitizer",
-  "version": "4.1.4",
+  "version": "4.2.0",
   "homepage": "https://www.admiralcloud.com",
   "dependencies": {
-    "ac-countrylist": "^1.0.12",
+    "ac-countrylist": "^1.0.13",
     "ac-file-extensions": "^2.0.10",
     "ac-ip": "^4.1.3",
     "chai": "^4.5.0",
@@ -17,10 +17,10 @@
     "validator": "^13.15.0"
   },
   "devDependencies": {
-    "ac-semantic-release": "^0.4.5",
+    "ac-semantic-release": "^0.4.6",
     "c8": "^10.1.3",
-    "eslint": "^9.25.0",
-    "mocha": "^11.1.0"
+    "eslint": "^9.26.0",
+    "mocha": "^11.2.2"
   },
   "scripts": {
     "test": "mocha --reporter spec --bail",

package/test/tests/ip.js

@@ -9,7 +9,13 @@ module.exports = {
       { name: 'Valid IPv6', type: 'ip', value: '1200:0000:AB00:1234:0000:2552:7777:1313', expected: '1200:0000:AB00:1234:0000:2552:7777:1313' },
       { name: 'Valid IPv6 - use version 6', type: 'ip', version: '6', value: '1200:0000:AB00:1234:0000:2552:7777:1313', expected: '1200:0000:AB00:1234:0000:2552:7777:1313' },
       { name: 'Valid local IPv6', type: 'ip', value: '::ffff:127.0.0.1', expected: '::ffff:127.0.0.1' },
-      { name: 'Invalid IPv4 - should fail', type: 'ip', value: 'A', error: 'ip_notAnIP' },      
+      { name: 'Invalid IPv4 - should fail', type: 'ip', value: 'A', error: 'ip_notAnIP' }, 
+      // anonymize
+      { name: 'Valid IPv4 - anonymize 2 octets with 0', type: 'ip', value: '8.8.8.8', expected: '8.8.0.0', anonymize: 2 },
+      { name: 'Valid IPv4 - anonymize 2 octets with x', type: 'ip', value: '8.8.8.8', expected: '8.8.x.x', anonymize: 2, replacement: 'x' },
+      { name: 'Valid IPv6 - anonymize 2 segements', type: 'ip', version: '6', value: '2001:db8:85a3:1:2:3:4:5', expected: '2001:db8:85a3:1::', anonymize: 2 },
+      { name: 'Valid IPv6 - anonymize 2 segements', type: 'ip', version: '6', value: '2001:db8:85a3::8a2e:370:7334', expected: '2001:db8:85a3::', anonymize: 2 },
+      { name: 'Valid IPv6 - anonymize 4 segements', type: 'ip', version: '6', value: '2001:0db8:85a3:0000:0000:8a2e:0370:7334', expected: '::', anonymize: 4 },
     ]
 
     runValidationTests(baseTests, 'ip')