org.springframework.security.messaging.web.socket.server

Class CsrfTokenHandshakeInterceptor

java.lang.Object

org.springframework.security.messaging.web.socket.server.CsrfTokenHandshakeInterceptor

All Implemented Interfaces:

org.springframework.web.socket.server.HandshakeInterceptor

public final class CsrfTokenHandshakeInterceptor
extends java.lang.Object
implements org.springframework.web.socket.server.HandshakeInterceptor

Copies a CsrfToken from the HttpServletRequest's attributes to the WebSocket attributes. This is used as the expected CsrfToken when validating connection requests to ensure only the same origin connects.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
CsrfTokenHandshakeInterceptor()

Method Summary

Modifier and Type	Method and Description
void	afterHandshake(org.springframework.http.server.ServerHttpRequest request, org.springframework.http.server.ServerHttpResponse response, org.springframework.web.socket.WebSocketHandler wsHandler, java.lang.Exception exception)
boolean	beforeHandshake(org.springframework.http.server.ServerHttpRequest request, org.springframework.http.server.ServerHttpResponse response, org.springframework.web.socket.WebSocketHandler wsHandler, java.util.Map<java.lang.String,java.lang.Object> attributes)

Methods inherited from class java.lang.Object

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

Constructor Detail

CsrfTokenHandshakeInterceptor

public CsrfTokenHandshakeInterceptor()

Method Detail

beforeHandshake

public boolean beforeHandshake(org.springframework.http.server.ServerHttpRequest request,
                               org.springframework.http.server.ServerHttpResponse response,
                               org.springframework.web.socket.WebSocketHandler wsHandler,
                               java.util.Map<java.lang.String,java.lang.Object> attributes)
                        throws java.lang.Exception

Specified by:

beforeHandshake in interface org.springframework.web.socket.server.HandshakeInterceptor

Throws:

java.lang.Exception

afterHandshake

public void afterHandshake(org.springframework.http.server.ServerHttpRequest request,
                           org.springframework.http.server.ServerHttpResponse response,
                           org.springframework.web.socket.WebSocketHandler wsHandler,
                           java.lang.Exception exception)

Specified by:

afterHandshake in interface org.springframework.web.socket.server.HandshakeInterceptor