README

   1 * What's this?
   2
   3 EasyPG is an all-in-one GnuPG interface for Emacs.  It has two
   4 aspects: convenient tools which allow to use GnuPG from Emacs (EasyPG
   5 Assistant), and a fully functional interface library to GnuPG (EasyPG
   6 Library).
   7
   8 * Features
   9
  10 The EasyPG Assistant provides the following features:
  11
  12 - Keyring browser.
  13 - Cryptographic operations on regions.
  14 - Cryptographic operations on files.
  15 - Dired integration.
  16 - Encryption/decryption of *.gpg files.
  17
  18 The EasyPG Library provides the following features:
  19
  20 - The API covers most functions of GnuPG like GPGME.
  21 - S/MIME support using gpgsm.
  22 - Designed to avoid potential security pitfalls around Emacs
  23
  24 * Requirements
  25
  26 ** GNU Emacs 21.4, XEmacs 21.4, or later
  27
  28 ** GnuPG 1.4.3 or later
  29    If you are using earlier versions, you will need to specify
  30    --disable-gpg-test when ./configure.
  31
  32 * Quick start
  33
  34 ** Installation
  35
  36   $ ./configure
  37   $ sudo make install
  38
  39 Add the following line to your ~/.emacs
  40
  41   (require 'epa-setup)
  42
  43 Restart emacs and type `M-x epa- TAB', and you will see a lot of
  44 commands available.  For example,
  45
  46 - To browse your keyring, type `M-x epa-list-keys'
  47 - To create a cleartext signature of the region, type `M-x epa-sign-region'
  48
  49 You can also do some cryptographic operations from dired.
  50
  51   M-x dired
  52   (mark some files)
  53   : e (or M-x epa-dired-do-encrypt)
  54   (select recipients by 'm' and click [OK])
  55
  56 * MUA Integration
  57
  58 The EasyPG Library can be used in combination with various MUA (Mail
  59 User Agents).
  60
  61 ** CVS version of Gnus
  62
  63 CVS version of Gnus uses EasyPG by default.  To make sure of that,
  64 check mml2015-use set to 'epg.  Other options which affect on the
  65 EasyPG are
  66
  67   mml2015-signers
  68   mml2015-encrypt-to-self
  69   mml2015-cache-passphrase
  70   mml2015-passphrase-cache-expiry
  71   mml2015-verbose
  72
  73 NOTE: You don't need pgg-epg.el in this case.
  74
  75 ** PGG based MUA
  76
  77 PGG is outdated PGP library used by old Gnus (<= v5.11), MH-E, etc.
  78
  79 There is a PGG backend written using EasyPG called pgg-epg.el.
  80 However, EasyPG API is a superset of PGG and pgg-epg.el provides
  81 nothing but compatibility with PGG.
  82
  83 *** Limitations of PGG
  84
  85 As I noted "PGG is outdated PGP library" above, PGG has several
  86 limitations.  For example
  87
  88 - PGG can't handle a message signed with multiple keys.
  89 - PGG can't prompt a user which key is being used.
  90 - PGG can't create a binary PGP messages.
  91 - PGG doesn't provide a way to select keys per cryptographic operation.
  92 - PGG ignores GnuPG's trust metrics.
  93
  94 ** SEMI based MUA
  95
  96 SEMI is the MIME library used by Wanderlust, cmail, T-gnus, etc.
  97
  98 There is an EasyPG capable SEMI library called EMIKO-EasyPG.  It can
  99 be downloaded from the same site of the EasyPG distribution point.
 100
 101 * Security
 102
 103 There are security pitfalls around Emacs.  EasyPG is written with
 104 avoiding them.
 105
 106 ** Passphrase may leak to a temporary file.
 107
 108 The function call-process-region writes data in region to a temporary
 109 file. If your PGP library used this function, your passphrases would
 110 leak to the filesystem.
 111
 112 The EasyPG Library does not use call-process-region to communicate
 113 with a gpg subprocess.
 114
 115 ** Passphrase may be stolen from a core file.
 116
 117 If Emacs crashes and dumps core, Lisp strings in memory are also
 118 dumped within the core file. read-passwd function clears passphrase
 119 strings by (fillarray string 0) to avoid this risk. However, Emacs
 120 performs compaction in gc_sweep phase. If GC happens before fillarray,
 121 passphrase strings may be moved elsewhere in memory. Therefore,
 122 passphrase caching in elisp is generally a bad idea.
 123
 124 The EasyPG Library dares to disable passphrase caching. Fortunately,
 125 there is more secure way to cache passphrases - use gpg-agent.