post release version number updates
[gnupg.git] / README
diff --git a/README b/README
index 91d3ac9..c14534e 100644 (file)
--- a/README
+++ b/README
+                   The GNU Privacy Guard 2
+                  =========================
+                       Version 1.9.x
 
-            G10 - The GNU Encryption and Signing Tool
-           ------------------------------------------
 
+GnuPG 1.9 is the future version of GnuPG; it is based on the gnupg-1.3
+code and the previous newpg package.  It will eventually lead to a
+GnuPG 2.0 release.  Note that GnuPG 1.3 and 1.9 are not always in sync
+and thus features and bug fixes done in 1.3 are not necessary
+available in 1.9.
 
-    THIS IS VERSION IS ONLY A TEST VERSION !  YOU SHOULD NOT
-    USE IT FOR OTHER PURPOSES THAN EVALUATING THE CURRENT CODE.
+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.2.x or 1.3.x).
 
-    * The data format may change in the next version!
 
-    * Some features are not yet implemented
+BUILD INSTRUCTIONS
+==================
 
+GnuPG 1.9 depends on the following packages:
 
-    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".
+  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.
 
-    See the file COPYING for copyright and warranty information.
+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/ .
 
-    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).
+You should get the latest versions of course, the GnuPG configure
+script complains if a version is not sufficient.
 
+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).
 
-    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.
+As with all packages, you just have to do
 
-    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.
+ ./configure
+ make
+ make install
 
+(Before doing install you might need to become root.)
 
+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 confict 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.
 
-    Installation
-    ------------
+In case of problem please ask on gpa-dev@gnupg.org for advise.  Note
+that this release is only expected to build on GNU and *BSD systems.
 
-    1) "./configure"
+A texinfo manual named `gnupg.info' will get installed.  Some commands
+and options given below.  See also the section `SMARTCARD INTRO'.
 
-       to enable the integrated malloc debugging stuff, use:
 
-       "./configure --enable-m-debug"
+COMMANDS
+========
 
-    2) "make"
+gpgsm:
+------
 
-    3) "make install"
+--learn-card
 
-    4) You end up with a binary "g10" in /usr/local/bin
+   Read information about the private keys from the smartcard and
+   import the certificates from there.
 
-    5) create a directory ".g10" under your hoem directory ("mkdir ~/.g10")
+--export
 
+   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.
 
 
-    Key Generation
-    --------------
+gpg2: (Note that these card commands are also available with gpg 1.3.x)
+-----
 
-       g10 --gen-key
+--card-status
 
-    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, "find /" or using the keyboard (on another window).
-    Because we have no hardware device to generate random we have to use
-    this method.
+   Show information pertaining smartcards implementing the OpenPGP
+   application.
 
-    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
+--change-pin
 
-    The prime number for ElGamal is generated this way:
+   Offers a menu to change the PIN of OpenPGP smartcards and to reset
+   the retry counters.
 
-    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.
+--card-edit
 
+   Offers a menu to change any data object on the card and to generate
+   the keys. 
 
-    You can sign a key with this command:
 
-       g10 --sign-key Donald
+OPTIONS
+=======
 
-    This let you sign the key of "Donald" with your default userid.
+gpgsm:
+------
 
-       g10 --sign-key -u Karl -u Joe Donald
+--include-certs <n>
 
-    This let you 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.
+  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>
 
-    You may remove a signature at any time using the option "--edit-sig",
-    which asks for the sigs to remove.
+  Chnage the deault name of the policy file
 
+--enable-policy-checks
+--disable-policy-checks
 
-    Sign
-    ----
+  By default policy checks are enabled.  These options may be used to
+  change it.
 
-       g10 -s file
+--enable-crl-checks
+--disable-crl-checks
 
-    This creates a file file.g10 which is compressed and has a signature
-    attached.
+  By default the CRL checks are enabled and the DirMngr is used to
+  check for revoked certificates.  The disable option is most useful
+  with a off-line connection to suppres this check.
 
-       g10 -sa file
+--agent-program <path_to_agent_program>
 
-    Same as above, but file.g10 is ascii armored.
+  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 varaibale GPG_AGENT_INFO is not set or
+  a running agent can't be connected.
+  
+--dirmngr-program <path_to_dirmgr_program>
 
-       g10 -s -o out file
+  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 varaibale DIRMNGR_INFO is not set or a running
+  dirmngr can't be connected.
 
-    Creates a signature of file, but writes the output to the file "out".
+--no-secmem-warning
 
+  Don't print the warning "no secure memory"
 
-    Encrypt
-    -------
+--armor
 
-       g10 -e -r heine file
+  Create PEM ecoded output.  Default is binary output. 
 
-    This encrypts files with the public key of "heine" and writes it
-    to "file.g10"
+--base64 
 
-       echo "hallo" | g10 -ea -r heine | mail heine
+  Create Base-64 encoded output; i.e. PEM without the header lines.
 
-    Ditto, but encrypts "hallo\n" and mails it as ascii armored message.
+--assume-armor
 
+  Assume the input data is PEM encoded.  Default is to autodetect the
+  encoding but this is may fail.
 
-    Sign and Encrypt
-    ----------------
+--assume-base64
 
-       g10 -se -r heine file
+  Assume the input data is plain base-64 encoded.
 
-    This encrypts files with the public key of "heine" and writes it
-    to "file.g10" after signing it with the default user id.
+--assume-binary
 
+  Assume the input data is binary encoded.
 
-       g10 -se -r heine -u Suttner file
+--server
 
-    Ditto, but sign the file with the user id "Suttner"
+  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>
 
-    How to Specify a UserID
-    -----------------------
-    There are several ways to specify a userID, here are some examples:
+  Set the user to be used for signing.  The default is the first
+  secret key found in the database.
 
-    * Only by the short keyid (prepend a zero if it start with A..F):
+--with-key-data
 
-       "234567C4"
-       "0F34E556E"
-       "01347A56A"
+  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.
 
-    * By a complete keyid:
 
-       "234AABBCC34567C4"
-       "0F323456784E56EAB"
-       "01AB3FED1347A5612"
 
-    * By a fingerprint (not yet implemented):
+gpg-agent:
+---------
 
-       "1234343434343434C434343434343434"
-       "123434343434343C3434343434343734349A3434"
-       "0E12343434343434343434EAB3484343434343434"
+--pinentry-program <path_to_pinentry_program>
 
-      The first one is MD5 the others are ripemd160 or sha1.
+  Specify the PINentry program.  The default value is
+  "<prefix>/bin/pinentry" so you most likely want to specify it.
 
-    * By an exact string (not yet implemented):
+--no-grab
 
-       "=Heinrich Heine <heinrichh@uni-duesseldorf.de>"
+  Tell the pinentry not to grab keybourd and mouse.  You most likely
+  want to give this option during testing and development to avoid
+  lockups in case of bugs.
 
-    * By an email address:
+                     
+scdaemon:
+--------
 
-       "<heinrichh@uni-duesseldorf.de>"
+--ctapi-driver <libraryname>
 
-      This can be used by a keyserver instead of a substring to
-      find this key faster.
+  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).
 
-    * By the Local ID (from the trustdb):
+--reader-port <portname>
 
-       "#34"
+  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).
 
-      This can be used by a MUA to specify an exact key after selecting
-      a key from G10 (by the use of a special option or an extra utility)
+--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.
 
-    * Or by the usual substring:
 
-       "Heine"
-       "*Heine"
+FILES
+=====
 
-      The '*' indicates substring search explicitly.
+The default home directory is ~/.gnupg.  It can be changed by
+either the --homedir option or by seting 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 whitye space character are ignored.
 
+gpg-agent.conf
+        
+        Options for gpg-agent
 
-    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.
+scdaemon.conf
 
-    Batch mode also causes G10 to terminate as soon as a BAD signature is
-    detected.
+        Options for scdaemon.
 
+dirmngr.conf 
 
-    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.
+        Options for the DirMngr which is not part of this package and
+        the option file wilol 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'.
 
-    Esoteric commands
-    -----------------
+gpg.conf-1.9.x
 
-       g10 --list-packets datafile
+        Options for gpg; tried before gpg.conf
 
-    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.
 
-       --quick-random
+policies.txt
 
-    Do not use the stroing random generator but a faster one.  This can be
-    used to generate keys for tests; those are marked as insecure.
+        A list of allowed CA policies.  This file should give the
+        object identifiers of the policies line by line.  Empty lines
+        and lines startung with a hash mark are ignored.
 
-       --list-trustdb
+        ++++++++++
+        2.289.9.9  
+        ++++++++++
 
-    List the contents of the trustdb in a human readable format
+trustlist.txt
 
-       --list-trustdb  <usernames>
+        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.
 
-    List the tree of certificates for the given usernames
+random_seed
 
-       --list-trust-path  depth  username
+        Used internally for keeping the state of the RNG over
+        invocations.
 
-    List the possible trust paths for the given username, up to the specified
-    depth.  If depth is negative, duplicate introducers are not listed,
-    because those would increase the trust probabilty only minimal.
-    (you must use the special option "--" to stop option parsing when
-     using a negative number). This option may create new entries in the
-    trustdb.
+pubring.kbx
 
-       --print-mds  filenames
+        The database file with the certificates. 
 
-    List all available message digest values for the fiven filenames
+pubring.gpg
 
-       --gen-prime n
+        The database file with the OpenPGP public keys.  This will
+        eventually be merged with pubring.kbx
 
-    Generate and print a simple prime number of size n
+secring.gpg
 
-       --gen-prime n q
+        The database file with the OpenPGP secret keys.  This will be
+        removed when gpg is changed to make use of the gpg-agent.
 
-    Generate a prime number suitable for ElGamal signatures of size n with
-    a q as largest primefactor of n-1.
 
-       --gen-prime n q 1
+private-keys-v1.d/
 
-    Ditto, but calculate a generator too.
+        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.
 
 
-    For more options/commands see the file g10/OPTIONS.
+SOURCE FILES
+============
 
+Here is a list of directories with source files:
 
-    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.
+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
 
-        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
-         256   trust verification stuff
 
 
-    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.
+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 deducded from the length of the string and its
+   content or "0x" prefix. For use with OpenPGP a 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 a 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
+
+ * [NEW] 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
+
+ * [NEW] Excact 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
+
+ * [NEW] Exact match by serial number and subject's DN
+
+   This is indicated by a hash mark, followed by the hexadecmal
+   representation of the serial number, the followed by a slahs 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.
+
+[Fixme: We need to explain this further]
+
+
+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.
+
+[fixme: write more stuff]
+
 
-    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>.