mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-06-06 18:30:57 +00:00
2217cfb95d
# Description of Changes Please provide a summary of the changes, including: https://docs.spring.io/spring-security/reference/api/java/org/springframework/security/web/util/matcher/AntPathRequestMatcher.html --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
320 lines
19 KiB
Java
320 lines
19 KiB
Java
package stirling.software.SPDF.config.security;
|
|
|
|
import java.util.Optional;
|
|
|
|
import org.springframework.beans.factory.annotation.Autowired;
|
|
import org.springframework.beans.factory.annotation.Qualifier;
|
|
import org.springframework.context.annotation.Bean;
|
|
import org.springframework.context.annotation.Configuration;
|
|
import org.springframework.context.annotation.DependsOn;
|
|
import org.springframework.context.annotation.Lazy;
|
|
import org.springframework.security.authentication.ProviderManager;
|
|
import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
|
|
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.config.http.SessionCreationPolicy;
|
|
import org.springframework.security.core.authority.mapping.GrantedAuthoritiesMapper;
|
|
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
|
|
import org.springframework.security.crypto.password.PasswordEncoder;
|
|
import org.springframework.security.saml2.provider.service.authentication.OpenSaml4AuthenticationProvider;
|
|
import org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistrationRepository;
|
|
import org.springframework.security.saml2.provider.service.web.authentication.OpenSaml4AuthenticationRequestResolver;
|
|
import org.springframework.security.web.SecurityFilterChain;
|
|
import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
|
|
import org.springframework.security.web.authentication.rememberme.PersistentTokenRepository;
|
|
import org.springframework.security.web.csrf.CookieCsrfTokenRepository;
|
|
import org.springframework.security.web.csrf.CsrfTokenRequestAttributeHandler;
|
|
import org.springframework.security.web.savedrequest.NullRequestCache;
|
|
import org.springframework.security.web.servlet.util.matcher.PathPatternRequestMatcher;
|
|
|
|
import lombok.extern.slf4j.Slf4j;
|
|
|
|
import stirling.software.SPDF.config.security.oauth2.CustomOAuth2AuthenticationFailureHandler;
|
|
import stirling.software.SPDF.config.security.oauth2.CustomOAuth2AuthenticationSuccessHandler;
|
|
import stirling.software.SPDF.config.security.oauth2.CustomOAuth2UserService;
|
|
import stirling.software.SPDF.config.security.saml2.CustomSaml2AuthenticationFailureHandler;
|
|
import stirling.software.SPDF.config.security.saml2.CustomSaml2AuthenticationSuccessHandler;
|
|
import stirling.software.SPDF.config.security.saml2.CustomSaml2ResponseAuthenticationConverter;
|
|
import stirling.software.SPDF.config.security.session.SessionPersistentRegistry;
|
|
import stirling.software.SPDF.model.User;
|
|
import stirling.software.SPDF.repository.JPATokenRepositoryImpl;
|
|
import stirling.software.SPDF.repository.PersistentLoginRepository;
|
|
import stirling.software.common.model.ApplicationProperties;
|
|
|
|
@Configuration
|
|
@EnableWebSecurity
|
|
@EnableMethodSecurity
|
|
@Slf4j
|
|
@DependsOn("runningProOrHigher")
|
|
public class SecurityConfiguration {
|
|
|
|
private final CustomUserDetailsService userDetailsService;
|
|
private final UserService userService;
|
|
private final boolean loginEnabledValue;
|
|
private final boolean runningProOrHigher;
|
|
|
|
private final ApplicationProperties applicationProperties;
|
|
private final UserAuthenticationFilter userAuthenticationFilter;
|
|
private final LoginAttemptService loginAttemptService;
|
|
private final FirstLoginFilter firstLoginFilter;
|
|
private final SessionPersistentRegistry sessionRegistry;
|
|
private final PersistentLoginRepository persistentLoginRepository;
|
|
private final GrantedAuthoritiesMapper oAuth2userAuthoritiesMapper;
|
|
private final RelyingPartyRegistrationRepository saml2RelyingPartyRegistrations;
|
|
private final OpenSaml4AuthenticationRequestResolver saml2AuthenticationRequestResolver;
|
|
|
|
public SecurityConfiguration(
|
|
PersistentLoginRepository persistentLoginRepository,
|
|
CustomUserDetailsService userDetailsService,
|
|
@Lazy UserService userService,
|
|
@Qualifier("loginEnabled") boolean loginEnabledValue,
|
|
@Qualifier("runningProOrHigher") boolean runningProOrHigher,
|
|
ApplicationProperties applicationProperties,
|
|
UserAuthenticationFilter userAuthenticationFilter,
|
|
LoginAttemptService loginAttemptService,
|
|
FirstLoginFilter firstLoginFilter,
|
|
SessionPersistentRegistry sessionRegistry,
|
|
@Autowired(required = false) GrantedAuthoritiesMapper oAuth2userAuthoritiesMapper,
|
|
@Autowired(required = false)
|
|
RelyingPartyRegistrationRepository saml2RelyingPartyRegistrations,
|
|
@Autowired(required = false)
|
|
OpenSaml4AuthenticationRequestResolver saml2AuthenticationRequestResolver) {
|
|
this.userDetailsService = userDetailsService;
|
|
this.userService = userService;
|
|
this.loginEnabledValue = loginEnabledValue;
|
|
this.runningProOrHigher = runningProOrHigher;
|
|
this.applicationProperties = applicationProperties;
|
|
this.userAuthenticationFilter = userAuthenticationFilter;
|
|
this.loginAttemptService = loginAttemptService;
|
|
this.firstLoginFilter = firstLoginFilter;
|
|
this.sessionRegistry = sessionRegistry;
|
|
this.persistentLoginRepository = persistentLoginRepository;
|
|
this.oAuth2userAuthoritiesMapper = oAuth2userAuthoritiesMapper;
|
|
this.saml2RelyingPartyRegistrations = saml2RelyingPartyRegistrations;
|
|
this.saml2AuthenticationRequestResolver = saml2AuthenticationRequestResolver;
|
|
}
|
|
|
|
@Bean
|
|
public PasswordEncoder passwordEncoder() {
|
|
return new BCryptPasswordEncoder();
|
|
}
|
|
|
|
@Bean
|
|
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
|
|
if (applicationProperties.getSecurity().getCsrfDisabled() || !loginEnabledValue) {
|
|
http.csrf(csrf -> csrf.disable());
|
|
}
|
|
|
|
if (loginEnabledValue) {
|
|
http.addFilterBefore(
|
|
userAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
|
|
if (!applicationProperties.getSecurity().getCsrfDisabled()) {
|
|
CookieCsrfTokenRepository cookieRepo =
|
|
CookieCsrfTokenRepository.withHttpOnlyFalse();
|
|
CsrfTokenRequestAttributeHandler requestHandler =
|
|
new CsrfTokenRequestAttributeHandler();
|
|
requestHandler.setCsrfRequestAttributeName(null);
|
|
http.csrf(
|
|
csrf ->
|
|
csrf.ignoringRequestMatchers(
|
|
request -> {
|
|
String apiKey = request.getHeader("X-API-KEY");
|
|
// If there's no API key, don't ignore CSRF
|
|
// (return false)
|
|
if (apiKey == null || apiKey.trim().isEmpty()) {
|
|
return false;
|
|
}
|
|
// Validate API key using existing UserService
|
|
try {
|
|
Optional<User> user =
|
|
userService.getUserByApiKey(apiKey);
|
|
// If API key is valid, ignore CSRF (return
|
|
// true)
|
|
// If API key is invalid, don't ignore CSRF
|
|
// (return false)
|
|
return user.isPresent();
|
|
} catch (Exception e) {
|
|
// If there's any error validating the API
|
|
// key, don't ignore CSRF
|
|
return false;
|
|
}
|
|
})
|
|
.csrfTokenRepository(cookieRepo)
|
|
.csrfTokenRequestHandler(requestHandler));
|
|
}
|
|
http.addFilterBefore(rateLimitingFilter(), UsernamePasswordAuthenticationFilter.class);
|
|
http.addFilterAfter(firstLoginFilter, UsernamePasswordAuthenticationFilter.class);
|
|
http.sessionManagement(
|
|
sessionManagement ->
|
|
sessionManagement
|
|
.sessionCreationPolicy(SessionCreationPolicy.IF_REQUIRED)
|
|
.maximumSessions(10)
|
|
.maxSessionsPreventsLogin(false)
|
|
.sessionRegistry(sessionRegistry)
|
|
.expiredUrl("/login?logout=true"));
|
|
http.authenticationProvider(daoAuthenticationProvider());
|
|
http.requestCache(requestCache -> requestCache.requestCache(new NullRequestCache()));
|
|
http.logout(
|
|
logout ->
|
|
logout.logoutRequestMatcher(
|
|
PathPatternRequestMatcher.withDefaults()
|
|
.matcher("/logout"))
|
|
.logoutSuccessHandler(
|
|
new CustomLogoutSuccessHandler(applicationProperties))
|
|
.clearAuthentication(true)
|
|
.invalidateHttpSession(true)
|
|
.deleteCookies("JSESSIONID", "remember-me"));
|
|
http.rememberMe(
|
|
rememberMeConfigurer -> // Use the configurator directly
|
|
rememberMeConfigurer
|
|
.tokenRepository(persistentTokenRepository())
|
|
.tokenValiditySeconds( // 14 days
|
|
14 * 24 * 60 * 60)
|
|
.userDetailsService( // Your existing UserDetailsService
|
|
userDetailsService)
|
|
.useSecureCookie( // Enable secure cookie
|
|
true)
|
|
.rememberMeParameter( // Form parameter name
|
|
"remember-me")
|
|
.rememberMeCookieName( // Cookie name
|
|
"remember-me")
|
|
.alwaysRemember(false));
|
|
http.authorizeHttpRequests(
|
|
authz ->
|
|
authz.requestMatchers(
|
|
req -> {
|
|
String uri = req.getRequestURI();
|
|
String contextPath = req.getContextPath();
|
|
// Remove the context path from the URI
|
|
String trimmedUri =
|
|
uri.startsWith(contextPath)
|
|
? uri.substring(
|
|
contextPath.length())
|
|
: uri;
|
|
return trimmedUri.startsWith("/login")
|
|
|| trimmedUri.startsWith("/oauth")
|
|
|| trimmedUri.startsWith("/saml2")
|
|
|| trimmedUri.endsWith(".svg")
|
|
|| trimmedUri.startsWith("/register")
|
|
|| trimmedUri.startsWith("/error")
|
|
|| trimmedUri.startsWith("/images/")
|
|
|| trimmedUri.startsWith("/public/")
|
|
|| trimmedUri.startsWith("/css/")
|
|
|| trimmedUri.startsWith("/fonts/")
|
|
|| trimmedUri.startsWith("/js/")
|
|
|| trimmedUri.startsWith(
|
|
"/api/v1/info/status");
|
|
})
|
|
.permitAll()
|
|
.anyRequest()
|
|
.authenticated());
|
|
// Handle User/Password Logins
|
|
if (applicationProperties.getSecurity().isUserPass()) {
|
|
http.formLogin(
|
|
formLogin ->
|
|
formLogin
|
|
.loginPage("/login")
|
|
.successHandler(
|
|
new CustomAuthenticationSuccessHandler(
|
|
loginAttemptService, userService))
|
|
.failureHandler(
|
|
new CustomAuthenticationFailureHandler(
|
|
loginAttemptService, userService))
|
|
.defaultSuccessUrl("/")
|
|
.permitAll());
|
|
}
|
|
// Handle OAUTH2 Logins
|
|
if (applicationProperties.getSecurity().isOauth2Active()) {
|
|
http.oauth2Login(
|
|
oauth2 ->
|
|
oauth2.loginPage("/oauth2")
|
|
.
|
|
/*
|
|
This Custom handler is used to check if the OAUTH2 user trying to log in, already exists in the database.
|
|
If user exists, login proceeds as usual. If user does not exist, then it is auto-created but only if 'OAUTH2AutoCreateUser'
|
|
is set as true, else login fails with an error message advising the same.
|
|
*/
|
|
successHandler(
|
|
new CustomOAuth2AuthenticationSuccessHandler(
|
|
loginAttemptService,
|
|
applicationProperties,
|
|
userService))
|
|
.failureHandler(
|
|
new CustomOAuth2AuthenticationFailureHandler())
|
|
. // Add existing Authorities from the database
|
|
userInfoEndpoint(
|
|
userInfoEndpoint ->
|
|
userInfoEndpoint
|
|
.oidcUserService(
|
|
new CustomOAuth2UserService(
|
|
applicationProperties,
|
|
userService,
|
|
loginAttemptService))
|
|
.userAuthoritiesMapper(
|
|
oAuth2userAuthoritiesMapper))
|
|
.permitAll());
|
|
}
|
|
// Handle SAML
|
|
if (applicationProperties.getSecurity().isSaml2Active() && runningProOrHigher) {
|
|
// Configure the authentication provider
|
|
OpenSaml4AuthenticationProvider authenticationProvider =
|
|
new OpenSaml4AuthenticationProvider();
|
|
authenticationProvider.setResponseAuthenticationConverter(
|
|
new CustomSaml2ResponseAuthenticationConverter(userService));
|
|
http.authenticationProvider(authenticationProvider)
|
|
.saml2Login(
|
|
saml2 -> {
|
|
try {
|
|
saml2.loginPage("/saml2")
|
|
.relyingPartyRegistrationRepository(
|
|
saml2RelyingPartyRegistrations)
|
|
.authenticationManager(
|
|
new ProviderManager(authenticationProvider))
|
|
.successHandler(
|
|
new CustomSaml2AuthenticationSuccessHandler(
|
|
loginAttemptService,
|
|
applicationProperties,
|
|
userService))
|
|
.failureHandler(
|
|
new CustomSaml2AuthenticationFailureHandler())
|
|
.authenticationRequestResolver(
|
|
saml2AuthenticationRequestResolver);
|
|
} catch (Exception e) {
|
|
log.error("Error configuring SAML 2 login", e);
|
|
throw new RuntimeException(e);
|
|
}
|
|
});
|
|
}
|
|
} else {
|
|
log.debug("SAML 2 login is not enabled. Using default.");
|
|
http.authorizeHttpRequests(authz -> authz.anyRequest().permitAll());
|
|
}
|
|
return http.build();
|
|
}
|
|
|
|
public DaoAuthenticationProvider daoAuthenticationProvider() {
|
|
DaoAuthenticationProvider provider = new DaoAuthenticationProvider();
|
|
provider.setUserDetailsService(userDetailsService);
|
|
provider.setPasswordEncoder(passwordEncoder());
|
|
return provider;
|
|
}
|
|
|
|
@Bean
|
|
public IPRateLimitingFilter rateLimitingFilter() {
|
|
// Example limit TODO add config level
|
|
int maxRequestsPerIp = 1000000;
|
|
return new IPRateLimitingFilter(maxRequestsPerIp, maxRequestsPerIp);
|
|
}
|
|
|
|
@Bean
|
|
public PersistentTokenRepository persistentTokenRepository() {
|
|
return new JPATokenRepositoryImpl(persistentLoginRepository);
|
|
}
|
|
|
|
@Bean
|
|
public boolean activeSecurity() {
|
|
return true;
|
|
}
|
|
}
|