Fix possible realloc overflow for gpgsm and uiserver engines.
[gpgme.git] / README
1                   GPGME - GnuPG Made Easy
2                 ---------------------------
3
4          Copyright 2004, 2006, 2010, 2012, 2013, 2014 g10 Code GmbH
5
6 This file is free software; as a special exception the author gives
7 unlimited permission to copy and/or distribute it, with or without
8 modifications, as long as this notice is preserved.
9
10 This file is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
12 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
13 PURPOSE.
14
15
16 Introduction
17 --------------
18
19 GnuPG Made Easy (GPGME) is a C language library that allows to add
20 support for cryptography to a program.  It is designed to make access
21 to public key crypto engines like GnuPG or GpgSM easier for
22 applications.  GPGME provides a high-level crypto API for encryption,
23 decryption, signing, signature verification and key management.
24
25 GPGME uses GnuPG and GpgSM as its backends to support OpenPGP and the
26 Cryptographic Message Syntax (CMS).
27
28 GPGME runs best on GNU/Linux or *BSD systems.  Other Unices may
29 require small portability fixes, please send us your patches.
30
31 See the files COPYING, COPYING.LESSER, and each file for copyright and
32 warranty information.  The file AUTHORS has a list of authors and
33 useful web and mail addresses.
34
35
36 Installation
37 --------------
38
39 See the file INSTALL for generic installation instructions.
40
41 Check that you have unmodified sources.  See below on how to do this.
42 Don't skip it - this is an important step!
43
44 To build GPGME, you need to install libgpg-error (>= 1.11) and
45 Libassuan (>= 2.0.2).
46
47 For support of the OpenPGP protocol (default), you should use the
48 latest version of GnuPG (>= 1.4) , available at:
49 ftp://ftp.gnupg.org/gcrypt/gnupg/.  For support of the CMS
50 (Cryptographic Message Syntax) protocol and lot of other features, you
51 need a GnuPG version >= 2.0.
52
53 For building the GIT version of GPGME please see the file README.GIT
54 for more information.
55
56
57 How to Verify the Source
58 --------------------------
59
60 In order to check that the version of GPGME which you are going to
61 install is an original and unmodified one, you can do it in one of the
62 following ways:
63
64 a) If you have a trusted Version of GnuPG installed, you can simply check
65    the supplied signature:
66
67         $ gpg --verify gpgme-x.y.z.tar.gz.sig
68
69    This checks that the detached signature gpgme-x.y.z.tar.gz.sig is
70    indeed a a signature of gpgme-x.y.z.tar.gz.  The key used to create
71    this signature is either of:
72
73    "pub  2048R/4F25E3B6 2011-01-12 Werner Koch (dist sig)"
74    "pub  1024D/87978569 1999-05-13
75                         Marcus Brinkmann <Marcus.Brinkmann@ruhr-uni-bochum.de>
76                         Marcus Brinkmann <mb@g10code.com>"
77
78    If you do not have this key, you can get it from any keyserver.  You
79    have to make sure that this is really the key and not a faked one.
80    You can do this by comparing the output of:
81
82         $ gpg --fingerprint 0x4F25E3B6
83
84    with the fingerprint published elsewhere.
85
86 b) If you don't have any of the above programs, you have to verify
87    the SHA1 checksum:
88
89         $ sha1sum gpgme-x.y.z.tar.gz
90
91    This should yield an output _similar_ to this:
92
93    fd9351b26b3189c1d577f0970f9dcadc3412def1  gpgme-x.y.z.tar.gz
94
95    Now check that this checksum is _exactly_ the same as the one
96    published via the announcement list and probably via Usenet.
97
98
99 Documentation
100 ---------------
101
102 For information how to use the library you can read the info manual,
103 which is also a reference book, in the doc/ directory.  The programs
104 in the tests/gpg/ directory may also prove useful.
105
106 Please subscribe to the gnupg-devel@gnupg.org mailing list if you want
107 to do serious work.
108
109 For hacking on GPGME, please have a look at doc/HACKING.