gpg: Cap size of attribute packets at 16MB.
[gnupg.git] / README
1                        The GNU Privacy Guard
2                       =======================
3                             Version 2.0
4
5    Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004,
6              2005, 2006, 2007, 2008, 2009, 2010, 2011,
7              2012, 2013 Free Software Foundation, Inc.
8    Copyright 1997, 1998, 2013, 2014 Werner Koch
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
31 BUILD INSTRUCTIONS
32 ==================
33
34 GnuPG 2.0 depends on the following packages:
35
36   libgpg-error     (ftp://ftp.gnupg.org/gcrypt/libgpg-error/)
37   libgcrypt        (ftp://ftp.gnupg.org/gcrypt/libgcrypt/)
38   libksba          (ftp://ftp.gnupg.org/gcrypt/libksba/)
39   libassuan >= 2.0 (ftp://ftp.gnupg.org/gcrypt/libassuan/)
40
41 You also need the Pinentry package for most function of GnuPG; however
42 it is not a build requirement.  Pinentry is available at
43 ftp://ftp.gnupg.org/gcrypt/pinentry/ .
44
45 You should get the latest versions of course, the GnuPG configure
46 script complains if a version is not sufficient.
47
48 After building and installing the above packages in the order as given
49 above, you may now continue with GnuPG installation (you may also just
50 try to build GnuPG to see whether your already installed versions are
51 sufficient).
52
53 As with all packages, you just have to do
54
55  ./configure
56  make
57  make install
58
59 (Before doing install you might need to become root.)
60
61 If everything succeeds, you have a working GnuPG with support for
62 S/MIME and smartcards.  Note that there is no binary gpg but a gpg2 so
63 that this package won't conflict with a GnuPG 1.4 installation.  gpg2
64 behaves just like gpg.
65
66 In case of problem please ask on gnupg-users@gnupg.org for advise.
67
68 Note that the PKITS tests are always skipped unless you copy the PKITS
69 test data file into the tests/pkits directory.
70
71
72 INCOMPATIBLE CHANGES
73 ====================
74
75 - With 2.0.20 the scdaemon option 'disable-keypad' has been renamed to
76   'disable-pinpad'.  If you are using this option in scdaemon.conf you
77   should rename it there.  In case you are using this option to work
78   around a problem with your card reader, you may want to test whether
79   this version of GnuPG works better with your reader.
80
81
82 DOCUMENTATION
83 =============
84
85 The complete documentation is in the texinfo manual named
86 `gnupg.info'.  Run "info gnupg" to read it.  If you want a a printable
87 copy of the manual, change to the "doc" directory and enter "make pdf"
88 For a HTML version enter "make html" and point your browser to
89 gnupg.html/index.html.  Standard man pages for all components are
90 provided as well.  An online version of the manual is available at
91 http://www.gnupg.org/documentation/manuals/gnupg/ .  A version of the
92 manual pertaining to the current development snapshot is at
93 http://www.gnupg.org/documentation/manuals/gnupg-devel/ .
94
95
96 GNUPG 1.4 AND GNUPG 2.0
97 =======================
98
99 GnuPG 2.0 is a newer version of GnuPG with additional support for
100 S/MIME.  It has a different design philosophy that splits
101 functionality up into several modules.  Both versions may be installed
102 simultaneously without any conflict (gpg is called gpg2 in GnuPG 2).
103 In fact, the gpg version from GnuPG 1.4 is able to make use of the
104 gpg-agent as included in GnuPG 2 and allows for seamless passphrase
105 caching.  The advantage of GnuPG 1.4 is its smaller size and no
106 dependency on other modules at run and build time.
107
108
109 HOW TO GET MORE INFORMATION
110 ===========================
111
112 The primary WWW page is "https://www.gnupg.org"
113            or using TOR "http://ic6au7wa3f6naxjq.onion"
114 The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
115
116 See http://www.gnupg.org/download/mirrors.html for a list of mirrors
117 and use them if possible.  You may also find GnuPG mirrored on some of
118 the regular GNU mirrors.
119
120 We have some mailing lists dedicated to GnuPG:
121
122    gnupg-announce@gnupg.org   For important announcements like new
123                               versions and such stuff.  This is a
124                               moderated list and has very low traffic.
125                               Do not post to this list.
126
127    gnupg-users@gnupg.org      For general user discussion and
128                               help (English).
129
130    gnupg-de@gnupg.org         German speaking counterpart of
131                               gnupg-users.
132
133    gnupg-ru@gnupg.org         Russian speaking counterpart of
134                               gnupg-users.
135
136    gnupg-devel@gnupg.org      GnuPG developers main forum.
137
138 You subscribe to one of the list by sending mail with a subject of
139 "subscribe" to x-request@gnupg.org, where x is the name of the mailing
140 list (gnupg-announce, gnupg-users, etc.).  An archive of the mailing
141 lists is available at <http://www.gnupg.org/documentation/mailing-lists.html>.
142
143 Please direct bug reports to http://bugs.gnupg.org or post them direct
144 to the mailing list <gnupg-devel@gnupg.org>.
145
146 Please direct questions about GnuPG to the users mailing list or one
147 of the pgp newsgroups; please do not direct questions to one of the
148 authors directly as we are busy working on improvements and bug fixes.
149 The English and German mailing lists are watched by the authors and we
150 try to answer questions when time allows us to do so.
151
152 Commercial grade support for GnuPG is available; for a listing of
153 offers see https://www.gnupg.org/service.html .  Maintaining and
154 improving GnuPG is costly.  For more than a decade, g10 Code GmbH, a
155 German company owned and headed by GnuPG's principal author Werner
156 Koch, is bearing the majority of these costs.  To help them carry on
157 this work, they need your support.  See https://gnupg.org/donate/ .
158
159
160   This file is Free Software; as a special exception the authors gives
161   unlimited permission to copy and/or distribute it, with or without
162   modifications, as long as this notice is preserved. For conditions
163   of the whole package, please see the file COPYING.  This file is
164   distributed in the hope that it will be useful, but WITHOUT ANY
165   WARRANTY, to the extent permitted by law; without even the implied
166   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.