build: New configure option --enable-all-tests.
[gnupg.git] / README
diff --git a/README b/README
index 6ae0e79..a9a3eb0 100644 (file)
--- a/README
+++ b/README
-                   The GNU Privacy Guard 2
-                  =========================
-                       Version 1.9.x
+                       The GNU Privacy Guard 2
+                      =========================
+                             Version 2.1
 
+          Copyright 1997-2017 Werner Koch
+          Copyright 1998-2017 Free Software Foundation, Inc.
 
-GnuPG 1.9 is the future version of GnuPG; it is based on some gnupg-1.3
-code and the previous newpg package.  It will eventually lead to a
-GnuPG 2.0 release.  Note that GnuPG 1.4 and 1.9 are not always in sync
-and thus features and bug fixes done in 1.4 are not necessary
-available in 1.9.
 
-You should use this GnuPG version if you want to use the gpg-agent or
-gpgsm (the S/MIME variant of gpg).  Note that the gpg-agent is also
-helpful when using the standard gpg versions (1.4.x as well as some of
-the old 1.2.x).  There are no problems installing 1.4 and 1.9
-alongside; in dact we suggest to do this.
+* INTRODUCTION
 
+  GnuPG is a complete and free implementation of the OpenPGP standard
+  as defined by RFC4880 (also known as PGP).  GnuPG enables encryption
+  and signing of data and communication, and features a versatile key
+  management system as well as access modules for public key
+  directories.
 
-BUILD INSTRUCTIONS
-==================
+  GnuPG, also known as GPG, is a command line tool with features for
+  easy integration with other applications.  A wealth of frontend
+  applications and libraries are available that make use of GnuPG.
+  Starting with version 2 GnuPG provides support for S/MIME and Secure
+  Shell in addition to OpenPGP.
 
-GnuPG 1.9 depends on the following packages:
+  GnuPG is Free Software (meaning that it respects your freedom). It
+  can be freely used, modified and distributed under the terms of the
+  GNU General Public License.
 
-  libgpg-error (ftp://ftp.gnupg.org/gcrypt/libgpg-error/)
-  libgcrypt    (ftp://ftp.gnupg.org/gcrypt/libgcrypt/)
-  libassuan    (ftp://ftp.gnupg.org/gcrypt/alpha/libassuan/)
-  libksba      (ftp://ftp.gnupg.org/gcrypt/alpha/libksba/)
-  
-If you use the configure option --enable-agent-only, libksba is not
-required.
+  Note that the 2.0 series of GnuPG will reach end-of-life on
+  2017-12-31.  It is not possible to install a 2.1.x version along
+  with any 2.0.x version.  However, it is possible to install GnuPG
+  1.4 along with a 2.x version.
 
-You also need the pinentry package for most function of GnuPG; however
-it is not a build requirement.  pinentry is available at
-ftp://ftp.gnupg.org/gcrypt/pinentry/ .
 
-You should get the latest versions of course, the GnuPG configure
-script complains if a version is not sufficient.
+* BUILD INSTRUCTIONS
 
-After building and installing the above packages in the order as given
-above, you may now continue with GnuPG installation (you may also just
-try to build GnuPG to see whether your already installed versions are
-sufficient).
+  GnuPG 2.1 depends on the following GnuPG related packages:
 
-As with all packages, you just have to do
+    npth         (ftp://ftp.gnupg.org/gcrypt/npth/)
+    libgpg-error (ftp://ftp.gnupg.org/gcrypt/libgpg-error/)
+    libgcrypt    (ftp://ftp.gnupg.org/gcrypt/libgcrypt/)
+    libksba      (ftp://ftp.gnupg.org/gcrypt/libksba/)
+    libassuan    (ftp://ftp.gnupg.org/gcrypt/libassuan/)
 
- ./configure
- make
- make install
+  You should get the latest versions of course, the GnuPG configure
+  script complains if a version is not sufficient.
 
-(Before doing install you might need to become root.)
+  For some advanced features several other libraries are required.
+  The configure script prints diagnostic messages if one of these
+  libraries is not available and a feature will not be available..
 
-If everything succeeds, you have a working GnuPG with support for
-S/MIME and smartcards.  Note that there is no binary gpg but a gpg2 so
-that this package won't conflict with a GnuPG 1.2 or 1.3
-installation. gpg2 behaves just like gpg; it is however suggested to
-keep using gpg 1.2.x or 1.3.x. gpg2 is not even build by default.
+  You also need the Pinentry package for most functions of GnuPG;
+  however it is not a build requirement.  Pinentry is available at
+  ftp://ftp.gnupg.org/gcrypt/pinentry/ .
 
-In case of problem please ask on gnupg-dev@gnupg.org for advise.  Note
-that this release is only expected to build on GNU and *BSD systems.
+  After building and installing the above packages in the order as
+  given above, you may continue with GnuPG installation (you may also
+  just try to build GnuPG to see whether your already installed
+  versions are sufficient).
 
-A texinfo manual named `gnupg.info' will get installed. man pages for
-all major components are also provided. Some commands and options
-given below.  See also the section `SMARTCARD INTRO'.
+  As with all packages, you just have to do
 
+    ./configure
+    make
+    make check
+    make install
 
-COMMANDS
-========
+  The "make check" is optional but highly recommended.  To run even
+  more tests you may add "--enable-all-tests" to the configure run.
+  Before running the "make install" you might need to become root.
 
-See the info documentation ("info gnupg") for a full list of commands
-and options.
+  If everything succeeds, you have a working GnuPG with support for
+  OpenPGP, S/MIME, ssh-agent, and smartcards.  Note that there is no
+  binary gpg but a gpg2 so that this package won't conflict with a
+  GnuPG 1.4 installation.  gpg2 behaves just like gpg.
 
-gpgsm:
-------
+  In case of problem please ask on the gnupg-users@gnupg.org mailing
+  list for advise.
 
---learn-card
+  Instruction on how to build for Windows can be found in the file
+  doc/HACKING in the section "How to build an installer for Windows".
+  This requires some experience as developer.
 
-   Read information about the private keys from the smartcard and
-   import the certificates from there.
+  Note that the PKITS tests are always skipped unless you copy the
+  PKITS test data file into the tests/pkits directory.  There is no
+  need to run these test and some of them may even fail because the
+  test scripts are not yet complete.
 
---export
+  You may run
 
-   Export all certificates stored in the Keybox or those specified on
-   the command line.  When using --armor a few informational lines are
-   prepended before each block.
+    gpgconf --list-dirs
 
+  to view the default directories used by GnuPG.
 
-OPTIONS
-=======
+  To quickly build all required software without installing it, the
+  Speedo method may be used:
 
-gpgsm:
-------
+    make -f build-aux/speedo.mk  native
 
---include-certs <n>
+  This method downloads all required libraries and does a native build
+  of GnuPG to PLAY/inst/.  GNU make is required and you need to set
+  LD_LIBRARY_PATH to $(pwd)/PLAY/inst/lib to test the binaries.
 
-  Using N of -2 includes all certificate except for the Root cert,
-  -1 includes all certs, 0 does not include any certs, 1 includes only
-  the signers cert (this is the default) and all other positives
-  values include up to N certs starting with the signer cert.
-  
---policy-file <filename>
+** Specific build problems on some machines:
 
-  Change the default name of the policy file
+*** Apple OSX 10.x using XCode
 
---enable-policy-checks
---disable-policy-checks
+  On some versions the correct location of a header file can't be
+  detected by configure.  To fix that you should run configure like
+  this
 
-  By default policy checks are enabled.  These options may be used to
-  change it.
+    ./configure  gl_cv_absolute_stdint_h=/usr/include/stdint.h
 
---enable-crl-checks
---disable-crl-checks
+  Add other options as needed.
 
-  By default the CRL checks are enabled and the DirMngr is used to
-  check for revoked certificates.  The disable option is most useful
-  with an off-line connection to suppres this check.
 
---agent-program <path_to_agent_program>
+*** Systems without a full C99 compiler
 
-  Specify an agent program to be used for secret key operations.  The
-  default value is "../agent/gpg-agent".  This is only used as a
-  fallback when the envrionment variable GPG_AGENT_INFO is not set or
-  a running agent can't be connected.
-  
---dirmngr-program <path_to_dirmgr_program>
+  If you run into problems with your compiler complaining about dns.c
+  you may use
 
-  Specify a dirmngr program to be used for CRL checks.  The default
-  value is "/usr/sbin/dirmngr".  This is only used as a fallback when
-  the environment variable DIRMNGR_INFO is not set or a running
-  dirmngr can't be connected.
+    ./configure --disable-libdns
 
---no-secmem-warning
+  Add other options as needed.
 
-  Don't print the warning "no secure memory"
 
---armor
+* MIGRATION from 1.4 or 2.0 to 2.1
 
-  Create PEM encoded output.  Default is binary output. 
+  The major change in 2.1 is gpg-agent taking care of the OpenPGP
+  secret keys (those managed by GPG).  The former file "secring.gpg"
+  will not be used anymore.  Newly generated keys are stored in the
+  agent's key store directory "~/.gnupg/private-keys-v1.d/".  The
+  first time gpg needs a secret key it checks whether a "secring.gpg"
+  exists and copies them to the new store.  The old secring.gpg is
+  kept for use by older versions of gpg.
 
---base64 
+  Note that gpg-agent now uses a fixed socket.  All tools will start
+  the gpg-agent as needed.  The formerly used environment variable
+  GPG_AGENT_INFO is ignored by 2.1.  The SSH_AUTH_SOCK environment
+  variable should be set to a fixed value.
 
-  Create Base-64 encoded output; i.e. PEM without the header lines.
+  The Dirmngr is now part of GnuPG proper and also used to access
+  OpenPGP keyservers.  The directory layout of Dirmngr changed to make
+  use of the GnuPG directories.  Dirmngr is started by gpg or gpgsm as
+  needed. There is no more need to install a separate Dirmngr package.
 
---assume-armor
+* RECOMMENDATIONS
 
-  Assume the input data is PEM encoded.  Default is to autodetect the
-  encoding but this is may fail.
+** Socket directory
 
---assume-base64
+  GnuPG uses Unix domain sockets to connect its components (on Windows
+  an emulation of these sockets is used).  Depending on the type of
+  the file system, it is sometimes not possible to use the GnuPG home
+  directory (i.e. ~/.gnupg) as the location for the sockets.  To solve
+  this problem GnuPG prefers the use of a per-user directory below the
+  the /run (or /var/run) hierarchy for the the sockets.  It is thus
+  suggested to create per-user directories on system or session
+  startup.  For example the following snippet can be used in
+  /etc/rc.local to create these directories:
 
-  Assume the input data is plain base-64 encoded.
+      [ ! -d /run/user ] && mkdir /run/user
+      awk -F: </etc/passwd '$3 >= 1000 && $3 < 65000 {print $3}' \
+        | ( while read uid rest; do
+              if [ ! -d "/run/user/$uid" ]; then
+                mkdir /run/user/$uid
+                chown $uid /run/user/$uid
+                chmod 700 /run/user/$uid
+              fi
+            done )
 
---assume-binary
 
-  Assume the input data is binary encoded.
+* DOCUMENTATION
 
---server
+  The complete documentation is in the texinfo manual named
+  `gnupg.info'.  Run "info gnupg" to read it.  If you want a a
+  printable copy of the manual, change to the "doc" directory and
+  enter "make pdf" For a HTML version enter "make html" and point your
+  browser to gnupg.html/index.html.  Standard man pages for all
+  components are provided as well.  An online version of the manual is
+  available at [[https://gnupg.org/documentation/manuals/gnupg/]] .  A
+  version of the manual pertaining to the current development snapshot
+  is at [[https://gnupg.org/documentation/manuals/gnupg-devel/]] .
 
-  Run in server mode.  This is used by GPGME to control gpgsm.  See
-  the assuan specification regarding gpgsm about the used protocol.
-  Some options are ignored in server mode.
 
---local-user  <user_id>
+* Installing GnuPG 2.2. and GnuPG 1.4
 
-  Set the user to be used for signing.  The default is the first
-  secret key found in the database.
+  GnuPG 2.2 is a current version of GnuPG with state of the art
+  security design and many more features.  To install both versions
+  alongside, it is suggested to rename the 1.4 version of "gpg" to
+  "gpg1" as well as the corresponding man page.  Newer releases of the
+  1.4 branch will likely do this by default.  In case this is not
+  possible, the 2.2 version can be installed under the name "gpg2"
+  using the configure option --enable-gpg-is-gpg2.
 
---with-key-data
 
-  Displays extra information with the --list-keys commands.  Especially
-  a line tagged "grp" is printed which tells you the keygrip of a
-  key.  This is string is for example used as the filename of the
-  secret key.
+* HOW TO GET MORE INFORMATION
 
+  A description of new features and changes in version 2.1 can be
+  found in the file "doc/whats-new-in-2.1.txt" and online at
+  "https://gnupg.org/faq/whats-new-in-2.1.html" .
 
+  The primary WWW page is "https://www.gnupg.org"
+             or using Tor "http://ic6au7wa3f6naxjq.onion"
+  The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
 
-gpg-agent:
----------
-
---pinentry-program <path_to_pinentry_program>
-
-  Specify the PINentry program.  The default value is
-  "<prefix>/bin/pinentry" so you most likely want to specify it.
-
---no-grab
-
-  Tell the pinentry not to grab keyboard and mouse.  You most likely
-  want to give this option during testing and development to avoid
-  lockups in case of bugs.
-
-                     
-scdaemon:
---------
-
---ctapi-driver <libraryname>
-
-  The default for Scdaemon is to use the PC/SC API currently provided
-  by libpcsclite.so.  As an alternative the ctAPI can be used by
-  specify this option with the appropriate driver name
-  (e.g. libtowitoko.so).
-
---reader-port <portname>
-
-  This specifies the port of the chipcard reader.  For PC/SC this is
-  currently ignored and the first PC/SC reader is used.  For the
-  ctAPI, a number must be specified (the default is 32768 for the
-  first USB port).
-
---disable-ccid 
-
-  Disable the integrated support for CCID compliant readers.  This
-  allows to fall back to one of the other drivers even if the internal
-  CCID driver can handle the reader.  Note, that CCID support is only
-  available if libusb was available at build time.
-
-
-FILES
-=====
-
-The default home directory is ~/.gnupg.  It can be changed by
-either the --homedir option or by setting the environment variable
-GNUPGHOME.  This is a list of files usually found in this directory:
-
-gpgsm.conf 
-
-        Options for gpgsm.  Options are the same as the command line
-        options but don't enter the leading dashes and give arguments
-        without an equal sign.  Blank lines and lines starting with a
-        hash mark as the first non white space character are ignored.
-
-gpg-agent.conf
-        
-        Options for gpg-agent
-
-scdaemon.conf
-
-        Options for scdaemon.
-
-dirmngr.conf 
-
-        Options for the DirMngr which is not part of this package and
-        the option file will most likely be moved to /etc
-
-gpg.conf
-        
-        Options for gpg.  Note that old versions of gpg use the
-        filename `options' instead of `gpg.conf'.
-
-gpg.conf-1.9.x
-
-        Options for gpg; tried before gpg.conf
-
-
-policies.txt
-
-        A list of allowed CA policies.  This file should give the
-        object identifiers of the policies line by line.  Empty lines
-        and lines starting with a hash mark are ignored.
-
-        ++++++++++
-        2.289.9.9  
-        ++++++++++
-
-trustlist.txt
-
-        A list of trusted certificates. The file will be created
-        automagically with some explaining comments.  By using
-        gpg-agent's option --allow-mark-trusted, gpg-agent may add new
-        entries after user confirmation.
-
-random_seed
-
-        Used internally for keeping the state of the RNG over
-        invocations.
-
-pubring.kbx
-
-        The database file with the certificates. 
-
-pubring.gpg
-
-        The database file with the OpenPGP public keys.  This will
-        eventually be merged with pubring.kbx
-
-secring.gpg
-
-        The database file with the OpenPGP secret keys.  This will be
-        removed when gpg is changed to make use of the gpg-agent.
-
-
-private-keys-v1.d/
-
-        Directory holding the private keys maintained by gpg-agent.
-        For detailed info see agent/keyformat.txt. Note that there is
-        a helper tool gpg-protect-tool which may be used to protect or
-        unprotect keys.  This is however nothing a user should care
-        about.
-
-
-SOURCE FILES
-============
-
-Here is a list of directories with source files:
-
-jnlib/  utility functions
-kbx/    keybox library
-g10/    the gpg program here called gpg2
-sm/     the gpgsm program
-agent/  the gpg-agent
-scd/    the smartcard daemon
-doc/    documentation
-
-
-
-HOW TO SPECIFY A USER ID
-========================
-
-Due to the way X.509 certificates are made up we need a few new ways
-to specify a certificate (aka key in OpenPGP).  In addition to the
-ways a user ID can be specified with gpg, I have implemented 3 new
-modes for gpgsm, here is the entire list of ways to specify a key:
-
- * By keyID.
-
-   This format is deducted from the length of the string and its
-   content or "0x" prefix. For use with OpenPGP an exclamation mark may
-   be appended to force use of the specified (sub)key.
-
-   As with v34 OpenPGP keys, the keyID of an X509 certificate are the
-   low 64 bits of the SHA-1 fingerprint.  The use of keyIDs is just a
-   shortcut, for all automated processing the fingerprint should be
-   used.
-
-   Examples:
-
-       234567C4
-       0F34E556E
-       01347A56A
-       0xAB123456
-
-       234AABBCC34567C4
-       0F323456784E56EAB
-       01AB3FED1347A5612
-       0x234AABBCC34567C4
-
- * By fingerprint
-
-   This is format is deduced from the length of the string and its
-   content or "0x" prefix.  Note, that only the 20 byte fingerprint is
-   used with GPGSM (SHA-1 hash of the certificate).  For use with
-   OpenPGP an exclamation mark may be appended to force use of the
-   specified (sub)key.
-
-   Examples:
-
-       1234343434343434C434343434343434
-       123434343434343C3434343434343734349A3434
-       0E12343434343434343434EAB3484343434343434
-       0xE12343434343434343434EAB3484343434343434
-
- * Exact match on OpenPGP user ID
-
-   This is denoted by a leading equal sign. It does not make much
-   sense for X.509.
-
-   Example:
-
-       =Heinrich Heine <heinrichh@uni-duesseldorf.de>
-
- * Exact match on an email address.
-
-   This is indicated by enclosing the email address in the usual way
-   with left and right angles
-
-   Example:
-
-       <heinrichh@uni-duesseldorf.de>
-
- * Word match
-
-   All words must match exactly (not case sensitive) but can appear in
-   any order in the user ID or a subjects name.  Words are any
-   sequences of letters, digits, the underscore and all characters
-   with bit 7 set.
-
-   Example:
-
-       +Heinrich Heine duesseldorf
-
- * Exact match by subject's DN
-
-   This is indicated by a leading slash, directly followed by the
-   rfc2253 encoded DN of the subject.  Note that you can't use the
-   string printed by "gpgsm --list-keys" because that one as been
-   reordered and modified for better readability; use --with-colons to 
-   print the raw (but standard escaped) rfc2253 string 
-
-   Example:
-
-      /CN=Heinrich Heine,O=Poets,L=Paris,C=FR
-
- * Exact match by issuer's DN
-
-   This is indicated by a leading hash mark, directly followed by a
-   slash and then directly followed by the rfc2253 encoded DN of the
-   issuer.  This should return the Root cert of the issuer.  See note
-   above.
-
-   Example:
-
-      #/CN=Root Cert,O=Poets,L=Paris,C=FR
-
- * Exact match by serial number and issuer's DN
-
-   This is indicated by a hash mark, followed by the hexadecmal
-   representation of the serial number, the followed by a slash and
-   the RFC2253 encoded DN of the issuer. See note above.
-
-   Example:
-
-      #4F03/CN=Root Cert,O=Poets,L=Paris,C=FR
-
- * Substring match
-
-   By case insensitive substring matching.  This is the default mode
-   but applications may want to explicitly indicate this by putting
-   the asterisk in front.
-
-   Example:
-
-        Heine
-        *Heine
-
-
-Please note that we have reused the hash mark identifier which was
-used in old GnuPG versions to indicate the so called local-id.  It is
-not anymore used and there should be no conflict when used with X.509
-stuff.
-
-Using the rfc2253 format of DNs has the drawback that it is not
-possible to map them back to the original encoding, however we don't
-have to do this, because our key database stores this encoding as meta
-data.
-
-Some of the search modes are not yet implemented ;-)
-
-
-HOW TO IMPORT A PRIVATE KEY
-===========================
-There is some limited support to import a private key from a PKCS-12
-file.  
-
- gpgsm --import  foo.p12
-
-This requires that the gpg-agent is running.
-
-
-HOW TO EXPORT A PRIVATE KEY
-===========================
-There is also limited support to export a private key in PKCS-12
-format. However there is no MAC applied.
-
- gpgsm --export-secret-key-p12 userID  >foo.p12
-
-
-SMARTCARD INTRO
-===============
-
-GPG, the OpenPGP part of GnuPG, supports the OpenPGP smartcard
-(surprise!); see http://g10code.com/p-card.html and
-http://www.gnupg.org/documentation/howtos.html#GnuPG-cardHOWTO .
-
-GPGSM, the CMS (S/MIME) part of GnuPG, supports two kinds of
-smartcards.  The most flexible way is to use PKCS#15 compliant cards,
-however you must have build GnuPG with support for the OpenSC library.
-The build process automagically detects the presence of this library
-and will include support for these cards.
-
-The other cards we currently support are the Telesec NetKey card with
-the NKS 2.0 card application and all generic DINSIG cards.
-
-Before GPGSM can make use of a new card it must gather some
-information, like the card's serial number, the public keys and the
-certificates stored on the card.  Thus for a new card you need to run
-the command
-
-  gpgsm --learn-card
-
-once.  This is also a good test to see whether your card reader is
-properly installed. See below in case of error.  Once this has been
-done you may use the keys stored on the card in the same way you use
-keys stored on the disk.  gpgsm automagically knows whether a card is
-required and will pop up the pinentry to ask you to insert the
-correct card.
-
-For selecting the driver, see the options of scdaemon.  A useful
-debugging flag is "--debug 2048" showing the communication between
-scdaemon and the reader.
-
-
+  See [[https://gnupg.org/download/mirrors.html]] for a list of
+  mirrors and use them if possible.  You may also find GnuPG mirrored
+  on some of the regular GNU mirrors.
 
+  We have some mailing lists dedicated to GnuPG:
 
+     gnupg-announce@gnupg.org   For important announcements like new
+                                versions and such stuff.  This is a
+                                moderated list and has very low traffic.
+                                Do not post to this list.
 
+     gnupg-users@gnupg.org      For general user discussion and
+                                help (English).
+
+     gnupg-de@gnupg.org         German speaking counterpart of
+                                gnupg-users.
+
+     gnupg-ru@gnupg.org         Russian speaking counterpart of
+                                gnupg-users.
+
+     gnupg-devel@gnupg.org      GnuPG developers main forum.
+
+  You subscribe to one of the list by sending mail with a subject of
+  "subscribe" to x-request@gnupg.org, where x is the name of the
+  mailing list (gnupg-announce, gnupg-users, etc.). See
+  https://www.gnupg.org/documentation/mailing-lists.html for archives
+  of the mailing lists.
+
+  Please direct bug reports to [[http://bugs.gnupg.org]] or post them
+  direct to the mailing list <gnupg-devel@gnupg.org>.
+
+  Please direct questions about GnuPG to the users mailing list or one
+  of the PGP newsgroups; please do not direct questions to one of the
+  authors directly as we are busy working on improvements and bug
+  fixes.  The English and German mailing lists are watched by the
+  authors and we try to answer questions when time allows us.
+
+  Commercial grade support for GnuPG is available; for a listing of
+  offers see https://www.gnupg.org/service.html .  Maintaining and
+  improving GnuPG requires a lot of time.  Since 2001, g10 Code GmbH,
+  a German company owned and headed by GnuPG's principal author Werner
+  Koch, is bearing the majority of these costs.  To keep GnuPG in a
+  healthy state, they need your support.
+
+  Please consider to donate at https://gnupg.org/donate/ .
+
+
+# This file is Free Software; as a special exception the authors gives
+# unlimited permission to copy and/or distribute it, with or without
+# modifications, as long as this notice is preserved. For conditions
+# of the whole package, please see the file COPYING.  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.
+#
+# Local Variables:
+# mode:org
+# End: