Merged Top directory of NewPG with GnuPG.
[gnupg.git] / README
diff --git a/README b/README
index 1830189..93dc1c8 100644 (file)
--- a/README
+++ b/README
+NewPG is a temporary protect to work on GnuPG extensions.  It will be
+merged into the regular GnuPG sources for a GnuPG 2.0 release.
 
-            G10 - The GNU Encryption and Signing Tool
-           ------------------------------------------
+jnlib/  utility functions
+assuan/ assuan protocol library
+kbx/    keybox library
+sm/     the gpgsm program
+agent/  the gpg-agent
+scd/    the smartcard daemon
 
+Libksba and Libgcrypt are required to build it.  
 
-    THIS IS VERSION IS ONLY A TEST VERSION !  YOU SHOULD NOT
-    USE IT FOR OTHER PURPOSES THAN EVALUATING THE CURRENT CODE.
+Assuan and Keybox are both designed to be source include-able.
 
-    * The data format may change in the next version!
+A texinfo manual `gnupg.info' will get installed.  Some commands and
+options given below.
 
-    * Some features are not yet implemented
 
+COMMANDS
+========
 
-    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".
+gpgsm:
+------
 
+--learn-card
 
-    See the file COPYING for copyright and warranty information.
+   Read tinformation about the private keys from the smartcard and
+   import the certificates from there.
 
+--export
 
-    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).
+    Export all certificates storein the Keybox or those specified on
+    the commandline.  When using --armor a few informational lines are
+    prepended before each block.
 
 
-    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.
+OPTIONS
+=======
 
-    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.
+gpgsm:
+------
 
+--include-certs <n>
 
+  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>
 
-    Resources
-    ---------
-    G10 needs a directory "~/.g10" to store the default keyrings
-    and other files.
+  Chnage the deault name of the policy file
 
+--enable-policy-checks
+--disable-policy-checks
 
-    Key Generation
-    --------------
+  By default policy checks are enabled.  These options may be used to
+  change it.
 
-       g10 --gen-key
+--enable-crl-checks
+--disable-crl-checks
 
-    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.
+  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.
 
-    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
+--agent-program <path_to_agent_program>
 
-    The prime number for ElGamal is generated this way:
+  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>
 
-    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.
+  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 envrionment varaibale DIRMNGR_INFO is not set or a running
+  dirmngr can't be connected.
 
+--no-secmem-warning
 
-    You can sign a key with this command:
+  Don't print the warning "no secure memory"
 
-       g10 --sign-key Donald
+--armor
 
-    To sign the key of of "Donald" with your default userid
+  Create PEM ecoded output.  Default is binary output. 
 
-       g10 --sign-key -u Karl -u Joe Donald
+--base64 
 
-    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.
+  Create Base-64 encoded output; i.e. PEM without the header lines.
 
-    You may remove a signature at any time by usiing the option "--edit-sig",
-    which also asks for the sigs to remove.
+--assume-armor
 
+  Assume the input data is PEM encoded.  Default is to autodetect the
+  encoding but this is may fail.
 
-    Sign
-    ----
+--assume-base64
 
-       g10 -s file
+  Assume the input data is plain base-64 encoded.
 
-    This creates a file file.g10 which is compressed and has a signature
-    attached.
+--assume-binary
 
-       g10 -sa file
+  Assume the input data is binary encoded.
 
-    Same as above, but file.g10 is ascii armored.
+--server
 
-       g10 -s -o out file
+  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.
 
-    Creates a signature of file, but writes the output to the file "out".
+--local-user  <user_id>
 
+  Set the user to be used for signing.  The default is the first
+  secret key found in the database.
 
-    Encrypt
-    -------
+--with-key-data
 
-       g10 -e -r heine file
+  Displays extra information with the --list-keys commands.  Especiall
+  a line tagged "grp" si printed which tells you the keygrip of a
+  key.  This is string is for example used as the filename of the
+  secret key.
 
-    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.
+gpg-agent:
+---------
 
+--pinentry-program <path_to_pinentry_program>
 
-    Sign and Encrypt
-    ----------------
+  Specify the PINentry program.  The default value is
+  "../../pinentry/kpinentry/kpinentry" so you most likely want to
+  specify it. 
 
-       g10 -se -r heine file
+--no-grab
 
-    This encrypts files with the public key of "heine" and writes it
-    to "file.g10" after signing it with the default user id.
+  Tel 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.
 
+                     
 
-       g10 -se -r heine -u Suttner file
 
-    Ditto, but sign the file with the user id "Suttner"
 
+FILES
+=====
 
+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:
 
-    Examine a data or key file
-    --------------------------
+gpgsm.conf 
 
-       g10 --list-packets datafile
+        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.
 
-    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.
+gpg-agent.conf
+        
+        Options for gpg-agent
 
+scdaemon.conf
 
-    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.
+        Options for scdaemon.
 
-    Batch mode also causes PGP to terminate as soon as a BAD signature is
-    detected.
+dirmngr.conf 
 
+        Options for the DirMngr which is not part of this package and
+        the option file wilol most likely be moved to /etc
 
-    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.
+gpg.conf
+        
+        Options for gpg.  Note that old versions of gpg use the
+        filename `options' instead of `gpg.conf'.
 
+policies.txt
 
+        A list of allowed CA policies.  This file should give the
+        object identifiers of the policies line by line.  emptry lines
+        and lines startung with a hash mark are ignored.
 
-    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.
+        ++++++++++
+        2.289.9.9  
+        ++++++++++
 
-        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
+trustlist.txt
 
+        A list of trusted certificates usually maintained by
+        gpg-agent.  It can however be edited manually.  The file will
+        be created automagically with some explaining comments.
 
+random_seed
 
-    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.
+        Used internally for keeping the state of the RNG over
+        invocations.
 
-    The primary FTP site is "ftp://ftp.guug.de/pub/gcrypt/"
-    The primary WWW page is "http://www.d.shuttle.de/isil/g10.html"
+pubring.kbx
 
-    Please direct bug reports to <g10-bugs@isil.d.shuttle.de> or better
-    post them to the mailing list <g10@net.lut.ac.uk>.
+        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.
+
+
+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.
+
+   Example:
+
+      /CN=Henrich 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
+
+   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.
+
+   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 indentifier 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.  Note, that this does only import the private key and not any
+certificates available in that file. 
+
+ gpg-protect-tool --p12-import --store  foo.p12
+
+This require that the gpg-agent is running, alternative you may give
+the passphrase on the commandline using the option "-P <passphrase>" -
+however this is in general not a good idea.  If that key already
+exists, the protect-tool refuses to store it unless you use the option
+"--force". 
+
+How to export a private key
+===========================
+There is also limited support to export a private key in PKCS-12
+format. However the certificate is not stored and there is no MAC applied.
+
+ gpg-protect-tool --p12-export  foo.key  >foo.p12