Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 1.99 KB

README.md

File metadata and controls

79 lines (51 loc) · 1.99 KB
Raw

gnupg-cryptomator

This project is fork from https://github.com/purejava/keepassxc-cryptomator , add GnuPG support

GitHub Release License

Plug-in for Cryptomator to store vault passwords with GnuPG encryption.

Build Project

Requirement:

  • JDK 17 or later
  • Maven 3.8.4 or later
mvn package

Copy packaged plugin from target/gnupg-cryptomator-$VERSION.jar to Cryptomator plugins directory.

Usage reference Wiki

Configuration

Configure file location:

  • /etc/cryptomator/config.json
  • ~/.config/cryptomator/config.json
{
  "gnuPgCommand": "/usr/local/bin/gpg",
  "keyId": "FFFFFFFFFFFFFFFFFFFF"
}

gnuPgCommand GnuPG command path, find it by which gpg
keyId is GnuPG key ID, you can find it by gpg -K
encryptKeyBasePath is key store path, default value is $USER_HOME/.config/cryptomator/keys/

Documentation

For documentation please take a look at the Wiki.

How it works?

This plugin use GnuPG encrypt and decrypt passwords.

Check GnuPG available

Run gpg, expect exit code is 0

gpg --version

Encrypt with GnuPG

Run gpg -e to encrypt texts, gpg read plaintext from std in, and write ciphertext to std out.

echo -n PLAINTEXT | gpg -e -a

Decrypt with GnuPG

Run gpg -d to decrypt texts, gpg read ciphertext from std in, and write plaintext to std out.

echo -n CIPHERTEXT | gpg -d

Copyright

Copyright (C) 2021-2024 Ralph Plawetzki
Copyright (C) 2024-2024 Hatter Jiang

The Cryptomator logo is Copyright (C) of https://cryptomator.org/
The KeePassXC logo is Copyright (C) of https://keepassxc.org/