2 Unix SMB/CIFS implementation.
3 LDAP protocol helper functions for SAMBA
4 Copyright (C) Jean François Micouleau 1998
5 Copyright (C) Gerald Carter 2001-2003
6 Copyright (C) Shahms King 2001
7 Copyright (C) Andrew Bartlett 2002-2003
8 Copyright (C) Stefan (metze) Metzmacher 2002-2003
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #ifndef LDAP_OPT_SUCCESS
29 #define LDAP_OPT_SUCCESS 0
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 )
221 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
222 if ( table[i].attrib == key )
223 return table[i].name;
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[] )
240 while ( table[i].attrib != LDAP_ATTR_LIST_END )
244 names = TALLOC_ARRAY( mem_ctx, const char*, i );
246 DEBUG(0,("get_attr_list: out of memory\n"));
251 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
252 names[i] = talloc_strdup( names, table[i].name );
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,
275 if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
276 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
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);
288 ldap_value_free(values);
289 #ifdef DEBUG_PASSWORDS
290 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
295 char * smbldap_talloc_single_attribute(LDAP *ldap_struct, LDAPMessage *entry,
296 const char *attribute,
301 size_t converted_size;
303 if (attribute == NULL) {
307 values = ldap_get_values(ldap_struct, entry, attribute);
309 if (values == NULL) {
310 DEBUG(10, ("attribute %s does not exist\n", attribute));
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);
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);
327 ldap_value_free(values);
329 #ifdef DEBUG_PASSWORDS
330 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
336 char * smbldap_talloc_smallest_attribute(LDAP *ldap_struct, LDAPMessage *entry,
337 const char *attribute,
342 size_t converted_size;
345 if (attribute == NULL) {
349 values = ldap_get_values(ldap_struct, entry, attribute);
351 if (values == NULL) {
352 DEBUG(10, ("attribute %s does not exist\n", attribute));
356 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
357 DEBUG(10, ("pull_utf8_talloc failed\n"));
358 ldap_value_free(values);
362 num_values = ldap_count_values(values);
364 for (i=1; i<num_values; i++) {
367 if (!pull_utf8_talloc(mem_ctx, &tmp, values[i],
369 DEBUG(10, ("pull_utf8_talloc failed\n"));
371 ldap_value_free(values);
375 if (StrCaseCmp(tmp, result) < 0) {
383 ldap_value_free(values);
385 #ifdef DEBUG_PASSWORDS
386 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
392 bool smbldap_pull_sid(LDAP *ld, LDAPMessage *msg, const char *attrib,
395 struct berval **values;
398 values = ldap_get_values_len(ld, msg, attrib);
404 if (values[0] != NULL) {
405 ret = sid_parse(values[0]->bv_val, values[0]->bv_len, sid);
408 ldap_value_free_len(values);
412 static int ldapmsg_destructor(LDAPMessage **result) {
413 ldap_msgfree(*result);
417 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
419 LDAPMessage **handle;
421 if (result == NULL) {
425 handle = TALLOC_P(mem_ctx, LDAPMessage *);
426 SMB_ASSERT(handle != NULL);
429 talloc_set_destructor(handle, ldapmsg_destructor);
432 static int ldapmod_destructor(LDAPMod ***mod) {
433 ldap_mods_free(*mod, True);
437 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
445 handle = TALLOC_P(mem_ctx, LDAPMod **);
446 SMB_ASSERT(handle != NULL);
449 talloc_set_destructor(handle, ldapmod_destructor);
452 /************************************************************************
453 Routine to manage the LDAPMod structure array
454 manage memory used by the array, by each struct, and values
455 ***********************************************************************/
457 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
465 /* sanity checks on the mod values */
467 if (attribute == NULL || *attribute == '\0') {
471 #if 0 /* commented out after discussion with abartlet. Do not reenable.
472 left here so other do not re-add similar code --jerry */
473 if (value == NULL || *value == '\0')
478 mods = SMB_MALLOC_P(LDAPMod *);
480 smb_panic("smbldap_set_mod: out of memory!");
486 for (i = 0; mods[i] != NULL; ++i) {
487 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
491 if (mods[i] == NULL) {
492 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
494 smb_panic("smbldap_set_mod: out of memory!");
497 mods[i] = SMB_MALLOC_P(LDAPMod);
498 if (mods[i] == NULL) {
499 smb_panic("smbldap_set_mod: out of memory!");
502 mods[i]->mod_op = modop;
503 mods[i]->mod_values = NULL;
504 mods[i]->mod_type = SMB_STRDUP(attribute);
509 char *utf8_value = NULL;
510 size_t converted_size;
513 if (mods[i]->mod_values != NULL) {
514 for (; mods[i]->mod_values[j] != NULL; j++);
516 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
518 if (mods[i]->mod_values == NULL) {
519 smb_panic("smbldap_set_mod: out of memory!");
523 if (!push_utf8_talloc(talloc_tos(), &utf8_value, value, &converted_size)) {
524 smb_panic("smbldap_set_mod: String conversion failure!");
529 mods[i]->mod_values[j] = SMB_STRDUP(utf8_value);
530 TALLOC_FREE(utf8_value);
531 SMB_ASSERT(mods[i]->mod_values[j] != NULL);
533 mods[i]->mod_values[j + 1] = NULL;
538 /**********************************************************************
539 Set attribute to newval in LDAP, regardless of what value the
540 attribute had in LDAP before.
541 *********************************************************************/
543 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
545 const char *attribute, const char *newval)
547 char oldval[2048]; /* current largest allowed value is mungeddial */
550 if (attribute == NULL) {
551 /* This can actually happen for ldapsam_compat where we for
552 * example don't have a password history */
556 if (existing != NULL) {
557 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
563 /* all of our string attributes are case insensitive */
565 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
567 /* Believe it or not, but LDAP will deny a delete and
568 an add at the same time if the values are the
570 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
575 /* There has been no value before, so don't delete it.
576 * Here's a possible race: We might end up with
577 * duplicate attributes */
578 /* By deleting exactly the value we found in the entry this
579 * should be race-free in the sense that the LDAP-Server will
580 * deny the complete operation if somebody changed the
581 * attribute behind our back. */
582 /* This will also allow modifying single valued attributes
583 * in Novell NDS. In NDS you have to first remove attribute and then
584 * you could add new value */
586 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
587 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
590 /* Regardless of the real operation (add or modify)
591 we add the new value here. We rely on deleting
592 the old value, should it exist. */
594 if ((newval != NULL) && (strlen(newval) > 0)) {
595 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
596 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
600 /**********************************************************************
601 Some varients of the LDAP rebind code do not pass in the third 'arg'
602 pointer to a void*, so we try and work around it by assuming that the
603 value of the 'LDAP *' pointer is the same as the one we had passed in
604 **********************************************************************/
606 struct smbldap_state_lookup {
608 struct smbldap_state *smbldap_state;
609 struct smbldap_state_lookup *prev, *next;
612 static struct smbldap_state_lookup *smbldap_state_lookup_list;
614 static struct smbldap_state *smbldap_find_state(LDAP *ld)
616 struct smbldap_state_lookup *t;
618 for (t = smbldap_state_lookup_list; t; t = t->next) {
620 return t->smbldap_state;
626 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
628 struct smbldap_state_lookup *t;
630 for (t = smbldap_state_lookup_list; t; t = t->next) {
631 if (t->smbldap_state == smbldap_state) {
632 DLIST_REMOVE(smbldap_state_lookup_list, t);
639 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
641 struct smbldap_state *tmp_ldap_state;
642 struct smbldap_state_lookup *t;
644 if ((tmp_ldap_state = smbldap_find_state(ld))) {
645 SMB_ASSERT(tmp_ldap_state == smbldap_state);
649 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
652 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
654 t->smbldap_state = smbldap_state;
657 /********************************************************************
658 start TLS on an existing LDAP connection
659 *******************************************************************/
661 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
663 #ifdef LDAP_OPT_X_TLS
667 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
671 #ifdef LDAP_OPT_X_TLS
672 if (version != LDAP_VERSION3) {
673 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
674 return LDAP_OPERATIONS_ERROR;
677 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
678 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
679 ldap_err2string(rc)));
683 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
686 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
687 return LDAP_OPERATIONS_ERROR;
691 /********************************************************************
692 setup a connection to the LDAP server based on a uri
693 *******************************************************************/
695 int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
699 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
701 #ifdef HAVE_LDAP_INITIALIZE
703 rc = ldap_initialize(ldap_struct, uri);
705 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
711 /* Parse the string manually */
717 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
720 /* skip leading "URL:" (if any) */
721 if ( strnequal( uri, "URL:", 4 ) ) {
725 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
728 if (strequal(protocol, "ldap")) {
730 } else if (strequal(protocol, "ldaps")) {
733 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
737 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
738 DEBUG(0, ("ldap_init failed !\n"));
739 return LDAP_OPERATIONS_ERROR;
742 if (strequal(protocol, "ldaps")) {
743 #ifdef LDAP_OPT_X_TLS
744 int tls = LDAP_OPT_X_TLS_HARD;
745 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
747 DEBUG(0, ("Failed to setup a TLS session\n"));
750 DEBUG(3,("LDAPS option set...!\n"));
752 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
753 return LDAP_OPERATIONS_ERROR;
754 #endif /* LDAP_OPT_X_TLS */
757 #endif /* HAVE_LDAP_INITIALIZE */
760 /* now set connection timeout */
761 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
763 int ct = lp_ldap_connection_timeout()*1000;
764 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
765 if (rc != LDAP_SUCCESS) {
766 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
767 ct, ldap_err2string(rc)));
770 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
774 ct.tv_sec = lp_ldap_connection_timeout();
775 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
776 if (rc != LDAP_SUCCESS) {
777 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
778 (int)ct.tv_sec, ldap_err2string(rc)));
786 /********************************************************************
787 try to upgrade to Version 3 LDAP if not already, in either case return current
789 *******************************************************************/
791 int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
796 /* assume the worst */
797 *new_version = LDAP_VERSION2;
799 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
804 if (version == LDAP_VERSION3) {
805 *new_version = LDAP_VERSION3;
810 version = LDAP_VERSION3;
811 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
816 *new_version = LDAP_VERSION3;
820 /*******************************************************************
821 open a connection to the ldap server (just until the bind)
822 ******************************************************************/
824 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
828 rc = smb_ldap_setup_conn(ldap_struct, uri);
833 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
838 rc = smb_ldap_start_tls(*ldap_struct, version);
846 /*******************************************************************
847 open a connection to the ldap server.
848 ******************************************************************/
849 static int smbldap_open_connection (struct smbldap_state *ldap_state)
852 int rc = LDAP_SUCCESS;
854 LDAP **ldap_struct = &ldap_state->ldap_struct;
856 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
861 /* Store the LDAP pointer in a lookup list */
863 smbldap_store_state(*ldap_struct, ldap_state);
865 /* Upgrade to LDAPv3 if possible */
867 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
872 /* Start TLS if required */
874 rc = smb_ldap_start_tls(*ldap_struct, version);
879 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
883 /*******************************************************************
884 a rebind function for authenticated referrals
885 This version takes a void* that we can shove useful stuff in :-)
886 ******************************************************************/
887 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
889 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
890 int *methodp, int freeit, void *arg)
892 struct smbldap_state *ldap_state = arg;
894 /** @TODO Should we be doing something to check what servers we rebind to?
895 Could we get a referral to a machine that we don't want to give our
896 username and password to? */
901 memset(*credp, '\0', strlen(*credp));
905 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
906 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
908 if (ldap_state->anonymous) {
912 *whop = SMB_STRDUP(ldap_state->bind_dn);
914 return LDAP_NO_MEMORY;
916 *credp = SMB_STRDUP(ldap_state->bind_secret);
919 return LDAP_NO_MEMORY;
922 *methodp = LDAP_AUTH_SIMPLE;
925 GetTimeOfDay(&ldap_state->last_rebind);
929 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
931 /*******************************************************************
932 a rebind function for authenticated referrals
933 This version takes a void* that we can shove useful stuff in :-)
934 and actually does the connection.
935 ******************************************************************/
936 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
937 static int rebindproc_connect_with_state (LDAP *ldap_struct,
938 LDAP_CONST char *url,
940 ber_int_t msgid, void *arg)
942 struct smbldap_state *ldap_state =
943 (struct smbldap_state *)arg;
947 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
948 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
950 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
951 * itself) before rebinding to another LDAP server to avoid to expose
952 * our credentials. At least *try* to secure the connection - Guenther */
954 smb_ldap_upgrade_conn(ldap_struct, &version);
955 smb_ldap_start_tls(ldap_struct, version);
957 /** @TODO Should we be doing something to check what servers we rebind to?
958 Could we get a referral to a machine that we don't want to give our
959 username and password to? */
961 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
963 /* only set the last rebind timestamp when we did rebind after a
964 * non-read LDAP operation. That way we avoid the replication sleep
965 * after a simple redirected search operation - Guenther */
969 case LDAP_REQ_MODIFY:
971 case LDAP_REQ_DELETE:
973 case LDAP_REQ_EXTENDED:
974 DEBUG(10,("rebindproc_connect_with_state: "
975 "setting last_rebind timestamp "
976 "(req: 0x%02x)\n", (unsigned int)request));
977 GetTimeOfDay(&ldap_state->last_rebind);
980 ZERO_STRUCT(ldap_state->last_rebind);
986 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
988 /*******************************************************************
989 Add a rebind function for authenticated referrals
990 ******************************************************************/
991 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
993 # if LDAP_SET_REBIND_PROC_ARGS == 2
994 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
995 int *method, int freeit )
997 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
999 return rebindproc_with_state(ldap_struct, whop, credp,
1000 method, freeit, ldap_state);
1003 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1004 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1006 /*******************************************************************
1007 a rebind function for authenticated referrals
1008 this also does the connection, but no void*.
1009 ******************************************************************/
1010 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1011 # if LDAP_SET_REBIND_PROC_ARGS == 2
1012 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
1015 struct smbldap_state *ldap_state = smbldap_find_state(ld);
1017 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
1020 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1021 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1023 /*******************************************************************
1024 connect to the ldap server under system privilege.
1025 ******************************************************************/
1026 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
1031 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
1033 /* get the default dn and password only if they are not set already */
1034 if (!fetch_ldap_pw(&ldap_state->bind_dn, &ldap_state->bind_secret)) {
1035 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
1036 return LDAP_INVALID_CREDENTIALS;
1040 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
1041 (OpenLDAP) doesnt' seem to support it */
1043 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
1044 ldap_state->uri, ldap_state->bind_dn));
1046 #ifdef HAVE_LDAP_SET_REBIND_PROC
1047 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1048 # if LDAP_SET_REBIND_PROC_ARGS == 2
1049 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
1051 # if LDAP_SET_REBIND_PROC_ARGS == 3
1052 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
1054 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1055 # if LDAP_SET_REBIND_PROC_ARGS == 2
1056 ldap_set_rebind_proc(ldap_struct, &rebindproc);
1058 # if LDAP_SET_REBIND_PROC_ARGS == 3
1059 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
1061 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1064 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1066 if (rc != LDAP_SUCCESS) {
1067 char *ld_error = NULL;
1068 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
1070 DEBUG(ldap_state->num_failures ? 2 : 0,
1071 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
1073 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
1074 ldap_err2string(rc),
1075 ld_error ? ld_error : "(unknown)"));
1076 SAFE_FREE(ld_error);
1077 ldap_state->num_failures++;
1081 ldap_state->num_failures = 0;
1082 ldap_state->paged_results = False;
1084 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1086 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1087 ldap_state->paged_results = True;
1090 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1091 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1092 ldap_state->paged_results ? "does" : "does not"));
1096 static void smbldap_idle_fn(struct event_context *event_ctx,
1097 struct timed_event *te,
1099 void *private_data);
1101 /**********************************************************************
1102 Connect to LDAP server (called before every ldap operation)
1103 *********************************************************************/
1104 static int smbldap_open(struct smbldap_state *ldap_state)
1107 bool reopen = False;
1108 SMB_ASSERT(ldap_state);
1110 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1112 #ifdef HAVE_UNIXSOCKET
1113 struct sockaddr_un addr;
1115 struct sockaddr addr;
1117 socklen_t len = sizeof(addr);
1120 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1121 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1124 #ifdef HAVE_UNIXSOCKET
1125 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1129 /* the other end has died. reopen. */
1130 ldap_unbind(ldap_state->ldap_struct);
1131 ldap_state->ldap_struct = NULL;
1132 ldap_state->last_ping = (time_t)0;
1134 ldap_state->last_ping = time(NULL);
1138 if (ldap_state->ldap_struct != NULL) {
1139 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1140 return LDAP_SUCCESS;
1143 if ((rc = smbldap_open_connection(ldap_state))) {
1147 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1148 ldap_unbind(ldap_state->ldap_struct);
1149 ldap_state->ldap_struct = NULL;
1154 ldap_state->last_ping = time(NULL);
1155 ldap_state->pid = sys_getpid();
1157 TALLOC_FREE(ldap_state->idle_event);
1159 if (ldap_state->event_context != NULL) {
1160 ldap_state->idle_event = event_add_timed(
1161 ldap_state->event_context, NULL,
1162 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1163 smbldap_idle_fn, ldap_state);
1166 DEBUG(4,("The LDAP server is successfully connected\n"));
1168 return LDAP_SUCCESS;
1171 /**********************************************************************
1172 Disconnect from LDAP server
1173 *********************************************************************/
1174 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1177 return NT_STATUS_INVALID_PARAMETER;
1179 if (ldap_state->ldap_struct != NULL) {
1180 ldap_unbind(ldap_state->ldap_struct);
1181 ldap_state->ldap_struct = NULL;
1184 smbldap_delete_state(ldap_state);
1186 DEBUG(5,("The connection to the LDAP server was closed\n"));
1187 /* maybe free the results here --metze */
1189 return NT_STATUS_OK;
1192 static bool got_alarm;
1194 static void (*old_handler)(int);
1196 static void gotalarm_sig(int dummy)
1201 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1202 int *attempts, time_t endtime)
1204 time_t now = time(NULL);
1205 int open_rc = LDAP_SERVER_DOWN;
1207 if (*rc != LDAP_SERVER_DOWN)
1210 if (now >= endtime) {
1211 smbldap_close(ldap_state);
1216 if (*attempts == 0) {
1218 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1219 alarm(endtime - now);
1221 if (ldap_state->pid != sys_getpid())
1222 smbldap_close(ldap_state);
1232 open_rc = smbldap_open(ldap_state);
1234 if (open_rc == LDAP_SUCCESS) {
1235 ldap_state->last_use = now;
1239 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1240 /* The fact that we are non-root or any other
1241 * access-denied condition will not change in the next
1242 * round of trying */
1252 if (open_rc != LDAP_SUCCESS) {
1253 DEBUG(1, ("Connection to LDAP server failed for the "
1254 "%d try!\n", *attempts));
1259 CatchSignal(SIGALRM, old_handler);
1261 ldap_state->last_use = now;
1265 /*********************************************************************
1266 ********************************************************************/
1268 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1269 const char *base, int scope, const char *filter,
1270 const char *attrs[], int attrsonly,
1271 LDAPControl **sctrls, LDAPControl **cctrls,
1272 int sizelimit, LDAPMessage **res)
1274 int rc = LDAP_SERVER_DOWN;
1277 time_t endtime = time(NULL)+lp_ldap_timeout();
1278 struct timeval timeout;
1279 size_t converted_size;
1281 SMB_ASSERT(ldap_state);
1283 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1284 "scope => [%d]\n", base, filter, scope));
1286 if (ldap_state->last_rebind.tv_sec > 0) {
1287 struct timeval tval;
1292 GetTimeOfDay(&tval);
1294 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1295 tdiff /= 1000; /* Convert to milliseconds. */
1297 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1298 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1300 if (sleep_time > 0) {
1301 /* we wait for the LDAP replication */
1302 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1303 "for LDAP replication.\n",sleep_time));
1304 smb_msleep(sleep_time);
1305 DEBUG(5,("smbldap_search_ext: go on!\n"));
1307 ZERO_STRUCT(ldap_state->last_rebind);
1310 if (!push_utf8_talloc(talloc_tos(), &utf8_filter, filter, &converted_size)) {
1311 return LDAP_NO_MEMORY;
1314 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1315 timeout.tv_sec = lp_ldap_timeout();
1316 timeout.tv_usec = 0;
1318 /* Setup alarm timeout.... Do we need both of these ? JRA.
1319 * Yes, I think we do need both of these. The server timeout only
1320 * covers the case where the server's operation takes too long. It
1321 * does not cover the case where the request hangs on its way to the
1322 * server. The server side timeout is not strictly necessary, it's
1323 * just a bit more kind to the server. VL. */
1326 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1327 alarm(lp_ldap_timeout());
1328 /* End setup timeout. */
1330 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1331 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1333 CONST_DISCARD(char **, attrs),
1334 attrsonly, sctrls, cctrls, &timeout,
1336 if (rc != LDAP_SUCCESS) {
1337 char *ld_error = NULL;
1340 ldap_get_option(ldap_state->ldap_struct,
1341 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1343 ldap_get_option(ldap_state->ldap_struct,
1344 LDAP_OPT_ERROR_STRING, &ld_error);
1345 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1346 "(%s)\n", base, ld_errno,
1347 ldap_err2string(rc),
1348 ld_error ? ld_error : "unknown"));
1349 SAFE_FREE(ld_error);
1351 if (ld_errno == LDAP_SERVER_DOWN) {
1352 ldap_unbind(ldap_state->ldap_struct);
1353 ldap_state->ldap_struct = NULL;
1358 TALLOC_FREE(utf8_filter);
1360 /* Teardown timeout. */
1361 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1365 return LDAP_TIMELIMIT_EXCEEDED;
1370 int smbldap_search(struct smbldap_state *ldap_state,
1371 const char *base, int scope, const char *filter,
1372 const char *attrs[], int attrsonly,
1375 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1376 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1379 int smbldap_search_paged(struct smbldap_state *ldap_state,
1380 const char *base, int scope, const char *filter,
1381 const char **attrs, int attrsonly, int pagesize,
1382 LDAPMessage **res, void **cookie)
1385 LDAPControl **rcontrols;
1386 LDAPControl *controls[2] = { NULL, NULL};
1387 BerElement *cookie_be = NULL;
1388 struct berval *cookie_bv = NULL;
1390 bool critical = True;
1394 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1395 "scope => [%d], pagesize => [%d]\n",
1396 base, filter, scope, pagesize));
1398 cookie_be = ber_alloc_t(LBER_USE_DER);
1399 if (cookie_be == NULL) {
1400 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1402 return LDAP_NO_MEMORY;
1405 /* construct cookie */
1406 if (*cookie != NULL) {
1407 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1408 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1411 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1413 ber_flatten(cookie_be, &cookie_bv);
1415 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1416 pr.ldctl_iscritical = (char) critical;
1417 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1418 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1423 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1424 0, controls, NULL, LDAP_NO_LIMIT, res);
1426 ber_free(cookie_be, 1);
1427 ber_bvfree(cookie_bv);
1430 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1431 "failed with [%s]\n", filter, ldap_err2string(rc)));
1435 DEBUG(3,("smbldap_search_paged: search was successfull\n"));
1437 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1438 NULL, NULL, &rcontrols, 0);
1440 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1441 "with [%s]\n", ldap_err2string(rc)));
1445 if (rcontrols == NULL)
1448 for (i=0; rcontrols[i]; i++) {
1450 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1453 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1454 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1455 /* the berval is the cookie, but must be freed when it is all
1457 if (cookie_bv->bv_len)
1458 *cookie=ber_bvdup(cookie_bv);
1461 ber_bvfree(cookie_bv);
1462 ber_free(cookie_be, 1);
1465 ldap_controls_free(rcontrols);
1470 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1472 int rc = LDAP_SERVER_DOWN;
1475 time_t endtime = time(NULL)+lp_ldap_timeout();
1476 size_t converted_size;
1478 SMB_ASSERT(ldap_state);
1480 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1482 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1483 return LDAP_NO_MEMORY;
1486 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1487 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1488 if (rc != LDAP_SUCCESS) {
1489 char *ld_error = NULL;
1492 ldap_get_option(ldap_state->ldap_struct,
1493 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1495 ldap_get_option(ldap_state->ldap_struct,
1496 LDAP_OPT_ERROR_STRING, &ld_error);
1497 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1498 "(%s)\n", dn, ld_errno,
1499 ldap_err2string(rc),
1500 ld_error ? ld_error : "unknown"));
1501 SAFE_FREE(ld_error);
1503 if (ld_errno == LDAP_SERVER_DOWN) {
1504 ldap_unbind(ldap_state->ldap_struct);
1505 ldap_state->ldap_struct = NULL;
1510 TALLOC_FREE(utf8_dn);
1514 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1516 int rc = LDAP_SERVER_DOWN;
1519 time_t endtime = time(NULL)+lp_ldap_timeout();
1520 size_t converted_size;
1522 SMB_ASSERT(ldap_state);
1524 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1526 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1527 return LDAP_NO_MEMORY;
1530 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1531 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1532 if (rc != LDAP_SUCCESS) {
1533 char *ld_error = NULL;
1536 ldap_get_option(ldap_state->ldap_struct,
1537 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1539 ldap_get_option(ldap_state->ldap_struct,
1540 LDAP_OPT_ERROR_STRING, &ld_error);
1541 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1542 "(%s)\n", dn, ld_errno,
1543 ldap_err2string(rc),
1544 ld_error ? ld_error : "unknown"));
1545 SAFE_FREE(ld_error);
1547 if (ld_errno == LDAP_SERVER_DOWN) {
1548 ldap_unbind(ldap_state->ldap_struct);
1549 ldap_state->ldap_struct = NULL;
1554 TALLOC_FREE(utf8_dn);
1558 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1560 int rc = LDAP_SERVER_DOWN;
1563 time_t endtime = time(NULL)+lp_ldap_timeout();
1564 size_t converted_size;
1566 SMB_ASSERT(ldap_state);
1568 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1570 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1571 return LDAP_NO_MEMORY;
1574 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1575 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1576 if (rc != LDAP_SUCCESS) {
1577 char *ld_error = NULL;
1580 ldap_get_option(ldap_state->ldap_struct,
1581 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1583 ldap_get_option(ldap_state->ldap_struct,
1584 LDAP_OPT_ERROR_STRING, &ld_error);
1585 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1586 "(%s)\n", dn, ld_errno,
1587 ldap_err2string(rc),
1588 ld_error ? ld_error : "unknown"));
1589 SAFE_FREE(ld_error);
1591 if (ld_errno == LDAP_SERVER_DOWN) {
1592 ldap_unbind(ldap_state->ldap_struct);
1593 ldap_state->ldap_struct = NULL;
1598 TALLOC_FREE(utf8_dn);
1602 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1603 LDAP_CONST char *reqoid, struct berval *reqdata,
1604 LDAPControl **serverctrls, LDAPControl **clientctrls,
1605 char **retoidp, struct berval **retdatap)
1607 int rc = LDAP_SERVER_DOWN;
1609 time_t endtime = time(NULL)+lp_ldap_timeout();
1614 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1615 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1616 reqdata, serverctrls,
1617 clientctrls, retoidp, retdatap);
1618 if (rc != LDAP_SUCCESS) {
1619 char *ld_error = NULL;
1622 ldap_get_option(ldap_state->ldap_struct,
1623 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1625 ldap_get_option(ldap_state->ldap_struct,
1626 LDAP_OPT_ERROR_STRING, &ld_error);
1627 DEBUG(10, ("Extended operation failed with error: "
1628 "%d (%s) (%s)\n", ld_errno,
1629 ldap_err2string(rc),
1630 ld_error ? ld_error : "unknown"));
1631 SAFE_FREE(ld_error);
1633 if (ld_errno == LDAP_SERVER_DOWN) {
1634 ldap_unbind(ldap_state->ldap_struct);
1635 ldap_state->ldap_struct = NULL;
1643 /*******************************************************************
1644 run the search by name.
1645 ******************************************************************/
1646 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1647 const char *filter, const char **search_attr,
1648 LDAPMessage ** result)
1650 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1651 filter, search_attr, 0, result);
1654 static void smbldap_idle_fn(struct event_context *event_ctx,
1655 struct timed_event *te,
1659 struct smbldap_state *state = (struct smbldap_state *)private_data;
1661 TALLOC_FREE(state->idle_event);
1663 if (state->ldap_struct == NULL) {
1664 DEBUG(10,("ldap connection not connected...\n"));
1668 if ((state->last_use+SMBLDAP_IDLE_TIME) > now.tv_sec) {
1669 DEBUG(10,("ldap connection not idle...\n"));
1671 state->idle_event = event_add_timed(
1673 timeval_add(&now, SMBLDAP_IDLE_TIME, 0),
1679 DEBUG(7,("ldap connection idle...closing connection\n"));
1680 smbldap_close(state);
1683 /**********************************************************************
1685 *********************************************************************/
1687 void smbldap_free_struct(struct smbldap_state **ldap_state)
1689 smbldap_close(*ldap_state);
1691 if ((*ldap_state)->bind_secret) {
1692 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1695 SAFE_FREE((*ldap_state)->bind_dn);
1696 SAFE_FREE((*ldap_state)->bind_secret);
1698 TALLOC_FREE((*ldap_state)->idle_event);
1702 /* No need to free any further, as it is talloc()ed */
1706 /**********************************************************************
1707 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1708 *********************************************************************/
1710 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1711 const char *location,
1712 struct smbldap_state **smbldap_state)
1714 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1715 if (!*smbldap_state) {
1716 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1717 return NT_STATUS_NO_MEMORY;
1721 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1723 (*smbldap_state)->uri = "ldap://localhost";
1726 (*smbldap_state)->event_context = event_ctx;
1728 return NT_STATUS_OK;
1731 char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1734 char *utf8_dn, *unix_dn;
1735 size_t converted_size;
1737 utf8_dn = ldap_get_dn(ld, entry);
1739 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1742 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1743 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1744 "[%s]\n", utf8_dn));
1747 ldap_memfree(utf8_dn);
1751 /*******************************************************************
1752 Check if root-dse has a certain Control or Extension
1753 ********************************************************************/
1755 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1757 LDAPMessage *msg = NULL;
1758 LDAPMessage *entry = NULL;
1759 char **values = NULL;
1760 int rc, num_result, num_values, i;
1761 bool result = False;
1764 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1768 if (!strequal(attrs[0], "supportedExtension") &&
1769 !strequal(attrs[0], "supportedControl") &&
1770 !strequal(attrs[0], "namingContexts")) {
1771 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1775 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1776 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1778 if (rc != LDAP_SUCCESS) {
1779 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1783 num_result = ldap_count_entries(ld, msg);
1785 if (num_result != 1) {
1786 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1790 entry = ldap_first_entry(ld, msg);
1792 if (entry == NULL) {
1793 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1797 values = ldap_get_values(ld, entry, attrs[0]);
1799 if (values == NULL) {
1800 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1804 num_values = ldap_count_values(values);
1806 if (num_values == 0) {
1807 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1811 for (i=0; i<num_values; i++) {
1812 if (strcmp(values[i], value) == 0)
1819 ldap_value_free(values);
1827 /*******************************************************************
1828 Check if LDAP-Server supports a certain Control (OID in string format)
1829 ********************************************************************/
1831 bool smbldap_has_control(LDAP *ld, const char *control)
1833 const char *attrs[] = { "supportedControl", NULL };
1834 return smbldap_check_root_dse(ld, attrs, control);
1837 /*******************************************************************
1838 Check if LDAP-Server supports a certain Extension (OID in string format)
1839 ********************************************************************/
1841 bool smbldap_has_extension(LDAP *ld, const char *extension)
1843 const char *attrs[] = { "supportedExtension", NULL };
1844 return smbldap_check_root_dse(ld, attrs, extension);
1847 /*******************************************************************
1848 Check if LDAP-Server holds a given namingContext
1849 ********************************************************************/
1851 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1853 const char *attrs[] = { "namingContexts", NULL };
1854 return smbldap_check_root_dse(ld, attrs, naming_context);
1857 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1859 ldap_state->anonymous = anon;
1861 /* free any previously set credential */
1863 SAFE_FREE(ldap_state->bind_dn);
1864 if (ldap_state->bind_secret) {
1865 /* make sure secrets are zeroed out of memory */
1866 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1867 SAFE_FREE(ldap_state->bind_secret);
1871 ldap_state->bind_dn = SMB_STRDUP(dn);
1872 ldap_state->bind_secret = SMB_STRDUP(secret);