com.stackify.api.common.mask.Masker Maven / Gradle / Ivy
package com.stackify.api.common.mask;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.NonNull;
import lombok.extern.slf4j.Slf4j;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
/**
* Handles masking string values based on regex matching.
* Class is Thread Safe.
*
* @author Darin Howard
*/
@NoArgsConstructor
@Slf4j
public class Masker {
public static final String MASK_CREDITCARD = "CREDITCARD";
public static final String MASK_SSN = "SSN";
public static final String MASK_IP = "IP";
public static final String MASK_UUID = "UUID";
public static final String MASK_NUMERIC = "NUMERIC";
public static final String MASK_EMAIL = "EMAIL";
public static final String[] MASKS = new String[]{MASK_CREDITCARD, MASK_SSN, MASK_IP, MASK_UUID, MASK_NUMERIC, MASK_EMAIL};
protected static final String MASK_CC_VISA_REGEX = "4[0-9]{12}(?:[0-9]{3})";
protected static final String MASK_CC_DISCOVER_REGEX = "6(?:011|5[0-9]{2})[0-9]{12}";
protected static final String MASK_CC_MASTERCARD_REGEX = "5[1-5][0-9]{14}";
protected static final String MASK_CC_AMEX_REGEX = "3[47][0-9]{13}";
protected static final String MASK_CC_DINERS_REGEX = "3(?:0[0-5]|[68][0-9])?[0-9]{11}";
protected static final String MASK_SSN_REGEX = "[0-9]{3}-[0-9]{2}-[0-9]{4}";
protected static final String MASK_IPV4_REGEX = "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)";
protected static final String MASK_NUMERIC_REGEX = "(\\d+)";
protected static final String MASK_UUID_REGEX = "(?i)(\\b[A-F0-9]{8}(?:-[A-F0-9]{4}){3}-[A-F0-9]{12}\\b)";
protected static final String MASK_EMAIL_REGEX = "((([!#$%&'*+\\-/=?^_`{|}~\\w])|([!#$%&'*+\\-/=?^_`{|}~\\w][!#$%&'*+\\-/=?^_`{|}~\\.\\w]{0,}[!#$%&'*+\\-/=?^_`{|}~\\w]))[@]\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*)";
private static final String DEFAULT_MASK_VALUE = "*";
@Getter
private final Map maskPatterns = new ConcurrentHashMap();
public void clearMasks() {
maskPatterns.clear();
}
private final Object lock = new Object();
public void removeMask(@NonNull final String mask) {
synchronized (lock) {
if (mask.equals(MASK_CREDITCARD)) {
removeMaskPattern(MASK_CC_VISA_REGEX);
removeMaskPattern(MASK_CC_DISCOVER_REGEX);
removeMaskPattern(MASK_CC_MASTERCARD_REGEX);
removeMaskPattern(MASK_CC_AMEX_REGEX);
removeMaskPattern(MASK_CC_DINERS_REGEX);
return;
} else if (mask.equals(MASK_SSN)) {
removeMaskPattern(MASK_SSN_REGEX);
return;
} else if (mask.equals(MASK_IP)) {
removeMaskPattern(MASK_IPV4_REGEX);
return;
} else if (mask.equals(MASK_UUID)) {
removeMaskPattern(MASK_UUID_REGEX);
return;
} else if (mask.equals(MASK_NUMERIC)) {
removeMaskPattern(MASK_NUMERIC_REGEX);
return;
} else if (mask.equals(MASK_EMAIL)) {
removeMaskPattern(MASK_EMAIL_REGEX);
return;
}
removeMaskPattern(mask);
}
}
public void addMask(@NonNull final String mask) {
synchronized (lock) {
if (mask.equals(MASK_CREDITCARD)) {
addMaskPattern(MASK_CC_VISA_REGEX);
addMaskPattern(MASK_CC_DISCOVER_REGEX);
addMaskPattern(MASK_CC_MASTERCARD_REGEX);
addMaskPattern(MASK_CC_AMEX_REGEX);
addMaskPattern(MASK_CC_DINERS_REGEX);
return;
} else if (mask.equals(MASK_SSN)) {
addMaskPattern(MASK_SSN_REGEX);
return;
} else if (mask.equals(MASK_IP)) {
addMaskPattern(MASK_IPV4_REGEX);
return;
} else if (mask.equals(MASK_UUID)) {
addMaskPattern(MASK_UUID_REGEX);
return;
} else if (mask.equals(MASK_NUMERIC)) {
addMaskPattern(MASK_NUMERIC_REGEX);
return;
} else if (mask.equals(MASK_EMAIL)) {
addMaskPattern(MASK_EMAIL_REGEX);
return;
}
addMaskPattern(mask);
}
}
private synchronized void addMaskPattern(final String regex) {
if (regex != null) {
try {
maskPatterns.put(regex, Pattern.compile(regex));
} catch (PatternSyntaxException e) {
log.error(String.format("Error Adding Mask: %s: '%s'", e.getMessage(), regex));
}
}
}
private synchronized void removeMaskPattern(final String regex) {
if (regex != null) {
try {
maskPatterns.remove(regex);
} catch (PatternSyntaxException e) {
log.error(String.format("%s: '%s'", e.getMessage(), regex));
}
}
}
/**
* Returns string with '*' replacing any value matching a configured mask.
*
* @param value Value to mask.
*/
public String mask(final String value) {
return mask(value, DEFAULT_MASK_VALUE);
}
/**
* Returns string with [replacementValue] replacing any value matching a configured mask.
*
* @param value Value to mask.
* @param replacementValue Value to use when replacing original content.
* If a single character string is supplied, it will be repeated to keep original value's length.
*/
public String mask(final String value,
final String replacementValue) {
try {
if (hasMasks()) {
if (value == null) return null;
String maskedValue = value;
for (Map.Entry entry : maskPatterns.entrySet()) {
Matcher matcher = entry.getValue().matcher(maskedValue);
while (matcher.find()) {
String match = matcher.group();
String matchReplace;
if (replacementValue.length() == 1) {
char[] symbols = new char[match.length()];
Arrays.fill(symbols, replacementValue.toCharArray()[0]);
matchReplace = new String(symbols);
} else {
matchReplace = replacementValue;
}
maskedValue = maskedValue.replace(match, matchReplace);
}
}
return maskedValue;
}
} catch (Throwable e) {
log.warn(e.getMessage(), e);
}
return value;
}
public boolean hasMasks() {
return maskPatterns.size() > 0;
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy