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