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
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.
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.
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/>.
28 #include "../libcli/security/security.h"
30 /* Try not to hit the up or down server forever */
32 #define SMBLDAP_DONT_PING_TIME 10 /* ping only all 10 seconds */
33 #define SMBLDAP_NUM_RETRIES 8 /* retry only 8 times */
35 #define SMBLDAP_IDLE_TIME 150 /* After 2.5 minutes disconnect */
38 /* attributes used by Samba 2.2 */
40 ATTRIB_MAP_ENTRY attrib_map_v22[] = {
41 { LDAP_ATTR_UID, "uid" },
42 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
43 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
44 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
45 { LDAP_ATTR_PWD_LAST_SET, "pwdLastSet" },
46 { LDAP_ATTR_PWD_CAN_CHANGE, "pwdCanChange" },
47 { LDAP_ATTR_PWD_MUST_CHANGE, "pwdMustChange" },
48 { LDAP_ATTR_LOGON_TIME, "logonTime" },
49 { LDAP_ATTR_LOGOFF_TIME, "logoffTime" },
50 { LDAP_ATTR_KICKOFF_TIME, "kickoffTime" },
51 { LDAP_ATTR_CN, "cn" },
52 { LDAP_ATTR_SN, "sn" },
53 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
54 { LDAP_ATTR_HOME_PATH, "smbHome" },
55 { LDAP_ATTR_HOME_DRIVE, "homeDrive" },
56 { LDAP_ATTR_LOGON_SCRIPT, "scriptPath" },
57 { LDAP_ATTR_PROFILE_PATH, "profilePath" },
58 { LDAP_ATTR_DESC, "description" },
59 { LDAP_ATTR_USER_WKS, "userWorkstations"},
60 { LDAP_ATTR_USER_RID, "rid" },
61 { LDAP_ATTR_PRIMARY_GROUP_RID, "primaryGroupID"},
62 { LDAP_ATTR_LMPW, "lmPassword" },
63 { LDAP_ATTR_NTPW, "ntPassword" },
64 { LDAP_ATTR_DOMAIN, "domain" },
65 { LDAP_ATTR_OBJCLASS, "objectClass" },
66 { LDAP_ATTR_ACB_INFO, "acctFlags" },
67 { LDAP_ATTR_MOD_TIMESTAMP, "modifyTimestamp" },
68 { LDAP_ATTR_LIST_END, NULL }
71 ATTRIB_MAP_ENTRY attrib_map_to_delete_v22[] = {
72 { LDAP_ATTR_PWD_LAST_SET, "pwdLastSet" },
73 { LDAP_ATTR_PWD_CAN_CHANGE, "pwdCanChange" },
74 { LDAP_ATTR_PWD_MUST_CHANGE, "pwdMustChange" },
75 { LDAP_ATTR_LOGON_TIME, "logonTime" },
76 { LDAP_ATTR_LOGOFF_TIME, "logoffTime" },
77 { LDAP_ATTR_KICKOFF_TIME, "kickoffTime" },
78 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
79 { LDAP_ATTR_HOME_PATH, "smbHome" },
80 { LDAP_ATTR_HOME_DRIVE, "homeDrives" },
81 { LDAP_ATTR_LOGON_SCRIPT, "scriptPath" },
82 { LDAP_ATTR_PROFILE_PATH, "profilePath" },
83 { LDAP_ATTR_USER_WKS, "userWorkstations"},
84 { LDAP_ATTR_USER_RID, "rid" },
85 { LDAP_ATTR_PRIMARY_GROUP_RID, "primaryGroupID"},
86 { LDAP_ATTR_LMPW, "lmPassword" },
87 { LDAP_ATTR_NTPW, "ntPassword" },
88 { LDAP_ATTR_DOMAIN, "domain" },
89 { LDAP_ATTR_ACB_INFO, "acctFlags" },
90 { LDAP_ATTR_LIST_END, NULL }
93 /* attributes used by Samba 3.0's sambaSamAccount */
95 ATTRIB_MAP_ENTRY attrib_map_v30[] = {
96 { LDAP_ATTR_UID, "uid" },
97 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
98 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
99 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
100 { LDAP_ATTR_PWD_LAST_SET, "sambaPwdLastSet" },
101 { LDAP_ATTR_PWD_CAN_CHANGE, "sambaPwdCanChange" },
102 { LDAP_ATTR_PWD_MUST_CHANGE, "sambaPwdMustChange" },
103 { LDAP_ATTR_LOGON_TIME, "sambaLogonTime" },
104 { LDAP_ATTR_LOGOFF_TIME, "sambaLogoffTime" },
105 { LDAP_ATTR_KICKOFF_TIME, "sambaKickoffTime" },
106 { LDAP_ATTR_CN, "cn" },
107 { LDAP_ATTR_SN, "sn" },
108 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
109 { LDAP_ATTR_HOME_DRIVE, "sambaHomeDrive" },
110 { LDAP_ATTR_HOME_PATH, "sambaHomePath" },
111 { LDAP_ATTR_LOGON_SCRIPT, "sambaLogonScript" },
112 { LDAP_ATTR_PROFILE_PATH, "sambaProfilePath" },
113 { LDAP_ATTR_DESC, "description" },
114 { LDAP_ATTR_USER_WKS, "sambaUserWorkstations" },
115 { LDAP_ATTR_USER_SID, LDAP_ATTRIBUTE_SID },
116 { LDAP_ATTR_PRIMARY_GROUP_SID, "sambaPrimaryGroupSID" },
117 { LDAP_ATTR_LMPW, "sambaLMPassword" },
118 { LDAP_ATTR_NTPW, "sambaNTPassword" },
119 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
120 { LDAP_ATTR_OBJCLASS, "objectClass" },
121 { LDAP_ATTR_ACB_INFO, "sambaAcctFlags" },
122 { LDAP_ATTR_MUNGED_DIAL, "sambaMungedDial" },
123 { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
124 { LDAP_ATTR_BAD_PASSWORD_TIME, "sambaBadPasswordTime" },
125 { LDAP_ATTR_PWD_HISTORY, "sambaPasswordHistory" },
126 { LDAP_ATTR_MOD_TIMESTAMP, "modifyTimestamp" },
127 { LDAP_ATTR_LOGON_HOURS, "sambaLogonHours" },
128 { LDAP_ATTR_LIST_END, NULL }
131 ATTRIB_MAP_ENTRY attrib_map_to_delete_v30[] = {
132 { LDAP_ATTR_PWD_LAST_SET, "sambaPwdLastSet" },
133 { LDAP_ATTR_PWD_CAN_CHANGE, "sambaPwdCanChange" },
134 { LDAP_ATTR_PWD_MUST_CHANGE, "sambaPwdMustChange" },
135 { LDAP_ATTR_LOGON_TIME, "sambaLogonTime" },
136 { LDAP_ATTR_LOGOFF_TIME, "sambaLogoffTime" },
137 { LDAP_ATTR_KICKOFF_TIME, "sambaKickoffTime" },
138 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
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 }
158 /* attributes used for allocating RIDs */
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 },
171 /* Samba 3.0 group mapping attributes */
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 }
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 }
194 /* idmap_ldap sambaUnixIdPool */
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 }
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 }
211 /**********************************************************************
212 perform a simple table lookup and return the attribute name
213 **********************************************************************/
215 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table[], int key )
219 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
220 if ( table[i].attrib == key )
221 return table[i].name;
229 /**********************************************************************
230 Return the list of attribute names from a mapping table
231 **********************************************************************/
233 const char** get_attr_list( TALLOC_CTX *mem_ctx, ATTRIB_MAP_ENTRY table[] )
238 while ( table[i].attrib != LDAP_ATTR_LIST_END )
242 names = TALLOC_ARRAY( mem_ctx, const char*, i );
244 DEBUG(0,("get_attr_list: out of memory\n"));
249 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
250 names[i] = talloc_strdup( names, table[i].name );
258 /*******************************************************************
259 Search an attribute and return the first value found.
260 ******************************************************************/
262 bool smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
263 const char *attribute, char *value,
273 if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
274 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
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);
286 ldap_value_free(values);
287 #ifdef DEBUG_PASSWORDS
288 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
293 char * smbldap_talloc_single_attribute(LDAP *ldap_struct, LDAPMessage *entry,
294 const char *attribute,
299 size_t converted_size;
301 if (attribute == NULL) {
305 values = ldap_get_values(ldap_struct, entry, attribute);
307 if (values == NULL) {
308 DEBUG(10, ("attribute %s does not exist\n", attribute));
312 if (ldap_count_values(values) != 1) {
313 DEBUG(10, ("attribute %s has %d values, expected only one\n",
314 attribute, ldap_count_values(values)));
315 ldap_value_free(values);
319 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
320 DEBUG(10, ("pull_utf8_talloc failed\n"));
321 ldap_value_free(values);
325 ldap_value_free(values);
327 #ifdef DEBUG_PASSWORDS
328 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
334 char * smbldap_talloc_first_attribute(LDAP *ldap_struct, LDAPMessage *entry,
335 const char *attribute,
340 size_t converted_size;
342 if (attribute == NULL) {
346 values = ldap_get_values(ldap_struct, entry, attribute);
348 if (values == NULL) {
349 DEBUG(10, ("attribute %s does not exist\n", attribute));
353 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
354 DEBUG(10, ("pull_utf8_talloc failed\n"));
355 ldap_value_free(values);
359 ldap_value_free(values);
361 #ifdef DEBUG_PASSWORDS
362 DEBUG (100, ("smbldap_get_first_attribute: [%s] = [%s]\n",
368 char * smbldap_talloc_smallest_attribute(LDAP *ldap_struct, LDAPMessage *entry,
369 const char *attribute,
374 size_t converted_size;
377 if (attribute == NULL) {
381 values = ldap_get_values(ldap_struct, entry, attribute);
383 if (values == NULL) {
384 DEBUG(10, ("attribute %s does not exist\n", attribute));
388 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
389 DEBUG(10, ("pull_utf8_talloc failed\n"));
390 ldap_value_free(values);
394 num_values = ldap_count_values(values);
396 for (i=1; i<num_values; i++) {
399 if (!pull_utf8_talloc(mem_ctx, &tmp, values[i],
401 DEBUG(10, ("pull_utf8_talloc failed\n"));
403 ldap_value_free(values);
407 if (StrCaseCmp(tmp, result) < 0) {
415 ldap_value_free(values);
417 #ifdef DEBUG_PASSWORDS
418 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
424 bool smbldap_talloc_single_blob(TALLOC_CTX *mem_ctx, LDAP *ld,
425 LDAPMessage *msg, const char *attrib,
428 struct berval **values;
430 values = ldap_get_values_len(ld, msg, attrib);
435 if (ldap_count_values_len(values) != 1) {
436 DEBUG(10, ("Expected one value for %s, got %d\n", attrib,
437 ldap_count_values_len(values)));
441 *blob = data_blob_talloc(mem_ctx, values[0]->bv_val,
443 ldap_value_free_len(values);
445 return (blob->data != NULL);
448 bool smbldap_pull_sid(LDAP *ld, LDAPMessage *msg, const char *attrib,
454 if (!smbldap_talloc_single_blob(talloc_tos(), ld, msg, attrib,
458 ret = sid_parse((char *)blob.data, blob.length, sid);
459 TALLOC_FREE(blob.data);
463 static int ldapmsg_destructor(LDAPMessage **result) {
464 ldap_msgfree(*result);
468 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
470 LDAPMessage **handle;
472 if (result == NULL) {
476 handle = TALLOC_P(mem_ctx, LDAPMessage *);
477 SMB_ASSERT(handle != NULL);
480 talloc_set_destructor(handle, ldapmsg_destructor);
483 static int ldapmod_destructor(LDAPMod ***mod) {
484 ldap_mods_free(*mod, True);
488 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
496 handle = TALLOC_P(mem_ctx, LDAPMod **);
497 SMB_ASSERT(handle != NULL);
500 talloc_set_destructor(handle, ldapmod_destructor);
503 /************************************************************************
504 Routine to manage the LDAPMod structure array
505 manage memory used by the array, by each struct, and values
506 ***********************************************************************/
508 static void smbldap_set_mod_internal(LDAPMod *** modlist, int modop, const char *attribute, const char *value, const DATA_BLOB *blob)
516 /* sanity checks on the mod values */
518 if (attribute == NULL || *attribute == '\0') {
522 #if 0 /* commented out after discussion with abartlet. Do not reenable.
523 left here so other do not re-add similar code --jerry */
524 if (value == NULL || *value == '\0')
529 mods = SMB_MALLOC_P(LDAPMod *);
531 smb_panic("smbldap_set_mod: out of memory!");
537 for (i = 0; mods[i] != NULL; ++i) {
538 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
542 if (mods[i] == NULL) {
543 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
545 smb_panic("smbldap_set_mod: out of memory!");
548 mods[i] = SMB_MALLOC_P(LDAPMod);
549 if (mods[i] == NULL) {
550 smb_panic("smbldap_set_mod: out of memory!");
553 mods[i]->mod_op = modop;
554 mods[i]->mod_values = NULL;
555 mods[i]->mod_type = SMB_STRDUP(attribute);
559 if (blob && (modop & LDAP_MOD_BVALUES)) {
561 if (mods[i]->mod_bvalues != NULL) {
562 for (; mods[i]->mod_bvalues[j] != NULL; j++);
564 mods[i]->mod_bvalues = SMB_REALLOC_ARRAY(mods[i]->mod_bvalues, struct berval *, j + 2);
566 if (mods[i]->mod_bvalues == NULL) {
567 smb_panic("smbldap_set_mod: out of memory!");
571 mods[i]->mod_bvalues[j] = SMB_MALLOC_P(struct berval);
572 SMB_ASSERT(mods[i]->mod_bvalues[j] != NULL);
574 mods[i]->mod_bvalues[j]->bv_val = (char *)memdup(blob->data, blob->length);
575 SMB_ASSERT(mods[i]->mod_bvalues[j]->bv_val != NULL);
576 mods[i]->mod_bvalues[j]->bv_len = blob->length;
578 mods[i]->mod_bvalues[j + 1] = NULL;
579 } else if (value != NULL) {
580 char *utf8_value = NULL;
581 size_t converted_size;
584 if (mods[i]->mod_values != NULL) {
585 for (; mods[i]->mod_values[j] != NULL; j++);
587 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
589 if (mods[i]->mod_values == NULL) {
590 smb_panic("smbldap_set_mod: out of memory!");
594 if (!push_utf8_talloc(talloc_tos(), &utf8_value, value, &converted_size)) {
595 smb_panic("smbldap_set_mod: String conversion failure!");
599 mods[i]->mod_values[j] = SMB_STRDUP(utf8_value);
600 TALLOC_FREE(utf8_value);
601 SMB_ASSERT(mods[i]->mod_values[j] != NULL);
603 mods[i]->mod_values[j + 1] = NULL;
608 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
610 smbldap_set_mod_internal(modlist, modop, attribute, value, NULL);
613 void smbldap_set_mod_blob(LDAPMod *** modlist, int modop, const char *attribute, const DATA_BLOB *value)
615 smbldap_set_mod_internal(modlist, modop | LDAP_MOD_BVALUES, attribute, NULL, value);
618 /**********************************************************************
619 Set attribute to newval in LDAP, regardless of what value the
620 attribute had in LDAP before.
621 *********************************************************************/
623 static void smbldap_make_mod_internal(LDAP *ldap_struct, LDAPMessage *existing,
625 const char *attribute, int op,
627 const DATA_BLOB *newblob)
629 char oldval[2048]; /* current largest allowed value is mungeddial */
631 DATA_BLOB oldblob = data_blob_null;
633 if (attribute == NULL) {
634 /* This can actually happen for ldapsam_compat where we for
635 * example don't have a password history */
639 if (existing != NULL) {
640 if (op & LDAP_MOD_BVALUES) {
641 existed = smbldap_talloc_single_blob(talloc_tos(), ldap_struct, existing, attribute, &oldblob);
643 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
652 if (op & LDAP_MOD_BVALUES) {
653 equal = (newblob && (data_blob_cmp(&oldblob, newblob) == 0));
655 /* all of our string attributes are case insensitive */
656 equal = (newval && (StrCaseCmp(oldval, newval) == 0));
660 /* Believe it or not, but LDAP will deny a delete and
661 an add at the same time if the values are the
663 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
667 /* There has been no value before, so don't delete it.
668 * Here's a possible race: We might end up with
669 * duplicate attributes */
670 /* By deleting exactly the value we found in the entry this
671 * should be race-free in the sense that the LDAP-Server will
672 * deny the complete operation if somebody changed the
673 * attribute behind our back. */
674 /* This will also allow modifying single valued attributes
675 * in Novell NDS. In NDS you have to first remove attribute and then
676 * you could add new value */
678 if (op & LDAP_MOD_BVALUES) {
679 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| blob\n", attribute));
680 smbldap_set_mod_blob(mods, LDAP_MOD_DELETE, attribute, &oldblob);
682 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
683 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
687 /* Regardless of the real operation (add or modify)
688 we add the new value here. We rely on deleting
689 the old value, should it exist. */
691 if (op & LDAP_MOD_BVALUES) {
692 if (newblob && newblob->length) {
693 DEBUG(10,("smbldap_make_mod: adding attribute |%s| blob\n", attribute));
694 smbldap_set_mod_blob(mods, LDAP_MOD_ADD, attribute, newblob);
697 if ((newval != NULL) && (strlen(newval) > 0)) {
698 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
699 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
704 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
706 const char *attribute, const char *newval)
708 smbldap_make_mod_internal(ldap_struct, existing, mods, attribute,
712 void smbldap_make_mod_blob(LDAP *ldap_struct, LDAPMessage *existing,
714 const char *attribute, const DATA_BLOB *newblob)
716 smbldap_make_mod_internal(ldap_struct, existing, mods, attribute,
717 LDAP_MOD_BVALUES, NULL, newblob);
720 /**********************************************************************
721 Some varients of the LDAP rebind code do not pass in the third 'arg'
722 pointer to a void*, so we try and work around it by assuming that the
723 value of the 'LDAP *' pointer is the same as the one we had passed in
724 **********************************************************************/
726 struct smbldap_state_lookup {
728 struct smbldap_state *smbldap_state;
729 struct smbldap_state_lookup *prev, *next;
732 static struct smbldap_state_lookup *smbldap_state_lookup_list;
734 static struct smbldap_state *smbldap_find_state(LDAP *ld)
736 struct smbldap_state_lookup *t;
738 for (t = smbldap_state_lookup_list; t; t = t->next) {
740 return t->smbldap_state;
746 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
748 struct smbldap_state_lookup *t;
750 for (t = smbldap_state_lookup_list; t; t = t->next) {
751 if (t->smbldap_state == smbldap_state) {
752 DLIST_REMOVE(smbldap_state_lookup_list, t);
759 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
761 struct smbldap_state *tmp_ldap_state;
762 struct smbldap_state_lookup *t;
764 if ((tmp_ldap_state = smbldap_find_state(ld))) {
765 SMB_ASSERT(tmp_ldap_state == smbldap_state);
769 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
772 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
774 t->smbldap_state = smbldap_state;
777 /********************************************************************
778 start TLS on an existing LDAP connection
779 *******************************************************************/
781 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
783 #ifdef LDAP_OPT_X_TLS
787 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
791 #ifdef LDAP_OPT_X_TLS
792 if (version != LDAP_VERSION3) {
793 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
794 return LDAP_OPERATIONS_ERROR;
797 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
798 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
799 ldap_err2string(rc)));
803 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
806 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
807 return LDAP_OPERATIONS_ERROR;
811 /********************************************************************
812 setup a connection to the LDAP server based on a uri
813 *******************************************************************/
815 static int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
819 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
821 #ifdef HAVE_LDAP_INITIALIZE
823 rc = ldap_initialize(ldap_struct, uri);
825 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
829 if (lp_ldap_follow_referral() != Auto) {
830 rc = ldap_set_option(*ldap_struct, LDAP_OPT_REFERRALS,
831 lp_ldap_follow_referral() ? LDAP_OPT_ON : LDAP_OPT_OFF);
832 if (rc != LDAP_SUCCESS)
833 DEBUG(0, ("Failed to set LDAP_OPT_REFERRALS: %s\n",
834 ldap_err2string(rc)));
840 /* Parse the string manually */
846 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
849 /* skip leading "URL:" (if any) */
850 if ( strnequal( uri, "URL:", 4 ) ) {
854 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
857 if (strequal(protocol, "ldap")) {
859 } else if (strequal(protocol, "ldaps")) {
862 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
866 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
867 DEBUG(0, ("ldap_init failed !\n"));
868 return LDAP_OPERATIONS_ERROR;
871 if (strequal(protocol, "ldaps")) {
872 #ifdef LDAP_OPT_X_TLS
873 int tls = LDAP_OPT_X_TLS_HARD;
874 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
876 DEBUG(0, ("Failed to setup a TLS session\n"));
879 DEBUG(3,("LDAPS option set...!\n"));
881 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
882 return LDAP_OPERATIONS_ERROR;
883 #endif /* LDAP_OPT_X_TLS */
886 #endif /* HAVE_LDAP_INITIALIZE */
888 /* now set connection timeout */
889 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
891 int ct = lp_ldap_connection_timeout()*1000;
892 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
893 if (rc != LDAP_SUCCESS) {
894 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
895 ct, ldap_err2string(rc)));
898 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
902 ct.tv_sec = lp_ldap_connection_timeout();
903 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
904 if (rc != LDAP_SUCCESS) {
905 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
906 (int)ct.tv_sec, ldap_err2string(rc)));
914 /********************************************************************
915 try to upgrade to Version 3 LDAP if not already, in either case return current
917 *******************************************************************/
919 static int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
924 /* assume the worst */
925 *new_version = LDAP_VERSION2;
927 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
932 if (version == LDAP_VERSION3) {
933 *new_version = LDAP_VERSION3;
938 version = LDAP_VERSION3;
939 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
944 *new_version = LDAP_VERSION3;
948 /*******************************************************************
949 open a connection to the ldap server (just until the bind)
950 ******************************************************************/
952 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
956 rc = smb_ldap_setup_conn(ldap_struct, uri);
961 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
966 rc = smb_ldap_start_tls(*ldap_struct, version);
974 /*******************************************************************
975 open a connection to the ldap server.
976 ******************************************************************/
977 static int smbldap_open_connection (struct smbldap_state *ldap_state)
980 int rc = LDAP_SUCCESS;
983 LDAP **ldap_struct = &ldap_state->ldap_struct;
985 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
990 /* Store the LDAP pointer in a lookup list */
992 smbldap_store_state(*ldap_struct, ldap_state);
994 /* Upgrade to LDAPv3 if possible */
996 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
1001 /* Start TLS if required */
1003 rc = smb_ldap_start_tls(*ldap_struct, version);
1008 /* Set alias dereferencing method */
1009 deref = lp_ldap_deref();
1011 if (ldap_set_option (*ldap_struct, LDAP_OPT_DEREF, &deref) != LDAP_OPT_SUCCESS) {
1012 DEBUG(1,("smbldap_open_connection: Failed to set dereferencing method: %d\n", deref));
1014 DEBUG(5,("Set dereferencing method: %d\n", deref));
1018 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
1022 /*******************************************************************
1023 a rebind function for authenticated referrals
1024 This version takes a void* that we can shove useful stuff in :-)
1025 ******************************************************************/
1026 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1028 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
1029 int *methodp, int freeit, void *arg)
1031 struct smbldap_state *ldap_state = arg;
1034 /** @TODO Should we be doing something to check what servers we rebind to?
1035 Could we get a referral to a machine that we don't want to give our
1036 username and password to? */
1041 memset(*credp, '\0', strlen(*credp));
1045 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
1046 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
1048 if (ldap_state->anonymous) {
1052 *whop = SMB_STRDUP(ldap_state->bind_dn);
1054 return LDAP_NO_MEMORY;
1056 *credp = SMB_STRDUP(ldap_state->bind_secret);
1059 return LDAP_NO_MEMORY;
1062 *methodp = LDAP_AUTH_SIMPLE;
1065 clock_gettime_mono(&ts);
1066 ldap_state->last_rebind = convert_timespec_to_timeval(ts);
1070 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1072 /*******************************************************************
1073 a rebind function for authenticated referrals
1074 This version takes a void* that we can shove useful stuff in :-)
1075 and actually does the connection.
1076 ******************************************************************/
1077 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1078 static int rebindproc_connect_with_state (LDAP *ldap_struct,
1079 LDAP_CONST char *url,
1081 ber_int_t msgid, void *arg)
1083 struct smbldap_state *ldap_state =
1084 (struct smbldap_state *)arg;
1089 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
1090 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
1092 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
1093 * itself) before rebinding to another LDAP server to avoid to expose
1094 * our credentials. At least *try* to secure the connection - Guenther */
1096 smb_ldap_upgrade_conn(ldap_struct, &version);
1097 smb_ldap_start_tls(ldap_struct, version);
1099 /** @TODO Should we be doing something to check what servers we rebind to?
1100 Could we get a referral to a machine that we don't want to give our
1101 username and password to? */
1103 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1105 /* only set the last rebind timestamp when we did rebind after a
1106 * non-read LDAP operation. That way we avoid the replication sleep
1107 * after a simple redirected search operation - Guenther */
1111 case LDAP_REQ_MODIFY:
1113 case LDAP_REQ_DELETE:
1114 case LDAP_REQ_MODDN:
1115 case LDAP_REQ_EXTENDED:
1116 DEBUG(10,("rebindproc_connect_with_state: "
1117 "setting last_rebind timestamp "
1118 "(req: 0x%02x)\n", (unsigned int)request));
1119 clock_gettime_mono(&ts);
1120 ldap_state->last_rebind = convert_timespec_to_timeval(ts);
1123 ZERO_STRUCT(ldap_state->last_rebind);
1129 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1131 /*******************************************************************
1132 Add a rebind function for authenticated referrals
1133 ******************************************************************/
1134 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1136 # if LDAP_SET_REBIND_PROC_ARGS == 2
1137 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
1138 int *method, int freeit )
1140 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
1142 return rebindproc_with_state(ldap_struct, whop, credp,
1143 method, freeit, ldap_state);
1145 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1146 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1148 /*******************************************************************
1149 a rebind function for authenticated referrals
1150 this also does the connection, but no void*.
1151 ******************************************************************/
1152 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1153 # if LDAP_SET_REBIND_PROC_ARGS == 2
1154 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
1157 struct smbldap_state *ldap_state = smbldap_find_state(ld);
1159 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
1162 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1163 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1165 /*******************************************************************
1166 connect to the ldap server under system privilege.
1167 ******************************************************************/
1168 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
1173 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
1174 char *bind_dn = NULL;
1175 char *bind_secret = NULL;
1177 /* get the default dn and password only if they are not set already */
1178 if (!fetch_ldap_pw(&bind_dn, &bind_secret)) {
1179 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
1180 return LDAP_INVALID_CREDENTIALS;
1182 smbldap_set_creds(ldap_state, false, bind_dn, bind_secret);
1184 memset(bind_secret, '\0', strlen(bind_secret));
1185 SAFE_FREE(bind_secret);
1188 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
1189 (OpenLDAP) doesnt' seem to support it */
1191 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
1192 ldap_state->uri, ldap_state->bind_dn));
1194 #ifdef HAVE_LDAP_SET_REBIND_PROC
1195 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1196 # if LDAP_SET_REBIND_PROC_ARGS == 2
1197 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
1199 # if LDAP_SET_REBIND_PROC_ARGS == 3
1200 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
1202 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1203 # if LDAP_SET_REBIND_PROC_ARGS == 2
1204 ldap_set_rebind_proc(ldap_struct, &rebindproc);
1206 # if LDAP_SET_REBIND_PROC_ARGS == 3
1207 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
1209 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1212 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1214 if (rc != LDAP_SUCCESS) {
1215 char *ld_error = NULL;
1216 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
1218 DEBUG(ldap_state->num_failures ? 2 : 0,
1219 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
1221 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
1222 ldap_err2string(rc),
1223 ld_error ? ld_error : "(unknown)"));
1224 SAFE_FREE(ld_error);
1225 ldap_state->num_failures++;
1229 ldap_state->num_failures = 0;
1230 ldap_state->paged_results = False;
1232 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1234 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1235 ldap_state->paged_results = True;
1238 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1239 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1240 ldap_state->paged_results ? "does" : "does not"));
1244 static void smbldap_idle_fn(struct event_context *event_ctx,
1245 struct timed_event *te,
1246 struct timeval now_abs,
1247 void *private_data);
1249 /**********************************************************************
1250 Connect to LDAP server (called before every ldap operation)
1251 *********************************************************************/
1252 static int smbldap_open(struct smbldap_state *ldap_state)
1255 bool reopen = False;
1256 SMB_ASSERT(ldap_state);
1258 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time_mono(NULL))) {
1260 #ifdef HAVE_UNIXSOCKET
1261 struct sockaddr_un addr;
1263 struct sockaddr addr;
1265 socklen_t len = sizeof(addr);
1268 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1269 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1272 #ifdef HAVE_UNIXSOCKET
1273 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1277 /* the other end has died. reopen. */
1278 ldap_unbind(ldap_state->ldap_struct);
1279 ldap_state->ldap_struct = NULL;
1280 ldap_state->last_ping = (time_t)0;
1282 ldap_state->last_ping = time_mono(NULL);
1286 if (ldap_state->ldap_struct != NULL) {
1287 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1288 return LDAP_SUCCESS;
1291 if ((rc = smbldap_open_connection(ldap_state))) {
1295 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1296 ldap_unbind(ldap_state->ldap_struct);
1297 ldap_state->ldap_struct = NULL;
1302 ldap_state->last_ping = time_mono(NULL);
1303 ldap_state->pid = sys_getpid();
1305 TALLOC_FREE(ldap_state->idle_event);
1307 if (ldap_state->event_context != NULL) {
1308 ldap_state->idle_event = event_add_timed(
1309 ldap_state->event_context, ldap_state,
1310 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1311 smbldap_idle_fn, ldap_state);
1314 DEBUG(4,("The LDAP server is successfully connected\n"));
1316 return LDAP_SUCCESS;
1319 /**********************************************************************
1320 Disconnect from LDAP server
1321 *********************************************************************/
1322 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1325 return NT_STATUS_INVALID_PARAMETER;
1327 if (ldap_state->ldap_struct != NULL) {
1328 ldap_unbind(ldap_state->ldap_struct);
1329 ldap_state->ldap_struct = NULL;
1332 smbldap_delete_state(ldap_state);
1334 TALLOC_FREE(ldap_state->idle_event);
1336 DEBUG(5,("The connection to the LDAP server was closed\n"));
1337 /* maybe free the results here --metze */
1339 return NT_STATUS_OK;
1342 static bool got_alarm;
1344 static void (*old_handler)(int);
1346 static void gotalarm_sig(int dummy)
1351 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1352 int *attempts, time_t endtime)
1354 time_t now = time_mono(NULL);
1355 int open_rc = LDAP_SERVER_DOWN;
1357 if (*rc != LDAP_SERVER_DOWN)
1360 if (now >= endtime) {
1361 smbldap_close(ldap_state);
1366 if (*attempts == 0) {
1368 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1369 alarm(endtime - now);
1371 if (ldap_state->pid != sys_getpid())
1372 smbldap_close(ldap_state);
1382 open_rc = smbldap_open(ldap_state);
1384 if (open_rc == LDAP_SUCCESS) {
1385 ldap_state->last_use = now;
1389 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1390 /* The fact that we are non-root or any other
1391 * access-denied condition will not change in the next
1392 * round of trying */
1402 if (open_rc != LDAP_SUCCESS) {
1403 DEBUG(1, ("Connection to LDAP server failed for the "
1404 "%d try!\n", *attempts));
1409 CatchSignal(SIGALRM, old_handler);
1411 ldap_state->last_use = now;
1415 /*********************************************************************
1416 ********************************************************************/
1418 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1419 const char *base, int scope, const char *filter,
1420 const char *attrs[], int attrsonly,
1421 LDAPControl **sctrls, LDAPControl **cctrls,
1422 int sizelimit, LDAPMessage **res)
1424 int rc = LDAP_SERVER_DOWN;
1427 time_t endtime = time_mono(NULL)+lp_ldap_timeout();
1428 struct timeval timeout;
1429 size_t converted_size;
1431 SMB_ASSERT(ldap_state);
1433 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1434 "scope => [%d]\n", base, filter, scope));
1436 if (ldap_state->last_rebind.tv_sec > 0) {
1437 struct timeval tval;
1442 clock_gettime_mono(&ts);
1443 tval = convert_timespec_to_timeval(ts);
1445 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1446 tdiff /= 1000; /* Convert to milliseconds. */
1448 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1449 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1451 if (sleep_time > 0) {
1452 /* we wait for the LDAP replication */
1453 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1454 "for LDAP replication.\n",sleep_time));
1455 smb_msleep(sleep_time);
1456 DEBUG(5,("smbldap_search_ext: go on!\n"));
1458 ZERO_STRUCT(ldap_state->last_rebind);
1461 if (!push_utf8_talloc(talloc_tos(), &utf8_filter, filter, &converted_size)) {
1462 return LDAP_NO_MEMORY;
1465 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1466 timeout.tv_sec = lp_ldap_timeout();
1467 timeout.tv_usec = 0;
1469 /* Setup alarm timeout.... Do we need both of these ? JRA.
1470 * Yes, I think we do need both of these. The server timeout only
1471 * covers the case where the server's operation takes too long. It
1472 * does not cover the case where the request hangs on its way to the
1473 * server. The server side timeout is not strictly necessary, it's
1474 * just a bit more kind to the server. VL. */
1477 CatchSignal(SIGALRM, gotalarm_sig);
1478 alarm(lp_ldap_timeout());
1479 /* End setup timeout. */
1481 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1482 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1484 CONST_DISCARD(char **, attrs),
1485 attrsonly, sctrls, cctrls, &timeout,
1487 if (rc != LDAP_SUCCESS) {
1488 char *ld_error = NULL;
1491 ldap_get_option(ldap_state->ldap_struct,
1492 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1494 ldap_get_option(ldap_state->ldap_struct,
1495 LDAP_OPT_ERROR_STRING, &ld_error);
1496 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1497 "(%s)\n", base, ld_errno,
1498 ldap_err2string(rc),
1499 ld_error ? ld_error : "unknown"));
1500 SAFE_FREE(ld_error);
1502 if (ld_errno == LDAP_SERVER_DOWN) {
1503 ldap_unbind(ldap_state->ldap_struct);
1504 ldap_state->ldap_struct = NULL;
1509 TALLOC_FREE(utf8_filter);
1511 /* Teardown timeout. */
1512 CatchSignal(SIGALRM, SIG_IGN);
1516 return LDAP_TIMELIMIT_EXCEEDED;
1521 int smbldap_search(struct smbldap_state *ldap_state,
1522 const char *base, int scope, const char *filter,
1523 const char *attrs[], int attrsonly,
1526 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1527 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1530 int smbldap_search_paged(struct smbldap_state *ldap_state,
1531 const char *base, int scope, const char *filter,
1532 const char **attrs, int attrsonly, int pagesize,
1533 LDAPMessage **res, void **cookie)
1536 LDAPControl **rcontrols;
1537 LDAPControl *controls[2] = { NULL, NULL};
1538 BerElement *cookie_be = NULL;
1539 struct berval *cookie_bv = NULL;
1541 bool critical = True;
1545 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1546 "scope => [%d], pagesize => [%d]\n",
1547 base, filter, scope, pagesize));
1549 cookie_be = ber_alloc_t(LBER_USE_DER);
1550 if (cookie_be == NULL) {
1551 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1553 return LDAP_NO_MEMORY;
1556 /* construct cookie */
1557 if (*cookie != NULL) {
1558 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1559 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1562 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1564 ber_flatten(cookie_be, &cookie_bv);
1566 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1567 pr.ldctl_iscritical = (char) critical;
1568 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1569 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1574 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1575 0, controls, NULL, LDAP_NO_LIMIT, res);
1577 ber_free(cookie_be, 1);
1578 ber_bvfree(cookie_bv);
1581 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1582 "failed with [%s]\n", filter, ldap_err2string(rc)));
1586 DEBUG(3,("smbldap_search_paged: search was successful\n"));
1588 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1589 NULL, NULL, &rcontrols, 0);
1591 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1592 "with [%s]\n", ldap_err2string(rc)));
1596 if (rcontrols == NULL)
1599 for (i=0; rcontrols[i]; i++) {
1601 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1604 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1605 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1606 /* the berval is the cookie, but must be freed when it is all
1608 if (cookie_bv->bv_len)
1609 *cookie=ber_bvdup(cookie_bv);
1612 ber_bvfree(cookie_bv);
1613 ber_free(cookie_be, 1);
1616 ldap_controls_free(rcontrols);
1621 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1623 int rc = LDAP_SERVER_DOWN;
1626 time_t endtime = time_mono(NULL)+lp_ldap_timeout();
1627 size_t converted_size;
1629 SMB_ASSERT(ldap_state);
1631 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1633 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1634 return LDAP_NO_MEMORY;
1637 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1638 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1639 if (rc != LDAP_SUCCESS) {
1640 char *ld_error = NULL;
1643 ldap_get_option(ldap_state->ldap_struct,
1644 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1646 ldap_get_option(ldap_state->ldap_struct,
1647 LDAP_OPT_ERROR_STRING, &ld_error);
1648 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1649 "(%s)\n", dn, ld_errno,
1650 ldap_err2string(rc),
1651 ld_error ? ld_error : "unknown"));
1652 SAFE_FREE(ld_error);
1654 if (ld_errno == LDAP_SERVER_DOWN) {
1655 ldap_unbind(ldap_state->ldap_struct);
1656 ldap_state->ldap_struct = NULL;
1661 TALLOC_FREE(utf8_dn);
1665 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1667 int rc = LDAP_SERVER_DOWN;
1670 time_t endtime = time_mono(NULL)+lp_ldap_timeout();
1671 size_t converted_size;
1673 SMB_ASSERT(ldap_state);
1675 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1677 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1678 return LDAP_NO_MEMORY;
1681 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1682 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1683 if (rc != LDAP_SUCCESS) {
1684 char *ld_error = NULL;
1687 ldap_get_option(ldap_state->ldap_struct,
1688 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1690 ldap_get_option(ldap_state->ldap_struct,
1691 LDAP_OPT_ERROR_STRING, &ld_error);
1692 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1693 "(%s)\n", dn, ld_errno,
1694 ldap_err2string(rc),
1695 ld_error ? ld_error : "unknown"));
1696 SAFE_FREE(ld_error);
1698 if (ld_errno == LDAP_SERVER_DOWN) {
1699 ldap_unbind(ldap_state->ldap_struct);
1700 ldap_state->ldap_struct = NULL;
1705 TALLOC_FREE(utf8_dn);
1709 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1711 int rc = LDAP_SERVER_DOWN;
1714 time_t endtime = time_mono(NULL)+lp_ldap_timeout();
1715 size_t converted_size;
1717 SMB_ASSERT(ldap_state);
1719 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1721 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1722 return LDAP_NO_MEMORY;
1725 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1726 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1727 if (rc != LDAP_SUCCESS) {
1728 char *ld_error = NULL;
1731 ldap_get_option(ldap_state->ldap_struct,
1732 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1734 ldap_get_option(ldap_state->ldap_struct,
1735 LDAP_OPT_ERROR_STRING, &ld_error);
1736 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1737 "(%s)\n", dn, ld_errno,
1738 ldap_err2string(rc),
1739 ld_error ? ld_error : "unknown"));
1740 SAFE_FREE(ld_error);
1742 if (ld_errno == LDAP_SERVER_DOWN) {
1743 ldap_unbind(ldap_state->ldap_struct);
1744 ldap_state->ldap_struct = NULL;
1749 TALLOC_FREE(utf8_dn);
1753 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1754 LDAP_CONST char *reqoid, struct berval *reqdata,
1755 LDAPControl **serverctrls, LDAPControl **clientctrls,
1756 char **retoidp, struct berval **retdatap)
1758 int rc = LDAP_SERVER_DOWN;
1760 time_t endtime = time_mono(NULL)+lp_ldap_timeout();
1765 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1766 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1767 reqdata, serverctrls,
1768 clientctrls, retoidp, retdatap);
1769 if (rc != LDAP_SUCCESS) {
1770 char *ld_error = NULL;
1773 ldap_get_option(ldap_state->ldap_struct,
1774 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1776 ldap_get_option(ldap_state->ldap_struct,
1777 LDAP_OPT_ERROR_STRING, &ld_error);
1778 DEBUG(10, ("Extended operation failed with error: "
1779 "%d (%s) (%s)\n", ld_errno,
1780 ldap_err2string(rc),
1781 ld_error ? ld_error : "unknown"));
1782 SAFE_FREE(ld_error);
1784 if (ld_errno == LDAP_SERVER_DOWN) {
1785 ldap_unbind(ldap_state->ldap_struct);
1786 ldap_state->ldap_struct = NULL;
1794 /*******************************************************************
1795 run the search by name.
1796 ******************************************************************/
1797 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1798 const char *filter, const char **search_attr,
1799 LDAPMessage ** result)
1801 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1802 filter, search_attr, 0, result);
1805 static void smbldap_idle_fn(struct event_context *event_ctx,
1806 struct timed_event *te,
1807 struct timeval now_abs,
1810 struct smbldap_state *state = (struct smbldap_state *)private_data;
1812 TALLOC_FREE(state->idle_event);
1814 if (state->ldap_struct == NULL) {
1815 DEBUG(10,("ldap connection not connected...\n"));
1819 if ((state->last_use+SMBLDAP_IDLE_TIME) > time_mono(NULL)) {
1820 DEBUG(10,("ldap connection not idle...\n"));
1822 /* this needs to be made monotonic clock aware inside tevent: */
1823 state->idle_event = event_add_timed(
1825 timeval_add(&now_abs, SMBLDAP_IDLE_TIME, 0),
1831 DEBUG(7,("ldap connection idle...closing connection\n"));
1832 smbldap_close(state);
1835 /**********************************************************************
1837 *********************************************************************/
1839 void smbldap_free_struct(struct smbldap_state **ldap_state)
1841 smbldap_close(*ldap_state);
1843 if ((*ldap_state)->bind_secret) {
1844 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1847 SAFE_FREE((*ldap_state)->bind_dn);
1848 SAFE_FREE((*ldap_state)->bind_secret);
1850 TALLOC_FREE(*ldap_state);
1852 /* No need to free any further, as it is talloc()ed */
1856 /**********************************************************************
1857 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1858 *********************************************************************/
1860 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1861 const char *location,
1862 struct smbldap_state **smbldap_state)
1864 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1865 if (!*smbldap_state) {
1866 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1867 return NT_STATUS_NO_MEMORY;
1871 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1873 (*smbldap_state)->uri = "ldap://localhost";
1876 (*smbldap_state)->event_context = event_ctx;
1878 return NT_STATUS_OK;
1881 char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1884 char *utf8_dn, *unix_dn;
1885 size_t converted_size;
1887 utf8_dn = ldap_get_dn(ld, entry);
1889 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1892 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1893 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1894 "[%s]\n", utf8_dn));
1897 ldap_memfree(utf8_dn);
1901 /*******************************************************************
1902 Check if root-dse has a certain Control or Extension
1903 ********************************************************************/
1905 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1907 LDAPMessage *msg = NULL;
1908 LDAPMessage *entry = NULL;
1909 char **values = NULL;
1910 int rc, num_result, num_values, i;
1911 bool result = False;
1914 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1918 if (!strequal(attrs[0], "supportedExtension") &&
1919 !strequal(attrs[0], "supportedControl") &&
1920 !strequal(attrs[0], "namingContexts")) {
1921 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1925 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1926 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1928 if (rc != LDAP_SUCCESS) {
1929 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1933 num_result = ldap_count_entries(ld, msg);
1935 if (num_result != 1) {
1936 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1940 entry = ldap_first_entry(ld, msg);
1942 if (entry == NULL) {
1943 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1947 values = ldap_get_values(ld, entry, attrs[0]);
1949 if (values == NULL) {
1950 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1954 num_values = ldap_count_values(values);
1956 if (num_values == 0) {
1957 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1961 for (i=0; i<num_values; i++) {
1962 if (strcmp(values[i], value) == 0)
1969 ldap_value_free(values);
1977 /*******************************************************************
1978 Check if LDAP-Server supports a certain Control (OID in string format)
1979 ********************************************************************/
1981 bool smbldap_has_control(LDAP *ld, const char *control)
1983 const char *attrs[] = { "supportedControl", NULL };
1984 return smbldap_check_root_dse(ld, attrs, control);
1987 /*******************************************************************
1988 Check if LDAP-Server supports a certain Extension (OID in string format)
1989 ********************************************************************/
1991 bool smbldap_has_extension(LDAP *ld, const char *extension)
1993 const char *attrs[] = { "supportedExtension", NULL };
1994 return smbldap_check_root_dse(ld, attrs, extension);
1997 /*******************************************************************
1998 Check if LDAP-Server holds a given namingContext
1999 ********************************************************************/
2001 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
2003 const char *attrs[] = { "namingContexts", NULL };
2004 return smbldap_check_root_dse(ld, attrs, naming_context);
2007 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
2009 ldap_state->anonymous = anon;
2011 /* free any previously set credential */
2013 SAFE_FREE(ldap_state->bind_dn);
2014 if (ldap_state->bind_secret) {
2015 /* make sure secrets are zeroed out of memory */
2016 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
2017 SAFE_FREE(ldap_state->bind_secret);
2021 ldap_state->bind_dn = SMB_STRDUP(dn);
2022 ldap_state->bind_secret = SMB_STRDUP(secret);