Make use of gcry_kdf_derive.
[gnupg.git] / README
1                        The GNU Privacy Guard 2
2                       =========================
3                              Version 2.1
4
5    THIS IS A DEVELOPMENT VERSION AND NOT INTENDED FOR REGULAR USE.
6
7       Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
8      2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
9
10
11 INTRODUCTION
12 ============
13
14 GnuPG is GNU's tool for secure communication and data storage.  It can
15 be used to encrypt data and to create digital signatures.  It includes
16 an advanced key management facility and is compliant with the proposed
17 OpenPGP Internet standard as described in RFC4880 and the S/MIME
18 standard as described by several RFCs.
19
20 GnuPG is distributed under the terms of the GNU General Public
21 License.  See the file COPYING for details.  GnuPG works best on
22 GNU/Linux or *BSD systems.  Most other Unices are also supported but
23 are not as well tested as the Free Unices.
24
25 GnuPG 2.0 is the stable version of GnuPG integrating support for
26 OpenPGP and S/MIME.  It does not conflict with an installed 1.4
27 OpenPGP-only version.
28
29
30 BUILD INSTRUCTIONS
31 ==================
32
33 GnuPG 2.1 depends on the following packages:
34
35   libgpg-error (ftp://ftp.gnupg.org/gcrypt/libgpg-error/)
36   libgcrypt    (ftp://ftp.gnupg.org/gcrypt/libgcrypt/)
37   libksba      (ftp://ftp.gnupg.org/gcrypt/libksba/)
38   libassuan    (ftp://ftp.gnupg.org/gcrypt/libassuan/)
39
40 You also need the Pinentry package for most function of GnuPG; however
41 it is not a build requirement.  Pinentry is available at
42 ftp://ftp.gnupg.org/gcrypt/pinentry/ .
43
44 You should get the latest versions of course, the GnuPG configure
45 script complains if a version is not sufficient.
46
47 After building and installing the above packages in the order as given
48 above, you may now continue with GnuPG installation (you may also just
49 try to build GnuPG to see whether your already installed versions are
50 sufficient).
51
52 As with all packages, you just have to do
53
54  ./configure
55  make
56  make install
57
58 (Before doing install you might need to become root.)
59
60 If everything succeeds, you have a working GnuPG with support for
61 S/MIME and smartcards.  Note that there is no binary gpg but a gpg2 so
62 that this package won't conflict with a GnuPG 1.4 installation.  gpg2
63 behaves just like gpg.
64
65 In case of problem please ask on gnupg-users@gnupg.org for advise.
66
67 Note that the PKITS tests are always skipped unless you copy the PKITS
68 test data file into the tests/pkits directory.  There is no need to
69 run these test and some of them may even fail because the test scripts
70 are not yet complete.
71
72 You may run
73
74   gpgconf --list-dirs
75
76 to view the default directories used by GnuPG.
77
78
79 MIGRATION FROM 1.4 or 2.0 to 2.1
80 ================================
81
82 The major change in 2.1 is that gpg-agent now takes care of the
83 OpenPGP secret keys (those managed by GPG).  The former secring.gpg
84 will not be used anymore.  Newly generated keys are generated and
85 stored in the agent's key store (~/.gnupg/private-keys-v1.d/).  To
86 migrate your existing keys to the agent you should run this command
87
88   gpg2 --import ~/.gnupg/secring.gpg
89
90 The agent will you ask for the passphrase of each key.  You may use
91 the Cancel button of the Pinentry to skip importing this key.  If you
92 want to stop the import process and you use one of the latest
93 pinentries, you should close the pinentry window instead of hitting
94 the cancel button.  Secret keys already imported are skipped by the
95 import command.  It is advisable to keep the secring.gpg for use with
96 older versions of GPG.
97
98 Note that gpg-agent now uses a fixed socket by default.  All tools
99 will start the gpg-agent as needed.  In general there is no more need
100 to set the GPG_AGENT_INFO environment variable.  The SSH_AUTH_SOCK
101 environment variable should be set to a fixed value.
102
103 GPG's smartcard commands --card-edit and --card-status as well as some
104 of the card related sub-commands of --edit-key are not yet fully
105 supported.  However, signing and decryption with a smartcard does
106 work.
107
108 The Dirmngr is now part of GnuPG proper.  Thus there is no more need
109 to install the separate dirmngr package.  The directroy layout of
110 Dirmngr changed to make use of the GnuPG directories; for example you
111 use /etc/gnupg/trusted-certs and /var/lib/gnupg/extra-certs.  Dirmngr
112 needs to be started as a system daemon.
113
114
115
116 DOCUMENTATION
117 =============
118
119 The complete documentation is in the texinfo manual named
120 `gnupg.info'.  Run "info gnupg" to read it.  If you want a a printable
121 copy of the manual, change to the "doc" directory and enter "make pdf"
122 For a HTML version enter "make html" and point your browser to
123 gnupg.html/index.html.  Standard man pages for all components are
124 provided as well.  An online version of the manual is available at
125 http://www.gnupg.org/documentation/manuals/gnupg/ .  A version of the
126 manual pertaining to the current development snapshot is at
127 http://www.gnupg.org/documentation/manuals/gnupg-devel/ .
128
129
130 GNUPG 1.4 AND GNUPG 2.0
131 =======================
132
133 GnuPG 2.0 is a newer version of GnuPG with additional support for
134 S/MIME.  It has a different design philosophy that splits
135 functionality up into several modules.  Both versions may be installed
136 simultaneously without any conflict (gpg is called gpg2 in GnuPG 2).
137 In fact, the gpg version from GnuPG 1.4 is able to make use of the
138 gpg-agent as included in GnuPG 2 and allows for seamless passphrase
139 caching.  The advantage of GnuPG 1.4 is its smaller size and no
140 dependency on other modules at run and build time.
141
142
143 HOW TO GET MORE INFORMATION
144 ===========================
145
146 The primary WWW page is "http://www.gnupg.org"
147 The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
148
149 See http://www.gnupg.org/download/mirrors.html for a list of mirrors
150 and use them if possible.  You may also find GnuPG mirrored on some of
151 the regular GNU mirrors.
152
153 We have some mailing lists dedicated to GnuPG:
154
155    gnupg-announce@gnupg.org   For important announcements like new
156                               versions and such stuff.  This is a
157                               moderated list and has very low traffic.
158                               Do not post to this list.
159
160    gnupg-users@gnupg.org      For general user discussion and
161                               help (English).
162
163    gnupg-de@gnupg.org         German speaking counterpart of
164                               gnupg-users.
165
166    gnupg-ru@gnupg.org         Russian speaking counterpart of
167                               gnupg-users.
168
169    gnupg-devel@gnupg.org      GnuPG developers main forum.
170
171 You subscribe to one of the list by sending mail with a subject of
172 "subscribe" to x-request@gnupg.org, where x is the name of the mailing
173 list (gnupg-announce, gnupg-users, etc.).  An archive of the mailing
174 lists are available at http://www.gnupg.org/documentation/mailing-lists.html
175
176 Please direct bug reports to http://bugs.gnupg.org or post them direct
177 to the mailing list <gnupg-devel@gnupg.org>.
178
179 Please direct questions about GnuPG to the users mailing list or one
180 of the pgp newsgroups; please do not direct questions to one of the
181 authors directly as we are busy working on improvements and bug fixes.
182 The English and German mailing lists are watched by the authors and we
183 try to answer questions when time allows us to do so.
184
185 Commercial grade support for GnuPG is available; please see
186 http://www.gnupg.org/service.html .
187
188
189   This file is Free Software; as a special exception the authors gives
190   unlimited permission to copy and/or distribute it, with or without
191   modifications, as long as this notice is preserved. For conditions
192   of the whole package, please see the file COPYING.  This file is
193   distributed in the hope that it will be useful, but WITHOUT ANY
194   WARRANTY, to the extent permitted by law; without even the implied
195   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.