2006-07-04 Marcus Brinkmann <marcus@g10code.de>
[libgcrypt.git] / README
diff --git a/README b/README
index 1830189..2f74ce4 100644 (file)
--- a/README
+++ b/README
+                   libgcrypt - The GNU crypto library
+                  ------------------------------------
+                           Version 1.3.x
 
-            G10 - The GNU Encryption and Signing Tool
-           ------------------------------------------
+    WARNING:  This is the development branch of Libgcrypt.  The stable
+    version is 1.2.x.
+    
 
+    Copyright 2000, 2002, 2003, 2004 Free Software Foundation, Inc.
 
-    THIS IS VERSION IS ONLY A TEST VERSION !  YOU SHOULD NOT
-    USE IT FOR OTHER PURPOSES THAN EVALUATING THE CURRENT CODE.
+    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.
 
-    * The data format may change in the next version!
+    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.
 
-    * Some features are not yet implemented
 
 
-    I provide this version as a reality check to start discussion.
-    Please subscribe to g10@net.lut.ac.uk by sending a mail with
-    the word "subscribe" in the body to "g10-request@net.lut.ac.uk".
+    Overview
+    --------
 
+    Libgcrypt is a general purpose crypto library based on the code
+    used in GnuPG.  We can't start with a new version number because
+    libgcrypt was part of gnupg 1.1 and some applications already used
+    it and tested for the version number. We believe that the API can
+    stay as it is, except that new functions may be added in the
+    future.
 
-    See the file COPYING for copyright and warranty information.
+    Libgcrypt depends on the library `libgpg-error', which must be
+    installed correctly before Libgcrypt is to be built.
 
 
-    Due to the fact that G10 does not use use any patented algorithm,
-    it cannot be compatible to old PGP versions, because those use
-    IDEA (which is worldwide patented) and RSA (which is patented in
-    the United States until Sep 20, 2000).  I'm sorry about this, but
-    this is the world we have created (e.g. by using proprietary software).
+    Mailing List
+    ------------
 
+    You may want to join the developer's mailing list
+    gcrypt-devel@gnupg.org by sending mail with a subject of
+    "subscribe" to gcrypt-devel-request@gnupg.org.  An archive of this
+    list is available at http://lists.gnupg.org .
 
-    Because the OpenPGP standard is still a draft, G10 is not yet
-    compatible to it (or PGP 5) - but it will. The data structures
-    used are compatible with PGP 2.x, so it can parse an list such files
-    and PGP should be able to parse data created by G10 and complain
-    about unsupported algorithms.
 
-    The default algorithms used by G10 are ElGamal for public-key
-    encryption and signing; Blowfish with a 160 bit key for protecting
-    the secret-key components, conventional and session encryption;
-    RIPE MD-160 to create message digest.  DSA, SHA-1 and CAST are
-    also implemented, but not used on default. I decided not
-    to use DSA as default signing algorithm, because it allows only for
-    1024 bit keys and this may be not enough in a couple of years.
-
-
-
-    Resources
-    ---------
-    G10 needs a directory "~/.g10" to store the default keyrings
-    and other files.
-
-
-    Key Generation
-    --------------
-
-       g10 --gen-key
-
-    This asks some questions and then starts key generation. To create
-    good random numbers for prime number generation, it uses a /dev/random
-    which will emit only bytes if the kernel can gather enough entropy.
-    If you see no progress, you should start some other activities such
-    as mouse moves or a "find /".  Because we have no hardware device
-    to generate random we have to use this method.
-
-    Key generation shows progress by printing different characters to
-    stderr:
-            "."  Miller-Rabin test failed.
-            "+"  Miller-Rabin test succeeded.
-            "!"  Reloading the pool with fresh prime numbers
-            "^"  Checking a new value for the generator
-            "~"  Issued during generator checks
-            "<"  Size of one factor decreased
-            ">"  Size of one factor increased
-
-    The prime number for ElGamal is generated this way:
-
-    1) Make a prime number q of 160, 200, 240 bits (depending on the keysize).
-    2) Select the length of the other prime factors to be at least the size
-       of q and calculate the number of prime factors needed
-    3) Make a pool of prime number, each of the length determined in step 2
-    4) Get a new permutation out of the pool or continue with step 3
-       if we have tested all permutations.
-    5) Calculate a candidate prime p = 2 * q * p[1] * ... * p[n] + 1
-    6) Check that this prime has the correct length (this may change q if
-       it seems not to be possible to make a prime of the desired length)
-    7) Check whether this is a prime using trial divisions and the
-       Miller-Rabin test.
-    8) Continue with step 4 if we did not find a prime in step 7.
-    9) Find a generator for that prime.
-
-
-    You can sign a key with this command:
-
-       g10 --sign-key Donald
-
-    To sign the key of of "Donald" with your default userid
-
-       g10 --sign-key -u Karl -u Joe Donald
-
-    To sign the key of of "Donald" with the userids of "Karl" and "Joe".
-    All existing signatures are checked, if some are invalid, a menu is
-    offered to delete some of them, and the you are asked for every user
-    wether you want to sign this key.
-
-    You may remove a signature at any time by usiing the option "--edit-sig",
-    which also asks for the sigs to remove.
-
-
-    Sign
-    ----
-
-       g10 -s file
-
-    This creates a file file.g10 which is compressed and has a signature
-    attached.
-
-       g10 -sa file
-
-    Same as above, but file.g10 is ascii armored.
-
-       g10 -s -o out file
-
-    Creates a signature of file, but writes the output to the file "out".
-
-
-    Encrypt
+    License
+    -------
+    
+    Most of this library is distributed under the terms of the GNU
+    Lesser General Public License (LGPL); see the file COPYING.LIB for
+    the actual terms.  However some parts are distributed under the
+    GNU General Public License (GPL) so if you configure Libgcrypt to
+    include these modules, you have to comply with the conditions of
+    the GPL as found in the file COPYING.  The modules under the GPL
+    are:
+
+      rndunix   - Entropy gatherer for Unices without a /dev/random
+      rndw32    - Entropy gatherer for MS Windows
+      gcryptrnd - The random number daemon.
+      getrandom - A client for that daemon.
+
+    The documentation is available under the terms of the GPL.
+
+    This library used to be available under the GPL - this was changed
+    with version 1.1.7 with the rationale that there are now many free
+    crypto libraries available and many of them come with capabilities
+    similar to Libcrypt.  We decided that to foster the use of
+    cryptography in Free Software an LGPLed library would make more
+    sense because it avoids problems due to license incompatibilities
+    between some Free Software licenses and the GPL.
+
+    Please note that in many cases it is better for a library to be
+    licensed under the GPL, so that it provides an advantage for free
+    software projects.  The Lesser GPL is so named because it does
+    less to protect the freedom of the users of the code that it
+    covers.  See http://www.gnu.org/philosophy/why-not-lgpl.html for
+    more explanation.
+
+
+    Configure options 
+    -----------------
+    Here is a list of configure options which are sometimes useful 
+    for installation.
+
+     --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-asm
+                     Do not use assembler modules.  It is not possible 
+                     to use this on some CPU types.
+                    
+     --enable-ld-version-script
+                     Libgcrypt tries to build a library where internal
+                     symbols are not exported.  This requires support
+                     from ld and is currently enabled for a few OSes.
+                     If you know that your ld supports the so called
+                     ELF version scripts, you can use this option to
+                     force its use.  OTOH, if you get error message
+                     from the linker, you probably want to use this
+                     option to disable the use of version scripts.
+                     Note, that you should never ever use an
+                     undocumented symbol or one which is prefixed with
+                     an underscore. 
+
+     --enable-ciphers=list
+     --enable-pubkey-ciphers=list
+     --enable-digests=list
+                     If not otherwise specified, all algorithms
+                     included in the libgcrypt source tree are built.
+                    An exception are algorithms, which depend on
+                    features not provided by the system, like 64bit
+                    data types.  With these switches it is possible
+                     to select exactly those algorithm modules, which
+                    should be built.
+
+    Contact
     -------
 
-       g10 -e -r heine file
-
-    This encrypts files with the public key of "heine" and writes it
-    to "file.g10"
-
-       echo "hallo" | g10 -ea -r heine | mail heine
-
-    Ditto, but encrypts "hallo\n" and mails it as ascii armored message.
-
-
-    Sign and Encrypt
-    ----------------
-
-       g10 -se -r heine file
-
-    This encrypts files with the public key of "heine" and writes it
-    to "file.g10" after signing it with the default user id.
-
-
-       g10 -se -r heine -u Suttner file
-
-    Ditto, but sign the file with the user id "Suttner"
-
-
-
-    Examine a data or key file
-    --------------------------
-
-       g10 --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 G10 is able to look at the
-    inner structure of a encrypted packet.
-
-
-    Batch mode
-    ----------
-    If you use the option "--batch", G10 runs in non-interactive mode and
-    never prompts for input data.  This even does not allow to enter
-    passphrase; until we have a better solution (something like ssh-agent),
-    you can use the option "--passhrase-fd n", which works like PGPs
-    PGPPASSFD.
-
-    Batch mode also causes PGP to terminate as soon as a BAD signature is
-    detected.
-
-
-    Exit status
-    -----------
-    G10 returns with an exit status of 1 if in batch mode and a bad signature
-    has been detected or 2 or higher for all other errors.  You should parse
-    stderr to get detailed informations about the errors.
-
-
-
-    Debug Flags
-    -----------
-    Use the option "--debug n" to output debug informations. This option
-    can be used multiple times, all values are ORed; n maybe prefixed with
-    0x to use hex-values.
-
-        value  used for
-        -----  ----------------------------------------------
-         1     packet reading/writing
-         2     MPI details
-         4     ciphers and primes (may reveal sensitive data)
-         8     iobuf filter functions
-         16    iobuf stuff
-         32    memory allocation stuff
-         64    caching
-         128   show memory statistics at exit
-
-
-
-    Other Notes
-    -----------
-    This is work in progress, so you may find duplicated code fragments,
-    ugly data structures, weird usage of filenames and other thinks.
-    I will run "indent" over the source when making a real distribution,
-    but for now I stick to my own formatting rules.
-
-    The primary FTP site is "ftp://ftp.guug.de/pub/gcrypt/"
-    The primary WWW page is "http://www.d.shuttle.de/isil/g10.html"
-
-    Please direct bug reports to <g10-bugs@isil.d.shuttle.de> or better
-    post them to the mailing list <g10@net.lut.ac.uk>.
-
+    See the file AUTHORS.