s3/smbldap: Fix typo in debug message.
[Samba.git] / source / lib / smbldap.c
blob918962735149a2de127cb3124e43c16d1ca69ab1
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;
302 if (attribute == NULL) {
303 return NULL;
306 values = ldap_get_values(ldap_struct, entry, attribute);
308 if (values == NULL) {
309 DEBUG(10, ("attribute %s does not exist\n", attribute));
310 return NULL;
313 if (ldap_count_values(values) != 1) {
314 DEBUG(10, ("attribute %s has %d values, expected only one\n",
315 attribute, ldap_count_values(values)));
316 ldap_value_free(values);
317 return NULL;
320 if (pull_utf8_talloc(mem_ctx, &result, values[0]) == (size_t)-1) {
321 DEBUG(10, ("pull_utf8_talloc failed\n"));
322 ldap_value_free(values);
323 return NULL;
326 ldap_value_free(values);
328 #ifdef DEBUG_PASSWORDS
329 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
330 attribute, result));
331 #endif
332 return result;
335 static int ldapmsg_destructor(LDAPMessage **result) {
336 ldap_msgfree(*result);
337 return 0;
340 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
342 LDAPMessage **handle;
344 if (result == NULL) {
345 return;
348 handle = TALLOC_P(mem_ctx, LDAPMessage *);
349 SMB_ASSERT(handle != NULL);
351 *handle = result;
352 talloc_set_destructor(handle, ldapmsg_destructor);
355 static int ldapmod_destructor(LDAPMod ***mod) {
356 ldap_mods_free(*mod, True);
357 return 0;
360 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
362 LDAPMod ***handle;
364 if (mod == NULL) {
365 return;
368 handle = TALLOC_P(mem_ctx, LDAPMod **);
369 SMB_ASSERT(handle != NULL);
371 *handle = mod;
372 talloc_set_destructor(handle, ldapmod_destructor);
375 /************************************************************************
376 Routine to manage the LDAPMod structure array
377 manage memory used by the array, by each struct, and values
378 ***********************************************************************/
380 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
382 LDAPMod **mods;
383 int i;
384 int j;
386 mods = *modlist;
388 /* sanity checks on the mod values */
390 if (attribute == NULL || *attribute == '\0') {
391 return;
394 #if 0 /* commented out after discussion with abartlet. Do not reenable.
395 left here so other do not re-add similar code --jerry */
396 if (value == NULL || *value == '\0')
397 return;
398 #endif
400 if (mods == NULL) {
401 mods = SMB_MALLOC_P(LDAPMod *);
402 if (mods == NULL) {
403 smb_panic("smbldap_set_mod: out of memory!");
404 /* notreached. */
406 mods[0] = NULL;
409 for (i = 0; mods[i] != NULL; ++i) {
410 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
411 break;
414 if (mods[i] == NULL) {
415 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
416 if (mods == NULL) {
417 smb_panic("smbldap_set_mod: out of memory!");
418 /* notreached. */
420 mods[i] = SMB_MALLOC_P(LDAPMod);
421 if (mods[i] == NULL) {
422 smb_panic("smbldap_set_mod: out of memory!");
423 /* notreached. */
425 mods[i]->mod_op = modop;
426 mods[i]->mod_values = NULL;
427 mods[i]->mod_type = SMB_STRDUP(attribute);
428 mods[i + 1] = NULL;
431 if (value != NULL) {
432 char *utf8_value = NULL;
434 j = 0;
435 if (mods[i]->mod_values != NULL) {
436 for (; mods[i]->mod_values[j] != NULL; j++);
438 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
440 if (mods[i]->mod_values == NULL) {
441 smb_panic("smbldap_set_mod: out of memory!");
442 /* notreached. */
445 if (push_utf8_allocate(&utf8_value, value) == (size_t)-1) {
446 smb_panic("smbldap_set_mod: String conversion failure!");
447 /* notreached. */
450 mods[i]->mod_values[j] = utf8_value;
452 mods[i]->mod_values[j + 1] = NULL;
454 *modlist = mods;
457 /**********************************************************************
458 Set attribute to newval in LDAP, regardless of what value the
459 attribute had in LDAP before.
460 *********************************************************************/
462 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
463 LDAPMod ***mods,
464 const char *attribute, const char *newval)
466 char oldval[2048]; /* current largest allowed value is mungeddial */
467 bool existed;
469 if (attribute == NULL) {
470 /* This can actually happen for ldapsam_compat where we for
471 * example don't have a password history */
472 return;
475 if (existing != NULL) {
476 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
477 } else {
478 existed = False;
479 *oldval = '\0';
482 /* all of our string attributes are case insensitive */
484 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
486 /* Believe it or not, but LDAP will deny a delete and
487 an add at the same time if the values are the
488 same... */
489 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
490 return;
493 if (existed) {
494 /* There has been no value before, so don't delete it.
495 * Here's a possible race: We might end up with
496 * duplicate attributes */
497 /* By deleting exactly the value we found in the entry this
498 * should be race-free in the sense that the LDAP-Server will
499 * deny the complete operation if somebody changed the
500 * attribute behind our back. */
501 /* This will also allow modifying single valued attributes
502 * in Novell NDS. In NDS you have to first remove attribute and then
503 * you could add new value */
505 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
506 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
509 /* Regardless of the real operation (add or modify)
510 we add the new value here. We rely on deleting
511 the old value, should it exist. */
513 if ((newval != NULL) && (strlen(newval) > 0)) {
514 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
515 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
519 /**********************************************************************
520 Some varients of the LDAP rebind code do not pass in the third 'arg'
521 pointer to a void*, so we try and work around it by assuming that the
522 value of the 'LDAP *' pointer is the same as the one we had passed in
523 **********************************************************************/
525 struct smbldap_state_lookup {
526 LDAP *ld;
527 struct smbldap_state *smbldap_state;
528 struct smbldap_state_lookup *prev, *next;
531 static struct smbldap_state_lookup *smbldap_state_lookup_list;
533 static struct smbldap_state *smbldap_find_state(LDAP *ld)
535 struct smbldap_state_lookup *t;
537 for (t = smbldap_state_lookup_list; t; t = t->next) {
538 if (t->ld == ld) {
539 return t->smbldap_state;
542 return NULL;
545 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
547 struct smbldap_state_lookup *t;
549 for (t = smbldap_state_lookup_list; t; t = t->next) {
550 if (t->smbldap_state == smbldap_state) {
551 DLIST_REMOVE(smbldap_state_lookup_list, t);
552 SAFE_FREE(t);
553 return;
558 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
560 struct smbldap_state *tmp_ldap_state;
561 struct smbldap_state_lookup *t;
563 if ((tmp_ldap_state = smbldap_find_state(ld))) {
564 SMB_ASSERT(tmp_ldap_state == smbldap_state);
565 return;
568 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
569 ZERO_STRUCTP(t);
571 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
572 t->ld = ld;
573 t->smbldap_state = smbldap_state;
576 /********************************************************************
577 start TLS on an existing LDAP connection
578 *******************************************************************/
580 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
582 int rc;
584 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
585 return LDAP_SUCCESS;
588 #ifdef LDAP_OPT_X_TLS
589 if (version != LDAP_VERSION3) {
590 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
591 return LDAP_OPERATIONS_ERROR;
594 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
595 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
596 ldap_err2string(rc)));
597 return rc;
600 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
601 return LDAP_SUCCESS;
602 #else
603 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
604 return LDAP_OPERATIONS_ERROR;
605 #endif
608 /********************************************************************
609 setup a connection to the LDAP server based on a uri
610 *******************************************************************/
612 int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
614 int rc;
616 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
618 #ifdef HAVE_LDAP_INITIALIZE
620 rc = ldap_initialize(ldap_struct, uri);
621 if (rc) {
622 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
625 return rc;
626 #else
628 /* Parse the string manually */
631 int port = 0;
632 fstring protocol;
633 fstring host;
634 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
637 /* skip leading "URL:" (if any) */
638 if ( strnequal( uri, "URL:", 4 ) ) {
639 uri += 4;
642 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
644 if (port == 0) {
645 if (strequal(protocol, "ldap")) {
646 port = LDAP_PORT;
647 } else if (strequal(protocol, "ldaps")) {
648 port = LDAPS_PORT;
649 } else {
650 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
654 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
655 DEBUG(0, ("ldap_init failed !\n"));
656 return LDAP_OPERATIONS_ERROR;
659 if (strequal(protocol, "ldaps")) {
660 #ifdef LDAP_OPT_X_TLS
661 int tls = LDAP_OPT_X_TLS_HARD;
662 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
664 DEBUG(0, ("Failed to setup a TLS session\n"));
667 DEBUG(3,("LDAPS option set...!\n"));
668 #else
669 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
670 return LDAP_OPERATIONS_ERROR;
671 #endif /* LDAP_OPT_X_TLS */
674 #endif /* HAVE_LDAP_INITIALIZE */
677 /* now set connection timeout */
678 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
680 int ct = lp_ldap_connection_timeout()*1000;
681 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
682 if (rc != LDAP_SUCCESS) {
683 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
684 ct, ldap_err2string(rc)));
687 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
689 struct timeval ct;
690 ct.tv_usec = 0;
691 ct.tv_sec = lp_ldap_connection_timeout();
692 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
693 if (rc != LDAP_SUCCESS) {
694 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
695 (int)ct.tv_sec, ldap_err2string(rc)));
698 #endif
700 return LDAP_SUCCESS;
703 /********************************************************************
704 try to upgrade to Version 3 LDAP if not already, in either case return current
705 version
706 *******************************************************************/
708 int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
710 int version;
711 int rc;
713 /* assume the worst */
714 *new_version = LDAP_VERSION2;
716 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
717 if (rc) {
718 return rc;
721 if (version == LDAP_VERSION3) {
722 *new_version = LDAP_VERSION3;
723 return LDAP_SUCCESS;
726 /* try upgrade */
727 version = LDAP_VERSION3;
728 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
729 if (rc) {
730 return rc;
733 *new_version = LDAP_VERSION3;
734 return LDAP_SUCCESS;
737 /*******************************************************************
738 open a connection to the ldap server (just until the bind)
739 ******************************************************************/
741 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
743 int rc, version;
745 rc = smb_ldap_setup_conn(ldap_struct, uri);
746 if (rc) {
747 return rc;
750 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
751 if (rc) {
752 return rc;
755 rc = smb_ldap_start_tls(*ldap_struct, version);
756 if (rc) {
757 return rc;
760 return LDAP_SUCCESS;
763 /*******************************************************************
764 open a connection to the ldap server.
765 ******************************************************************/
766 static int smbldap_open_connection (struct smbldap_state *ldap_state)
769 int rc = LDAP_SUCCESS;
770 int version;
771 LDAP **ldap_struct = &ldap_state->ldap_struct;
773 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
774 if (rc) {
775 return rc;
778 /* Store the LDAP pointer in a lookup list */
780 smbldap_store_state(*ldap_struct, ldap_state);
782 /* Upgrade to LDAPv3 if possible */
784 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
785 if (rc) {
786 return rc;
789 /* Start TLS if required */
791 rc = smb_ldap_start_tls(*ldap_struct, version);
792 if (rc) {
793 return rc;
796 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
797 return rc;
800 /*******************************************************************
801 a rebind function for authenticated referrals
802 This version takes a void* that we can shove useful stuff in :-)
803 ******************************************************************/
804 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
805 #else
806 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
807 int *methodp, int freeit, void *arg)
809 struct smbldap_state *ldap_state = arg;
811 /** @TODO Should we be doing something to check what servers we rebind to?
812 Could we get a referral to a machine that we don't want to give our
813 username and password to? */
815 if (freeit) {
816 SAFE_FREE(*whop);
817 if (*credp) {
818 memset(*credp, '\0', strlen(*credp));
820 SAFE_FREE(*credp);
821 } else {
822 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
823 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
825 if (ldap_state->anonymous) {
826 *whop = NULL;
827 *credp = NULL;
828 } else {
829 *whop = SMB_STRDUP(ldap_state->bind_dn);
830 if (!*whop) {
831 return LDAP_NO_MEMORY;
833 *credp = SMB_STRDUP(ldap_state->bind_secret);
834 if (!*credp) {
835 SAFE_FREE(*whop);
836 return LDAP_NO_MEMORY;
839 *methodp = LDAP_AUTH_SIMPLE;
842 GetTimeOfDay(&ldap_state->last_rebind);
844 return 0;
846 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
848 /*******************************************************************
849 a rebind function for authenticated referrals
850 This version takes a void* that we can shove useful stuff in :-)
851 and actually does the connection.
852 ******************************************************************/
853 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
854 static int rebindproc_connect_with_state (LDAP *ldap_struct,
855 LDAP_CONST char *url,
856 ber_tag_t request,
857 ber_int_t msgid, void *arg)
859 struct smbldap_state *ldap_state =
860 (struct smbldap_state *)arg;
861 int rc;
862 int version;
864 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
865 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
867 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
868 * itself) before rebinding to another LDAP server to avoid to expose
869 * our credentials. At least *try* to secure the connection - Guenther */
871 smb_ldap_upgrade_conn(ldap_struct, &version);
872 smb_ldap_start_tls(ldap_struct, version);
874 /** @TODO Should we be doing something to check what servers we rebind to?
875 Could we get a referral to a machine that we don't want to give our
876 username and password to? */
878 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
880 /* only set the last rebind timestamp when we did rebind after a
881 * non-read LDAP operation. That way we avoid the replication sleep
882 * after a simple redirected search operation - Guenther */
884 switch (request) {
886 case LDAP_REQ_MODIFY:
887 case LDAP_REQ_ADD:
888 case LDAP_REQ_DELETE:
889 case LDAP_REQ_MODDN:
890 case LDAP_REQ_EXTENDED:
891 DEBUG(10,("rebindproc_connect_with_state: "
892 "setting last_rebind timestamp "
893 "(req: 0x%02x)\n", (unsigned int)request));
894 GetTimeOfDay(&ldap_state->last_rebind);
895 break;
896 default:
897 ZERO_STRUCT(ldap_state->last_rebind);
898 break;
901 return rc;
903 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
905 /*******************************************************************
906 Add a rebind function for authenticated referrals
907 ******************************************************************/
908 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
909 #else
910 # if LDAP_SET_REBIND_PROC_ARGS == 2
911 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
912 int *method, int freeit )
914 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
916 return rebindproc_with_state(ldap_struct, whop, credp,
917 method, freeit, ldap_state);
920 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
921 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
923 /*******************************************************************
924 a rebind function for authenticated referrals
925 this also does the connection, but no void*.
926 ******************************************************************/
927 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
928 # if LDAP_SET_REBIND_PROC_ARGS == 2
929 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
930 ber_int_t msgid)
932 struct smbldap_state *ldap_state = smbldap_find_state(ld);
934 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
935 ldap_state);
937 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
938 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
940 /*******************************************************************
941 connect to the ldap server under system privilege.
942 ******************************************************************/
943 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
945 int rc;
946 int version;
948 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
950 /* get the default dn and password only if they are not set already */
951 if (!fetch_ldap_pw(&ldap_state->bind_dn, &ldap_state->bind_secret)) {
952 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
953 return LDAP_INVALID_CREDENTIALS;
957 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
958 (OpenLDAP) doesnt' seem to support it */
960 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
961 ldap_state->uri, ldap_state->bind_dn));
963 #ifdef HAVE_LDAP_SET_REBIND_PROC
964 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
965 # if LDAP_SET_REBIND_PROC_ARGS == 2
966 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
967 # endif
968 # if LDAP_SET_REBIND_PROC_ARGS == 3
969 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
970 # endif
971 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
972 # if LDAP_SET_REBIND_PROC_ARGS == 2
973 ldap_set_rebind_proc(ldap_struct, &rebindproc);
974 # endif
975 # if LDAP_SET_REBIND_PROC_ARGS == 3
976 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
977 # endif
978 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
979 #endif
981 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
983 if (rc != LDAP_SUCCESS) {
984 char *ld_error = NULL;
985 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
986 &ld_error);
987 DEBUG(ldap_state->num_failures ? 2 : 0,
988 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
989 ldap_state->uri,
990 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
991 ldap_err2string(rc),
992 ld_error ? ld_error : "(unknown)"));
993 SAFE_FREE(ld_error);
994 ldap_state->num_failures++;
995 return rc;
998 ldap_state->num_failures = 0;
999 ldap_state->paged_results = False;
1001 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1003 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1004 ldap_state->paged_results = True;
1007 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1008 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1009 ldap_state->paged_results ? "does" : "does not"));
1010 return rc;
1013 static void smbldap_idle_fn(struct event_context *event_ctx,
1014 struct timed_event *te,
1015 const struct timeval *now,
1016 void *private_data);
1018 /**********************************************************************
1019 Connect to LDAP server (called before every ldap operation)
1020 *********************************************************************/
1021 static int smbldap_open(struct smbldap_state *ldap_state)
1023 int rc, opt_rc;
1024 bool reopen = False;
1025 SMB_ASSERT(ldap_state);
1027 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1029 #ifdef HAVE_UNIXSOCKET
1030 struct sockaddr_un addr;
1031 #else
1032 struct sockaddr addr;
1033 #endif
1034 socklen_t len = sizeof(addr);
1035 int sd;
1037 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1038 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1039 reopen = True;
1041 #ifdef HAVE_UNIXSOCKET
1042 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1043 reopen = True;
1044 #endif
1045 if (reopen) {
1046 /* the other end has died. reopen. */
1047 ldap_unbind(ldap_state->ldap_struct);
1048 ldap_state->ldap_struct = NULL;
1049 ldap_state->last_ping = (time_t)0;
1050 } else {
1051 ldap_state->last_ping = time(NULL);
1055 if (ldap_state->ldap_struct != NULL) {
1056 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1057 return LDAP_SUCCESS;
1060 if ((rc = smbldap_open_connection(ldap_state))) {
1061 return rc;
1064 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1065 ldap_unbind(ldap_state->ldap_struct);
1066 ldap_state->ldap_struct = NULL;
1067 return rc;
1071 ldap_state->last_ping = time(NULL);
1072 ldap_state->pid = sys_getpid();
1074 TALLOC_FREE(ldap_state->idle_event);
1076 if (ldap_state->event_context != NULL) {
1077 ldap_state->idle_event = event_add_timed(
1078 ldap_state->event_context, NULL,
1079 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1080 "smbldap_idle_fn", smbldap_idle_fn, ldap_state);
1083 DEBUG(4,("The LDAP server is successfully connected\n"));
1085 return LDAP_SUCCESS;
1088 /**********************************************************************
1089 Disconnect from LDAP server
1090 *********************************************************************/
1091 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1093 if (!ldap_state)
1094 return NT_STATUS_INVALID_PARAMETER;
1096 if (ldap_state->ldap_struct != NULL) {
1097 ldap_unbind(ldap_state->ldap_struct);
1098 ldap_state->ldap_struct = NULL;
1101 smbldap_delete_state(ldap_state);
1103 DEBUG(5,("The connection to the LDAP server was closed\n"));
1104 /* maybe free the results here --metze */
1106 return NT_STATUS_OK;
1109 static bool got_alarm;
1111 static void (*old_handler)(int);
1113 static void gotalarm_sig(int dummy)
1115 got_alarm = True;
1118 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1119 int *attempts, time_t endtime)
1121 time_t now = time(NULL);
1122 int open_rc = LDAP_SERVER_DOWN;
1124 if (*rc != LDAP_SERVER_DOWN)
1125 goto no_next;
1127 if (now >= endtime) {
1128 smbldap_close(ldap_state);
1129 *rc = LDAP_TIMEOUT;
1130 goto no_next;
1133 if (*attempts == 0) {
1134 got_alarm = False;
1135 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1136 alarm(endtime - now);
1138 if (ldap_state->pid != sys_getpid())
1139 smbldap_close(ldap_state);
1142 while (1) {
1144 if (*attempts != 0)
1145 smb_msleep(1000);
1147 *attempts += 1;
1149 open_rc = smbldap_open(ldap_state);
1151 if (open_rc == LDAP_SUCCESS) {
1152 ldap_state->last_use = now;
1153 return True;
1156 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1157 /* The fact that we are non-root or any other
1158 * access-denied condition will not change in the next
1159 * round of trying */
1160 *rc = open_rc;
1161 break;
1164 if (got_alarm) {
1165 *rc = LDAP_TIMEOUT;
1166 break;
1169 if (open_rc != LDAP_SUCCESS) {
1170 DEBUG(1, ("Connection to LDAP server failed for the "
1171 "%d try!\n", *attempts));
1175 no_next:
1176 CatchSignal(SIGALRM, old_handler);
1177 alarm(0);
1178 ldap_state->last_use = now;
1179 return False;
1182 /*********************************************************************
1183 ********************************************************************/
1185 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1186 const char *base, int scope, const char *filter,
1187 const char *attrs[], int attrsonly,
1188 LDAPControl **sctrls, LDAPControl **cctrls,
1189 int sizelimit, LDAPMessage **res)
1191 int rc = LDAP_SERVER_DOWN;
1192 int attempts = 0;
1193 char *utf8_filter;
1194 time_t endtime = time(NULL)+lp_ldap_timeout();
1195 struct timeval timeout;
1197 SMB_ASSERT(ldap_state);
1199 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1200 "scope => [%d]\n", base, filter, scope));
1202 if (ldap_state->last_rebind.tv_sec > 0) {
1203 struct timeval tval;
1204 SMB_BIG_INT tdiff = 0;
1205 int sleep_time = 0;
1207 ZERO_STRUCT(tval);
1208 GetTimeOfDay(&tval);
1210 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1211 tdiff /= 1000; /* Convert to milliseconds. */
1213 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1214 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1216 if (sleep_time > 0) {
1217 /* we wait for the LDAP replication */
1218 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1219 "for LDAP replication.\n",sleep_time));
1220 smb_msleep(sleep_time);
1221 DEBUG(5,("smbldap_search_ext: go on!\n"));
1223 ZERO_STRUCT(ldap_state->last_rebind);
1226 if (push_utf8_allocate(&utf8_filter, filter) == (size_t)-1) {
1227 return LDAP_NO_MEMORY;
1230 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1231 timeout.tv_sec = lp_ldap_timeout();
1232 timeout.tv_usec = 0;
1234 /* Setup alarm timeout.... Do we need both of these ? JRA.
1235 * Yes, I think we do need both of these. The server timeout only
1236 * covers the case where the server's operation takes too long. It
1237 * does not cover the case where the request hangs on its way to the
1238 * server. The server side timeout is not strictly necessary, it's
1239 * just a bit more kind to the server. VL. */
1241 got_alarm = 0;
1242 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1243 alarm(lp_ldap_timeout());
1244 /* End setup timeout. */
1246 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1247 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1248 utf8_filter,
1249 CONST_DISCARD(char **, attrs),
1250 attrsonly, sctrls, cctrls, &timeout,
1251 sizelimit, res);
1252 if (rc != LDAP_SUCCESS) {
1253 char *ld_error = NULL;
1254 int ld_errno;
1256 ldap_get_option(ldap_state->ldap_struct,
1257 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1259 ldap_get_option(ldap_state->ldap_struct,
1260 LDAP_OPT_ERROR_STRING, &ld_error);
1261 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1262 "(%s)\n", base, ld_errno,
1263 ldap_err2string(rc),
1264 ld_error ? ld_error : "unknown"));
1265 SAFE_FREE(ld_error);
1267 if (ld_errno == LDAP_SERVER_DOWN) {
1268 ldap_unbind(ldap_state->ldap_struct);
1269 ldap_state->ldap_struct = NULL;
1274 SAFE_FREE(utf8_filter);
1276 /* Teardown timeout. */
1277 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1278 alarm(0);
1280 if (got_alarm != 0)
1281 return LDAP_TIMELIMIT_EXCEEDED;
1283 return rc;
1286 int smbldap_search(struct smbldap_state *ldap_state,
1287 const char *base, int scope, const char *filter,
1288 const char *attrs[], int attrsonly,
1289 LDAPMessage **res)
1291 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1292 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1295 int smbldap_search_paged(struct smbldap_state *ldap_state,
1296 const char *base, int scope, const char *filter,
1297 const char **attrs, int attrsonly, int pagesize,
1298 LDAPMessage **res, void **cookie)
1300 LDAPControl pr;
1301 LDAPControl **rcontrols;
1302 LDAPControl *controls[2] = { NULL, NULL};
1303 BerElement *cookie_be = NULL;
1304 struct berval *cookie_bv = NULL;
1305 int tmp = 0, i, rc;
1306 bool critical = True;
1308 *res = NULL;
1310 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1311 "scope => [%d], pagesize => [%d]\n",
1312 base, filter, scope, pagesize));
1314 cookie_be = ber_alloc_t(LBER_USE_DER);
1315 if (cookie_be == NULL) {
1316 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1317 "NULL\n"));
1318 return LDAP_NO_MEMORY;
1321 /* construct cookie */
1322 if (*cookie != NULL) {
1323 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1324 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1325 *cookie = NULL;
1326 } else {
1327 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1329 ber_flatten(cookie_be, &cookie_bv);
1331 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1332 pr.ldctl_iscritical = (char) critical;
1333 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1334 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1336 controls[0] = &pr;
1337 controls[1] = NULL;
1339 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1340 0, controls, NULL, LDAP_NO_LIMIT, res);
1342 ber_free(cookie_be, 1);
1343 ber_bvfree(cookie_bv);
1345 if (rc != 0) {
1346 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1347 "failed with [%s]\n", filter, ldap_err2string(rc)));
1348 goto done;
1351 DEBUG(3,("smbldap_search_paged: search was successful\n"));
1353 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1354 NULL, NULL, &rcontrols, 0);
1355 if (rc != 0) {
1356 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1357 "with [%s]\n", ldap_err2string(rc)));
1358 goto done;
1361 if (rcontrols == NULL)
1362 goto done;
1364 for (i=0; rcontrols[i]; i++) {
1366 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1367 continue;
1369 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1370 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1371 /* the berval is the cookie, but must be freed when it is all
1372 done */
1373 if (cookie_bv->bv_len)
1374 *cookie=ber_bvdup(cookie_bv);
1375 else
1376 *cookie=NULL;
1377 ber_bvfree(cookie_bv);
1378 ber_free(cookie_be, 1);
1379 break;
1381 ldap_controls_free(rcontrols);
1382 done:
1383 return rc;
1386 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1388 int rc = LDAP_SERVER_DOWN;
1389 int attempts = 0;
1390 char *utf8_dn;
1391 time_t endtime = time(NULL)+lp_ldap_timeout();
1393 SMB_ASSERT(ldap_state);
1395 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1397 if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1398 return LDAP_NO_MEMORY;
1401 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1402 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1403 if (rc != LDAP_SUCCESS) {
1404 char *ld_error = NULL;
1405 int ld_errno;
1407 ldap_get_option(ldap_state->ldap_struct,
1408 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1410 ldap_get_option(ldap_state->ldap_struct,
1411 LDAP_OPT_ERROR_STRING, &ld_error);
1412 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1413 "(%s)\n", dn, ld_errno,
1414 ldap_err2string(rc),
1415 ld_error ? ld_error : "unknown"));
1416 SAFE_FREE(ld_error);
1418 if (ld_errno == LDAP_SERVER_DOWN) {
1419 ldap_unbind(ldap_state->ldap_struct);
1420 ldap_state->ldap_struct = NULL;
1425 SAFE_FREE(utf8_dn);
1426 return rc;
1429 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1431 int rc = LDAP_SERVER_DOWN;
1432 int attempts = 0;
1433 char *utf8_dn;
1434 time_t endtime = time(NULL)+lp_ldap_timeout();
1436 SMB_ASSERT(ldap_state);
1438 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1440 if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1441 return LDAP_NO_MEMORY;
1444 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1445 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1446 if (rc != LDAP_SUCCESS) {
1447 char *ld_error = NULL;
1448 int ld_errno;
1450 ldap_get_option(ldap_state->ldap_struct,
1451 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1453 ldap_get_option(ldap_state->ldap_struct,
1454 LDAP_OPT_ERROR_STRING, &ld_error);
1455 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1456 "(%s)\n", dn, ld_errno,
1457 ldap_err2string(rc),
1458 ld_error ? ld_error : "unknown"));
1459 SAFE_FREE(ld_error);
1461 if (ld_errno == LDAP_SERVER_DOWN) {
1462 ldap_unbind(ldap_state->ldap_struct);
1463 ldap_state->ldap_struct = NULL;
1468 SAFE_FREE(utf8_dn);
1469 return rc;
1472 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1474 int rc = LDAP_SERVER_DOWN;
1475 int attempts = 0;
1476 char *utf8_dn;
1477 time_t endtime = time(NULL)+lp_ldap_timeout();
1479 SMB_ASSERT(ldap_state);
1481 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1483 if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1484 return LDAP_NO_MEMORY;
1487 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1488 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1489 if (rc != LDAP_SUCCESS) {
1490 char *ld_error = NULL;
1491 int ld_errno;
1493 ldap_get_option(ldap_state->ldap_struct,
1494 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1496 ldap_get_option(ldap_state->ldap_struct,
1497 LDAP_OPT_ERROR_STRING, &ld_error);
1498 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1499 "(%s)\n", dn, ld_errno,
1500 ldap_err2string(rc),
1501 ld_error ? ld_error : "unknown"));
1502 SAFE_FREE(ld_error);
1504 if (ld_errno == LDAP_SERVER_DOWN) {
1505 ldap_unbind(ldap_state->ldap_struct);
1506 ldap_state->ldap_struct = NULL;
1511 SAFE_FREE(utf8_dn);
1512 return rc;
1515 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1516 LDAP_CONST char *reqoid, struct berval *reqdata,
1517 LDAPControl **serverctrls, LDAPControl **clientctrls,
1518 char **retoidp, struct berval **retdatap)
1520 int rc = LDAP_SERVER_DOWN;
1521 int attempts = 0;
1522 time_t endtime = time(NULL)+lp_ldap_timeout();
1524 if (!ldap_state)
1525 return (-1);
1527 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1528 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1529 reqdata, serverctrls,
1530 clientctrls, retoidp, retdatap);
1531 if (rc != LDAP_SUCCESS) {
1532 char *ld_error = NULL;
1533 int ld_errno;
1535 ldap_get_option(ldap_state->ldap_struct,
1536 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1538 ldap_get_option(ldap_state->ldap_struct,
1539 LDAP_OPT_ERROR_STRING, &ld_error);
1540 DEBUG(10, ("Extended operation failed with error: "
1541 "%d (%s) (%s)\n", ld_errno,
1542 ldap_err2string(rc),
1543 ld_error ? ld_error : "unknown"));
1544 SAFE_FREE(ld_error);
1546 if (ld_errno == LDAP_SERVER_DOWN) {
1547 ldap_unbind(ldap_state->ldap_struct);
1548 ldap_state->ldap_struct = NULL;
1553 return rc;
1556 /*******************************************************************
1557 run the search by name.
1558 ******************************************************************/
1559 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1560 const char *filter, const char **search_attr,
1561 LDAPMessage ** result)
1563 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1564 filter, search_attr, 0, result);
1567 static void smbldap_idle_fn(struct event_context *event_ctx,
1568 struct timed_event *te,
1569 const struct timeval *now,
1570 void *private_data)
1572 struct smbldap_state *state = (struct smbldap_state *)private_data;
1574 TALLOC_FREE(state->idle_event);
1576 if (state->ldap_struct == NULL) {
1577 DEBUG(10,("ldap connection not connected...\n"));
1578 return;
1581 if ((state->last_use+SMBLDAP_IDLE_TIME) > now->tv_sec) {
1582 DEBUG(10,("ldap connection not idle...\n"));
1584 state->idle_event = event_add_timed(
1585 event_ctx, NULL,
1586 timeval_add(now, SMBLDAP_IDLE_TIME, 0),
1587 "smbldap_idle_fn", smbldap_idle_fn,
1588 private_data);
1589 return;
1592 DEBUG(7,("ldap connection idle...closing connection\n"));
1593 smbldap_close(state);
1596 /**********************************************************************
1597 Housekeeping
1598 *********************************************************************/
1600 void smbldap_free_struct(struct smbldap_state **ldap_state)
1602 smbldap_close(*ldap_state);
1604 if ((*ldap_state)->bind_secret) {
1605 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1608 SAFE_FREE((*ldap_state)->bind_dn);
1609 SAFE_FREE((*ldap_state)->bind_secret);
1611 TALLOC_FREE((*ldap_state)->idle_event);
1613 *ldap_state = NULL;
1615 /* No need to free any further, as it is talloc()ed */
1619 /**********************************************************************
1620 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1621 *********************************************************************/
1623 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1624 const char *location,
1625 struct smbldap_state **smbldap_state)
1627 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1628 if (!*smbldap_state) {
1629 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1630 return NT_STATUS_NO_MEMORY;
1633 if (location) {
1634 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1635 } else {
1636 (*smbldap_state)->uri = "ldap://localhost";
1639 (*smbldap_state)->event_context = event_ctx;
1641 return NT_STATUS_OK;
1644 /*******************************************************************
1645 Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1646 ********************************************************************/
1647 char *smbldap_get_dn(LDAP *ld, LDAPMessage *entry)
1649 char *utf8_dn, *unix_dn;
1651 utf8_dn = ldap_get_dn(ld, entry);
1652 if (!utf8_dn) {
1653 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1654 return NULL;
1656 if (pull_utf8_allocate(&unix_dn, utf8_dn) == (size_t)-1) {
1657 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 [%s]\n", utf8_dn));
1658 return NULL;
1660 ldap_memfree(utf8_dn);
1661 return unix_dn;
1664 const char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1665 LDAPMessage *entry)
1667 char *utf8_dn, *unix_dn;
1669 utf8_dn = ldap_get_dn(ld, entry);
1670 if (!utf8_dn) {
1671 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1672 return NULL;
1674 if (pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn) == (size_t)-1) {
1675 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1676 "[%s]\n", utf8_dn));
1677 return NULL;
1679 ldap_memfree(utf8_dn);
1680 return unix_dn;
1683 /*******************************************************************
1684 Check if root-dse has a certain Control or Extension
1685 ********************************************************************/
1687 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1689 LDAPMessage *msg = NULL;
1690 LDAPMessage *entry = NULL;
1691 char **values = NULL;
1692 int rc, num_result, num_values, i;
1693 bool result = False;
1695 if (!attrs[0]) {
1696 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1697 return False;
1700 if (!strequal(attrs[0], "supportedExtension") &&
1701 !strequal(attrs[0], "supportedControl") &&
1702 !strequal(attrs[0], "namingContexts")) {
1703 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1704 return False;
1707 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1708 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1710 if (rc != LDAP_SUCCESS) {
1711 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1712 return False;
1715 num_result = ldap_count_entries(ld, msg);
1717 if (num_result != 1) {
1718 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1719 goto done;
1722 entry = ldap_first_entry(ld, msg);
1724 if (entry == NULL) {
1725 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1726 goto done;
1729 values = ldap_get_values(ld, entry, attrs[0]);
1731 if (values == NULL) {
1732 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1733 goto done;
1736 num_values = ldap_count_values(values);
1738 if (num_values == 0) {
1739 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1740 goto done;
1743 for (i=0; i<num_values; i++) {
1744 if (strcmp(values[i], value) == 0)
1745 result = True;
1749 done:
1750 if (values != NULL)
1751 ldap_value_free(values);
1752 if (msg != NULL)
1753 ldap_msgfree(msg);
1755 return result;
1759 /*******************************************************************
1760 Check if LDAP-Server supports a certain Control (OID in string format)
1761 ********************************************************************/
1763 bool smbldap_has_control(LDAP *ld, const char *control)
1765 const char *attrs[] = { "supportedControl", NULL };
1766 return smbldap_check_root_dse(ld, attrs, control);
1769 /*******************************************************************
1770 Check if LDAP-Server supports a certain Extension (OID in string format)
1771 ********************************************************************/
1773 bool smbldap_has_extension(LDAP *ld, const char *extension)
1775 const char *attrs[] = { "supportedExtension", NULL };
1776 return smbldap_check_root_dse(ld, attrs, extension);
1779 /*******************************************************************
1780 Check if LDAP-Server holds a given namingContext
1781 ********************************************************************/
1783 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1785 const char *attrs[] = { "namingContexts", NULL };
1786 return smbldap_check_root_dse(ld, attrs, naming_context);
1789 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1791 ldap_state->anonymous = anon;
1793 /* free any previously set credential */
1795 SAFE_FREE(ldap_state->bind_dn);
1796 if (ldap_state->bind_secret) {
1797 /* make sure secrets are zeroed out of memory */
1798 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1799 SAFE_FREE(ldap_state->bind_secret);
1802 if ( ! anon) {
1803 ldap_state->bind_dn = SMB_STRDUP(dn);
1804 ldap_state->bind_secret = SMB_STRDUP(secret);
1807 return True;