dirmngr: Better handle systems without IPv6 or IPv4.
[gnupg.git] / dirmngr / dirmngr_ldap.c
index 089a2e3..61a7e39 100644 (file)
@@ -1,21 +1,21 @@
 /* dirmngr-ldap.c  -  The LDAP helper for dirmngr.
- *     Copyright (C) 2004 g10 Code GmbH
+ * Copyright (C) 2004 g10 Code GmbH
+ * Copyright (C) 2010 Free Software Foundation, Inc.
  *
- * This file is part of DirMngr.
+ * This file is part of GnuPG.
  *
- * DirMngr is free software; you can redistribute it and/or modify
+ * 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.
  *
- * DirMngr is distributed in the hope that it will be useful,
+ * GnuPG is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * 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 <assert.h>
 #include <sys/time.h>
 #include <unistd.h>
+#ifndef USE_LDAPWRAPPER
+# include <npth.h>
+#endif
 
 #ifdef HAVE_W32_SYSTEM
-#include <winsock2.h>
-#include <winldap.h>
-#include <fcntl.h>
-#include "ldap-url.h"
+# include <winsock2.h>
+# include <winldap.h>
+# include <winber.h>
+# include <fcntl.h>
+# include "ldap-url.h"
 #else
-/* For OpenLDAP, to enable the API that we're using. */
-#define LDAP_DEPRECATED 1
-#include <ldap.h>
+  /* For OpenLDAP, to enable the API that we're using. */
+# define LDAP_DEPRECATED 1
+# include <ldap.h>
 #endif
 
 
-#define JNLIB_NEED_LOG_LOGV
+#include <gpg-error.h>
 #include "../common/logging.h"
 #include "../common/argparse.h"
 #include "../common/stringhelp.h"
 
 #include "i18n.h"
 #include "util.h"
+#include "../common/init.h"
 
-/* If we are not using the ldap wrapper process we need to include the
-   prototype for our module's main function.  */
-#ifndef USE_LDAPWRAPPER
-#include "./ldap-wrapper.h"
+/* With the ldap wrapper, there is no need for the npth_unprotect and leave
+   functions; thus we redefine them to nops.  If we are not using the
+   ldap wrapper process we need to include the prototype for our
+   module's main function.  */
+#ifdef USE_LDAPWRAPPER
+static void npth_unprotect (void) { }
+static void npth_protect (void) { }
+#else
+# include "./ldap-wrapper.h"
+#endif
+
+#ifdef HAVE_W32CE_SYSTEM
+# include "w32-ldap-help.h"
+# define my_ldap_init(a,b)                      \
+  _dirmngr_ldap_init ((a), (b))
+# define my_ldap_simple_bind_s(a,b,c)           \
+  _dirmngr_ldap_simple_bind_s ((a),(b),(c))
+# define my_ldap_search_st(a,b,c,d,e,f,g,h)     \
+  _dirmngr_ldap_search_st ((a), (b), (c), (d), (e), (f), (g), (h))
+# define my_ldap_first_attribute(a,b,c)         \
+  _dirmngr_ldap_first_attribute ((a),(b),(c))
+# define my_ldap_next_attribute(a,b,c)          \
+  _dirmngr_ldap_next_attribute ((a),(b),(c))
+# define my_ldap_get_values_len(a,b,c)          \
+  _dirmngr_ldap_get_values_len ((a),(b),(c))
+# define my_ldap_free_attr(a)                   \
+  xfree ((a))
+#else
+# define my_ldap_init(a,b)              ldap_init ((a), (b))
+# define my_ldap_simple_bind_s(a,b,c)   ldap_simple_bind_s ((a), (b), (c))
+# define my_ldap_search_st(a,b,c,d,e,f,g,h)     \
+  ldap_search_st ((a), (b), (c), (d), (e), (f), (g), (h))
+# define my_ldap_first_attribute(a,b,c) ldap_first_attribute ((a),(b),(c))
+# define my_ldap_next_attribute(a,b,c)  ldap_next_attribute ((a),(b),(c))
+# define my_ldap_get_values_len(a,b,c)  ldap_get_values_len ((a),(b),(c))
+# define my_ldap_free_attr(a)           ldap_memfree ((a))
+#endif
+
+#ifdef HAVE_W32_SYSTEM
+ typedef LDAP_TIMEVAL  my_ldap_timeval_t;
+#else
+ typedef struct timeval my_ldap_timeval_t;
 #endif
 
 #define DEFAULT_LDAP_TIMEOUT 100 /* Arbitrary long timeout. */
 
 
 /* Constants for the options.  */
-enum 
+enum
   {
     oQuiet       = 'q',
     oVerbose     = 'v',
@@ -118,7 +161,7 @@ struct my_opt_s
 {
   int quiet;
   int verbose;
-  struct timeval timeout; /* Timeout for the LDAP search functions.  */
+  my_ldap_timeval_t timeout;/* Timeout for the LDAP search functions.  */
   unsigned int alarm_timeout; /* And for the alarm based timeout.  */
   int multi;
 
@@ -135,24 +178,27 @@ struct my_opt_s
   char *filter;/* Override filter.  */
   char *attr;  /* Override attribute.  */
 };
-typedef struct my_opt_s my_opt_t;
+typedef struct my_opt_s *my_opt_t;
 
 
 /* Prototypes.  */
+#ifndef HAVE_W32_SYSTEM
 static void catch_alarm (int dummy);
+#endif
 static int process_url (my_opt_t myopt, const char *url);
 
 
 
 /* Function called by argparse.c to display information.  */
+#ifdef USE_LDAPWRAPPER
 static const char *
 my_strusage (int level)
 {
   const char *p;
-    
+
   switch(level)
     {
-    case 11: p = "dirmngr_ldap (GnuPG)";
+    case 11: p = "dirmngr_ldap (@GNUPG@)";
       break;
     case 13: p = VERSION; break;
     case 17: p = PRINTABLE_OS_NAME; break;
@@ -164,14 +210,15 @@ my_strusage (int level)
       break;
     case 41: p =
           _("Syntax: dirmngr_ldap [options] [URL]\n"
-            "Internal LDAP helper for Dirmngr.\n"
-            "Interface and options may change without notice.\n");
+            "Internal LDAP helper for Dirmngr\n"
+            "Interface and options may change without notice\n");
       break;
 
     default: p = NULL;
     }
   return p;
 }
+#endif /*!USE_LDAPWRAPPER*/
 
 
 int
@@ -190,13 +237,16 @@ ldap_wrapper_main (char **argv, estream_t outstream)
   int only_search_timeout = 0;
   struct my_opt_s my_opt_buffer;
   my_opt_t myopt = &my_opt_buffer;
-  
+  char *malloced_buffer1 = NULL;
+
   memset (&my_opt_buffer, 0, sizeof my_opt_buffer);
 
+  early_system_init ();
+
 #ifdef USE_LDAPWRAPPER
   set_strusage (my_strusage);
-  log_set_prefix ("dirmngr_ldap", JNLIB_LOG_WITH_PREFIX); 
-  
+  log_set_prefix ("dirmngr_ldap", GPGRT_LOG_WITH_PREFIX);
+
   /* Setup I18N and common subsystems. */
   i18n_init();
 
@@ -225,8 +275,8 @@ ldap_wrapper_main (char **argv, estream_t outstream)
         {
         case oVerbose: myopt->verbose++; break;
         case oQuiet: myopt->quiet++; break;
-       case oTimeout: 
-         myopt->timeout.tv_sec = pargs.r.ret_int; 
+       case oTimeout:
+         myopt->timeout.tv_sec = pargs.r.ret_int;
          myopt->timeout.tv_usec = 0;
           myopt->alarm_timeout = pargs.r.ret_int;
          break;
@@ -247,7 +297,7 @@ ldap_wrapper_main (char **argv, estream_t outstream)
           {
             unsigned int oldflags;
             log_get_prefix (&oldflags);
-            log_set_prefix (NULL, oldflags | JNLIB_LOG_WITH_PID);
+            log_set_prefix (NULL, oldflags | GPGRT_LOG_WITH_PID);
           }
           break;
 
@@ -266,7 +316,13 @@ ldap_wrapper_main (char **argv, estream_t outstream)
 
   if (myopt->proxy)
     {
-      myopt->host = xstrdup (myopt->proxy);
+      malloced_buffer1 = xtrystrdup (myopt->proxy);
+      if (!malloced_buffer1)
+        {
+          log_error ("error copying string: %s\n", strerror (errno));
+          return 1;
+        }
+      myopt->host = malloced_buffer1;
       p = strchr (myopt->host, ':');
       if (p)
         {
@@ -276,7 +332,7 @@ ldap_wrapper_main (char **argv, estream_t outstream)
       if (!myopt->port)
         myopt->port = 389;  /* make sure ports gets overridden.  */
     }
-        
+
   if (myopt->port < 0 || myopt->port > 65535)
     log_error (_("invalid port number %d\n"), myopt->port);
 
@@ -296,12 +352,12 @@ ldap_wrapper_main (char **argv, estream_t outstream)
 #ifndef HAVE_W32_SYSTEM
 # if defined(HAVE_SIGACTION) && defined(HAVE_STRUCT_SIGACTION)
       struct sigaction act;
-      
+
       act.sa_handler = catch_alarm;
       sigemptyset (&act.sa_mask);
       act.sa_flags = 0;
       if (sigaction (SIGALRM,&act,NULL))
-# else 
+# else
       if (signal (SIGALRM, catch_alarm) == SIG_ERR)
 # endif
           log_fatal ("unable to register timeout handler\n");
@@ -313,25 +369,26 @@ ldap_wrapper_main (char **argv, estream_t outstream)
     if (process_url (myopt, *argv))
       any_err = 1;
 
-
-  /* FIXME: Do we need to release stuff?  */
+  xfree (malloced_buffer1);
   return any_err;
 }
 
-
+#ifndef HAVE_W32_SYSTEM
 static void
 catch_alarm (int dummy)
 {
   (void)dummy;
   _exit (10);
 }
-
+#endif
 
 static void
 set_timeout (my_opt_t myopt)
 {
-#ifndef HAVE_W32_SYSTEM
+#ifdef HAVE_W32_SYSTEM
   /* FIXME for W32.  */
+  (void)myopt;
+#else
   if (myopt->alarm_timeout)
     alarm (myopt->alarm_timeout);
 #endif
@@ -345,19 +402,20 @@ print_ldap_entries (my_opt_t myopt, LDAP *ld, LDAPMessage *msg, char *want_attr)
   LDAPMessage *item;
   int any = 0;
 
-  for (item = ldap_first_entry (ld, msg); item;
-       item = ldap_next_entry (ld, item))
+  for (npth_unprotect (), item = ldap_first_entry (ld, msg), npth_protect ();
+       item;
+       npth_unprotect (), item = ldap_next_entry (ld, item), npth_protect ())
     {
       BerElement *berctx;
       char *attr;
 
       if (myopt->verbose > 1)
-        log_info (_("scanning result for attribute `%s'\n"),
+        log_info (_("scanning result for attribute '%s'\n"),
                   want_attr? want_attr : "[all]");
 
       if (myopt->multi)
         { /*  Write item marker. */
-          if (es_fwrite ("I\0\0\0\0", 5, 1, myopt->oustream) != 1)
+          if (es_fwrite ("I\0\0\0\0", 5, 1, myopt->outstream) != 1)
             {
               log_error (_("error writing to stdout: %s\n"),
                          strerror (errno));
@@ -365,16 +423,19 @@ print_ldap_entries (my_opt_t myopt, LDAP *ld, LDAPMessage *msg, char *want_attr)
             }
         }
 
-          
-      for (attr = ldap_first_attribute (ld, item, &berctx); attr;
-           attr = ldap_next_attribute (ld, item, berctx))
+
+      for (npth_unprotect (), attr = my_ldap_first_attribute (ld, item, &berctx),
+             npth_protect ();
+           attr;
+           npth_unprotect (), attr = my_ldap_next_attribute (ld, item, berctx),
+             npth_protect ())
         {
           struct berval **values;
           int idx;
 
           if (myopt->verbose > 1)
-            log_info (_("          available attribute `%s'\n"), attr);
-          
+            log_info (_("          available attribute '%s'\n"), attr);
+
           set_timeout (myopt);
 
           /* I case we want only one attribute we do a case
@@ -399,29 +460,31 @@ print_ldap_entries (my_opt_t myopt, LDAP *ld, LDAPMessage *msg, char *want_attr)
                 *cp2 = ';';
               if (cmpres)
                 {
-                  ldap_memfree (attr);
+                  my_ldap_free_attr (attr);
                   continue; /* Not found:  Try next attribute.  */
                 }
             }
 
-          values = ldap_get_values_len (ld, item, attr);
-  
+          npth_unprotect ();
+          values = my_ldap_get_values_len (ld, item, attr);
+          npth_protect ();
+
           if (!values)
             {
               if (myopt->verbose)
-                log_info (_("attribute `%s' not found\n"), attr);
-              ldap_memfree (attr);
+                log_info (_("attribute '%s' not found\n"), attr);
+              my_ldap_free_attr (attr);
               continue;
             }
 
           if (myopt->verbose)
             {
-              log_info (_("found attribute `%s'\n"), attr);
+              log_info (_("found attribute '%s'\n"), attr);
               if (myopt->verbose > 1)
                 for (idx=0; values[idx]; idx++)
                   log_info ("         length[%d]=%d\n",
                             idx, (int)values[0]->bv_len);
-              
+
             }
 
           if (myopt->multi)
@@ -434,13 +497,13 @@ print_ldap_entries (my_opt_t myopt, LDAP *ld, LDAPMessage *msg, char *want_attr)
               tmp[2] = (n >> 16);
               tmp[3] = (n >> 8);
               tmp[4] = (n);
-              if (es_fwrite (tmp, 5, 1, myopt->oustream) != 1 
-                  || es_fwrite (attr, n, 1, myopt->oustream) != 1)
+              if (es_fwrite (tmp, 5, 1, myopt->outstream) != 1
+                  || es_fwrite (attr, n, 1, myopt->outstream) != 1)
                 {
                   log_error (_("error writing to stdout: %s\n"),
                              strerror (errno));
                   ldap_value_free_len (values);
-                  ldap_memfree (attr);
+                  my_ldap_free_attr (attr);
                   ber_free (berctx, 0);
                   return -1;
                 }
@@ -459,69 +522,39 @@ print_ldap_entries (my_opt_t myopt, LDAP *ld, LDAPMessage *msg, char *want_attr)
                   tmp[3] = (n >> 8);
                   tmp[4] = (n);
 
-                  if (es_fwrite (tmp, 5, 1, myopt->oustream) != 1)
+                  if (es_fwrite (tmp, 5, 1, myopt->outstream) != 1)
                     {
                       log_error (_("error writing to stdout: %s\n"),
                                  strerror (errno));
                       ldap_value_free_len (values);
-                      ldap_memfree (attr);
+                      my_ldap_free_attr (attr);
                       ber_free (berctx, 0);
                       return -1;
                     }
                 }
-#if 1
-             /* Note: this does not work for STDOUT on a Windows
-                console, where it fails with "Not enough space" for
-                CRLs which are 52 KB or larger.  */
-#warning still true - implement in estream
+
              if (es_fwrite (values[0]->bv_val, values[0]->bv_len,
-                             1, myopt->oustream) != 1)
+                             1, myopt->outstream) != 1)
                 {
                   log_error (_("error writing to stdout: %s\n"),
                              strerror (errno));
                   ldap_value_free_len (values);
-                  ldap_memfree (attr);
+                  my_ldap_free_attr (attr);
                   ber_free (berctx, 0);
                   return -1;
                 }
-#else
-             /* On Windows console STDOUT, we have to break up the
-                writes into small parts.  */
-             {
-               int n = 0;
-               while (n < values[0]->bv_len)
-                 {
-                   int cnt = values[0]->bv_len - n;
-                   /* The actual limit is (52 * 1024 - 1) on Windows XP SP2.  */
-#define MAX_CNT (32*1024)
-                   if (cnt > MAX_CNT)
-                     cnt = MAX_CNT;
-                   
-                   if (es_fwrite (((char *) values[0]->bv_val) + n, cnt, 1,
-                                   myopt->oustream) != 1)
-                     {
-                       log_error (_("error writing to stdout: %s\n"),
-                                  strerror (errno));
-                       ldap_value_free_len (values);
-                       ldap_memfree (attr);
-                       ber_free (berctx, 0);
-                       return -1;
-                     }
-                   n += cnt;
-                 }
-             }
-#endif
+
               any = 1;
               if (!myopt->multi)
                 break; /* Print only the first value.  */
             }
           ldap_value_free_len (values);
-          ldap_memfree (attr);
+          my_ldap_free_attr (attr);
           if (want_attr || !myopt->multi)
             break; /* We only want to return the first attribute.  */
         }
       ber_free (berctx, 0);
-    } 
+    }
 
   if (myopt->verbose > 1 && any)
     log_info ("result has been printed\n");
@@ -540,6 +573,7 @@ fetch_ldap (my_opt_t myopt, const char *url, const LDAPURLDesc *ludp)
   int rc = 0;
   char *host, *dn, *filter, *attrs[2], *attr;
   int port;
+  int ret;
 
   host     = myopt->host?   myopt->host   : ludp->lud_host;
   port     = myopt->port?   myopt->port   : ludp->lud_port;
@@ -554,37 +588,37 @@ fetch_ldap (my_opt_t myopt, const char *url, const LDAPURLDesc *ludp)
 
   if (myopt->verbose)
     {
-      log_info (_("processing url `%s'\n"), url);
+      log_info (_("processing url '%s'\n"), url);
       if (myopt->user)
-        log_info (_("          user `%s'\n"), myopt->user);
+        log_info (_("          user '%s'\n"), myopt->user);
       if (myopt->pass)
-        log_info (_("          pass `%s'\n"), *myopt->pass?"*****":"");
+        log_info (_("          pass '%s'\n"), *myopt->pass?"*****":"");
       if (host)
-        log_info (_("          host `%s'\n"), host);
+        log_info (_("          host '%s'\n"), host);
       log_info (_("          port %d\n"), port);
       if (dn)
-        log_info (_("            DN `%s'\n"), dn);
+        log_info (_("            DN '%s'\n"), dn);
       if (filter)
-        log_info (_("        filter `%s'\n"), filter);
+        log_info (_("        filter '%s'\n"), filter);
       if (myopt->multi && !myopt->attr && ludp->lud_attrs)
         {
           int i;
           for (i=0; ludp->lud_attrs[i]; i++)
-            log_info (_("          attr `%s'\n"), ludp->lud_attrs[i]);
+            log_info (_("          attr '%s'\n"), ludp->lud_attrs[i]);
         }
       else if (attr)
-        log_info (_("          attr `%s'\n"), attr);
+        log_info (_("          attr '%s'\n"), attr);
     }
 
 
   if (!host || !*host)
     {
-      log_error (_("no host name in `%s'\n"), url);
+      log_error (_("no host name in '%s'\n"), url);
       return -1;
     }
   if (!myopt->multi && !attr)
     {
-      log_error (_("no attribute given for query `%s'\n"), url);
+      log_error (_("no attribute given for query '%s'\n"), url);
       return -1;
     }
 
@@ -594,30 +628,38 @@ fetch_ldap (my_opt_t myopt, const char *url, const LDAPURLDesc *ludp)
 
 
   set_timeout (myopt);
-  ld = ldap_init (host, port);
+  npth_unprotect ();
+  ld = my_ldap_init (host, port);
+  npth_protect ();
   if (!ld)
     {
-      log_error (_("LDAP init to `%s:%d' failed: %s\n"), 
+      log_error (_("LDAP init to '%s:%d' failed: %s\n"),
                  host, port, strerror (errno));
       return -1;
     }
-  if (ldap_simple_bind_s (ld, myopt->user, myopt->pass))
+  npth_unprotect ();
+  /* Fixme:  Can we use MYOPT->user or is it shared with other theeads?.  */
+  ret = my_ldap_simple_bind_s (ld, myopt->user, myopt->pass);
+  npth_protect ();
+  if (ret)
     {
-      log_error (_("binding to `%s:%d' failed: %s\n"), 
+      log_error (_("binding to '%s:%d' failed: %s\n"),
                  host, port, strerror (errno));
-      /* FIXME: Need deinit (ld)?  */
+      ldap_unbind (ld);
       return -1;
     }
 
   set_timeout (myopt);
-  rc = ldap_search_st (ld, dn, ludp->lud_scope, filter,
-                       myopt->multi && !myopt->attr && ludp->lud_attrs?
-                       ludp->lud_attrs:attrs,
-                       0,
-                       &myopt->timeout, &msg);
+  npth_unprotect ();
+  rc = my_ldap_search_st (ld, dn, ludp->lud_scope, filter,
+                          myopt->multi && !myopt->attr && ludp->lud_attrs?
+                          ludp->lud_attrs:attrs,
+                          0,
+                          &myopt->timeout, &msg);
+  npth_protect ();
   if (rc == LDAP_SIZELIMIT_EXCEEDED && myopt->multi)
     {
-      if (es_fwrite ("E\0\0\0\x09truncated", 14, 1, myopt->oustream) != 1)
+      if (es_fwrite ("E\0\0\0\x09truncated", 14, 1, myopt->outstream) != 1)
         {
           log_error (_("error writing to stdout: %s\n"), strerror (errno));
           return -1;
@@ -625,8 +667,12 @@ fetch_ldap (my_opt_t myopt, const char *url, const LDAPURLDesc *ludp)
     }
   else if (rc)
     {
-      log_error (_("searching `%s' failed: %s\n"), 
+#ifdef HAVE_W32CE_SYSTEM
+      log_error ("searching '%s' failed: %d\n", url, rc);
+#else
+      log_error (_("searching '%s' failed: %s\n"),
                  url, ldap_err2string (rc));
+#endif
       if (rc != LDAP_NO_SUCH_OBJECT)
         {
           /* FIXME: Need deinit (ld)?  */
@@ -638,7 +684,7 @@ fetch_ldap (my_opt_t myopt, const char *url, const LDAPURLDesc *ludp)
   rc = print_ldap_entries (myopt, ld, msg, myopt->multi? NULL:attr);
 
   ldap_msgfree (msg);
-  /* FIXME: Need deinit (ld)?  */
+  ldap_unbind (ld);
   return rc;
 }
 
@@ -656,13 +702,13 @@ process_url (my_opt_t myopt, const char *url)
 
   if (!ldap_is_ldap_url (url))
     {
-      log_error (_("`%s' is not an LDAP URL\n"), url);
+      log_error (_("'%s' is not an LDAP URL\n"), url);
       return -1;
     }
 
   if (ldap_url_parse (url, &ludp))
     {
-      log_error (_("`%s' is an invalid LDAP URL\n"), url);
+      log_error (_("'%s' is an invalid LDAP URL\n"), url);
       return -1;
     }
 
@@ -671,4 +717,3 @@ process_url (my_opt_t myopt, const char *url)
   ldap_free_urldesc (ludp);
   return rc;
 }
-