Refresh sample keys
[gnupg.git] / doc / DETAILS
index ef8d3cd..4e87394 100644 (file)
@@ -3,8 +3,8 @@ Format of colon listings
 ========================
 First an example:
 
-$ gpg --fixed-list-mode --with-colons --list-keys \
-   --with-fingerprint --with-fingerprint wk@gnupg.org
+$ gpg --with-colons --list-keys \
+      --with-fingerprint --with-fingerprint wk@gnupg.org
 
 pub:f:1024:17:6C7EE1B8621CC013:899817715:1055898235::m:::scESC:
 fpr:::::::::ECAF7590EB3443B5C7CF3ACB6C7EE1B8621CC013:
@@ -34,7 +34,7 @@ record; gpg2 does this by default and the option is a dummy.
             rev = revocation signature
            fpr = fingerprint: (fingerprint is in field 10)
            pkd = public key data (special field format, see below)
-            grp = reserved for gpgsm
+            grp = keygrip
             rvk = revocation key
             tru = trust database information
             spk = signature subpacket
@@ -52,12 +52,16 @@ record; gpg2 does this by default and the option is a dummy.
                q = Undefined validity
                    '-' and 'q' may safely be treated as the same
                    value for most purposes
-               n = The key is valid
+               n = The key is not valid
                m = The key is marginal valid.
                f = The key is fully valid
                u = The key is ultimately valid.  This often means
                    that the secret key is available, but any key may
-                   be marked as ultimately valid. 
+                   be marked as ultimately valid.
+                w = The key has a well known private part.
+                s = The key has special validity.  This means that it
+                    might be self-signed and expected to be used in
+                    the STEED sytem.
 
             If the validity information is given for a UID or UAT
             record, it describes the validity calculated based on this
@@ -97,7 +101,7 @@ record; gpg2 does this by default and the option is a dummy.
            This is a single letter, but be prepared that additional
            information may follow in some future versions.  For trust
            signatures with a regular expression, this is the regular
-           expression value, quoted as in field 10. 
+           expression value, quoted as in field 10.
 
 10. Field:  User-ID.  The value is quoted like a C string to avoid
            control characters (the colon is quoted "\x3a").
@@ -134,7 +138,7 @@ record; gpg2 does this by default and the option is a dummy.
             this is the same string as the fingerprint. The advantage
             of using this value is that it is guaranteed to have been
             been build by the same lookup algorithm as gpgsm uses.
-            For "uid" records this lists the preferences in the same 
+            For "uid" records this lists the preferences in the same
             way the gpg's --edit-key menu does.
            For "sig" records, this is the fingerprint of the key that
            issued the signature.  Note that this is only filled in if
@@ -147,6 +151,10 @@ record; gpg2 does this by default and the option is a dummy.
 15. Field   Used in sec/sbb to print the serial number of a token
             (internal protect mode 1002) or a '#' if that key is a
             simple stub (internal protect mode 1001)
+16. Field:  For sig records, this is the used hash algorithm:
+                2 = SHA-1
+                8 = SHA-256
+           (for other id's see include/cipher.h)
 
 All dates are displayed in the format yyyy-mm-dd unless you use the
 option --fixed-list-mode in which case they are displayed as seconds
@@ -190,7 +198,7 @@ Example for a "tru" trust base record:
     (gpg's option --marginals-needed)
  7: Number of completely trusted users to introduce a new key signer.
     (gpg's option --completes-needed)
- 8: Maximum depth of a certification chain.  
+ 8: Maximum depth of a certification chain.
     *gpg's option --max-cert-depth)
 
 The "spk" signature subpacket records have the fields:
@@ -236,7 +244,7 @@ more arguments in future versions.
        keyid if it is available.  This is the case with CMS and might
        eventually also be available for OpenPGP.
 
-    EXPKEYSIG  <long_keyid_or_fpr> <username> 
+    EXPKEYSIG  <long_keyid_or_fpr> <username>
         The signature with the keyid is good, but the signature was
        made by an expired key. The username is the primary one
        encoded in UTF-8 and %XX escaped.  The fingerprint may be used
@@ -328,13 +336,13 @@ more arguments in future versions.
 
     UNEXPECTED <what>
         Unexpected data has been encountered
-            0 - not further specified               1       
-  
+            0 - not further specified
+
 
     TRUST_UNDEFINED <error token>
     TRUST_NEVER     <error token>
     TRUST_MARGINAL  [0  [<validation_model>]]
-    TRUST_FULLY     [0  [<validation_model>]] 
+    TRUST_FULLY     [0  [<validation_model>]]
     TRUST_ULTIMATE  [0  [<validation_model>]]
        For good signatures one of these status lines are emitted to
        indicate the validity of the key used to create the signature.
@@ -347,6 +355,7 @@ more arguments in future versions.
            "pgp"   for the standard PGP WoT.
           "shell" for the standard X.509 model.
           "chain" for the chain model.
+           "steed" for the STEED model.
 
         Note that we use the term "TRUST_" in the status names for
         historic reasons; we now speak of validity.
@@ -355,10 +364,7 @@ more arguments in future versions.
     PKA_TRUST_BAD  <mailbox>
         Depending on the outcome of the PKA check one of the above
         status codes is emitted in addition to a TRUST_* status.
-        Without PKA info available or 
-
-    SIGEXPIRED
-       This is deprecated in favor of KEYEXPIRED.
+        Without PKA info available or
 
     KEYEXPIRED <expire-timestamp>
        The key has expired.  expire-timestamp is the expiration time
@@ -379,11 +385,9 @@ more arguments in future versions.
        The ASCII armor is corrupted.  No arguments yet.
 
     RSA_OR_IDEA
-       The IDEA algorithms has been used in the data.  A
-       program might want to fallback to another program to handle
-       the data if GnuPG failed.  This status message used to be emitted
-        also for RSA but this has been dropped after the RSA patent expired.
-        However we can't change the name of the message.
+       Obsolete.  This status message used to be emitted for requests
+        to use the IDEA or RSA algorithms.  It has been dropped from
+        GnuPG 2.1 after the respective patents expired.
 
     SHM_INFO
     SHM_GET
@@ -423,17 +427,6 @@ more arguments in future versions.
        The supplied passphrase was good and the secret key material
        is therefore usable.
 
-    DECRYPTION_FAILED
-       The symmetric decryption failed - one reason could be a wrong
-       passphrase for a symmetrical encrypted message.
-
-    DECRYPTION_OKAY
-       The decryption process succeeded.  This means, that either the
-       correct secret key has been used or the correct passphrase
-       for a conventional encrypted message was given.  The program
-       itself may return an errorcode because it may not be possible to
-       verify a signature for some reasons.
-
     NO_PUBKEY  <long keyid>
     NO_SECKEY  <long keyid>
        The key is not available
@@ -452,7 +445,7 @@ more arguments in future versions.
           1 := Entirely new key.
           2 := New user IDs
           4 := New signatures
-          8 := New subkeys 
+          8 := New subkeys
          16 := Contains private key.
         The flags may be ORed.
 
@@ -465,7 +458,8 @@ more arguments in future versions.
           4 := "Error storing certificate".
 
     IMPORT_RES <count> <no_user_id> <imported> <imported_rsa> <unchanged>
-       <n_uids> <n_subk> <n_sigs> <n_revoc> <sec_read> <sec_imported> <sec_dups> <not_imported>
+       <n_uids> <n_subk> <n_sigs> <n_revoc> <sec_read> <sec_imported>
+        <sec_dups> <skipped_new_keys> <not_imported>
        Final statistics on import process (this is one long line)
 
     FILE_START <what> <filename>
@@ -473,7 +467,7 @@ more arguments in future versions.
        operation:
            1 - verify
             2 - encrypt
-            3 - decrypt        
+            3 - decrypt
 
     FILE_DONE
        Marks the end of a file processing which has been started
@@ -484,6 +478,22 @@ more arguments in future versions.
        Mark the start and end of the actual decryption process.  These
        are also emitted when in --list-only mode.
 
+    DECRYPTION_INFO <mdc_method> <sym_algo>
+        Print information about the symmetric encryption algorithm and
+        the MDC method.  This will be emitted even if the decryption
+        fails.
+
+    DECRYPTION_FAILED
+       The symmetric decryption failed - one reason could be a wrong
+       passphrase for a symmetrical encrypted message.
+
+    DECRYPTION_OKAY
+       The decryption process succeeded.  This means, that either the
+       correct secret key has been used or the correct passphrase
+       for a conventional encrypted message was given.  The program
+       itself may return an errorcode because it may not be possible to
+       verify a signature for some reasons.
+
     BEGIN_ENCRYPTION  <mdc_method> <sym_algo>
     END_ENCRYPTION
        Mark the start and end of the actual encryption process.
@@ -504,7 +514,7 @@ more arguments in future versions.
        "char" is the character displayed with no --status-fd enabled, with
        the linefeed replaced by an 'X'.  "cur" is the current amount
        done and "total" is amount to be done; a "total" of 0 indicates that
-       the total amount is not known.  The condition 
+       the total amount is not known.  The condition
            TOATL && CUR == TOTAL
         may be used to detect the end of an operation.
         Well known values for WHAT:
@@ -523,7 +533,7 @@ more arguments in future versions.
              "learncard"  Send by the agent and gpgsm while learing
                          the data of a smartcard.
              "card_busy"  A smartcard is still working
-        
+
     SIG_CREATED <type> <pubkey algo> <hash algo> <class> <timestamp> <key fpr>
        A signature has been created using these parameters.
            type:  'D' = detached
@@ -535,7 +545,7 @@ more arguments in future versions.
         Note, that TIMESTAMP may either be a number with seconds since
         epoch or an ISO 8601 string which can be detected by the
         presence of the letter 'T' inside.
-        
+
     KEY_CREATED <type> <fingerprint> [<handle>]
         A key has been created
             type: 'B' = primary and subkey
@@ -556,13 +566,13 @@ more arguments in future versions.
        is used.  The format is suitable to be passed to the option
        --override-session-key
 
-    NOTATION_NAME <name> 
+    NOTATION_NAME <name>
     NOTATION_DATA <string>
         name and string are %XX escaped; the data may be split
         among several NOTATION_DATA lines.
 
     USERID_HINT <long main keyid> <string>
-        Give a hint about the user ID for a certain keyID. 
+        Give a hint about the user ID for a certain keyID.
 
     POLICY_URL <string>
         string is %XX escaped
@@ -586,7 +596,8 @@ more arguments in future versions.
           8 := "Policy mismatch"
           9 := "Not a secret key"
         10 := "Key not trusted"
-         11 := "Missing certificate"  (e.g. intermediate or root cert.)
+         11 := "Missing certificate"
+         12 := "Missing issuer certificate"
 
         Note that for historical reasons the INV_RECP status is also
         used for gpgsm's SIGNER command where it relates to signer's
@@ -619,9 +630,9 @@ more arguments in future versions.
 
     SUCCESS [<location>]
         Postive confirimation that an operation succeeded.  <location>
-        is optional but if given should not contain spaces. 
+        is optional but if given should not contain spaces.
         Used only with a few commands.
-            
+
 
     ATTRIBUTE <fpr> <octets> <type> <index> <count>
              <timestamp> <expiredate> <flags>
@@ -648,7 +659,7 @@ more arguments in future versions.
            3 = Card with serialnumber detected
            4 = No card available.
            5 = No card reader available
-           6 = No card support available                      
+           6 = No card support available
 
     PLAINTEXT <format> <timestamp> <filename>
         This indicates the format of the plaintext that is about to be
@@ -694,6 +705,14 @@ more arguments in future versions.
         by g13.
 
 
+Status lines which are not anymore used:
+
+    SIGEXPIRED removed on 2011-02-04.
+       This is deprecated in favor of KEYEXPIRED.
+
+
+
+
 Format of the "--attribute-fd" output
 =====================================
 
@@ -773,184 +792,12 @@ would result in:
 
 Key generation
 ==============
-    See the Libcrypt manual.
+See the Libcrypt manual.
 
 
 Unattended key generation
 =========================
-This feature allows unattended generation of keys controlled by a
-parameter file.  To use this feature, you use --gen-key together with
---batch and feed the parameters either from stdin or from a file given
-on the commandline.
-
-The format of this file is as follows:
-  o Text only, line length is limited to about 1000 chars.
-  o You must use UTF-8 encoding to specify non-ascii characters.
-  o Empty lines are ignored.
-  o Leading and trailing spaces are ignored.
-  o A hash sign as the first non white space character indicates a comment line.
-  o Control statements are indicated by a leading percent sign, the
-    arguments are separated by white space from the keyword.
-  o Parameters are specified by a keyword, followed by a colon.  Arguments
-    are separated by white space.
-  o The first parameter must be "Key-Type", control statements
-    may be placed anywhere.
-  o Key generation takes place when either the end of the parameter file
-    is reached, the next "Key-Type" parameter is encountered or at the
-    control statement "%commit"
-  o Control statements:
-    %echo <text>
-       Print <text>.
-    %dry-run
-       Suppress actual key generation (useful for syntax checking).
-    %commit
-       Perform the key generation.  An implicit commit is done
-       at the next "Key-Type" parameter.
-    %pubring <filename>
-    %secring <filename>
-       Do not write the key to the default or commandline given
-       keyring but to <filename>.  This must be given before the first
-       commit to take place, duplicate specification of the same filename
-       is ignored, the last filename before a commit is used.
-       The filename is used until a new filename is used (at commit points)
-       and all keys are written to that file.  If a new filename is given,
-       this file is created (and overwrites an existing one).
-       Both control statements must be given.
-    %ask-passphrase
-        Enable a mode where the command "passphrase" is ignored and
-        instead the usual passphrase dialog is used.  This does not
-        make sense for batch key generation; however the unattended
-        key generation feature is also used by GUIs and this feature
-        relinquishes the GUI from implementing its own passphrase
-        entry code.  This is a global option.
-    %no-ask-passphrase
-        Disable the ask-passphrase mode.        
-
-   o The order of the parameters does not matter except for "Key-Type"
-     which must be the first parameter.  The parameters are only for the
-     generated keyblock and parameters from previous key generations are not
-     used. Some syntactically checks may be performed.
-     The currently defined parameters are:
-     Key-Type: <algo-number>|<algo-string>
-       Starts a new parameter block by giving the type of the primary
-       key. The algorithm must be capable of signing.  This is a
-       required parameter.  It may be "default" to use the default
-       one; in this case don't give a Key-Usage and use "default" for
-       the Subkey-Type.
-     Key-Length: <length-in-bits>
-       Length of the key in bits.  The default is returned by running
-        the command "gpg --gpgconf-list".
-     Key-Usage: <usage-list>
-        Space or comma delimited list of key usage, allowed values are
-        "encrypt", "sign", and "auth".  This is used to generate the
-        key flags.  Please make sure that the algorithm is capable of
-        this usage.  Note that OpenPGP requires that all primary keys
-        are capable of certification, so no matter what usage is given
-        here, the "cert" flag will be on.  If no Key-Usage is
-        specified and the key-type is not "default", all allowed
-        usages for that particular algorithm are used; if it is not
-        given but "default" is used the usage will be "sign".
-     Subkey-Type: <algo-number>|<algo-string>
-       This generates a secondary key.  Currently only one subkey
-       can be handled.  "default" is also supported.
-     Subkey-Length: <length-in-bits>
-       Length of the subkey in bits.  The default is returned by running
-        the command "gpg --gpgconf-list".
-     Subkey-Usage: <usage-list>
-        Similar to Key-Usage.
-     Passphrase: <string>
-       If you want to specify a passphrase for the secret key,
-       enter it here.  Default is not to use any passphrase.
-     Name-Real: <string>
-     Name-Comment: <string>
-     Name-Email: <string>
-       The 3 parts of a key. Remember to use UTF-8 here.
-       If you don't give any of them, no user ID is created.
-     Expire-Date: <iso-date>|(<number>[d|w|m|y])
-       Set the expiration date for the key (and the subkey).  It may
-       either be entered in ISO date format (2000-08-15) or as number
-       of days, weeks, month or years.  The special notation
-       "seconds=N" is also allowed to directly give an Epoch
-       value. Without a letter days are assumed.  Note that there is
-       no check done on the overflow of the type used by OpenPGP for
-       timestamps.  Thus you better make sure that the given value
-       make sense.  Although OpenPGP works with time intervals, GnuPG
-       uses an absolute value internally and thus the last year we
-       can represent is 2105.
-     Creation-Date: <iso-date>
-        Set the creation date of the key as stored in the key
-        information and which is also part of the fingerprint
-        calculation.  Either a date like "1986-04-26" or a full
-        timestamp like "19860426T042640" may be used.  The time is
-        considered to be UTC.  If it is not given the current time 
-        is used.
-     Preferences: <string>
-        Set the cipher, hash, and compression preference values for
-       this key.  This expects the same type of string as "setpref"
-       in the --edit menu.
-     Revoker: <algo>:<fpr> [sensitive]
-        Add a designated revoker to the generated key.  Algo is the
-       public key algorithm of the designated revoker (i.e. RSA=1,
-       DSA=17, etc.)  Fpr is the fingerprint of the designated
-       revoker.  The optional "sensitive" flag marks the designated
-       revoker as sensitive information.  Only v4 keys may be
-       designated revokers.
-     Handle: <string>
-        This is an optional parameter only used with the status lines
-        KEY_CREATED and KEY_NOT_CREATED.  STRING may be up to 100
-        characters and should not contain spaces.  It is useful for
-        batch key generation to associate a key parameter block with a
-        status line.
-     Keyserver: <string>
-        This is an optional parameter that specifies the preferred
-        keyserver URL for the key.
-
-
-Here is an example on how to create a key:
-$ cat >foo <<EOF
-     %echo Generating a basic OpenPGP key
-     Key-Type: DSA
-     Key-Length: 1024
-     Subkey-Type: ELG-E
-     Subkey-Length: 1024
-     Name-Real: Joe Tester
-     Name-Comment: with stupid passphrase
-     Name-Email: joe@foo.bar
-     Expire-Date: 0
-     Passphrase: abc
-     %pubring foo.pub
-     %secring foo.sec
-     # Do a commit here, so that we can later print "done" :-)
-     %commit
-     %echo done
-EOF
-$ gpg --batch --gen-key foo
- [...]
-$ gpg --no-default-keyring --secret-keyring ./foo.sec \
-                                 --keyring ./foo.pub --list-secret-keys
-/home/wk/work/gnupg-stable/scratch/foo.sec
-------------------------------------------
-sec  1024D/915A878D 2000-03-09 Joe Tester (with stupid passphrase) <joe@foo.bar>
-ssb  1024g/8F70E2C0 2000-03-09
-
-If you want to create a key with the default algorithms you would
-use these parameters:
-
-     %echo Generating a default key
-     Key-Type: default
-     Subkey-Type: default
-     Name-Real: Joe Tester
-     Name-Comment: with stupid passphrase
-     Name-Email: joe@foo.bar
-     Expire-Date: 0
-     Passphrase: abc
-     %pubring foo.pub
-     %secring foo.sec
-     # Do a commit here, so that we can later print "done" :-)
-     %commit
-     %echo done
-
-
+The the manual for a description.
 
 
 Layout of the TrustDB
@@ -1191,9 +1038,12 @@ Other Notes
 OIDs below the GnuPG arc:
 =========================
 
- 1.3.6.1.4.1.11591.2          GnuPG 
+ 1.3.6.1.4.1.11591.2          GnuPG
  1.3.6.1.4.1.11591.2.1          notation
  1.3.6.1.4.1.11591.2.1.1          pkaAddress
+ 1.3.6.1.4.1.11591.2.2          X.509 extensions
+ 1.3.6.1.4.1.11591.2.2.1          standaloneCertificate
+ 1.3.6.1.4.1.11591.2.2.2          wellKnownPrivateKey
  1.3.6.1.4.1.11591.2.12242973   invalid encoded OID
 
 
@@ -1274,4 +1124,3 @@ A better way to do this would be a request like:
 This can be implemented using Hurd's translator mechanism.
 However, I think the whole key server stuff has to be re-thought;
 I have some ideas and probably create a white paper.
-