gpg: Improve keydb handling in the main import function.
[gnupg.git] / g10 / sig-check.c
index 4d39e09..f8e366b 100644 (file)
@@ -16,7 +16,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, see <http://www.gnu.org/licenses/>.
+ * along with this program; if not, see <https://www.gnu.org/licenses/>.
  */
 
 #include <config.h>
 #include <string.h>
 
 #include "gpg.h"
-#include "util.h"
+#include "../common/util.h"
 #include "packet.h"
 #include "keydb.h"
 #include "main.h"
-#include "status.h"
-#include "i18n.h"
+#include "../common/status.h"
+#include "../common/i18n.h"
 #include "options.h"
 #include "pkglue.h"
+#include "../common/compliance.h"
 
 static int check_signature_end (PKT_public_key *pk, PKT_signature *sig,
                                gcry_md_hd_t digest,
@@ -42,12 +43,33 @@ static int check_signature_end (PKT_public_key *pk, PKT_signature *sig,
 static int check_signature_end_simple (PKT_public_key *pk, PKT_signature *sig,
                                        gcry_md_hd_t digest);
 
+
+/* Statistics for signature verification.  */
+struct
+{
+  unsigned int total;  /* Total number of verifications.  */
+  unsigned int cached; /* Number of seen cache entries.  */
+  unsigned int goodsig;/* Number of good verifications from the cache.  */
+  unsigned int badsig; /* Number of bad verifications from the cache.  */
+} cache_stats;
+
+
+/* Dump verification stats.  */
+void
+sig_check_dump_stats (void)
+{
+  log_info ("sig_cache: total=%u cached=%u good=%u bad=%u\n",
+            cache_stats.total, cache_stats.cached,
+            cache_stats.goodsig, cache_stats.badsig);
+}
+
+
 /* Check a signature.  This is shorthand for check_signature2 with
    the unnamed arguments passed as NULL.  */
 int
-check_signature (PKT_signature *sig, gcry_md_hd_t digest)
+check_signature (ctrl_t ctrl, PKT_signature *sig, gcry_md_hd_t digest)
 {
-    return check_signature2 (sig, digest, NULL, NULL, NULL, NULL);
+  return check_signature2 (ctrl, sig, digest, NULL, NULL, NULL, NULL);
 }
 
 
@@ -89,7 +111,8 @@ check_signature (PKT_signature *sig, gcry_md_hd_t digest)
  *
  * Returns 0 on success.  An error code otherwise.  */
 gpg_error_t
-check_signature2 (PKT_signature *sig, gcry_md_hd_t digest, u32 *r_expiredate,
+check_signature2 (ctrl_t ctrl,
+                  PKT_signature *sig, gcry_md_hd_t digest, u32 *r_expiredate,
                  int *r_expired, int *r_revoked, PKT_public_key **r_pk)
 {
     int rc=0;
@@ -110,6 +133,14 @@ check_signature2 (PKT_signature *sig, gcry_md_hd_t digest, u32 *r_expiredate,
 
     if ( (rc=openpgp_md_test_algo(sig->digest_algo)) )
       ; /* We don't have this digest. */
+    else if (! gnupg_digest_is_allowed (opt.compliance, 0, sig->digest_algo))
+      {
+       /* Compliance failure.  */
+       log_info (_("digest algorithm '%s' may not be used in %s mode\n"),
+                 gcry_md_algo_name (sig->digest_algo),
+                 gnupg_compliance_option_string (opt.compliance));
+       rc = gpg_error (GPG_ERR_DIGEST_ALGO);
+      }
     else if ((rc=openpgp_pk_test_algo(sig->pubkey_algo)))
       ; /* We don't have this pubkey algo. */
     else if (!gcry_md_is_enabled (digest,sig->digest_algo))
@@ -122,8 +153,19 @@ check_signature2 (PKT_signature *sig, gcry_md_hd_t digest, u32 *r_expiredate,
         log_info(_("WARNING: signature digest conflict in message\n"));
        rc = gpg_error (GPG_ERR_GENERAL);
       }
-    else if( get_pubkey( pk, sig->keyid ) )
+    else if( get_pubkey (ctrl, pk, sig->keyid ) )
       rc = gpg_error (GPG_ERR_NO_PUBKEY);
+    else if (! gnupg_pk_is_allowed (opt.compliance, PK_USE_VERIFICATION,
+                                   pk->pubkey_algo, pk->pkey,
+                                    nbits_from_pk (pk),
+                                   NULL))
+      {
+       /* Compliance failure.  */
+       log_error (_("key %s may not be used for signing in %s mode\n"),
+                   keystr_from_pk (pk),
+                   gnupg_compliance_option_string (opt.compliance));
+       rc = gpg_error (GPG_ERR_PUBKEY_ALGO);
+      }
     else if(!pk->flags.valid)
       {
         /* You cannot have a good sig from an invalid key.  */
@@ -163,6 +205,7 @@ check_signature2 (PKT_signature *sig, gcry_md_hd_t digest, u32 *r_expiredate,
                rc = gpg_error (GPG_ERR_GENERAL);
              }
          }
+
       }
 
     if( !rc && sig->sig_class < 2 && is_status_enabled() ) {
@@ -190,7 +233,7 @@ check_signature2 (PKT_signature *sig, gcry_md_hd_t digest, u32 *r_expiredate,
        unsigned char *p, *buffer;
         size_t n, nbytes;
         int i;
-        char hashbuf[20];
+        char hashbuf[20];  /* We use SHA-1 here.  */
 
         nbytes = 6;
        for (i=0; i < nsig; i++ )
@@ -467,7 +510,11 @@ check_signature_end_simple (PKT_public_key *pk, PKT_signature *sig,
         return GPG_ERR_GENERAL;
 
     /* Verify the signature.  */
+    if (DBG_CLOCK && sig->sig_class <= 0x01)
+      log_clock ("enter pk_verify");
     rc = pk_verify( pk->pubkey_algo, result, sig->data, pk->pkey );
+    if (DBG_CLOCK && sig->sig_class <= 0x01)
+      log_clock ("leave pk_verify");
     gcry_mpi_release (result);
 
     if( !rc && sig->flags.unknown_critical )
@@ -560,7 +607,7 @@ cache_sig_result ( PKT_signature *sig, int result )
  * revoked, B is still revoked.  I'm not completely convinced this is
  * the proper behavior, but it matches how PGP does it. -dms */
 int
-check_revocation_keys (PKT_public_key *pk, PKT_signature *sig)
+check_revocation_keys (ctrl_t ctrl, PKT_public_key *pk, PKT_signature *sig)
 {
   static int busy=0;
   int i;
@@ -616,7 +663,8 @@ check_revocation_keys (PKT_public_key *pk, PKT_signature *sig)
          /* The revoker's keyid.  */
           u32 keyid[2];
 
-          keyid_from_fingerprint(pk->revkey[i].fpr,MAX_FINGERPRINT_LEN,keyid);
+          keyid_from_fingerprint (ctrl, pk->revkey[i].fpr,
+                                  MAX_FINGERPRINT_LEN, keyid);
 
           if(keyid[0]==sig->keyid[0] && keyid[1]==sig->keyid[1])
            /* The signature was generated by a designated revoker.
@@ -629,7 +677,7 @@ check_revocation_keys (PKT_public_key *pk, PKT_signature *sig)
               hash_public_key(md,pk);
              /* Note: check_signature only checks that the signature
                 is good.  It does not fail if the key is revoked.  */
-              rc=check_signature(sig,md);
+              rc = check_signature (ctrl, sig, md);
              cache_sig_result(sig,rc);
               gcry_md_close (md);
              break;
@@ -685,47 +733,49 @@ check_backsig (PKT_public_key *main_pk,PKT_public_key *sub_pk,
  * passed as NULL.  See the documentation for that function for more
  * details.  */
 int
-check_key_signature (KBNODE root, KBNODE node, int *is_selfsig)
+check_key_signature (ctrl_t ctrl, kbnode_t root, kbnode_t node,
+                     int *is_selfsig)
 {
-  return check_key_signature2 (root, node, NULL, NULL, is_selfsig, NULL, NULL);
+  return check_key_signature2 (ctrl, root, node, NULL, NULL,
+                               is_selfsig, NULL, NULL);
 }
 
 
 /* Returns whether SIGNER generated the signature SIG over the packet
  PACKET, which is a key, subkey or uid, and comes from the key block
  KB.  (KB is PACKET's corresponding keyblock; we don't assume that
  SIG has been added to the keyblock.)
-
  If SIGNER is set, then checks whether SIGNER generated the
  signature.  Otherwise, uses SIG->KEYID to find the alleged signer.
  This parameter can be used to effectively override the alleged
  signer that is stored in SIG.
-
  KB may be NULL if SIGNER is set.
-
  Unlike check_key_signature, this function ignores any cached
  results!  That is, it does not consider SIG->FLAGS.CHECKED and
  SIG->FLAGS.VALID nor does it set them.
-
  This doesn't check the signature's semantic mean.  Concretely, it
  doesn't check whether a non-self signed revocation signature was
  created by a designated revoker.  In fact, it doesn't return an
  error for a binding generated by a completely different key!
-
  Returns 0 if the signature is valid.  Returns GPG_ERR_SIG_CLASS if
  this signature can't be over PACKET.  Returns GPG_ERR_NOT_FOUND if
  the key that generated the signature (according to SIG) could not
  be found.  Returns GPG_ERR_BAD_SIGNATURE if the signature is bad.
  Other errors codes may be returned if something else goes wrong.
-
  IF IS_SELFSIG is not NULL, sets *IS_SELFSIG to 1 if this is a
  self-signature (by the key's primary key) or 0 if not.
-
  If RET_PK is not NULL, returns a copy of the public key that
  generated the signature (i.e., the signer) on success.  This must
  be released by the caller using release_public_key_parts ().  */
* PACKET, which is a key, subkey or uid, and comes from the key block
* KB.  (KB is PACKET's corresponding keyblock; we don't assume that
* SIG has been added to the keyblock.)
+ *
* If SIGNER is set, then checks whether SIGNER generated the
* signature.  Otherwise, uses SIG->KEYID to find the alleged signer.
* This parameter can be used to effectively override the alleged
* signer that is stored in SIG.
+ *
* KB may be NULL if SIGNER is set.
+ *
* Unlike check_key_signature, this function ignores any cached
* results!  That is, it does not consider SIG->FLAGS.CHECKED and
* SIG->FLAGS.VALID nor does it set them.
+ *
* This doesn't check the signature's semantic mean.  Concretely, it
* doesn't check whether a non-self signed revocation signature was
* created by a designated revoker.  In fact, it doesn't return an
* error for a binding generated by a completely different key!
+ *
* Returns 0 if the signature is valid.  Returns GPG_ERR_SIG_CLASS if
* this signature can't be over PACKET.  Returns GPG_ERR_NOT_FOUND if
* the key that generated the signature (according to SIG) could not
* be found.  Returns GPG_ERR_BAD_SIGNATURE if the signature is bad.
* Other errors codes may be returned if something else goes wrong.
+ *
* IF IS_SELFSIG is not NULL, sets *IS_SELFSIG to 1 if this is a
* self-signature (by the key's primary key) or 0 if not.
+ *
* If RET_PK is not NULL, returns a copy of the public key that
* generated the signature (i.e., the signer) on success.  This must
* be released by the caller using release_public_key_parts ().  */
 gpg_error_t
-check_signature_over_key_or_uid (PKT_public_key *signer,
+check_signature_over_key_or_uid (ctrl_t ctrl, PKT_public_key *signer,
                                  PKT_signature *sig, KBNODE kb, PACKET *packet,
                                  int *is_selfsig, PKT_public_key *ret_pk)
 {
@@ -750,8 +800,8 @@ check_signature_over_key_or_uid (PKT_public_key *signer,
       /* Primary key revocation.  */
       || sig->sig_class == 0x20)
     {
+      /* Key revocations can only be over primary keys.  */
       if (packet->pkttype != PKT_PUBLIC_KEY)
-        /* Key revocations can only be over primary keys.  */
         return gpg_error (GPG_ERR_SIG_CLASS);
     }
   else if (/* Subkey binding.  */
@@ -794,19 +844,19 @@ check_signature_over_key_or_uid (PKT_public_key *signer,
       /* Get the signer.  If possible, avoid a look up.  */
       if (sig->keyid[0] == pripk->keyid[0]
           && sig->keyid[1] == pripk->keyid[1])
-        /* Issued by the primary key.  */
         {
+          /* Issued by the primary key.  */
           signer = pripk;
           if (is_selfsig)
             *is_selfsig = 1;
         }
       else
         {
+          /* See if one of the subkeys was the signer (although this
+             is extremely unlikely).  */
           kbnode_t ctx = NULL;
           kbnode_t n;
 
-          /* See if one of the subkeys was the signer (although this
-             is extremely unlikely).  */
           while ((n = walk_kbnode (kb, &ctx, 0)))
             {
               PKT_public_key *subk;
@@ -817,21 +867,24 @@ check_signature_over_key_or_uid (PKT_public_key *signer,
               subk = n->pkt->pkt.public_key;
               if (sig->keyid[0] == subk->keyid[0]
                   && sig->keyid[1] == subk->keyid[1])
-                /* Issued by a subkey.  */
                 {
+                  /* Issued by a subkey.  */
                   signer = subk;
                   break;
                 }
             }
 
           if (! signer)
-            /* Signer by some other key.  */
             {
+              /* Signer by some other key.  */
               if (is_selfsig)
                 *is_selfsig = 0;
               if (ret_pk)
                 {
                   signer = ret_pk;
+                  /* FIXME: Using memset here is probematic because it
+                   * assumes that there are no allocated fields in
+                   * SIGNER.  */
                   memset (signer, 0, sizeof (*signer));
                   signer_alloced = 1;
                 }
@@ -841,20 +894,20 @@ check_signature_over_key_or_uid (PKT_public_key *signer,
                   signer_alloced = 2;
                 }
 
-              rc = get_pubkey (signer, sig->keyid);
+              rc = get_pubkey (ctrl, signer, sig->keyid);
               if (rc)
                 {
                   xfree (signer);
                   signer = NULL;
                   signer_alloced = 0;
-                  goto out;
+                  goto leave;
                 }
             }
         }
     }
 
   /* We checked above that we supported this algo, so an error here is
-     a bug.  */
+   * a bug.  */
   if (gcry_md_open (&md, sig->digest_algo, 0))
     BUG ();
 
@@ -870,7 +923,7 @@ check_signature_over_key_or_uid (PKT_public_key *signer,
       rc = check_signature_end_simple (signer, sig, md);
     }
   else if (/* Primary key binding (made by a subkey).  */
-      sig->sig_class == 0x19)
+           sig->sig_class == 0x19)
     {
       log_assert (packet->pkttype == PKT_PUBLIC_KEY);
       hash_public_key (md, packet->pkt.public_key);
@@ -901,27 +954,31 @@ check_signature_over_key_or_uid (PKT_public_key *signer,
       rc = check_signature_end_simple (signer, sig, md);
     }
   else
-    /* We should never get here.  (The first if above should have
-       already caught this error.)  */
-    BUG ();
+    {
+      /* We should never get here.  (The first if above should have
+       * already caught this error.)  */
+      BUG ();
+    }
 
   gcry_md_close (md);
 
out:
-  if (! rc && ret_pk && (signer_alloced == -1 || ret_pk != signer))
leave:
+  if (! rc && ret_pk && ret_pk != signer)
     copy_public_key (ret_pk, signer);
-  if (signer_alloced == 1)
-    /* We looked up SIGNER; it is not a pointer into KB.  */
+
+  if (signer_alloced)
     {
+      /* We looked up SIGNER; it is not a pointer into KB.  */
       release_public_key_parts (signer);
+      /* Free if we also allocated the memory.  */
       if (signer_alloced == 2)
-        /* We also allocated the memory.  */
         xfree (signer);
     }
 
   return rc;
 }
 
+
 /* Check that a signature over a key (e.g., a key revocation, key
  * binding, user id certification, etc.) is valid.  If the function
  * detects a self-signature, it uses the public key from the specified
@@ -957,7 +1014,8 @@ check_signature_over_key_or_uid (PKT_public_key *signer,
  * TODO: add r_revoked here as well.  It has the same problems as
  * r_expiredate and r_expired and the cache.  */
 int
-check_key_signature2 (kbnode_t root, kbnode_t node, PKT_public_key *check_pk,
+check_key_signature2 (ctrl_t ctrl,
+                      kbnode_t root, kbnode_t node, PKT_public_key *check_pk,
                       PKT_public_key *ret_pk, int *is_selfsig,
                       u32 *r_expiredate, int *r_expired )
 {
@@ -980,13 +1038,15 @@ check_key_signature2 (kbnode_t root, kbnode_t node, PKT_public_key *check_pk,
   algo = sig->digest_algo;
 
   /* Check whether we have cached the result of a previous signature
-     check.  Note that we may no longer have the pubkey or hash
-     needed to verify a sig, but can still use the cached value.  A
-     cache refresh detects and clears these cases. */
+   * check.  Note that we may no longer have the pubkey or hash
+   * needed to verify a sig, but can still use the cached value.  A
+   * cache refresh detects and clears these cases. */
   if ( !opt.no_sig_cache )
     {
+      cache_stats.total++;
       if (sig->flags.checked) /* Cached status available.  */
         {
+          cache_stats.cached++;
           if (is_selfsig)
             {
               u32 keyid[2];
@@ -996,11 +1056,17 @@ check_key_signature2 (kbnode_t root, kbnode_t node, PKT_public_key *check_pk,
                 *is_selfsig = 1;
            }
           /* BUG: This is wrong for non-self-sigs... needs to be the
-             actual pk.  */
+           * actual pk.  */
           rc = check_signature_metadata_validity (pk, sig, r_expired, NULL);
           if (rc)
             return rc;
-          return sig->flags.valid? 0 : gpg_error (GPG_ERR_BAD_SIGNATURE);
+          if (sig->flags.valid)
+            {
+              cache_stats.goodsig++;
+              return 0;
+            }
+          cache_stats.badsig++;
+          return gpg_error (GPG_ERR_BAD_SIGNATURE);
         }
     }
 
@@ -1018,13 +1084,14 @@ check_key_signature2 (kbnode_t root, kbnode_t node, PKT_public_key *check_pk,
 
       /* Is it a designated revoker? */
       if (keyid[0] != sig->keyid[0] || keyid[1] != sig->keyid[1])
-        rc = check_revocation_keys (pk, sig);
+        rc = check_revocation_keys (ctrl, pk, sig);
       else
         {
           rc = check_signature_metadata_validity (pk, sig,
                                                   r_expired, NULL);
           if (! rc)
-            rc = check_signature_over_key_or_uid (pk, sig, root, root->pkt,
+            rc = check_signature_over_key_or_uid (ctrl, pk, sig,
+                                                  root, root->pkt,
                                                   is_selfsig, ret_pk);
         }
     }
@@ -1038,12 +1105,15 @@ check_key_signature2 (kbnode_t root, kbnode_t node, PKT_public_key *check_pk,
           rc = check_signature_metadata_validity (pk, sig,
                                                   r_expired, NULL);
           if (! rc)
-            /* 0x28 must be a self-sig, but 0x18 needn't be.  */
-            rc = check_signature_over_key_or_uid (sig->sig_class == 0x18
-                                                  ? NULL : pk,
-                                                  sig, root, snode->pkt,
-                                                  is_selfsig, ret_pk);
-       }
+            {
+              /* 0x28 must be a self-sig, but 0x18 needn't be.  */
+              rc = check_signature_over_key_or_uid (ctrl,
+                                                    sig->sig_class == 0x18
+                                                    ? NULL : pk,
+                                                    sig, root, snode->pkt,
+                                                    is_selfsig, ret_pk);
+            }
+        }
       else
         {
           if (opt.verbose)
@@ -1063,7 +1133,7 @@ check_key_signature2 (kbnode_t root, kbnode_t node, PKT_public_key *check_pk,
         rc = check_signature_metadata_validity (pk, sig,
                                                 r_expired, NULL);
         if (! rc)
-          rc = check_signature_over_key_or_uid (pk, sig, root, root->pkt,
+          rc = check_signature_over_key_or_uid (ctrl, pk, sig, root, root->pkt,
                                                 is_selfsig, ret_pk);
       }
     else if (/* Certification.  */
@@ -1080,10 +1150,13 @@ check_key_signature2 (kbnode_t root, kbnode_t node, PKT_public_key *check_pk,
           {
             rc = check_signature_metadata_validity (pk, sig, r_expired, NULL);
             if (! rc)
-              /* If this is a self-sig, ignore check_pk.  */
-              rc = check_signature_over_key_or_uid
-                (keyid_cmp (pk_keyid (pk), sig->keyid) == 0 ? pk : check_pk,
-                 sig, root, unode->pkt, NULL, ret_pk);
+              {
+                /* If this is a self-sig, ignore check_pk.  */
+                rc = check_signature_over_key_or_uid
+                  (ctrl,
+                   keyid_cmp (pk_keyid (pk), sig->keyid) == 0 ? pk : check_pk,
+                   sig, root, unode->pkt, NULL, ret_pk);
+              }
           }
        else
          {