Support X.509 certificate creation.
[gnupg.git] / doc / DETAILS
index dd3e357..5870927 100644 (file)
@@ -57,7 +57,7 @@ record; gpg2 does this by default and the option is a dummy.
                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.
 
             If the validity information is given for a UID or UAT
             record, it describes the validity calculated based on this
@@ -97,7 +97,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 +134,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
@@ -190,7 +190,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 +236,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 +328,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.
@@ -355,10 +355,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
@@ -423,17 +420,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 +438,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 +451,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 +460,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 +471,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 +507,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 +526,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 +538,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 +559,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 +589,7 @@ more arguments in future versions.
           8 := "Policy mismatch"
           9 := "Not a secret key"
         10 := "Key not trusted"
-         11 := "Missing certificate" 
+         11 := "Missing certificate"
          12 := "Missing issuer certificate"
 
         Note that for historical reasons the INV_RECP status is also
@@ -620,9 +623,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>
@@ -649,7 +652,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
@@ -695,6 +698,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
 =====================================
 
@@ -782,7 +793,8 @@ 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.
+on the commandline.  The description below is only for GPG; GPGSM has
+a similar feature, see the file sm/certreqgen.c for a description.
 
 The format of this file is as follows:
   o Text only, line length is limited to about 1000 chars.
@@ -816,7 +828,8 @@ The format of this file is as follows:
        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.
+        GnuPG < 2.1:  Both control statements must be given.
+        GnuPG >= 2.1: "%secring" is now a no-op.
     %ask-passphrase
         Enable a mode where the command "passphrase" is ignored and
         instead the usual passphrase dialog is used.  This does not
@@ -825,7 +838,7 @@ The format of this file is as follows:
         relinquishes the GUI from implementing its own passphrase
         entry code.  This is a global option.
     %no-ask-passphrase
-        Disable the ask-passphrase mode.        
+        Disable the ask-passphrase mode.
     %no-protection
         With GnuPG 2.1 it is not anymore possible to specify a
         passphrase for unattended key generation.  The passphrase
@@ -896,7 +909,7 @@ The format of this file is as follows:
         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 
+        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
@@ -1205,9 +1218,11 @@ 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.12242973   invalid encoded OID
 
 
@@ -1288,4 +1303,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.
-