Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Method Security Exclude ExceptionHandler annotation method #15355

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -17,27 +17,44 @@
package org.springframework.security.authorization.method;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

import org.springframework.aop.Pointcut;
import org.springframework.aop.support.ComposablePointcut;
import org.springframework.aop.support.Pointcuts;
import org.springframework.aop.support.annotation.AnnotationMatchingPointcut;
import org.springframework.aop.support.annotation.AnnotationMethodMatcher;
import org.springframework.security.access.prepost.PostAuthorize;
import org.springframework.security.access.prepost.PostFilter;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.security.access.prepost.PreFilter;
import org.springframework.util.ClassUtils;

/**
* @author Josh Cummings
* @author Evgeniy Cheban
* @author DingHao
*/
final class AuthorizationMethodPointcuts {

private static Class<?> exceptionHandlerClass;

static {
try {
exceptionHandlerClass = ClassUtils
.resolveClassName("org.springframework.web.bind.annotation.ExceptionHandler", null);
}
catch (Exception ex) {
exceptionHandlerClass = null;
}
}

static Pointcut forAllAnnotations() {
return forAnnotations(PreFilter.class, PreAuthorize.class, PostFilter.class, PostAuthorize.class);
}

@SafeVarargs
@SuppressWarnings("unchecked")
static Pointcut forAnnotations(Class<? extends Annotation>... annotations) {
ComposablePointcut pointcut = null;
for (Class<? extends Annotation> annotation : annotations) {
Expand All @@ -48,6 +65,15 @@ static Pointcut forAnnotations(Class<? extends Annotation>... annotations) {
pointcut.union(classOrMethod(annotation));
}
}
if (exceptionHandlerClass != null && pointcut != null) {
pointcut
.intersection(new AnnotationMethodMatcher((Class<? extends Annotation>) exceptionHandlerClass, true) {
@Override
public boolean matches(Method method, Class<?> targetClass) {
return !super.matches(method, targetClass);
}
});
}
return pointcut;
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
/*
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.security.test.web.servlet.request;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.ResponseEntity;
import org.springframework.security.access.AccessDeniedException;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.test.context.support.WithMockUser;
import org.springframework.security.web.SecurityFilterChain;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

/**
* SecurityMockMvcRequestExceptionHandlerTests
*
* @author DingHao
*/
@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = SecurityMockMvcRequestExceptionHandlerTests.Config.class)
@WebAppConfiguration
public class SecurityMockMvcRequestExceptionHandlerTests {

@Autowired
private WebApplicationContext context;

private MockMvc mvc;

@BeforeEach
public void setup() {
this.mvc = MockMvcBuilders.webAppContextSetup(this.context).build();
}

@Test
@WithMockUser
public void testMethodSecurityWithExceptionHandler() throws Exception {
this.mvc.perform(get("/")).andExpect(status().is2xxSuccessful());
}

@Configuration
@EnableWebSecurity
@EnableMethodSecurity
@EnableWebMvc
static class Config {

@Bean
SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
return http.authorizeHttpRequests((c) -> c.anyRequest().authenticated()).build();
}

@RestController
@PreAuthorize("hasRole('ADMIN')")
static class TestRestApi {

@RequestMapping("/")
String get() {
return "Hello";
}

@ExceptionHandler
private ResponseEntity<String> handleAccessDeniedException(AccessDeniedException e) {
return ResponseEntity.ok(e.getMessage());
}

}

}

}