org.owasp.security.logging.mask

Class NLFConverter

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<ch.qos.logback.classic.spi.ILoggingEvent>

org.owasp.security.logging.mask.NLFConverter

All Implemented Interfaces:

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

public class NLFConverter
extends ch.qos.logback.core.pattern.CompositeConverter<ch.qos.logback.classic.spi.ILoggingEvent>

This converter is used to encode any carriage returns and line feeds to prevent log injection attacks 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.

Field Summary

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

started

Constructor Summary

Constructors

Constructor and Description
NLFConverter()

Method Summary

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

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

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

Constructor Detail

NLFConverter

public NLFConverter()

Method Detail

transform

protected String transform(ch.qos.logback.classic.spi.ILoggingEvent event,
                           String in)

Specified by:

transform 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.DynamicConverter<ch.qos.logback.classic.spi.ILoggingEvent>