com.devonfw.module.logging.common.impl

Class SecureLogging

java.lang.Object

com.devonfw.module.logging.common.impl.SecureLogging

public class SecureLogging
extends Object

Class which provides Markers for differential logging. Implements "MultiMarker"s (org.owasp.security.logging.MultiMarker) for optimal filtering if the dependency org.owasp is available, or corresponding conventional Markers as a fall back solution.

Example usage:

 
 LOG.info(SecureLogging.SECURITY_FAILURE_CONFIDENTIAL, "Confidential Security Failure message.");
 
 

Example filters for appenders in logback.xml to accept or reject the above log event:

  <filter class="org.owasp.security.logging.filter.SecurityMarkerFilter" />
  <filter class="org.owasp.security.logging.filter.ExcludeClassifiedMarkerFilter" />
 

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Marker	CONFIDENTIAL Marker for Confidential log events.
private static String	CONFIDENTIAL_MARKER_NAME
private static String	EXT_CLASS
private static boolean	initialized
private static org.slf4j.Logger	LOG Logger instance.
private static org.slf4j.Marker	markerSecurAuditConfid
private static org.slf4j.Marker	markerSecurFailConfid
private static org.slf4j.Marker	markerSecurSuccConfid
private static String	METHOD_NAME
static org.slf4j.Marker	RESTRICTED Marker for Restricted log events.
private static String	RESTRICTED_MARKER_NAME
static org.slf4j.Marker	SECURITY_AUDIT_CONFIDENTIAL Marker or MultiMarker for Confidential Security Audit log events.
private static String	SECURITY_AUDIT_CONFIDENTIAL_MARKER_NAME
private static String	SECURITY_AUDIT_MARKER_NAME
static org.slf4j.Marker	SECURITY_FAILURE Marker for Security Failure log events.
static org.slf4j.Marker	SECURITY_FAILURE_CONFIDENTIAL Marker or MultiMarker for Confidential Security Failure log events.
private static String	SECURITY_FAILURE_CONFIDENTIAL_MARKER_NAME
private static String	SECURITY_FAILURE_MARKER_NAME
static org.slf4j.Marker	SECURITY_SUCCESS Marker for Security Success log events.
static org.slf4j.Marker	SECURITY_SUCCESS_CONFIDENTIAL Marker or MultiMarker for Confidential Security Success log events.
private static String	SECURITY_SUCCESS_CONFIDENTIAL_MARKER_NAME
private static String	SECURITY_SUCCESS_MARKER_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SecureLogging()

Method Summary

Modifier and Type	Method and Description
private static void	createDefaultMarkers()
private static void	createMultiMarkers(Class<?> cExtClass)
private static Class<?>	findExtClass(String className)
private static org.slf4j.Marker	getMarkerSecurAuditConfid()
private static org.slf4j.Marker	getMarkerSecurFailConfid()
private static org.slf4j.Marker	getMarkerSecurSuccConfid()
static boolean	hasExtClass()
private static void	initMarkers() Main method to initialize the combined Markers provided by this class.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

Logger instance.

EXT_CLASS

private static final String EXT_CLASS

See Also:

Constant Field Values

METHOD_NAME

private static final String METHOD_NAME

See Also:

Constant Field Values

initialized

private static boolean initialized

markerSecurSuccConfid

private static org.slf4j.Marker markerSecurSuccConfid

markerSecurFailConfid

private static org.slf4j.Marker markerSecurFailConfid

markerSecurAuditConfid

private static org.slf4j.Marker markerSecurAuditConfid

RESTRICTED_MARKER_NAME

private static final String RESTRICTED_MARKER_NAME

See Also:

Constant Field Values

CONFIDENTIAL_MARKER_NAME

private static final String CONFIDENTIAL_MARKER_NAME

See Also:

Constant Field Values

SECURITY_SUCCESS_MARKER_NAME

private static final String SECURITY_SUCCESS_MARKER_NAME

See Also:

Constant Field Values

SECURITY_FAILURE_MARKER_NAME

private static final String SECURITY_FAILURE_MARKER_NAME

See Also:

Constant Field Values

SECURITY_AUDIT_MARKER_NAME

private static final String SECURITY_AUDIT_MARKER_NAME

See Also:

Constant Field Values

SECURITY_SUCCESS_CONFIDENTIAL_MARKER_NAME

private static final String SECURITY_SUCCESS_CONFIDENTIAL_MARKER_NAME

See Also:

Constant Field Values

SECURITY_FAILURE_CONFIDENTIAL_MARKER_NAME

private static final String SECURITY_FAILURE_CONFIDENTIAL_MARKER_NAME

See Also:

Constant Field Values

SECURITY_AUDIT_CONFIDENTIAL_MARKER_NAME

private static final String SECURITY_AUDIT_CONFIDENTIAL_MARKER_NAME

See Also:

Constant Field Values

RESTRICTED

public static final org.slf4j.Marker RESTRICTED

Marker for Restricted log events.

CONFIDENTIAL

public static final org.slf4j.Marker CONFIDENTIAL

Marker for Confidential log events. Usage with OWASP provides possibility for masking, e.g. of passwords.

SECURITY_SUCCESS

public static final org.slf4j.Marker SECURITY_SUCCESS

Marker for Security Success log events.

SECURITY_FAILURE

public static final org.slf4j.Marker SECURITY_FAILURE

Marker for Security Failure log events.

SECURITY_SUCCESS_CONFIDENTIAL

public static final org.slf4j.Marker SECURITY_SUCCESS_CONFIDENTIAL

Marker or MultiMarker for Confidential Security Success log events.

SECURITY_FAILURE_CONFIDENTIAL

public static final org.slf4j.Marker SECURITY_FAILURE_CONFIDENTIAL

Marker or MultiMarker for Confidential Security Failure log events.

SECURITY_AUDIT_CONFIDENTIAL

public static final org.slf4j.Marker SECURITY_AUDIT_CONFIDENTIAL

Marker or MultiMarker for Confidential Security Audit log events.

Constructor Detail

SecureLogging

private SecureLogging()

Method Detail

getMarkerSecurSuccConfid

private static org.slf4j.Marker getMarkerSecurSuccConfid()

getMarkerSecurFailConfid

private static org.slf4j.Marker getMarkerSecurFailConfid()

getMarkerSecurAuditConfid

private static org.slf4j.Marker getMarkerSecurAuditConfid()

initMarkers

private static void initMarkers()

Main method to initialize the combined Markers provided by this class.

createDefaultMarkers

private static void createDefaultMarkers()

createMultiMarkers

private static void createMultiMarkers(Class<?> cExtClass)

hasExtClass

public static boolean hasExtClass()

Returns:

True if the dependency is available.

findExtClass

private static Class<?> findExtClass(String className)

Returns:

The given Class if parameter 'className' can be resolved, otherwise String.class.