2004-12-07 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / README
1                   GPGME - GnuPG Made Easy
2                 ---------------------------
3
4                Copyright 2004 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, send us your patches.
30
31 See the file COPYING for copyright and warranty information.
32
33
34 Installation
35 --------------
36
37 See the file INSTALL for generic installation instructions.
38
39 Check that you have unmodified sources.  See below on how to do this.
40 Don't skip it - this is an important step!
41
42 To build GPGME, you need to install libgpg-error.  You need at least
43 libgpg-error 0.5.
44
45 For support of the OpenPGP protocol (default), you should use the
46 latest version of GnuPG 1.2, available at:
47 ftp://ftp.gnupg.org/gcrypt/gnupg/
48
49 You need at least GnuPG 1.2.2.
50
51 If configure can't find the `gpg' binary in your path, you can specify
52 the location with the --with-gpg=/path/to/gpg argument to configure.
53
54 For support of the CMS (Cryptographic Message Syntax) protocol, you
55 need the latest CVS version of GnuPG 1.9, which is available in the
56 GnuPG repository:
57 http://www.gnupg.org/(en)/download/cvs_access.html
58 Use the tag `GNUPG-1-9-BRANCH'.  There are also snapshots available at:
59 ftp://ftp.gnupg.org/gcrypt/alpha/gnupg/
60
61 You need at least GpgSM 1.9.6.
62
63 If configure can't find the `gpgsm' binary in your path, you can
64 specify the location with the --with-gpgsm=/path/to/gpgsm argument to
65 configure.
66
67 For building the CVS version of GPGME please see the file README.CVS
68 for more information.
69
70
71 How to Verify the Source
72 --------------------------
73
74 In order to check that the version of GPGME which you are going to
75 install is an original and unmodified one, you can do it in one of the
76 following ways:
77
78 a) If you have a trusted Version of GnuPG installed, you can simply check
79    the supplied signature:
80
81         $ gpg --verify gpgme-x.y.z.tar.gz.sig
82
83    This checks that the detached signature gpgme-x.y.z.tar.gz.sig is
84    indeed a a signature of gpgme-x.y.z.tar.gz.  The key used to create
85    this signature is either of:
86
87    "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
88    "pub  1024D/87978569 1999-05-13
89                         Marcus Brinkmann <Marcus.Brinkmann@ruhr-uni-bochum.de>
90                         Marcus Brinkmann <mb@g10code.com>"
91
92    If you do not have this key, you can get it from any keyserver.  You
93    have to make sure that this is really the key and not a faked one.
94    You can do this by comparing the output of:
95
96         $ gpg --fingerprint 0x57548DCD
97
98    with the fingerprint published elsewhere.
99
100 b) If you don't have any of the above programs, you have to verify
101    the MD5 checksum:
102
103         $ md5sum gpgme-x.y.z.tar.gz
104
105    This should yield an output _similar_ to this:
106
107    fd9351b26b3189c1d577f0970f9dcadc  gpgme-x.y.z.tar.gz
108
109    Now check that this checksum is _exactly_ the same as the one
110    published via the announcement list and probably via Usenet.
111
112
113 Documentation
114 ---------------
115
116 For information how to use the library you can read the info manual,
117 which is also a reference book, in the doc/ directory.  The programs
118 in the tests/gpg/ directory may also prove useful.
119
120 Please subscribe to the gnupg-devel@gnupg.org mailing list if you want
121 to do serious work.