feat: v1.0.0-SNAPSHOT, support GnuPG

Author: jht5945

.gitignore

@@ -1,9 +1,11 @@
+.DS_Store
 *.class
 *.jar
 
 # Maven #
 target/
 pom.xml.versionsBackup
+dependency-reduced-pom.xml
 
 # IntelliJ Settings Files (https://intellij-support.jetbrains.com/hc/en-us/articles/206544839-How-to-manage-projects-under-Version-Control-Systems) #
 .idea/**/workspace.xml

LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
 Copyright (c) 2021-2024 Ralph Plawetzki
+Copyright (c) 2024-2024 Hatter Jiang
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,24 +1,44 @@
-# keepassxc-cryptomator
-![keepassxc-cryptomator](keepassxc-cryptomator.svg)
+# gnupg-cryptomator
+
+> This project is fork from https://github.com/purejava/keepassxc-cryptomator , add GnuPG support
 
-[![Java CI with Maven](https://github.com/purejava/keepassxc-cryptomator/workflows/Java%20CI%20with%20Maven/badge.svg)](https://github.com/purejava/keepassxc-cryptomator/actions?query=workflow%3A%22Java+CI+with+Maven%22)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f092de6bfd99450f8a9a2766ed01c3c1)](https://app.codacy.com/gh/purejava/keepassxc-cryptomator?utm_source=github.com&utm_medium=referral&utm_content=purejava/keepassxc-cryptomator&utm_campaign=Badge_Grade_Settings)
 [![GitHub Release](https://img.shields.io/github/v/release/purejava/keepassxc-cryptomator)](https://github.com/purejava/keepassxc-cryptomator/releases)
 [![License](https://img.shields.io/github/license/purejava/keepassxc-cryptomator.svg)](https://github.com/purejava/keepassxc-cryptomator/blob/master/LICENSE)
-[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate?hosted_button_id=XVX9ZM7WE4ANL)
 
-Plug-in for Cryptomator to store vault passwords in KeePassXC
+Plug-in for Cryptomator to store vault passwords with GnuPG encryption.
 
-# Documentation
-For documentation please take a look at the [Wiki](https://github.com/purejava/keepassxc-cryptomator/wiki).
+# Build Project
+
+Requirement:
+
+* JDK 17 or later
+* Maven 3.8.4 or later
+
+```shell
+mvn package
+```
+
+Copy plugin in `target/gnupg-cryptomator-1.0.0-SNAPSHOT.jar` to Cryptomator plugins dir.
+> Usage reference [Wiki](https://github.com/purejava/keepassxc-cryptomator/wiki)
 
-# Donation
-If you like this project, you can give me a cup of coffee :)
+# Configuration
 
-[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate?hosted_button_id=XVX9ZM7WE4ANL)
+Config file location:
+
+* `/etc/cryptomator/config.json`
+* `~/.config/cryptomator/config.json`
+
+Keys will store in directory:
+`~/.config/cryptomator/keys/`
+
+# Documentation
+
+For documentation please take a look at the [Wiki](https://github.com/purejava/keepassxc-cryptomator/wiki).
 
 # Copyright
+
 Copyright (C) 2021-2024 Ralph Plawetzki
+Copyright (C) 2024-2024 Hatter Jiang
 
 The Cryptomator logo is Copyright (C) of https://cryptomator.org/
 

build.json

@@ -0,0 +1,7 @@
+{
+    "java": "17",
+    "builder": {
+        "name": "maven",
+        "version": "3.8.4"
+    }
+}

pom.xml

@@ -3,13 +3,13 @@
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
-  <groupId>org.purejava</groupId>
-  <artifactId>keepassxc-cryptomator</artifactId>
-  <version>1.2.6-SNAPSHOT</version>
+  <groupId>me.hatter</groupId>
+  <artifactId>gnupg-cryptomator</artifactId>
+  <version>1.0.0-SNAPSHOT</version>
 
-  <name>keepassxc-cryptomator</name>
-  <description>Plug-in for Cryptomator to store vault passwords in KeePassXC</description>
-  <url>https://github.com/purejava/keepassxc-cryptomator/</url>
+  <name>gnupg-cryptomator</name>
+  <description>Plug-in for Cryptomator to store vault passwords with GnuPG encryption.</description>
+  <url>https://github.com/jht5945/gnupg-cryptomator/</url>
 
   <licenses>
     <license>
@@ -26,12 +26,19 @@
       <organization/>
       <organizationUrl>https://github.com/purejava</organizationUrl>
     </developer>
+    <developer>
+      <name>Hatter Jiang</name>
+      <email>jht5945@gmail.com</email>
+      <timezone>+8</timezone>
+      <organization/>
+      <organizationUrl>https://github.com/jht5945</organizationUrl>
+    </developer>
   </developers>
 
   <scm>
-    <connection>scm:git:git@github.com:purejava/keepassxc-cryptomator.git</connection>
-    <developerConnection>scm:git:git@github.com:purejava/keepassxc-cryptomator.git</developerConnection>
-    <url>git@github.com:purejava/keepassxc-cryptomator.git</url>
+    <connection>scm:git:git@github.com:jht5945/gnupg-cryptomator.git</connection>
+    <developerConnection>scm:git:git@github.com:jht5945/gnupg-cryptomator.git</developerConnection>
+    <url>git@github.com:jht5945/gnupg-cryptomator.git</url>
   </scm>
 
   <distributionManagement>
@@ -52,6 +59,7 @@
     <api.version>1.3.1</api.version>
     <keepassxc-proxy.version>1.2.5</keepassxc-proxy.version>
     <guava.version>33.2.1-jre</guava.version>
+    <gson.version>2.11.0</gson.version>
     <slf4j.version>2.0.13</slf4j.version>
     <junit.version>5.10.2</junit.version>
   </properties>
@@ -78,6 +86,11 @@
       <artifactId>guava</artifactId>
       <version>${guava.version}</version>
     </dependency>
+    <dependency>
+      <groupId>com.google.code.gson</groupId>
+      <artifactId>gson</artifactId>
+      <version>${gson.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.purejava</groupId>
       <artifactId>keepassxc-proxy-access</artifactId>

src/main/java/me/hatter/integrations/keychain/GnuPGAccessProvider.java

@@ -0,0 +1,81 @@
+package me.hatter.integrations.keychain;
+
+import org.cryptomator.integrations.keychain.KeychainAccessException;
+import org.cryptomator.integrations.keychain.KeychainAccessProvider;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * @author hatterjiang
+ */
+public class GnuPGAccessProvider implements KeychainAccessProvider {
+
+    private static final Logger LOG = LoggerFactory.getLogger(GnuPGAccessProvider.class);
+
+    private GnuPGConfig gnuPGConfig;
+
+    public GnuPGAccessProvider() {
+        try {
+            gnuPGConfig = Utils.loadGnuPGConfig();
+            if (!Utils.checkGnuPGReady(gnuPGConfig)) {
+                LOG.error("Check GnuPG command failed");
+                gnuPGConfig = null;
+            }
+        } catch (KeychainAccessException e) {
+            gnuPGConfig = null;
+            LOG.error("Load GnuPG config failed", e);
+        }
+    }
+
+    @Override
+    public String displayName() {
+        return "GnuPG";
+    }
+
+    @Override
+    public boolean isSupported() {
+        return gnuPGConfig != null;
+    }
+
+    @Override
+    public boolean isLocked() {
+        // No lock status
+        return false;
+    }
+
+    @Override
+    public void storePassphrase(String vault, CharSequence password) throws KeychainAccessException {
+        storePassphrase(vault, "Vault", password);
+    }
+
+    @Override
+    public void storePassphrase(String vault, String name, CharSequence password) throws KeychainAccessException {
+        Utils.storePassword(gnuPGConfig, vault, name, password);
+    }
+
+    @Override
+    public char[] loadPassphrase(String vault) throws KeychainAccessException {
+        final String password = Utils.loadPassword(gnuPGConfig, vault);
+        return password.toCharArray();
+    }
+
+    @Override
+    public void deletePassphrase(String vault) throws KeychainAccessException {
+        if (isLocked()) {
+            LOG.info("Failed to delete password. KeePassXC database is locked. Needs to be unlocked first.");
+            return;
+        }
+        Utils.deletePassword(gnuPGConfig, vault);
+    }
+
+    @Override
+    public void changePassphrase(String vault, CharSequence password) throws KeychainAccessException {
+        changePassphrase(vault, "Vault", password);
+    }
+
+    @Override
+    public void changePassphrase(String vault, String name, CharSequence password) throws KeychainAccessException {
+        LOG.info("Change password for: " + vault);
+        Utils.storePassword(gnuPGConfig, vault, name, password);
+    }
+}

src/main/java/me/hatter/integrations/keychain/GnuPGConfig.java

@@ -0,0 +1,45 @@
+package me.hatter.integrations.keychain;
+
+/**
+ * GnuPG config
+ *
+ * @author hatterjiang
+ */
+public class GnuPGConfig {
+    /**
+     * REQUIRED, GnuPG key ID
+     */
+    private String keyId;
+    /**
+     * OPTIONAL, GnuPG command path, default "gpg"
+     */
+    private String gnuPgCommand;
+    /**
+     * OPTIONAL, Encrypt key base path, default "~/.config/cryptomator/keys/"
+     */
+    private String encryptKeyBasePath;
+
+    public String getKeyId() {
+        return keyId;
+    }
+
+    public void setKeyId(String keyId) {
+        this.keyId = keyId;
+    }
+
+    public String getGnuPgCommand() {
+        return gnuPgCommand;
+    }
+
+    public void setGnuPgCommand(String gnuPgCommand) {
+        this.gnuPgCommand = gnuPgCommand;
+    }
+
+    public String getEncryptKeyBasePath() {
+        return encryptKeyBasePath;
+    }
+
+    public void setEncryptKeyBasePath(String encryptKeyBasePath) {
+        this.encryptKeyBasePath = encryptKeyBasePath;
+    }
+}