2270: rebasing from main

Stirling-Tools · Dec 20, 2024 · d0e3ae9 · d0e3ae9
1 parent f072de8
commit d0e3ae9
Show file tree

Hide file tree

Showing 10 changed files with 87 additions and 68 deletions.
diff --git a/src/main/java/stirling/software/SPDF/config/interfaces/DatabaseInterface.java b/src/main/java/stirling/software/SPDF/config/interfaces/DatabaseInterface.java
@@ -1,12 +1,13 @@
 package stirling.software.SPDF.config.interfaces;
 
-import java.io.IOException;
+import java.sql.SQLException;
 import java.util.List;
 
+import stirling.software.SPDF.model.provider.UnsupportedProviderException;
 import stirling.software.SPDF.utils.FileInfo;
 
 public interface DatabaseInterface {
-    void exportDatabase() throws IOException;
+    void exportDatabase() throws SQLException, UnsupportedProviderException;
 
     List<FileInfo> getBackupList();
 }
diff --git a/src/main/java/stirling/software/SPDF/config/security/InitialSecuritySetup.java b/src/main/java/stirling/software/SPDF/config/security/InitialSecuritySetup.java
@@ -1,6 +1,6 @@
 package stirling.software.SPDF.config.security;
 
-import java.io.IOException;
+import java.sql.SQLException;
 import java.util.UUID;
 
 import org.springframework.beans.factory.annotation.Autowired;
@@ -11,6 +11,7 @@
 import stirling.software.SPDF.config.interfaces.DatabaseInterface;
 import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.Role;
+import stirling.software.SPDF.model.provider.UnsupportedProviderException;
 
 @Slf4j
 @Component
@@ -31,13 +32,13 @@ public void init() {
 
             userService.migrateOauth2ToSSO();
             initializeInternalApiUser();
-        } catch (IllegalArgumentException | IOException e) {
+        } catch (IllegalArgumentException | SQLException | UnsupportedProviderException e) {
             log.error("Failed to initialize security setup.", e);
             System.exit(1);
         }
     }
 
-    private void initializeAdminUser() throws IOException {
+    private void initializeAdminUser() throws SQLException, UnsupportedProviderException {
         String initialUsername =
                 applicationProperties.getSecurity().getInitialLogin().getUsername();
         String initialPassword =
@@ -55,7 +56,7 @@ private void initializeAdminUser() throws IOException {
         }
     }
 
-    private void createDefaultAdminUser() throws IOException {
+    private void createDefaultAdminUser() throws SQLException, UnsupportedProviderException {
         String defaultUsername = "admin";
         String defaultPassword = "stirling";
 
@@ -65,7 +66,8 @@ private void createDefaultAdminUser() throws IOException {
         }
     }
 
-    private void initializeInternalApiUser() throws IllegalArgumentException, IOException {
+    private void initializeInternalApiUser()
+            throws IllegalArgumentException, SQLException, UnsupportedProviderException {
         if (!userService.usernameExistsIgnoreCase(Role.INTERNAL_API_USER.getRoleId())) {
             userService.saveUser(
                     Role.INTERNAL_API_USER.getRoleId(),

diff --git a/src/main/java/stirling/software/SPDF/config/security/UserService.java b/src/main/java/stirling/software/SPDF/config/security/UserService.java
@@ -1,6 +1,6 @@
 package stirling.software.SPDF.config.security;
 
-import java.io.IOException;
+import java.sql.SQLException;
 import java.util.*;
 import java.util.stream.Collectors;
 
@@ -25,11 +25,8 @@
 import stirling.software.SPDF.config.security.saml2.CustomSaml2AuthenticatedPrincipal;
 import stirling.software.SPDF.config.security.session.SessionPersistentRegistry;
 import stirling.software.SPDF.controller.api.pipeline.UserServiceInterface;
-import stirling.software.SPDF.model.ApplicationProperties;
-import stirling.software.SPDF.model.AuthenticationType;
-import stirling.software.SPDF.model.Authority;
-import stirling.software.SPDF.model.Role;
-import stirling.software.SPDF.model.User;
+import stirling.software.SPDF.model.*;
+import stirling.software.SPDF.model.provider.UnsupportedProviderException;
 import stirling.software.SPDF.repository.AuthorityRepository;
 import stirling.software.SPDF.repository.UserRepository;
 
@@ -64,7 +61,7 @@ public void migrateOauth2ToSSO() {
 
     // Handle OAUTH2 login and user auto creation.
     public boolean processSSOPostLogin(String username, boolean autoCreateUser)
-            throws IllegalArgumentException, IOException {
+            throws IllegalArgumentException, SQLException, UnsupportedProviderException {
         if (!isUsernameValid(username)) {
             return false;
         }
@@ -151,12 +148,12 @@ public boolean validateApiKeyForUser(String username, String apiKey) {
     }
 
     public void saveUser(String username, AuthenticationType authenticationType)
-            throws IllegalArgumentException, IOException {
+            throws IllegalArgumentException, SQLException, UnsupportedProviderException {
         saveUser(username, authenticationType, Role.USER.getRoleId());
     }
 
     public void saveUser(String username, AuthenticationType authenticationType, String role)
-            throws IllegalArgumentException, IOException {
+            throws IllegalArgumentException, SQLException, UnsupportedProviderException {
         if (!isUsernameValid(username)) {
             throw new IllegalArgumentException(getInvalidUsernameMessage());
         }
@@ -171,7 +168,7 @@ public void saveUser(String username, AuthenticationType authenticationType, Str
     }
 
     public void saveUser(String username, String password)
-            throws IllegalArgumentException, IOException {
+            throws IllegalArgumentException, SQLException, UnsupportedProviderException {
         if (!isUsernameValid(username)) {
             throw new IllegalArgumentException(getInvalidUsernameMessage());
         }
@@ -185,7 +182,7 @@ public void saveUser(String username, String password)
     }
 
     public void saveUser(String username, String password, String role, boolean firstLogin)
-            throws IllegalArgumentException, IOException {
+            throws IllegalArgumentException, SQLException, UnsupportedProviderException {
         if (!isUsernameValid(username)) {
             throw new IllegalArgumentException(getInvalidUsernameMessage());
         }
@@ -201,7 +198,7 @@ public void saveUser(String username, String password, String role, boolean firs
     }
 
     public void saveUser(String username, String password, String role)
-            throws IllegalArgumentException, IOException {
+            throws IllegalArgumentException, SQLException, UnsupportedProviderException {
         saveUser(username, password, role, false);
     }
 
@@ -235,7 +232,7 @@ public boolean hasUsers() {
     }
 
     public void updateUserSettings(String username, Map<String, String> updates)
-            throws IOException {
+            throws SQLException, UnsupportedProviderException {
         Optional<User> userOpt = findByUsernameIgnoreCaseWithSettings(username);
         if (userOpt.isPresent()) {
             User user = userOpt.get();
@@ -270,7 +267,7 @@ public Authority findRole(User user) {
     }
 
     public void changeUsername(User user, String newUsername)
-            throws IllegalArgumentException, IOException {
+            throws IllegalArgumentException, SQLException, UnsupportedProviderException {
         if (!isUsernameValid(newUsername)) {
             throw new IllegalArgumentException(getInvalidUsernameMessage());
         }
@@ -279,26 +276,30 @@ public void changeUsername(User user, String newUsername)
         databaseService.exportDatabase();
     }
 
-    public void changePassword(User user, String newPassword) throws IOException {
+    public void changePassword(User user, String newPassword)
+            throws SQLException, UnsupportedProviderException {
         user.setPassword(passwordEncoder.encode(newPassword));
         userRepository.save(user);
         databaseService.exportDatabase();
     }
 
-    public void changeFirstUse(User user, boolean firstUse) throws IOException {
+    public void changeFirstUse(User user, boolean firstUse)
+            throws SQLException, UnsupportedProviderException {
         user.setFirstLogin(firstUse);
         userRepository.save(user);
         databaseService.exportDatabase();
     }
 
-    public void changeRole(User user, String newRole) throws IOException {
+    public void changeRole(User user, String newRole)
+            throws SQLException, UnsupportedProviderException {
         Authority userAuthority = this.findRole(user);
         userAuthority.setAuthority(newRole);
         authorityRepository.save(userAuthority);
         databaseService.exportDatabase();
     }
 
-    public void changeUserEnabled(User user, Boolean enbeled) throws IOException {
+    public void changeUserEnabled(User user, Boolean enbeled)
+            throws SQLException, UnsupportedProviderException {
         user.setEnabled(enbeled);
         userRepository.save(user);
         databaseService.exportDatabase();
@@ -391,7 +392,8 @@ public String getCurrentUsername() {
     }
 
     @Transactional
-    public void syncCustomApiUser(String customApiKey) throws IOException {
+    public void syncCustomApiUser(String customApiKey)
+            throws SQLException, UnsupportedProviderException {
         if (customApiKey == null || customApiKey.trim().length() == 0) {
             return;
         }

diff --git a/src/main/java/stirling/software/SPDF/config/security/database/DatabaseService.java b/src/main/java/stirling/software/SPDF/config/security/database/DatabaseService.java
@@ -27,6 +27,7 @@
 
 import lombok.extern.slf4j.Slf4j;
 import stirling.software.SPDF.config.interfaces.DatabaseInterface;
+import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.provider.UnsupportedProviderException;
 import stirling.software.SPDF.utils.FileInfo;
 
@@ -104,7 +105,7 @@ private void importDatabaseFromUI(Path tempTemplatePath) throws IOException {
     }
 
     @Override
-    public void exportDatabase() {
+    public void exportDatabase() throws SQLException, UnsupportedProviderException {
         // Filter and delete old backups if there are more than 5
         List<FileInfo> filteredBackupList =
                 this.getBackupList().stream()
@@ -127,8 +128,10 @@ public void exportDatabase() {
             log.info("Database export completed: {}", insertOutputFilePath);
         } catch (SQLException | UnsupportedProviderException e) {
             log.error("Error during database export: {}", e.getMessage(), e);
+            throw e;
         } catch (ScriptException e) {
             log.error("Error during database export: File {} not found", insertOutputFilePath);
+            throw e;
         }
     }
 
@@ -149,17 +152,26 @@ private static void deleteOldestBackup(List<FileInfo> filteredBackupList) {
     // Retrieves the H2 database version.
     public String getH2Version() {
         String version = "Unknown";
-        try (Connection conn = databaseConfig.connection()) {
-            try (Statement stmt = conn.createStatement();
-                    ResultSet rs = stmt.executeQuery("SELECT H2VERSION() AS version")) {
-                if (rs.next()) {
-                    version = rs.getString("version");
-                    log.info("H2 Database Version: {}", version);
+
+        if (databaseConfig
+                .getApplicationProperties()
+                .getSystem()
+                .getDatasource()
+                .getType()
+                .equals(ApplicationProperties.Driver.H2.name())) {
+            try (Connection conn = databaseConfig.connection()) {
+                try (Statement stmt = conn.createStatement();
+                        ResultSet rs = stmt.executeQuery("SELECT H2VERSION() AS version")) {
+                    if (rs.next()) {
+                        version = rs.getString("version");
+                        log.info("H2 Database Version: {}", version);
+                    }
                 }
+            } catch (SQLException | UnsupportedProviderException e) {
+                log.error("Error retrieving H2 version: {}", e.getMessage(), e);
             }
-        } catch (SQLException | UnsupportedProviderException e) {
-            log.error("Error retrieving H2 version: {}", e.getMessage(), e);
         }
+
         return version;
     }
 

diff --git a/src/main/java/stirling/software/SPDF/config/security/database/ScheduledTasks.java b/src/main/java/stirling/software/SPDF/config/security/database/ScheduledTasks.java
@@ -1,18 +1,20 @@
 package stirling.software.SPDF.config.security.database;
 
-import java.io.IOException;
+import java.sql.SQLException;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.scheduling.annotation.Scheduled;
 import org.springframework.stereotype.Component;
 
+import stirling.software.SPDF.model.provider.UnsupportedProviderException;
+
 @Component
 public class ScheduledTasks {
 
     @Autowired private DatabaseService databaseService;
 
     @Scheduled(cron = "0 0 0 * * ?")
-    public void performBackup() throws IOException {
+    public void performBackup() throws SQLException, UnsupportedProviderException {
         databaseService.exportDatabase();
     }
 }
diff --git a/...irling/software/SPDF/config/security/oauth2/CustomOAuth2AuthenticationSuccessHandler.java b/...irling/software/SPDF/config/security/oauth2/CustomOAuth2AuthenticationSuccessHandler.java
@@ -1,6 +1,7 @@
 package stirling.software.SPDF.config.security.oauth2;
 
 import java.io.IOException;
+import java.sql.SQLException;
 
 import org.springframework.security.authentication.LockedException;
 import org.springframework.security.core.Authentication;
@@ -18,6 +19,7 @@
 import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.ApplicationProperties.Security.OAUTH2;
 import stirling.software.SPDF.model.AuthenticationType;
+import stirling.software.SPDF.model.provider.UnsupportedProviderException;
 import stirling.software.SPDF.utils.RequestUriUtils;
 
 public class CustomOAuth2AuthenticationSuccessHandler
@@ -97,10 +99,8 @@ public void onAuthenticationSuccess(
                     userService.processSSOPostLogin(username, oAuth.getAutoCreateUser());
                 }
                 response.sendRedirect(contextPath + "/");
-                return;
-            } catch (IllegalArgumentException e) {
+            } catch (IllegalArgumentException | SQLException | UnsupportedProviderException e) {
                 response.sendRedirect(contextPath + "/logout?invalidUsername=true");
-                return;
             }
         }
     }

diff --git a/...stirling/software/SPDF/config/security/saml2/CustomSaml2AuthenticationSuccessHandler.java b/...stirling/software/SPDF/config/security/saml2/CustomSaml2AuthenticationSuccessHandler.java
@@ -1,6 +1,7 @@
 package stirling.software.SPDF.config.security.saml2;
 
 import java.io.IOException;
+import java.sql.SQLException;
 
 import org.springframework.security.authentication.LockedException;
 import org.springframework.security.core.Authentication;
@@ -18,6 +19,7 @@
 import stirling.software.SPDF.model.ApplicationProperties;
 import stirling.software.SPDF.model.ApplicationProperties.Security.SAML2;
 import stirling.software.SPDF.model.AuthenticationType;
+import stirling.software.SPDF.model.provider.UnsupportedProviderException;
 import stirling.software.SPDF.utils.RequestUriUtils;
 
 @AllArgsConstructor
@@ -115,6 +117,9 @@ public void onAuthenticationSuccess(
                             username);
                     response.sendRedirect(contextPath + "/logout?invalidUsername=true");
                     return;
+                } catch (SQLException | UnsupportedProviderException e) {
+                    log.error("Error, redirecting to logout", e);
+                    response.sendRedirect(contextPath + "/logout?error=true");
                 }
             }
         } else {