README

   1 * What's this?
   2
   3 EasyPG is yet another GnuPG interface for Emacs.  It consists of two parts:
   4
   5 - "The EasyPG Assistant" which provides basic GUI of GnuPG
   6 - "The EasyPG Library" which enables use of various features of GnuPG
   7
   8 NOTE: EasyPG is neither a fork nor a re-implementation of Gnus/PGG.
   9
  10 * Requirements
  11
  12 ** GNU Emacs 21.4 or XEmacs 21.4
  13
  14 ** GnuPG 1.4.3
  15
  16 * Quick start
  17
  18 ** Installation
  19
  20   $ ./configure
  21   $ sudo make install
  22
  23 Add the following line to your ~/.emacs
  24
  25   (require 'epa-setup)
  26
  27 Then you can browse your keyring by `M-x epa-list-keys'.  In addition,
  28 you can do some cryptographic operations on dired.
  29
  30   M-x dired
  31   (mark some files)
  32   : e (or M-x epg-dired-do-encrypt)
  33   (select recipients and click [OK])
  34
  35 * Security consideration
  36
  37 There are security pitfalls around Emacs.
  38
  39 ** Passphrase may leak to a temporary file.
  40
  41 `call-process-region' writes data in region to a temporary file.
  42 The EasyPG Library does not use `call-process-region' to communicate with a gpg
  43 subprocess.
  44
  45 ** Passphrase may be stolen from a core file.
  46
  47 If Emacs crashes and dumps core, Lisp strings in memory are also
  48 dumped within the core file.  `read-passwd' function clears passphrase
  49 strings by `(fillarray string 0)'.  However, Emacs performs compaction
  50 in gc_sweep phase.  If GC happens before `fillarray', passphrase
  51 strings may be moved elsewhere in memory.  Therefore, passphrase
  52 caching in elisp is generally a bad idea.
  53
  54 The EasyPG Library dares to disable passphrase caching.  Fortunately,
  55 there is more secure way to cache passphrases - use gpg-agent.  Elisp
  56 programs can set `epg-context-passphrase-callback' to cache user's
  57 passphrases, it is not recommended though.