s3:smbldap: add smbldap_talloc_first_attribute()
[Samba.git] / source / lib / smbldap.c
blob6678ad9b8d0dca4a43c00855db3faff6a908dfdb
1 /*
2 Unix SMB/CIFS implementation.
3 LDAP protocol helper functions for SAMBA
4 Copyright (C) Jean François Micouleau 1998
5 Copyright (C) Gerald Carter 2001-2003
6 Copyright (C) Shahms King 2001
7 Copyright (C) Andrew Bartlett 2002-2003
8 Copyright (C) Stefan (metze) Metzmacher 2002-2003
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/>.
25 #include "includes.h"
26 #include "smbldap.h"
28 #ifndef LDAP_OPT_SUCCESS
29 #define LDAP_OPT_SUCCESS 0
30 #endif
32 /* Try not to hit the up or down server forever */
34 #define SMBLDAP_DONT_PING_TIME 10 /* ping only all 10 seconds */
35 #define SMBLDAP_NUM_RETRIES 8 /* retry only 8 times */
37 #define SMBLDAP_IDLE_TIME 150 /* After 2.5 minutes disconnect */
40 /* attributes used by Samba 2.2 */
42 ATTRIB_MAP_ENTRY attrib_map_v22[] = {
43 { LDAP_ATTR_UID, "uid" },
44 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
45 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
46 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
47 { LDAP_ATTR_PWD_LAST_SET, "pwdLastSet" },
48 { LDAP_ATTR_PWD_CAN_CHANGE, "pwdCanChange" },
49 { LDAP_ATTR_PWD_MUST_CHANGE, "pwdMustChange" },
50 { LDAP_ATTR_LOGON_TIME, "logonTime" },
51 { LDAP_ATTR_LOGOFF_TIME, "logoffTime" },
52 { LDAP_ATTR_KICKOFF_TIME, "kickoffTime" },
53 { LDAP_ATTR_CN, "cn" },
54 { LDAP_ATTR_SN, "sn" },
55 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
56 { LDAP_ATTR_HOME_PATH, "smbHome" },
57 { LDAP_ATTR_HOME_DRIVE, "homeDrive" },
58 { LDAP_ATTR_LOGON_SCRIPT, "scriptPath" },
59 { LDAP_ATTR_PROFILE_PATH, "profilePath" },
60 { LDAP_ATTR_DESC, "description" },
61 { LDAP_ATTR_USER_WKS, "userWorkstations"},
62 { LDAP_ATTR_USER_RID, "rid" },
63 { LDAP_ATTR_PRIMARY_GROUP_RID, "primaryGroupID"},
64 { LDAP_ATTR_LMPW, "lmPassword" },
65 { LDAP_ATTR_NTPW, "ntPassword" },
66 { LDAP_ATTR_DOMAIN, "domain" },
67 { LDAP_ATTR_OBJCLASS, "objectClass" },
68 { LDAP_ATTR_ACB_INFO, "acctFlags" },
69 { LDAP_ATTR_MOD_TIMESTAMP, "modifyTimestamp" },
70 { LDAP_ATTR_LIST_END, NULL }
73 ATTRIB_MAP_ENTRY attrib_map_to_delete_v22[] = {
74 { LDAP_ATTR_PWD_LAST_SET, "pwdLastSet" },
75 { LDAP_ATTR_PWD_CAN_CHANGE, "pwdCanChange" },
76 { LDAP_ATTR_PWD_MUST_CHANGE, "pwdMustChange" },
77 { LDAP_ATTR_LOGON_TIME, "logonTime" },
78 { LDAP_ATTR_LOGOFF_TIME, "logoffTime" },
79 { LDAP_ATTR_KICKOFF_TIME, "kickoffTime" },
80 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
81 { LDAP_ATTR_HOME_PATH, "smbHome" },
82 { LDAP_ATTR_HOME_DRIVE, "homeDrives" },
83 { LDAP_ATTR_LOGON_SCRIPT, "scriptPath" },
84 { LDAP_ATTR_PROFILE_PATH, "profilePath" },
85 { LDAP_ATTR_USER_WKS, "userWorkstations"},
86 { LDAP_ATTR_USER_RID, "rid" },
87 { LDAP_ATTR_PRIMARY_GROUP_RID, "primaryGroupID"},
88 { LDAP_ATTR_LMPW, "lmPassword" },
89 { LDAP_ATTR_NTPW, "ntPassword" },
90 { LDAP_ATTR_DOMAIN, "domain" },
91 { LDAP_ATTR_ACB_INFO, "acctFlags" },
92 { LDAP_ATTR_LIST_END, NULL }
95 /* attributes used by Samba 3.0's sambaSamAccount */
97 ATTRIB_MAP_ENTRY attrib_map_v30[] = {
98 { LDAP_ATTR_UID, "uid" },
99 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
100 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
101 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
102 { LDAP_ATTR_PWD_LAST_SET, "sambaPwdLastSet" },
103 { LDAP_ATTR_PWD_CAN_CHANGE, "sambaPwdCanChange" },
104 { LDAP_ATTR_PWD_MUST_CHANGE, "sambaPwdMustChange" },
105 { LDAP_ATTR_LOGON_TIME, "sambaLogonTime" },
106 { LDAP_ATTR_LOGOFF_TIME, "sambaLogoffTime" },
107 { LDAP_ATTR_KICKOFF_TIME, "sambaKickoffTime" },
108 { LDAP_ATTR_CN, "cn" },
109 { LDAP_ATTR_SN, "sn" },
110 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
111 { LDAP_ATTR_HOME_DRIVE, "sambaHomeDrive" },
112 { LDAP_ATTR_HOME_PATH, "sambaHomePath" },
113 { LDAP_ATTR_LOGON_SCRIPT, "sambaLogonScript" },
114 { LDAP_ATTR_PROFILE_PATH, "sambaProfilePath" },
115 { LDAP_ATTR_DESC, "description" },
116 { LDAP_ATTR_USER_WKS, "sambaUserWorkstations" },
117 { LDAP_ATTR_USER_SID, LDAP_ATTRIBUTE_SID },
118 { LDAP_ATTR_PRIMARY_GROUP_SID, "sambaPrimaryGroupSID" },
119 { LDAP_ATTR_LMPW, "sambaLMPassword" },
120 { LDAP_ATTR_NTPW, "sambaNTPassword" },
121 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
122 { LDAP_ATTR_OBJCLASS, "objectClass" },
123 { LDAP_ATTR_ACB_INFO, "sambaAcctFlags" },
124 { LDAP_ATTR_MUNGED_DIAL, "sambaMungedDial" },
125 { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
126 { LDAP_ATTR_BAD_PASSWORD_TIME, "sambaBadPasswordTime" },
127 { LDAP_ATTR_PWD_HISTORY, "sambaPasswordHistory" },
128 { LDAP_ATTR_MOD_TIMESTAMP, "modifyTimestamp" },
129 { LDAP_ATTR_LOGON_HOURS, "sambaLogonHours" },
130 { LDAP_ATTR_LIST_END, NULL }
133 ATTRIB_MAP_ENTRY attrib_map_to_delete_v30[] = {
134 { LDAP_ATTR_PWD_LAST_SET, "sambaPwdLastSet" },
135 { LDAP_ATTR_PWD_CAN_CHANGE, "sambaPwdCanChange" },
136 { LDAP_ATTR_PWD_MUST_CHANGE, "sambaPwdMustChange" },
137 { LDAP_ATTR_LOGON_TIME, "sambaLogonTime" },
138 { LDAP_ATTR_LOGOFF_TIME, "sambaLogoffTime" },
139 { LDAP_ATTR_KICKOFF_TIME, "sambaKickoffTime" },
140 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
141 { LDAP_ATTR_HOME_DRIVE, "sambaHomeDrive" },
142 { LDAP_ATTR_HOME_PATH, "sambaHomePath" },
143 { LDAP_ATTR_LOGON_SCRIPT, "sambaLogonScript" },
144 { LDAP_ATTR_PROFILE_PATH, "sambaProfilePath" },
145 { LDAP_ATTR_USER_WKS, "sambaUserWorkstations" },
146 { LDAP_ATTR_USER_SID, LDAP_ATTRIBUTE_SID },
147 { LDAP_ATTR_PRIMARY_GROUP_SID, "sambaPrimaryGroupSID" },
148 { LDAP_ATTR_LMPW, "sambaLMPassword" },
149 { LDAP_ATTR_NTPW, "sambaNTPassword" },
150 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
151 { LDAP_ATTR_ACB_INFO, "sambaAcctFlags" },
152 { LDAP_ATTR_MUNGED_DIAL, "sambaMungedDial" },
153 { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
154 { LDAP_ATTR_BAD_PASSWORD_TIME, "sambaBadPasswordTime" },
155 { LDAP_ATTR_PWD_HISTORY, "sambaPasswordHistory" },
156 { LDAP_ATTR_LOGON_HOURS, "sambaLogonHours" },
157 { LDAP_ATTR_LIST_END, NULL }
160 /* attributes used for allocating RIDs */
162 ATTRIB_MAP_ENTRY dominfo_attr_list[] = {
163 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
164 { LDAP_ATTR_NEXT_RID, "sambaNextRid" },
165 { LDAP_ATTR_NEXT_USERRID, "sambaNextUserRid" },
166 { LDAP_ATTR_NEXT_GROUPRID, "sambaNextGroupRid" },
167 { LDAP_ATTR_DOM_SID, LDAP_ATTRIBUTE_SID },
168 { LDAP_ATTR_ALGORITHMIC_RID_BASE,"sambaAlgorithmicRidBase"},
169 { LDAP_ATTR_OBJCLASS, "objectClass" },
170 { LDAP_ATTR_LIST_END, NULL },
173 /* Samba 3.0 group mapping attributes */
175 ATTRIB_MAP_ENTRY groupmap_attr_list[] = {
176 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
177 { LDAP_ATTR_GROUP_SID, LDAP_ATTRIBUTE_SID },
178 { LDAP_ATTR_GROUP_TYPE, "sambaGroupType" },
179 { LDAP_ATTR_SID_LIST, "sambaSIDList" },
180 { LDAP_ATTR_DESC, "description" },
181 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
182 { LDAP_ATTR_CN, "cn" },
183 { LDAP_ATTR_OBJCLASS, "objectClass" },
184 { LDAP_ATTR_LIST_END, NULL }
187 ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete[] = {
188 { LDAP_ATTR_GROUP_SID, LDAP_ATTRIBUTE_SID },
189 { LDAP_ATTR_GROUP_TYPE, "sambaGroupType" },
190 { LDAP_ATTR_DESC, "description" },
191 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
192 { LDAP_ATTR_SID_LIST, "sambaSIDList" },
193 { LDAP_ATTR_LIST_END, NULL }
196 /* idmap_ldap sambaUnixIdPool */
198 ATTRIB_MAP_ENTRY idpool_attr_list[] = {
199 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
200 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
201 { LDAP_ATTR_OBJCLASS, "objectClass" },
202 { LDAP_ATTR_LIST_END, NULL }
205 ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
206 { LDAP_ATTR_SID, LDAP_ATTRIBUTE_SID },
207 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
208 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
209 { LDAP_ATTR_OBJCLASS, "objectClass" },
210 { LDAP_ATTR_LIST_END, NULL }
213 /**********************************************************************
214 perform a simple table lookup and return the attribute name
215 **********************************************************************/
217 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table[], int key )
219 int i = 0;
221 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
222 if ( table[i].attrib == key )
223 return table[i].name;
224 i++;
227 return NULL;
231 /**********************************************************************
232 Return the list of attribute names from a mapping table
233 **********************************************************************/
235 const char** get_attr_list( TALLOC_CTX *mem_ctx, ATTRIB_MAP_ENTRY table[] )
237 const char **names;
238 int i = 0;
240 while ( table[i].attrib != LDAP_ATTR_LIST_END )
241 i++;
242 i++;
244 names = TALLOC_ARRAY( mem_ctx, const char*, i );
245 if ( !names ) {
246 DEBUG(0,("get_attr_list: out of memory\n"));
247 return NULL;
250 i = 0;
251 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
252 names[i] = talloc_strdup( names, table[i].name );
253 i++;
255 names[i] = NULL;
257 return names;
260 /*******************************************************************
261 Search an attribute and return the first value found.
262 ******************************************************************/
264 bool smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
265 const char *attribute, char *value,
266 int max_len)
268 char **values;
270 if ( !attribute )
271 return False;
273 value[0] = '\0';
275 if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
276 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
278 return False;
281 if (convert_string(CH_UTF8, CH_UNIX,values[0], -1, value, max_len, False) == (size_t)-1) {
282 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
283 attribute, values[0]));
284 ldap_value_free(values);
285 return False;
288 ldap_value_free(values);
289 #ifdef DEBUG_PASSWORDS
290 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
291 #endif
292 return True;
295 char * smbldap_talloc_single_attribute(LDAP *ldap_struct, LDAPMessage *entry,
296 const char *attribute,
297 TALLOC_CTX *mem_ctx)
299 char **values;
300 char *result;
301 size_t converted_size;
303 if (attribute == NULL) {
304 return NULL;
307 values = ldap_get_values(ldap_struct, entry, attribute);
309 if (values == NULL) {
310 DEBUG(10, ("attribute %s does not exist\n", attribute));
311 return NULL;
314 if (ldap_count_values(values) != 1) {
315 DEBUG(10, ("attribute %s has %d values, expected only one\n",
316 attribute, ldap_count_values(values)));
317 ldap_value_free(values);
318 return NULL;
321 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
322 DEBUG(10, ("pull_utf8_talloc failed\n"));
323 ldap_value_free(values);
324 return NULL;
327 ldap_value_free(values);
329 #ifdef DEBUG_PASSWORDS
330 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
331 attribute, result));
332 #endif
333 return result;
336 char * smbldap_talloc_first_attribute(LDAP *ldap_struct, LDAPMessage *entry,
337 const char *attribute,
338 TALLOC_CTX *mem_ctx)
340 char **values;
341 char *result;
342 size_t converted_size;
344 if (attribute == NULL) {
345 return NULL;
348 values = ldap_get_values(ldap_struct, entry, attribute);
350 if (values == NULL) {
351 DEBUG(10, ("attribute %s does not exist\n", attribute));
352 return NULL;
355 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
356 DEBUG(10, ("pull_utf8_talloc failed\n"));
357 ldap_value_free(values);
358 return NULL;
361 ldap_value_free(values);
363 #ifdef DEBUG_PASSWORDS
364 DEBUG (100, ("smbldap_get_first_attribute: [%s] = [%s]\n",
365 attribute, result));
366 #endif
367 return result;
370 char * smbldap_talloc_smallest_attribute(LDAP *ldap_struct, LDAPMessage *entry,
371 const char *attribute,
372 TALLOC_CTX *mem_ctx)
374 char **values;
375 char *result;
376 size_t converted_size;
377 int i, num_values;
379 if (attribute == NULL) {
380 return NULL;
383 values = ldap_get_values(ldap_struct, entry, attribute);
385 if (values == NULL) {
386 DEBUG(10, ("attribute %s does not exist\n", attribute));
387 return NULL;
390 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
391 DEBUG(10, ("pull_utf8_talloc failed\n"));
392 ldap_value_free(values);
393 return NULL;
396 num_values = ldap_count_values(values);
398 for (i=1; i<num_values; i++) {
399 char *tmp;
401 if (!pull_utf8_talloc(mem_ctx, &tmp, values[i],
402 &converted_size)) {
403 DEBUG(10, ("pull_utf8_talloc failed\n"));
404 TALLOC_FREE(result);
405 ldap_value_free(values);
406 return NULL;
409 if (StrCaseCmp(tmp, result) < 0) {
410 TALLOC_FREE(result);
411 result = tmp;
412 } else {
413 TALLOC_FREE(tmp);
417 ldap_value_free(values);
419 #ifdef DEBUG_PASSWORDS
420 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
421 attribute, result));
422 #endif
423 return result;
426 static int ldapmsg_destructor(LDAPMessage **result) {
427 ldap_msgfree(*result);
428 return 0;
431 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
433 LDAPMessage **handle;
435 if (result == NULL) {
436 return;
439 handle = TALLOC_P(mem_ctx, LDAPMessage *);
440 SMB_ASSERT(handle != NULL);
442 *handle = result;
443 talloc_set_destructor(handle, ldapmsg_destructor);
446 static int ldapmod_destructor(LDAPMod ***mod) {
447 ldap_mods_free(*mod, True);
448 return 0;
451 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
453 LDAPMod ***handle;
455 if (mod == NULL) {
456 return;
459 handle = TALLOC_P(mem_ctx, LDAPMod **);
460 SMB_ASSERT(handle != NULL);
462 *handle = mod;
463 talloc_set_destructor(handle, ldapmod_destructor);
466 /************************************************************************
467 Routine to manage the LDAPMod structure array
468 manage memory used by the array, by each struct, and values
469 ***********************************************************************/
471 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
473 LDAPMod **mods;
474 int i;
475 int j;
477 mods = *modlist;
479 /* sanity checks on the mod values */
481 if (attribute == NULL || *attribute == '\0') {
482 return;
485 #if 0 /* commented out after discussion with abartlet. Do not reenable.
486 left here so other do not re-add similar code --jerry */
487 if (value == NULL || *value == '\0')
488 return;
489 #endif
491 if (mods == NULL) {
492 mods = SMB_MALLOC_P(LDAPMod *);
493 if (mods == NULL) {
494 smb_panic("smbldap_set_mod: out of memory!");
495 /* notreached. */
497 mods[0] = NULL;
500 for (i = 0; mods[i] != NULL; ++i) {
501 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
502 break;
505 if (mods[i] == NULL) {
506 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
507 if (mods == NULL) {
508 smb_panic("smbldap_set_mod: out of memory!");
509 /* notreached. */
511 mods[i] = SMB_MALLOC_P(LDAPMod);
512 if (mods[i] == NULL) {
513 smb_panic("smbldap_set_mod: out of memory!");
514 /* notreached. */
516 mods[i]->mod_op = modop;
517 mods[i]->mod_values = NULL;
518 mods[i]->mod_type = SMB_STRDUP(attribute);
519 mods[i + 1] = NULL;
522 if (value != NULL) {
523 char *utf8_value = NULL;
524 size_t converted_size;
526 j = 0;
527 if (mods[i]->mod_values != NULL) {
528 for (; mods[i]->mod_values[j] != NULL; j++);
530 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
532 if (mods[i]->mod_values == NULL) {
533 smb_panic("smbldap_set_mod: out of memory!");
534 /* notreached. */
537 if (!push_utf8_allocate(&utf8_value, value, &converted_size)) {
538 smb_panic("smbldap_set_mod: String conversion failure!");
539 /* notreached. */
542 mods[i]->mod_values[j] = utf8_value;
544 mods[i]->mod_values[j + 1] = NULL;
546 *modlist = mods;
549 /**********************************************************************
550 Set attribute to newval in LDAP, regardless of what value the
551 attribute had in LDAP before.
552 *********************************************************************/
554 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
555 LDAPMod ***mods,
556 const char *attribute, const char *newval)
558 char oldval[2048]; /* current largest allowed value is mungeddial */
559 bool existed;
561 if (attribute == NULL) {
562 /* This can actually happen for ldapsam_compat where we for
563 * example don't have a password history */
564 return;
567 if (existing != NULL) {
568 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
569 } else {
570 existed = False;
571 *oldval = '\0';
574 /* all of our string attributes are case insensitive */
576 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
578 /* Believe it or not, but LDAP will deny a delete and
579 an add at the same time if the values are the
580 same... */
581 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
582 return;
585 if (existed) {
586 /* There has been no value before, so don't delete it.
587 * Here's a possible race: We might end up with
588 * duplicate attributes */
589 /* By deleting exactly the value we found in the entry this
590 * should be race-free in the sense that the LDAP-Server will
591 * deny the complete operation if somebody changed the
592 * attribute behind our back. */
593 /* This will also allow modifying single valued attributes
594 * in Novell NDS. In NDS you have to first remove attribute and then
595 * you could add new value */
597 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
598 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
601 /* Regardless of the real operation (add or modify)
602 we add the new value here. We rely on deleting
603 the old value, should it exist. */
605 if ((newval != NULL) && (strlen(newval) > 0)) {
606 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
607 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
611 /**********************************************************************
612 Some varients of the LDAP rebind code do not pass in the third 'arg'
613 pointer to a void*, so we try and work around it by assuming that the
614 value of the 'LDAP *' pointer is the same as the one we had passed in
615 **********************************************************************/
617 struct smbldap_state_lookup {
618 LDAP *ld;
619 struct smbldap_state *smbldap_state;
620 struct smbldap_state_lookup *prev, *next;
623 static struct smbldap_state_lookup *smbldap_state_lookup_list;
625 static struct smbldap_state *smbldap_find_state(LDAP *ld)
627 struct smbldap_state_lookup *t;
629 for (t = smbldap_state_lookup_list; t; t = t->next) {
630 if (t->ld == ld) {
631 return t->smbldap_state;
634 return NULL;
637 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
639 struct smbldap_state_lookup *t;
641 for (t = smbldap_state_lookup_list; t; t = t->next) {
642 if (t->smbldap_state == smbldap_state) {
643 DLIST_REMOVE(smbldap_state_lookup_list, t);
644 SAFE_FREE(t);
645 return;
650 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
652 struct smbldap_state *tmp_ldap_state;
653 struct smbldap_state_lookup *t;
655 if ((tmp_ldap_state = smbldap_find_state(ld))) {
656 SMB_ASSERT(tmp_ldap_state == smbldap_state);
657 return;
660 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
661 ZERO_STRUCTP(t);
663 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
664 t->ld = ld;
665 t->smbldap_state = smbldap_state;
668 /********************************************************************
669 start TLS on an existing LDAP connection
670 *******************************************************************/
672 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
674 #ifdef LDAP_OPT_X_TLS
675 int rc;
676 #endif
678 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
679 return LDAP_SUCCESS;
682 #ifdef LDAP_OPT_X_TLS
683 if (version != LDAP_VERSION3) {
684 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
685 return LDAP_OPERATIONS_ERROR;
688 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
689 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
690 ldap_err2string(rc)));
691 return rc;
694 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
695 return LDAP_SUCCESS;
696 #else
697 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
698 return LDAP_OPERATIONS_ERROR;
699 #endif
702 /********************************************************************
703 setup a connection to the LDAP server based on a uri
704 *******************************************************************/
706 int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
708 int rc;
710 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
712 #ifdef HAVE_LDAP_INITIALIZE
714 rc = ldap_initialize(ldap_struct, uri);
715 if (rc) {
716 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
719 return rc;
720 #else
722 /* Parse the string manually */
725 int port = 0;
726 fstring protocol;
727 fstring host;
728 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
731 /* skip leading "URL:" (if any) */
732 if ( strnequal( uri, "URL:", 4 ) ) {
733 uri += 4;
736 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
738 if (port == 0) {
739 if (strequal(protocol, "ldap")) {
740 port = LDAP_PORT;
741 } else if (strequal(protocol, "ldaps")) {
742 port = LDAPS_PORT;
743 } else {
744 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
748 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
749 DEBUG(0, ("ldap_init failed !\n"));
750 return LDAP_OPERATIONS_ERROR;
753 if (strequal(protocol, "ldaps")) {
754 #ifdef LDAP_OPT_X_TLS
755 int tls = LDAP_OPT_X_TLS_HARD;
756 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
758 DEBUG(0, ("Failed to setup a TLS session\n"));
761 DEBUG(3,("LDAPS option set...!\n"));
762 #else
763 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
764 return LDAP_OPERATIONS_ERROR;
765 #endif /* LDAP_OPT_X_TLS */
768 #endif /* HAVE_LDAP_INITIALIZE */
771 /* now set connection timeout */
772 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
774 int ct = lp_ldap_connection_timeout()*1000;
775 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
776 if (rc != LDAP_SUCCESS) {
777 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
778 ct, ldap_err2string(rc)));
781 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
783 struct timeval ct;
784 ct.tv_usec = 0;
785 ct.tv_sec = lp_ldap_connection_timeout();
786 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
787 if (rc != LDAP_SUCCESS) {
788 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
789 (int)ct.tv_sec, ldap_err2string(rc)));
792 #endif
794 return LDAP_SUCCESS;
797 /********************************************************************
798 try to upgrade to Version 3 LDAP if not already, in either case return current
799 version
800 *******************************************************************/
802 int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
804 int version;
805 int rc;
807 /* assume the worst */
808 *new_version = LDAP_VERSION2;
810 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
811 if (rc) {
812 return rc;
815 if (version == LDAP_VERSION3) {
816 *new_version = LDAP_VERSION3;
817 return LDAP_SUCCESS;
820 /* try upgrade */
821 version = LDAP_VERSION3;
822 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
823 if (rc) {
824 return rc;
827 *new_version = LDAP_VERSION3;
828 return LDAP_SUCCESS;
831 /*******************************************************************
832 open a connection to the ldap server (just until the bind)
833 ******************************************************************/
835 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
837 int rc, version;
839 rc = smb_ldap_setup_conn(ldap_struct, uri);
840 if (rc) {
841 return rc;
844 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
845 if (rc) {
846 return rc;
849 rc = smb_ldap_start_tls(*ldap_struct, version);
850 if (rc) {
851 return rc;
854 return LDAP_SUCCESS;
857 /*******************************************************************
858 open a connection to the ldap server.
859 ******************************************************************/
860 static int smbldap_open_connection (struct smbldap_state *ldap_state)
863 int rc = LDAP_SUCCESS;
864 int version;
865 LDAP **ldap_struct = &ldap_state->ldap_struct;
867 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
868 if (rc) {
869 return rc;
872 /* Store the LDAP pointer in a lookup list */
874 smbldap_store_state(*ldap_struct, ldap_state);
876 /* Upgrade to LDAPv3 if possible */
878 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
879 if (rc) {
880 return rc;
883 /* Start TLS if required */
885 rc = smb_ldap_start_tls(*ldap_struct, version);
886 if (rc) {
887 return rc;
890 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
891 return rc;
894 /*******************************************************************
895 a rebind function for authenticated referrals
896 This version takes a void* that we can shove useful stuff in :-)
897 ******************************************************************/
898 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
899 #else
900 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
901 int *methodp, int freeit, void *arg)
903 struct smbldap_state *ldap_state = arg;
905 /** @TODO Should we be doing something to check what servers we rebind to?
906 Could we get a referral to a machine that we don't want to give our
907 username and password to? */
909 if (freeit) {
910 SAFE_FREE(*whop);
911 if (*credp) {
912 memset(*credp, '\0', strlen(*credp));
914 SAFE_FREE(*credp);
915 } else {
916 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
917 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
919 if (ldap_state->anonymous) {
920 *whop = NULL;
921 *credp = NULL;
922 } else {
923 *whop = SMB_STRDUP(ldap_state->bind_dn);
924 if (!*whop) {
925 return LDAP_NO_MEMORY;
927 *credp = SMB_STRDUP(ldap_state->bind_secret);
928 if (!*credp) {
929 SAFE_FREE(*whop);
930 return LDAP_NO_MEMORY;
933 *methodp = LDAP_AUTH_SIMPLE;
936 GetTimeOfDay(&ldap_state->last_rebind);
938 return 0;
940 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
942 /*******************************************************************
943 a rebind function for authenticated referrals
944 This version takes a void* that we can shove useful stuff in :-)
945 and actually does the connection.
946 ******************************************************************/
947 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
948 static int rebindproc_connect_with_state (LDAP *ldap_struct,
949 LDAP_CONST char *url,
950 ber_tag_t request,
951 ber_int_t msgid, void *arg)
953 struct smbldap_state *ldap_state =
954 (struct smbldap_state *)arg;
955 int rc;
956 int version;
958 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
959 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
961 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
962 * itself) before rebinding to another LDAP server to avoid to expose
963 * our credentials. At least *try* to secure the connection - Guenther */
965 smb_ldap_upgrade_conn(ldap_struct, &version);
966 smb_ldap_start_tls(ldap_struct, version);
968 /** @TODO Should we be doing something to check what servers we rebind to?
969 Could we get a referral to a machine that we don't want to give our
970 username and password to? */
972 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
974 /* only set the last rebind timestamp when we did rebind after a
975 * non-read LDAP operation. That way we avoid the replication sleep
976 * after a simple redirected search operation - Guenther */
978 switch (request) {
980 case LDAP_REQ_MODIFY:
981 case LDAP_REQ_ADD:
982 case LDAP_REQ_DELETE:
983 case LDAP_REQ_MODDN:
984 case LDAP_REQ_EXTENDED:
985 DEBUG(10,("rebindproc_connect_with_state: "
986 "setting last_rebind timestamp "
987 "(req: 0x%02x)\n", (unsigned int)request));
988 GetTimeOfDay(&ldap_state->last_rebind);
989 break;
990 default:
991 ZERO_STRUCT(ldap_state->last_rebind);
992 break;
995 return rc;
997 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
999 /*******************************************************************
1000 Add a rebind function for authenticated referrals
1001 ******************************************************************/
1002 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1003 #else
1004 # if LDAP_SET_REBIND_PROC_ARGS == 2
1005 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
1006 int *method, int freeit )
1008 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
1010 return rebindproc_with_state(ldap_struct, whop, credp,
1011 method, freeit, ldap_state);
1014 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1015 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1017 /*******************************************************************
1018 a rebind function for authenticated referrals
1019 this also does the connection, but no void*.
1020 ******************************************************************/
1021 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1022 # if LDAP_SET_REBIND_PROC_ARGS == 2
1023 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
1024 ber_int_t msgid)
1026 struct smbldap_state *ldap_state = smbldap_find_state(ld);
1028 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
1029 ldap_state);
1031 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1032 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1034 /*******************************************************************
1035 connect to the ldap server under system privilege.
1036 ******************************************************************/
1037 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
1039 int rc;
1040 int version;
1042 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
1044 /* get the default dn and password only if they are not set already */
1045 if (!fetch_ldap_pw(&ldap_state->bind_dn, &ldap_state->bind_secret)) {
1046 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
1047 return LDAP_INVALID_CREDENTIALS;
1051 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
1052 (OpenLDAP) doesnt' seem to support it */
1054 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
1055 ldap_state->uri, ldap_state->bind_dn));
1057 #ifdef HAVE_LDAP_SET_REBIND_PROC
1058 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1059 # if LDAP_SET_REBIND_PROC_ARGS == 2
1060 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
1061 # endif
1062 # if LDAP_SET_REBIND_PROC_ARGS == 3
1063 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
1064 # endif
1065 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1066 # if LDAP_SET_REBIND_PROC_ARGS == 2
1067 ldap_set_rebind_proc(ldap_struct, &rebindproc);
1068 # endif
1069 # if LDAP_SET_REBIND_PROC_ARGS == 3
1070 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
1071 # endif
1072 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1073 #endif
1075 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1077 if (rc != LDAP_SUCCESS) {
1078 char *ld_error = NULL;
1079 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
1080 &ld_error);
1081 DEBUG(ldap_state->num_failures ? 2 : 0,
1082 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
1083 ldap_state->uri,
1084 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
1085 ldap_err2string(rc),
1086 ld_error ? ld_error : "(unknown)"));
1087 SAFE_FREE(ld_error);
1088 ldap_state->num_failures++;
1089 return rc;
1092 ldap_state->num_failures = 0;
1093 ldap_state->paged_results = False;
1095 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1097 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1098 ldap_state->paged_results = True;
1101 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1102 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1103 ldap_state->paged_results ? "does" : "does not"));
1104 return rc;
1107 static void smbldap_idle_fn(struct event_context *event_ctx,
1108 struct timed_event *te,
1109 struct timeval now,
1110 void *private_data);
1112 /**********************************************************************
1113 Connect to LDAP server (called before every ldap operation)
1114 *********************************************************************/
1115 static int smbldap_open(struct smbldap_state *ldap_state)
1117 int rc, opt_rc;
1118 bool reopen = False;
1119 SMB_ASSERT(ldap_state);
1121 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1123 #ifdef HAVE_UNIXSOCKET
1124 struct sockaddr_un addr;
1125 #else
1126 struct sockaddr addr;
1127 #endif
1128 socklen_t len = sizeof(addr);
1129 int sd;
1131 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1132 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1133 reopen = True;
1135 #ifdef HAVE_UNIXSOCKET
1136 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1137 reopen = True;
1138 #endif
1139 if (reopen) {
1140 /* the other end has died. reopen. */
1141 ldap_unbind(ldap_state->ldap_struct);
1142 ldap_state->ldap_struct = NULL;
1143 ldap_state->last_ping = (time_t)0;
1144 } else {
1145 ldap_state->last_ping = time(NULL);
1149 if (ldap_state->ldap_struct != NULL) {
1150 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1151 return LDAP_SUCCESS;
1154 if ((rc = smbldap_open_connection(ldap_state))) {
1155 return rc;
1158 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1159 ldap_unbind(ldap_state->ldap_struct);
1160 ldap_state->ldap_struct = NULL;
1161 return rc;
1165 ldap_state->last_ping = time(NULL);
1166 ldap_state->pid = sys_getpid();
1168 TALLOC_FREE(ldap_state->idle_event);
1170 if (ldap_state->event_context != NULL) {
1171 ldap_state->idle_event = event_add_timed(
1172 ldap_state->event_context, NULL,
1173 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1174 smbldap_idle_fn, ldap_state);
1177 DEBUG(4,("The LDAP server is successfully connected\n"));
1179 return LDAP_SUCCESS;
1182 /**********************************************************************
1183 Disconnect from LDAP server
1184 *********************************************************************/
1185 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1187 if (!ldap_state)
1188 return NT_STATUS_INVALID_PARAMETER;
1190 if (ldap_state->ldap_struct != NULL) {
1191 ldap_unbind(ldap_state->ldap_struct);
1192 ldap_state->ldap_struct = NULL;
1195 smbldap_delete_state(ldap_state);
1197 DEBUG(5,("The connection to the LDAP server was closed\n"));
1198 /* maybe free the results here --metze */
1200 return NT_STATUS_OK;
1203 static bool got_alarm;
1205 static void (*old_handler)(int);
1207 static void gotalarm_sig(int dummy)
1209 got_alarm = True;
1212 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1213 int *attempts, time_t endtime)
1215 time_t now = time(NULL);
1216 int open_rc = LDAP_SERVER_DOWN;
1218 if (*rc != LDAP_SERVER_DOWN)
1219 goto no_next;
1221 if (now >= endtime) {
1222 smbldap_close(ldap_state);
1223 *rc = LDAP_TIMEOUT;
1224 goto no_next;
1227 if (*attempts == 0) {
1228 got_alarm = False;
1229 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1230 alarm(endtime - now);
1232 if (ldap_state->pid != sys_getpid())
1233 smbldap_close(ldap_state);
1236 while (1) {
1238 if (*attempts != 0)
1239 smb_msleep(1000);
1241 *attempts += 1;
1243 open_rc = smbldap_open(ldap_state);
1245 if (open_rc == LDAP_SUCCESS) {
1246 ldap_state->last_use = now;
1247 return True;
1250 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1251 /* The fact that we are non-root or any other
1252 * access-denied condition will not change in the next
1253 * round of trying */
1254 *rc = open_rc;
1255 break;
1258 if (got_alarm) {
1259 *rc = LDAP_TIMEOUT;
1260 break;
1263 if (open_rc != LDAP_SUCCESS) {
1264 DEBUG(1, ("Connection to LDAP server failed for the "
1265 "%d try!\n", *attempts));
1269 no_next:
1270 CatchSignal(SIGALRM, old_handler);
1271 alarm(0);
1272 ldap_state->last_use = now;
1273 return False;
1276 /*********************************************************************
1277 ********************************************************************/
1279 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1280 const char *base, int scope, const char *filter,
1281 const char *attrs[], int attrsonly,
1282 LDAPControl **sctrls, LDAPControl **cctrls,
1283 int sizelimit, LDAPMessage **res)
1285 int rc = LDAP_SERVER_DOWN;
1286 int attempts = 0;
1287 char *utf8_filter;
1288 time_t endtime = time(NULL)+lp_ldap_timeout();
1289 struct timeval timeout;
1290 size_t converted_size;
1292 SMB_ASSERT(ldap_state);
1294 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1295 "scope => [%d]\n", base, filter, scope));
1297 if (ldap_state->last_rebind.tv_sec > 0) {
1298 struct timeval tval;
1299 SMB_BIG_INT tdiff = 0;
1300 int sleep_time = 0;
1302 ZERO_STRUCT(tval);
1303 GetTimeOfDay(&tval);
1305 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1306 tdiff /= 1000; /* Convert to milliseconds. */
1308 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1309 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1311 if (sleep_time > 0) {
1312 /* we wait for the LDAP replication */
1313 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1314 "for LDAP replication.\n",sleep_time));
1315 smb_msleep(sleep_time);
1316 DEBUG(5,("smbldap_search_ext: go on!\n"));
1318 ZERO_STRUCT(ldap_state->last_rebind);
1321 if (!push_utf8_allocate(&utf8_filter, filter, &converted_size)) {
1322 return LDAP_NO_MEMORY;
1325 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1326 timeout.tv_sec = lp_ldap_timeout();
1327 timeout.tv_usec = 0;
1329 /* Setup alarm timeout.... Do we need both of these ? JRA.
1330 * Yes, I think we do need both of these. The server timeout only
1331 * covers the case where the server's operation takes too long. It
1332 * does not cover the case where the request hangs on its way to the
1333 * server. The server side timeout is not strictly necessary, it's
1334 * just a bit more kind to the server. VL. */
1336 got_alarm = 0;
1337 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1338 alarm(lp_ldap_timeout());
1339 /* End setup timeout. */
1341 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1342 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1343 utf8_filter,
1344 CONST_DISCARD(char **, attrs),
1345 attrsonly, sctrls, cctrls, &timeout,
1346 sizelimit, res);
1347 if (rc != LDAP_SUCCESS) {
1348 char *ld_error = NULL;
1349 int ld_errno;
1351 ldap_get_option(ldap_state->ldap_struct,
1352 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1354 ldap_get_option(ldap_state->ldap_struct,
1355 LDAP_OPT_ERROR_STRING, &ld_error);
1356 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1357 "(%s)\n", base, ld_errno,
1358 ldap_err2string(rc),
1359 ld_error ? ld_error : "unknown"));
1360 SAFE_FREE(ld_error);
1362 if (ld_errno == LDAP_SERVER_DOWN) {
1363 ldap_unbind(ldap_state->ldap_struct);
1364 ldap_state->ldap_struct = NULL;
1369 SAFE_FREE(utf8_filter);
1371 /* Teardown timeout. */
1372 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1373 alarm(0);
1375 if (got_alarm != 0)
1376 return LDAP_TIMELIMIT_EXCEEDED;
1378 return rc;
1381 int smbldap_search(struct smbldap_state *ldap_state,
1382 const char *base, int scope, const char *filter,
1383 const char *attrs[], int attrsonly,
1384 LDAPMessage **res)
1386 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1387 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1390 int smbldap_search_paged(struct smbldap_state *ldap_state,
1391 const char *base, int scope, const char *filter,
1392 const char **attrs, int attrsonly, int pagesize,
1393 LDAPMessage **res, void **cookie)
1395 LDAPControl pr;
1396 LDAPControl **rcontrols;
1397 LDAPControl *controls[2] = { NULL, NULL};
1398 BerElement *cookie_be = NULL;
1399 struct berval *cookie_bv = NULL;
1400 int tmp = 0, i, rc;
1401 bool critical = True;
1403 *res = NULL;
1405 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1406 "scope => [%d], pagesize => [%d]\n",
1407 base, filter, scope, pagesize));
1409 cookie_be = ber_alloc_t(LBER_USE_DER);
1410 if (cookie_be == NULL) {
1411 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1412 "NULL\n"));
1413 return LDAP_NO_MEMORY;
1416 /* construct cookie */
1417 if (*cookie != NULL) {
1418 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1419 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1420 *cookie = NULL;
1421 } else {
1422 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1424 ber_flatten(cookie_be, &cookie_bv);
1426 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1427 pr.ldctl_iscritical = (char) critical;
1428 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1429 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1431 controls[0] = &pr;
1432 controls[1] = NULL;
1434 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1435 0, controls, NULL, LDAP_NO_LIMIT, res);
1437 ber_free(cookie_be, 1);
1438 ber_bvfree(cookie_bv);
1440 if (rc != 0) {
1441 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1442 "failed with [%s]\n", filter, ldap_err2string(rc)));
1443 goto done;
1446 DEBUG(3,("smbldap_search_paged: search was successful\n"));
1448 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1449 NULL, NULL, &rcontrols, 0);
1450 if (rc != 0) {
1451 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1452 "with [%s]\n", ldap_err2string(rc)));
1453 goto done;
1456 if (rcontrols == NULL)
1457 goto done;
1459 for (i=0; rcontrols[i]; i++) {
1461 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1462 continue;
1464 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1465 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1466 /* the berval is the cookie, but must be freed when it is all
1467 done */
1468 if (cookie_bv->bv_len)
1469 *cookie=ber_bvdup(cookie_bv);
1470 else
1471 *cookie=NULL;
1472 ber_bvfree(cookie_bv);
1473 ber_free(cookie_be, 1);
1474 break;
1476 ldap_controls_free(rcontrols);
1477 done:
1478 return rc;
1481 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1483 int rc = LDAP_SERVER_DOWN;
1484 int attempts = 0;
1485 char *utf8_dn;
1486 time_t endtime = time(NULL)+lp_ldap_timeout();
1487 size_t converted_size;
1489 SMB_ASSERT(ldap_state);
1491 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1493 if (!push_utf8_allocate(&utf8_dn, dn, &converted_size)) {
1494 return LDAP_NO_MEMORY;
1497 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1498 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1499 if (rc != LDAP_SUCCESS) {
1500 char *ld_error = NULL;
1501 int ld_errno;
1503 ldap_get_option(ldap_state->ldap_struct,
1504 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1506 ldap_get_option(ldap_state->ldap_struct,
1507 LDAP_OPT_ERROR_STRING, &ld_error);
1508 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1509 "(%s)\n", dn, ld_errno,
1510 ldap_err2string(rc),
1511 ld_error ? ld_error : "unknown"));
1512 SAFE_FREE(ld_error);
1514 if (ld_errno == LDAP_SERVER_DOWN) {
1515 ldap_unbind(ldap_state->ldap_struct);
1516 ldap_state->ldap_struct = NULL;
1521 SAFE_FREE(utf8_dn);
1522 return rc;
1525 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1527 int rc = LDAP_SERVER_DOWN;
1528 int attempts = 0;
1529 char *utf8_dn;
1530 time_t endtime = time(NULL)+lp_ldap_timeout();
1531 size_t converted_size;
1533 SMB_ASSERT(ldap_state);
1535 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1537 if (!push_utf8_allocate(&utf8_dn, dn, &converted_size)) {
1538 return LDAP_NO_MEMORY;
1541 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1542 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1543 if (rc != LDAP_SUCCESS) {
1544 char *ld_error = NULL;
1545 int ld_errno;
1547 ldap_get_option(ldap_state->ldap_struct,
1548 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1550 ldap_get_option(ldap_state->ldap_struct,
1551 LDAP_OPT_ERROR_STRING, &ld_error);
1552 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1553 "(%s)\n", dn, ld_errno,
1554 ldap_err2string(rc),
1555 ld_error ? ld_error : "unknown"));
1556 SAFE_FREE(ld_error);
1558 if (ld_errno == LDAP_SERVER_DOWN) {
1559 ldap_unbind(ldap_state->ldap_struct);
1560 ldap_state->ldap_struct = NULL;
1565 SAFE_FREE(utf8_dn);
1566 return rc;
1569 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1571 int rc = LDAP_SERVER_DOWN;
1572 int attempts = 0;
1573 char *utf8_dn;
1574 time_t endtime = time(NULL)+lp_ldap_timeout();
1575 size_t converted_size;
1577 SMB_ASSERT(ldap_state);
1579 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1581 if (!push_utf8_allocate(&utf8_dn, dn, &converted_size)) {
1582 return LDAP_NO_MEMORY;
1585 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1586 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1587 if (rc != LDAP_SUCCESS) {
1588 char *ld_error = NULL;
1589 int ld_errno;
1591 ldap_get_option(ldap_state->ldap_struct,
1592 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1594 ldap_get_option(ldap_state->ldap_struct,
1595 LDAP_OPT_ERROR_STRING, &ld_error);
1596 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1597 "(%s)\n", dn, ld_errno,
1598 ldap_err2string(rc),
1599 ld_error ? ld_error : "unknown"));
1600 SAFE_FREE(ld_error);
1602 if (ld_errno == LDAP_SERVER_DOWN) {
1603 ldap_unbind(ldap_state->ldap_struct);
1604 ldap_state->ldap_struct = NULL;
1609 SAFE_FREE(utf8_dn);
1610 return rc;
1613 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1614 LDAP_CONST char *reqoid, struct berval *reqdata,
1615 LDAPControl **serverctrls, LDAPControl **clientctrls,
1616 char **retoidp, struct berval **retdatap)
1618 int rc = LDAP_SERVER_DOWN;
1619 int attempts = 0;
1620 time_t endtime = time(NULL)+lp_ldap_timeout();
1622 if (!ldap_state)
1623 return (-1);
1625 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1626 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1627 reqdata, serverctrls,
1628 clientctrls, retoidp, retdatap);
1629 if (rc != LDAP_SUCCESS) {
1630 char *ld_error = NULL;
1631 int ld_errno;
1633 ldap_get_option(ldap_state->ldap_struct,
1634 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1636 ldap_get_option(ldap_state->ldap_struct,
1637 LDAP_OPT_ERROR_STRING, &ld_error);
1638 DEBUG(10, ("Extended operation failed with error: "
1639 "%d (%s) (%s)\n", ld_errno,
1640 ldap_err2string(rc),
1641 ld_error ? ld_error : "unknown"));
1642 SAFE_FREE(ld_error);
1644 if (ld_errno == LDAP_SERVER_DOWN) {
1645 ldap_unbind(ldap_state->ldap_struct);
1646 ldap_state->ldap_struct = NULL;
1651 return rc;
1654 /*******************************************************************
1655 run the search by name.
1656 ******************************************************************/
1657 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1658 const char *filter, const char **search_attr,
1659 LDAPMessage ** result)
1661 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1662 filter, search_attr, 0, result);
1665 static void smbldap_idle_fn(struct event_context *event_ctx,
1666 struct timed_event *te,
1667 struct timeval now,
1668 void *private_data)
1670 struct smbldap_state *state = (struct smbldap_state *)private_data;
1672 TALLOC_FREE(state->idle_event);
1674 if (state->ldap_struct == NULL) {
1675 DEBUG(10,("ldap connection not connected...\n"));
1676 return;
1679 if ((state->last_use+SMBLDAP_IDLE_TIME) > now.tv_sec) {
1680 DEBUG(10,("ldap connection not idle...\n"));
1682 state->idle_event = event_add_timed(
1683 event_ctx, NULL,
1684 timeval_add(&now, SMBLDAP_IDLE_TIME, 0),
1685 smbldap_idle_fn,
1686 private_data);
1687 return;
1690 DEBUG(7,("ldap connection idle...closing connection\n"));
1691 smbldap_close(state);
1694 /**********************************************************************
1695 Housekeeping
1696 *********************************************************************/
1698 void smbldap_free_struct(struct smbldap_state **ldap_state)
1700 smbldap_close(*ldap_state);
1702 if ((*ldap_state)->bind_secret) {
1703 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1706 SAFE_FREE((*ldap_state)->bind_dn);
1707 SAFE_FREE((*ldap_state)->bind_secret);
1709 TALLOC_FREE((*ldap_state)->idle_event);
1711 *ldap_state = NULL;
1713 /* No need to free any further, as it is talloc()ed */
1717 /**********************************************************************
1718 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1719 *********************************************************************/
1721 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1722 const char *location,
1723 struct smbldap_state **smbldap_state)
1725 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1726 if (!*smbldap_state) {
1727 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1728 return NT_STATUS_NO_MEMORY;
1731 if (location) {
1732 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1733 } else {
1734 (*smbldap_state)->uri = "ldap://localhost";
1737 (*smbldap_state)->event_context = event_ctx;
1739 return NT_STATUS_OK;
1742 /*******************************************************************
1743 Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1744 ********************************************************************/
1745 char *smbldap_get_dn(LDAP *ld, LDAPMessage *entry)
1747 char *utf8_dn, *unix_dn;
1748 size_t converted_size;
1750 utf8_dn = ldap_get_dn(ld, entry);
1751 if (!utf8_dn) {
1752 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1753 return NULL;
1755 if (!pull_utf8_allocate(&unix_dn, utf8_dn, &converted_size)) {
1756 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1757 "[%s]\n", utf8_dn));
1758 return NULL;
1760 ldap_memfree(utf8_dn);
1761 return unix_dn;
1764 const char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1765 LDAPMessage *entry)
1767 char *utf8_dn, *unix_dn;
1768 size_t converted_size;
1770 utf8_dn = ldap_get_dn(ld, entry);
1771 if (!utf8_dn) {
1772 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1773 return NULL;
1775 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1776 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1777 "[%s]\n", utf8_dn));
1778 return NULL;
1780 ldap_memfree(utf8_dn);
1781 return unix_dn;
1784 /*******************************************************************
1785 Check if root-dse has a certain Control or Extension
1786 ********************************************************************/
1788 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1790 LDAPMessage *msg = NULL;
1791 LDAPMessage *entry = NULL;
1792 char **values = NULL;
1793 int rc, num_result, num_values, i;
1794 bool result = False;
1796 if (!attrs[0]) {
1797 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1798 return False;
1801 if (!strequal(attrs[0], "supportedExtension") &&
1802 !strequal(attrs[0], "supportedControl") &&
1803 !strequal(attrs[0], "namingContexts")) {
1804 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1805 return False;
1808 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1809 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1811 if (rc != LDAP_SUCCESS) {
1812 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1813 return False;
1816 num_result = ldap_count_entries(ld, msg);
1818 if (num_result != 1) {
1819 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1820 goto done;
1823 entry = ldap_first_entry(ld, msg);
1825 if (entry == NULL) {
1826 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1827 goto done;
1830 values = ldap_get_values(ld, entry, attrs[0]);
1832 if (values == NULL) {
1833 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1834 goto done;
1837 num_values = ldap_count_values(values);
1839 if (num_values == 0) {
1840 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1841 goto done;
1844 for (i=0; i<num_values; i++) {
1845 if (strcmp(values[i], value) == 0)
1846 result = True;
1850 done:
1851 if (values != NULL)
1852 ldap_value_free(values);
1853 if (msg != NULL)
1854 ldap_msgfree(msg);
1856 return result;
1860 /*******************************************************************
1861 Check if LDAP-Server supports a certain Control (OID in string format)
1862 ********************************************************************/
1864 bool smbldap_has_control(LDAP *ld, const char *control)
1866 const char *attrs[] = { "supportedControl", NULL };
1867 return smbldap_check_root_dse(ld, attrs, control);
1870 /*******************************************************************
1871 Check if LDAP-Server supports a certain Extension (OID in string format)
1872 ********************************************************************/
1874 bool smbldap_has_extension(LDAP *ld, const char *extension)
1876 const char *attrs[] = { "supportedExtension", NULL };
1877 return smbldap_check_root_dse(ld, attrs, extension);
1880 /*******************************************************************
1881 Check if LDAP-Server holds a given namingContext
1882 ********************************************************************/
1884 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1886 const char *attrs[] = { "namingContexts", NULL };
1887 return smbldap_check_root_dse(ld, attrs, naming_context);
1890 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1892 ldap_state->anonymous = anon;
1894 /* free any previously set credential */
1896 SAFE_FREE(ldap_state->bind_dn);
1897 if (ldap_state->bind_secret) {
1898 /* make sure secrets are zeroed out of memory */
1899 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1900 SAFE_FREE(ldap_state->bind_secret);
1903 if ( ! anon) {
1904 ldap_state->bind_dn = SMB_STRDUP(dn);
1905 ldap_state->bind_secret = SMB_STRDUP(secret);
1908 return True;