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,
274 if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
275 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
280 if (!convert_string(CH_UTF8, CH_UNIX,values[0], -1, value, max_len, &size)) {
281 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
282 attribute, values[0]));
283 ldap_value_free(values);
287 ldap_value_free(values);
288 #ifdef DEBUG_PASSWORDS
289 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
294 char * smbldap_talloc_single_attribute(LDAP *ldap_struct, LDAPMessage *entry,
295 const char *attribute,
300 size_t converted_size;
302 if (attribute == NULL) {
306 values = ldap_get_values(ldap_struct, entry, attribute);
308 if (values == NULL) {
309 DEBUG(10, ("attribute %s does not exist\n", attribute));
313 if (ldap_count_values(values) != 1) {
314 DEBUG(10, ("attribute %s has %d values, expected only one\n",
315 attribute, ldap_count_values(values)));
316 ldap_value_free(values);
320 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
321 DEBUG(10, ("pull_utf8_talloc failed\n"));
322 ldap_value_free(values);
326 ldap_value_free(values);
328 #ifdef DEBUG_PASSWORDS
329 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
335 char * smbldap_talloc_first_attribute(LDAP *ldap_struct, LDAPMessage *entry,
336 const char *attribute,
341 size_t converted_size;
343 if (attribute == NULL) {
347 values = ldap_get_values(ldap_struct, entry, attribute);
349 if (values == NULL) {
350 DEBUG(10, ("attribute %s does not exist\n", attribute));
354 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
355 DEBUG(10, ("pull_utf8_talloc failed\n"));
356 ldap_value_free(values);
360 ldap_value_free(values);
362 #ifdef DEBUG_PASSWORDS
363 DEBUG (100, ("smbldap_get_first_attribute: [%s] = [%s]\n",
369 char * smbldap_talloc_smallest_attribute(LDAP *ldap_struct, LDAPMessage *entry,
370 const char *attribute,
375 size_t converted_size;
378 if (attribute == NULL) {
382 values = ldap_get_values(ldap_struct, entry, attribute);
384 if (values == NULL) {
385 DEBUG(10, ("attribute %s does not exist\n", attribute));
389 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
390 DEBUG(10, ("pull_utf8_talloc failed\n"));
391 ldap_value_free(values);
395 num_values = ldap_count_values(values);
397 for (i=1; i<num_values; i++) {
400 if (!pull_utf8_talloc(mem_ctx, &tmp, values[i],
402 DEBUG(10, ("pull_utf8_talloc failed\n"));
404 ldap_value_free(values);
408 if (strcasecmp_m(tmp, result) < 0) {
416 ldap_value_free(values);
418 #ifdef DEBUG_PASSWORDS
419 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
425 bool smbldap_talloc_single_blob(TALLOC_CTX *mem_ctx, LDAP *ld,
426 LDAPMessage *msg, const char *attrib,
429 struct berval **values;
431 values = ldap_get_values_len(ld, msg, attrib);
436 if (ldap_count_values_len(values) != 1) {
437 DEBUG(10, ("Expected one value for %s, got %d\n", attrib,
438 ldap_count_values_len(values)));
442 *blob = data_blob_talloc(mem_ctx, values[0]->bv_val,
444 ldap_value_free_len(values);
446 return (blob->data != NULL);
449 bool smbldap_pull_sid(LDAP *ld, LDAPMessage *msg, const char *attrib,
455 if (!smbldap_talloc_single_blob(talloc_tos(), ld, msg, attrib,
459 ret = sid_parse((char *)blob.data, blob.length, sid);
460 TALLOC_FREE(blob.data);
464 static int ldapmsg_destructor(LDAPMessage **result) {
465 ldap_msgfree(*result);
469 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
471 LDAPMessage **handle;
473 if (result == NULL) {
477 handle = talloc(mem_ctx, LDAPMessage *);
478 SMB_ASSERT(handle != NULL);
481 talloc_set_destructor(handle, ldapmsg_destructor);
484 static int ldapmod_destructor(LDAPMod ***mod) {
485 ldap_mods_free(*mod, True);
489 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
497 handle = talloc(mem_ctx, LDAPMod **);
498 SMB_ASSERT(handle != NULL);
501 talloc_set_destructor(handle, ldapmod_destructor);
504 /************************************************************************
505 Routine to manage the LDAPMod structure array
506 manage memory used by the array, by each struct, and values
507 ***********************************************************************/
509 static void smbldap_set_mod_internal(LDAPMod *** modlist, int modop, const char *attribute, const char *value, const DATA_BLOB *blob)
517 /* sanity checks on the mod values */
519 if (attribute == NULL || *attribute == '\0') {
523 #if 0 /* commented out after discussion with abartlet. Do not reenable.
524 left here so other do not re-add similar code --jerry */
525 if (value == NULL || *value == '\0')
530 mods = SMB_MALLOC_P(LDAPMod *);
532 smb_panic("smbldap_set_mod: out of memory!");
538 for (i = 0; mods[i] != NULL; ++i) {
539 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
543 if (mods[i] == NULL) {
544 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
546 smb_panic("smbldap_set_mod: out of memory!");
549 mods[i] = SMB_MALLOC_P(LDAPMod);
550 if (mods[i] == NULL) {
551 smb_panic("smbldap_set_mod: out of memory!");
554 mods[i]->mod_op = modop;
555 mods[i]->mod_values = NULL;
556 mods[i]->mod_type = SMB_STRDUP(attribute);
560 if (blob && (modop & LDAP_MOD_BVALUES)) {
562 if (mods[i]->mod_bvalues != NULL) {
563 for (; mods[i]->mod_bvalues[j] != NULL; j++);
565 mods[i]->mod_bvalues = SMB_REALLOC_ARRAY(mods[i]->mod_bvalues, struct berval *, j + 2);
567 if (mods[i]->mod_bvalues == NULL) {
568 smb_panic("smbldap_set_mod: out of memory!");
572 mods[i]->mod_bvalues[j] = SMB_MALLOC_P(struct berval);
573 SMB_ASSERT(mods[i]->mod_bvalues[j] != NULL);
575 mods[i]->mod_bvalues[j]->bv_val = (char *)memdup(blob->data, blob->length);
576 SMB_ASSERT(mods[i]->mod_bvalues[j]->bv_val != NULL);
577 mods[i]->mod_bvalues[j]->bv_len = blob->length;
579 mods[i]->mod_bvalues[j + 1] = NULL;
580 } else if (value != NULL) {
581 char *utf8_value = NULL;
582 size_t converted_size;
585 if (mods[i]->mod_values != NULL) {
586 for (; mods[i]->mod_values[j] != NULL; j++);
588 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
590 if (mods[i]->mod_values == NULL) {
591 smb_panic("smbldap_set_mod: out of memory!");
595 if (!push_utf8_talloc(talloc_tos(), &utf8_value, value, &converted_size)) {
596 smb_panic("smbldap_set_mod: String conversion failure!");
600 mods[i]->mod_values[j] = SMB_STRDUP(utf8_value);
601 TALLOC_FREE(utf8_value);
602 SMB_ASSERT(mods[i]->mod_values[j] != NULL);
604 mods[i]->mod_values[j + 1] = NULL;
609 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
611 smbldap_set_mod_internal(modlist, modop, attribute, value, NULL);
614 void smbldap_set_mod_blob(LDAPMod *** modlist, int modop, const char *attribute, const DATA_BLOB *value)
616 smbldap_set_mod_internal(modlist, modop | LDAP_MOD_BVALUES, attribute, NULL, value);
619 /**********************************************************************
620 Set attribute to newval in LDAP, regardless of what value the
621 attribute had in LDAP before.
622 *********************************************************************/
624 static void smbldap_make_mod_internal(LDAP *ldap_struct, LDAPMessage *existing,
626 const char *attribute, int op,
628 const DATA_BLOB *newblob)
630 char oldval[2048]; /* current largest allowed value is mungeddial */
632 DATA_BLOB oldblob = data_blob_null;
634 if (attribute == NULL) {
635 /* This can actually happen for ldapsam_compat where we for
636 * example don't have a password history */
640 if (existing != NULL) {
641 if (op & LDAP_MOD_BVALUES) {
642 existed = smbldap_talloc_single_blob(talloc_tos(), ldap_struct, existing, attribute, &oldblob);
644 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
653 if (op & LDAP_MOD_BVALUES) {
654 equal = (newblob && (data_blob_cmp(&oldblob, newblob) == 0));
656 /* all of our string attributes are case insensitive */
657 equal = (newval && (strcasecmp_m(oldval, newval) == 0));
661 /* Believe it or not, but LDAP will deny a delete and
662 an add at the same time if the values are the
664 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
668 /* There has been no value before, so don't delete it.
669 * Here's a possible race: We might end up with
670 * duplicate attributes */
671 /* By deleting exactly the value we found in the entry this
672 * should be race-free in the sense that the LDAP-Server will
673 * deny the complete operation if somebody changed the
674 * attribute behind our back. */
675 /* This will also allow modifying single valued attributes
676 * in Novell NDS. In NDS you have to first remove attribute and then
677 * you could add new value */
679 if (op & LDAP_MOD_BVALUES) {
680 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| blob\n", attribute));
681 smbldap_set_mod_blob(mods, LDAP_MOD_DELETE, attribute, &oldblob);
683 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
684 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
688 /* Regardless of the real operation (add or modify)
689 we add the new value here. We rely on deleting
690 the old value, should it exist. */
692 if (op & LDAP_MOD_BVALUES) {
693 if (newblob && newblob->length) {
694 DEBUG(10,("smbldap_make_mod: adding attribute |%s| blob\n", attribute));
695 smbldap_set_mod_blob(mods, LDAP_MOD_ADD, attribute, newblob);
698 if ((newval != NULL) && (strlen(newval) > 0)) {
699 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
700 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
705 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
707 const char *attribute, const char *newval)
709 smbldap_make_mod_internal(ldap_struct, existing, mods, attribute,
713 void smbldap_make_mod_blob(LDAP *ldap_struct, LDAPMessage *existing,
715 const char *attribute, const DATA_BLOB *newblob)
717 smbldap_make_mod_internal(ldap_struct, existing, mods, attribute,
718 LDAP_MOD_BVALUES, NULL, newblob);
721 /**********************************************************************
722 Some varients of the LDAP rebind code do not pass in the third 'arg'
723 pointer to a void*, so we try and work around it by assuming that the
724 value of the 'LDAP *' pointer is the same as the one we had passed in
725 **********************************************************************/
727 struct smbldap_state_lookup {
729 struct smbldap_state *smbldap_state;
730 struct smbldap_state_lookup *prev, *next;
733 static struct smbldap_state_lookup *smbldap_state_lookup_list;
735 static struct smbldap_state *smbldap_find_state(LDAP *ld)
737 struct smbldap_state_lookup *t;
739 for (t = smbldap_state_lookup_list; t; t = t->next) {
741 return t->smbldap_state;
747 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
749 struct smbldap_state_lookup *t;
751 for (t = smbldap_state_lookup_list; t; t = t->next) {
752 if (t->smbldap_state == smbldap_state) {
753 DLIST_REMOVE(smbldap_state_lookup_list, t);
760 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
762 struct smbldap_state *tmp_ldap_state;
763 struct smbldap_state_lookup *t;
765 if ((tmp_ldap_state = smbldap_find_state(ld))) {
766 SMB_ASSERT(tmp_ldap_state == smbldap_state);
770 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
773 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
775 t->smbldap_state = smbldap_state;
778 /********************************************************************
779 start TLS on an existing LDAP connection
780 *******************************************************************/
782 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
784 #ifdef LDAP_OPT_X_TLS
788 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
792 #ifdef LDAP_OPT_X_TLS
793 if (version != LDAP_VERSION3) {
794 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
795 return LDAP_OPERATIONS_ERROR;
798 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
799 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
800 ldap_err2string(rc)));
804 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
807 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
808 return LDAP_OPERATIONS_ERROR;
812 /********************************************************************
813 setup a connection to the LDAP server based on a uri
814 *******************************************************************/
816 static int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
820 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
822 #ifdef HAVE_LDAP_INITIALIZE
824 rc = ldap_initialize(ldap_struct, uri);
826 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
830 if (lp_ldap_follow_referral() != Auto) {
831 rc = ldap_set_option(*ldap_struct, LDAP_OPT_REFERRALS,
832 lp_ldap_follow_referral() ? LDAP_OPT_ON : LDAP_OPT_OFF);
833 if (rc != LDAP_SUCCESS)
834 DEBUG(0, ("Failed to set LDAP_OPT_REFERRALS: %s\n",
835 ldap_err2string(rc)));
841 /* Parse the string manually */
847 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
850 /* skip leading "URL:" (if any) */
851 if ( strnequal( uri, "URL:", 4 ) ) {
855 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
858 if (strequal(protocol, "ldap")) {
860 } else if (strequal(protocol, "ldaps")) {
863 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
867 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
868 DEBUG(0, ("ldap_init failed !\n"));
869 return LDAP_OPERATIONS_ERROR;
872 if (strequal(protocol, "ldaps")) {
873 #ifdef LDAP_OPT_X_TLS
874 int tls = LDAP_OPT_X_TLS_HARD;
875 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
877 DEBUG(0, ("Failed to setup a TLS session\n"));
880 DEBUG(3,("LDAPS option set...!\n"));
882 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
883 return LDAP_OPERATIONS_ERROR;
884 #endif /* LDAP_OPT_X_TLS */
887 #endif /* HAVE_LDAP_INITIALIZE */
889 /* now set connection timeout */
890 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
892 int ct = lp_ldap_connection_timeout()*1000;
893 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
894 if (rc != LDAP_SUCCESS) {
895 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
896 ct, ldap_err2string(rc)));
899 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
903 ct.tv_sec = lp_ldap_connection_timeout();
904 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
905 if (rc != LDAP_SUCCESS) {
906 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
907 (int)ct.tv_sec, ldap_err2string(rc)));
915 /********************************************************************
916 try to upgrade to Version 3 LDAP if not already, in either case return current
918 *******************************************************************/
920 static int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
925 /* assume the worst */
926 *new_version = LDAP_VERSION2;
928 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
933 if (version == LDAP_VERSION3) {
934 *new_version = LDAP_VERSION3;
939 version = LDAP_VERSION3;
940 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
945 *new_version = LDAP_VERSION3;
949 /*******************************************************************
950 open a connection to the ldap server (just until the bind)
951 ******************************************************************/
953 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
957 rc = smb_ldap_setup_conn(ldap_struct, uri);
962 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
967 rc = smb_ldap_start_tls(*ldap_struct, version);
975 /*******************************************************************
976 open a connection to the ldap server.
977 ******************************************************************/
978 static int smbldap_open_connection (struct smbldap_state *ldap_state)
981 int rc = LDAP_SUCCESS;
984 LDAP **ldap_struct = &ldap_state->ldap_struct;
986 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
991 /* Store the LDAP pointer in a lookup list */
993 smbldap_store_state(*ldap_struct, ldap_state);
995 /* Upgrade to LDAPv3 if possible */
997 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
1002 /* Start TLS if required */
1004 rc = smb_ldap_start_tls(*ldap_struct, version);
1009 /* Set alias dereferencing method */
1010 deref = lp_ldap_deref();
1012 if (ldap_set_option (*ldap_struct, LDAP_OPT_DEREF, &deref) != LDAP_OPT_SUCCESS) {
1013 DEBUG(1,("smbldap_open_connection: Failed to set dereferencing method: %d\n", deref));
1015 DEBUG(5,("Set dereferencing method: %d\n", deref));
1019 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
1023 /*******************************************************************
1024 a rebind function for authenticated referrals
1025 This version takes a void* that we can shove useful stuff in :-)
1026 ******************************************************************/
1027 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1029 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
1030 int *methodp, int freeit, void *arg)
1032 struct smbldap_state *ldap_state = arg;
1035 /** @TODO Should we be doing something to check what servers we rebind to?
1036 Could we get a referral to a machine that we don't want to give our
1037 username and password to? */
1042 memset(*credp, '\0', strlen(*credp));
1046 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
1047 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
1049 if (ldap_state->anonymous) {
1053 *whop = SMB_STRDUP(ldap_state->bind_dn);
1055 return LDAP_NO_MEMORY;
1057 *credp = SMB_STRDUP(ldap_state->bind_secret);
1060 return LDAP_NO_MEMORY;
1063 *methodp = LDAP_AUTH_SIMPLE;
1066 clock_gettime_mono(&ts);
1067 ldap_state->last_rebind = convert_timespec_to_timeval(ts);
1071 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1073 /*******************************************************************
1074 a rebind function for authenticated referrals
1075 This version takes a void* that we can shove useful stuff in :-)
1076 and actually does the connection.
1077 ******************************************************************/
1078 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1079 static int rebindproc_connect_with_state (LDAP *ldap_struct,
1080 LDAP_CONST char *url,
1082 ber_int_t msgid, void *arg)
1084 struct smbldap_state *ldap_state =
1085 (struct smbldap_state *)arg;
1090 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
1091 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
1093 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
1094 * itself) before rebinding to another LDAP server to avoid to expose
1095 * our credentials. At least *try* to secure the connection - Guenther */
1097 smb_ldap_upgrade_conn(ldap_struct, &version);
1098 smb_ldap_start_tls(ldap_struct, version);
1100 /** @TODO Should we be doing something to check what servers we rebind to?
1101 Could we get a referral to a machine that we don't want to give our
1102 username and password to? */
1104 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1106 /* only set the last rebind timestamp when we did rebind after a
1107 * non-read LDAP operation. That way we avoid the replication sleep
1108 * after a simple redirected search operation - Guenther */
1112 case LDAP_REQ_MODIFY:
1114 case LDAP_REQ_DELETE:
1115 case LDAP_REQ_MODDN:
1116 case LDAP_REQ_EXTENDED:
1117 DEBUG(10,("rebindproc_connect_with_state: "
1118 "setting last_rebind timestamp "
1119 "(req: 0x%02x)\n", (unsigned int)request));
1120 clock_gettime_mono(&ts);
1121 ldap_state->last_rebind = convert_timespec_to_timeval(ts);
1124 ZERO_STRUCT(ldap_state->last_rebind);
1130 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1132 /*******************************************************************
1133 Add a rebind function for authenticated referrals
1134 ******************************************************************/
1135 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1137 # if LDAP_SET_REBIND_PROC_ARGS == 2
1138 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
1139 int *method, int freeit )
1141 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
1143 return rebindproc_with_state(ldap_struct, whop, credp,
1144 method, freeit, ldap_state);
1146 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1147 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1149 /*******************************************************************
1150 a rebind function for authenticated referrals
1151 this also does the connection, but no void*.
1152 ******************************************************************/
1153 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1154 # if LDAP_SET_REBIND_PROC_ARGS == 2
1155 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
1158 struct smbldap_state *ldap_state = smbldap_find_state(ld);
1160 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
1163 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1164 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1166 /*******************************************************************
1167 connect to the ldap server under system privilege.
1168 ******************************************************************/
1169 static int smbldap_connect_system(struct smbldap_state *ldap_state)
1171 LDAP *ldap_struct = ldap_state->ldap_struct;
1175 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
1176 char *bind_dn = NULL;
1177 char *bind_secret = NULL;
1179 /* get the default dn and password only if they are not set already */
1180 if (!fetch_ldap_pw(&bind_dn, &bind_secret)) {
1181 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
1182 rc = LDAP_INVALID_CREDENTIALS;
1185 smbldap_set_creds(ldap_state, false, bind_dn, bind_secret);
1187 memset(bind_secret, '\0', strlen(bind_secret));
1188 SAFE_FREE(bind_secret);
1191 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
1192 (OpenLDAP) doesnt' seem to support it */
1194 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
1195 ldap_state->uri, ldap_state->bind_dn));
1197 #ifdef HAVE_LDAP_SET_REBIND_PROC
1198 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1199 # if LDAP_SET_REBIND_PROC_ARGS == 2
1200 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
1202 # if LDAP_SET_REBIND_PROC_ARGS == 3
1203 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
1205 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1206 # if LDAP_SET_REBIND_PROC_ARGS == 2
1207 ldap_set_rebind_proc(ldap_struct, &rebindproc);
1209 # if LDAP_SET_REBIND_PROC_ARGS == 3
1210 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
1212 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1215 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1217 if (rc != LDAP_SUCCESS) {
1218 char *ld_error = NULL;
1219 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
1221 DEBUG(ldap_state->num_failures ? 2 : 0,
1222 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
1224 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
1225 ldap_err2string(rc),
1226 ld_error ? ld_error : "(unknown)"));
1227 SAFE_FREE(ld_error);
1228 ldap_state->num_failures++;
1232 ldap_state->num_failures = 0;
1233 ldap_state->paged_results = False;
1235 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1237 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1238 ldap_state->paged_results = True;
1241 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1242 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1243 ldap_state->paged_results ? "does" : "does not"));
1246 ldap_unbind(ldap_struct);
1247 ldap_state->ldap_struct = NULL;
1252 static void smbldap_idle_fn(struct event_context *event_ctx,
1253 struct timed_event *te,
1254 struct timeval now_abs,
1255 void *private_data);
1257 /**********************************************************************
1258 Connect to LDAP server (called before every ldap operation)
1259 *********************************************************************/
1260 static int smbldap_open(struct smbldap_state *ldap_state)
1263 bool reopen = False;
1264 SMB_ASSERT(ldap_state);
1266 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time_mono(NULL))) {
1268 #ifdef HAVE_UNIXSOCKET
1269 struct sockaddr_un addr;
1271 struct sockaddr addr;
1273 socklen_t len = sizeof(addr);
1276 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1277 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1280 #ifdef HAVE_UNIXSOCKET
1281 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1285 /* the other end has died. reopen. */
1286 ldap_unbind(ldap_state->ldap_struct);
1287 ldap_state->ldap_struct = NULL;
1288 ldap_state->last_ping = (time_t)0;
1290 ldap_state->last_ping = time_mono(NULL);
1294 if (ldap_state->ldap_struct != NULL) {
1295 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1296 return LDAP_SUCCESS;
1299 if ((rc = smbldap_open_connection(ldap_state))) {
1303 if ((rc = smbldap_connect_system(ldap_state))) {
1308 ldap_state->last_ping = time_mono(NULL);
1309 ldap_state->pid = sys_getpid();
1311 TALLOC_FREE(ldap_state->idle_event);
1313 if (ldap_state->event_context != NULL) {
1314 ldap_state->idle_event = event_add_timed(
1315 ldap_state->event_context, ldap_state,
1316 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1317 smbldap_idle_fn, ldap_state);
1320 DEBUG(4,("The LDAP server is successfully connected\n"));
1322 return LDAP_SUCCESS;
1325 /**********************************************************************
1326 Disconnect from LDAP server
1327 *********************************************************************/
1328 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1331 return NT_STATUS_INVALID_PARAMETER;
1333 if (ldap_state->ldap_struct != NULL) {
1334 ldap_unbind(ldap_state->ldap_struct);
1335 ldap_state->ldap_struct = NULL;
1338 smbldap_delete_state(ldap_state);
1340 TALLOC_FREE(ldap_state->idle_event);
1342 DEBUG(5,("The connection to the LDAP server was closed\n"));
1343 /* maybe free the results here --metze */
1345 return NT_STATUS_OK;
1348 static SIG_ATOMIC_T got_alarm;
1350 static void gotalarm_sig(int dummy)
1355 static time_t calc_ldap_abs_endtime(int ldap_to)
1358 /* No timeout - don't
1364 /* Make the alarm time one second beyond
1365 the timout we're setting for the
1366 remote search timeout, to allow that
1367 to fire in preference. */
1369 return time_mono(NULL)+ldap_to+1;
1372 static int end_ldap_local_alarm(time_t absolute_endtime, int rc)
1374 if (absolute_endtime) {
1376 CatchSignal(SIGALRM, SIG_IGN);
1378 /* Client timeout error code. */
1380 return LDAP_TIMEOUT;
1386 static void setup_ldap_local_alarm(struct smbldap_state *ldap_state, time_t absolute_endtime)
1388 time_t now = time_mono(NULL);
1390 if (absolute_endtime) {
1392 CatchSignal(SIGALRM, gotalarm_sig);
1393 alarm(absolute_endtime - now);
1396 if (ldap_state->pid != sys_getpid()) {
1397 smbldap_close(ldap_state);
1401 static void get_ldap_errs(struct smbldap_state *ldap_state, char **pp_ld_error, int *p_ld_errno)
1403 ldap_get_option(ldap_state->ldap_struct,
1404 LDAP_OPT_ERROR_NUMBER, p_ld_errno);
1406 ldap_get_option(ldap_state->ldap_struct,
1407 LDAP_OPT_ERROR_STRING, pp_ld_error);
1410 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1411 int *attempts, time_t abs_endtime)
1413 time_t now = time_mono(NULL);
1414 int open_rc = LDAP_SERVER_DOWN;
1416 if (*rc != LDAP_SERVER_DOWN)
1419 if (abs_endtime && now >= abs_endtime) {
1420 smbldap_close(ldap_state);
1432 open_rc = smbldap_open(ldap_state);
1434 if (open_rc == LDAP_SUCCESS) {
1435 ldap_state->last_use = now;
1439 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1440 /* The fact that we are non-root or any other
1441 * access-denied condition will not change in the next
1442 * round of trying */
1452 if (open_rc != LDAP_SUCCESS) {
1453 DEBUG(1, ("Connection to LDAP server failed for the "
1454 "%d try!\n", *attempts));
1459 ldap_state->last_use = now;
1463 /*********************************************************************
1464 ********************************************************************/
1466 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1467 const char *base, int scope, const char *filter,
1468 const char *attrs[], int attrsonly,
1469 LDAPControl **sctrls, LDAPControl **cctrls,
1470 int sizelimit, LDAPMessage **res)
1472 int rc = LDAP_SERVER_DOWN;
1475 int to = lp_ldap_timeout();
1476 time_t abs_endtime = calc_ldap_abs_endtime(to);
1477 struct timeval timeout;
1478 struct timeval *timeout_ptr = NULL;
1479 size_t converted_size;
1481 SMB_ASSERT(ldap_state);
1483 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1484 "scope => [%d]\n", base, filter, scope));
1486 if (ldap_state->last_rebind.tv_sec > 0) {
1487 struct timeval tval;
1492 clock_gettime_mono(&ts);
1493 tval = convert_timespec_to_timeval(ts);
1495 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1496 tdiff /= 1000; /* Convert to milliseconds. */
1498 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1499 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1501 if (sleep_time > 0) {
1502 /* we wait for the LDAP replication */
1503 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1504 "for LDAP replication.\n",sleep_time));
1505 smb_msleep(sleep_time);
1506 DEBUG(5,("smbldap_search_ext: go on!\n"));
1508 ZERO_STRUCT(ldap_state->last_rebind);
1511 if (!push_utf8_talloc(talloc_tos(), &utf8_filter, filter, &converted_size)) {
1512 return LDAP_NO_MEMORY;
1515 /* Setup remote timeout for the ldap_search_ext_s call. */
1517 timeout.tv_sec = to;
1518 timeout.tv_usec = 0;
1519 timeout_ptr = &timeout;
1522 setup_ldap_local_alarm(ldap_state, abs_endtime);
1524 while (another_ldap_try(ldap_state, &rc, &attempts, abs_endtime)) {
1525 char *ld_error = NULL;
1528 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1530 discard_const_p(char *, attrs),
1531 attrsonly, sctrls, cctrls, timeout_ptr,
1533 if (rc == LDAP_SUCCESS) {
1537 get_ldap_errs(ldap_state, &ld_error, &ld_errno);
1539 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1540 "(%s)\n", base, ld_errno,
1541 ldap_err2string(rc),
1542 ld_error ? ld_error : "unknown"));
1543 SAFE_FREE(ld_error);
1545 if (ld_errno == LDAP_SERVER_DOWN) {
1546 ldap_unbind(ldap_state->ldap_struct);
1547 ldap_state->ldap_struct = NULL;
1551 TALLOC_FREE(utf8_filter);
1552 return end_ldap_local_alarm(abs_endtime, rc);
1555 int smbldap_search(struct smbldap_state *ldap_state,
1556 const char *base, int scope, const char *filter,
1557 const char *attrs[], int attrsonly,
1560 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1561 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1564 int smbldap_search_paged(struct smbldap_state *ldap_state,
1565 const char *base, int scope, const char *filter,
1566 const char **attrs, int attrsonly, int pagesize,
1567 LDAPMessage **res, void **cookie)
1570 LDAPControl **rcontrols;
1571 LDAPControl *controls[2] = { NULL, NULL};
1572 BerElement *cookie_be = NULL;
1573 struct berval *cookie_bv = NULL;
1575 bool critical = True;
1579 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1580 "scope => [%d], pagesize => [%d]\n",
1581 base, filter, scope, pagesize));
1583 cookie_be = ber_alloc_t(LBER_USE_DER);
1584 if (cookie_be == NULL) {
1585 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1587 return LDAP_NO_MEMORY;
1590 /* construct cookie */
1591 if (*cookie != NULL) {
1592 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1593 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1596 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1598 ber_flatten(cookie_be, &cookie_bv);
1600 pr.ldctl_oid = discard_const_p(char, ADS_PAGE_CTL_OID);
1601 pr.ldctl_iscritical = (char) critical;
1602 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1603 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1608 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1609 0, controls, NULL, LDAP_NO_LIMIT, res);
1611 ber_free(cookie_be, 1);
1612 ber_bvfree(cookie_bv);
1615 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1616 "failed with [%s]\n", filter, ldap_err2string(rc)));
1620 DEBUG(3,("smbldap_search_paged: search was successful\n"));
1622 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1623 NULL, NULL, &rcontrols, 0);
1625 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1626 "with [%s]\n", ldap_err2string(rc)));
1630 if (rcontrols == NULL)
1633 for (i=0; rcontrols[i]; i++) {
1635 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1638 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1639 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1640 /* the berval is the cookie, but must be freed when it is all
1642 if (cookie_bv->bv_len)
1643 *cookie=ber_bvdup(cookie_bv);
1646 ber_bvfree(cookie_bv);
1647 ber_free(cookie_be, 1);
1650 ldap_controls_free(rcontrols);
1655 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1657 int rc = LDAP_SERVER_DOWN;
1660 time_t abs_endtime = calc_ldap_abs_endtime(lp_ldap_timeout());
1661 size_t converted_size;
1663 SMB_ASSERT(ldap_state);
1665 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1667 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1668 return LDAP_NO_MEMORY;
1671 setup_ldap_local_alarm(ldap_state, abs_endtime);
1673 while (another_ldap_try(ldap_state, &rc, &attempts, abs_endtime)) {
1674 char *ld_error = NULL;
1677 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1678 if (rc == LDAP_SUCCESS) {
1682 get_ldap_errs(ldap_state, &ld_error, &ld_errno);
1684 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1685 "(%s)\n", dn, ld_errno,
1686 ldap_err2string(rc),
1687 ld_error ? ld_error : "unknown"));
1688 SAFE_FREE(ld_error);
1690 if (ld_errno == LDAP_SERVER_DOWN) {
1691 ldap_unbind(ldap_state->ldap_struct);
1692 ldap_state->ldap_struct = NULL;
1696 TALLOC_FREE(utf8_dn);
1697 return end_ldap_local_alarm(abs_endtime, rc);
1700 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1702 int rc = LDAP_SERVER_DOWN;
1705 time_t abs_endtime = calc_ldap_abs_endtime(lp_ldap_timeout());
1706 size_t converted_size;
1708 SMB_ASSERT(ldap_state);
1710 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1712 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1713 return LDAP_NO_MEMORY;
1716 setup_ldap_local_alarm(ldap_state, abs_endtime);
1718 while (another_ldap_try(ldap_state, &rc, &attempts, abs_endtime)) {
1719 char *ld_error = NULL;
1722 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1723 if (rc == LDAP_SUCCESS) {
1727 get_ldap_errs(ldap_state, &ld_error, &ld_errno);
1729 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1730 "(%s)\n", dn, ld_errno,
1731 ldap_err2string(rc),
1732 ld_error ? ld_error : "unknown"));
1733 SAFE_FREE(ld_error);
1735 if (ld_errno == LDAP_SERVER_DOWN) {
1736 ldap_unbind(ldap_state->ldap_struct);
1737 ldap_state->ldap_struct = NULL;
1741 TALLOC_FREE(utf8_dn);
1742 return end_ldap_local_alarm(abs_endtime, rc);
1745 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1747 int rc = LDAP_SERVER_DOWN;
1750 time_t abs_endtime = calc_ldap_abs_endtime(lp_ldap_timeout());
1751 size_t converted_size;
1753 SMB_ASSERT(ldap_state);
1755 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1757 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1758 return LDAP_NO_MEMORY;
1761 setup_ldap_local_alarm(ldap_state, abs_endtime);
1763 while (another_ldap_try(ldap_state, &rc, &attempts, abs_endtime)) {
1764 char *ld_error = NULL;
1767 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1768 if (rc == LDAP_SUCCESS) {
1772 get_ldap_errs(ldap_state, &ld_error, &ld_errno);
1774 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1775 "(%s)\n", dn, ld_errno,
1776 ldap_err2string(rc),
1777 ld_error ? ld_error : "unknown"));
1778 SAFE_FREE(ld_error);
1780 if (ld_errno == LDAP_SERVER_DOWN) {
1781 ldap_unbind(ldap_state->ldap_struct);
1782 ldap_state->ldap_struct = NULL;
1786 TALLOC_FREE(utf8_dn);
1787 return end_ldap_local_alarm(abs_endtime, rc);
1790 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1791 LDAP_CONST char *reqoid, struct berval *reqdata,
1792 LDAPControl **serverctrls, LDAPControl **clientctrls,
1793 char **retoidp, struct berval **retdatap)
1795 int rc = LDAP_SERVER_DOWN;
1797 time_t abs_endtime = calc_ldap_abs_endtime(lp_ldap_timeout());
1802 setup_ldap_local_alarm(ldap_state, abs_endtime);
1804 while (another_ldap_try(ldap_state, &rc, &attempts, abs_endtime)) {
1805 char *ld_error = NULL;
1808 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1809 reqdata, serverctrls,
1810 clientctrls, retoidp, retdatap);
1811 if (rc == LDAP_SUCCESS) {
1815 get_ldap_errs(ldap_state, &ld_error, &ld_errno);
1817 DEBUG(10, ("Extended operation failed with error: "
1818 "%d (%s) (%s)\n", ld_errno,
1819 ldap_err2string(rc),
1820 ld_error ? ld_error : "unknown"));
1821 SAFE_FREE(ld_error);
1823 if (ld_errno == LDAP_SERVER_DOWN) {
1824 ldap_unbind(ldap_state->ldap_struct);
1825 ldap_state->ldap_struct = NULL;
1829 return end_ldap_local_alarm(abs_endtime, rc);
1832 /*******************************************************************
1833 run the search by name.
1834 ******************************************************************/
1835 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1836 const char *filter, const char **search_attr,
1837 LDAPMessage ** result)
1839 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1840 filter, search_attr, 0, result);
1843 static void smbldap_idle_fn(struct event_context *event_ctx,
1844 struct timed_event *te,
1845 struct timeval now_abs,
1848 struct smbldap_state *state = (struct smbldap_state *)private_data;
1850 TALLOC_FREE(state->idle_event);
1852 if (state->ldap_struct == NULL) {
1853 DEBUG(10,("ldap connection not connected...\n"));
1857 if ((state->last_use+SMBLDAP_IDLE_TIME) > time_mono(NULL)) {
1858 DEBUG(10,("ldap connection not idle...\n"));
1860 /* this needs to be made monotonic clock aware inside tevent: */
1861 state->idle_event = event_add_timed(
1863 timeval_add(&now_abs, SMBLDAP_IDLE_TIME, 0),
1869 DEBUG(7,("ldap connection idle...closing connection\n"));
1870 smbldap_close(state);
1873 /**********************************************************************
1875 *********************************************************************/
1877 void smbldap_free_struct(struct smbldap_state **ldap_state)
1879 smbldap_close(*ldap_state);
1881 if ((*ldap_state)->bind_secret) {
1882 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1885 SAFE_FREE((*ldap_state)->bind_dn);
1886 SAFE_FREE((*ldap_state)->bind_secret);
1888 TALLOC_FREE(*ldap_state);
1890 /* No need to free any further, as it is talloc()ed */
1893 static int smbldap_state_destructor(struct smbldap_state *state)
1895 smbldap_free_struct(&state);
1900 /**********************************************************************
1901 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1902 *********************************************************************/
1904 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1905 const char *location,
1906 struct smbldap_state **smbldap_state)
1908 *smbldap_state = talloc_zero(mem_ctx, struct smbldap_state);
1909 if (!*smbldap_state) {
1910 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1911 return NT_STATUS_NO_MEMORY;
1915 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1917 (*smbldap_state)->uri = "ldap://localhost";
1920 (*smbldap_state)->event_context = event_ctx;
1922 talloc_set_destructor(*smbldap_state, smbldap_state_destructor);
1923 return NT_STATUS_OK;
1926 char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1929 char *utf8_dn, *unix_dn;
1930 size_t converted_size;
1932 utf8_dn = ldap_get_dn(ld, entry);
1934 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1937 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1938 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1939 "[%s]\n", utf8_dn));
1942 ldap_memfree(utf8_dn);
1946 /*******************************************************************
1947 Check if root-dse has a certain Control or Extension
1948 ********************************************************************/
1950 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1952 LDAPMessage *msg = NULL;
1953 LDAPMessage *entry = NULL;
1954 char **values = NULL;
1955 int rc, num_result, num_values, i;
1956 bool result = False;
1959 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1963 if (!strequal(attrs[0], "supportedExtension") &&
1964 !strequal(attrs[0], "supportedControl") &&
1965 !strequal(attrs[0], "namingContexts")) {
1966 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1970 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1971 "(objectclass=*)", discard_const_p(char *, attrs), 0 , &msg);
1973 if (rc != LDAP_SUCCESS) {
1974 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1978 num_result = ldap_count_entries(ld, msg);
1980 if (num_result != 1) {
1981 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1985 entry = ldap_first_entry(ld, msg);
1987 if (entry == NULL) {
1988 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1992 values = ldap_get_values(ld, entry, attrs[0]);
1994 if (values == NULL) {
1995 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1999 num_values = ldap_count_values(values);
2001 if (num_values == 0) {
2002 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
2006 for (i=0; i<num_values; i++) {
2007 if (strcmp(values[i], value) == 0)
2014 ldap_value_free(values);
2022 /*******************************************************************
2023 Check if LDAP-Server supports a certain Control (OID in string format)
2024 ********************************************************************/
2026 bool smbldap_has_control(LDAP *ld, const char *control)
2028 const char *attrs[] = { "supportedControl", NULL };
2029 return smbldap_check_root_dse(ld, attrs, control);
2032 /*******************************************************************
2033 Check if LDAP-Server supports a certain Extension (OID in string format)
2034 ********************************************************************/
2036 bool smbldap_has_extension(LDAP *ld, const char *extension)
2038 const char *attrs[] = { "supportedExtension", NULL };
2039 return smbldap_check_root_dse(ld, attrs, extension);
2042 /*******************************************************************
2043 Check if LDAP-Server holds a given namingContext
2044 ********************************************************************/
2046 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
2048 const char *attrs[] = { "namingContexts", NULL };
2049 return smbldap_check_root_dse(ld, attrs, naming_context);
2052 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
2054 ldap_state->anonymous = anon;
2056 /* free any previously set credential */
2058 SAFE_FREE(ldap_state->bind_dn);
2059 if (ldap_state->bind_secret) {
2060 /* make sure secrets are zeroed out of memory */
2061 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
2062 SAFE_FREE(ldap_state->bind_secret);
2066 ldap_state->bind_dn = SMB_STRDUP(dn);
2067 ldap_state->bind_secret = SMB_STRDUP(secret);