README

   1 * What's this?
   2
   3 EasyPG is yet another GnuPG interface for Emacs.  It consists of two
   4 parts: transparent file encryption utility and easy-to-use elisp
   5 library to interact with GnuPG.
   6
   7 * Requirements
   8
   9 ** GNU Emacs 21.4 or later
  10
  11 ** XEmacs 21.4 or later
  12
  13 ** GnuPG 1.4.3 or later
  14
  15 * Quick start
  16
  17 (0) Put (require 'epg-file) in your ~/.emacs.el
  18
  19 (1) Restart emacs
  20
  21 (2) C-x C-f ~/test.gpg
  22
  23 * Advantages over other competitors
  24
  25 There are many competitors of EasyPG such as Mailcrypt, PGG, gpg.el,
  26 etc.  EasyPG has some advantages over them.
  27
  28 ** EasyPG avoides potential security flaws of Emacs.
  29
  30 *** `call-process-region' writes data in region to temporary files.
  31
  32 `call-process-region' writes data in region to temporary files.  PGG
  33 and gpg.el use `call-process-region' to communicate with a gpg
  34 subprocess.  Your passphrases leak to the filesystem!
  35
  36 *** There is no way to clear strings safely.
  37
  38 If Emacs crashed and dumps core, passphrase strings in memory are also
  39 dumped within the core file.  `read-passwd' function clears passphrase
  40 strings by `(fillarray string 0)'.  However, Emacs performs compaction
  41 in gc_sweep phase.  If GC happens before `fillarray', passphrase
  42 strings may be moved elsewhere in memory.  It is recommended that as
  43 soon as you are done with passphrase you should clear it manually.
  44 However, PGG and gpg.el can keep passphrase strings in cache for a
  45 while and this behavior is their default!
  46
  47 ** Most GnuPG features are accessible from Emacs
  48
  49 Other competitors provide only specific features of GnuPG.  As the
  50 name indicates, EasyPG is inspired by GPGME (GnuPG Made Easy), and the
  51 library interface is close to GPGME.  With EasyPG you can handle
  52 binary messages, sign/encrypt combined messages, etc.