Add an entry for the "check" command to the tdbtool manpage.
[Samba/gebeck_regimport.git] / source3 / lib / smbldap.c
blobf2161dc946f4f15247782248494f9051442a9166
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 static int ldapmsg_destructor(LDAPMessage **result) {
337 ldap_msgfree(*result);
338 return 0;
341 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
343 LDAPMessage **handle;
345 if (result == NULL) {
346 return;
349 handle = TALLOC_P(mem_ctx, LDAPMessage *);
350 SMB_ASSERT(handle != NULL);
352 *handle = result;
353 talloc_set_destructor(handle, ldapmsg_destructor);
356 static int ldapmod_destructor(LDAPMod ***mod) {
357 ldap_mods_free(*mod, True);
358 return 0;
361 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
363 LDAPMod ***handle;
365 if (mod == NULL) {
366 return;
369 handle = TALLOC_P(mem_ctx, LDAPMod **);
370 SMB_ASSERT(handle != NULL);
372 *handle = mod;
373 talloc_set_destructor(handle, ldapmod_destructor);
376 /************************************************************************
377 Routine to manage the LDAPMod structure array
378 manage memory used by the array, by each struct, and values
379 ***********************************************************************/
381 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
383 LDAPMod **mods;
384 int i;
385 int j;
387 mods = *modlist;
389 /* sanity checks on the mod values */
391 if (attribute == NULL || *attribute == '\0') {
392 return;
395 #if 0 /* commented out after discussion with abartlet. Do not reenable.
396 left here so other do not re-add similar code --jerry */
397 if (value == NULL || *value == '\0')
398 return;
399 #endif
401 if (mods == NULL) {
402 mods = SMB_MALLOC_P(LDAPMod *);
403 if (mods == NULL) {
404 smb_panic("smbldap_set_mod: out of memory!");
405 /* notreached. */
407 mods[0] = NULL;
410 for (i = 0; mods[i] != NULL; ++i) {
411 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
412 break;
415 if (mods[i] == NULL) {
416 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
417 if (mods == NULL) {
418 smb_panic("smbldap_set_mod: out of memory!");
419 /* notreached. */
421 mods[i] = SMB_MALLOC_P(LDAPMod);
422 if (mods[i] == NULL) {
423 smb_panic("smbldap_set_mod: out of memory!");
424 /* notreached. */
426 mods[i]->mod_op = modop;
427 mods[i]->mod_values = NULL;
428 mods[i]->mod_type = SMB_STRDUP(attribute);
429 mods[i + 1] = NULL;
432 if (value != NULL) {
433 char *utf8_value = NULL;
434 size_t converted_size;
436 j = 0;
437 if (mods[i]->mod_values != NULL) {
438 for (; mods[i]->mod_values[j] != NULL; j++);
440 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
442 if (mods[i]->mod_values == NULL) {
443 smb_panic("smbldap_set_mod: out of memory!");
444 /* notreached. */
447 if (!push_utf8_allocate(&utf8_value, value, &converted_size)) {
448 smb_panic("smbldap_set_mod: String conversion failure!");
449 /* notreached. */
452 mods[i]->mod_values[j] = utf8_value;
454 mods[i]->mod_values[j + 1] = NULL;
456 *modlist = mods;
459 /**********************************************************************
460 Set attribute to newval in LDAP, regardless of what value the
461 attribute had in LDAP before.
462 *********************************************************************/
464 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
465 LDAPMod ***mods,
466 const char *attribute, const char *newval)
468 char oldval[2048]; /* current largest allowed value is mungeddial */
469 bool existed;
471 if (attribute == NULL) {
472 /* This can actually happen for ldapsam_compat where we for
473 * example don't have a password history */
474 return;
477 if (existing != NULL) {
478 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
479 } else {
480 existed = False;
481 *oldval = '\0';
484 /* all of our string attributes are case insensitive */
486 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
488 /* Believe it or not, but LDAP will deny a delete and
489 an add at the same time if the values are the
490 same... */
491 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
492 return;
495 if (existed) {
496 /* There has been no value before, so don't delete it.
497 * Here's a possible race: We might end up with
498 * duplicate attributes */
499 /* By deleting exactly the value we found in the entry this
500 * should be race-free in the sense that the LDAP-Server will
501 * deny the complete operation if somebody changed the
502 * attribute behind our back. */
503 /* This will also allow modifying single valued attributes
504 * in Novell NDS. In NDS you have to first remove attribute and then
505 * you could add new value */
507 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
508 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
511 /* Regardless of the real operation (add or modify)
512 we add the new value here. We rely on deleting
513 the old value, should it exist. */
515 if ((newval != NULL) && (strlen(newval) > 0)) {
516 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
517 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
521 /**********************************************************************
522 Some varients of the LDAP rebind code do not pass in the third 'arg'
523 pointer to a void*, so we try and work around it by assuming that the
524 value of the 'LDAP *' pointer is the same as the one we had passed in
525 **********************************************************************/
527 struct smbldap_state_lookup {
528 LDAP *ld;
529 struct smbldap_state *smbldap_state;
530 struct smbldap_state_lookup *prev, *next;
533 static struct smbldap_state_lookup *smbldap_state_lookup_list;
535 static struct smbldap_state *smbldap_find_state(LDAP *ld)
537 struct smbldap_state_lookup *t;
539 for (t = smbldap_state_lookup_list; t; t = t->next) {
540 if (t->ld == ld) {
541 return t->smbldap_state;
544 return NULL;
547 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
549 struct smbldap_state_lookup *t;
551 for (t = smbldap_state_lookup_list; t; t = t->next) {
552 if (t->smbldap_state == smbldap_state) {
553 DLIST_REMOVE(smbldap_state_lookup_list, t);
554 SAFE_FREE(t);
555 return;
560 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
562 struct smbldap_state *tmp_ldap_state;
563 struct smbldap_state_lookup *t;
565 if ((tmp_ldap_state = smbldap_find_state(ld))) {
566 SMB_ASSERT(tmp_ldap_state == smbldap_state);
567 return;
570 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
571 ZERO_STRUCTP(t);
573 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
574 t->ld = ld;
575 t->smbldap_state = smbldap_state;
578 /********************************************************************
579 start TLS on an existing LDAP connection
580 *******************************************************************/
582 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
584 int rc;
586 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
587 return LDAP_SUCCESS;
590 #ifdef LDAP_OPT_X_TLS
591 if (version != LDAP_VERSION3) {
592 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
593 return LDAP_OPERATIONS_ERROR;
596 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
597 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
598 ldap_err2string(rc)));
599 return rc;
602 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
603 return LDAP_SUCCESS;
604 #else
605 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
606 return LDAP_OPERATIONS_ERROR;
607 #endif
610 /********************************************************************
611 setup a connection to the LDAP server based on a uri
612 *******************************************************************/
614 int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
616 int rc;
618 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
620 #ifdef HAVE_LDAP_INITIALIZE
622 rc = ldap_initialize(ldap_struct, uri);
623 if (rc) {
624 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
627 return rc;
628 #else
630 /* Parse the string manually */
633 int port = 0;
634 fstring protocol;
635 fstring host;
636 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
639 /* skip leading "URL:" (if any) */
640 if ( strnequal( uri, "URL:", 4 ) ) {
641 uri += 4;
644 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
646 if (port == 0) {
647 if (strequal(protocol, "ldap")) {
648 port = LDAP_PORT;
649 } else if (strequal(protocol, "ldaps")) {
650 port = LDAPS_PORT;
651 } else {
652 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
656 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
657 DEBUG(0, ("ldap_init failed !\n"));
658 return LDAP_OPERATIONS_ERROR;
661 if (strequal(protocol, "ldaps")) {
662 #ifdef LDAP_OPT_X_TLS
663 int tls = LDAP_OPT_X_TLS_HARD;
664 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
666 DEBUG(0, ("Failed to setup a TLS session\n"));
669 DEBUG(3,("LDAPS option set...!\n"));
670 #else
671 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
672 return LDAP_OPERATIONS_ERROR;
673 #endif /* LDAP_OPT_X_TLS */
676 #endif /* HAVE_LDAP_INITIALIZE */
679 /* now set connection timeout */
680 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
682 int ct = lp_ldap_connection_timeout()*1000;
683 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
684 if (rc != LDAP_SUCCESS) {
685 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
686 ct, ldap_err2string(rc)));
689 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
691 struct timeval ct;
692 ct.tv_usec = 0;
693 ct.tv_sec = lp_ldap_connection_timeout();
694 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
695 if (rc != LDAP_SUCCESS) {
696 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
697 (int)ct.tv_sec, ldap_err2string(rc)));
700 #endif
702 return LDAP_SUCCESS;
705 /********************************************************************
706 try to upgrade to Version 3 LDAP if not already, in either case return current
707 version
708 *******************************************************************/
710 int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
712 int version;
713 int rc;
715 /* assume the worst */
716 *new_version = LDAP_VERSION2;
718 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
719 if (rc) {
720 return rc;
723 if (version == LDAP_VERSION3) {
724 *new_version = LDAP_VERSION3;
725 return LDAP_SUCCESS;
728 /* try upgrade */
729 version = LDAP_VERSION3;
730 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
731 if (rc) {
732 return rc;
735 *new_version = LDAP_VERSION3;
736 return LDAP_SUCCESS;
739 /*******************************************************************
740 open a connection to the ldap server (just until the bind)
741 ******************************************************************/
743 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
745 int rc, version;
747 rc = smb_ldap_setup_conn(ldap_struct, uri);
748 if (rc) {
749 return rc;
752 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
753 if (rc) {
754 return rc;
757 rc = smb_ldap_start_tls(*ldap_struct, version);
758 if (rc) {
759 return rc;
762 return LDAP_SUCCESS;
765 /*******************************************************************
766 open a connection to the ldap server.
767 ******************************************************************/
768 static int smbldap_open_connection (struct smbldap_state *ldap_state)
771 int rc = LDAP_SUCCESS;
772 int version;
773 LDAP **ldap_struct = &ldap_state->ldap_struct;
775 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
776 if (rc) {
777 return rc;
780 /* Store the LDAP pointer in a lookup list */
782 smbldap_store_state(*ldap_struct, ldap_state);
784 /* Upgrade to LDAPv3 if possible */
786 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
787 if (rc) {
788 return rc;
791 /* Start TLS if required */
793 rc = smb_ldap_start_tls(*ldap_struct, version);
794 if (rc) {
795 return rc;
798 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
799 return rc;
802 /*******************************************************************
803 a rebind function for authenticated referrals
804 This version takes a void* that we can shove useful stuff in :-)
805 ******************************************************************/
806 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
807 #else
808 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
809 int *methodp, int freeit, void *arg)
811 struct smbldap_state *ldap_state = arg;
813 /** @TODO Should we be doing something to check what servers we rebind to?
814 Could we get a referral to a machine that we don't want to give our
815 username and password to? */
817 if (freeit) {
818 SAFE_FREE(*whop);
819 if (*credp) {
820 memset(*credp, '\0', strlen(*credp));
822 SAFE_FREE(*credp);
823 } else {
824 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
825 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
827 if (ldap_state->anonymous) {
828 *whop = NULL;
829 *credp = NULL;
830 } else {
831 *whop = SMB_STRDUP(ldap_state->bind_dn);
832 if (!*whop) {
833 return LDAP_NO_MEMORY;
835 *credp = SMB_STRDUP(ldap_state->bind_secret);
836 if (!*credp) {
837 SAFE_FREE(*whop);
838 return LDAP_NO_MEMORY;
841 *methodp = LDAP_AUTH_SIMPLE;
844 GetTimeOfDay(&ldap_state->last_rebind);
846 return 0;
848 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
850 /*******************************************************************
851 a rebind function for authenticated referrals
852 This version takes a void* that we can shove useful stuff in :-)
853 and actually does the connection.
854 ******************************************************************/
855 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
856 static int rebindproc_connect_with_state (LDAP *ldap_struct,
857 LDAP_CONST char *url,
858 ber_tag_t request,
859 ber_int_t msgid, void *arg)
861 struct smbldap_state *ldap_state =
862 (struct smbldap_state *)arg;
863 int rc;
864 int version;
866 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
867 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
869 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
870 * itself) before rebinding to another LDAP server to avoid to expose
871 * our credentials. At least *try* to secure the connection - Guenther */
873 smb_ldap_upgrade_conn(ldap_struct, &version);
874 smb_ldap_start_tls(ldap_struct, version);
876 /** @TODO Should we be doing something to check what servers we rebind to?
877 Could we get a referral to a machine that we don't want to give our
878 username and password to? */
880 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
882 /* only set the last rebind timestamp when we did rebind after a
883 * non-read LDAP operation. That way we avoid the replication sleep
884 * after a simple redirected search operation - Guenther */
886 switch (request) {
888 case LDAP_REQ_MODIFY:
889 case LDAP_REQ_ADD:
890 case LDAP_REQ_DELETE:
891 case LDAP_REQ_MODDN:
892 case LDAP_REQ_EXTENDED:
893 DEBUG(10,("rebindproc_connect_with_state: "
894 "setting last_rebind timestamp "
895 "(req: 0x%02x)\n", (unsigned int)request));
896 GetTimeOfDay(&ldap_state->last_rebind);
897 break;
898 default:
899 ZERO_STRUCT(ldap_state->last_rebind);
900 break;
903 return rc;
905 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
907 /*******************************************************************
908 Add a rebind function for authenticated referrals
909 ******************************************************************/
910 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
911 #else
912 # if LDAP_SET_REBIND_PROC_ARGS == 2
913 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
914 int *method, int freeit )
916 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
918 return rebindproc_with_state(ldap_struct, whop, credp,
919 method, freeit, ldap_state);
922 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
923 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
925 /*******************************************************************
926 a rebind function for authenticated referrals
927 this also does the connection, but no void*.
928 ******************************************************************/
929 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
930 # if LDAP_SET_REBIND_PROC_ARGS == 2
931 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
932 ber_int_t msgid)
934 struct smbldap_state *ldap_state = smbldap_find_state(ld);
936 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
937 ldap_state);
939 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
940 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
942 /*******************************************************************
943 connect to the ldap server under system privilege.
944 ******************************************************************/
945 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
947 int rc;
948 int version;
950 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
952 /* get the default dn and password only if they are not set already */
953 if (!fetch_ldap_pw(&ldap_state->bind_dn, &ldap_state->bind_secret)) {
954 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
955 return LDAP_INVALID_CREDENTIALS;
959 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
960 (OpenLDAP) doesnt' seem to support it */
962 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
963 ldap_state->uri, ldap_state->bind_dn));
965 #ifdef HAVE_LDAP_SET_REBIND_PROC
966 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
967 # if LDAP_SET_REBIND_PROC_ARGS == 2
968 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
969 # endif
970 # if LDAP_SET_REBIND_PROC_ARGS == 3
971 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
972 # endif
973 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
974 # if LDAP_SET_REBIND_PROC_ARGS == 2
975 ldap_set_rebind_proc(ldap_struct, &rebindproc);
976 # endif
977 # if LDAP_SET_REBIND_PROC_ARGS == 3
978 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
979 # endif
980 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
981 #endif
983 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
985 if (rc != LDAP_SUCCESS) {
986 char *ld_error = NULL;
987 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
988 &ld_error);
989 DEBUG(ldap_state->num_failures ? 2 : 0,
990 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
991 ldap_state->uri,
992 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
993 ldap_err2string(rc),
994 ld_error ? ld_error : "(unknown)"));
995 SAFE_FREE(ld_error);
996 ldap_state->num_failures++;
997 return rc;
1000 ldap_state->num_failures = 0;
1001 ldap_state->paged_results = False;
1003 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1005 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1006 ldap_state->paged_results = True;
1009 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1010 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1011 ldap_state->paged_results ? "does" : "does not"));
1012 return rc;
1015 static void smbldap_idle_fn(struct event_context *event_ctx,
1016 struct timed_event *te,
1017 const struct timeval *now,
1018 void *private_data);
1020 /**********************************************************************
1021 Connect to LDAP server (called before every ldap operation)
1022 *********************************************************************/
1023 static int smbldap_open(struct smbldap_state *ldap_state)
1025 int rc, opt_rc;
1026 bool reopen = False;
1027 SMB_ASSERT(ldap_state);
1029 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1031 #ifdef HAVE_UNIXSOCKET
1032 struct sockaddr_un addr;
1033 #else
1034 struct sockaddr addr;
1035 #endif
1036 socklen_t len = sizeof(addr);
1037 int sd;
1039 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1040 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1041 reopen = True;
1043 #ifdef HAVE_UNIXSOCKET
1044 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1045 reopen = True;
1046 #endif
1047 if (reopen) {
1048 /* the other end has died. reopen. */
1049 ldap_unbind(ldap_state->ldap_struct);
1050 ldap_state->ldap_struct = NULL;
1051 ldap_state->last_ping = (time_t)0;
1052 } else {
1053 ldap_state->last_ping = time(NULL);
1057 if (ldap_state->ldap_struct != NULL) {
1058 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1059 return LDAP_SUCCESS;
1062 if ((rc = smbldap_open_connection(ldap_state))) {
1063 return rc;
1066 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1067 ldap_unbind(ldap_state->ldap_struct);
1068 ldap_state->ldap_struct = NULL;
1069 return rc;
1073 ldap_state->last_ping = time(NULL);
1074 ldap_state->pid = sys_getpid();
1076 TALLOC_FREE(ldap_state->idle_event);
1078 if (ldap_state->event_context != NULL) {
1079 ldap_state->idle_event = event_add_timed(
1080 ldap_state->event_context, NULL,
1081 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1082 "smbldap_idle_fn", smbldap_idle_fn, ldap_state);
1085 DEBUG(4,("The LDAP server is successfully connected\n"));
1087 return LDAP_SUCCESS;
1090 /**********************************************************************
1091 Disconnect from LDAP server
1092 *********************************************************************/
1093 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1095 if (!ldap_state)
1096 return NT_STATUS_INVALID_PARAMETER;
1098 if (ldap_state->ldap_struct != NULL) {
1099 ldap_unbind(ldap_state->ldap_struct);
1100 ldap_state->ldap_struct = NULL;
1103 smbldap_delete_state(ldap_state);
1105 DEBUG(5,("The connection to the LDAP server was closed\n"));
1106 /* maybe free the results here --metze */
1108 return NT_STATUS_OK;
1111 static bool got_alarm;
1113 static void (*old_handler)(int);
1115 static void gotalarm_sig(int dummy)
1117 got_alarm = True;
1120 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1121 int *attempts, time_t endtime)
1123 time_t now = time(NULL);
1124 int open_rc = LDAP_SERVER_DOWN;
1126 if (*rc != LDAP_SERVER_DOWN)
1127 goto no_next;
1129 if (now >= endtime) {
1130 smbldap_close(ldap_state);
1131 *rc = LDAP_TIMEOUT;
1132 goto no_next;
1135 if (*attempts == 0) {
1136 got_alarm = False;
1137 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1138 alarm(endtime - now);
1140 if (ldap_state->pid != sys_getpid())
1141 smbldap_close(ldap_state);
1144 while (1) {
1146 if (*attempts != 0)
1147 smb_msleep(1000);
1149 *attempts += 1;
1151 open_rc = smbldap_open(ldap_state);
1153 if (open_rc == LDAP_SUCCESS) {
1154 ldap_state->last_use = now;
1155 return True;
1158 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1159 /* The fact that we are non-root or any other
1160 * access-denied condition will not change in the next
1161 * round of trying */
1162 *rc = open_rc;
1163 break;
1166 if (got_alarm) {
1167 *rc = LDAP_TIMEOUT;
1168 break;
1171 if (open_rc != LDAP_SUCCESS) {
1172 DEBUG(1, ("Connection to LDAP server failed for the "
1173 "%d try!\n", *attempts));
1177 no_next:
1178 CatchSignal(SIGALRM, old_handler);
1179 alarm(0);
1180 ldap_state->last_use = now;
1181 return False;
1184 /*********************************************************************
1185 ********************************************************************/
1187 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1188 const char *base, int scope, const char *filter,
1189 const char *attrs[], int attrsonly,
1190 LDAPControl **sctrls, LDAPControl **cctrls,
1191 int sizelimit, LDAPMessage **res)
1193 int rc = LDAP_SERVER_DOWN;
1194 int attempts = 0;
1195 char *utf8_filter;
1196 time_t endtime = time(NULL)+lp_ldap_timeout();
1197 struct timeval timeout;
1198 size_t converted_size;
1200 SMB_ASSERT(ldap_state);
1202 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1203 "scope => [%d]\n", base, filter, scope));
1205 if (ldap_state->last_rebind.tv_sec > 0) {
1206 struct timeval tval;
1207 int64_t tdiff = 0;
1208 int sleep_time = 0;
1210 ZERO_STRUCT(tval);
1211 GetTimeOfDay(&tval);
1213 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1214 tdiff /= 1000; /* Convert to milliseconds. */
1216 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1217 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1219 if (sleep_time > 0) {
1220 /* we wait for the LDAP replication */
1221 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1222 "for LDAP replication.\n",sleep_time));
1223 smb_msleep(sleep_time);
1224 DEBUG(5,("smbldap_search_ext: go on!\n"));
1226 ZERO_STRUCT(ldap_state->last_rebind);
1229 if (!push_utf8_allocate(&utf8_filter, filter, &converted_size)) {
1230 return LDAP_NO_MEMORY;
1233 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1234 timeout.tv_sec = lp_ldap_timeout();
1235 timeout.tv_usec = 0;
1237 /* Setup alarm timeout.... Do we need both of these ? JRA.
1238 * Yes, I think we do need both of these. The server timeout only
1239 * covers the case where the server's operation takes too long. It
1240 * does not cover the case where the request hangs on its way to the
1241 * server. The server side timeout is not strictly necessary, it's
1242 * just a bit more kind to the server. VL. */
1244 got_alarm = 0;
1245 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1246 alarm(lp_ldap_timeout());
1247 /* End setup timeout. */
1249 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1250 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1251 utf8_filter,
1252 CONST_DISCARD(char **, attrs),
1253 attrsonly, sctrls, cctrls, &timeout,
1254 sizelimit, res);
1255 if (rc != LDAP_SUCCESS) {
1256 char *ld_error = NULL;
1257 int ld_errno;
1259 ldap_get_option(ldap_state->ldap_struct,
1260 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1262 ldap_get_option(ldap_state->ldap_struct,
1263 LDAP_OPT_ERROR_STRING, &ld_error);
1264 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1265 "(%s)\n", base, ld_errno,
1266 ldap_err2string(rc),
1267 ld_error ? ld_error : "unknown"));
1268 SAFE_FREE(ld_error);
1270 if (ld_errno == LDAP_SERVER_DOWN) {
1271 ldap_unbind(ldap_state->ldap_struct);
1272 ldap_state->ldap_struct = NULL;
1277 SAFE_FREE(utf8_filter);
1279 /* Teardown timeout. */
1280 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1281 alarm(0);
1283 if (got_alarm != 0)
1284 return LDAP_TIMELIMIT_EXCEEDED;
1286 return rc;
1289 int smbldap_search(struct smbldap_state *ldap_state,
1290 const char *base, int scope, const char *filter,
1291 const char *attrs[], int attrsonly,
1292 LDAPMessage **res)
1294 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1295 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1298 int smbldap_search_paged(struct smbldap_state *ldap_state,
1299 const char *base, int scope, const char *filter,
1300 const char **attrs, int attrsonly, int pagesize,
1301 LDAPMessage **res, void **cookie)
1303 LDAPControl pr;
1304 LDAPControl **rcontrols;
1305 LDAPControl *controls[2] = { NULL, NULL};
1306 BerElement *cookie_be = NULL;
1307 struct berval *cookie_bv = NULL;
1308 int tmp = 0, i, rc;
1309 bool critical = True;
1311 *res = NULL;
1313 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1314 "scope => [%d], pagesize => [%d]\n",
1315 base, filter, scope, pagesize));
1317 cookie_be = ber_alloc_t(LBER_USE_DER);
1318 if (cookie_be == NULL) {
1319 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1320 "NULL\n"));
1321 return LDAP_NO_MEMORY;
1324 /* construct cookie */
1325 if (*cookie != NULL) {
1326 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1327 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1328 *cookie = NULL;
1329 } else {
1330 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1332 ber_flatten(cookie_be, &cookie_bv);
1334 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1335 pr.ldctl_iscritical = (char) critical;
1336 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1337 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1339 controls[0] = &pr;
1340 controls[1] = NULL;
1342 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1343 0, controls, NULL, LDAP_NO_LIMIT, res);
1345 ber_free(cookie_be, 1);
1346 ber_bvfree(cookie_bv);
1348 if (rc != 0) {
1349 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1350 "failed with [%s]\n", filter, ldap_err2string(rc)));
1351 goto done;
1354 DEBUG(3,("smbldap_search_paged: search was successfull\n"));
1356 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1357 NULL, NULL, &rcontrols, 0);
1358 if (rc != 0) {
1359 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1360 "with [%s]\n", ldap_err2string(rc)));
1361 goto done;
1364 if (rcontrols == NULL)
1365 goto done;
1367 for (i=0; rcontrols[i]; i++) {
1369 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1370 continue;
1372 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1373 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1374 /* the berval is the cookie, but must be freed when it is all
1375 done */
1376 if (cookie_bv->bv_len)
1377 *cookie=ber_bvdup(cookie_bv);
1378 else
1379 *cookie=NULL;
1380 ber_bvfree(cookie_bv);
1381 ber_free(cookie_be, 1);
1382 break;
1384 ldap_controls_free(rcontrols);
1385 done:
1386 return rc;
1389 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1391 int rc = LDAP_SERVER_DOWN;
1392 int attempts = 0;
1393 char *utf8_dn;
1394 time_t endtime = time(NULL)+lp_ldap_timeout();
1395 size_t converted_size;
1397 SMB_ASSERT(ldap_state);
1399 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1401 if (!push_utf8_allocate(&utf8_dn, dn, &converted_size)) {
1402 return LDAP_NO_MEMORY;
1405 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1406 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1407 if (rc != LDAP_SUCCESS) {
1408 char *ld_error = NULL;
1409 int ld_errno;
1411 ldap_get_option(ldap_state->ldap_struct,
1412 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1414 ldap_get_option(ldap_state->ldap_struct,
1415 LDAP_OPT_ERROR_STRING, &ld_error);
1416 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1417 "(%s)\n", dn, ld_errno,
1418 ldap_err2string(rc),
1419 ld_error ? ld_error : "unknown"));
1420 SAFE_FREE(ld_error);
1422 if (ld_errno == LDAP_SERVER_DOWN) {
1423 ldap_unbind(ldap_state->ldap_struct);
1424 ldap_state->ldap_struct = NULL;
1429 SAFE_FREE(utf8_dn);
1430 return rc;
1433 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1435 int rc = LDAP_SERVER_DOWN;
1436 int attempts = 0;
1437 char *utf8_dn;
1438 time_t endtime = time(NULL)+lp_ldap_timeout();
1439 size_t converted_size;
1441 SMB_ASSERT(ldap_state);
1443 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1445 if (!push_utf8_allocate(&utf8_dn, dn, &converted_size)) {
1446 return LDAP_NO_MEMORY;
1449 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1450 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1451 if (rc != LDAP_SUCCESS) {
1452 char *ld_error = NULL;
1453 int ld_errno;
1455 ldap_get_option(ldap_state->ldap_struct,
1456 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1458 ldap_get_option(ldap_state->ldap_struct,
1459 LDAP_OPT_ERROR_STRING, &ld_error);
1460 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1461 "(%s)\n", dn, ld_errno,
1462 ldap_err2string(rc),
1463 ld_error ? ld_error : "unknown"));
1464 SAFE_FREE(ld_error);
1466 if (ld_errno == LDAP_SERVER_DOWN) {
1467 ldap_unbind(ldap_state->ldap_struct);
1468 ldap_state->ldap_struct = NULL;
1473 SAFE_FREE(utf8_dn);
1474 return rc;
1477 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1479 int rc = LDAP_SERVER_DOWN;
1480 int attempts = 0;
1481 char *utf8_dn;
1482 time_t endtime = time(NULL)+lp_ldap_timeout();
1483 size_t converted_size;
1485 SMB_ASSERT(ldap_state);
1487 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1489 if (!push_utf8_allocate(&utf8_dn, dn, &converted_size)) {
1490 return LDAP_NO_MEMORY;
1493 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1494 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1495 if (rc != LDAP_SUCCESS) {
1496 char *ld_error = NULL;
1497 int ld_errno;
1499 ldap_get_option(ldap_state->ldap_struct,
1500 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1502 ldap_get_option(ldap_state->ldap_struct,
1503 LDAP_OPT_ERROR_STRING, &ld_error);
1504 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1505 "(%s)\n", dn, ld_errno,
1506 ldap_err2string(rc),
1507 ld_error ? ld_error : "unknown"));
1508 SAFE_FREE(ld_error);
1510 if (ld_errno == LDAP_SERVER_DOWN) {
1511 ldap_unbind(ldap_state->ldap_struct);
1512 ldap_state->ldap_struct = NULL;
1517 SAFE_FREE(utf8_dn);
1518 return rc;
1521 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1522 LDAP_CONST char *reqoid, struct berval *reqdata,
1523 LDAPControl **serverctrls, LDAPControl **clientctrls,
1524 char **retoidp, struct berval **retdatap)
1526 int rc = LDAP_SERVER_DOWN;
1527 int attempts = 0;
1528 time_t endtime = time(NULL)+lp_ldap_timeout();
1530 if (!ldap_state)
1531 return (-1);
1533 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1534 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1535 reqdata, serverctrls,
1536 clientctrls, retoidp, retdatap);
1537 if (rc != LDAP_SUCCESS) {
1538 char *ld_error = NULL;
1539 int ld_errno;
1541 ldap_get_option(ldap_state->ldap_struct,
1542 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1544 ldap_get_option(ldap_state->ldap_struct,
1545 LDAP_OPT_ERROR_STRING, &ld_error);
1546 DEBUG(10, ("Extended operation failed with error: "
1547 "%d (%s) (%s)\n", ld_errno,
1548 ldap_err2string(rc),
1549 ld_error ? ld_error : "unknown"));
1550 SAFE_FREE(ld_error);
1552 if (ld_errno == LDAP_SERVER_DOWN) {
1553 ldap_unbind(ldap_state->ldap_struct);
1554 ldap_state->ldap_struct = NULL;
1559 return rc;
1562 /*******************************************************************
1563 run the search by name.
1564 ******************************************************************/
1565 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1566 const char *filter, const char **search_attr,
1567 LDAPMessage ** result)
1569 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1570 filter, search_attr, 0, result);
1573 static void smbldap_idle_fn(struct event_context *event_ctx,
1574 struct timed_event *te,
1575 const struct timeval *now,
1576 void *private_data)
1578 struct smbldap_state *state = (struct smbldap_state *)private_data;
1580 TALLOC_FREE(state->idle_event);
1582 if (state->ldap_struct == NULL) {
1583 DEBUG(10,("ldap connection not connected...\n"));
1584 return;
1587 if ((state->last_use+SMBLDAP_IDLE_TIME) > now->tv_sec) {
1588 DEBUG(10,("ldap connection not idle...\n"));
1590 state->idle_event = event_add_timed(
1591 event_ctx, NULL,
1592 timeval_add(now, SMBLDAP_IDLE_TIME, 0),
1593 "smbldap_idle_fn", smbldap_idle_fn,
1594 private_data);
1595 return;
1598 DEBUG(7,("ldap connection idle...closing connection\n"));
1599 smbldap_close(state);
1602 /**********************************************************************
1603 Housekeeping
1604 *********************************************************************/
1606 void smbldap_free_struct(struct smbldap_state **ldap_state)
1608 smbldap_close(*ldap_state);
1610 if ((*ldap_state)->bind_secret) {
1611 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1614 SAFE_FREE((*ldap_state)->bind_dn);
1615 SAFE_FREE((*ldap_state)->bind_secret);
1617 TALLOC_FREE((*ldap_state)->idle_event);
1619 *ldap_state = NULL;
1621 /* No need to free any further, as it is talloc()ed */
1625 /**********************************************************************
1626 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1627 *********************************************************************/
1629 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1630 const char *location,
1631 struct smbldap_state **smbldap_state)
1633 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1634 if (!*smbldap_state) {
1635 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1636 return NT_STATUS_NO_MEMORY;
1639 if (location) {
1640 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1641 } else {
1642 (*smbldap_state)->uri = "ldap://localhost";
1645 (*smbldap_state)->event_context = event_ctx;
1647 return NT_STATUS_OK;
1650 /*******************************************************************
1651 Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1652 ********************************************************************/
1653 char *smbldap_get_dn(LDAP *ld, LDAPMessage *entry)
1655 char *utf8_dn, *unix_dn;
1656 size_t converted_size;
1658 utf8_dn = ldap_get_dn(ld, entry);
1659 if (!utf8_dn) {
1660 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1661 return NULL;
1663 if (!pull_utf8_allocate(&unix_dn, utf8_dn, &converted_size)) {
1664 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1665 "[%s]\n", utf8_dn));
1666 return NULL;
1668 ldap_memfree(utf8_dn);
1669 return unix_dn;
1672 const char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1673 LDAPMessage *entry)
1675 char *utf8_dn, *unix_dn;
1676 size_t converted_size;
1678 utf8_dn = ldap_get_dn(ld, entry);
1679 if (!utf8_dn) {
1680 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1681 return NULL;
1683 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1684 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1685 "[%s]\n", utf8_dn));
1686 return NULL;
1688 ldap_memfree(utf8_dn);
1689 return unix_dn;
1692 /*******************************************************************
1693 Check if root-dse has a certain Control or Extension
1694 ********************************************************************/
1696 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1698 LDAPMessage *msg = NULL;
1699 LDAPMessage *entry = NULL;
1700 char **values = NULL;
1701 int rc, num_result, num_values, i;
1702 bool result = False;
1704 if (!attrs[0]) {
1705 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1706 return False;
1709 if (!strequal(attrs[0], "supportedExtension") &&
1710 !strequal(attrs[0], "supportedControl") &&
1711 !strequal(attrs[0], "namingContexts")) {
1712 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1713 return False;
1716 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1717 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1719 if (rc != LDAP_SUCCESS) {
1720 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1721 return False;
1724 num_result = ldap_count_entries(ld, msg);
1726 if (num_result != 1) {
1727 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1728 goto done;
1731 entry = ldap_first_entry(ld, msg);
1733 if (entry == NULL) {
1734 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1735 goto done;
1738 values = ldap_get_values(ld, entry, attrs[0]);
1740 if (values == NULL) {
1741 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1742 goto done;
1745 num_values = ldap_count_values(values);
1747 if (num_values == 0) {
1748 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1749 goto done;
1752 for (i=0; i<num_values; i++) {
1753 if (strcmp(values[i], value) == 0)
1754 result = True;
1758 done:
1759 if (values != NULL)
1760 ldap_value_free(values);
1761 if (msg != NULL)
1762 ldap_msgfree(msg);
1764 return result;
1768 /*******************************************************************
1769 Check if LDAP-Server supports a certain Control (OID in string format)
1770 ********************************************************************/
1772 bool smbldap_has_control(LDAP *ld, const char *control)
1774 const char *attrs[] = { "supportedControl", NULL };
1775 return smbldap_check_root_dse(ld, attrs, control);
1778 /*******************************************************************
1779 Check if LDAP-Server supports a certain Extension (OID in string format)
1780 ********************************************************************/
1782 bool smbldap_has_extension(LDAP *ld, const char *extension)
1784 const char *attrs[] = { "supportedExtension", NULL };
1785 return smbldap_check_root_dse(ld, attrs, extension);
1788 /*******************************************************************
1789 Check if LDAP-Server holds a given namingContext
1790 ********************************************************************/
1792 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1794 const char *attrs[] = { "namingContexts", NULL };
1795 return smbldap_check_root_dse(ld, attrs, naming_context);
1798 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1800 ldap_state->anonymous = anon;
1802 /* free any previously set credential */
1804 SAFE_FREE(ldap_state->bind_dn);
1805 if (ldap_state->bind_secret) {
1806 /* make sure secrets are zeroed out of memory */
1807 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1808 SAFE_FREE(ldap_state->bind_secret);
1811 if ( ! anon) {
1812 ldap_state->bind_dn = SMB_STRDUP(dn);
1813 ldap_state->bind_secret = SMB_STRDUP(secret);
1816 return True;