RT-44 - adding in masking

Author: darinhoward

README.md

@@ -29,7 +29,7 @@ Add it as a maven dependency:
 ## Usage
 
 Example appender configuration (*.properties file):
-```
+```properties
 log4j.appender.STACKIFY=com.stackify.log.log4j12.StackifyLogAppender
 log4j.appender.STACKIFY.apiKey=YOUR_API_KEY
 log4j.appender.STACKIFY.application=YOUR_APPLICATION_NAME
@@ -41,7 +41,7 @@ Example appender configuration (*.xml file):
 <appender name="STACKIFY" class="com.stackify.log.log4j12.StackifyLogAppender">
     <param name="apiKey" value="YOUR_API_KEY"/>
     <param name="application" value="YOUR_APPLICATION_NAME"/>
-    <param name="environment" value="YOUR_ENVIRONMENT"/>
+    <param name="environment" value="YOUR_ENVIRONMENT"/>  
 </appender>
 ```
 
@@ -52,6 +52,51 @@ Be sure to shutdown Log4j to flush this appender of any errors and shutdown the
 org.apache.log4j.LogManager.shutdown();
 ```
 
+
+## Masking 
+
+The Stackify appender has built-in data masking for credit cards and social security number values.
+
+**Disable Masking:**
+
+Add `<MaskEnabled>false</MaskEnabled>` inside the `<StackifyLog> ... </StackifyLog>` tag.
+
+**Customize Masking:**
+
+The example below has the following customizations: 
+
+1. Credit Card value masking is disabled (`<param name="maskCreditCard" value="false"/>`)
+2. IP Address masking is enabled (`<param name="maskIP" value="true"/>`).
+3. Custom masking to remove vowels using a regex (`<param name="maskCustom" value="[aeiou]"/> `)
+
+```properties
+log4j.appender.STACKIFY=com.stackify.log.log4j12.StackifyLogAppender
+log4j.appender.STACKIFY.apiKey=YOUR_API_KEY
+log4j.appender.STACKIFY.application=YOUR_APPLICATION_NAME
+log4j.appender.STACKIFY.environment=YOUR_ENVIRONMENT
+ 
+log4j.appender.STACKIFY.maskEnabled=true
+log4j.appender.STACKIFY.maskCreditCard=false
+log4j.appender.STACKIFY.maskSSN=true
+log4j.appender.STACKIFY.maskIP=true
+log4j.appender.STACKIFY.maskCustom=[aeiou]
+```
+ 
+```xml
+<appender name="STACKIFY" class="com.stackify.log.log4j12.StackifyLogAppender">
+    <param name="apiKey" value="YOUR_API_KEY"/>
+    <param name="application" value="YOUR_APPLICATION_NAME"/>
+    <param name="environment" value="YOUR_ENVIRONMENT"/>
+      
+    <param name="maskEnabled" value="true"/>
+    <param name="maskCreditCard" value="false"/>
+    <param name="maskSSN" value="true"/>
+    <param name="maskIP" value="true"/>
+    <param name="maskCustom" value="[aeiou]"/> 
+</appender>
+```
+
+
 ## License
 
 Copyright 2014 Stackify, LLC.

pom.xml

@@ -62,11 +62,20 @@
 		<dependency>
 		  	<groupId>com.stackify</groupId>
   			<artifactId>stackify-api-java</artifactId>
-  			<version>2.1.8</version>
+  			<version>2.1.9-SNAPSHOT</version>
 		</dependency>
 
 		<!-- Runtime dependencies -->
 
+		<!-- Provided dependencies -->
+
+		<dependency>
+			<groupId>org.projectlombok</groupId>
+			<artifactId>lombok</artifactId>
+			<version>1.16.10</version>
+			<scope>provided</scope>
+		</dependency>
+
 		<!-- Test dependencies -->
 
 		<dependency>
@@ -162,6 +171,10 @@
 						<goals>
 							<goal>jar</goal>
 						</goals>
+						<configuration>
+							<failOnError>false</failOnError>
+							<additionalparam>-Xdoclint:none</additionalparam>
+						</configuration>
 					</execution>
 				</executions>
 			</plugin>

src/main/java/com/stackify/log/log4j12/StackifyLogAppender.java

@@ -15,6 +15,9 @@
  */
 package com.stackify.log.log4j12;
 
+import com.stackify.api.common.mask.Masker;
+import lombok.Getter;
+import lombok.Setter;
 import org.apache.log4j.spi.LoggingEvent;
 
 import com.stackify.api.common.ApiClients;
@@ -82,7 +85,27 @@ public class StackifyLogAppender extends NonReentrantAppender {
 	 * Generic log appender
 	 */
 	private LogAppender<LoggingEvent> logAppender;
-	
+
+	@Setter
+	@Getter
+	private String maskEnabled;
+
+	@Setter
+	@Getter
+	private String maskCreditCard;
+
+	@Setter
+	@Getter
+	private String maskSSN;
+
+	@Setter
+	@Getter
+	private String maskIP;
+
+	@Setter
+	@Getter
+	private String maskCustom;
+
 	/**
 	 * @return the apiUrl
 	 */
@@ -145,19 +168,53 @@ public void setEnvironment(String environment) {
 	@Override
 	public void activateOptions() {
 		super.activateOptions();
-		
+
 		// build the api config
 
 		ApiConfiguration apiConfig = ApiConfigurations.fromPropertiesWithOverrides(apiUrl, apiKey, application, environment);
-		
+
 		// get the client project name with version
 
 		String clientName = ApiClients.getApiClient(StackifyLogAppender.class, "/stackify-log-log4j12.properties", "stackify-log-log4j12");
 
 		// build the log appender
 
 		try {
-			this.logAppender = new LogAppender<LoggingEvent>(clientName, new LoggingEventAdapter(apiConfig.getEnvDetail()));
+
+			// setup masker
+
+			if (maskEnabled == null) {
+				maskEnabled = Boolean.TRUE.toString();
+			}
+
+			Masker masker = new Masker();
+			if (Boolean.parseBoolean(maskEnabled)) {
+
+				// set default masks
+				masker.addMask(Masker.MASK_CREDITCARD);
+				masker.addMask(Masker.MASK_SSN);
+
+				if (maskCreditCard != null && !Boolean.parseBoolean(maskCreditCard)) {
+					masker.removeMask(Masker.MASK_CREDITCARD);
+				}
+
+				if (maskSSN != null && !Boolean.parseBoolean(maskSSN)) {
+					masker.removeMask(Masker.MASK_SSN);
+				}
+
+				if (maskIP != null && Boolean.parseBoolean(maskIP)) {
+					masker.addMask(Masker.MASK_IP);
+				}
+
+				if (maskCustom != null) {
+					masker.addMask(maskCustom);
+				}
+
+			} else {
+				masker.clearMasks();
+			}
+
+			this.logAppender = new LogAppender<LoggingEvent>(clientName, new LoggingEventAdapter(apiConfig.getEnvDetail()), masker);
 			this.logAppender.activate(apiConfig);
 		} catch (Exception e) {
 			errorHandler.error("Exception starting the Stackify_LogBackgroundService", e, 0);