org.owasp.security.logging.mask

Class DefinedRegexMaskingConverter

java.lang.Object

ch.qos.logback.core.pattern.Converter<E>

ch.qos.logback.core.pattern.FormattingConverter<E>

ch.qos.logback.core.pattern.DynamicConverter<ch.qos.logback.classic.spi.ILoggingEvent>

ch.qos.logback.classic.pattern.ClassicConverter

org.owasp.security.logging.mask.DefinedRegexMaskingConverter

All Implemented Interfaces:

ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle

public class DefinedRegexMaskingConverter
extends ch.qos.logback.classic.pattern.ClassicConverter

Masking configured values in logs. To configure in you logback file here is an example: Step 1 add conversion word: <conversionRule conversionWord="maskedMsg" converterClass="org.owasp.security.logging.mask.DefinedRegexMaskingConverter" /> Step 2 add to the pattern like this. There 4 pre-defined values for CompleteMask, MaskLastFour, MaskFirstFour, emailMasking %maskedMsg{password|signature username, orderNumber|giftCardNum|, email }

Author:

Rahul Agarwal

Field Summary

Fields inherited from class ch.qos.logback.core.pattern.DynamicConverter

started

Constructor Summary

Constructors

Constructor and Description
DefinedRegexMaskingConverter()

Method Summary

Modifier and Type	Method and Description
String	convert(ch.qos.logback.classic.spi.ILoggingEvent logEvent)
void	start()

Methods inherited from class ch.qos.logback.core.pattern.DynamicConverter

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getFirstOption, getOptionList, isStarted, setContext, setOptionList, stop

Methods inherited from class ch.qos.logback.core.pattern.FormattingConverter

getFormattingInfo, setFormattingInfo, write

Methods inherited from class ch.qos.logback.core.pattern.Converter

getNext, setNext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefinedRegexMaskingConverter

public DefinedRegexMaskingConverter()

Method Detail

convert

public String convert(ch.qos.logback.classic.spi.ILoggingEvent logEvent)

Specified by:

convert in class ch.qos.logback.core.pattern.Converter<ch.qos.logback.classic.spi.ILoggingEvent>

start

public void start()

Specified by:

start in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

start in class ch.qos.logback.core.pattern.DynamicConverter<ch.qos.logback.classic.spi.ILoggingEvent>