From 2965a981b7ec22866fbdf2d567d87e2d068d3617 Mon Sep 17 00:00:00 2001
From: Thomas Bruederli <thomas@roundcube.net>
Date: Fri, 31 Jul 2015 16:04:08 -0400
Subject: [PATCH] Allow to search and import missing PGP pubkeys from keyservers using Publickey.js

---
 plugins/enigma/README |   53 ++++++++++++++++++++++++++++++++---------------------
 1 files changed, 32 insertions(+), 21 deletions(-)

diff --git a/plugins/enigma/README b/plugins/enigma/README
index 3026b84..0566069 100644
--- a/plugins/enigma/README
+++ b/plugins/enigma/README
@@ -1,37 +1,38 @@
-------------------------------------------------------------------
-THIS IS NOT EVEN AN "ALPHA" STATE. USE ONLY FOR DEVELOPMENT!!!!!!!
-------------------------------------------------------------------
+Enigma Plugin for Roundcube
 
-WARNING: Don't use with gnupg-2.x!
+This plugin adds support for viewing and sending of signed and encrypted
+messages in PGP (RFC 2440) and PGP/MIME (RFC 3156) format.
 
-Plugin Status:
+The plugin uses gpg binary on the server and stores all keys
+(including private keys of the users) on the server.
+Encryption/decryption is done server-side. So, this plugin
+is for users that trust the server.
 
-+ PGP: signed messages verification
+WARNING! The plugin is in very early state. See below for a list
+of missing features and known issues.
+
+
+Implemented features:
+---------------------
++ PGP: signatures verification
 + PGP: messages decryption
++ PGP: Sending of encrypted/signed messages
 + PGP: keys management UI (keys import and delete)
 + Handling of PGP keys attached to incoming messages
++ User preferences to disable plugin features
 
 TODO (must have):
-
-- Fix issues with enabled messages_cache
-- PGP: Sending of encrypted/signed messages
-- Per-Identity settings (including keys/certs)
-- Test/Make working with gnupg-2.x
+-----------------
 - Keys export to file
 - Disable Reply/Forward options when viewing encrypted messages
   until they are decrypted successfully
-- Handling of replying/forwarding of encrypted messages
-- Add composer.json file
-- Performance improvements:
-   - cache decrypted message key id in cache so we can skip
-     decryption if we have no password in session
-   - cache sig verification status to not verify on every msg preview (optional)
+- Handling of replying/forwarding of encrypted/signed messages
+- Client-side keys generation (with OpenPGP.js?)
 
 TODO (later):
-
+-------------
 - Handling of big messages with temp files
 - Server-side keys generation (warning: no-entropy issue, max_execution_time issue)
-- Client-side keys generation (with OpenPGP.js?)
 - Key info in contact details page (optional)
 - Extended key management:
    - disable,
@@ -43,9 +44,12 @@
 - Key server(s) support (search, import, upload, refresh)
 - Attaching public keys to email
 - Mark keys as trusted/untrasted, display appropriate message in verify/decrypt status
-- User-preferences to disable signature verification, decrypting, encrypting or all enigma features
 - Change attachment icon on messages list for encrypted messages (like vcard_attachment plugin does)
-
+- Support for multi-server installations (store keys in sql database?)
+- Per-Identity settings (including keys/certs)
+- Performance improvements:
+   - cache decrypted message key id so we can skip decryption if we have no password in session
+   - cache (last or successful only?) sig verification status to not verify on every msg preview (optional)
 - S/MIME: Certs generation
 - S/MIME: Certs management
 - S/MIME: signed messages verification
@@ -53,3 +57,10 @@
 - S/MIME: Sending signed/encrypted messages
 - S/MIME: Handling of certs attached to incoming messages
 - S/MIME: Certificate info in Contacts details page (optional)
+
+Known issues:
+-------------
+1. There are Crypt_GPG issues when using gnupg >= 2.0
+   - http://pear.php.net/bugs/bug.php?id=19914
+   - http://pear.php.net/bugs/bug.php?id=20453
+   - http://pear.php.net/bugs/bug.php?id=20527

--
Gitblit v1.9.1