From a3644638aaf0418598196a870204e0b632a4c8ad Mon Sep 17 00:00:00 2001
From: Thomas Bruederli <thomas@roundcube.net>
Date: Fri, 17 Apr 2015 06:28:40 -0400
Subject: [PATCH] Allow preference sections to define CSS class names

---
 plugins/enigma/README |   86 +++++++++++++++++++++++++++++--------------
 1 files changed, 58 insertions(+), 28 deletions(-)

diff --git a/plugins/enigma/README b/plugins/enigma/README
index c4e474b..0566069 100644
--- a/plugins/enigma/README
+++ b/plugins/enigma/README
@@ -1,36 +1,66 @@
-------------------------------------------------------------------
-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.
 
-Enigma 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.
 
-* DONE:
+WARNING! The plugin is in very early state. See below for a list
+of missing features and known issues.
 
-- PGP signed messages verification
-- Handling of PGP keys files attached to incoming messages
-- PGP encrypted messages decryption (started)
-- PGP keys management UI (started)
-- S/MIME signatures verification (started)
 
-* TODO (must have):
+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
 
-- Parsing of decrypted messages into array (see rcube_mime_struct) and then into rcube_message_part structure
-  (create core class rcube_mime_parser or take over PEAR::Mail_mimeDecode package and improve it)
-- Sending encrypted/signed messages (probably some changes in core will be needed)
+TODO (must have):
+-----------------
+- Keys export to file
+- Disable Reply/Forward options when viewing encrypted messages
+  until they are decrypted successfully
+- 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)
+- Key info in contact details page (optional)
+- Extended key management:
+   - disable,
+   - revoke,
+   - change expiration date, change passphrase, add photo,
+   - manage user IDs
+- Generate revocation certs
+- Search filter to see invalid/expired keys
+- 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
+- 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)
-- Handling big messages with temp files (including changes in Roundcube core)
-- Performance improvements (some caching, code review)
-- better (and more) icons
+- 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
+- S/MIME: encrypted messages decryption
+- S/MIME: Sending signed/encrypted messages
+- S/MIME: Handling of certs attached to incoming messages
+- S/MIME: Certificate info in Contacts details page (optional)
 
-* TODO (later):
-
-- Keys generation
-- Certs generation
-- Keys/Certs info in Contacts details page (+ split Contact details page into tabs)
-- Key server support
-- S/MIME signed messages verification
-- S/MIME encrypted messages decryption
-- Handling of S/MIME certs files attached to incoming messages
-- SSL (S/MIME) Certs management
+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