s3/smbldap: Fix typo in debug message.
[Samba.git] / source3 / lib / smbldap.c
blob8c2b26d878d68a3ef33b9561b4e07795c3352c02
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_smallest_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;
343 int i, num_values;
345 if (attribute == NULL) {
346 return NULL;
349 values = ldap_get_values(ldap_struct, entry, attribute);
351 if (values == NULL) {
352 DEBUG(10, ("attribute %s does not exist\n", attribute));
353 return NULL;
356 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
357 DEBUG(10, ("pull_utf8_talloc failed\n"));
358 ldap_value_free(values);
359 return NULL;
362 num_values = ldap_count_values(values);
364 for (i=1; i<num_values; i++) {
365 char *tmp;
367 if (!pull_utf8_talloc(mem_ctx, &tmp, values[i],
368 &converted_size)) {
369 DEBUG(10, ("pull_utf8_talloc failed\n"));
370 TALLOC_FREE(result);
371 ldap_value_free(values);
372 return NULL;
375 if (StrCaseCmp(tmp, result) < 0) {
376 TALLOC_FREE(result);
377 result = tmp;
378 } else {
379 TALLOC_FREE(tmp);
383 ldap_value_free(values);
385 #ifdef DEBUG_PASSWORDS
386 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
387 attribute, result));
388 #endif
389 return result;
392 static int ldapmsg_destructor(LDAPMessage **result) {
393 ldap_msgfree(*result);
394 return 0;
397 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
399 LDAPMessage **handle;
401 if (result == NULL) {
402 return;
405 handle = TALLOC_P(mem_ctx, LDAPMessage *);
406 SMB_ASSERT(handle != NULL);
408 *handle = result;
409 talloc_set_destructor(handle, ldapmsg_destructor);
412 static int ldapmod_destructor(LDAPMod ***mod) {
413 ldap_mods_free(*mod, True);
414 return 0;
417 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
419 LDAPMod ***handle;
421 if (mod == NULL) {
422 return;
425 handle = TALLOC_P(mem_ctx, LDAPMod **);
426 SMB_ASSERT(handle != NULL);
428 *handle = mod;
429 talloc_set_destructor(handle, ldapmod_destructor);
432 /************************************************************************
433 Routine to manage the LDAPMod structure array
434 manage memory used by the array, by each struct, and values
435 ***********************************************************************/
437 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
439 LDAPMod **mods;
440 int i;
441 int j;
443 mods = *modlist;
445 /* sanity checks on the mod values */
447 if (attribute == NULL || *attribute == '\0') {
448 return;
451 #if 0 /* commented out after discussion with abartlet. Do not reenable.
452 left here so other do not re-add similar code --jerry */
453 if (value == NULL || *value == '\0')
454 return;
455 #endif
457 if (mods == NULL) {
458 mods = SMB_MALLOC_P(LDAPMod *);
459 if (mods == NULL) {
460 smb_panic("smbldap_set_mod: out of memory!");
461 /* notreached. */
463 mods[0] = NULL;
466 for (i = 0; mods[i] != NULL; ++i) {
467 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
468 break;
471 if (mods[i] == NULL) {
472 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
473 if (mods == NULL) {
474 smb_panic("smbldap_set_mod: out of memory!");
475 /* notreached. */
477 mods[i] = SMB_MALLOC_P(LDAPMod);
478 if (mods[i] == NULL) {
479 smb_panic("smbldap_set_mod: out of memory!");
480 /* notreached. */
482 mods[i]->mod_op = modop;
483 mods[i]->mod_values = NULL;
484 mods[i]->mod_type = SMB_STRDUP(attribute);
485 mods[i + 1] = NULL;
488 if (value != NULL) {
489 char *utf8_value = NULL;
490 size_t converted_size;
492 j = 0;
493 if (mods[i]->mod_values != NULL) {
494 for (; mods[i]->mod_values[j] != NULL; j++);
496 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
498 if (mods[i]->mod_values == NULL) {
499 smb_panic("smbldap_set_mod: out of memory!");
500 /* notreached. */
503 if (!push_utf8_allocate(&utf8_value, value, &converted_size)) {
504 smb_panic("smbldap_set_mod: String conversion failure!");
505 /* notreached. */
508 mods[i]->mod_values[j] = utf8_value;
510 mods[i]->mod_values[j + 1] = NULL;
512 *modlist = mods;
515 /**********************************************************************
516 Set attribute to newval in LDAP, regardless of what value the
517 attribute had in LDAP before.
518 *********************************************************************/
520 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
521 LDAPMod ***mods,
522 const char *attribute, const char *newval)
524 char oldval[2048]; /* current largest allowed value is mungeddial */
525 bool existed;
527 if (attribute == NULL) {
528 /* This can actually happen for ldapsam_compat where we for
529 * example don't have a password history */
530 return;
533 if (existing != NULL) {
534 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
535 } else {
536 existed = False;
537 *oldval = '\0';
540 /* all of our string attributes are case insensitive */
542 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
544 /* Believe it or not, but LDAP will deny a delete and
545 an add at the same time if the values are the
546 same... */
547 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
548 return;
551 if (existed) {
552 /* There has been no value before, so don't delete it.
553 * Here's a possible race: We might end up with
554 * duplicate attributes */
555 /* By deleting exactly the value we found in the entry this
556 * should be race-free in the sense that the LDAP-Server will
557 * deny the complete operation if somebody changed the
558 * attribute behind our back. */
559 /* This will also allow modifying single valued attributes
560 * in Novell NDS. In NDS you have to first remove attribute and then
561 * you could add new value */
563 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
564 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
567 /* Regardless of the real operation (add or modify)
568 we add the new value here. We rely on deleting
569 the old value, should it exist. */
571 if ((newval != NULL) && (strlen(newval) > 0)) {
572 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
573 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
577 /**********************************************************************
578 Some varients of the LDAP rebind code do not pass in the third 'arg'
579 pointer to a void*, so we try and work around it by assuming that the
580 value of the 'LDAP *' pointer is the same as the one we had passed in
581 **********************************************************************/
583 struct smbldap_state_lookup {
584 LDAP *ld;
585 struct smbldap_state *smbldap_state;
586 struct smbldap_state_lookup *prev, *next;
589 static struct smbldap_state_lookup *smbldap_state_lookup_list;
591 static struct smbldap_state *smbldap_find_state(LDAP *ld)
593 struct smbldap_state_lookup *t;
595 for (t = smbldap_state_lookup_list; t; t = t->next) {
596 if (t->ld == ld) {
597 return t->smbldap_state;
600 return NULL;
603 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
605 struct smbldap_state_lookup *t;
607 for (t = smbldap_state_lookup_list; t; t = t->next) {
608 if (t->smbldap_state == smbldap_state) {
609 DLIST_REMOVE(smbldap_state_lookup_list, t);
610 SAFE_FREE(t);
611 return;
616 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
618 struct smbldap_state *tmp_ldap_state;
619 struct smbldap_state_lookup *t;
621 if ((tmp_ldap_state = smbldap_find_state(ld))) {
622 SMB_ASSERT(tmp_ldap_state == smbldap_state);
623 return;
626 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
627 ZERO_STRUCTP(t);
629 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
630 t->ld = ld;
631 t->smbldap_state = smbldap_state;
634 /********************************************************************
635 start TLS on an existing LDAP connection
636 *******************************************************************/
638 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
640 #ifdef LDAP_OPT_X_TLS
641 int rc;
642 #endif
644 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
645 return LDAP_SUCCESS;
648 #ifdef LDAP_OPT_X_TLS
649 if (version != LDAP_VERSION3) {
650 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
651 return LDAP_OPERATIONS_ERROR;
654 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
655 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
656 ldap_err2string(rc)));
657 return rc;
660 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
661 return LDAP_SUCCESS;
662 #else
663 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
664 return LDAP_OPERATIONS_ERROR;
665 #endif
668 /********************************************************************
669 setup a connection to the LDAP server based on a uri
670 *******************************************************************/
672 int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
674 int rc;
676 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
678 #ifdef HAVE_LDAP_INITIALIZE
680 rc = ldap_initialize(ldap_struct, uri);
681 if (rc) {
682 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
685 return rc;
686 #else
688 /* Parse the string manually */
691 int port = 0;
692 fstring protocol;
693 fstring host;
694 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
697 /* skip leading "URL:" (if any) */
698 if ( strnequal( uri, "URL:", 4 ) ) {
699 uri += 4;
702 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
704 if (port == 0) {
705 if (strequal(protocol, "ldap")) {
706 port = LDAP_PORT;
707 } else if (strequal(protocol, "ldaps")) {
708 port = LDAPS_PORT;
709 } else {
710 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
714 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
715 DEBUG(0, ("ldap_init failed !\n"));
716 return LDAP_OPERATIONS_ERROR;
719 if (strequal(protocol, "ldaps")) {
720 #ifdef LDAP_OPT_X_TLS
721 int tls = LDAP_OPT_X_TLS_HARD;
722 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
724 DEBUG(0, ("Failed to setup a TLS session\n"));
727 DEBUG(3,("LDAPS option set...!\n"));
728 #else
729 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
730 return LDAP_OPERATIONS_ERROR;
731 #endif /* LDAP_OPT_X_TLS */
734 #endif /* HAVE_LDAP_INITIALIZE */
737 /* now set connection timeout */
738 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
740 int ct = lp_ldap_connection_timeout()*1000;
741 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
742 if (rc != LDAP_SUCCESS) {
743 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
744 ct, ldap_err2string(rc)));
747 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
749 struct timeval ct;
750 ct.tv_usec = 0;
751 ct.tv_sec = lp_ldap_connection_timeout();
752 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
753 if (rc != LDAP_SUCCESS) {
754 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
755 (int)ct.tv_sec, ldap_err2string(rc)));
758 #endif
760 return LDAP_SUCCESS;
763 /********************************************************************
764 try to upgrade to Version 3 LDAP if not already, in either case return current
765 version
766 *******************************************************************/
768 int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
770 int version;
771 int rc;
773 /* assume the worst */
774 *new_version = LDAP_VERSION2;
776 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
777 if (rc) {
778 return rc;
781 if (version == LDAP_VERSION3) {
782 *new_version = LDAP_VERSION3;
783 return LDAP_SUCCESS;
786 /* try upgrade */
787 version = LDAP_VERSION3;
788 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
789 if (rc) {
790 return rc;
793 *new_version = LDAP_VERSION3;
794 return LDAP_SUCCESS;
797 /*******************************************************************
798 open a connection to the ldap server (just until the bind)
799 ******************************************************************/
801 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
803 int rc, version;
805 rc = smb_ldap_setup_conn(ldap_struct, uri);
806 if (rc) {
807 return rc;
810 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
811 if (rc) {
812 return rc;
815 rc = smb_ldap_start_tls(*ldap_struct, version);
816 if (rc) {
817 return rc;
820 return LDAP_SUCCESS;
823 /*******************************************************************
824 open a connection to the ldap server.
825 ******************************************************************/
826 static int smbldap_open_connection (struct smbldap_state *ldap_state)
829 int rc = LDAP_SUCCESS;
830 int version;
831 LDAP **ldap_struct = &ldap_state->ldap_struct;
833 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
834 if (rc) {
835 return rc;
838 /* Store the LDAP pointer in a lookup list */
840 smbldap_store_state(*ldap_struct, ldap_state);
842 /* Upgrade to LDAPv3 if possible */
844 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
845 if (rc) {
846 return rc;
849 /* Start TLS if required */
851 rc = smb_ldap_start_tls(*ldap_struct, version);
852 if (rc) {
853 return rc;
856 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
857 return rc;
860 /*******************************************************************
861 a rebind function for authenticated referrals
862 This version takes a void* that we can shove useful stuff in :-)
863 ******************************************************************/
864 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
865 #else
866 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
867 int *methodp, int freeit, void *arg)
869 struct smbldap_state *ldap_state = arg;
871 /** @TODO Should we be doing something to check what servers we rebind to?
872 Could we get a referral to a machine that we don't want to give our
873 username and password to? */
875 if (freeit) {
876 SAFE_FREE(*whop);
877 if (*credp) {
878 memset(*credp, '\0', strlen(*credp));
880 SAFE_FREE(*credp);
881 } else {
882 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
883 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
885 if (ldap_state->anonymous) {
886 *whop = NULL;
887 *credp = NULL;
888 } else {
889 *whop = SMB_STRDUP(ldap_state->bind_dn);
890 if (!*whop) {
891 return LDAP_NO_MEMORY;
893 *credp = SMB_STRDUP(ldap_state->bind_secret);
894 if (!*credp) {
895 SAFE_FREE(*whop);
896 return LDAP_NO_MEMORY;
899 *methodp = LDAP_AUTH_SIMPLE;
902 GetTimeOfDay(&ldap_state->last_rebind);
904 return 0;
906 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
908 /*******************************************************************
909 a rebind function for authenticated referrals
910 This version takes a void* that we can shove useful stuff in :-)
911 and actually does the connection.
912 ******************************************************************/
913 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
914 static int rebindproc_connect_with_state (LDAP *ldap_struct,
915 LDAP_CONST char *url,
916 ber_tag_t request,
917 ber_int_t msgid, void *arg)
919 struct smbldap_state *ldap_state =
920 (struct smbldap_state *)arg;
921 int rc;
922 int version;
924 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
925 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
927 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
928 * itself) before rebinding to another LDAP server to avoid to expose
929 * our credentials. At least *try* to secure the connection - Guenther */
931 smb_ldap_upgrade_conn(ldap_struct, &version);
932 smb_ldap_start_tls(ldap_struct, version);
934 /** @TODO Should we be doing something to check what servers we rebind to?
935 Could we get a referral to a machine that we don't want to give our
936 username and password to? */
938 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
940 /* only set the last rebind timestamp when we did rebind after a
941 * non-read LDAP operation. That way we avoid the replication sleep
942 * after a simple redirected search operation - Guenther */
944 switch (request) {
946 case LDAP_REQ_MODIFY:
947 case LDAP_REQ_ADD:
948 case LDAP_REQ_DELETE:
949 case LDAP_REQ_MODDN:
950 case LDAP_REQ_EXTENDED:
951 DEBUG(10,("rebindproc_connect_with_state: "
952 "setting last_rebind timestamp "
953 "(req: 0x%02x)\n", (unsigned int)request));
954 GetTimeOfDay(&ldap_state->last_rebind);
955 break;
956 default:
957 ZERO_STRUCT(ldap_state->last_rebind);
958 break;
961 return rc;
963 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
965 /*******************************************************************
966 Add a rebind function for authenticated referrals
967 ******************************************************************/
968 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
969 #else
970 # if LDAP_SET_REBIND_PROC_ARGS == 2
971 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
972 int *method, int freeit )
974 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
976 return rebindproc_with_state(ldap_struct, whop, credp,
977 method, freeit, ldap_state);
980 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
981 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
983 /*******************************************************************
984 a rebind function for authenticated referrals
985 this also does the connection, but no void*.
986 ******************************************************************/
987 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
988 # if LDAP_SET_REBIND_PROC_ARGS == 2
989 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
990 ber_int_t msgid)
992 struct smbldap_state *ldap_state = smbldap_find_state(ld);
994 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
995 ldap_state);
997 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
998 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1000 /*******************************************************************
1001 connect to the ldap server under system privilege.
1002 ******************************************************************/
1003 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
1005 int rc;
1006 int version;
1008 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
1010 /* get the default dn and password only if they are not set already */
1011 if (!fetch_ldap_pw(&ldap_state->bind_dn, &ldap_state->bind_secret)) {
1012 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
1013 return LDAP_INVALID_CREDENTIALS;
1017 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
1018 (OpenLDAP) doesnt' seem to support it */
1020 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
1021 ldap_state->uri, ldap_state->bind_dn));
1023 #ifdef HAVE_LDAP_SET_REBIND_PROC
1024 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1025 # if LDAP_SET_REBIND_PROC_ARGS == 2
1026 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
1027 # endif
1028 # if LDAP_SET_REBIND_PROC_ARGS == 3
1029 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
1030 # endif
1031 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1032 # if LDAP_SET_REBIND_PROC_ARGS == 2
1033 ldap_set_rebind_proc(ldap_struct, &rebindproc);
1034 # endif
1035 # if LDAP_SET_REBIND_PROC_ARGS == 3
1036 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
1037 # endif
1038 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1039 #endif
1041 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1043 if (rc != LDAP_SUCCESS) {
1044 char *ld_error = NULL;
1045 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
1046 &ld_error);
1047 DEBUG(ldap_state->num_failures ? 2 : 0,
1048 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
1049 ldap_state->uri,
1050 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
1051 ldap_err2string(rc),
1052 ld_error ? ld_error : "(unknown)"));
1053 SAFE_FREE(ld_error);
1054 ldap_state->num_failures++;
1055 return rc;
1058 ldap_state->num_failures = 0;
1059 ldap_state->paged_results = False;
1061 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1063 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1064 ldap_state->paged_results = True;
1067 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1068 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1069 ldap_state->paged_results ? "does" : "does not"));
1070 return rc;
1073 static void smbldap_idle_fn(struct event_context *event_ctx,
1074 struct timed_event *te,
1075 struct timeval now,
1076 void *private_data);
1078 /**********************************************************************
1079 Connect to LDAP server (called before every ldap operation)
1080 *********************************************************************/
1081 static int smbldap_open(struct smbldap_state *ldap_state)
1083 int rc, opt_rc;
1084 bool reopen = False;
1085 SMB_ASSERT(ldap_state);
1087 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1089 #ifdef HAVE_UNIXSOCKET
1090 struct sockaddr_un addr;
1091 #else
1092 struct sockaddr addr;
1093 #endif
1094 socklen_t len = sizeof(addr);
1095 int sd;
1097 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1098 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1099 reopen = True;
1101 #ifdef HAVE_UNIXSOCKET
1102 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1103 reopen = True;
1104 #endif
1105 if (reopen) {
1106 /* the other end has died. reopen. */
1107 ldap_unbind(ldap_state->ldap_struct);
1108 ldap_state->ldap_struct = NULL;
1109 ldap_state->last_ping = (time_t)0;
1110 } else {
1111 ldap_state->last_ping = time(NULL);
1115 if (ldap_state->ldap_struct != NULL) {
1116 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1117 return LDAP_SUCCESS;
1120 if ((rc = smbldap_open_connection(ldap_state))) {
1121 return rc;
1124 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1125 ldap_unbind(ldap_state->ldap_struct);
1126 ldap_state->ldap_struct = NULL;
1127 return rc;
1131 ldap_state->last_ping = time(NULL);
1132 ldap_state->pid = sys_getpid();
1134 TALLOC_FREE(ldap_state->idle_event);
1136 if (ldap_state->event_context != NULL) {
1137 ldap_state->idle_event = event_add_timed(
1138 ldap_state->event_context, NULL,
1139 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1140 smbldap_idle_fn, ldap_state);
1143 DEBUG(4,("The LDAP server is successfully connected\n"));
1145 return LDAP_SUCCESS;
1148 /**********************************************************************
1149 Disconnect from LDAP server
1150 *********************************************************************/
1151 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1153 if (!ldap_state)
1154 return NT_STATUS_INVALID_PARAMETER;
1156 if (ldap_state->ldap_struct != NULL) {
1157 ldap_unbind(ldap_state->ldap_struct);
1158 ldap_state->ldap_struct = NULL;
1161 smbldap_delete_state(ldap_state);
1163 DEBUG(5,("The connection to the LDAP server was closed\n"));
1164 /* maybe free the results here --metze */
1166 return NT_STATUS_OK;
1169 static bool got_alarm;
1171 static void (*old_handler)(int);
1173 static void gotalarm_sig(int dummy)
1175 got_alarm = True;
1178 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1179 int *attempts, time_t endtime)
1181 time_t now = time(NULL);
1182 int open_rc = LDAP_SERVER_DOWN;
1184 if (*rc != LDAP_SERVER_DOWN)
1185 goto no_next;
1187 if (now >= endtime) {
1188 smbldap_close(ldap_state);
1189 *rc = LDAP_TIMEOUT;
1190 goto no_next;
1193 if (*attempts == 0) {
1194 got_alarm = False;
1195 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1196 alarm(endtime - now);
1198 if (ldap_state->pid != sys_getpid())
1199 smbldap_close(ldap_state);
1202 while (1) {
1204 if (*attempts != 0)
1205 smb_msleep(1000);
1207 *attempts += 1;
1209 open_rc = smbldap_open(ldap_state);
1211 if (open_rc == LDAP_SUCCESS) {
1212 ldap_state->last_use = now;
1213 return True;
1216 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1217 /* The fact that we are non-root or any other
1218 * access-denied condition will not change in the next
1219 * round of trying */
1220 *rc = open_rc;
1221 break;
1224 if (got_alarm) {
1225 *rc = LDAP_TIMEOUT;
1226 break;
1229 if (open_rc != LDAP_SUCCESS) {
1230 DEBUG(1, ("Connection to LDAP server failed for the "
1231 "%d try!\n", *attempts));
1235 no_next:
1236 CatchSignal(SIGALRM, old_handler);
1237 alarm(0);
1238 ldap_state->last_use = now;
1239 return False;
1242 /*********************************************************************
1243 ********************************************************************/
1245 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1246 const char *base, int scope, const char *filter,
1247 const char *attrs[], int attrsonly,
1248 LDAPControl **sctrls, LDAPControl **cctrls,
1249 int sizelimit, LDAPMessage **res)
1251 int rc = LDAP_SERVER_DOWN;
1252 int attempts = 0;
1253 char *utf8_filter;
1254 time_t endtime = time(NULL)+lp_ldap_timeout();
1255 struct timeval timeout;
1256 size_t converted_size;
1258 SMB_ASSERT(ldap_state);
1260 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1261 "scope => [%d]\n", base, filter, scope));
1263 if (ldap_state->last_rebind.tv_sec > 0) {
1264 struct timeval tval;
1265 int64_t tdiff = 0;
1266 int sleep_time = 0;
1268 ZERO_STRUCT(tval);
1269 GetTimeOfDay(&tval);
1271 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1272 tdiff /= 1000; /* Convert to milliseconds. */
1274 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1275 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1277 if (sleep_time > 0) {
1278 /* we wait for the LDAP replication */
1279 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1280 "for LDAP replication.\n",sleep_time));
1281 smb_msleep(sleep_time);
1282 DEBUG(5,("smbldap_search_ext: go on!\n"));
1284 ZERO_STRUCT(ldap_state->last_rebind);
1287 if (!push_utf8_talloc(talloc_tos(), &utf8_filter, filter, &converted_size)) {
1288 return LDAP_NO_MEMORY;
1291 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1292 timeout.tv_sec = lp_ldap_timeout();
1293 timeout.tv_usec = 0;
1295 /* Setup alarm timeout.... Do we need both of these ? JRA.
1296 * Yes, I think we do need both of these. The server timeout only
1297 * covers the case where the server's operation takes too long. It
1298 * does not cover the case where the request hangs on its way to the
1299 * server. The server side timeout is not strictly necessary, it's
1300 * just a bit more kind to the server. VL. */
1302 got_alarm = 0;
1303 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1304 alarm(lp_ldap_timeout());
1305 /* End setup timeout. */
1307 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1308 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1309 utf8_filter,
1310 CONST_DISCARD(char **, attrs),
1311 attrsonly, sctrls, cctrls, &timeout,
1312 sizelimit, res);
1313 if (rc != LDAP_SUCCESS) {
1314 char *ld_error = NULL;
1315 int ld_errno;
1317 ldap_get_option(ldap_state->ldap_struct,
1318 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1320 ldap_get_option(ldap_state->ldap_struct,
1321 LDAP_OPT_ERROR_STRING, &ld_error);
1322 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1323 "(%s)\n", base, ld_errno,
1324 ldap_err2string(rc),
1325 ld_error ? ld_error : "unknown"));
1326 SAFE_FREE(ld_error);
1328 if (ld_errno == LDAP_SERVER_DOWN) {
1329 ldap_unbind(ldap_state->ldap_struct);
1330 ldap_state->ldap_struct = NULL;
1335 TALLOC_FREE(utf8_filter);
1337 /* Teardown timeout. */
1338 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1339 alarm(0);
1341 if (got_alarm != 0)
1342 return LDAP_TIMELIMIT_EXCEEDED;
1344 return rc;
1347 int smbldap_search(struct smbldap_state *ldap_state,
1348 const char *base, int scope, const char *filter,
1349 const char *attrs[], int attrsonly,
1350 LDAPMessage **res)
1352 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1353 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1356 int smbldap_search_paged(struct smbldap_state *ldap_state,
1357 const char *base, int scope, const char *filter,
1358 const char **attrs, int attrsonly, int pagesize,
1359 LDAPMessage **res, void **cookie)
1361 LDAPControl pr;
1362 LDAPControl **rcontrols;
1363 LDAPControl *controls[2] = { NULL, NULL};
1364 BerElement *cookie_be = NULL;
1365 struct berval *cookie_bv = NULL;
1366 int tmp = 0, i, rc;
1367 bool critical = True;
1369 *res = NULL;
1371 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1372 "scope => [%d], pagesize => [%d]\n",
1373 base, filter, scope, pagesize));
1375 cookie_be = ber_alloc_t(LBER_USE_DER);
1376 if (cookie_be == NULL) {
1377 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1378 "NULL\n"));
1379 return LDAP_NO_MEMORY;
1382 /* construct cookie */
1383 if (*cookie != NULL) {
1384 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1385 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1386 *cookie = NULL;
1387 } else {
1388 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1390 ber_flatten(cookie_be, &cookie_bv);
1392 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1393 pr.ldctl_iscritical = (char) critical;
1394 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1395 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1397 controls[0] = &pr;
1398 controls[1] = NULL;
1400 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1401 0, controls, NULL, LDAP_NO_LIMIT, res);
1403 ber_free(cookie_be, 1);
1404 ber_bvfree(cookie_bv);
1406 if (rc != 0) {
1407 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1408 "failed with [%s]\n", filter, ldap_err2string(rc)));
1409 goto done;
1412 DEBUG(3,("smbldap_search_paged: search was successful\n"));
1414 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1415 NULL, NULL, &rcontrols, 0);
1416 if (rc != 0) {
1417 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1418 "with [%s]\n", ldap_err2string(rc)));
1419 goto done;
1422 if (rcontrols == NULL)
1423 goto done;
1425 for (i=0; rcontrols[i]; i++) {
1427 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1428 continue;
1430 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1431 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1432 /* the berval is the cookie, but must be freed when it is all
1433 done */
1434 if (cookie_bv->bv_len)
1435 *cookie=ber_bvdup(cookie_bv);
1436 else
1437 *cookie=NULL;
1438 ber_bvfree(cookie_bv);
1439 ber_free(cookie_be, 1);
1440 break;
1442 ldap_controls_free(rcontrols);
1443 done:
1444 return rc;
1447 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1449 int rc = LDAP_SERVER_DOWN;
1450 int attempts = 0;
1451 char *utf8_dn;
1452 time_t endtime = time(NULL)+lp_ldap_timeout();
1453 size_t converted_size;
1455 SMB_ASSERT(ldap_state);
1457 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1459 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1460 return LDAP_NO_MEMORY;
1463 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1464 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1465 if (rc != LDAP_SUCCESS) {
1466 char *ld_error = NULL;
1467 int ld_errno;
1469 ldap_get_option(ldap_state->ldap_struct,
1470 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1472 ldap_get_option(ldap_state->ldap_struct,
1473 LDAP_OPT_ERROR_STRING, &ld_error);
1474 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1475 "(%s)\n", dn, ld_errno,
1476 ldap_err2string(rc),
1477 ld_error ? ld_error : "unknown"));
1478 SAFE_FREE(ld_error);
1480 if (ld_errno == LDAP_SERVER_DOWN) {
1481 ldap_unbind(ldap_state->ldap_struct);
1482 ldap_state->ldap_struct = NULL;
1487 TALLOC_FREE(utf8_dn);
1488 return rc;
1491 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1493 int rc = LDAP_SERVER_DOWN;
1494 int attempts = 0;
1495 char *utf8_dn;
1496 time_t endtime = time(NULL)+lp_ldap_timeout();
1497 size_t converted_size;
1499 SMB_ASSERT(ldap_state);
1501 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1503 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1504 return LDAP_NO_MEMORY;
1507 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1508 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1509 if (rc != LDAP_SUCCESS) {
1510 char *ld_error = NULL;
1511 int ld_errno;
1513 ldap_get_option(ldap_state->ldap_struct,
1514 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1516 ldap_get_option(ldap_state->ldap_struct,
1517 LDAP_OPT_ERROR_STRING, &ld_error);
1518 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1519 "(%s)\n", dn, ld_errno,
1520 ldap_err2string(rc),
1521 ld_error ? ld_error : "unknown"));
1522 SAFE_FREE(ld_error);
1524 if (ld_errno == LDAP_SERVER_DOWN) {
1525 ldap_unbind(ldap_state->ldap_struct);
1526 ldap_state->ldap_struct = NULL;
1531 TALLOC_FREE(utf8_dn);
1532 return rc;
1535 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1537 int rc = LDAP_SERVER_DOWN;
1538 int attempts = 0;
1539 char *utf8_dn;
1540 time_t endtime = time(NULL)+lp_ldap_timeout();
1541 size_t converted_size;
1543 SMB_ASSERT(ldap_state);
1545 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1547 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1548 return LDAP_NO_MEMORY;
1551 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1552 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1553 if (rc != LDAP_SUCCESS) {
1554 char *ld_error = NULL;
1555 int ld_errno;
1557 ldap_get_option(ldap_state->ldap_struct,
1558 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1560 ldap_get_option(ldap_state->ldap_struct,
1561 LDAP_OPT_ERROR_STRING, &ld_error);
1562 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1563 "(%s)\n", dn, ld_errno,
1564 ldap_err2string(rc),
1565 ld_error ? ld_error : "unknown"));
1566 SAFE_FREE(ld_error);
1568 if (ld_errno == LDAP_SERVER_DOWN) {
1569 ldap_unbind(ldap_state->ldap_struct);
1570 ldap_state->ldap_struct = NULL;
1575 TALLOC_FREE(utf8_dn);
1576 return rc;
1579 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1580 LDAP_CONST char *reqoid, struct berval *reqdata,
1581 LDAPControl **serverctrls, LDAPControl **clientctrls,
1582 char **retoidp, struct berval **retdatap)
1584 int rc = LDAP_SERVER_DOWN;
1585 int attempts = 0;
1586 time_t endtime = time(NULL)+lp_ldap_timeout();
1588 if (!ldap_state)
1589 return (-1);
1591 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1592 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1593 reqdata, serverctrls,
1594 clientctrls, retoidp, retdatap);
1595 if (rc != LDAP_SUCCESS) {
1596 char *ld_error = NULL;
1597 int ld_errno;
1599 ldap_get_option(ldap_state->ldap_struct,
1600 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1602 ldap_get_option(ldap_state->ldap_struct,
1603 LDAP_OPT_ERROR_STRING, &ld_error);
1604 DEBUG(10, ("Extended operation failed with error: "
1605 "%d (%s) (%s)\n", ld_errno,
1606 ldap_err2string(rc),
1607 ld_error ? ld_error : "unknown"));
1608 SAFE_FREE(ld_error);
1610 if (ld_errno == LDAP_SERVER_DOWN) {
1611 ldap_unbind(ldap_state->ldap_struct);
1612 ldap_state->ldap_struct = NULL;
1617 return rc;
1620 /*******************************************************************
1621 run the search by name.
1622 ******************************************************************/
1623 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1624 const char *filter, const char **search_attr,
1625 LDAPMessage ** result)
1627 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1628 filter, search_attr, 0, result);
1631 static void smbldap_idle_fn(struct event_context *event_ctx,
1632 struct timed_event *te,
1633 struct timeval now,
1634 void *private_data)
1636 struct smbldap_state *state = (struct smbldap_state *)private_data;
1638 TALLOC_FREE(state->idle_event);
1640 if (state->ldap_struct == NULL) {
1641 DEBUG(10,("ldap connection not connected...\n"));
1642 return;
1645 if ((state->last_use+SMBLDAP_IDLE_TIME) > now.tv_sec) {
1646 DEBUG(10,("ldap connection not idle...\n"));
1648 state->idle_event = event_add_timed(
1649 event_ctx, NULL,
1650 timeval_add(&now, SMBLDAP_IDLE_TIME, 0),
1651 smbldap_idle_fn,
1652 private_data);
1653 return;
1656 DEBUG(7,("ldap connection idle...closing connection\n"));
1657 smbldap_close(state);
1660 /**********************************************************************
1661 Housekeeping
1662 *********************************************************************/
1664 void smbldap_free_struct(struct smbldap_state **ldap_state)
1666 smbldap_close(*ldap_state);
1668 if ((*ldap_state)->bind_secret) {
1669 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1672 SAFE_FREE((*ldap_state)->bind_dn);
1673 SAFE_FREE((*ldap_state)->bind_secret);
1675 TALLOC_FREE((*ldap_state)->idle_event);
1677 *ldap_state = NULL;
1679 /* No need to free any further, as it is talloc()ed */
1683 /**********************************************************************
1684 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1685 *********************************************************************/
1687 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1688 const char *location,
1689 struct smbldap_state **smbldap_state)
1691 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1692 if (!*smbldap_state) {
1693 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1694 return NT_STATUS_NO_MEMORY;
1697 if (location) {
1698 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1699 } else {
1700 (*smbldap_state)->uri = "ldap://localhost";
1703 (*smbldap_state)->event_context = event_ctx;
1705 return NT_STATUS_OK;
1708 char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1709 LDAPMessage *entry)
1711 char *utf8_dn, *unix_dn;
1712 size_t converted_size;
1714 utf8_dn = ldap_get_dn(ld, entry);
1715 if (!utf8_dn) {
1716 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1717 return NULL;
1719 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1720 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1721 "[%s]\n", utf8_dn));
1722 return NULL;
1724 ldap_memfree(utf8_dn);
1725 return unix_dn;
1728 /*******************************************************************
1729 Check if root-dse has a certain Control or Extension
1730 ********************************************************************/
1732 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1734 LDAPMessage *msg = NULL;
1735 LDAPMessage *entry = NULL;
1736 char **values = NULL;
1737 int rc, num_result, num_values, i;
1738 bool result = False;
1740 if (!attrs[0]) {
1741 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1742 return False;
1745 if (!strequal(attrs[0], "supportedExtension") &&
1746 !strequal(attrs[0], "supportedControl") &&
1747 !strequal(attrs[0], "namingContexts")) {
1748 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1749 return False;
1752 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1753 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1755 if (rc != LDAP_SUCCESS) {
1756 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1757 return False;
1760 num_result = ldap_count_entries(ld, msg);
1762 if (num_result != 1) {
1763 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1764 goto done;
1767 entry = ldap_first_entry(ld, msg);
1769 if (entry == NULL) {
1770 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1771 goto done;
1774 values = ldap_get_values(ld, entry, attrs[0]);
1776 if (values == NULL) {
1777 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1778 goto done;
1781 num_values = ldap_count_values(values);
1783 if (num_values == 0) {
1784 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1785 goto done;
1788 for (i=0; i<num_values; i++) {
1789 if (strcmp(values[i], value) == 0)
1790 result = True;
1794 done:
1795 if (values != NULL)
1796 ldap_value_free(values);
1797 if (msg != NULL)
1798 ldap_msgfree(msg);
1800 return result;
1804 /*******************************************************************
1805 Check if LDAP-Server supports a certain Control (OID in string format)
1806 ********************************************************************/
1808 bool smbldap_has_control(LDAP *ld, const char *control)
1810 const char *attrs[] = { "supportedControl", NULL };
1811 return smbldap_check_root_dse(ld, attrs, control);
1814 /*******************************************************************
1815 Check if LDAP-Server supports a certain Extension (OID in string format)
1816 ********************************************************************/
1818 bool smbldap_has_extension(LDAP *ld, const char *extension)
1820 const char *attrs[] = { "supportedExtension", NULL };
1821 return smbldap_check_root_dse(ld, attrs, extension);
1824 /*******************************************************************
1825 Check if LDAP-Server holds a given namingContext
1826 ********************************************************************/
1828 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1830 const char *attrs[] = { "namingContexts", NULL };
1831 return smbldap_check_root_dse(ld, attrs, naming_context);
1834 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1836 ldap_state->anonymous = anon;
1838 /* free any previously set credential */
1840 SAFE_FREE(ldap_state->bind_dn);
1841 if (ldap_state->bind_secret) {
1842 /* make sure secrets are zeroed out of memory */
1843 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1844 SAFE_FREE(ldap_state->bind_secret);
1847 if ( ! anon) {
1848 ldap_state->bind_dn = SMB_STRDUP(dn);
1849 ldap_state->bind_secret = SMB_STRDUP(secret);
1852 return True;