-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
AYS-509 | Restricted Fields Have Been Masked while Saving Logs (#423)
- Loading branch information
1 parent
baaecd3
commit 5859f18
Showing
6 changed files
with
237 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| package org.ays.common.util; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.node.ArrayNode; | ||
| import com.fasterxml.jackson.databind.node.ObjectNode; | ||
| import lombok.experimental.UtilityClass; | ||
| import org.apache.commons.lang3.StringUtils; | ||
|
|
||
| import java.util.Iterator; | ||
|
|
||
| /** | ||
| * Utility class for masking sensitive information in JSON data. | ||
| * <p> | ||
| * This class provides methods for masking fields within a {@link JsonNode} or individual string values. | ||
| * It is designed to handle common sensitive fields such as tokens, passwords, email addresses, and more. | ||
| * </p> | ||
| * | ||
| * <p><strong>Unmasked JSON:</strong></p> | ||
| * <pre> | ||
| * { | ||
| * "emailAddress": "[email protected]", | ||
| * "password": "123456789", | ||
| * "lineNumber": "1234567890", | ||
| * "address": "123 Main Street, Springfield", | ||
| * "firstName": "John", | ||
| * "lastName": "Doe" | ||
| * } | ||
| * </pre> | ||
| * | ||
| * <p><strong>Masked JSON:</strong></p> | ||
| * <pre> | ||
| * { | ||
| * "emailAddress": "tes******com", | ||
| * "password": "******", | ||
| * "lineNumber": "******7890", | ||
| * "address": "123 Main ******field", | ||
| * "firstName": "Joh******ohn", | ||
| * "lastName": "Doe******oe" | ||
| * } | ||
| * </pre> | ||
| */ | ||
| @UtilityClass | ||
| public class AysMaskUtil { | ||
|
|
||
| private static final String MASKED_VALUE = "******"; | ||
|
|
||
| /** | ||
| * Masks sensitive fields in the given {@link JsonNode}. | ||
| * <p> | ||
| * This method recursively iterates through the fields in the JSON object or array, | ||
| * and applies masking to fields identified as sensitive. | ||
| * </p> | ||
| * | ||
| * @param jsonNode the JSON node to process for masking | ||
| */ | ||
| public static void mask(final JsonNode jsonNode) { | ||
|
|
||
| if (jsonNode.isObject()) { | ||
|
|
||
| ObjectNode objectNode = (ObjectNode) jsonNode; | ||
| Iterator<String> fieldNames = objectNode.fieldNames(); | ||
|
|
||
| while (fieldNames.hasNext()) { | ||
|
|
||
| String fieldName = fieldNames.next(); | ||
| JsonNode fieldValue = objectNode.get(fieldName); | ||
|
|
||
| if (fieldValue.isValueNode()) { | ||
| String maskedValue = mask(fieldName, fieldValue.asText()); | ||
| objectNode.put(fieldName, maskedValue); | ||
| continue; | ||
| } | ||
|
|
||
| mask(fieldValue); | ||
| } | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| if (jsonNode.isArray()) { | ||
| ArrayNode arrayNode = (ArrayNode) jsonNode; | ||
| for (JsonNode arrayElement : arrayNode) { | ||
| mask(arrayElement); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Masks the value of a specific field based on its name. | ||
| * <p> | ||
| * This method identifies sensitive fields by their names and applies the appropriate | ||
| * masking strategy. Fields not recognized as sensitive are returned without modification. | ||
| * </p> | ||
| * | ||
| * @param field the name of the field | ||
| * @param value the value to mask | ||
| * @return the masked value | ||
| */ | ||
| public static String mask(final String field, final String value) { | ||
|
|
||
| if ("null".equalsIgnoreCase(value) || StringUtils.isBlank(value)) { | ||
| return value; | ||
| } | ||
|
|
||
| return switch (field) { | ||
| case "Authorization", "accessToken", "refreshToken" -> maskToken(value); | ||
| case "password" -> maskPassword(); | ||
| case "emailAddress" -> maskEmailAddress(value); | ||
| case "lineNumber" -> maskLineNumber(value); | ||
| case "address" -> maskAddress(value); | ||
| case "firstName", "lastName", "applicantFirstName", "applicantLastName" -> maskName(value); | ||
| default -> value; | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Masks token fields such as "Authorization", "accessToken", or "refreshToken". | ||
| * | ||
| * @param value the token value to mask | ||
| * @return the masked token | ||
| */ | ||
| private static String maskToken(String value) { | ||
|
|
||
| if (value.length() <= 20) { | ||
| return value; | ||
| } | ||
|
|
||
| return value.substring(0, 20) + MASKED_VALUE; | ||
| } | ||
|
|
||
| /** | ||
| * Masks password fields, replacing their values with a fixed placeholder. | ||
| * | ||
| * @return the masked password placeholder | ||
| */ | ||
| private static String maskPassword() { | ||
| return MASKED_VALUE; | ||
| } | ||
|
|
||
| /** | ||
| * Masks email addresses by revealing the first three and last three characters, | ||
| * replacing the rest with asterisks. | ||
| * | ||
| * @param value the email address to mask | ||
| * @return the masked email address | ||
| */ | ||
| private static String maskEmailAddress(String value) { | ||
|
|
||
| if (value.length() <= 3) { | ||
| return value; | ||
| } | ||
|
|
||
| int length = value.length(); | ||
| String firstThree = value.substring(0, 3); | ||
| String lastThree = value.substring(length - 3); | ||
| return firstThree + MASKED_VALUE + lastThree; | ||
| } | ||
|
|
||
| /** | ||
| * Masks address fields by revealing the first ten and last ten characters, | ||
| * replacing the middle part with asterisks. | ||
| * | ||
| * @param value the address to mask | ||
| * @return the masked address | ||
| */ | ||
| private static String maskAddress(String value) { | ||
|
|
||
| if (value.length() <= 10) { | ||
| return value; | ||
| } | ||
|
|
||
| return value.substring(0, 10) + MASKED_VALUE + value.substring(value.length() - 10); | ||
| } | ||
|
|
||
| /** | ||
| * Masks line numbers by revealing the last four digits, replacing the preceding digits with asterisks. | ||
| * | ||
| * @param value the line number to mask | ||
| * @return the masked line number | ||
| */ | ||
| private static String maskLineNumber(String value) { | ||
|
|
||
| if (value.length() <= 4) { | ||
| return value; | ||
| } | ||
|
|
||
| return MASKED_VALUE + value.substring(value.length() - 4); | ||
| } | ||
|
|
||
| /** | ||
| * Masks name fields such as "firstName", "lastName", or similar by revealing the first three | ||
| * and last three characters, replacing the middle part with asterisks. | ||
| * | ||
| * @param value the name to mask | ||
| * @return the masked name | ||
| */ | ||
| private static String maskName(String value) { | ||
|
|
||
| if (value.length() <= 3) { | ||
| return value; | ||
| } | ||
|
|
||
| return value.substring(0, 3) + MASKED_VALUE + value.substring(value.length() - 3); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters