* gpgsm.c: New command --keydb-clear-some-cert-flags.
[gnupg.git] / sm / certdump.c
index 5056939..21581dc 100644 (file)
@@ -1,5 +1,5 @@
 /* certdump.c - Dump a certificate for debugging
- *     Copyright (C) 2001 Free Software Foundation, Inc.
+ *     Copyright (C) 2001, 2004 Free Software Foundation, Inc.
  *
  * This file is part of GnuPG.
  *
 #include <unistd.h> 
 #include <time.h>
 #include <assert.h>
+#ifdef HAVE_LOCALE_H
+#include <locale.h>
+#endif
+#ifdef HAVE_LANGINFO_CODESET
+#include <langinfo.h>
+#endif
 
 #include "gpgsm.h"
 #include <gcrypt.h>
@@ -94,6 +100,41 @@ gpgsm_dump_serial (ksba_const_sexp_t p)
     }
 }
 
+
+char *
+gpgsm_format_serial (ksba_const_sexp_t p)
+{
+  unsigned long n;
+  char *endp;
+  char *buffer;
+  int i;
+
+  if (!p)
+    return NULL;
+
+  if (*p != '(')
+    BUG (); /* Not a valid S-expression. */
+
+  p++;
+  n = strtoul (p, &endp, 10);
+  p = endp;
+  if (*p!=':')
+    BUG (); /* Not a valid S-expression. */
+  p++;
+
+  buffer = xtrymalloc (n*2+1);
+  if (buffer)
+    {
+      for (i=0; n; n--, p++, i+=2)
+        sprintf (buffer+i, "%02X", *(unsigned char *)p);
+      buffer[i] = 0;
+    }
+  return buffer;
+}
+
+
+
+
 void
 gpgsm_print_time (FILE *fp, ksba_isotime_t t)
 {
@@ -143,6 +184,7 @@ gpgsm_dump_string (const char *string)
 }
 
 
+/* This simple dump function is mainly used for debugging purposes. */
 void 
 gpgsm_dump_cert (const char *text, ksba_cert_t cert)
 {
@@ -196,11 +238,31 @@ gpgsm_dump_cert (const char *text, ksba_cert_t cert)
 static const unsigned char *
 parse_dn_part (struct dn_array_s *array, const unsigned char *string)
 {
+  static struct {
+    const char *label;
+    const char *oid;
+  } label_map[] = {
+    /* Warning: When adding new labels, make sure that the buffer
+       below we be allocated large enough. */
+    {"EMail",        "1.2.840.113549.1.9.1" },
+    {"T",            "2.5.4.12" },
+    {"GN",           "2.5.4.42" },
+    {"SN",           "2.5.4.4" },
+    {"NameDistinguisher", "0.2.262.1.10.7.20"}, 
+    {"ADDR",         "2.5.4.16" },
+    {"BC",           "2.5.4.15" },
+    {"D",            "2.5.4.13" },
+    {"PostalCode",   "2.5.4.17" },
+    {"Pseudo",       "2.5.4.65" },
+    {"SerialNumber", "2.5.4.5" },
+    {NULL, NULL}
+  };
   const unsigned char *s, *s1;
   size_t n;
   unsigned char *p;
+  int i;
 
-  /* parse attributeType */
+  /* Parse attributeType */
   for (s = string+1; *s && *s != '='; s++)
     ;
   if (!*s)
@@ -208,17 +270,25 @@ parse_dn_part (struct dn_array_s *array, const unsigned char *string)
   n = s - string;
   if (!n)
     return NULL; /* empty key */
-  array->key = p = xtrymalloc (n+1);
+
+  /* We need to allocate a few bytes more due to the possible mapping
+     from the shorter OID to the longer label. */
+  array->key = p = xtrymalloc (n+10);
   if (!array->key)
     return NULL;
   memcpy (p, string, n); 
   p[n] = 0;
   trim_trailing_spaces (p);
-  if ( !strcmp (p, "1.2.840.113549.1.9.1") )
-    strcpy (p,     "EMail");
-  else if ( !strcmp (p, "0.2.262.1.10.7.20") )
-    strcpy (p,          "NameDistinguisher");
 
+  if (digitp (p))
+    {
+      for (i=0; label_map[i].label; i++ )
+        if ( !strcmp (p, label_map[i].oid) )
+          {
+            strcpy (p, label_map[i].label);
+            break;
+          }
+    }
   string = s + 1;
 
   if (*string == '#')
@@ -228,13 +298,18 @@ parse_dn_part (struct dn_array_s *array, const unsigned char *string)
         s++;
       n = s - string;
       if (!n || (n & 1))
-        return NULL; /* empty or odd number of digits */
+        return NULL; /* Empty or odd number of digits. */
       n /= 2;
       array->value = p = xtrymalloc (n+1);
       if (!p)
         return NULL;
-      for (s1=string; n; s1 += 2, n--)
-        *p++ = xtoi_2 (s1);
+      for (s1=string; n; s1 += 2, n--, p++)
+        {
+          *p = xtoi_2 (s1);
+          if (!*p)
+            *p = 0x01; /* Better print a wrong value than truncating
+                          the string. */
+        }
       *p = 0;
    }
   else
@@ -446,3 +521,176 @@ gpgsm_print_name (FILE *fp, const char *name)
 
 
 
+/* A cookie structure used for the memory stream. */
+struct format_name_cookie 
+{
+  char *buffer;         /* Malloced buffer with the data to deliver. */
+  size_t size;          /* Allocated size of this buffer. */
+  size_t len;           /* strlen (buffer). */
+  int error;            /* system error code if any. */
+};
+
+/* The writer function for the memory stream. */
+static int 
+format_name_writer (void *cookie, const char *buffer, size_t size)
+{
+  struct format_name_cookie *c = cookie;
+  char *p;
+
+  if (c->buffer)
+    p = xtryrealloc (c->buffer, c->size + size + 1);
+  else
+    p = xtrymalloc (size + 1);
+  if (!p)
+    {
+      c->error = errno;
+      xfree (c->buffer);
+      errno = c->error;
+      return -1;
+    }
+  c->buffer = p;
+  memcpy (p + c->len, buffer, size);
+  c->len += size;
+  p[c->len] = 0; /* Terminate string. */ 
+
+  return size;
+}
+
+/* Format NAME which is expected to be in rfc2253 format into a better
+   human readable format. Caller must free the returned string.  NULL
+   is returned in case of an error. */
+char *
+gpgsm_format_name (const char *name)
+{
+#if defined (HAVE_FOPENCOOKIE) || defined (HAVE_FUNOPEN)
+  FILE *fp;
+  struct format_name_cookie cookie;
+
+  memset (&cookie, 0, sizeof cookie);
+
+#ifdef HAVE_FOPENCOOKIE
+  {
+    cookie_io_functions_t io = { NULL };
+    io.write = format_name_writer;
+    
+    fp = fopencookie (&cookie, "w", io);
+  }
+#else /*!HAVE_FOPENCOOKIE*/
+  {
+    fp = funopen (&cookie, NULL, format_name_writer, NULL, NULL);
+  }
+#endif /*!HAVE_FOPENCOOKIE*/
+  if (!fp)
+    {
+      int save_errno = errno;
+      log_error ("error creating memory stream: %s\n", strerror (errno));
+      errno = save_errno;
+      return NULL;
+    }
+  gpgsm_print_name (fp, name);
+  fclose (fp);
+  if (cookie.error || !cookie.buffer)
+    {
+      xfree (cookie.buffer);
+      errno = cookie.error;
+      return NULL;
+    }
+  return cookie.buffer;
+#else /* No fun - use the name verbatim. */
+  return xtrystrdup (name);
+#endif /* No fun. */
+}
+
+
+/* Create a key description for the CERT, this may be passed to the
+   pinentry.  The caller must free the returned string. NULL may be
+   returned on error. */
+char *
+gpgsm_format_keydesc (ksba_cert_t cert)
+{
+  int rc;
+  char *name, *subject, *buffer, *p;
+  const char *s;
+  ksba_isotime_t t;
+  char created[20];
+  char *sn;
+  ksba_sexp_t sexp;
+  char *orig_codeset = NULL;
+
+  name = ksba_cert_get_subject (cert, 0);
+  subject = name? gpgsm_format_name (name) : NULL;
+  ksba_free (name); name = NULL;
+
+  sexp = ksba_cert_get_serial (cert);
+  sn = sexp? gpgsm_format_serial (sexp) : NULL;
+  ksba_free (sexp);
+
+  ksba_cert_get_validity (cert, 0, t);
+  if (t && *t)
+    sprintf (created, "%.4s-%.2s-%.2s", t, t+4, t+6);
+  else
+    *created = 0;
+
+
+#ifdef ENABLE_NLS
+  /* The Assuan agent protol requires us to transmit utf-8 strings */
+  orig_codeset = bind_textdomain_codeset (PACKAGE_GT, NULL);
+#ifdef HAVE_LANGINFO_CODESET
+  if (!orig_codeset)
+    orig_codeset = nl_langinfo (CODESET);
+#endif
+  if (orig_codeset)
+    { /* We only switch when we are able to restore the codeset later. */
+      orig_codeset = xstrdup (orig_codeset);
+      if (!bind_textdomain_codeset (PACKAGE_GT, "utf-8"))
+        orig_codeset = NULL; 
+    }
+#endif
+
+
+  rc = asprintf (&name,
+                 _("Please enter the passphrase to unlock the"
+                   " secret key for:\n"
+                   "\"%s\"\n"
+                   "S/N %s, ID %08lX, created %s" ),
+                 subject? subject:"?",
+                 sn? sn: "?",
+                 gpgsm_get_short_fingerprint (cert),
+                 created);
+
+#ifdef ENABLE_NLS
+  if (orig_codeset)
+    bind_textdomain_codeset (PACKAGE_GT, orig_codeset);
+#endif
+  xfree (orig_codeset);
+
+  if (rc < 0)
+    {
+      int save_errno = errno;
+      xfree (subject);
+      xfree (sn);
+      errno = save_errno;
+      return NULL;
+    }
+  
+  xfree (subject);
+  xfree (sn);
+
+  buffer = p = xtrymalloc (strlen (name) * 3 + 1);
+  for (s=name; *s; s++)
+    {
+      if (*s < ' ' || *s == '+')
+        {
+          sprintf (p, "%%%02X", *(unsigned char *)s);
+          p += 3;
+        }
+      else if (*s == ' ')
+        *p++ = '+';
+      else
+        *p++ = *s;
+    }
+  *p = 0;
+  free (name); 
+
+  return buffer;
+}