Package dev.voidframework.web.http.filter.csrf

Class CSRFFilter

java.lang.Object

dev.voidframework.web.http.filter.csrf.CSRFFilter

All Implemented Interfaces:

Filter

public class CSRFFilter
extends Object
implements Filter

This filter takes care of generating and checking a CSRF token if the request matches the chosen criteria.

Since:

1.1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final TypedMap.Key<Boolean>	BYPASS_CSRF_VERIFICATION
static final TypedMap.Key<String>	CSRF_TOKEN_KEY

Constructor Summary

Constructors

Constructor	Description
CSRFFilter(com.typesafe.config.Config configuration)	Build a new instance.

Method Summary

Modifier and Type	Method	Description
Result	apply(Context context, FilterChain filterChain)	Applies the filter.

Methods inherited from class java.lang.Object

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

Field Details

CSRF_TOKEN_KEY

public static final TypedMap.Key<String> CSRF_TOKEN_KEY

BYPASS_CSRF_VERIFICATION

public static final TypedMap.Key<Boolean> BYPASS_CSRF_VERIFICATION

Constructor Details

CSRFFilter

@Inject
public CSRFFilter(com.typesafe.config.Config configuration)

Build a new instance.

Parameters:

configuration - The application configuration

Since:

1.1.0

Method Details

apply

public Result apply(Context context,
 FilterChain filterChain)

Description copied from interface: Filter

Applies the filter.

Specified by:

apply in interface Filter

Parameters:

context - The current context

filterChain - The owner filter chain

Returns:

A result