org.owasp.security.logging.mask

Class MaskingConverter

java.lang.Object

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

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

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

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

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

org.owasp.security.logging.mask.MaskingConverter

All Implemented Interfaces:

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

public class MaskingConverter
extends ch.qos.logback.core.pattern.ReplacingCompositeConverter<ch.qos.logback.classic.spi.ILoggingEvent>

This converter is used to output a masked version of the formatted message in contexts where the logging of confidential information is undesirable. It is not possible to replace the actual formatted message, instead this converter returns a masked version of the message that can be accessed using the conversionWord specified in the conversionRule definition in logback.xml.

Author:

August Detlefsen [augustd@codemagi.com], Sytze van Koningsveld

Field Summary

Fields

Modifier and Type	Field and Description
static String	MASKED_PASSWORD

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

started

Constructor Summary

Constructors

Constructor and Description
MaskingConverter()

Method Summary

Modifier and Type	Method and Description
String	convert(ch.qos.logback.classic.spi.ILoggingEvent event)
void	start() Override start method because the superclass ReplacingCompositeConverter requires at least two options and this class has none.

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

transform

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

getChildConverter, setChildConverter, toString

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, wait, wait, wait

Field Detail

MASKED_PASSWORD

public static final String MASKED_PASSWORD

See Also:

Constant Field Values

Constructor Detail

MaskingConverter

public MaskingConverter()

Method Detail

convert

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

Overrides:

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

start

public void start()

Override start method because the superclass ReplacingCompositeConverter requires at least two options and this class has none.

Specified by:

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

Overrides:

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