History

Darren Clarke 0e0f081a79 PGP build fixes		2023-05-10 11:10:32 +00:00
..
src	PGP build fixes	2023-05-10 11:10:32 +00:00
package.json	PGP build fixes	2023-05-10 11:10:32 +00:00
README.md	Organize directories	2023-02-13 13:10:48 +00:00

README.md

zammad-addon-pgp

Adds PGP integration into Zammad via Sequoia.

Configuration

Once PGP addon has been successfully installed, there are a few steps required to set it up for use. This is also assuming that Zammad has already been correctly configured for sending and receiving email, and that you have command-line access to a system with the gnupg client installed for generating and manipulating keys.

For Thunderbird users

If you generated and manage your key through a current version of Thunderbird (see here for general information on how to generate keys and use PGP in versions of Thunderbird 78 and above), you will need to use the following steps to prepare for the instructions below assuming you already have a key:

Go to Account Settings -> End-To-End Encryption for the relevant account and click the 'OpenPGP Key Manager' button to access the key manager.
Click the relevant key and select File -> Backup Secret Key(s) to File and select a place to save the key file.
It will ask you to set a passphrase for the key, make sure to note this down for use below.
After the key has been saved to a file, go to that file in a terminal and run gpg --import <key file>. It will ask you for the passphrase you just set.
Go to #2 below and continue with the instructions.

Generate helpdesk key

In order to receive encrypted email, the Zammad helpdesk must have a PGP key associated with its email address. You can follow the instructions here in order to generate such a key if you do not already have one; when you get to the step where you enter your email address, use the email address associated with your Zammad installation.

Generate the key, using the instructions above. Make a note of the corresponding keyid.
You'll need to remove the passphrase from the private key before adding it to Zammad. To do this, edit the key: gpg --edit-key <keyid>
In the resulting prompt, type passwd. Enter the passphrasse you set during key generation, and when you are prompted for a new passphrase just leave it blank and hit 'enter' twice and confirm.
As an admin user, go to the Zammad settings panel and under Channels -> PGP Support and click the Add Key button at the top.
In your terminal, export the private key with gpg --export-secret-key --armor <keyid> and paste the entire resulting text block including the header and footer into the box for the private key. Do the same for the public key box by exporting with gpg --export --armor <keyid>. Select the group the key is associated with ('Users' by default).
Submit the changes

Now your helpdesk is configured to accept encrypted email!

Set user keys

In order to send an encrypted reply to a user who has submitted a ticket, they must have a public key configured. Either that user or an admin can go to settings under Manage -> Users, select the user account, and paste their public key in the PGP Public Key box. The key can be exported by the user by running gpg --export --armor <keyid>, where is the keyid of the key associated with the email address with which they are sending an email to the helpdesk. Then submit the changes.

The helpdesk can now send encrypted email to that user!

Help and Support

Join us in our public matrix channel #cdr-link-dev-support:matrix.org.

License

This is a free software project licensed under the GNU Affero General Public License v3.0 (GNU AGPLv3) by The Center for Digital Resilience and Guardian Project.

🤸