Add method to manually close the connection to the KeePassXC database

Author: purejava

src/main/java/org/keepassxc/Connection.java

@@ -92,6 +92,11 @@ public void run() {
                     if (errorCount > MAX_ERROR_COUNT) {
                         log.info("Too much errors - stopping MessagePublisher");
                         doStop();
+                        try {
+                            close();
+                        } catch (Exception e) {
+                            log.error(e.toString(), e.getCause());
+                        }
                         reconnect();
                     }
                 }

src/main/java/org/keepassxc/LinuxMacConnection.java

@@ -120,13 +120,13 @@ private String getSocketPath() {
 
     @Override
     protected boolean isConnected() {
-        return null!= socket && socket.isOpen();
+        return null != socket && socket.isOpen();
     }
 
     @Override
     public void close() throws Exception {
-        messagePublisher.doStop();
+        if (null != messagePublisher) messagePublisher.doStop();
         executorService.shutdown();
-        socket.close();
+        if (isConnected()) socket.close();
     }
 }

src/main/java/org/keepassxc/WindowsConnection.java

@@ -87,13 +87,13 @@ protected JSONObject getCleartextResponse() {
 
     @Override
     protected boolean isConnected() {
-        return null != pipe;
+        return null != pipe && pipe.isOpen();
     }
 
     @Override
     public void close() throws Exception {
-        messagePublisher.doStop();
+        if (null != messagePublisher) messagePublisher.doStop();
         executorService.shutdown();
-        pipe.close();
+        if (isConnected()) pipe.close();
     }
 }

src/main/java/org/purejava/KeepassProxyAccess.java

@@ -56,8 +56,14 @@ public KeepassProxyAccess() {
         }
         scheduler = Executors.newSingleThreadScheduledExecutor();
         connection.addPropertyChangeListener(this);
-        Runtime.getRuntime().addShutdownHook(new Thread(() ->
-                connection.removePropertyChangeListener(this)
+        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
+                connection.removePropertyChangeListener(this);
+            try {
+                closeConnection();
+            } catch (Exception e) {
+                log.error(e.toString(), e.getCause());
+            }
+        }
         ));
         connection.setCredentials(loadCredentials());
     }
@@ -489,6 +495,21 @@ public String getAssociateId() {
         return connection.getAssociateId();
     }
 
+    /**
+     * Close the connection to the socket (for Linux and Mac) or the named pip (for Windows) respectively.
+     *
+     * @return True, in case the connection was closed without an error, false otherwise.
+     */
+    public boolean closeConnection() {
+        try {
+            connection.close();
+            return true;
+        } catch (Exception e) {
+            log.error(e.toString(), e.getCause());
+            return false;
+        }
+    }
+
     /**
      * Getter for the ScheduledExecutorService in case the service needs to be shutdown from outside this library.
      *

src/test/java/org/purejava/KeepassProxyAccessTest.java

@@ -5,6 +5,7 @@
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 /**
  * This test is designed to run within CI, where a KeePassXC database is not available.
@@ -17,5 +18,6 @@ public class KeepassProxyAccessTest {
     @DisplayName("Testing availability of a socket to KeePassXC")
     public void shouldHaveNoErrors() {
         assertFalse(kpa.connect());
+        assertTrue(kpa.closeConnection());
     }
 }

src/test/java/org/purejava/LockedDatabaseTest.java

@@ -18,5 +18,6 @@ public class LockedDatabaseTest {
     public void shouldHaveNoErrors() {
         assertTrue(kpa.connect());
         assertTrue(kpa.getDatabasehash().isEmpty());
+        assertTrue(kpa.closeConnection());
     }
 }

src/test/java/org/purejava/UnlockedDatabaseTest.java

@@ -23,7 +23,7 @@ public class UnlockedDatabaseTest {
     @Test
     @Order(3)
     @DisplayName("Testing KeePassXC proxy functionality")
-    public void shouldHaveNoErrors() throws InterruptedException {
+    public void shouldHaveNoErrors() throws Exception {
         log.info("Please enter a name for the connection in the pop-up within 10 seconds");
         assertTrue(kpa.connect());
         // TODO:
@@ -52,5 +52,6 @@ public void shouldHaveNoErrors() throws InterruptedException {
         assertTrue(kpa.deleteEntry("2aafee1a89fd435c8bad7df12bbaaa3e"));
         log.info("Please deny to save changes");
         assertTrue(kpa.lockDatabase());
+        assertTrue(kpa.closeConnection());
     }
 }