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 not a fork or a re-implementation of Gnus/PGG.
   9
  10 * Requirements
  11
  12 ** GNU Emacs 21.4 or later, XEmacs 21.4 or later
  13
  14 ** GnuPG 1.4.3 or later
  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 do some cryptographic operations on dired.
  28
  29   M-x dired
  30   (mark some files)
  31   : e (or M-x epg-dired-do-encrypt)
  32   (select recipients and click [OK])
  33
  34 * Security consideration
  35
  36 ** `call-process-region' writes data in region to a temporary file
  37
  38 `call-process-region' writes data in region to a temporary file.
  39 EasyPG does *not* use `call-process-region' to communicate with a gpg
  40 subprocess.
  41
  42 ** `(fillarray string 0)' is not enough to clear passphrases
  43
  44 If Emacs crashed and dumps core, passphrase strings in memory are also
  45 dumped within the core file.  `read-passwd' function clears passphrase
  46 strings by `(fillarray string 0)'.  However, Emacs performs compaction
  47 in gc_sweep phase.  If GC happens before `fillarray', passphrase
  48 strings may be moved elsewhere in memory.
  49
  50 Fortunately, there is gpg-agent to cache passphrases in more secure
  51 way, so the EasyPG library dares *not* to cache passphrase by itself.
  52 Elisp programs can set `epg-context-passphrase-callback' to cache
  53 user's passphrases.