Make gpgconf aware of --p12-charset.
[gnupg.git] / agent / learncard.c
index 28a74f9..fac12be 100644 (file)
@@ -1,5 +1,5 @@
 /* learncard.c - Handle the LEARN command
- *     Copyright (C) 2002, 2003 Free Software Foundation, Inc.
+ *     Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
  *
  * This file is part of GnuPG.
  *
@@ -15,7 +15,8 @@
  *
  * 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
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ * USA.
  */
 
 #include <config.h>
 #include "agent.h"
 #include <assuan.h>
 
+/* 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;
 
@@ -45,6 +51,9 @@ struct kpinfo_cb_parm_s {
 };
 
 
+
+/* Structures used by the callback mechanism to convey information
+   pertaining to certificates.  */
 struct certinfo_s {
   struct certinfo_s *next;
   int type;  
@@ -59,6 +68,8 @@ struct certinfo_cb_parm_s {
 };
 
 
+/* Structures used by the callback mechanism to convey assuan status
+   lines.  */
 struct sinfo_s {
   struct sinfo_s *next;
   char *data;       /* Points into keyword. */
@@ -72,7 +83,7 @@ struct sinfo_cb_parm_s {
 };
 
 
-
+/* Destructor for key information objects. */
 static void
 release_keypair_info (KEYPAIR_INFO info)
 {
@@ -84,6 +95,7 @@ release_keypair_info (KEYPAIR_INFO info)
     }
 }
 
+/* Destructor for certificate information objects. */
 static void
 release_certinfo (CERTINFO info)
 {
@@ -95,6 +107,7 @@ release_certinfo (CERTINFO info)
     }
 }
 
+/* Destructor for status information objects. */
 static void
 release_sinfo (SINFO info)
 {
@@ -227,41 +240,15 @@ sinfo_cb (void *opaque, const char *keyword, size_t keywordlen,
 }
 
 
-/* Create an S-expression with the shadow info.  */
-static unsigned char *
-make_shadow_info (const char *serialno, const char *idstring)
-{
-  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;
-}
 
 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",
@@ -278,16 +265,16 @@ 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;
@@ -303,6 +290,7 @@ agent_handle_learn (void *assuan_context)
     101, /* trusted */
     102, /* useful */
     100, /* regular */
+    /* We don't include 110 here because gpgsm can't handle it. */
     -1 /* end of list */
   };
 
@@ -312,12 +300,12 @@ agent_handle_learn (void *assuan_context)
   memset (&sparm, 0, sizeof sparm);
 
   /* 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 available info */
-  rc = agent_card_learn (kpinfo_cb, &parm, certinfo_cb, &cparm,
+  /* 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;
@@ -353,7 +341,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;
@@ -370,16 +358,22 @@ 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", gpg_strerror (rc));
@@ -429,7 +423,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;
             }