Adding MASK filter strategy (#105)

* #104 Adding MASK filter strategy.
philterd · Jul 15, 2024 · d9a63f1 · d9a63f1
1 parent cdd2166
commit d9a63f1
Show file tree

Hide file tree

Showing 35 changed files with 549 additions and 0 deletions.
diff --git a/...main/java/ai/philterd/phileas/model/policy/filters/strategies/AbstractFilterStrategy.java b/...main/java/ai/philterd/phileas/model/policy/filters/strategies/AbstractFilterStrategy.java
@@ -42,6 +42,7 @@ public abstract class AbstractFilterStrategy {
     public static final String FPE_ENCRYPT_REPLACE = "FPE_ENCRYPT_REPLACE";
     public static final String HASH_SHA256_REPLACE = "HASH_SHA256_REPLACE";
     public static final String LAST_4 = "LAST_4";
+    public static final String MASK = "MASK";
 
     // NER Person's name strategies
     public static final String ABBREVIATE = "ABBREVIATE";
@@ -97,6 +98,14 @@ public abstract class AbstractFilterStrategy {
     @Expose
     protected String staticReplacement = "";
 
+    @SerializedName("maskCharacter")
+    @Expose
+    protected String maskCharacter = "*";
+
+    @SerializedName("maskLength")
+    @Expose
+    protected String maskLength = "same";
+
     @SerializedName("condition")
     @Expose
     protected String condition = "";
@@ -339,6 +348,22 @@ public void setStaticReplacement(String staticReplacement) {
         this.staticReplacement = staticReplacement;
     }
 
+    public void setMaskCharacter(String maskCharacter) {
+        this.maskCharacter = maskCharacter;
+    }
+
+    public String getMaskCharacter() {
+        return maskCharacter;
+    }
+
+    public void setMaskLength(String maskLength) {
+        this.maskLength = maskLength;
+    }
+
+    public String getMaskLength() {
+        return maskLength;
+    }
+
     public void setConditions(String condition) {
         this.condition = condition;
     }

diff --git a/...in/java/ai/philterd/phileas/model/policy/filters/strategies/ai/PersonsFilterStrategy.java b/...in/java/ai/philterd/phileas/model/policy/filters/strategies/ai/PersonsFilterStrategy.java
@@ -142,6 +142,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/...ilterd/phileas/model/policy/filters/strategies/custom/CustomDictionaryFilterStrategy.java b/...ilterd/phileas/model/policy/filters/strategies/custom/CustomDictionaryFilterStrategy.java
@@ -131,6 +131,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/.../java/ai/philterd/phileas/model/policy/filters/strategies/dynamic/CityFilterStrategy.java b/.../java/ai/philterd/phileas/model/policy/filters/strategies/dynamic/CityFilterStrategy.java
@@ -128,6 +128,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/...ava/ai/philterd/phileas/model/policy/filters/strategies/dynamic/CountyFilterStrategy.java b/...ava/ai/philterd/phileas/model/policy/filters/strategies/dynamic/CountyFilterStrategy.java
@@ -128,6 +128,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/.../ai/philterd/phileas/model/policy/filters/strategies/dynamic/FirstNameFilterStrategy.java b/.../ai/philterd/phileas/model/policy/filters/strategies/dynamic/FirstNameFilterStrategy.java
@@ -128,6 +128,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/...d/phileas/model/policy/filters/strategies/dynamic/HospitalAbbreviationFilterStrategy.java b/...d/phileas/model/policy/filters/strategies/dynamic/HospitalAbbreviationFilterStrategy.java
@@ -128,6 +128,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/...a/ai/philterd/phileas/model/policy/filters/strategies/dynamic/HospitalFilterStrategy.java b/...a/ai/philterd/phileas/model/policy/filters/strategies/dynamic/HospitalFilterStrategy.java
@@ -128,6 +128,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/...java/ai/philterd/phileas/model/policy/filters/strategies/dynamic/StateFilterStrategy.java b/...java/ai/philterd/phileas/model/policy/filters/strategies/dynamic/StateFilterStrategy.java
@@ -128,6 +128,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/...va/ai/philterd/phileas/model/policy/filters/strategies/dynamic/SurnameFilterStrategy.java b/...va/ai/philterd/phileas/model/policy/filters/strategies/dynamic/SurnameFilterStrategy.java
@@ -128,6 +128,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/...ain/java/ai/philterd/phileas/model/policy/filters/strategies/rules/AgeFilterStrategy.java b/...ain/java/ai/philterd/phileas/model/policy/filters/strategies/rules/AgeFilterStrategy.java
@@ -132,6 +132,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/...ilterd/phileas/model/policy/filters/strategies/rules/BankRoutingNumberFilterStrategy.java b/...ilterd/phileas/model/policy/filters/strategies/rules/BankRoutingNumberFilterStrategy.java
@@ -128,6 +128,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/.../philterd/phileas/model/policy/filters/strategies/rules/BitcoinAddressFilterStrategy.java b/.../philterd/phileas/model/policy/filters/strategies/rules/BitcoinAddressFilterStrategy.java
@@ -127,6 +127,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/...a/ai/philterd/phileas/model/policy/filters/strategies/rules/CreditCardFilterStrategy.java b/...a/ai/philterd/phileas/model/policy/filters/strategies/rules/CreditCardFilterStrategy.java
@@ -130,6 +130,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/...ava/ai/philterd/phileas/model/policy/filters/strategies/rules/CurrencyFilterStrategy.java b/...ava/ai/philterd/phileas/model/policy/filters/strategies/rules/CurrencyFilterStrategy.java
@@ -128,6 +128,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/...in/java/ai/philterd/phileas/model/policy/filters/strategies/rules/DateFilterStrategy.java b/...in/java/ai/philterd/phileas/model/policy/filters/strategies/rules/DateFilterStrategy.java
@@ -160,6 +160,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.

diff --git a/.../philterd/phileas/model/policy/filters/strategies/rules/DriversLicenseFilterStrategy.java b/.../philterd/phileas/model/policy/filters/strategies/rules/DriversLicenseFilterStrategy.java
@@ -138,6 +138,20 @@ public Replacement getReplacement(String label, String context, String documentI
 
             replacement = getRedactedToken(token, label, filterType);
 
+        } else if(StringUtils.equalsIgnoreCase(strategy, MASK)) {
+
+            int characters = token.length();
+
+            if(!StringUtils.equalsIgnoreCase(maskLength, "same")) {
+                characters = Integer.parseInt(maskLength);
+            }
+
+            if(characters < 1) {
+                characters = 5;
+            }
+
+            replacement = maskCharacter.repeat(characters);
+
         } else if(StringUtils.equalsIgnoreCase(strategy, RANDOM_REPLACE)) {
 
             // Default to document scope.