* misc.c (is_secured_filename): New.
[gnupg.git] / README
diff --git a/README b/README
index 3c015a1..9d635e5 100644 (file)
--- a/README
+++ b/README
@@ -1,73 +1,78 @@
------BEGIN PGP SIGNED MESSAGE-----
 
                    GnuPG - The GNU Privacy Guard
                   -------------------------------
-                          Version 0.9.10
+                           Version 1.3.90
 
-    GnuPG is now in Beta test and you should report all bugs to the
-    mailing list (see below).  The 0.9.x versions are released mainly
-    to fix all remaining serious bugs. As soon as version 1.0 is out,
-    development will continue with a 1.1 series and bug fixes for the
-    1.0 version as needed.
+           Copyright 1998, 1999, 2000, 2001, 2002, 2003,
+                2004 Free Software Foundation, Inc.
 
-    GnuPG works best on GNU/Linux or *BSD.  Other Unices are
-    also supported but are not as well tested as the Free Unices.
+    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.
 
-    See the file COPYING for copyright and warranty information.
+    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.
 
-    GnuPG is in compliance with RFC2440 (OpenPGP), see doc/OpenPGP for
-    details.
 
-    Because GnuPG does not use use any patented algorithm it cannot be
-    compatible with PGP2 versions.  PGP 2.x uses only IDEA (which is
-    patented worldwide) and RSA (which is patented in the United States
-    until Sep 20, 2000).
+    Intro
+    -----
 
-    The default algorithms are DSA and ElGamal.  ElGamal for signing
-    is still available, but because of the larger size of such
-    signatures it is deprecated (Please note that the GnuPG
-    implementation of ElGamal signatures is *not* insecure).  Symmetric
-    algorithms are: 3DES, Blowfish, CAST5 and Twofish (GnuPG does not
-    yet create Twofish encrypted messages because there no agreement
-    in the OpenPG WG on how to use it together with a MDC algorithm)
-    Digest algorithms available are MD5, RIPEMD160, SHA1, and TIGER/192.
+    GnuPG is GNU's tool for secure communication and data storage.
+    It can be used to encrypt data and to create digital signatures.
+    It includes an advanced key management facility and is compliant
+    with the proposed OpenPGP Internet standard as described in RFC2440.
 
+    GnuPG works best on GNU/Linux or *BSD systems.  Most other Unices
+    are also supported but are not as well tested as the Free Unices.
+    See http://www.gnupg.org/download/supported_systems.html for a
+    list of systems which are known to work.
 
-    Installation
-    ------------
+    See the file COPYING for copyright and warranty information.
 
-    Please read the file INSTALL!
+    Because GnuPG does not use use any patented algorithms it is not
+    by default fully compatible with PGP 2.x, which uses the patented
+    IDEA algorithm.  See http://www.gnupg.org/why-not-idea.html for
+    more information on this subject, including what to do if you are
+    legally entitled to use IDEA.
 
-    Here is a quick summary:
+    The default public key algorithms are DSA and Elgamal, but RSA is
+    also supported.  Symmetric algorithms available are AES (with 128,
+    192, and 256 bit keys), 3DES, Blowfish, CAST5 and Twofish.  Digest
+    algorithms available are MD5, RIPEMD/160, SHA-1, SHA-256, SHA-384,
+    and SHA-512.  Compression algorithms available are ZIP, ZLIB, and
+    BZIP2 (with libbz2 installed).
+
+
+    Installation
+    ------------
+    Please read the file INSTALL and the sections in this file
+    related to the installation.  Here is a quick summary:
 
-    1) Check that you have unmodified sources. The below on how to do this.
-       Don't skip it - this is an important step!
+    1) Check that you have unmodified sources.  See below on how to do
+       this.  Don't skip it - this is an important step!
 
-    2) Unpack the TAR.  With GNU tar you can do it this way:
-       "tar xzvf gnupg-x.y.z.tar.gz"
+    2) Unpack the tarball.  With GNU tar you can do it this way:
+       "tar xzvf gnupg-x.y.z.tar.gz"
 
     3) "cd gnupg-x.y.z"
 
-    4) "./configure"
+    4) "./configure"
 
     5) "make"
 
     6) "make install"
 
     7) You end up with a "gpg" binary in /usr/local/bin.
-       Note: Because some old programs rely on the existence of a
-       binary named "gpgm"; you should install a symbolic link
-       from gpgm to gpg:
-       "cd /usr/local/bin; ln -s gpg gpgm"
 
-    8) To avoid swapping out of sensitive data, you can install "gpg" as
-       suid root.  If you don't do so, you may want to add the option
-       "no-secmem-warning" to ~/.gnupg/options
+    8) To avoid swapping out of sensitive data, you can install "gpg"
+       setuid root.  If you don't do so, you may want to add the
+       option "no-secmem-warning" to ~/.gnupg/gpg.conf
 
 
     How to Verify the Source
     ------------------------
-
     In order to check that the version of GnuPG which you are going to
     install is an original and unmodified one, you can do it in one of
     the following ways:
        "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
 
        If you do not have this key, you can get it from the source in
-       the file g10/pubring.asc (use "gpg --import g10/pubring.gpg" to
-       add it to the keyring) or from any keyserver.  You have to make
-       sure that this is really the key and not a faked one. You can do
-       this by comparing the output of:
+       the file doc/samplekeys.asc (use "gpg --import  doc/samplekeys.asc"
+       to add it to the keyring) or from any keyserver.  You have to
+       make sure that this is really the key and not a faked one. You
+       can do this by comparing the output of:
 
                $ gpg --fingerprint 0x57548DCD
 
-       with the elsewhere published fingerprint, or - if you are able to
-       _positively_ verify the signature of this README file - with
-       this fingerprint: "6BD9 050F D8FC 941B 4341  2DCC 68B7 AB89 5754 8DCD"
+       with the fingerprint published elsewhere.
 
        Please note, that you have to use an old version of GnuPG to
        do all this stuff.  *Never* use the version which you are going
        to check!
 
 
-    b) If you have a trusted Version of PGP 2 or 5 installed, you
-       can check the supplied PGP 2 signature:
+    b) If you don't have any of the above programs, you have to verify
+       the MD5 checksum:
 
-       $ pgp gnupg-x.y.z.tar.gz.sig gnupg-x.y.z.tar.gz
+       $ md5sum gnupg-x.y.z.tar.gz
 
-       This checks that the detached signature gnupg-x.y.z.tar.gz.sig
-       is indeed a a signature of gnupg-x.y.z.tar.gz.  Please note,
-       that this signature has been created with a RSA signature and
-       you probably can't use this method (due to legal reasons) when
-       you are in the U.S.  The key used to create this signature is
-       the same as the one used to sign this README file.  It should be
-       available at the keyservers and is also included in the source
-       of GnuPG in g10/pubring.asc.
+       This should yield an output _similar_ to this:
 
-       "pub   768R/0C9857A5 1995-09-30 Werner Koch <werner.koch@guug.de>"
+       fd9351b26b3189c1d577f0970f9dcadc  gnupg-x.y.z.tar.gz
 
-       The finperprint of this key is published in printed form in the
-         "Global Trust Register for 1998", ISBN 0-9532397-0-5.
+       Now check that this checksum is _exactly_ the same as the one
+       published via the announcement list and probably via Usenet.
 
 
-    c) If you don't have any of the above programs, you have to verify
-       the MD5 checksum:
+    Documentation
+    -------------
 
-       $ md5sum gnupg-x.y.z.tar.gz.sig
+    The manual will be distributed separately under the name "gph".
+    An online version of the latest manual draft is available at the
+    GnuPG web pages:
 
-       This should yield an output similar to this:
+       http://www.gnupg.org/documentation/
 
-       fd9351b26b3189c1d577f0970f9dcadc  gnupg-x.y.z.tar.gz
+    A list of frequently asked questions is available in the GnuPG
+    distribution in the file doc/FAQ and online as:
 
-       Now check that this checksum is _exactly_ the same as the one
-       published via the anouncement list and probably via Usenet.
+       http://www.gnupg.org/documentation/faqs.html
 
+    A couple of HOWTO documents are available online; for a listing see:
+
+       http://www.gnupg.org/documentation/howtos.html
+
+    A man page with a description of all commands and options gets installed
+    along with the program. 
 
 
     Introduction
     ------------
+    Here is a brief overview on how to use GnuPG - it is strongly suggested
+    that you read the manual and other information about the use of
+    cryptography.  GnuPG is only a tool, secure usage requires that
+    YOU KNOW WHAT YOU ARE DOING.
 
-    This is a brief overview how to use GnuPG - it is strongly suggested
-    that you read the manual^H^H^H more information about the use of
-    cryptography.  GnuPG is only a tool, secure results require that YOU
-    KNOW WHAT YOU ARE DOING.
+    The first time you run gpg, it will create a .gnupg directory in
+    your home directory and populate it with a default configuration
+    file.  Once this is done, you may create a new key, or if you
+    already have keyrings from PGP, you can import them into GnuPG
+    with:
 
-    If you already have a DSA key from PGP 5 (they call them DH/ElGamal)
-    you can simply copy the pgp keyrings over the GnuPG keyrings after
-    running gpg once to create the correct directory.
+        gpg --import path/to/pgp/keyring/pubring.pkr
+    and
+        gpg --import path/to/pgp/keyring/secring.skr
 
     The normal way to create a key is
 
     good random numbers for the key parameters, GnuPG needs to gather
     enough noise (entropy) from your system.  If you see no progress
     during key generation you should start some other activities such
-    as mouse moves or hitting on the CTRL and SHIFT keys.
+    as moving the mouse or hitting the CTRL and SHIFT keys.
 
     Generate a key ONLY on a machine where you have direct physical
-    access - don't do it over the network or on a machine used also
-    by others - especially if you have no access to the root account.
+    access - don't do it over the network or on a machine also used
+    by others, especially if you have no access to the root account.
 
     When you are asked for a passphrase use a good one which you can
-    easy remember.  Don't make the passphrase too long because you have
-    to type it for every decryption or signing; but, - AND THIS IS VERY
-    IMPORTANT - use a good one that is not easily to guess because the
-    security of the whole system relies on your secret key and the
-    passphrase that protects it when someone gains access to your secret
-    keyring.  A good way to select a passphrase is to figure out a short
-    nonsense sentence which makes some sense for you and modify it by
-    inserting extra spaces, non-letters and changing the case of some
-    characters - this is really easy to remember especially if you
-    associate some pictures with it.
+    easily remember.  Don't make the passphrase too long because you
+    have to type it for every decryption or signing; but, - AND THIS
+    IS VERY IMPORTANT - use a good one that is not easily to guess
+    because the security of the whole system relies on your secret key
+    and the passphrase that protects it when someone gains access to
+    your secret keyring.  One good way to select a passphrase is to
+    figure out a short nonsense sentence which makes some sense for
+    you and modify it by inserting extra spaces, non-letters and
+    changing the case of some characters - this is really easy to
+    remember especially if you associate some pictures with it.
 
     Next, you should create a revocation certificate in case someone
     gets knowledge of your secret key or you forgot your passphrase
        "123434343434343C3434343434343734349A3434"
        "0E12343434343434343434EAB3484343434343434"
 
-      The first one is MD5 the others are ripemd160 or sha1.
+      The first one is a short fingerprint for PGP 2.x style keys.
+      The others are long fingerprints for OpenPGP keys.
 
     * By an exact string:
 
 
        "+Heinrich Heine duesseldorf"
 
-      All words must match excatly (not case sensitive) and appear in
+      All words must match exactly (not case sensitive) and appear in
       any order in the user ID.  Words are any sequences of letters,
       digits, the underscore and characters with bit 7 set.
 
-    * By the Local ID (from the trust DB):
-
-       "#34"
-
-      This may be used by a MUA to specify an exact key after selecting
-      a key from GnuPG (by using a special option or an extra utility)
-
     * Or by the usual substring:
 
        "Heine"
     If you use the option "--batch", GnuPG runs in non-interactive mode and
     never prompts for input data.  This does not even allow entering the
     passphrase.  Until we have a better solution (something like ssh-agent),
-    you can use the option "--passphrase-fd n", which works like PGPs
+    you can use the option "--passphrase-fd n", which works like PGP's
     PGPPASSFD.
 
     Batch mode also causes GnuPG to terminate as soon as a BAD signature is
     detailed information about the errors.
 
 
-    Esoteric commands
+    Configure options 
+    -----------------
+    Here is a list of configure options which are sometime useful 
+    for installation.
+
+    --enable-static-rnd=<name> 
+                     Force the use of the random byte gathering
+                    module <name>.  Default is either to use /dev/random
+                    or the auto mode.  Value for name:
+                      egd - Use the module which accesses the
+                            Entropy Gathering Daemon. See the webpages
+                            for more information about it.
+                     unix - Use the standard Unix module which does not
+                            have a very good performance.
+                    linux - Use the module which accesses /dev/random.
+                            This is the first choice and the default one
+                            for GNU/Linux or *BSD.
+                      auto - Compile linux, egd and unix in and 
+                             automagically select at runtime.
+  
+     --with-egd-socket=<name>
+                     This is only used when EGD is used as random
+                     gatherer. GnuPG uses by default "~/.gnupg/entropy"
+                     as the socket to connect EGD.  Using this option the
+                     socket name can be changed.  You may use any filename
+                     here with 2 exceptions:  a filename starting with
+                     "~/" uses the socket in the home directory of the user
+                     and one starting with a "=" uses a socket in the
+                     GnuPG home directory which is "~/.gnupg" by default.
+     --without-readline
+                     Do not include support for the readline libary
+                     even if it is available.  The default is to check
+                     whether the readline libarry is a availbale and
+                     use it to allow fancy command line editing.
+  
+     --with-included-zlib
+                     Forces usage of the local zlib sources. Default is
+                    to use the (shared) library of the system.
+
+     --with-zlib=<DIR>
+                    Look for the system zlib in DIR.
+
+     --with-bzip2=<DIR>
+                    Look for the system libbz2 in DIR.
+
+     --without-bzip2
+                    Disable the BZIP2 compression algorithm.
+
+     --with-included-gettext
+                     Forces usage of the local gettext sources instead of
+                    the one provided by your system.
+
+     --disable-nls
+                     Disable NLS support (See the file ABOUT-NLS)
+
+     --enable-m-guard
+                     Enable the integrated malloc checking code. Please
+                     note that this feature does not work on all CPUs
+                     (e.g. SunOS 5.7 on UltraSparc-2) and might give
+                     you a bus error.
+
+     --disable-dynload 
+                    If you have problems with dynamic loading, this
+                    option disables all dynamic loading stuff.  Note
+                    that the use of dynamic linking is very limited.
+
+     --disable-asm
+                    Do not use assembler modules.  It is not possible 
+                    to use this on some CPU types.
+                    
+     --disable-exec
+                    Disable all remote program execution.  This
+                   disables photo ID viewing as well as all keyserver
+                   access.
+
+     --disable-photo-viewers
+                    Disable only photo ID viewing.
+
+     --disable-keyserver-helpers
+                    Disable only keyserver helpers.
+
+     --disable-keyserver-path
+                    Disables the user's ability to use the exec-path
+                   feature to add additional search directories when
+                   executing a keyserver helper.
+
+     --with-photo-viewer=FIXED_VIEWER
+                    Force the photo viewer to be FIXED_VIEWER and
+                   disable any ability for the user to change it in
+                   their options file.
+
+     --disable-rsa
+                   Removes support for the RSA public key algorithm.
+                    This can give a smaller gpg binary for places
+                    where space is tight.
+
+     --disable-idea
+     --disable-cast5
+     --disable-blowfish
+     --disable-aes
+     --disable-twofish
+     --disable-sha256
+     --disable-sha512
+                   Removes support for the selected symmetric
+                   algorithm.  This can give a smaller gpg binary for
+                   places where space is tight.
+
+                   **** Note that if there are existing keys that
+                   have one of these algorithms as a preference,
+                   messages may be received that use one of these
+                   algorithms and you will not be able to decrypt the
+                   message! ****
+
+                   The public key preference list can be updated to
+                   match the list of available algorithms by using
+                   "gpg --edit-key (thekey)", and running the
+                   "updpref" command.
+
+     --enable-minimal
+                   Build the smallest gpg possible (disables all
+                   optional algorithms, disables keyserver access,
+                   and disables photo IDs).  Specifically, this means
+                   --disable-rsa --disable-idea, --disable-cast5,
+                   --disable-blowfish, --disable-aes,
+                   --disable-twofish, --disable-sha256,
+                   --disable-sha512, --without-bzip2, and
+                   --disable-exec.  Configure command lines are read
+                   from left to right, so if you want to have an
+                   "almost minimal" configuration, you can do (for
+                   example) "--enable-minimal --enable-rsa" to have
+                   RSA added to the minimal build.
+
+     --enable-key-cache=SIZE
+                    Set the internal key and UID cache size.  This has
+                    a significant impact on performance with large
+                    keyrings.  The default is 4096, but for use on
+                    platforms where memory is an issue, it can be set
+                    as low as 5.
+
+     --disable-card-support
+                    Do not include smartcard support.  The default is
+                    to include support if all required libraries are
+                    available.
+
+
+    Installation Problems
+    ---------------------
+    If you get unresolved externals "gettext" you should run configure
+    again with the option "--with-included-gettext"; this is version
+    0.12.1 which is available at ftp.gnu.org.
+
+    If you have other compile problems, try the configure options
+    "--with-included-zlib" or "--disable-nls" (See ABOUT-NLS) or
+    --disable-dynload.
+
+    We can't check all assembler files, so if you have problems
+    assembling them (or the program crashes) use --disable-asm with
+    ./configure.  If you opt to delete individual replacement files in
+    hopes of using the remaining ones, be aware that the configure
+    scripts may consider several subdirectories to get all available
+    assembler files; be sure to delete the correct ones. The assembler
+    replacements are in C and in mpi/generic; never delete
+    udiv-qrnnd.S in any CPU directory, because there may be no C
+    substitute.  Don't forget to delete "config.cache" and run
+    "./config.status --recheck".  We have also heard reports of
+    problems when using versions of gcc earlier than 2.96 along with a
+    non-GNU assembler (as).  If this applies to your platform, you can
+    either upgrade gcc to a more recent version, or use the GNU
+    assembler.
+
+    Some make tools are broken - the best solution is to use GNU's
+    make.  Try gmake or grab the sources from a GNU archive and
+    install them.
+
+    On some OSF systems you may get unresolved externals.  This is a
+    libtool problem and the workaround is to manually remove all the
+    "-lc -lz" but the last one from the linker line and execute them
+    manually.
+
+    On some architectures you see warnings like:
+      longlong.h:175: warning: function declaration isn't a prototype
+    or
+      http.c:647: warning: cast increases required alignment of target type
+    This doesn't matter and we know about it (actually it is due to
+    some warning options which we have enabled for gcc)
+
+
+    Specific problems on some machines
+    ----------------------------------
+
+    * Apple Darwin 6.1:
+
+        ./configure --with-libiconv-prefix=/sw
+
+    * Compaq C V6.2 for alpha:
+
+        You may want to use the option "-msg-disable ptrmismatch1"
+        to get rid of the sign/unsigned char mismatch warnings.
+
+    * IBM RS/6000 running AIX:
+
+       Due to a change in gcc (since version 2.8) the MPI stuff may
+       not build. In this case try to run configure using:
+           CFLAGS="-g -O2 -mcpu=powerpc" ./configure
+
+    * SVR4.2 (ESIX V4.2 cc)
+
+        Due to problems with the ESIX as, you probably want to do
+            CFLAGS="-O -K pentium" ./configure --disable-asm
+
+    * SunOS 4.1.4
+
+         ./configure ac_cv_sys_symbol_underscore=yes
+
+    The Random Device
     -----------------
 
-       gpg --list-packets datafile
-
-    Use this to list the contents of a data file. If the file is encrypted
-    you are asked for the passphrase, so that GnuPG is able to look at the
-    inner structure of a encrypted packet.  This command should list all
-    kinds of rfc2440 messages.
-
-       gpg --list-trustdb
-
-    List the contents of the trust DB in a human readable format
+    Random devices are available in Linux, FreeBSD and OpenBSD.
+    Operating systems without a random devices must use another
+    entropy collector. 
 
-       gpg --list-trustdb  <usernames>
+    This collector works by running a lot of commands that yield more
+    or less unpredictable output and feds this as entropy into the
+    random generator - It should work reliably but you should check
+    whether it produces good output for your version of Unix. There
+    are some debug options to help you (see cipher/rndunix.c).
 
-    List the tree of certificates for the given usernames
 
-       gpg --list-trust-path  username
+    Creating an RPM package
+    -----------------------
+    The file scripts/gnupg.spec is used to build a RPM package (both
+    binary and src):
+      1. copy the spec file into /usr/src/redhat/SPECS
+      2. copy the tar file into /usr/src/redhat/SOURCES
+      3. type: rpm -ba SPECS/gnupg.spec
 
-    List the possible trust paths for the given username. The length
-    of such a trust path is limited by the option --max-cert-depth
-    which defaults to 5.
+    Or use the -t (--tarbuild) option of rpm:
+      1. rpm -ta gnupg-x.x.x.tar.gz
 
-    For more options/commands see the man page or use "gpg --help".
+    The binary rpm file can now be found in /usr/src/redhat/RPMS, source
+    rpm in /usr/src/redhat/SRPMS
 
 
-    Other Notes
-    -----------
+    How to Get More Information
+    ---------------------------
 
-    The primary FTP site is "ftp://ftp.gnupg.org/pub/gcrypt/"
     The primary WWW page is "http://www.gnupg.org"
+    The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
 
-    See http://www.gnupg.org/mirrors.html for a list of FTP mirrors
-    and use them if possible.
+    See http://www.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.
+                                   new versions and such stuff.
                                    This is a moderated list and has
                                    very low traffic.
+
        gnupg-users@gnupg.org       For general user discussion and
                                    help.
+
        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.).  An archive of
-    the mailing lists is available at http://lists.gnupg.org .
+    the mailing lists are available at
+    http://www.gnupg.org/documentation/mailing-lists.html
 
-    The gnupg.org domain is hosted in Germany to avoid possible legal
-    problems (technical advices may count as a violation of ITAR).
-
-    Please direct bug reports to <gnupg-bugs@gnu.org> or post
+    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 and give me more time to improve
-    GnuPG.  Commercial support for GnuPG is also available; please
-    see the GNU service directory or search other resources.
-
-    Have fun and remember: Echelon is looking at you kid.
-
-- -----END PGP SIGNATURE-----
------BEGIN PGP SIGNATURE-----
-Version: GnuPG v0.9.9 (GNU/Linux)
-Comment: For info see http://www.gnupg.org
-
-iQB1AwUBN6figR0Z9MEMmFelAQHydwL+LuKC3W6kRkm0clwab3v8I7zlX0bagxzA
-RStlHXdO6ln1Mo3s3nBuCfrS6LogiUgNRFhNJQ5+rjrTydz00nzcorbyTalqvMlq
-Gnsu9Pd/pTPzvk6kP79yDdoBxfaQGcgw
-=W8uz
------END PGP SIGNATURE-----
+    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.  Both mailing lists are watched by the authors
+    and we try to answer questions when time allows us to do so.
+
+    Commercial grade support for GnuPG is available; please see
+    the GNU service directory or search other resources.