From 1fa1848f9fa95761d3dc7e5ce56975a62bd1bc8d Mon Sep 17 00:00:00 2001 From: earlgrey02 Date: Thu, 30 Jan 2025 13:25:15 +0900 Subject: [PATCH] Add HttpStatusAccessDeniedHandler Signed-off-by: earlgrey02 --- .../access/HttpStatusAccessDeniedHandler.java | 34 ++++++++++++++ .../HttpStatusAccessDeniedHandlerTests.java | 46 +++++++++++++++++++ 2 files changed, 80 insertions(+) create mode 100644 web/src/main/java/org/springframework/security/web/access/HttpStatusAccessDeniedHandler.java create mode 100644 web/src/test/java/org/springframework/security/web/access/HttpStatusAccessDeniedHandlerTests.java diff --git a/web/src/main/java/org/springframework/security/web/access/HttpStatusAccessDeniedHandler.java b/web/src/main/java/org/springframework/security/web/access/HttpStatusAccessDeniedHandler.java new file mode 100644 index 0000000000..93e191583b --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/access/HttpStatusAccessDeniedHandler.java @@ -0,0 +1,34 @@ +package org.springframework.security.web.access; + +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.core.log.LogMessage; +import org.springframework.http.HttpStatus; +import org.springframework.security.access.AccessDeniedException; +import org.springframework.util.Assert; + +import java.io.IOException; + +public class HttpStatusAccessDeniedHandler implements AccessDeniedHandler { + + protected static final Log logger = LogFactory.getLog(HttpStatusAccessDeniedHandler.class); + + private final HttpStatus httpStatus; + + public HttpStatusAccessDeniedHandler(HttpStatus httpStatus) { + Assert.notNull(httpStatus, "httpStatus cannot be null"); + this.httpStatus = httpStatus; + } + + @Override + public void handle(HttpServletRequest request, HttpServletResponse response, + AccessDeniedException accessDeniedException) throws IOException, ServletException { + logger.debug(LogMessage.format("Access denied with status code %d", this.httpStatus.value())); + + response.sendError(this.httpStatus.value(), "Access Denied"); + } + +} diff --git a/web/src/test/java/org/springframework/security/web/access/HttpStatusAccessDeniedHandlerTests.java b/web/src/test/java/org/springframework/security/web/access/HttpStatusAccessDeniedHandlerTests.java new file mode 100644 index 0000000000..59158088bd --- /dev/null +++ b/web/src/test/java/org/springframework/security/web/access/HttpStatusAccessDeniedHandlerTests.java @@ -0,0 +1,46 @@ +package org.springframework.security.web.access; + +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.http.HttpStatus; +import org.springframework.mock.web.MockHttpServletResponse; +import org.springframework.security.access.AccessDeniedException; + +import java.io.IOException; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; + +@ExtendWith(MockitoExtension.class) +public class HttpStatusAccessDeniedHandlerTests { + + @Mock + private HttpServletRequest request; + + @Mock + private HttpServletResponse response; + + private HttpStatus httpStatus = HttpStatus.FORBIDDEN; + + private HttpStatusAccessDeniedHandler handler = new HttpStatusAccessDeniedHandler(this.httpStatus); + + private AccessDeniedException exception = new AccessDeniedException("Forbidden"); + + @Test + public void constructorHttpStatusWhenNullThenException() { + assertThatIllegalArgumentException().isThrownBy(() -> new HttpStatusAccessDeniedHandler(null)); + } + + @Test + public void commenceThenStatusSet() throws IOException, ServletException { + this.response = new MockHttpServletResponse(); + this.handler.handle(this.request, this.response, this.exception); + assertThat(this.response.getStatus()).isEqualTo(this.httpStatus.value()); + } + +}