source3/lib/smbldap.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    LDAP protocol helper functions for SAMBA
   4    Copyright (C) Jean François Micouleau       1998
   5    Copyright (C) Gerald Carter                  2001-2003
   6    Copyright (C) Shahms King                    2001
   7    Copyright (C) Andrew Bartlett                2002-2003
   8    Copyright (C) Stefan (metze) Metzmacher      2002-2003
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 */
  24
  25 #include "includes.h"
  26 #include "smbldap.h"
  27 #include "../libcli/security/security.h"
  28 #include <tevent.h>
  29
  30 /* Try not to hit the up or down server forever */
  31
  32 #define SMBLDAP_DONT_PING_TIME 10       /* ping only all 10 seconds */
  33 #define SMBLDAP_NUM_RETRIES 8           /* retry only 8 times */
  34
  35 #define SMBLDAP_IDLE_TIME 150           /* After 2.5 minutes disconnect */
  36
  37
  38 /*******************************************************************
  39  Search an attribute and return the first value found.
  40 ******************************************************************/
  41
  42  bool smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
  43                                     const char *attribute, char *value,
  44                                     int max_len)
  45 {
  46         char **values;
  47         size_t size = 0;
  48
  49         if ( !attribute )
  50                 return False;
  51
  52         value[0] = '\0';
  53
  54         if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
  55                 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
  56
  57                 return False;
  58         }
  59
  60         if (!convert_string(CH_UTF8, CH_UNIX,values[0], -1, value, max_len, &size)) {
  61                 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
  62                           attribute, values[0]));
  63                 ldap_value_free(values);
  64                 return False;
  65         }
  66
  67         ldap_value_free(values);
  68 #ifdef DEBUG_PASSWORDS
  69         DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
  70 #endif
  71         return True;
  72 }
  73
  74  char * smbldap_talloc_single_attribute(LDAP *ldap_struct, LDAPMessage *entry,
  75                                         const char *attribute,
  76                                         TALLOC_CTX *mem_ctx)
  77 {
  78         char **values;
  79         char *result;
  80         size_t converted_size;
  81
  82         if (attribute == NULL) {
  83                 return NULL;
  84         }
  85
  86         values = ldap_get_values(ldap_struct, entry, attribute);
  87
  88         if (values == NULL) {
  89                 DEBUG(10, ("attribute %s does not exist\n", attribute));
  90                 return NULL;
  91         }
  92
  93         if (ldap_count_values(values) != 1) {
  94                 DEBUG(10, ("attribute %s has %d values, expected only one\n",
  95                            attribute, ldap_count_values(values)));
  96                 ldap_value_free(values);
  97                 return NULL;
  98         }
  99
 100         if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
 101                 DEBUG(10, ("pull_utf8_talloc failed\n"));
 102                 ldap_value_free(values);
 103                 return NULL;
 104         }
 105
 106         ldap_value_free(values);
 107
 108 #ifdef DEBUG_PASSWORDS
 109         DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
 110                      attribute, result));
 111 #endif
 112         return result;
 113 }
 114
 115  char * smbldap_talloc_first_attribute(LDAP *ldap_struct, LDAPMessage *entry,
 116                                        const char *attribute,
 117                                        TALLOC_CTX *mem_ctx)
 118 {
 119         char **values;
 120         char *result;
 121         size_t converted_size;
 122
 123         if (attribute == NULL) {
 124                 return NULL;
 125         }
 126
 127         values = ldap_get_values(ldap_struct, entry, attribute);
 128
 129         if (values == NULL) {
 130                 DEBUG(10, ("attribute %s does not exist\n", attribute));
 131                 return NULL;
 132         }
 133
 134         if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
 135                 DEBUG(10, ("pull_utf8_talloc failed\n"));
 136                 ldap_value_free(values);
 137                 return NULL;
 138         }
 139
 140         ldap_value_free(values);
 141
 142 #ifdef DEBUG_PASSWORDS
 143         DEBUG (100, ("smbldap_get_first_attribute: [%s] = [%s]\n",
 144                      attribute, result));
 145 #endif
 146         return result;
 147 }
 148
 149  char * smbldap_talloc_smallest_attribute(LDAP *ldap_struct, LDAPMessage *entry,
 150                                           const char *attribute,
 151                                           TALLOC_CTX *mem_ctx)
 152 {
 153         char **values;
 154         char *result;
 155         size_t converted_size;
 156         int i, num_values;
 157
 158         if (attribute == NULL) {
 159                 return NULL;
 160         }
 161
 162         values = ldap_get_values(ldap_struct, entry, attribute);
 163
 164         if (values == NULL) {
 165                 DEBUG(10, ("attribute %s does not exist\n", attribute));
 166                 return NULL;
 167         }
 168
 169         if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
 170                 DEBUG(10, ("pull_utf8_talloc failed\n"));
 171                 ldap_value_free(values);
 172                 return NULL;
 173         }
 174
 175         num_values = ldap_count_values(values);
 176
 177         for (i=1; i<num_values; i++) {
 178                 char *tmp;
 179
 180                 if (!pull_utf8_talloc(mem_ctx, &tmp, values[i],
 181                                       &converted_size)) {
 182                         DEBUG(10, ("pull_utf8_talloc failed\n"));
 183                         TALLOC_FREE(result);
 184                         ldap_value_free(values);
 185                         return NULL;
 186                 }
 187
 188                 if (strcasecmp_m(tmp, result) < 0) {
 189                         TALLOC_FREE(result);
 190                         result = tmp;
 191                 } else {
 192                         TALLOC_FREE(tmp);
 193                 }
 194         }
 195
 196         ldap_value_free(values);
 197
 198 #ifdef DEBUG_PASSWORDS
 199         DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
 200                      attribute, result));
 201 #endif
 202         return result;
 203 }
 204
 205  bool smbldap_talloc_single_blob(TALLOC_CTX *mem_ctx, LDAP *ld,
 206                                  LDAPMessage *msg, const char *attrib,
 207                                  DATA_BLOB *blob)
 208 {
 209         struct berval **values;
 210
 211         values = ldap_get_values_len(ld, msg, attrib);
 212         if (!values) {
 213                 return false;
 214         }
 215
 216         if (ldap_count_values_len(values) != 1) {
 217                 DEBUG(10, ("Expected one value for %s, got %d\n", attrib,
 218                            ldap_count_values_len(values)));
 219                 return false;
 220         }
 221
 222         *blob = data_blob_talloc(mem_ctx, values[0]->bv_val,
 223                                  values[0]->bv_len);
 224         ldap_value_free_len(values);
 225
 226         return (blob->data != NULL);
 227 }
 228
 229  bool smbldap_pull_sid(LDAP *ld, LDAPMessage *msg, const char *attrib,
 230                        struct dom_sid *sid)
 231 {
 232         DATA_BLOB blob;
 233         bool ret;
 234
 235         if (!smbldap_talloc_single_blob(talloc_tos(), ld, msg, attrib,
 236                                         &blob)) {
 237                 return false;
 238         }
 239         ret = sid_parse((char *)blob.data, blob.length, sid);
 240         TALLOC_FREE(blob.data);
 241         return ret;
 242 }
 243
 244  static int ldapmsg_destructor(LDAPMessage **result) {
 245         ldap_msgfree(*result);
 246         return 0;
 247 }
 248
 249  void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
 250 {
 251         LDAPMessage **handle;
 252
 253         if (result == NULL) {
 254                 return;
 255         }
 256
 257         handle = talloc(mem_ctx, LDAPMessage *);
 258         SMB_ASSERT(handle != NULL);
 259
 260         *handle = result;
 261         talloc_set_destructor(handle, ldapmsg_destructor);
 262 }
 263
 264  static int ldapmod_destructor(LDAPMod ***mod) {
 265         ldap_mods_free(*mod, True);
 266         return 0;
 267 }
 268
 269  void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
 270 {
 271         LDAPMod ***handle;
 272
 273         if (mod == NULL) {
 274                 return;
 275         }
 276
 277         handle = talloc(mem_ctx, LDAPMod **);
 278         SMB_ASSERT(handle != NULL);
 279
 280         *handle = mod;
 281         talloc_set_destructor(handle, ldapmod_destructor);
 282 }
 283
 284 /************************************************************************
 285  Routine to manage the LDAPMod structure array
 286  manage memory used by the array, by each struct, and values
 287  ***********************************************************************/
 288
 289 static void smbldap_set_mod_internal(LDAPMod *** modlist, int modop, const char *attribute, const char *value, const DATA_BLOB *blob)
 290 {
 291         LDAPMod **mods;
 292         int i;
 293         int j;
 294
 295         mods = *modlist;
 296
 297         /* sanity checks on the mod values */
 298
 299         if (attribute == NULL || *attribute == '\0') {
 300                 return;
 301         }
 302
 303 #if 0   /* commented out after discussion with abartlet.  Do not reenable.
 304            left here so other do not re-add similar code   --jerry */
 305         if (value == NULL || *value == '\0')
 306                 return;
 307 #endif
 308
 309         if (mods == NULL) {
 310                 mods = SMB_MALLOC_P(LDAPMod *);
 311                 if (mods == NULL) {
 312                         smb_panic("smbldap_set_mod: out of memory!");
 313                         /* notreached. */
 314                 }
 315                 mods[0] = NULL;
 316         }
 317
 318         for (i = 0; mods[i] != NULL; ++i) {
 319                 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
 320                         break;
 321         }
 322
 323         if (mods[i] == NULL) {
 324                 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
 325                 if (mods == NULL) {
 326                         smb_panic("smbldap_set_mod: out of memory!");
 327                         /* notreached. */
 328                 }
 329                 mods[i] = SMB_MALLOC_P(LDAPMod);
 330                 if (mods[i] == NULL) {
 331                         smb_panic("smbldap_set_mod: out of memory!");
 332                         /* notreached. */
 333                 }
 334                 mods[i]->mod_op = modop;
 335                 mods[i]->mod_values = NULL;
 336                 mods[i]->mod_type = SMB_STRDUP(attribute);
 337                 mods[i + 1] = NULL;
 338         }
 339
 340         if (blob && (modop & LDAP_MOD_BVALUES)) {
 341                 j = 0;
 342                 if (mods[i]->mod_bvalues != NULL) {
 343                         for (; mods[i]->mod_bvalues[j] != NULL; j++);
 344                 }
 345                 mods[i]->mod_bvalues = SMB_REALLOC_ARRAY(mods[i]->mod_bvalues, struct berval *, j + 2);
 346
 347                 if (mods[i]->mod_bvalues == NULL) {
 348                         smb_panic("smbldap_set_mod: out of memory!");
 349                         /* notreached. */
 350                 }
 351
 352                 mods[i]->mod_bvalues[j] = SMB_MALLOC_P(struct berval);
 353                 SMB_ASSERT(mods[i]->mod_bvalues[j] != NULL);
 354
 355                 mods[i]->mod_bvalues[j]->bv_val = (char *)memdup(blob->data, blob->length);
 356                 SMB_ASSERT(mods[i]->mod_bvalues[j]->bv_val != NULL);
 357                 mods[i]->mod_bvalues[j]->bv_len = blob->length;
 358
 359                 mods[i]->mod_bvalues[j + 1] = NULL;
 360         } else if (value != NULL) {
 361                 char *utf8_value = NULL;
 362                 size_t converted_size;
 363
 364                 j = 0;
 365                 if (mods[i]->mod_values != NULL) {
 366                         for (; mods[i]->mod_values[j] != NULL; j++);
 367                 }
 368                 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
 369
 370                 if (mods[i]->mod_values == NULL) {
 371                         smb_panic("smbldap_set_mod: out of memory!");
 372                         /* notreached. */
 373                 }
 374
 375                 if (!push_utf8_talloc(talloc_tos(), &utf8_value, value, &converted_size)) {
 376                         smb_panic("smbldap_set_mod: String conversion failure!");
 377                         /* notreached. */
 378                 }
 379
 380                 mods[i]->mod_values[j] = SMB_STRDUP(utf8_value);
 381                 TALLOC_FREE(utf8_value);
 382                 SMB_ASSERT(mods[i]->mod_values[j] != NULL);
 383
 384                 mods[i]->mod_values[j + 1] = NULL;
 385         }
 386         *modlist = mods;
 387 }
 388
 389  void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
 390 {
 391         smbldap_set_mod_internal(modlist, modop, attribute, value, NULL);
 392 }
 393
 394  void smbldap_set_mod_blob(LDAPMod *** modlist, int modop, const char *attribute, const DATA_BLOB *value)
 395 {
 396         smbldap_set_mod_internal(modlist, modop | LDAP_MOD_BVALUES, attribute, NULL, value);
 397 }
 398
 399 /**********************************************************************
 400   Set attribute to newval in LDAP, regardless of what value the
 401   attribute had in LDAP before.
 402 *********************************************************************/
 403
 404 static void smbldap_make_mod_internal(LDAP *ldap_struct, LDAPMessage *existing,
 405                                       LDAPMod ***mods,
 406                                       const char *attribute, int op,
 407                                       const char *newval,
 408                                       const DATA_BLOB *newblob)
 409 {
 410         char oldval[2048]; /* current largest allowed value is mungeddial */
 411         bool existed;
 412         DATA_BLOB oldblob = data_blob_null;
 413
 414         if (attribute == NULL) {
 415                 /* This can actually happen for ldapsam_compat where we for
 416                  * example don't have a password history */
 417                 return;
 418         }
 419
 420         if (existing != NULL) {
 421                 if (op & LDAP_MOD_BVALUES) {
 422                         existed = smbldap_talloc_single_blob(talloc_tos(), ldap_struct, existing, attribute, &oldblob);
 423                 } else {
 424                         existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
 425                 }
 426         } else {
 427                 existed = False;
 428                 *oldval = '\0';
 429         }
 430
 431         if (existed) {
 432                 bool equal = false;
 433                 if (op & LDAP_MOD_BVALUES) {
 434                         equal = (newblob && (data_blob_cmp(&oldblob, newblob) == 0));
 435                 } else {
 436                         /* all of our string attributes are case insensitive */
 437                         equal = (newval && (strcasecmp_m(oldval, newval) == 0));
 438                 }
 439
 440                 if (equal) {
 441                         /* Believe it or not, but LDAP will deny a delete and
 442                            an add at the same time if the values are the
 443                            same... */
 444                         DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
 445                         return;
 446                 }
 447
 448                 /* There has been no value before, so don't delete it.
 449                  * Here's a possible race: We might end up with
 450                  * duplicate attributes */
 451                 /* By deleting exactly the value we found in the entry this
 452                  * should be race-free in the sense that the LDAP-Server will
 453                  * deny the complete operation if somebody changed the
 454                  * attribute behind our back. */
 455                 /* This will also allow modifying single valued attributes
 456                  * in Novell NDS. In NDS you have to first remove attribute and then
 457                  * you could add new value */
 458
 459                 if (op & LDAP_MOD_BVALUES) {
 460                         DEBUG(10,("smbldap_make_mod: deleting attribute |%s| blob\n", attribute));
 461                         smbldap_set_mod_blob(mods, LDAP_MOD_DELETE, attribute, &oldblob);
 462                 } else {
 463                         DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
 464                         smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
 465                 }
 466         }
 467
 468         /* Regardless of the real operation (add or modify)
 469            we add the new value here. We rely on deleting
 470            the old value, should it exist. */
 471
 472         if (op & LDAP_MOD_BVALUES) {
 473                 if (newblob && newblob->length) {
 474                         DEBUG(10,("smbldap_make_mod: adding attribute |%s| blob\n", attribute));
 475                         smbldap_set_mod_blob(mods, LDAP_MOD_ADD, attribute, newblob);
 476                 }
 477         } else {
 478                 if ((newval != NULL) && (strlen(newval) > 0)) {
 479                         DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
 480                         smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
 481                 }
 482         }
 483 }
 484
 485  void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
 486                       LDAPMod ***mods,
 487                       const char *attribute, const char *newval)
 488 {
 489         smbldap_make_mod_internal(ldap_struct, existing, mods, attribute,
 490                                   0, newval, NULL);
 491 }
 492
 493  void smbldap_make_mod_blob(LDAP *ldap_struct, LDAPMessage *existing,
 494                             LDAPMod ***mods,
 495                             const char *attribute, const DATA_BLOB *newblob)
 496 {
 497         smbldap_make_mod_internal(ldap_struct, existing, mods, attribute,
 498                                   LDAP_MOD_BVALUES, NULL, newblob);
 499 }
 500
 501 /**********************************************************************
 502  Some varients of the LDAP rebind code do not pass in the third 'arg'
 503  pointer to a void*, so we try and work around it by assuming that the
 504  value of the 'LDAP *' pointer is the same as the one we had passed in
 505  **********************************************************************/
 506
 507 struct smbldap_state_lookup {
 508         LDAP *ld;
 509         struct smbldap_state *smbldap_state;
 510         struct smbldap_state_lookup *prev, *next;
 511 };
 512
 513 static struct smbldap_state_lookup *smbldap_state_lookup_list;
 514
 515 static struct smbldap_state *smbldap_find_state(LDAP *ld)
 516 {
 517         struct smbldap_state_lookup *t;
 518
 519         for (t = smbldap_state_lookup_list; t; t = t->next) {
 520                 if (t->ld == ld) {
 521                         return t->smbldap_state;
 522                 }
 523         }
 524         return NULL;
 525 }
 526
 527 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
 528 {
 529         struct smbldap_state_lookup *t;
 530
 531         for (t = smbldap_state_lookup_list; t; t = t->next) {
 532                 if (t->smbldap_state == smbldap_state) {
 533                         DLIST_REMOVE(smbldap_state_lookup_list, t);
 534                         SAFE_FREE(t);
 535                         return;
 536                 }
 537         }
 538 }
 539
 540 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
 541 {
 542         struct smbldap_state *tmp_ldap_state;
 543         struct smbldap_state_lookup *t;
 544
 545         if ((tmp_ldap_state = smbldap_find_state(ld))) {
 546                 SMB_ASSERT(tmp_ldap_state == smbldap_state);
 547                 return;
 548         }
 549
 550         t = SMB_XMALLOC_P(struct smbldap_state_lookup);
 551         ZERO_STRUCTP(t);
 552
 553         DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
 554         t->ld = ld;
 555         t->smbldap_state = smbldap_state;
 556 }
 557
 558 /********************************************************************
 559  start TLS on an existing LDAP connection
 560 *******************************************************************/
 561
 562 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
 563 {
 564 #ifdef LDAP_OPT_X_TLS
 565         int rc;
 566 #endif
 567
 568         if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
 569                 return LDAP_SUCCESS;
 570         }
 571
 572 #ifdef LDAP_OPT_X_TLS
 573         if (version != LDAP_VERSION3) {
 574                 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
 575                 return LDAP_OPERATIONS_ERROR;
 576         }
 577
 578         if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS)  {
 579                 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
 580                          ldap_err2string(rc)));
 581                 return rc;
 582         }
 583
 584         DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
 585         return LDAP_SUCCESS;
 586 #else
 587         DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
 588         return LDAP_OPERATIONS_ERROR;
 589 #endif
 590 }
 591
 592 /********************************************************************
 593  setup a connection to the LDAP server based on a uri
 594 *******************************************************************/
 595
 596 static int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
 597 {
 598         int rc;
 599
 600         DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
 601
 602 #ifdef HAVE_LDAP_INITIALIZE
 603
 604         rc = ldap_initialize(ldap_struct, uri);
 605         if (rc) {
 606                 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
 607                 return rc;
 608         }
 609
 610         if (lp_ldap_follow_referral() != Auto) {
 611                 rc = ldap_set_option(*ldap_struct, LDAP_OPT_REFERRALS,
 612                      lp_ldap_follow_referral() ? LDAP_OPT_ON : LDAP_OPT_OFF);
 613                 if (rc != LDAP_SUCCESS)
 614                         DEBUG(0, ("Failed to set LDAP_OPT_REFERRALS: %s\n",
 615                                 ldap_err2string(rc)));
 616         }
 617
 618         return LDAP_SUCCESS;
 619 #else
 620
 621         /* Parse the string manually */
 622
 623         {
 624                 int port = 0;
 625                 fstring protocol;
 626                 fstring host;
 627                 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
 628
 629
 630                 /* skip leading "URL:" (if any) */
 631                 if ( strnequal( uri, "URL:", 4 ) ) {
 632                         uri += 4;
 633                 }
 634
 635                 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
 636
 637                 if (port == 0) {
 638                         if (strequal(protocol, "ldap")) {
 639                                 port = LDAP_PORT;
 640                         } else if (strequal(protocol, "ldaps")) {
 641                                 port = LDAPS_PORT;
 642                         } else {
 643                                 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
 644                         }
 645                 }
 646
 647                 if ((*ldap_struct = ldap_init(host, port)) == NULL)     {
 648                         DEBUG(0, ("ldap_init failed !\n"));
 649                         return LDAP_OPERATIONS_ERROR;
 650                 }
 651
 652                 if (strequal(protocol, "ldaps")) {
 653 #ifdef LDAP_OPT_X_TLS
 654                         int tls = LDAP_OPT_X_TLS_HARD;
 655                         if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
 656                         {
 657                                 DEBUG(0, ("Failed to setup a TLS session\n"));
 658                         }
 659
 660                         DEBUG(3,("LDAPS option set...!\n"));
 661 #else
 662                         DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
 663                         return LDAP_OPERATIONS_ERROR;
 664 #endif /* LDAP_OPT_X_TLS */
 665                 }
 666         }
 667 #endif /* HAVE_LDAP_INITIALIZE */
 668
 669         /* now set connection timeout */
 670 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
 671         {
 672                 int ct = lp_ldap_connection_timeout()*1000;
 673                 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
 674                 if (rc != LDAP_SUCCESS) {
 675                         DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
 676                                 ct, ldap_err2string(rc)));
 677                 }
 678         }
 679 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
 680         {
 681                 struct timeval ct;
 682                 ct.tv_usec = 0;
 683                 ct.tv_sec = lp_ldap_connection_timeout();
 684                 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
 685                 if (rc != LDAP_SUCCESS) {
 686                         DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
 687                                 (int)ct.tv_sec, ldap_err2string(rc)));
 688                 }
 689         }
 690 #endif
 691
 692         return LDAP_SUCCESS;
 693 }
 694
 695 /********************************************************************
 696  try to upgrade to Version 3 LDAP if not already, in either case return current
 697  version
 698  *******************************************************************/
 699
 700 static int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
 701 {
 702         int version;
 703         int rc;
 704
 705         /* assume the worst */
 706         *new_version = LDAP_VERSION2;
 707
 708         rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
 709         if (rc) {
 710                 return rc;
 711         }
 712
 713         if (version == LDAP_VERSION3) {
 714                 *new_version = LDAP_VERSION3;
 715                 return LDAP_SUCCESS;
 716         }
 717
 718         /* try upgrade */
 719         version = LDAP_VERSION3;
 720         rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
 721         if (rc) {
 722                 return rc;
 723         }
 724
 725         *new_version = LDAP_VERSION3;
 726         return LDAP_SUCCESS;
 727 }
 728
 729 /*******************************************************************
 730  open a connection to the ldap server (just until the bind)
 731  ******************************************************************/
 732
 733 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
 734 {
 735         int rc, version;
 736
 737         rc = smb_ldap_setup_conn(ldap_struct, uri);
 738         if (rc) {
 739                 return rc;
 740         }
 741
 742         rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
 743         if (rc) {
 744                 return rc;
 745         }
 746
 747         rc = smb_ldap_start_tls(*ldap_struct, version);
 748         if (rc) {
 749                 return rc;
 750         }
 751
 752         return LDAP_SUCCESS;
 753 }
 754
 755 /*******************************************************************
 756  open a connection to the ldap server.
 757 ******************************************************************/
 758 static int smbldap_open_connection (struct smbldap_state *ldap_state)
 759
 760 {
 761         int rc = LDAP_SUCCESS;
 762         int version;
 763         int deref;
 764         LDAP **ldap_struct = &ldap_state->ldap_struct;
 765
 766         rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
 767         if (rc) {
 768                 return rc;
 769         }
 770
 771         /* Store the LDAP pointer in a lookup list */
 772
 773         smbldap_store_state(*ldap_struct, ldap_state);
 774
 775         /* Upgrade to LDAPv3 if possible */
 776
 777         rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
 778         if (rc) {
 779                 return rc;
 780         }
 781
 782         /* Start TLS if required */
 783
 784         rc = smb_ldap_start_tls(*ldap_struct, version);
 785         if (rc) {
 786                 return rc;
 787         }
 788
 789         /* Set alias dereferencing method */
 790         deref = lp_ldap_deref();
 791         if (deref != -1) {
 792                 if (ldap_set_option (*ldap_struct, LDAP_OPT_DEREF, &deref) != LDAP_OPT_SUCCESS) {
 793                         DEBUG(1,("smbldap_open_connection: Failed to set dereferencing method: %d\n", deref));
 794                 } else {
 795                         DEBUG(5,("Set dereferencing method: %d\n", deref));
 796                 }
 797         }
 798
 799         DEBUG(2, ("smbldap_open_connection: connection opened\n"));
 800         return rc;
 801 }
 802
 803 /*******************************************************************
 804  a rebind function for authenticated referrals
 805  This version takes a void* that we can shove useful stuff in :-)
 806 ******************************************************************/
 807 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
 808 #else
 809 static int rebindproc_with_state  (LDAP * ld, char **whop, char **credp,
 810                                    int *methodp, int freeit, void *arg)
 811 {
 812         struct smbldap_state *ldap_state = arg;
 813         struct timespec ts;
 814
 815         /** @TODO Should we be doing something to check what servers we rebind to?
 816             Could we get a referral to a machine that we don't want to give our
 817             username and password to? */
 818
 819         if (freeit) {
 820                 SAFE_FREE(*whop);
 821                 if (*credp) {
 822                         memset(*credp, '\0', strlen(*credp));
 823                 }
 824                 SAFE_FREE(*credp);
 825         } else {
 826                 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
 827                           ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
 828
 829                 if (ldap_state->anonymous) {
 830                         *whop = NULL;
 831                         *credp = NULL;
 832                 } else {
 833                         *whop = SMB_STRDUP(ldap_state->bind_dn);
 834                         if (!*whop) {
 835                                 return LDAP_NO_MEMORY;
 836                         }
 837                         *credp = SMB_STRDUP(ldap_state->bind_secret);
 838                         if (!*credp) {
 839                                 SAFE_FREE(*whop);
 840                                 return LDAP_NO_MEMORY;
 841                         }
 842                 }
 843                 *methodp = LDAP_AUTH_SIMPLE;
 844         }
 845
 846         clock_gettime_mono(&ts);
 847         ldap_state->last_rebind = convert_timespec_to_timeval(ts);
 848
 849         return 0;
 850 }
 851 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
 852
 853 /*******************************************************************
 854  a rebind function for authenticated referrals
 855  This version takes a void* that we can shove useful stuff in :-)
 856  and actually does the connection.
 857 ******************************************************************/
 858 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
 859 static int rebindproc_connect_with_state (LDAP *ldap_struct,
 860                                           LDAP_CONST char *url,
 861                                           ber_tag_t request,
 862                                           ber_int_t msgid, void *arg)
 863 {
 864         struct smbldap_state *ldap_state =
 865                 (struct smbldap_state *)arg;
 866         int rc;
 867         struct timespec ts;
 868         int version;
 869
 870         DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
 871                  url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
 872
 873         /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
 874          * itself) before rebinding to another LDAP server to avoid to expose
 875          * our credentials. At least *try* to secure the connection - Guenther */
 876
 877         smb_ldap_upgrade_conn(ldap_struct, &version);
 878         smb_ldap_start_tls(ldap_struct, version);
 879
 880         /** @TODO Should we be doing something to check what servers we rebind to?
 881             Could we get a referral to a machine that we don't want to give our
 882             username and password to? */
 883
 884         rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
 885
 886         /* only set the last rebind timestamp when we did rebind after a
 887          * non-read LDAP operation. That way we avoid the replication sleep
 888          * after a simple redirected search operation - Guenther */
 889
 890         switch (request) {
 891
 892                 case LDAP_REQ_MODIFY:
 893                 case LDAP_REQ_ADD:
 894                 case LDAP_REQ_DELETE:
 895                 case LDAP_REQ_MODDN:
 896                 case LDAP_REQ_EXTENDED:
 897                         DEBUG(10,("rebindproc_connect_with_state: "
 898                                 "setting last_rebind timestamp "
 899                                 "(req: 0x%02x)\n", (unsigned int)request));
 900                         clock_gettime_mono(&ts);
 901                         ldap_state->last_rebind = convert_timespec_to_timeval(ts);
 902                         break;
 903                 default:
 904                         ZERO_STRUCT(ldap_state->last_rebind);
 905                         break;
 906         }
 907
 908         return rc;
 909 }
 910 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
 911
 912 /*******************************************************************
 913  Add a rebind function for authenticated referrals
 914 ******************************************************************/
 915 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
 916 #else
 917 # if LDAP_SET_REBIND_PROC_ARGS == 2
 918 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
 919                        int *method, int freeit )
 920 {
 921         struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
 922
 923         return rebindproc_with_state(ldap_struct, whop, credp,
 924                                      method, freeit, ldap_state);
 925 }
 926 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
 927 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
 928
 929 /*******************************************************************
 930  a rebind function for authenticated referrals
 931  this also does the connection, but no void*.
 932 ******************************************************************/
 933 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
 934 # if LDAP_SET_REBIND_PROC_ARGS == 2
 935 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
 936                                ber_int_t msgid)
 937 {
 938         struct smbldap_state *ldap_state = smbldap_find_state(ld);
 939
 940         return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
 941                                              ldap_state);
 942 }
 943 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
 944 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
 945
 946 /*******************************************************************
 947  connect to the ldap server under system privilege.
 948 ******************************************************************/
 949 static int smbldap_connect_system(struct smbldap_state *ldap_state)
 950 {
 951         LDAP *ldap_struct = ldap_state->ldap_struct;
 952         int rc;
 953         int version;
 954
 955         /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
 956            (OpenLDAP) doesnt' seem to support it */
 957
 958         DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
 959                   ldap_state->uri, ldap_state->bind_dn));
 960
 961 #ifdef HAVE_LDAP_SET_REBIND_PROC
 962 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
 963 # if LDAP_SET_REBIND_PROC_ARGS == 2
 964         ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
 965 # endif
 966 # if LDAP_SET_REBIND_PROC_ARGS == 3
 967         ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
 968 # endif
 969 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
 970 # if LDAP_SET_REBIND_PROC_ARGS == 2
 971         ldap_set_rebind_proc(ldap_struct, &rebindproc);
 972 # endif
 973 # if LDAP_SET_REBIND_PROC_ARGS == 3
 974         ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
 975 # endif
 976 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
 977 #endif
 978
 979         rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
 980
 981         if (rc != LDAP_SUCCESS) {
 982                 char *ld_error = NULL;
 983                 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
 984                                 &ld_error);
 985                 DEBUG(ldap_state->num_failures ? 2 : 0,
 986                       ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
 987                                ldap_state->uri,
 988                                ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
 989                                ldap_err2string(rc),
 990                                ld_error ? ld_error : "(unknown)"));
 991                 SAFE_FREE(ld_error);
 992                 ldap_state->num_failures++;
 993                 goto done;
 994         }
 995
 996         ldap_state->num_failures = 0;
 997         ldap_state->paged_results = False;
 998
 999         ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1000
1001         if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1002                 ldap_state->paged_results = True;
1003         }
1004
1005         DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1006         DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1007                 ldap_state->paged_results ? "does" : "does not"));
1008 done:
1009         if (rc != 0) {
1010                 ldap_unbind(ldap_struct);
1011                 ldap_state->ldap_struct = NULL;
1012         }
1013         return rc;
1014 }
1015
1016 static void smbldap_idle_fn(struct tevent_context *tevent_ctx,
1017                             struct timed_event *te,
1018                             struct timeval now_abs,
1019                             void *private_data);
1020
1021 /**********************************************************************
1022  Connect to LDAP server (called before every ldap operation)
1023 *********************************************************************/
1024 static int smbldap_open(struct smbldap_state *ldap_state)
1025 {
1026         int rc, opt_rc;
1027         bool reopen = False;
1028         SMB_ASSERT(ldap_state);
1029
1030         if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time_mono(NULL))) {
1031
1032 #ifdef HAVE_UNIXSOCKET
1033                 struct sockaddr_un addr;
1034 #else
1035                 struct sockaddr addr;
1036 #endif
1037                 socklen_t len = sizeof(addr);
1038                 int sd;
1039
1040                 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1041                 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1042                         reopen = True;
1043
1044 #ifdef HAVE_UNIXSOCKET
1045                 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1046                         reopen = True;
1047 #endif
1048                 if (reopen) {
1049                         /* the other end has died. reopen. */
1050                         ldap_unbind(ldap_state->ldap_struct);
1051                         ldap_state->ldap_struct = NULL;
1052                         ldap_state->last_ping = (time_t)0;
1053                 } else {
1054                         ldap_state->last_ping = time_mono(NULL);
1055                 }
1056         }
1057
1058         if (ldap_state->ldap_struct != NULL) {
1059                 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1060                 return LDAP_SUCCESS;
1061         }
1062
1063         if ((rc = smbldap_open_connection(ldap_state))) {
1064                 return rc;
1065         }
1066
1067         if ((rc = smbldap_connect_system(ldap_state))) {
1068                 return rc;
1069         }
1070
1071
1072         ldap_state->last_ping = time_mono(NULL);
1073         ldap_state->pid = getpid();
1074
1075         TALLOC_FREE(ldap_state->idle_event);
1076
1077         if (ldap_state->tevent_context != NULL) {
1078                 ldap_state->idle_event = tevent_add_timer(
1079                         ldap_state->tevent_context, ldap_state,
1080                         timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1081                         smbldap_idle_fn, ldap_state);
1082         }
1083
1084         DEBUG(4,("The LDAP server is successfully connected\n"));
1085
1086         return LDAP_SUCCESS;
1087 }
1088
1089 /**********************************************************************
1090 Disconnect from LDAP server
1091 *********************************************************************/
1092 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1093 {
1094         if (!ldap_state)
1095                 return NT_STATUS_INVALID_PARAMETER;
1096
1097         if (ldap_state->ldap_struct != NULL) {
1098                 ldap_unbind(ldap_state->ldap_struct);
1099                 ldap_state->ldap_struct = NULL;
1100         }
1101
1102         smbldap_delete_state(ldap_state);
1103
1104         TALLOC_FREE(ldap_state->idle_event);
1105
1106         DEBUG(5,("The connection to the LDAP server was closed\n"));
1107         /* maybe free the results here --metze */
1108
1109         return NT_STATUS_OK;
1110 }
1111
1112 static SIG_ATOMIC_T got_alarm;
1113
1114 static void gotalarm_sig(int dummy)
1115 {
1116         got_alarm = 1;
1117 }
1118
1119 static time_t calc_ldap_abs_endtime(int ldap_to)
1120 {
1121         if (ldap_to == 0) {
1122                 /* No timeout - don't
1123                    return a value for
1124                    the alarm. */
1125                 return (time_t)0;
1126         }
1127
1128         /* Make the alarm time one second beyond
1129            the timout we're setting for the
1130            remote search timeout, to allow that
1131            to fire in preference. */
1132
1133         return time_mono(NULL)+ldap_to+1;
1134 }
1135
1136 static int end_ldap_local_alarm(time_t absolute_endtime, int rc)
1137 {
1138         if (absolute_endtime) {
1139                 alarm(0);
1140                 CatchSignal(SIGALRM, SIG_IGN);
1141                 if (got_alarm) {
1142                         /* Client timeout error code. */
1143                         got_alarm = 0;
1144                         return LDAP_TIMEOUT;
1145                 }
1146         }
1147         return rc;
1148 }
1149
1150 static void setup_ldap_local_alarm(struct smbldap_state *ldap_state, time_t absolute_endtime)
1151 {
1152         time_t now = time_mono(NULL);
1153
1154         if (absolute_endtime) {
1155                 got_alarm = 0;
1156                 CatchSignal(SIGALRM, gotalarm_sig);
1157                 alarm(absolute_endtime - now);
1158         }
1159
1160         if (ldap_state->pid != getpid()) {
1161                 smbldap_close(ldap_state);
1162         }
1163 }
1164
1165 static void get_ldap_errs(struct smbldap_state *ldap_state, char **pp_ld_error, int *p_ld_errno)
1166 {
1167         ldap_get_option(ldap_state->ldap_struct,
1168                         LDAP_OPT_ERROR_NUMBER, p_ld_errno);
1169
1170         ldap_get_option(ldap_state->ldap_struct,
1171                         LDAP_OPT_ERROR_STRING, pp_ld_error);
1172 }
1173
1174 static int get_cached_ldap_connect(struct smbldap_state *ldap_state, time_t abs_endtime)
1175 {
1176         int attempts = 0;
1177
1178         while (1) {
1179                 int rc;
1180                 time_t now;
1181
1182                 now = time_mono(NULL);
1183                 ldap_state->last_use = now;
1184
1185                 if (abs_endtime && now > abs_endtime) {
1186                         smbldap_close(ldap_state);
1187                         return LDAP_TIMEOUT;
1188                 }
1189
1190                 rc = smbldap_open(ldap_state);
1191
1192                 if (rc == LDAP_SUCCESS) {
1193                         return LDAP_SUCCESS;
1194                 }
1195
1196                 attempts++;
1197                 DEBUG(1, ("Connection to LDAP server failed for the "
1198                         "%d try!\n", attempts));
1199
1200                 if (rc == LDAP_INSUFFICIENT_ACCESS) {
1201                         /* The fact that we are non-root or any other
1202                          * access-denied condition will not change in the next
1203                          * round of trying */
1204                         return rc;
1205                 }
1206
1207                 if (got_alarm) {
1208                         smbldap_close(ldap_state);
1209                         return LDAP_TIMEOUT;
1210                 }
1211
1212                 smb_msleep(1000);
1213
1214                 if (got_alarm) {
1215                         smbldap_close(ldap_state);
1216                         return LDAP_TIMEOUT;
1217                 }
1218         }
1219 }
1220
1221 /*********************************************************************
1222  ********************************************************************/
1223
1224 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1225                               const char *base, int scope, const char *filter,
1226                               const char *attrs[], int attrsonly,
1227                               LDAPControl **sctrls, LDAPControl **cctrls,
1228                               int sizelimit, LDAPMessage **res)
1229 {
1230         int             rc = LDAP_SERVER_DOWN;
1231         char           *utf8_filter;
1232         int             to = lp_ldap_timeout();
1233         time_t          abs_endtime = calc_ldap_abs_endtime(to);
1234         struct          timeval timeout;
1235         struct          timeval *timeout_ptr = NULL;
1236         size_t          converted_size;
1237
1238         SMB_ASSERT(ldap_state);
1239
1240         DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1241                  "scope => [%d]\n", base, filter, scope));
1242
1243         if (ldap_state->last_rebind.tv_sec > 0) {
1244                 struct timeval  tval;
1245                 struct timespec ts;
1246                 int64_t tdiff = 0;
1247                 int             sleep_time = 0;
1248
1249                 clock_gettime_mono(&ts);
1250                 tval = convert_timespec_to_timeval(ts);
1251
1252                 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1253                 tdiff /= 1000; /* Convert to milliseconds. */
1254
1255                 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1256                 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1257
1258                 if (sleep_time > 0) {
1259                         /* we wait for the LDAP replication */
1260                         DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1261                                  "for LDAP replication.\n",sleep_time));
1262                         smb_msleep(sleep_time);
1263                         DEBUG(5,("smbldap_search_ext: go on!\n"));
1264                 }
1265                 ZERO_STRUCT(ldap_state->last_rebind);
1266         }
1267
1268         if (!push_utf8_talloc(talloc_tos(), &utf8_filter, filter, &converted_size)) {
1269                 return LDAP_NO_MEMORY;
1270         }
1271
1272         /* Setup remote timeout for the ldap_search_ext_s call. */
1273         if (to) {
1274                 timeout.tv_sec = to;
1275                 timeout.tv_usec = 0;
1276                 timeout_ptr = &timeout;
1277         }
1278
1279         setup_ldap_local_alarm(ldap_state, abs_endtime);
1280
1281         while (1) {
1282                 char *ld_error = NULL;
1283                 int ld_errno;
1284
1285                 rc = get_cached_ldap_connect(ldap_state, abs_endtime);
1286                 if (rc != LDAP_SUCCESS) {
1287                         break;
1288                 }
1289
1290                 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1291                                        utf8_filter,
1292                                        discard_const_p(char *, attrs),
1293                                        attrsonly, sctrls, cctrls, timeout_ptr,
1294                                        sizelimit, res);
1295                 if (rc == LDAP_SUCCESS) {
1296                         break;
1297                 }
1298
1299                 get_ldap_errs(ldap_state, &ld_error, &ld_errno);
1300
1301                 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1302                            "(%s)\n", base, ld_errno,
1303                            ldap_err2string(rc),
1304                            ld_error ? ld_error : "unknown"));
1305                 SAFE_FREE(ld_error);
1306
1307                 if (ld_errno != LDAP_SERVER_DOWN) {
1308                         break;
1309                 }
1310                 ldap_unbind(ldap_state->ldap_struct);
1311                 ldap_state->ldap_struct = NULL;
1312         }
1313
1314         TALLOC_FREE(utf8_filter);
1315         return end_ldap_local_alarm(abs_endtime, rc);
1316 }
1317
1318 int smbldap_search(struct smbldap_state *ldap_state,
1319                    const char *base, int scope, const char *filter,
1320                    const char *attrs[], int attrsonly,
1321                    LDAPMessage **res)
1322 {
1323         return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1324                                   attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1325 }
1326
1327 int smbldap_search_paged(struct smbldap_state *ldap_state,
1328                          const char *base, int scope, const char *filter,
1329                          const char **attrs, int attrsonly, int pagesize,
1330                          LDAPMessage **res, void **cookie)
1331 {
1332         LDAPControl     pr;
1333         LDAPControl     **rcontrols;
1334         LDAPControl     *controls[2] = { NULL, NULL};
1335         BerElement      *cookie_be = NULL;
1336         struct berval   *cookie_bv = NULL;
1337         int             tmp = 0, i, rc;
1338         bool            critical = True;
1339
1340         *res = NULL;
1341
1342         DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1343                  "scope => [%d], pagesize => [%d]\n",
1344                  base, filter, scope, pagesize));
1345
1346         cookie_be = ber_alloc_t(LBER_USE_DER);
1347         if (cookie_be == NULL) {
1348                 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1349                          "NULL\n"));
1350                 return LDAP_NO_MEMORY;
1351         }
1352
1353         /* construct cookie */
1354         if (*cookie != NULL) {
1355                 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1356                 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1357                 *cookie = NULL;
1358         } else {
1359                 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1360         }
1361         ber_flatten(cookie_be, &cookie_bv);
1362
1363         pr.ldctl_oid = discard_const_p(char, ADS_PAGE_CTL_OID);
1364         pr.ldctl_iscritical = (char) critical;
1365         pr.ldctl_value.bv_len = cookie_bv->bv_len;
1366         pr.ldctl_value.bv_val = cookie_bv->bv_val;
1367
1368         controls[0] = &pr;
1369         controls[1] = NULL;
1370
1371         rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1372                                  0, controls, NULL, LDAP_NO_LIMIT, res);
1373
1374         ber_free(cookie_be, 1);
1375         ber_bvfree(cookie_bv);
1376
1377         if (rc != 0) {
1378                 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1379                          "failed with [%s]\n", filter, ldap_err2string(rc)));
1380                 goto done;
1381         }
1382
1383         DEBUG(3,("smbldap_search_paged: search was successful\n"));
1384
1385         rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1386                                NULL, NULL, &rcontrols,  0);
1387         if (rc != 0) {
1388                 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1389                          "with [%s]\n", ldap_err2string(rc)));
1390                 goto done;
1391         }
1392
1393         if (rcontrols == NULL)
1394                 goto done;
1395
1396         for (i=0; rcontrols[i]; i++) {
1397
1398                 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1399                         continue;
1400
1401                 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1402                 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1403                 /* the berval is the cookie, but must be freed when it is all
1404                    done */
1405                 if (cookie_bv->bv_len)
1406                         *cookie=ber_bvdup(cookie_bv);
1407                 else
1408                         *cookie=NULL;
1409                 ber_bvfree(cookie_bv);
1410                 ber_free(cookie_be, 1);
1411                 break;
1412         }
1413         ldap_controls_free(rcontrols);
1414 done:
1415         return rc;
1416 }
1417
1418 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1419 {
1420         int             rc = LDAP_SERVER_DOWN;
1421         char           *utf8_dn;
1422         time_t          abs_endtime = calc_ldap_abs_endtime(lp_ldap_timeout());
1423         size_t          converted_size;
1424
1425         SMB_ASSERT(ldap_state);
1426
1427         DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1428
1429         if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1430                 return LDAP_NO_MEMORY;
1431         }
1432
1433         setup_ldap_local_alarm(ldap_state, abs_endtime);
1434
1435         while (1) {
1436                 char *ld_error = NULL;
1437                 int ld_errno;
1438
1439                 rc = get_cached_ldap_connect(ldap_state, abs_endtime);
1440                 if (rc != LDAP_SUCCESS) {
1441                         break;
1442                 }
1443
1444                 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1445                 if (rc == LDAP_SUCCESS) {
1446                         break;
1447                 }
1448
1449                 get_ldap_errs(ldap_state, &ld_error, &ld_errno);
1450
1451                 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1452                            "(%s)\n", dn, ld_errno,
1453                            ldap_err2string(rc),
1454                            ld_error ? ld_error : "unknown"));
1455                 SAFE_FREE(ld_error);
1456
1457                 if (ld_errno != LDAP_SERVER_DOWN) {
1458                         break;
1459                 }
1460                 ldap_unbind(ldap_state->ldap_struct);
1461                 ldap_state->ldap_struct = NULL;
1462         }
1463
1464         TALLOC_FREE(utf8_dn);
1465         return end_ldap_local_alarm(abs_endtime, rc);
1466 }
1467
1468 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1469 {
1470         int             rc = LDAP_SERVER_DOWN;
1471         char           *utf8_dn;
1472         time_t          abs_endtime = calc_ldap_abs_endtime(lp_ldap_timeout());
1473         size_t          converted_size;
1474
1475         SMB_ASSERT(ldap_state);
1476
1477         DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1478
1479         if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1480                 return LDAP_NO_MEMORY;
1481         }
1482
1483         setup_ldap_local_alarm(ldap_state, abs_endtime);
1484
1485         while (1) {
1486                 char *ld_error = NULL;
1487                 int ld_errno;
1488
1489                 rc = get_cached_ldap_connect(ldap_state, abs_endtime);
1490                 if (rc != LDAP_SUCCESS) {
1491                         break;
1492                 }
1493
1494                 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1495                 if (rc == LDAP_SUCCESS) {
1496                         break;
1497                 }
1498
1499                 get_ldap_errs(ldap_state, &ld_error, &ld_errno);
1500
1501                 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1502                            "(%s)\n", dn, ld_errno,
1503                            ldap_err2string(rc),
1504                            ld_error ? ld_error : "unknown"));
1505                 SAFE_FREE(ld_error);
1506
1507                 if (ld_errno != LDAP_SERVER_DOWN) {
1508                         break;
1509                 }
1510                 ldap_unbind(ldap_state->ldap_struct);
1511                 ldap_state->ldap_struct = NULL;
1512         }
1513
1514         TALLOC_FREE(utf8_dn);
1515         return end_ldap_local_alarm(abs_endtime, rc);
1516 }
1517
1518 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1519 {
1520         int             rc = LDAP_SERVER_DOWN;
1521         char           *utf8_dn;
1522         time_t          abs_endtime = calc_ldap_abs_endtime(lp_ldap_timeout());
1523         size_t          converted_size;
1524
1525         SMB_ASSERT(ldap_state);
1526
1527         DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1528
1529         if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1530                 return LDAP_NO_MEMORY;
1531         }
1532
1533         setup_ldap_local_alarm(ldap_state, abs_endtime);
1534
1535         while (1) {
1536                 char *ld_error = NULL;
1537                 int ld_errno;
1538
1539                 rc = get_cached_ldap_connect(ldap_state, abs_endtime);
1540                 if (rc != LDAP_SUCCESS) {
1541                         break;
1542                 }
1543
1544                 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1545                 if (rc == LDAP_SUCCESS) {
1546                         break;
1547                 }
1548
1549                 get_ldap_errs(ldap_state, &ld_error, &ld_errno);
1550
1551                 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1552                            "(%s)\n", dn, ld_errno,
1553                            ldap_err2string(rc),
1554                            ld_error ? ld_error : "unknown"));
1555                 SAFE_FREE(ld_error);
1556
1557                 if (ld_errno != LDAP_SERVER_DOWN) {
1558                         break;
1559                 }
1560                 ldap_unbind(ldap_state->ldap_struct);
1561                 ldap_state->ldap_struct = NULL;
1562         }
1563
1564         TALLOC_FREE(utf8_dn);
1565         return end_ldap_local_alarm(abs_endtime, rc);
1566 }
1567
1568 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1569                                LDAP_CONST char *reqoid, struct berval *reqdata,
1570                                LDAPControl **serverctrls, LDAPControl **clientctrls,
1571                                char **retoidp, struct berval **retdatap)
1572 {
1573         int             rc = LDAP_SERVER_DOWN;
1574         time_t          abs_endtime = calc_ldap_abs_endtime(lp_ldap_timeout());
1575
1576         if (!ldap_state)
1577                 return (-1);
1578
1579         setup_ldap_local_alarm(ldap_state, abs_endtime);
1580
1581         while (1) {
1582                 char *ld_error = NULL;
1583                 int ld_errno;
1584
1585                 rc = get_cached_ldap_connect(ldap_state, abs_endtime);
1586                 if (rc != LDAP_SUCCESS) {
1587                         break;
1588                 }
1589
1590                 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1591                                                reqdata, serverctrls,
1592                                                clientctrls, retoidp, retdatap);
1593                 if (rc == LDAP_SUCCESS) {
1594                         break;
1595                 }
1596
1597                 get_ldap_errs(ldap_state, &ld_error, &ld_errno);
1598
1599                 DEBUG(10, ("Extended operation failed with error: "
1600                            "%d (%s) (%s)\n", ld_errno,
1601                            ldap_err2string(rc),
1602                            ld_error ? ld_error : "unknown"));
1603                 SAFE_FREE(ld_error);
1604
1605                 if (ld_errno != LDAP_SERVER_DOWN) {
1606                         break;
1607                 }
1608                 ldap_unbind(ldap_state->ldap_struct);
1609                 ldap_state->ldap_struct = NULL;
1610         }
1611
1612         return end_ldap_local_alarm(abs_endtime, rc);
1613 }
1614
1615 /*******************************************************************
1616  run the search by name.
1617 ******************************************************************/
1618 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1619                            const char *filter, const char **search_attr,
1620                            LDAPMessage ** result)
1621 {
1622         return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1623                               filter, search_attr, 0, result);
1624 }
1625
1626 static void smbldap_idle_fn(struct tevent_context *tevent_ctx,
1627                             struct timed_event *te,
1628                             struct timeval now_abs,
1629                             void *private_data)
1630 {
1631         struct smbldap_state *state = (struct smbldap_state *)private_data;
1632
1633         TALLOC_FREE(state->idle_event);
1634
1635         if (state->ldap_struct == NULL) {
1636                 DEBUG(10,("ldap connection not connected...\n"));
1637                 return;
1638         }
1639
1640         if ((state->last_use+SMBLDAP_IDLE_TIME) > time_mono(NULL)) {
1641                 DEBUG(10,("ldap connection not idle...\n"));
1642
1643                 /* this needs to be made monotonic clock aware inside tevent: */
1644                 state->idle_event = tevent_add_timer(
1645                         tevent_ctx, state,
1646                         timeval_add(&now_abs, SMBLDAP_IDLE_TIME, 0),
1647                         smbldap_idle_fn,
1648                         private_data);
1649                 return;
1650         }
1651
1652         DEBUG(7,("ldap connection idle...closing connection\n"));
1653         smbldap_close(state);
1654 }
1655
1656 /**********************************************************************
1657  Housekeeping
1658  *********************************************************************/
1659
1660 void smbldap_free_struct(struct smbldap_state **ldap_state)
1661 {
1662         smbldap_close(*ldap_state);
1663
1664         if ((*ldap_state)->bind_secret) {
1665                 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1666         }
1667
1668         SAFE_FREE((*ldap_state)->bind_dn);
1669         SAFE_FREE((*ldap_state)->bind_secret);
1670
1671         TALLOC_FREE(*ldap_state);
1672
1673         /* No need to free any further, as it is talloc()ed */
1674 }
1675
1676 static int smbldap_state_destructor(struct smbldap_state *state)
1677 {
1678         smbldap_free_struct(&state);
1679         return 0;
1680 }
1681
1682
1683 /**********************************************************************
1684  Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1685  *********************************************************************/
1686
1687 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct tevent_context *tevent_ctx,
1688                       const char *location,
1689                       bool anon,
1690                       const char *bind_dn,
1691                       const char *bind_secret,
1692                       struct smbldap_state **smbldap_state)
1693 {
1694         *smbldap_state = talloc_zero(mem_ctx, struct smbldap_state);
1695         if (!*smbldap_state) {
1696                 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1697                 return NT_STATUS_NO_MEMORY;
1698         }
1699
1700         if (location) {
1701                 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1702         } else {
1703                 (*smbldap_state)->uri = "ldap://localhost";
1704         }
1705
1706         (*smbldap_state)->tevent_context = tevent_ctx;
1707
1708         if (bind_dn && bind_secret) {
1709                 smbldap_set_creds(*smbldap_state, anon, bind_dn, bind_secret);
1710         }
1711
1712         talloc_set_destructor(*smbldap_state, smbldap_state_destructor);
1713         return NT_STATUS_OK;
1714 }
1715
1716  char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1717                          LDAPMessage *entry)
1718 {
1719         char *utf8_dn, *unix_dn;
1720         size_t converted_size;
1721
1722         utf8_dn = ldap_get_dn(ld, entry);
1723         if (!utf8_dn) {
1724                 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1725                 return NULL;
1726         }
1727         if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1728                 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1729                            "[%s]\n", utf8_dn));
1730                 return NULL;
1731         }
1732         ldap_memfree(utf8_dn);
1733         return unix_dn;
1734 }
1735
1736 /*******************************************************************
1737  Check if root-dse has a certain Control or Extension
1738 ********************************************************************/
1739
1740 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1741 {
1742         LDAPMessage *msg = NULL;
1743         LDAPMessage *entry = NULL;
1744         char **values = NULL;
1745         int rc, num_result, num_values, i;
1746         bool result = False;
1747
1748         if (!attrs[0]) {
1749                 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1750                 return False;
1751         }
1752
1753         if (!strequal(attrs[0], "supportedExtension") &&
1754             !strequal(attrs[0], "supportedControl") &&
1755             !strequal(attrs[0], "namingContexts")) {
1756                 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1757                 return False;
1758         }
1759
1760         rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1761                            "(objectclass=*)", discard_const_p(char *, attrs), 0 , &msg);
1762
1763         if (rc != LDAP_SUCCESS) {
1764                 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1765                 return False;
1766         }
1767
1768         num_result = ldap_count_entries(ld, msg);
1769
1770         if (num_result != 1) {
1771                 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1772                 goto done;
1773         }
1774
1775         entry = ldap_first_entry(ld, msg);
1776
1777         if (entry == NULL) {
1778                 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1779                 goto done;
1780         }
1781
1782         values = ldap_get_values(ld, entry, attrs[0]);
1783
1784         if (values == NULL) {
1785                 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1786                 goto done;
1787         }
1788
1789         num_values = ldap_count_values(values);
1790
1791         if (num_values == 0) {
1792                 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1793                 goto done;
1794         }
1795
1796         for (i=0; i<num_values; i++) {
1797                 if (strcmp(values[i], value) == 0)
1798                         result = True;
1799         }
1800
1801
1802  done:
1803         if (values != NULL)
1804                 ldap_value_free(values);
1805         if (msg != NULL)
1806                 ldap_msgfree(msg);
1807
1808         return result;
1809
1810 }
1811
1812 /*******************************************************************
1813  Check if LDAP-Server supports a certain Control (OID in string format)
1814 ********************************************************************/
1815
1816 bool smbldap_has_control(LDAP *ld, const char *control)
1817 {
1818         const char *attrs[] = { "supportedControl", NULL };
1819         return smbldap_check_root_dse(ld, attrs, control);
1820 }
1821
1822 /*******************************************************************
1823  Check if LDAP-Server supports a certain Extension (OID in string format)
1824 ********************************************************************/
1825
1826 bool smbldap_has_extension(LDAP *ld, const char *extension)
1827 {
1828         const char *attrs[] = { "supportedExtension", NULL };
1829         return smbldap_check_root_dse(ld, attrs, extension);
1830 }
1831
1832 /*******************************************************************
1833  Check if LDAP-Server holds a given namingContext
1834 ********************************************************************/
1835
1836 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1837 {
1838         const char *attrs[] = { "namingContexts", NULL };
1839         return smbldap_check_root_dse(ld, attrs, naming_context);
1840 }
1841
1842 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1843 {
1844         ldap_state->anonymous = anon;
1845
1846         /* free any previously set credential */
1847
1848         SAFE_FREE(ldap_state->bind_dn);
1849         if (ldap_state->bind_secret) {
1850                 /* make sure secrets are zeroed out of memory */
1851                 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1852                 SAFE_FREE(ldap_state->bind_secret);
1853         }
1854
1855         if ( ! anon) {
1856                 ldap_state->bind_dn = SMB_STRDUP(dn);
1857                 ldap_state->bind_secret = SMB_STRDUP(secret);
1858         }
1859
1860         return True;
1861 }