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