Add new set_binary feature to estream
[gnupg.git] / dirmngr / dirmngr_ldap.c
1 /* dirmngr-ldap.c  -  The LDAP helper for dirmngr.
2  *      Copyright (C) 2004 g10 Code GmbH
3  *
4  * This file is part of DirMngr.
5  *
6  * DirMngr is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * DirMngr is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <stddef.h>
26 #include <stdarg.h>
27 #include <string.h>
28 #ifdef HAVE_SIGNAL_H
29 # include <signal.h>
30 #endif
31 #include <errno.h>
32 #include <assert.h>
33 #include <sys/time.h>
34 #include <unistd.h>
35
36 #ifdef HAVE_W32_SYSTEM
37 #include <winsock2.h>
38 #include <winldap.h>
39 #include <fcntl.h>
40 #include "ldap-url.h"
41 #else
42 /* For OpenLDAP, to enable the API that we're using. */
43 #define LDAP_DEPRECATED 1
44 #include <ldap.h>
45 #endif
46
47
48 #define JNLIB_NEED_LOG_LOGV
49 #include "../common/logging.h"
50 #include "../common/argparse.h"
51 #include "../common/stringhelp.h"
52 #include "../common/mischelp.h"
53 #include "../common/strlist.h"
54
55 #include "i18n.h"
56 #include "util.h"
57
58 #define DEFAULT_LDAP_TIMEOUT 100 /* Arbitrary long timeout. */
59
60
61 /* Constants for the options.  */
62 enum 
63   {
64     oQuiet        = 'q',
65     oVerbose      = 'v',
66
67     oTimeout      = 500,
68     oMulti,
69     oProxy,
70     oHost,
71     oPort,
72     oUser,
73     oPass,
74     oEnvPass,
75     oDN,
76     oFilter,
77     oAttr,
78
79     oOnlySearchTimeout,
80     oLogWithPID
81   };
82
83
84 /* The list of options as used by the argparse.c code.  */
85 static ARGPARSE_OPTS opts[] = {
86   { oVerbose,  "verbose",   0, N_("verbose") },
87   { oQuiet,    "quiet",     0, N_("be somewhat more quiet") },
88   { oTimeout,  "timeout",   1, N_("|N|set LDAP timeout to N seconds")},
89   { oMulti,    "multi",     0, N_("return all values in"
90                                   " a record oriented format")},
91   { oProxy,    "proxy",     2,
92     N_("|NAME|ignore host part and connect through NAME")},
93   { oHost,     "host",      2, N_("|NAME|connect to host NAME")},
94   { oPort,     "port",      1, N_("|N|connect to port N")},
95   { oUser,     "user",      2, N_("|NAME|use user NAME for authentication")},
96   { oPass,     "pass",      2, N_("|PASS|use password PASS"
97                                   " for authentication")},
98   { oEnvPass,  "env-pass",  0, N_("take password from $DIRMNGR_LDAP_PASS")},
99   { oDN,       "dn",        2, N_("|STRING|query DN STRING")},
100   { oFilter,   "filter",    2, N_("|STRING|use STRING as filter expression")},
101   { oAttr,     "attr",      2, N_("|STRING|return the attribute STRING")},
102   { oOnlySearchTimeout, "only-search-timeout", 0, "@"},
103   { oLogWithPID,"log-with-pid", 0, "@"},
104   { 0, NULL, 0, NULL }
105 };
106
107
108 /* The usual structure for the program flags.  */
109 static struct
110 {
111   int quiet;
112   int verbose;
113   struct timeval timeout; /* Timeout for the LDAP search functions.  */
114   unsigned int alarm_timeout; /* And for the alarm based timeout.  */
115   int multi;
116
117   /* Note that we can't use const for the strings because ldap_* are
118      not defined that way.  */
119   char *proxy; /* Host and Port override.  */
120   char *user;  /* Authentication user.  */
121   char *pass;  /* Authentication password.  */
122   char *host;  /* Override host.  */
123   int port;    /* Override port.  */
124   char *dn;    /* Override DN.  */
125   char *filter;/* Override filter.  */
126   char *attr;  /* Override attribute.  */
127 } opt;
128
129
130 /* Prototypes.  */
131 static void catch_alarm (int dummy);
132 static int process_url (const char *url);
133
134
135
136 /* Function called by argparse.c to display information.  */
137 static const char *
138 my_strusage (int level)
139 {
140   const char *p;
141     
142   switch(level)
143     {
144     case 11: p = "dirmngr_ldap (GnuPG)";
145       break;
146     case 13: p = VERSION; break;
147     case 17: p = PRINTABLE_OS_NAME; break;
148     case 19: p = _("Please report bugs to <@EMAIL@>.\n"); break;
149     case 49: p = PACKAGE_BUGREPORT; break;
150     case 1:
151     case 40: p =
152                _("Usage: dirmngr_ldap [options] [URL] (-h for help)\n");
153       break;
154     case 41: p =
155           _("Syntax: dirmngr_ldap [options] [URL]\n"
156             "Internal LDAP helper for Dirmngr.\n"
157             "Interface and options may change without notice.\n");
158       break;
159
160     default: p = NULL;
161     }
162   return p;
163 }
164
165
166 int
167 main (int argc, char **argv )
168 {
169   ARGPARSE_ARGS pargs;
170   int any_err = 0;
171   char *p;
172   int only_search_timeout = 0;
173
174   set_strusage (my_strusage);
175   log_set_prefix ("dirmngr_ldap", JNLIB_LOG_WITH_PREFIX); 
176   
177   /* Setup I18N and common subsystems. */
178   i18n_init();
179
180   init_common_subsystems (&argc, &argv);
181
182   es_set_binary (es_stdout);
183
184
185   /* LDAP defaults */
186   opt.timeout.tv_sec = DEFAULT_LDAP_TIMEOUT;
187   opt.timeout.tv_usec = 0;
188   opt.alarm_timeout = 0;
189
190   /* Parse the command line.  */
191   pargs.argc = &argc;
192   pargs.argv = &argv;
193   pargs.flags= 1;  /* Do not remove the args. */
194   while (arg_parse (&pargs, opts) )
195     {
196       switch (pargs.r_opt)
197         {
198         case oVerbose: opt.verbose++; break;
199         case oQuiet: opt.quiet++; break;
200         case oTimeout: 
201           opt.timeout.tv_sec = pargs.r.ret_int; 
202           opt.timeout.tv_usec = 0;
203           opt.alarm_timeout = pargs.r.ret_int;
204           break;
205         case oOnlySearchTimeout: only_search_timeout = 1; break;
206         case oMulti: opt.multi = 1; break;
207         case oUser: opt.user = pargs.r.ret_str; break;
208         case oPass: opt.pass = pargs.r.ret_str; break;
209         case oEnvPass:
210           opt.pass = getenv ("DIRMNGR_LDAP_PASS");
211           break;
212         case oProxy: opt.proxy = pargs.r.ret_str; break;
213         case oHost: opt.host = pargs.r.ret_str; break;
214         case oPort: opt.port = pargs.r.ret_int; break;
215         case oDN:   opt.dn = pargs.r.ret_str; break;
216         case oFilter: opt.filter = pargs.r.ret_str; break;
217         case oAttr: opt.attr = pargs.r.ret_str; break;
218         case oLogWithPID:
219           {
220             unsigned int oldflags;
221             log_get_prefix (&oldflags);
222             log_set_prefix (NULL, oldflags | JNLIB_LOG_WITH_PID);
223           }
224           break;
225
226         default : pargs.err = 2; break;
227         }
228     }
229
230   if (only_search_timeout)
231     opt.alarm_timeout = 0;
232
233   if (opt.proxy)
234     {
235       opt.host = xstrdup (opt.proxy);
236       p = strchr (opt.host, ':');
237       if (p)
238         {
239           *p++ = 0;
240           opt.port = atoi (p);
241         }
242       if (!opt.port)
243         opt.port = 389;  /* make sure ports gets overridden.  */
244     }
245         
246   if (opt.port < 0 || opt.port > 65535)
247     log_error (_("invalid port number %d\n"), opt.port);
248
249   if (log_get_errorcount (0))
250     exit (2);
251
252   if (argc < 1)
253     usage (1);
254
255   if (opt.alarm_timeout)
256     {
257 #ifndef HAVE_W32_SYSTEM
258 # if defined(HAVE_SIGACTION) && defined(HAVE_STRUCT_SIGACTION)
259       struct sigaction act;
260       
261       act.sa_handler = catch_alarm;
262       sigemptyset (&act.sa_mask);
263       act.sa_flags = 0;
264       if (sigaction (SIGALRM,&act,NULL))
265 # else 
266       if (signal (SIGALRM, catch_alarm) == SIG_ERR)
267 # endif
268           log_fatal ("unable to register timeout handler\n");
269 #endif
270     }
271
272   for (; argc; argc--, argv++)
273     if (process_url (*argv))
274       any_err = 1;
275
276   return any_err;
277 }
278
279
280 static void
281 catch_alarm (int dummy)
282 {
283   (void)dummy;
284   _exit (10);
285 }
286
287
288 static void
289 set_timeout (void)
290 {
291 #ifndef HAVE_W32_SYSTEM
292   /* FIXME for W32.  */
293   if (opt.alarm_timeout)
294     alarm (opt.alarm_timeout);
295 #endif
296 }
297
298
299 /* Helper for fetch_ldap().  */
300 static int
301 print_ldap_entries (LDAP *ld, LDAPMessage *msg, char *want_attr)
302 {
303   LDAPMessage *item;
304   int any = 0;
305
306   for (item = ldap_first_entry (ld, msg); item;
307        item = ldap_next_entry (ld, item))
308     {
309       BerElement *berctx;
310       char *attr;
311
312       if (opt.verbose > 1)
313         log_info (_("scanning result for attribute `%s'\n"),
314                   want_attr? want_attr : "[all]");
315
316       if (opt.multi)
317         { /*  Write item marker. */
318           if (es_fwrite ("I\0\0\0\0", 5, 1, es_stdout) != 1)
319             {
320               log_error (_("error writing to stdout: %s\n"),
321                          strerror (errno));
322               return -1;
323             }
324         }
325
326           
327       for (attr = ldap_first_attribute (ld, item, &berctx); attr;
328            attr = ldap_next_attribute (ld, item, berctx))
329         {
330           struct berval **values;
331           int idx;
332
333           if (opt.verbose > 1)
334             log_info (_("          available attribute `%s'\n"), attr);
335           
336           set_timeout ();
337
338           /* I case we want only one attribute we do a case
339              insensitive compare without the optional extension
340              (i.e. ";binary").  Case insensitive is not really correct
341              but the best we can do.  */
342           if (want_attr)
343             {
344               char *cp1, *cp2;
345               int cmpres;
346
347               cp1 = strchr (want_attr, ';');
348               if (cp1)
349                 *cp1 = 0;
350               cp2 = strchr (attr, ';');
351               if (cp2)
352                 *cp2 = 0;
353               cmpres = ascii_strcasecmp (want_attr, attr);
354               if (cp1)
355                 *cp1 = ';';
356               if (cp2)
357                 *cp2 = ';';
358               if (cmpres)
359                 {
360                   ldap_memfree (attr);
361                   continue; /* Not found:  Try next attribute.  */
362                 }
363             }
364
365           values = ldap_get_values_len (ld, item, attr);
366   
367           if (!values)
368             {
369               if (opt.verbose)
370                 log_info (_("attribute `%s' not found\n"), attr);
371               ldap_memfree (attr);
372               continue;
373             }
374
375           if (opt.verbose)
376             {
377               log_info (_("found attribute `%s'\n"), attr);
378               if (opt.verbose > 1)
379                 for (idx=0; values[idx]; idx++)
380                   log_info ("         length[%d]=%d\n",
381                             idx, (int)values[0]->bv_len);
382               
383             }
384
385           if (opt.multi)
386             { /*  Write attribute marker. */
387               unsigned char tmp[5];
388               size_t n = strlen (attr);
389
390               tmp[0] = 'A';
391               tmp[1] = (n >> 24);
392               tmp[2] = (n >> 16);
393               tmp[3] = (n >> 8);
394               tmp[4] = (n);
395               if (es_fwrite (tmp, 5, 1, es_stdout) != 1 
396                   || es_fwrite (attr, n, 1, es_stdout) != 1)
397                 {
398                   log_error (_("error writing to stdout: %s\n"),
399                              strerror (errno));
400                   ldap_value_free_len (values);
401                   ldap_memfree (attr);
402                   ber_free (berctx, 0);
403                   return -1;
404                 }
405             }
406
407           for (idx=0; values[idx]; idx++)
408             {
409               if (opt.multi)
410                 { /* Write value marker.  */
411                   unsigned char tmp[5];
412                   size_t n = values[0]->bv_len;
413
414                   tmp[0] = 'V';
415                   tmp[1] = (n >> 24);
416                   tmp[2] = (n >> 16);
417                   tmp[3] = (n >> 8);
418                   tmp[4] = (n);
419
420                   if (es_fwrite (tmp, 5, 1, es_stdout) != 1)
421                     {
422                       log_error (_("error writing to stdout: %s\n"),
423                                  strerror (errno));
424                       ldap_value_free_len (values);
425                       ldap_memfree (attr);
426                       ber_free (berctx, 0);
427                       return -1;
428                     }
429                 }
430 #if 1
431               /* Note: this does not work for STDOUT on a Windows
432                  console, where it fails with "Not enough space" for
433                  CRLs which are 52 KB or larger.  */
434 #warning still true - implement in estream
435               if (es_fwrite (values[0]->bv_val, values[0]->bv_len,
436                              1, es_stdout) != 1)
437                 {
438                   log_error (_("error writing to stdout: %s\n"),
439                              strerror (errno));
440                   ldap_value_free_len (values);
441                   ldap_memfree (attr);
442                   ber_free (berctx, 0);
443                   return -1;
444                 }
445 #else
446               /* On Windows console STDOUT, we have to break up the
447                  writes into small parts.  */
448               {
449                 int n = 0;
450                 while (n < values[0]->bv_len)
451                   {
452                     int cnt = values[0]->bv_len - n;
453                     /* The actual limit is (52 * 1024 - 1) on Windows XP SP2.  */
454 #define MAX_CNT (32*1024)
455                     if (cnt > MAX_CNT)
456                       cnt = MAX_CNT;
457                     
458                     if (es_fwrite (((char *) values[0]->bv_val) + n, cnt, 1,
459                                    es_stdout) != 1)
460                       {
461                         log_error (_("error writing to stdout: %s\n"),
462                                    strerror (errno));
463                         ldap_value_free_len (values);
464                         ldap_memfree (attr);
465                         ber_free (berctx, 0);
466                         return -1;
467                       }
468                     n += cnt;
469                   }
470               }
471 #endif
472               any = 1;
473               if (!opt.multi)
474                 break; /* Print only the first value.  */
475             }
476           ldap_value_free_len (values);
477           ldap_memfree (attr);
478           if (want_attr || !opt.multi)
479             break; /* We only want to return the first attribute.  */
480         }
481       ber_free (berctx, 0);
482     } 
483
484   if (opt.verbose > 1 && any)
485     log_info ("result has been printed\n");
486
487   return any?0:-1;
488 }
489
490
491
492 /* Helper for the URL based LDAP query. */
493 static int
494 fetch_ldap (const char *url, const LDAPURLDesc *ludp)
495 {
496   LDAP *ld;
497   LDAPMessage *msg;
498   int rc = 0;
499   char *host, *dn, *filter, *attrs[2], *attr;
500   int port;
501
502   host     = opt.host?   opt.host   : ludp->lud_host;
503   port     = opt.port?   opt.port   : ludp->lud_port;
504   dn       = opt.dn?     opt.dn     : ludp->lud_dn;
505   filter   = opt.filter? opt.filter : ludp->lud_filter;
506   attrs[0] = opt.attr?   opt.attr   : ludp->lud_attrs? ludp->lud_attrs[0]:NULL;
507   attrs[1] = NULL;
508   attr = attrs[0];
509
510   if (!port)
511     port = (ludp->lud_scheme && !strcmp (ludp->lud_scheme, "ldaps"))? 636:389;
512
513   if (opt.verbose)
514     {
515       log_info (_("processing url `%s'\n"), url);
516       if (opt.user)
517         log_info (_("          user `%s'\n"), opt.user);
518       if (opt.pass)
519         log_info (_("          pass `%s'\n"), *opt.pass?"*****":"");
520       if (host)
521         log_info (_("          host `%s'\n"), host);
522       log_info (_("          port %d\n"), port);
523       if (dn)
524         log_info (_("            DN `%s'\n"), dn);
525       if (filter)
526         log_info (_("        filter `%s'\n"), filter);
527       if (opt.multi && !opt.attr && ludp->lud_attrs)
528         {
529           int i;
530           for (i=0; ludp->lud_attrs[i]; i++)
531             log_info (_("          attr `%s'\n"), ludp->lud_attrs[i]);
532         }
533       else if (attr)
534         log_info (_("          attr `%s'\n"), attr);
535     }
536
537
538   if (!host || !*host)
539     {
540       log_error (_("no host name in `%s'\n"), url);
541       return -1;
542     }
543   if (!opt.multi && !attr)
544     {
545       log_error (_("no attribute given for query `%s'\n"), url);
546       return -1;
547     }
548
549   if (!opt.multi && !opt.attr
550       && ludp->lud_attrs && ludp->lud_attrs[0] && ludp->lud_attrs[1])
551     log_info (_("WARNING: using first attribute only\n"));
552
553
554   set_timeout ();
555   ld = ldap_init (host, port);
556   if (!ld)
557     {
558       log_error (_("LDAP init to `%s:%d' failed: %s\n"), 
559                  host, port, strerror (errno));
560       return -1;
561     }
562   if (ldap_simple_bind_s (ld, opt.user, opt.pass))
563     {
564       log_error (_("binding to `%s:%d' failed: %s\n"), 
565                  host, port, strerror (errno));
566       /* FIXME: Need deinit (ld)?  */
567       return -1;
568     }
569
570   set_timeout ();
571   rc = ldap_search_st (ld, dn, ludp->lud_scope, filter,
572                        opt.multi && !opt.attr && ludp->lud_attrs?
573                        ludp->lud_attrs:attrs,
574                        0,
575                        &opt.timeout, &msg);
576   if (rc == LDAP_SIZELIMIT_EXCEEDED && opt.multi)
577     {
578       if (es_fwrite ("E\0\0\0\x09truncated", 14, 1, es_stdout) != 1)
579         {
580           log_error (_("error writing to stdout: %s\n"),
581                      strerror (errno));
582           return -1;
583         }
584     }
585   else if (rc)
586     {
587       log_error (_("searching `%s' failed: %s\n"), 
588                  url, ldap_err2string (rc));
589       if (rc != LDAP_NO_SUCH_OBJECT)
590         {
591           /* FIXME: Need deinit (ld)?  */
592           /* Hmmm: Do we need to released MSG in case of an error? */
593           return -1;
594         }
595     }
596
597   rc = print_ldap_entries (ld, msg, opt.multi? NULL:attr);
598
599   ldap_msgfree (msg);
600   /* FIXME: Need deinit (ld)?  */
601   return rc;
602 }
603
604
605
606
607 /* Main processing.  Take the URL and run the LDAP query. The result
608    is printed to stdout, errors are logged to the log stream. */
609 static int
610 process_url (const char *url)
611 {
612   int rc;
613   LDAPURLDesc *ludp = NULL;
614
615
616   if (!ldap_is_ldap_url (url))
617     {
618       log_error (_("`%s' is not an LDAP URL\n"), url);
619       return -1;
620     }
621
622   if (ldap_url_parse (url, &ludp))
623     {
624       log_error (_("`%s' is an invalid LDAP URL\n"), url);
625       return -1;
626     }
627
628   rc = fetch_ldap (url, ludp);
629
630   ldap_free_urldesc (ludp);
631   return rc;
632 }
633