README

   1 * What's this?
   2
   3 EasyPG is yet another GnuPG interface for Emacs.  It consists of three
   4 parts: transparent file encryption utility, Gnus/PGG backend, and
   5 elisp library to interact with GnuPG.
   6
   7 * Requirements
   8
   9 ** GNU Emacs 21.4 or later, XEmacs 21.4 or later
  10
  11 ** GnuPG 1.4.3 or later
  12
  13 ** Gnus 5.10.8 or later (optional)
  14
  15 * Quick start
  16
  17 ** Installation
  18
  19 $ ./configure
  20 $ sudo make install
  21
  22 ** Transparent file encryption utility
  23
  24 EasyPG provides transparent file encryption utility similar to
  25 crypt++, alpaca.el, hedgehog.  To try this, add the following line to
  26 your ~/.emacs and C-x C-f ~/test.txt.gpg.
  27
  28 (require 'epf)
  29
  30 ** Gnus/PGG backend
  31
  32 EasyPG provides an implementation of the backend interface of
  33 Gnus/PGG.  To use EasyPG instead of pgg-gpg, install pgg-epg.el and
  34 add the following line to your ~/.gnus.
  35
  36 (setq pgg-scheme 'epg)
  37
  38 * Advantages over other competitors
  39
  40 There are many competitors of EasyPG such as Mailcrypt, Gnus/PGG,
  41 gpg.el, etc.  EasyPG has some advantages over them.
  42
  43 ** EasyPG avoides potential security flaws of Emacs
  44
  45 See "Security consideration" section.
  46
  47 ** GnuPG features are directly accessible from Emacs
  48
  49 Other competitors provide only specific features of GnuPG since they
  50 still support PGP 2.*, 5.*, 6.*.  As the name indicates, EasyPG is
  51 inspired by GPGME (GnuPG Made Easy), and the library interface is
  52 close to GPGME.  With EasyPG you can benefit from a lot of features of
  53 GnuPG.
  54
  55 * Security consideration
  56
  57 ** `call-process-region' writes data in region to a temporary file
  58
  59 `call-process-region' writes data in region to a temporary file.
  60 EasyPG does *not* use `call-process-region' to communicate with a gpg
  61 subprocess.
  62
  63 ** `(fillarray string 0)' is not enough to clear passphrases
  64
  65 If Emacs crashed and dumps core, passphrase strings in memory are also
  66 dumped within the core file.  `read-passwd' function clears passphrase
  67 strings by `(fillarray string 0)'.  However, Emacs performs compaction
  68 in gc_sweep phase.  If GC happens before `fillarray', passphrase
  69 strings may be moved elsewhere in memory.
  70
  71 Fortunately, there is gpg-agent to cache passphrases in more secure
  72 way, so the EasyPG library dares *not* to cache passphrase by itself.
  73 Elisp programs can set `epg-context-passphrase-callback' to cache
  74 user's passphrases.