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