org.owasp.security.logging.mdc.plugins

Class ForwardedIPAddressPlugin

java.lang.Object

org.owasp.security.logging.mdc.plugins.ForwardedIPAddressPlugin

All Implemented Interfaces:

IPlugin

public class ForwardedIPAddressPlugin
extends Object
implements IPlugin

This plugin adds the request's remote IP address to the MDC by using the value of the X-Forwarded-For header appended by a load balancer. The value can be accessed in a PatternLayout by using the specifier: %X{ipAddress} IMPORTANT: If your environment does not use a load balancer, it is recommended to not use this plugin since an attacker could easily add spoofed X-Forwarded-For headers in any request.

Author:

August Detlefsen [augustd@codemagi.com]

Constructor Summary

Constructors

Constructor and Description
ForwardedIPAddressPlugin()

Method Summary

Modifier and Type	Method and Description
void	execute(javax.servlet.http.HttpServletRequest request) Execute the plugin's action and place information into the diagnostic context.
void	init(javax.servlet.FilterConfig config) Initialize the plugin and load any required resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardedIPAddressPlugin

public ForwardedIPAddressPlugin()

Method Detail

init

public void init(javax.servlet.FilterConfig config)

Description copied from interface: IPlugin

Initialize the plugin and load any required resources.

Specified by:

init in interface IPlugin

Parameters:

config - The filter configuration to initialize the plugin

execute

public void execute(javax.servlet.http.HttpServletRequest request)

Description copied from interface: IPlugin

Execute the plugin's action and place information into the diagnostic context.

Specified by:

execute in interface IPlugin

Parameters:

request - The HTTP request to execute this plugin for