Skip to content
Ralph Plawetzki edited this page Nov 30, 2021 · 32 revisions

Usage

keepassxc-cryptomator is a plugin that extends the functionality of Cryptomator. With this plugin configured, Cryptomator can use a KeePassXC database as a backend to store and retrieve passwords for vaults:

Development status

The plugin is feature complete.

Releases

Updated versions of keepassxc-cryptomator are published as releases in this same GitHub repository.

Below each release, in the Assets section, there is a jar-file called keepassxc-cryptomator-RELEASE_TAG.jar that is the ready-to-use plugin.

Internals

The plugin is implemented as an uber-jar that consists of a couple of jar files - its dependencies:

[INFO] Replacing /home/runner/work/keepassxc-cryptomator/keepassxc-cryptomator/target/keepassxc-cryptomator-0.0.3.jar with /home/runner/work/keepassxc-cryptomator/keepassxc-cryptomator/target/keepassxc-cryptomator-0.0.3-shaded.jar

The jar-file keepassxc-cryptomator-RELEASE_TAG.jar just needs to be copied to Cryptomator which enables and configures the plugin for Cryptomator. The steps for different environments are described below.

Plug it in Cryptomator

Cryptomator installations on Mac, Linux and Windows

With PR 1759 Cryptomator introduces a configurable pluginDir, where the plugin can be copied into.

This functionality can be used since Cryptomator release 1.6.0 Beta 2.

The default values for the pluginDir on an unchanged Crytomator installation on the different operating systems are:

OS Default Dir
Mac ~/Library/Application Support/Cryptomator/Plugins
Linux ~/.local/share/Cryptomator/plugins
Windows %homepath%\AppData\Roaming\Cryptomator\Plugins

Copy the plugin file into the appropriate directory and start Cryptomator. That's all. The new password backend can be choosen on the General tab of the Cryptomator Preferences as shown in the screenshot above.

Development

When Cryptomator has been compiled via the CLI with mvn clean install, a target/libs folder gets created. The plugin file just needs to be copied to the target/libs folder and your are good to go.

Just start the according launcher-script that is right for your operating system.

Update - this does not work at the moment due to PR 1744, as there is no working launcher-script at the moment.

Check out the integrity of the downloaded plugin

Plugin releases are signed. It is wise and more secure to check out for their integrity.

Integrity check

You can check that the version of the keepassxc-cryptomator plugin that you want to install is original and unmodified by verifying the file's signature.

Verifying the file's signature

For example, to check the signature of the file keepassxc-cryptomator-0.0.3.jar, you can use this command:

$ gpg --verify keepassxc-cryptomator-0.0.3.jar.sig keepassxc-cryptomator-0.0.3.jar

You should sees something like the following output:

gpg: Signature made Sun Oct 10 16:04:47 2021 CEST
gpg:                using RSA key A9C262832A8C5408D3DBF3A9884A9D5F00094C9C
gpg: Good signature from "Ralph Plawetzki <ralph@purejava.org>" [ultimate]

If you are missing the signing key to verify the download, you can get it from a keyserver.

Clone this wiki locally