com.sap.cloud.sdk.cloudplatform.logging

Class LogInputSanitizer

java.lang.Object

com.sap.cloud.sdk.cloudplatform.logging.LogInputSanitizer

public class LogInputSanitizer
extends Object

This class can be used to prevent log forging. It works by checking the input of a log entry against a defined END_OF_LOG token. If the token is present in the input string, the log entry might be forged and will be marked as such. If the token is not present, everything is fine and the token will be appended to the input. Example usage:

 
 LogInputSanitizer sanitizer = new LogInputSanitizer();
 logger.info(sanitizer.sanitizeAndMark("My log entry."));
 
 

Constructor Summary

Constructors

Constructor and Description
LogInputSanitizer() Returns a new instance of the LogInputSanitizer.
LogInputSanitizer(String endOfLogToken) Returns a new instance of the LogInputSanitizer.

Method Summary

Modifier and Type	Method and Description
String	getEndOfLogToken()
String	sanitizeAndMark(String input) Takes an input string, checks it for forging and marks the string accordingly.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogInputSanitizer

public LogInputSanitizer()

Returns a new instance of the LogInputSanitizer.

LogInputSanitizer

public LogInputSanitizer(@Nullable
                         String endOfLogToken)

Returns a new instance of the LogInputSanitizer.

Parameters:

endOfLogToken - The token that will be checked for and appended at the end of log entries. If null, the default token is used.

Method Detail

sanitizeAndMark

@Nullable
public String sanitizeAndMark(@Nullable
                                        String input)

Takes an input string, checks it for forging and marks the string accordingly. If the token is present in the input string, the log entry might be forged and will be marked as such. If the token is not present, everything is fine and the token will be appended to the input.

Parameters:

input - The input string to be logged.

Returns:

The input string, marked either with the end of log token or a warning token.

getEndOfLogToken

public String getEndOfLogToken()