Skip to content

Warning when EnableTransactionManagement has lower precedence than EnableMethodSecurity #17665

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+222 −1
Open

Warning when EnableTransactionManagement has lower precedence than EnableMethodSecurity #17665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
66 changes: 65 additions & 1 deletion ...k/security/config/annotation/method/configuration/PrePostMethodSecurityConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,18 @@

package org.springframework.security.config.annotation.method.configuration;

import java.util.Map;

import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.aop.Pointcut;
import org.springframework.aop.framework.AopInfrastructureBean;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.beans.factory.SmartInitializingSingleton;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.ApplicationContext;
Expand All @@ -31,6 +36,7 @@
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportAware;
import org.springframework.context.annotation.Role;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.security.access.expression.method.DefaultMethodSecurityExpressionHandler;
import org.springframework.security.access.expression.method.MethodSecurityExpressionHandler;
Expand All @@ -50,18 +56,24 @@
import org.springframework.security.config.core.GrantedAuthorityDefaults;
import org.springframework.security.core.annotation.AnnotationTemplateExpressionDefaults;
import org.springframework.security.core.context.SecurityContextHolderStrategy;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import org.springframework.util.ClassUtils;

/**
* Base {@link Configuration} for enabling Spring Security Method Security.
*
* @author Evgeniy Cheban
* @author Josh Cummings
* @author Yoobin Yoon
* @since 5.6
* @see EnableMethodSecurity
*/
@Configuration(value = "_prePostMethodSecurityConfiguration", proxyBeanMethods = false)
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
final class PrePostMethodSecurityConfiguration implements ImportAware, ApplicationContextAware, AopInfrastructureBean {
final class PrePostMethodSecurityConfiguration
implements ImportAware, ApplicationContextAware, AopInfrastructureBean, SmartInitializingSingleton {

private static final Log logger = LogFactory.getLog(PrePostMethodSecurityConfiguration.class);

private static final Pointcut preFilterPointcut = new PreFilterAuthorizationMethodInterceptor().getPointcut();

Expand All @@ -87,6 +99,10 @@ final class PrePostMethodSecurityConfiguration implements ImportAware, Applicati

private final DefaultMethodSecurityExpressionHandler expressionHandler = new DefaultMethodSecurityExpressionHandler();

private ApplicationContext applicationContext;

private boolean prePostEnabled = true;

PrePostMethodSecurityConfiguration(
ObjectProvider<ObjectPostProcessor<AuthorizationManager<MethodInvocation>>> preAuthorizeProcessor,
ObjectProvider<ObjectPostProcessor<AuthorizationManager<MethodInvocationResult>>> postAuthorizeProcessor) {
Expand All @@ -106,11 +122,20 @@ final class PrePostMethodSecurityConfiguration implements ImportAware, Applicati

@Override
public void setApplicationContext(ApplicationContext context) throws BeansException {
this.applicationContext = context;
this.expressionHandler.setApplicationContext(context);
this.preAuthorizeAuthorizationManager.setApplicationContext(context);
this.postAuthorizeAuthorizationManager.setApplicationContext(context);
}

@Override
public void afterSingletonsInstantiated() {
if (!this.prePostEnabled) {
return;
}
validateTransactionManagementPrecedence();
}

@Autowired(required = false)
void setGrantedAuthorityDefaults(GrantedAuthorityDefaults grantedAuthorityDefaults) {
this.expressionHandler.setDefaultRolePrefix(grantedAuthorityDefaults.getRolePrefix());
Expand Down Expand Up @@ -192,6 +217,7 @@ static SecurityHintsRegistrar prePostAuthorizeExpressionHintsRegistrar() {
@Override
public void setImportMetadata(AnnotationMetadata importMetadata) {
EnableMethodSecurity annotation = importMetadata.getAnnotations().get(EnableMethodSecurity.class).synthesize();
this.prePostEnabled = annotation.prePostEnabled();
this.preFilterMethodInterceptor.setOrder(this.preFilterMethodInterceptor.getOrder() + annotation.offset());
this.preAuthorizeMethodInterceptor
.setOrder(this.preAuthorizeMethodInterceptor.getOrder() + annotation.offset());
Expand All @@ -200,4 +226,42 @@ public void setImportMetadata(AnnotationMetadata importMetadata) {
this.postFilterMethodInterceptor.setOrder(this.postFilterMethodInterceptor.getOrder() + annotation.offset());
}

/**
* Validates that @EnableTransactionManagement has higher precedence
* than @EnableMethodSecurity. This is important to ensure that @PostAuthorize checks
* happen before transaction commit, allowing rollback on authorization failures.
*/
private void validateTransactionManagementPrecedence() {
try {
int currentMethodSecurityOrder = this.preAuthorizeMethodInterceptor.getOrder();

Map<String, Object> txMgmtBeans = this.applicationContext
.getBeansWithAnnotation(EnableTransactionManagement.class);

for (Map.Entry<String, Object> entry : txMgmtBeans.entrySet()) {
Class<?> configClass = ClassUtils.getUserClass(entry.getValue().getClass());
EnableTransactionManagement txMgmt = AnnotationUtils.findAnnotation(configClass,
EnableTransactionManagement.class);

if (txMgmt != null) {
int txOrder = txMgmt.order();
if (txOrder >= currentMethodSecurityOrder) {
logger.warn("@EnableTransactionManagement has same or lower precedence (order=" + txOrder
+ ") than @EnableMethodSecurity (effective order=" + currentMethodSecurityOrder
+ "). This may cause issues with @PostAuthorize on methods with side effects. "
+ "Consider setting @EnableTransactionManagement(order = 0) or adjusting the order values. "
+ "See Spring Security migration guide for more details.");
break;
}
}
}
}
catch (BeansException ex) {
logger.warn("Could not validate transaction management precedence due to bean access issues", ex);
}
catch (Exception ex) {
logger.debug("Could not validate transaction management precedence", ex);
}
}

}
157 changes: 157 additions & 0 deletions ...urity/config/annotation/method/configuration/PrePostMethodSecurityConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@
import java.util.function.Consumer;
import java.util.function.Supplier;

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.read.ListAppender;
import io.micrometer.observation.Observation;
import io.micrometer.observation.ObservationHandler;
import io.micrometer.observation.ObservationRegistry;
Expand All @@ -40,6 +44,7 @@
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import org.slf4j.LoggerFactory;

import org.springframework.aop.Advisor;
import org.springframework.aop.Pointcut;
Expand Down Expand Up @@ -125,6 +130,7 @@
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
Expand Down Expand Up @@ -156,6 +162,7 @@
*
* @author Evgeniy Cheban
* @author Josh Cummings
* @author Yoobin Yoon
*/
@ExtendWith({ SpringExtension.class, SpringTestContextExtension.class })
@ContextConfiguration(classes = SecurityContextChangedListenerConfig.class)
Expand Down Expand Up @@ -1348,6 +1355,85 @@ void getWhenCustomAdvisorAuthenticationNameNotMatchThenRespondsWithForbidden() t
this.mvc.perform(requestWithUser).andExpect(status().isForbidden());
}

@Test
public void configureWhenTransactionManagementThenWarningCondition() {
this.spring.register(TransactionManagementConfig.class).autowire();
assertThat(this.spring.getContext().getBean(MethodSecurityService.class)).isNotNull();
EnableTransactionManagement txMgmt = TransactionManagementConfig.class
.getAnnotation(EnableTransactionManagement.class);
assertThat(txMgmt.order()).isGreaterThan(100);
}

@Test
public void configureWhenTransactionManagementLowerPrecedenceThenWarningCondition() {
this.spring.register(TransactionManagementLowerPrecedenceConfig.class).autowire();
EnableTransactionManagement txMgmt = TransactionManagementLowerPrecedenceConfig.class
.getAnnotation(EnableTransactionManagement.class);
assertThat(txMgmt.order()).isGreaterThan(100);
}

@Test
public void configureWhenTransactionManagementHigherPrecedenceThenNoWarningCondition() {
this.spring.register(TransactionManagementHigherPrecedenceConfig.class).autowire();
assertThat(this.spring.getContext().getBean(MethodSecurityService.class)).isNotNull();
EnableTransactionManagement txMgmt = TransactionManagementHigherPrecedenceConfig.class
.getAnnotation(EnableTransactionManagement.class);
assertThat(txMgmt.order()).isLessThanOrEqualTo(100);
}

@Test
public void configureWhenTransactionManagementSameOrderThenWarningCondition() {
this.spring.register(TransactionManagementSameOrderConfig.class).autowire();
EnableTransactionManagement txMgmt = TransactionManagementSameOrderConfig.class
.getAnnotation(EnableTransactionManagement.class);
assertThat(txMgmt.order()).isEqualTo(100);
}

@Test
public void configureWhenMethodSecurityOffsetThenWarningCondition() {
this.spring.register(MethodSecurityOffsetWithTransactionConfig.class).autowire();
EnableMethodSecurity methodSecurity = MethodSecurityOffsetWithTransactionConfig.class
.getAnnotation(EnableMethodSecurity.class);
EnableTransactionManagement txMgmt = MethodSecurityOffsetWithTransactionConfig.class
.getAnnotation(EnableTransactionManagement.class);
int effectiveMethodSecurityOrder = 100 + methodSecurity.offset();
assertThat(txMgmt.order()).isGreaterThan(effectiveMethodSecurityOrder);
}

@Test
public void configureWhenTransactionManagementSameOrderThenNoWarningCondition() {
this.spring.register(TransactionManagementSameOrderConfig.class).autowire();
EnableTransactionManagement txMgmt = TransactionManagementSameOrderConfig.class
.getAnnotation(EnableTransactionManagement.class);
assertThat(txMgmt.order()).isEqualTo(100);
}

@Test
public void configureWhenTransactionManagementLowerPrecedenceThenValidationRuns() {
assertThatNoException()
.isThrownBy(() -> this.spring.register(TransactionManagementLowerPrecedenceConfig.class).autowire());
assertThat(this.spring.getContext().getBean(MethodSecurityService.class)).isNotNull();
}

@Test
public void validateTransactionManagementPrecedenceWhenLowerPrecedenceThenLogsWarning() {
Logger logger = (Logger) LoggerFactory.getLogger(PrePostMethodSecurityConfiguration.class);
ListAppender<ILoggingEvent> appender = new ListAppender<>();
appender.start();
logger.addAppender(appender);
try {
this.spring.register(TransactionManagementLowerPrecedenceConfig.class).autowire();
assertThat(appender.list).hasSize(1);
assertThat(appender.list.get(0).getLevel()).isEqualTo(Level.WARN);
assertThat(appender.list.get(0).getMessage())
.contains("@EnableTransactionManagement has same or lower precedence");

}
finally {
logger.detachAppender(appender);
}
}

private static Consumer<ConfigurableWebApplicationContext> disallowBeanOverriding() {
return (context) -> ((AnnotationConfigWebApplicationContext) context).setAllowBeanDefinitionOverriding(false);
}
Expand Down Expand Up @@ -2201,4 +2287,75 @@ public String getName() {

}

@Configuration
@EnableMethodSecurity(prePostEnabled = true)
@EnableTransactionManagement
static class TransactionManagementConfig {

@Bean
MethodSecurityService methodSecurityService() {
return new MethodSecurityServiceImpl();
}

}

@Configuration
@EnableMethodSecurity(prePostEnabled = true)
@EnableTransactionManagement(order = 300)
static class TransactionManagementLowerPrecedenceConfig {

@Bean
MethodSecurityService methodSecurityService() {
return new MethodSecurityServiceImpl();
}

}

@Configuration
@EnableMethodSecurity(prePostEnabled = true)
@EnableTransactionManagement(order = 0)
static class TransactionManagementHigherPrecedenceConfig {

@Bean
MethodSecurityService methodSecurityService() {
return new MethodSecurityServiceImpl();
}

}

@Configuration
@EnableMethodSecurity(prePostEnabled = true)
@EnableTransactionManagement(order = 100)
static class TransactionManagementSameOrderConfig {

@Bean
MethodSecurityService methodSecurityService() {
return new MethodSecurityServiceImpl();
}

}

@Configuration
@EnableMethodSecurity(prePostEnabled = true)
static class NoTransactionManagementConfig {

@Bean
MethodSecurityService methodSecurityService() {
return new MethodSecurityServiceImpl();
}

}

@Configuration
@EnableMethodSecurity(prePostEnabled = true, offset = 50)
@EnableTransactionManagement(order = 200)
static class MethodSecurityOffsetWithTransactionConfig {

@Bean
MethodSecurityService methodSecurityService() {
return new MethodSecurityServiceImpl();
}

}

}