git.chise.org Git - chise/xemacs-chise.git.1/blob - src/eldap.c

   1 /* LDAP client interface for XEmacs.
   2    Copyright (C) 1998 Free Software Foundation, Inc.
   3
   4 This file is part of XEmacs.
   5
   6 XEmacs is free software; you can redistribute it and/or modify it
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option) any
   9 later version.
  10
  11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
  12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with XEmacs; see the file COPYING.  If not, write to
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 /* Synched up with: Not in FSF. */
  22
  23 /* Author: Oscar Figueiredo with lots of support from Hrvoje Niksic */
  24
  25 /* This file provides lisp primitives for access to an LDAP library
  26    conforming to the API defined in RFC 1823.
  27    It has been tested with:
  28    - UMich LDAP 3.3 (http://www.umich.edu/~dirsvcs/ldap/)
  29    - OpenLDAP 1.0.3 (http://www.openldap.org/)
  30    - Netscape's LDAP SDK 1.0 (http://developer.netscape.com) */
  31
  32
  33 #include <config.h>
  34 #include "lisp.h"
  35 #include "opaque.h"
  36 #include "sysdep.h"
  37 #include "buffer.h"
  38
  39 #include <errno.h>
  40
  41 #include "eldap.h"
  42
  43 #ifdef HAVE_NS_LDAP
  44 # define HAVE_LDAP_SET_OPTION 1
  45 # define HAVE_LDAP_GET_ERRNO 1
  46 #else
  47 # undef HAVE_LDAP_SET_OPTION
  48 # undef HAVE_LDAP_GET_ERRNO
  49 #endif
  50
  51 static int ldap_default_port;
  52 static Lisp_Object Vldap_default_base;
  53
  54 /* Needed by the lrecord definition */
  55 Lisp_Object Qldapp;
  56
  57 /* ldap-open plist keywords */
  58 extern Lisp_Object Qport, Qauth, Qbinddn, Qpasswd, Qderef, Qtimelimit,
  59   Qsizelimit;
  60 /* Search scope limits */
  61 extern Lisp_Object Qbase, Qonelevel, Qsubtree;
  62 /* Authentication methods */
  63 extern Lisp_Object Qkrbv41, Qkrbv42;
  64 /* Deref policy */
  65 extern Lisp_Object Qnever, Qalways, Qfind;
  66 \f
  67 /************************************************************************/
  68 /*                         Utility Functions                            */
  69 /************************************************************************/
  70
  71 static void
  72 signal_ldap_error (LDAP *ld)
  73 {
  74 #ifdef HAVE_LDAP_GET_ERRNO
  75   signal_simple_error
  76     ("LDAP error",
  77      build_string (ldap_err2string (ldap_get_lderrno (ld, NULL, NULL))));
  78 #else
  79   signal_simple_error ("LDAP error",
  80                        build_string (ldap_err2string (ld->ld_errno)));
  81 #endif
  82 }
  83
  84 \f
  85 /************************************************************************/
  86 /*                        ldap lrecord basic functions                  */
  87 /************************************************************************/
  88
  89 static Lisp_Object
  90 make_ldap (struct Lisp_LDAP *ldap)
  91 {
  92   Lisp_Object lisp_ldap;
  93   XSETLDAP (lisp_ldap, ldap);
  94   return lisp_ldap;
  95 }
  96
  97 static Lisp_Object
  98 mark_ldap (Lisp_Object obj, void (*markobj) (Lisp_Object))
  99 {
 100   return XLDAP (obj)->host;
 101 }
 102
 103 static void
 104 print_ldap (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
 105 {
 106   char buf[32];
 107
 108   struct Lisp_LDAP *ldap = XLDAP (obj);
 109
 110   if (print_readably)
 111     error ("printing unreadable object #<ldap %s>",
 112            XSTRING_DATA (ldap->host));
 113
 114   write_c_string ("#<ldap ", printcharfun);
 115   print_internal (ldap->host, printcharfun, 1);
 116   if (!ldap->livep)
 117     write_c_string ("(dead) ",printcharfun);
 118   sprintf (buf, " 0x%x>", (unsigned int)ldap);
 119   write_c_string (buf, printcharfun);
 120 }
 121
 122 static struct Lisp_LDAP *
 123 allocate_ldap (void)
 124 {
 125   struct Lisp_LDAP *ldap =
 126     alloc_lcrecord_type (struct Lisp_LDAP, lrecord_ldap);
 127
 128   ldap->ld = NULL;
 129   ldap->host = Qnil;
 130   ldap->livep = 0;
 131   return ldap;
 132 }
 133
 134 static void
 135 finalize_ldap (void *header, int for_disksave)
 136 {
 137   struct Lisp_LDAP *ldap = (struct Lisp_LDAP *) header;
 138
 139   if (for_disksave)
 140     signal_simple_error ("Can't dump an emacs containing LDAP objects",
 141                          make_ldap (ldap));
 142
 143   if (ldap->livep)
 144     ldap_unbind (ldap->ld);
 145 }
 146
 147 DEFINE_LRECORD_IMPLEMENTATION ("ldap", ldap,
 148                                mark_ldap, print_ldap, finalize_ldap,
 149                                NULL, NULL, struct Lisp_LDAP);
 150
 151
 152
 153 \f
 154 /************************************************************************/
 155 /*                        Basic ldap accessors                          */
 156 /************************************************************************/
 157
 158 DEFUN ("ldapp", Fldapp, 1, 1, 0, /*
 159 Return t if OBJECT is a LDAP connection.
 160 */
 161        (object))
 162 {
 163   return LDAPP (object) ? Qt : Qnil;
 164 }
 165
 166 DEFUN ("ldap-host", Fldap_host, 1, 1, 0, /*
 167 Return the server host of the connection LDAP, as a string.
 168 */
 169        (ldap))
 170 {
 171   CHECK_LDAP (ldap);
 172   return (XLDAP (ldap))->host;
 173 }
 174
 175 DEFUN ("ldap-live-p", Fldap_status, 1, 1, 0, /*
 176 Return t if LDAP is an active LDAP connection.
 177 */
 178        (ldap))
 179 {
 180   CHECK_LDAP (ldap);
 181   return (XLDAP (ldap))->livep ? Qt : Qnil;
 182 }
 183 \f
 184 /************************************************************************/
 185 /*                  Opening/Closing a LDAP connection                   */
 186 /************************************************************************/
 187
 188
 189 DEFUN ("ldap-open", Fldap_open, 1, 2, 0, /*
 190 Open a LDAP connection to HOST.
 191 PLIST is a plist containing additional parameters for the connection.
 192 Valid keys in that list are:
 193   `port' the TCP port to use for the connection if different from
 194 `ldap-default-port'.
 195   `auth' is the authentication method to use, possible values depend on
 196 the LDAP library XEmacs was compiled with: `simple', `krbv41' and `krbv42'.
 197   `binddn' is the distinguished name of the user to bind as (in RFC 1779 syntax).
 198   `passwd' is the password to use for simple authentication.
 199   `deref' is one of the symbols `never', `always', `search' or `find'.
 200   `timelimit' is the timeout limit for the connection in seconds.
 201   `sizelimit' is the maximum number of matches to return.
 202 */
 203        (host, plist))
 204 {
 205   /* This function can GC */
 206   struct Lisp_LDAP *ldap;
 207   LDAP *ld;
 208   int  ldap_port = 0;
 209   int  ldap_auth = LDAP_AUTH_SIMPLE;
 210   char *ldap_binddn = NULL;
 211   char *ldap_passwd = NULL;
 212   int  ldap_deref = LDAP_DEREF_NEVER;
 213   int  ldap_timelimit = 0;
 214   int  ldap_sizelimit = 0;
 215   int  err;
 216
 217   Lisp_Object list, keyword, value;
 218
 219   CHECK_STRING (host);
 220
 221   EXTERNAL_PROPERTY_LIST_LOOP (list, keyword, value, plist)
 222     {
 223       /* TCP Port */
 224       if (EQ (keyword, Qport))
 225         {
 226           CHECK_INT (value);
 227           ldap_port = XINT (value);
 228         }
 229       /* Authentication method */
 230       if (EQ (keyword, Qauth))
 231         {
 232           if (EQ (value, Qsimple))
 233             ldap_auth = LDAP_AUTH_SIMPLE;
 234 #ifdef LDAP_AUTH_KRBV41
 235           else if (EQ (value, Qkrbv41))
 236             ldap_auth = LDAP_AUTH_KRBV41;
 237 #endif
 238 #ifdef LDAP_AUTH_KRBV42
 239           else if (EQ (value, Qkrbv42))
 240             ldap_auth = LDAP_AUTH_KRBV42;
 241 #endif
 242           else
 243             signal_simple_error ("Invalid authentication method", value);
 244         }
 245       /* Bind DN */
 246       else if (EQ (keyword, Qbinddn))
 247         {
 248           CHECK_STRING (value);
 249           GET_C_STRING_OS_DATA_ALLOCA (value, ldap_binddn);
 250         }
 251       /* Password */
 252       else if (EQ (keyword, Qpasswd))
 253         {
 254           CHECK_STRING (value);
 255           GET_C_STRING_OS_DATA_ALLOCA (value, ldap_passwd);
 256         }
 257       /* Deref */
 258       else if (EQ (keyword, Qderef))
 259         {
 260           if (EQ (value, Qnever))
 261             ldap_deref = LDAP_DEREF_NEVER;
 262           else if (EQ (value, Qsearch))
 263             ldap_deref = LDAP_DEREF_SEARCHING;
 264           else if (EQ (value, Qfind))
 265             ldap_deref = LDAP_DEREF_FINDING;
 266           else if (EQ (value, Qalways))
 267             ldap_deref = LDAP_DEREF_ALWAYS;
 268           else
 269             signal_simple_error ("Invalid deref value", value);
 270         }
 271       /* Timelimit */
 272       else if (EQ (keyword, Qtimelimit))
 273         {
 274           CHECK_INT (value);
 275           ldap_timelimit = XINT (value);
 276         }
 277       /* Sizelimit */
 278       else if (EQ (keyword, Qsizelimit))
 279         {
 280           CHECK_INT (value);
 281           ldap_sizelimit = XINT (value);
 282         }
 283     }
 284
 285   if (ldap_port == 0)
 286     {
 287       ldap_port = ldap_default_port;
 288     }
 289
 290   /* Connect to the server and bind */
 291   ld = ldap_open ((char *)XSTRING_DATA (host), ldap_port);
 292   if (ld == NULL )
 293     signal_simple_error_2 ("Failed connecting to host",
 294                            host,
 295                            lisp_strerror (errno));
 296
 297
 298 #ifdef HAVE_LDAP_SET_OPTION
 299   if (ldap_set_option (ld, LDAP_OPT_DEREF, (void *)&ldap_deref) != LDAP_SUCCESS)
 300     signal_ldap_error (ld);
 301   if (ldap_set_option (ld, LDAP_OPT_TIMELIMIT,
 302                        (void *)&ldap_timelimit) != LDAP_SUCCESS)
 303     signal_ldap_error (ld);
 304   if (ldap_set_option (ld, LDAP_OPT_SIZELIMIT,
 305                        (void *)&ldap_sizelimit) != LDAP_SUCCESS)
 306     signal_ldap_error (ld);
 307   if (ldap_set_option (ld, LDAP_OPT_REFERRALS, LDAP_OPT_ON) != LDAP_SUCCESS)
 308     signal_ldap_error (ld);
 309 #else  /* not HAVE_LDAP_SET_OPTION */
 310   ld->ld_deref = ldap_deref;
 311   ld->ld_timelimit = ldap_timelimit;
 312   ld->ld_sizelimit = ldap_sizelimit;
 313 #ifdef LDAP_REFERRALS
 314   ld->ld_options = LDAP_OPT_REFERRALS;
 315 #else /* not LDAP_REFERRALS */
 316   ld->ld_options = 0;
 317 #endif /* not LDAP_REFERRALS */
 318 #endif /* not HAVE_LDAP_SET_OPTION */
 319
 320   /* ldap_bind_s calls select and may be wedged by SIGIO.  */
 321   slow_down_interrupts ();
 322   err = ldap_bind_s (ld, ldap_binddn, ldap_passwd, ldap_auth);
 323   speed_up_interrupts ();
 324   if (err != LDAP_SUCCESS)
 325     signal_simple_error ("Failed binding to the server",
 326                          build_string (ldap_err2string (err)));
 327
 328   ldap = allocate_ldap ();
 329   ldap->ld = ld;
 330   ldap->host = host;
 331   ldap->livep = 1;
 332
 333   return make_ldap (ldap);
 334 }
 335
 336
 337
 338 DEFUN ("ldap-close", Fldap_close, 1, 1, 0, /*
 339 Close an LDAP connection.
 340 */
 341       (ldap))
 342 {
 343   struct Lisp_LDAP *lldap;
 344   CHECK_LIVE_LDAP (ldap);
 345   lldap = XLDAP (ldap);
 346   ldap_unbind (lldap->ld);
 347   lldap->livep = 0;
 348   return Qnil;
 349 }
 350
 351
 352 \f
 353 /************************************************************************/
 354 /*                  Working on a LDAP connection                        */
 355 /************************************************************************/
 356 struct ldap_unwind_struct
 357 {
 358   LDAPMessage *res;
 359   char **vals;
 360 };
 361
 362
 363 static Lisp_Object
 364 ldap_search_unwind (Lisp_Object unwind_obj)
 365 {
 366   struct ldap_unwind_struct *unwind =
 367     (struct ldap_unwind_struct *) get_opaque_ptr (unwind_obj);
 368   if (unwind->res)
 369     ldap_msgfree (unwind->res);
 370   if (unwind->vals)
 371     ldap_value_free (unwind->vals);
 372   return Qnil;
 373 }
 374
 375 DEFUN ("ldap-search-internal", Fldap_search_internal, 2, 6, 0, /*
 376 Perform a search on an open LDAP connection.
 377 LDAP is an LDAP connection object created with `ldap-open'.
 378 FILTER is a filter string for the search as described in RFC 1558.
 379 BASE is the distinguished name at which to start the search.
 380 SCOPE is one of the symbols `base', `onelevel' or `subtree' indicating
 381 the scope of the search.
 382 ATTRS is a list of strings indicating which attributes to retrieve
 383  for each matching entry. If nil return all available attributes.
 384 If ATTRSONLY is non-nil then only the attributes are retrieved, not
 385 the associated values.
 386 The function returns a list of matching entries.  Each entry is itself
 387 an alist of attribute/values.
 388 */
 389        (ldap, filter, base, scope, attrs, attrsonly))
 390 {
 391   /* This function can GC */
 392
 393   /* Vars for query */
 394   LDAP *ld;
 395   LDAPMessage *e;
 396   BerElement *ptr;
 397   char *a;
 398   int i, rc;
 399   int  matches;
 400   struct ldap_unwind_struct unwind;
 401
 402   int  ldap_scope = LDAP_SCOPE_SUBTREE;
 403   char **ldap_attributes = NULL;
 404
 405   int speccount = specpdl_depth ();
 406
 407   Lisp_Object list, entry, result;
 408   struct gcpro gcpro1, gcpro2, gcpro3;
 409
 410   list = entry = result = Qnil;
 411   GCPRO3 (list, entry, result);
 412
 413   unwind.res = NULL;
 414   unwind.vals = NULL;
 415
 416   /* Do all the parameter checking  */
 417   CHECK_LIVE_LDAP (ldap);
 418   ld = XLDAP (ldap)->ld;
 419
 420   /* Filter */
 421   CHECK_STRING (filter);
 422
 423   /* Search base */
 424   if (NILP (base))
 425     {
 426       base = Vldap_default_base;
 427     }
 428   if (!NILP (base))
 429     {
 430       CHECK_STRING (base);
 431     }
 432
 433   /* Search scope */
 434   if (!NILP (scope))
 435     {
 436       if (EQ (scope, Qbase))
 437         ldap_scope = LDAP_SCOPE_BASE;
 438       else if (EQ (scope, Qonelevel))
 439         ldap_scope = LDAP_SCOPE_ONELEVEL;
 440       else if (EQ (scope, Qsubtree))
 441         ldap_scope = LDAP_SCOPE_SUBTREE;
 442       else
 443         signal_simple_error ("Invalid scope", scope);
 444     }
 445
 446   /* Attributes to search */
 447   if (!NILP (attrs))
 448     {
 449       CHECK_CONS (attrs);
 450       ldap_attributes = alloca_array (char *, 1 + XINT (Flength (attrs)));
 451
 452       i = 0;
 453       EXTERNAL_LIST_LOOP (attrs, attrs)
 454         {
 455           Lisp_Object current = XCAR (attrs);
 456           CHECK_STRING (current);
 457           GET_C_STRING_OS_DATA_ALLOCA (current, ldap_attributes[i]);
 458           ++i;
 459         }
 460       ldap_attributes[i] = NULL;
 461     }
 462
 463   /* Attributes only ? */
 464   CHECK_SYMBOL (attrsonly);
 465
 466   /* Perform the search */
 467   if (ldap_search (ld,
 468                    NILP (base) ? "" : (char *) XSTRING_DATA (base),
 469                    ldap_scope,
 470                    NILP (filter) ? "" : (char *) XSTRING_DATA (filter),
 471                    ldap_attributes,
 472                    NILP (attrsonly) ? 0 : 1)
 473        == -1)
 474     {
 475       signal_ldap_error (ld);
 476     }
 477
 478   /* Ensure we don't exit without cleaning up */
 479   record_unwind_protect (ldap_search_unwind,
 480                          make_opaque_ptr (&unwind));
 481
 482   /* Build the results list */
 483   matches = 0;
 484
 485   /* ldap_result calls select() and can get wedged by EINTR signals */
 486   slow_down_interrupts ();
 487   rc = ldap_result (ld, LDAP_RES_ANY, 0, NULL, &unwind.res);
 488   speed_up_interrupts ();
 489   while (rc == LDAP_RES_SEARCH_ENTRY)
 490     {
 491       QUIT;
 492       matches ++;
 493       e = ldap_first_entry (ld, unwind.res);
 494       /* #### This call to message() is pretty fascist, because it
 495          destroys the current echo area contents, even when invoked
 496          from Lisp.  It should use echo_area_message() instead, and
 497          restore the old echo area contents later.  */
 498       message ("Parsing ldap results... %d", matches);
 499       entry = Qnil;
 500       for (a= ldap_first_attribute (ld, e, &ptr);
 501            a != NULL;
 502            a= ldap_next_attribute (ld, e, ptr) )
 503         {
 504           list = Fcons (build_ext_string (a, FORMAT_OS), Qnil);
 505           unwind.vals = ldap_get_values (ld, e, a);
 506           if (unwind.vals != NULL)
 507             {
 508               for (i = 0; unwind.vals[i] != NULL; i++)
 509                 {
 510                   list = Fcons (build_ext_string (unwind.vals[i], FORMAT_OS),
 511                                 list);
 512                 }
 513             }
 514           entry = Fcons (Fnreverse (list),
 515                          entry);
 516           ldap_value_free (unwind.vals);
 517           unwind.vals = NULL;
 518         }
 519       result = Fcons (Fnreverse (entry),
 520                       result);
 521       ldap_msgfree (unwind.res);
 522       unwind.res = NULL;
 523
 524       slow_down_interrupts ();
 525       rc = ldap_result (ld, LDAP_RES_ANY, 0, NULL, &(unwind.res));
 526       speed_up_interrupts ();
 527     }
 528
 529   if (rc == -1)
 530     {
 531       signal_ldap_error (ld);
 532     }
 533   rc = ldap_result2error (ld, unwind.res, 0);
 534   if ((rc != LDAP_SUCCESS) &&
 535       (rc != LDAP_SIZELIMIT_EXCEEDED))
 536     {
 537       signal_ldap_error (ld);
 538     }
 539
 540   ldap_msgfree (unwind.res);
 541   unwind.res = (LDAPMessage *)NULL;
 542   /* #### See above for calling message().  */
 543   message ("Parsing ldap results... done");
 544
 545   unbind_to (speccount, Qnil);
 546   UNGCPRO;
 547   return Fnreverse (result);
 548 }
 549
 550
 551 void
 552 syms_of_eldap (void)
 553 {
 554   defsymbol (&Qldapp, "ldapp");
 555   DEFSUBR (Fldapp);
 556   DEFSUBR (Fldap_host);
 557   DEFSUBR (Fldap_status);
 558   DEFSUBR (Fldap_open);
 559   DEFSUBR (Fldap_close);
 560   DEFSUBR (Fldap_search_internal);
 561 }
 562
 563 void
 564 vars_of_eldap (void)
 565 {
 566   Fprovide (intern ("ldap"));
 567
 568   ldap_default_port = LDAP_PORT;
 569   Vldap_default_base =  Qnil;
 570
 571   DEFVAR_INT ("ldap-default-port", &ldap_default_port /*
 572 Default TCP port for LDAP connections.
 573 Initialized from the LDAP library. Default value is 389.
 574 */ );
 575
 576   DEFVAR_LISP ("ldap-default-base", &Vldap_default_base /*
 577 Default base for LDAP searches.
 578 This is a string using the syntax of RFC 1779.
 579 For instance, "o=ACME, c=US" limits the search to the
 580 Acme organization in the United States.
 581 */ );
 582
 583 }
 584
 585