tests: Enable gpgconf test.
[gpgme.git] / README
1                        GPGME - GnuPG Made Easy
2                      ---------------------------
3
4                   Copyright 2001-2016 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 comes with language bindings for Common Lisp, C++, QT, Python2
26 and Python 3.
27
28 GPGME uses GnuPG and GpgSM as its backends to support OpenPGP and the
29 Cryptographic Message Syntax (CMS).
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 gpgme-x.y.z.tar.gz
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      2048R/4F25E3B6 2011-01-12 [expires: 2019-12-31]
74      Key fingerprint = D869 2123 C406 5DEA 5E0F  3AB5 249B 39D2 4F25 E3B6
75      Werner Koch (dist sig)
76
77      rsa2048/E0856959 2014-10-29 [expires: 2019-12-31]
78      Key fingerprint = 46CC 7308 65BB 5C78 EBAB  ADCF 0437 6F3E E085 6959
79      David Shaw (GnuPG Release Signing Key) <dshaw 'at' jabberwocky.com>
80
81      rsa2048/33BD3F06 2014-10-29 [expires: 2016-10-28]
82      Key fingerprint = 031E C253 6E58 0D8E A286  A9F2 2071 B08A 33BD 3F06
83      NIIBE Yutaka (GnuPG Release Key) <gniibe 'at' fsij.org>
84
85      rsa2048/7EFD60D9 2014-10-19 [expires: 2020-12-31]
86      Key fingerprint = D238 EA65 D64C 67ED 4C30  73F2 8A86 1B1C 7EFD 60D9
87      Werner Koch (Release Signing Key)
88
89    You may retrieve these files from the keyservers using this command
90
91      gpg --recv-keys 249B39D24F25E3B6 04376F3EE0856959 \
92                      2071B08A33BD3F06 8A861B1C7EFD60D9
93
94    The keys are also available at https://gnupg.org/signature_key.html
95    and in released GnuPG tarballs in the file g10/distsigkey.gpg .
96    You have to make sure that these are really the desired keys and
97    not faked one.  You should do this by comparing the fingerprints
98    with the fingerprints published elsewhere.
99
100 b) If you don't have any of the above programs, you have to verify
101    the SHA1 checksum:
102
103         $ sha1sum gpgme-x.y.z.tar.gz
104
105    This should yield an output _similar_ to this:
106
107    fd9351b26b3189c1d577f0970f9dcadc3412def1  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/ 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.
122
123 For hacking on GPGME, please have a look at doc/HACKING.