org.owasp.security.logging

Class Utils

java.lang.Object

org.owasp.security.logging.Utils

public class Utils
extends Object

Utilities methods for logging.

Author:

August Detlefsen [augustd@codemagi.com]

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static String	escapeNLFChars(String value) Replace any NLF (newline function) with an underscore to prevent log injection attacks.
static boolean	isEmpty(String value) Determines if a string is null or empty
static String	replaceCRLFWithUnderscore(String value) Replace any carriage returns and line feeds with an underscore to prevent log injection attacks.
static String	toSHA(byte[] input) Converts an input byte array to a SHA hash.
static String	toSHA(String input) Converts an input String to a SHA hash.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

toSHA

public static String toSHA(String input)

Converts an input String to a SHA hash. The actual hash strength is hidden by the method name to allow for future-proofing this API, but the current default is SHA-256.

Parameters:

input - The string to hash

Returns:

SHA hash of the input String, hex encoded.

toSHA

public static String toSHA(byte[] input)

Converts an input byte array to a SHA hash. The actual hash strength is hidden by the method name to allow for future-proofing this API, but the current default is SHA-256.

Parameters:

input - Byte array to hash

Returns:

SHA hash of the input String, hex encoded.

isEmpty

public static boolean isEmpty(String value)

Determines if a string is null or empty

Parameters:

value - string to test

Returns:

true if the string is empty or null; false otherwise

replaceCRLFWithUnderscore

public static String replaceCRLFWithUnderscore(String value)

Replace any carriage returns and line feeds with an underscore to prevent log injection attacks.

Parameters:

value - string to convert

Returns:

converted string

escapeNLFChars

public static String escapeNLFChars(String value)

Replace any NLF (newline function) with an underscore to prevent log injection attacks.

Parameters:

value - string to convert

Returns:

converted string

See Also:

Unicode Standard