Make most of the selftests work.
[gnupg.git] / agent / learncard.c
index 93229f4..77f2bb0 100644 (file)
@@ -1,11 +1,11 @@
 /* learncard.c - Handle the LEARN command
- *     Copyright (C) 2002 Free Software Foundation, Inc.
+ * Copyright (C) 2002, 2003, 2004, 2009 Free Software Foundation, Inc.
  *
  * This file is part of GnuPG.
  *
  * GnuPG is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * GnuPG is distributed in the hope that it will be useful,
@@ -14,8 +14,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, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #include <config.h>
 #include <sys/stat.h>
 
 #include "agent.h"
-#include "../assuan/assuan.h"
+#include <assuan.h>
 
-struct keypair_info_s {
+/* Structures used by the callback mechanism to convey information
+   pertaining to key pairs.  */
+struct keypair_info_s 
+{
   struct keypair_info_s *next;
   int no_cert;
-  char *id;  /* points into grip */
-  char hexgrip[1];
+  char *id;          /* points into grip */
+  char hexgrip[1];   /* The keygrip (i.e. a hash over the public key
+                        parameters) formatted as a hex string.
+                        Allocated somewhat large to also act as
+                        memeory for the above ID field. */
 };
 typedef struct keypair_info_s *KEYPAIR_INFO;
 
-struct kpinfo_cb_parm_s {
+struct kpinfo_cb_parm_s 
+{
+  ctrl_t ctrl;
   int error;
   KEYPAIR_INFO info;
 };
 
 
+/* Structures used by the callback mechanism to convey information
+   pertaining to certificates.  */
 struct certinfo_s {
   struct certinfo_s *next;
   int type;  
@@ -53,12 +62,30 @@ struct certinfo_s {
 };
 typedef struct certinfo_s *CERTINFO;
 
-struct certinfo_cb_parm_s {
+struct certinfo_cb_parm_s 
+{
+  ctrl_t ctrl;
   int error;
   CERTINFO info;
 };
 
 
+/* Structures used by the callback mechanism to convey assuan status
+   lines.  */
+struct sinfo_s {
+  struct sinfo_s *next;
+  char *data;       /* Points into keyword. */
+  char keyword[1];  
+};
+typedef struct sinfo_s *SINFO;  
+
+struct sinfo_cb_parm_s {
+  int error;
+  SINFO info;
+};
+
+
+/* Destructor for key information objects. */
 static void
 release_keypair_info (KEYPAIR_INFO info)
 {
@@ -70,6 +97,7 @@ release_keypair_info (KEYPAIR_INFO info)
     }
 }
 
+/* Destructor for certificate information objects. */
 static void
 release_certinfo (CERTINFO info)
 {
@@ -81,9 +109,21 @@ release_certinfo (CERTINFO info)
     }
 }
 
+/* Destructor for status information objects. */
+static void
+release_sinfo (SINFO info)
+{
+  while (info)
+    {
+      SINFO tmp = info->next;
+      xfree (info);
+      info = tmp;
+    }
+}
+
 
 
-/* This callback is used by agent_card_leanr and passed the content of
+/* This callback is used by agent_card_learn and passed the content of
    all KEYPAIRINFO lines.  It merely stores this data away */
 static void
 kpinfo_cb (void *opaque, const char *line)
@@ -94,10 +134,15 @@ kpinfo_cb (void *opaque, const char *line)
 
   if (parm->error)
     return; /* no need to gather data after an error coccured */
+
+  if ((parm->error = agent_write_status (parm->ctrl, "PROGRESS",
+                                         "learncard", "k", "0", "0", NULL)))
+    return;
+
   item = xtrycalloc (1, sizeof *item + strlen (line));
   if (!item)
     {
-      parm->error = GNUPG_Out_Of_Core;
+      parm->error = out_of_core ();
       return;
     }
   strcpy (item->hexgrip, line);
@@ -110,7 +155,7 @@ kpinfo_cb (void *opaque, const char *line)
     }
   else if ((p - item->hexgrip) != 40 || !spacep (p))
     { /* not a 20 byte hex keygrip or not followed by a space */
-      parm->error = GNUPG_Invalid_Response;
+      parm->error = gpg_error (GPG_ERR_INV_RESPONSE);
       xfree (item);
       return;
     }
@@ -122,7 +167,7 @@ kpinfo_cb (void *opaque, const char *line)
     p++;
   if (p == item->id)
     { /* invalid ID string */
-      parm->error = GNUPG_Invalid_Response;
+      parm->error = gpg_error (GPG_ERR_INV_RESPONSE);
       xfree (item);
       return;
     }
@@ -134,7 +179,7 @@ kpinfo_cb (void *opaque, const char *line)
 }
 
 
-/* This callback is used by agent_card_leanr and passed the content of
+/* This callback is used by agent_card_learn and passed the content of
    all CERTINFO lines.  It merely stores this data away */
 static void
 certinfo_cb (void *opaque, const char *line)
@@ -147,6 +192,10 @@ certinfo_cb (void *opaque, const char *line)
   if (parm->error)
     return; /* no need to gather data after an error coccured */
 
+  if ((parm->error = agent_write_status (parm->ctrl, "PROGRESS",
+                                         "learncard", "c", "0", "0", NULL)))
+    return;
+
   type = strtol (line, &p, 10);
   while (spacep (p))
     p++;
@@ -154,7 +203,7 @@ certinfo_cb (void *opaque, const char *line)
     ;
   if (p == pend || !*p)
     { 
-      parm->error = GNUPG_Invalid_Response;
+      parm->error = gpg_error (GPG_ERR_INV_RESPONSE);
       return;
     }
   *pend = 0; /* ignore trailing stuff */
@@ -162,7 +211,7 @@ certinfo_cb (void *opaque, const char *line)
   item = xtrycalloc (1, sizeof *item + strlen (p));
   if (!item)
     {
-      parm->error = GNUPG_Out_Of_Core;
+      parm->error = out_of_core ();
       return;
     }
   item->type = type;
@@ -173,46 +222,63 @@ certinfo_cb (void *opaque, const char *line)
 }
 
 
-/* Create an S-expression with the shadow info.  */
-static unsigned char *
-make_shadow_info (const char *serialno, const char *idstring)
+/* This callback is used by agent_card_learn and passed the content of
+   all SINFO lines.  It merely stores this data away */
+static void
+sinfo_cb (void *opaque, const char *keyword, size_t keywordlen,
+          const char *data)
 {
-  const char *s;
-  unsigned char *info, *p;
-  char numbuf[21];
-  int n;
-
-  for (s=serialno, n=0; *s && s[1]; s += 2)
-    n++;
-
-  info = p = xtrymalloc (1 + 21 + n
-                           + 21 + strlen (idstring) + 1 + 1);
-  *p++ = '(';
-  sprintf (numbuf, "%d:", n);
-  p = stpcpy (p, numbuf);
-  for (s=serialno; *s && s[1]; s += 2)
-    *p++ = xtoi_2 (s);
-  sprintf (numbuf, "%d:", strlen (idstring));
-  p = stpcpy (p, numbuf);
-  p = stpcpy (p, idstring);
-  *p++ = ')';
-  *p = 0;
-  return info;
+  struct sinfo_cb_parm_s *sparm = opaque;
+  SINFO item;
+
+  if (sparm->error)
+    return; /* no need to gather data after an error coccured */
+
+  item = xtrycalloc (1, sizeof *item + keywordlen + 1 + strlen (data));
+  if (!item)
+    {
+      sparm->error = out_of_core ();
+      return;
+    }
+  memcpy (item->keyword, keyword, keywordlen);
+  item->data = item->keyword + keywordlen;
+  *item->data = 0;
+  item->data++;
+  strcpy (item->data, data);
+  /* store it */
+  item->next = sparm->info;
+  sparm->info = item;
 }
 
+
+
 static int
-send_cert_back (const char *id, void *assuan_context)
+send_cert_back (ctrl_t ctrl, const char *id, void *assuan_context)
 {
   int rc;
   char *derbuf;
   size_t derbuflen;
   
-  rc = agent_card_readcert (id, &derbuf, &derbuflen);
+  rc = agent_card_readcert (ctrl, id, &derbuf, &derbuflen);
   if (rc)
     {
-      log_error ("error reading certificate: %s\n",
-                 gnupg_strerror (rc));
-      return rc;
+      const char *action;
+
+      switch (gpg_err_code (rc))
+        {
+        case GPG_ERR_INV_ID:
+        case GPG_ERR_NOT_FOUND:
+          action = " - ignored";
+          break;
+        default:
+          action = "";
+          break;
+        }
+      if (opt.verbose || !*action)
+        log_info ("error reading certificate `%s': %s%s\n",
+                  id? id:"?", gpg_strerror (rc), action);
+
+      return *action? 0 : rc;
     }
 
   rc = assuan_send_data (assuan_context, derbuf, derbuflen);
@@ -224,53 +290,72 @@ send_cert_back (const char *id, void *assuan_context)
   if (rc)
     {
       log_error ("sending certificate failed: %s\n",
-                 assuan_strerror (rc));
-      return map_assuan_err (rc);
+                 gpg_strerror (rc));
+      return rc;
     }
   return 0;
 }
 
 /* Perform the learn operation.  If ASSUAN_CONTEXT is not NULL all new
-   certificates are send via Assuan */
+   certificates are send back via Assuan.  */
 int
-agent_handle_learn (void *assuan_context)
+agent_handle_learn (ctrl_t ctrl, void *assuan_context)
 {
   int rc;
+
   struct kpinfo_cb_parm_s parm;
   struct certinfo_cb_parm_s cparm;
+  struct sinfo_cb_parm_s sparm;
   char *serialno = NULL;
   KEYPAIR_INFO item;
+  SINFO sitem;
   unsigned char grip[20];
   char *p;
   int i;
   static int certtype_list[] = { 
+    111, /* Root CA */
     101, /* trusted */
     102, /* useful */
     100, /* regular */
+    /* We don't include 110 here because gpgsm can't handle that
+       special root CA format. */
     -1 /* end of list */
   };
 
 
   memset (&parm, 0, sizeof parm);
   memset (&cparm, 0, sizeof cparm);
+  memset (&sparm, 0, sizeof sparm);
+  parm.ctrl = ctrl;
+  cparm.ctrl = ctrl;
 
   /* Check whether a card is present and get the serial number */
-  rc = agent_card_serialno (&serialno);
+  rc = agent_card_serialno (ctrl, &serialno);
   if (rc)
     goto leave;
 
-  /* now gather all the availabe info */
-  rc = agent_card_learn (kpinfo_cb, &parm, certinfo_cb, &cparm);
-  if (!rc && (parm.error || cparm.error))
-    rc = parm.error? parm.error : cparm.error;
+  /* Now gather all the available info. */
+  rc = agent_card_learn (ctrl, kpinfo_cb, &parm, certinfo_cb, &cparm,
+                         sinfo_cb, &sparm);
+  if (!rc && (parm.error || cparm.error || sparm.error))
+    rc = parm.error? parm.error : cparm.error? cparm.error : sparm.error;
   if (rc)
     {
-      log_debug ("agent_card_learn failed: %s\n", gnupg_strerror (rc));
+      log_debug ("agent_card_learn failed: %s\n", gpg_strerror (rc));
       goto leave;
     }
   
   log_info ("card has S/N: %s\n", serialno);
 
+  /* Pass on all the collected status information. */
+  if (assuan_context)
+    {
+      for (sitem = sparm.info; sitem; sitem = sitem->next)
+        {
+          assuan_write_status (assuan_context, sitem->keyword, sitem->data);
+        }
+    }
+
   /* Write out the certificates in a standard order. */
   for (i=0; certtype_list[i] != -1; i++)
     {
@@ -286,7 +371,7 @@ agent_handle_learn (void *assuan_context)
           
           if (assuan_context)
             {
-              rc = send_cert_back (citem->id, assuan_context);
+              rc = send_cert_back (ctrl, citem->id, assuan_context);
               if (rc)
                 goto leave;
               citem->done = 1;
@@ -303,19 +388,25 @@ agent_handle_learn (void *assuan_context)
         log_info ("          id: %s    (grip=%s)\n", item->id, item->hexgrip);
 
       if (item->no_cert)
-        continue; /* no public key yet available */
+        continue; /* No public key yet available. */
+
+      if (assuan_context)
+        {
+          agent_write_status (ctrl, "KEYPAIRINFO",
+                              item->hexgrip, item->id, NULL);
+        }
 
       for (p=item->hexgrip, i=0; i < 20; p += 2, i++)
         grip[i] = xtoi_2 (p);
       
       if (!agent_key_available (grip))
-        continue;
+        continue; /* The key is already available. */
       
-      /* unknown - store it */
-      rc = agent_card_readkey (item->id, &pubkey);
+      /* Unknown key - store it. */
+      rc = agent_card_readkey (ctrl, item->id, &pubkey);
       if (rc)
         {
-          log_debug ("agent_card_readkey failed: %s\n", gnupg_strerror (rc));
+          log_debug ("agent_card_readkey failed: %s\n", gpg_strerror (rc));
           goto leave;
         }
 
@@ -323,7 +414,7 @@ agent_handle_learn (void *assuan_context)
         unsigned char *shadow_info = make_shadow_info (serialno, item->id);
         if (!shadow_info)
           {
-            rc = GNUPG_Out_Of_Core;
+            rc = gpg_error (GPG_ERR_ENOMEM);
             xfree (pubkey);
             goto leave;
           }
@@ -333,7 +424,7 @@ agent_handle_learn (void *assuan_context)
       xfree (pubkey);
       if (rc)
         {
-          log_error ("shadowing the key failed: %s\n", gnupg_strerror (rc));
+          log_error ("shadowing the key failed: %s\n", gpg_strerror (rc));
           goto leave;
         }
       n = gcry_sexp_canon_len (shdkey, 0, NULL, NULL);
@@ -343,7 +434,7 @@ agent_handle_learn (void *assuan_context)
       xfree (shdkey);
       if (rc)
         {
-          log_error ("error writing key: %s\n", gnupg_strerror (rc));
+          log_error ("error writing key: %s\n", gpg_strerror (rc));
           goto leave;
         }
 
@@ -362,7 +453,7 @@ agent_handle_learn (void *assuan_context)
             }
           if (!citem)
             {
-              rc = send_cert_back (item->id, assuan_context);
+              rc = send_cert_back (ctrl, item->id, assuan_context);
               if (rc)
                 goto leave;
             }
@@ -374,6 +465,7 @@ agent_handle_learn (void *assuan_context)
   xfree (serialno);
   release_keypair_info (parm.info);
   release_certinfo (cparm.info);
+  release_sinfo (sparm.info);
   return rc;
 }