GnuPG Made Easy. NOTE: Maintainers are not tracking this mirror. Do not make pull requests here, nor comment any commits, submit them usual way to bug tracker (https://www.gnupg.org/documentation/bts.html) or to the mailing list (https://www.gnupg.org/documentation/mailing-lists.html).
Go to file
Ben McGinnes c8a04af676 python: sphinx modification
* The make.bat file incorrectly triggers the trailing whitespace check
  in the git repo (it doesn't actually have any trailing whitespace,
  but triggers the error on every line).
* Will need to add a script to handle future org-mode conversions of
  the index page anyway, so will get that script to deal with this
  problem too by generating the make.bat file if the platform is
  detected as Windows.

Signed-off-by: Ben McGinnes <ben@adversary.org>
2018-12-05 09:31:10 +11:00
build-aux doc: use https:// for www.gnu.org 2018-10-18 00:28:51 -04:00
conf Release 1.12.0 2018-10-08 11:17:01 +02:00
doc doc: Minor comment cleanups. 2018-12-03 10:41:00 +01:00
lang python: sphinx modification 2018-12-05 09:31:10 +11:00
m4 build: Update gpg-error.m4 and libassuan.m4. 2018-11-13 11:44:24 +09:00
src doc: Minor comment cleanups. 2018-12-03 10:41:00 +01:00
tests tests, json: Make them run on debian stable 2018-11-28 10:45:27 +01:00
.gitignore build: Let configure create the VERSION file. 2018-10-10 13:39:42 +09:00
acinclude.m4 Spelling fixes for comments and doc 2017-12-08 05:59:11 +01:00
AUTHORS Add SPDX identifiers to most source files 2018-11-16 13:27:33 +01:00
autogen.rc build: Remove --with-*-prefix, which is no need any more. 2018-12-04 12:35:41 +09:00
autogen.sh build: Let configure create the VERSION file. 2018-10-10 13:39:42 +09:00
ChangeLog Generate the ChangeLog from commit logs. 2011-12-02 11:36:37 +01:00
ChangeLog-2011 Generate the ChangeLog from commit logs. 2011-12-02 11:36:37 +01:00
configure.ac core: Simplify the trace maros by using variadics. 2018-11-16 16:25:49 +01:00
COPYING Added files usually installed bu automake. We want to keep them in the CVS 2004-01-12 13:49:11 +00:00
COPYING.LESSER 2004-12-07 Marcus Brinkmann <marcus@g10code.de> 2004-12-07 21:13:39 +00:00
gpgme.spec.in doc: convert more links to equivalent https:// URLs 2018-10-18 00:28:51 -04:00
gpgme.txt doc: convert more links to equivalent https:// URLs 2018-10-18 00:28:51 -04:00
INSTALL Update automake scripts. 2008-07-04 15:46:01 +00:00
Makefile.am Add SPDX identifiers to most source files 2018-11-16 13:27:33 +01:00
missing Update automake scripts. 2008-07-04 15:46:01 +00:00
NEWS spelling: fix misspellings 2018-11-08 12:34:27 +07:00
README doc: Update copyright years and change two URLs. 2018-04-18 19:30:50 +02:00
README.GIT Release 1.3.2. 2012-05-02 11:18:24 +02:00
THANKS move some file encodings to UTF-8 2016-09-23 16:08:33 +02:00
TODO spelling: fix misspellings 2018-11-08 12:34:27 +07:00

                       GPGME - GnuPG Made Easy
                     ---------------------------

Copyright 2001-2018 g10 Code GmbH

This file is free software; as a special exception the author gives
unlimited permission to copy and/or distribute it, with or without
modifications, as long as this notice is preserved.

This file is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.


Introduction
--------------

GnuPG Made Easy (GPGME) is a C language library that allows to add
support for cryptography to a program.  It is designed to make access
to public key crypto engines like GnuPG or GpgSM easier for
applications.  GPGME provides a high-level crypto API for encryption,
decryption, signing, signature verification and key management.

GPGME comes with language bindings for Common Lisp, C++, QT, Python2,
and Python 3.

GPGME uses GnuPG as its backend to support OpenPGP and the
Cryptographic Message Syntax (CMS).

See the files COPYING, COPYING.LESSER, and each file for copyright and
warranty information.  The file AUTHORS has a list of authors and
useful web and mail addresses.


Installation
--------------

See the file INSTALL for generic installation instructions.

Check that you have unmodified sources.  See below on how to do this.
Don't skip it - this is an important step!

To build GPGME, you need to install libgpg-error (>= 1.24) and
Libassuan (>= 2.4.2).

For support of the OpenPGP and the CMS protocols, you should use the
latest version of GnuPG (>= 2.1.18) , available at:
https://gnupg.org/ftp/gcrypt/gnupg/.

For building the Git version of GPGME please see the file README.GIT
for more information.


How to Verify the Source
--------------------------

In order to check that the version of GPGME which you are going to
install is an original and unmodified one, you can do it in one of the
following ways:

a) If you have a trusted Version of GnuPG installed, you can simply check
   the supplied signature:

	$ gpg --verify gpgme-x.y.z.tar.gz.sig gpgme-x.y.z.tar.gz

   This checks that the detached signature gpgme-x.y.z.tar.gz.sig is
   indeed a a signature of gpgme-x.y.z.tar.gz.  The key used to create
   this signature is at least one of:

     rsa2048 2011-01-12 [expires: 2019-12-31]
     Key fingerprint = D869 2123 C406 5DEA 5E0F  3AB5 249B 39D2 4F25 E3B6
     Werner Koch (dist sig)

     rsa2048 2014-10-29 [expires: 2019-12-31]
     Key fingerprint = 46CC 7308 65BB 5C78 EBAB  ADCF 0437 6F3E E085 6959
     David Shaw (GnuPG Release Signing Key) <dshaw 'at' jabberwocky.com>

     rsa2048 2014-10-29 [expires: 2020-10-30]
     Key fingerprint = 031E C253 6E58 0D8E A286  A9F2 2071 B08A 33BD 3F06
     NIIBE Yutaka (GnuPG Release Key) <gniibe 'at' fsij.org>

     rsa3072 2017-03-17 [expires: 2027-03-15]
     Key fingerprint = 5B80 C575 4298 F0CB 55D8  ED6A BCEF 7E29 4B09 2E28
     Andre Heinecke (Release Signing Key)

   The keys are available at <https://gnupg.org/signature_key.html>
   and in released GnuPG tarballs in the file g10/distsigkey.gpg .
   You have to make sure that these are really the desired keys and
   not faked one.  You should do this by comparing the fingerprints
   with the fingerprints published elsewhere.

b) If you don't have any of the above programs, you have to verify
   the SHA1 checksum:

	$ sha1sum gpgme-x.y.z.tar.gz

   This should yield an output _similar_ to this:

   fd9351b26b3189c1d577f0970f9dcadc3412def1  gpgme-x.y.z.tar.gz

   Now check that this checksum is _exactly_ the same as the one
   published via the announcement list and probably via Usenet.


Documentation
---------------

For information how to use the library you can read the info manual,
which is also a reference book, in the doc/ directory.  The programs
in the tests/ directory may also prove useful.

Please subscribe to the gnupg-devel@gnupg.org mailing list if you want
to do serious work.

For hacking on GPGME, please have a look at doc/HACKING.