README

   1 * What's this?
   2
   3 EasyPG is yet another GnuPG interface for Emacs.  It consists of two
   4 parts:
   5
   6 - "The EasyPG Assistant"
   7   A GUI frontend of GnuPG
   8 - "The EasyPG Library"
   9   A library to interact with GnuPG
  10
  11 * Requirements
  12
  13 ** GNU Emacs 21.4 or XEmacs 21.4
  14
  15 ** GnuPG 1.4.3
  16
  17 * Quick start
  18
  19 ** Installation
  20
  21   $ ./configure
  22   $ sudo make install
  23
  24 Add the following line to your ~/.emacs
  25
  26   (require 'epa-setup)
  27
  28 Then you can browse your keyring by `M-x epa-list-keys'.  In addition,
  29 you can do some cryptographic operations on dired.
  30
  31   M-x dired
  32   (mark some files)
  33   : e (or M-x epa-dired-do-encrypt)
  34   (select recipients and click [OK])
  35
  36 * Security
  37
  38 There are security pitfalls around Emacs.
  39
  40 ** Passphrase may leak to a temporary file.
  41
  42 The function call-process-region writes data in region to a temporary
  43 file. If your PGP library used this function, your passphrases would
  44 leak to the filesystem.
  45
  46 The EasyPG Library does not use call-process-region to communicate
  47 with a gpg subprocess.
  48
  49 ** Passphrase may be stolen from a core file.
  50
  51 If Emacs crashes and dumps core, Lisp strings in memory are also
  52 dumped within the core file. read-passwd function clears passphrase
  53 strings by (fillarray string 0) to avoid this risk. However, Emacs
  54 performs compaction in gc_sweep phase. If GC happens before fillarray,
  55 passphrase strings may be moved elsewhere in memory. Therefore,
  56 passphrase caching in elisp is generally a bad idea.
  57
  58 The EasyPG Library dares to disable passphrase caching. Fortunately,
  59 there is more secure way to cache passphrases - use gpg-agent.
  60
  61 * MUA Integration
  62
  63 The EasyPG Library can be used in combination with MUA (Mail User
  64 Agents).
  65
  66 ** SEMI based MUA
  67
  68 SEMI is the MIME library used by Wanderlust, cmail, T-gnus, etc.
  69
  70 There is an EasyPG capable SEMI library called EMIKO-EasyPG.  It can
  71 be downloaded from the same site of the EasyPG distribution point.
  72
  73 ** PGG based MUA
  74
  75 PGG is somewhat outdated PGP library used by Gnus, MH-E, etc.
  76
  77 There is a PGG backend using EasyPG called pgg-epg.el.  However,
  78 through the pgg-epg.el you can't benefit of the power of the EasyPG
  79 Library, because the PGG API is restricted so that it supports old PGP
  80 2.x/5.x.