Package com.atlassian.confluence.impl.webapp.security.enforcer

Class XsrfTokenEnforcer

java.lang.Object

com.atlassian.confluence.impl.webapp.security.enforcer.XsrfTokenEnforcer

All Implemented Interfaces:

SecurityEnforcer

public final class XsrfTokenEnforcer
extends Object
implements SecurityEnforcer

Enforces XSRF token checks for protected actions. The lower level implementation is in XsrfTokenValidationManager.

Since:

8.8

Constructor Summary

Constructors

Constructor	Description
XsrfTokenEnforcer(XsrfTokenValidationManager xsrfTokenValidationManager)

Method Summary

Modifier and Type	Method	Description
void	enforce(ConfluenceUser user, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Enforcement action that should be taken when SecurityEnforcer.shouldEnforce(com.atlassian.confluence.user.ConfluenceUser, com.atlassian.confluence.dmz.struts.MappedAction, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse) returns true.
boolean	shouldEnforce(ConfluenceUser user, MappedAction mappedAction, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

Methods inherited from class java.lang.Object

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

Constructor Details

XsrfTokenEnforcer

public XsrfTokenEnforcer(XsrfTokenValidationManager xsrfTokenValidationManager)

Method Details

shouldEnforce

public boolean shouldEnforce(ConfluenceUser user,
 MappedAction mappedAction,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Specified by:

shouldEnforce in interface SecurityEnforcer

Returns:

true if arguments failed enforcement criteria and SecurityEnforcer.enforce(com.atlassian.confluence.user.ConfluenceUser, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse) should be called.

enforce

public void enforce(ConfluenceUser user,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
             throws IOException,
jakarta.servlet.ServletException

Description copied from interface: SecurityEnforcer

Enforcement action that should be taken when SecurityEnforcer.shouldEnforce(com.atlassian.confluence.user.ConfluenceUser, com.atlassian.confluence.dmz.struts.MappedAction, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse) returns true.

Specified by:

enforce in interface SecurityEnforcer

Throws:

IOException

jakarta.servlet.ServletException