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_talloc_single_blob(TALLOC_CTX *mem_ctx, LDAP *ld,
393 LDAPMessage *msg, const char *attrib,
396 struct berval **values;
398 values = ldap_get_values_len(ld, msg, attrib);
403 if (ldap_count_values_len(values) != 1) {
404 DEBUG(10, ("Expected one value for %s, got %d\n", attrib,
405 ldap_count_values_len(values)));
409 *blob = data_blob_talloc(mem_ctx, values[0]->bv_val,
411 ldap_value_free_len(values);
413 return (blob->data != NULL);
416 bool smbldap_pull_sid(LDAP *ld, LDAPMessage *msg, const char *attrib,
422 if (!smbldap_talloc_single_blob(talloc_tos(), ld, msg, attrib,
426 ret = sid_parse((char *)blob.data, blob.length, sid);
427 TALLOC_FREE(blob.data);
431 static int ldapmsg_destructor(LDAPMessage **result) {
432 ldap_msgfree(*result);
436 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
438 LDAPMessage **handle;
440 if (result == NULL) {
444 handle = TALLOC_P(mem_ctx, LDAPMessage *);
445 SMB_ASSERT(handle != NULL);
448 talloc_set_destructor(handle, ldapmsg_destructor);
451 static int ldapmod_destructor(LDAPMod ***mod) {
452 ldap_mods_free(*mod, True);
456 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
464 handle = TALLOC_P(mem_ctx, LDAPMod **);
465 SMB_ASSERT(handle != NULL);
468 talloc_set_destructor(handle, ldapmod_destructor);
471 /************************************************************************
472 Routine to manage the LDAPMod structure array
473 manage memory used by the array, by each struct, and values
474 ***********************************************************************/
476 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
484 /* sanity checks on the mod values */
486 if (attribute == NULL || *attribute == '\0') {
490 #if 0 /* commented out after discussion with abartlet. Do not reenable.
491 left here so other do not re-add similar code --jerry */
492 if (value == NULL || *value == '\0')
497 mods = SMB_MALLOC_P(LDAPMod *);
499 smb_panic("smbldap_set_mod: out of memory!");
505 for (i = 0; mods[i] != NULL; ++i) {
506 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
510 if (mods[i] == NULL) {
511 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
513 smb_panic("smbldap_set_mod: out of memory!");
516 mods[i] = SMB_MALLOC_P(LDAPMod);
517 if (mods[i] == NULL) {
518 smb_panic("smbldap_set_mod: out of memory!");
521 mods[i]->mod_op = modop;
522 mods[i]->mod_values = NULL;
523 mods[i]->mod_type = SMB_STRDUP(attribute);
528 char *utf8_value = NULL;
529 size_t converted_size;
532 if (mods[i]->mod_values != NULL) {
533 for (; mods[i]->mod_values[j] != NULL; j++);
535 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
537 if (mods[i]->mod_values == NULL) {
538 smb_panic("smbldap_set_mod: out of memory!");
542 if (!push_utf8_talloc(talloc_tos(), &utf8_value, value, &converted_size)) {
543 smb_panic("smbldap_set_mod: String conversion failure!");
547 mods[i]->mod_values[j] = SMB_STRDUP(utf8_value);
548 TALLOC_FREE(utf8_value);
549 SMB_ASSERT(mods[i]->mod_values[j] != NULL);
551 mods[i]->mod_values[j + 1] = NULL;
556 /**********************************************************************
557 Set attribute to newval in LDAP, regardless of what value the
558 attribute had in LDAP before.
559 *********************************************************************/
561 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
563 const char *attribute, const char *newval)
565 char oldval[2048]; /* current largest allowed value is mungeddial */
568 if (attribute == NULL) {
569 /* This can actually happen for ldapsam_compat where we for
570 * example don't have a password history */
574 if (existing != NULL) {
575 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
581 /* all of our string attributes are case insensitive */
583 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
585 /* Believe it or not, but LDAP will deny a delete and
586 an add at the same time if the values are the
588 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
593 /* There has been no value before, so don't delete it.
594 * Here's a possible race: We might end up with
595 * duplicate attributes */
596 /* By deleting exactly the value we found in the entry this
597 * should be race-free in the sense that the LDAP-Server will
598 * deny the complete operation if somebody changed the
599 * attribute behind our back. */
600 /* This will also allow modifying single valued attributes
601 * in Novell NDS. In NDS you have to first remove attribute and then
602 * you could add new value */
604 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
605 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
608 /* Regardless of the real operation (add or modify)
609 we add the new value here. We rely on deleting
610 the old value, should it exist. */
612 if ((newval != NULL) && (strlen(newval) > 0)) {
613 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
614 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
618 /**********************************************************************
619 Some varients of the LDAP rebind code do not pass in the third 'arg'
620 pointer to a void*, so we try and work around it by assuming that the
621 value of the 'LDAP *' pointer is the same as the one we had passed in
622 **********************************************************************/
624 struct smbldap_state_lookup {
626 struct smbldap_state *smbldap_state;
627 struct smbldap_state_lookup *prev, *next;
630 static struct smbldap_state_lookup *smbldap_state_lookup_list;
632 static struct smbldap_state *smbldap_find_state(LDAP *ld)
634 struct smbldap_state_lookup *t;
636 for (t = smbldap_state_lookup_list; t; t = t->next) {
638 return t->smbldap_state;
644 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
646 struct smbldap_state_lookup *t;
648 for (t = smbldap_state_lookup_list; t; t = t->next) {
649 if (t->smbldap_state == smbldap_state) {
650 DLIST_REMOVE(smbldap_state_lookup_list, t);
657 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
659 struct smbldap_state *tmp_ldap_state;
660 struct smbldap_state_lookup *t;
662 if ((tmp_ldap_state = smbldap_find_state(ld))) {
663 SMB_ASSERT(tmp_ldap_state == smbldap_state);
667 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
670 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
672 t->smbldap_state = smbldap_state;
675 /********************************************************************
676 start TLS on an existing LDAP connection
677 *******************************************************************/
679 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
681 #ifdef LDAP_OPT_X_TLS
685 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
689 #ifdef LDAP_OPT_X_TLS
690 if (version != LDAP_VERSION3) {
691 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
692 return LDAP_OPERATIONS_ERROR;
695 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
696 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
697 ldap_err2string(rc)));
701 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
704 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
705 return LDAP_OPERATIONS_ERROR;
709 /********************************************************************
710 setup a connection to the LDAP server based on a uri
711 *******************************************************************/
713 int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
717 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
719 #ifdef HAVE_LDAP_INITIALIZE
721 rc = ldap_initialize(ldap_struct, uri);
723 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
727 if (lp_ldap_follow_referral() != Auto) {
728 rc = ldap_set_option(*ldap_struct, LDAP_OPT_REFERRALS,
729 lp_ldap_follow_referral() ? LDAP_OPT_ON : LDAP_OPT_OFF);
730 if (rc != LDAP_SUCCESS)
731 DEBUG(0, ("Failed to set LDAP_OPT_REFERRALS: %s\n",
732 ldap_err2string(rc)));
738 /* Parse the string manually */
744 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
747 /* skip leading "URL:" (if any) */
748 if ( strnequal( uri, "URL:", 4 ) ) {
752 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
755 if (strequal(protocol, "ldap")) {
757 } else if (strequal(protocol, "ldaps")) {
760 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
764 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
765 DEBUG(0, ("ldap_init failed !\n"));
766 return LDAP_OPERATIONS_ERROR;
769 if (strequal(protocol, "ldaps")) {
770 #ifdef LDAP_OPT_X_TLS
771 int tls = LDAP_OPT_X_TLS_HARD;
772 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
774 DEBUG(0, ("Failed to setup a TLS session\n"));
777 DEBUG(3,("LDAPS option set...!\n"));
779 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
780 return LDAP_OPERATIONS_ERROR;
781 #endif /* LDAP_OPT_X_TLS */
784 #endif /* HAVE_LDAP_INITIALIZE */
786 /* now set connection timeout */
787 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
789 int ct = lp_ldap_connection_timeout()*1000;
790 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
791 if (rc != LDAP_SUCCESS) {
792 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
793 ct, ldap_err2string(rc)));
796 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
800 ct.tv_sec = lp_ldap_connection_timeout();
801 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
802 if (rc != LDAP_SUCCESS) {
803 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
804 (int)ct.tv_sec, ldap_err2string(rc)));
812 /********************************************************************
813 try to upgrade to Version 3 LDAP if not already, in either case return current
815 *******************************************************************/
817 int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
822 /* assume the worst */
823 *new_version = LDAP_VERSION2;
825 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
830 if (version == LDAP_VERSION3) {
831 *new_version = LDAP_VERSION3;
836 version = LDAP_VERSION3;
837 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
842 *new_version = LDAP_VERSION3;
846 /*******************************************************************
847 open a connection to the ldap server (just until the bind)
848 ******************************************************************/
850 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
854 rc = smb_ldap_setup_conn(ldap_struct, uri);
859 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
864 rc = smb_ldap_start_tls(*ldap_struct, version);
872 /*******************************************************************
873 open a connection to the ldap server.
874 ******************************************************************/
875 static int smbldap_open_connection (struct smbldap_state *ldap_state)
878 int rc = LDAP_SUCCESS;
881 LDAP **ldap_struct = &ldap_state->ldap_struct;
883 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
888 /* Store the LDAP pointer in a lookup list */
890 smbldap_store_state(*ldap_struct, ldap_state);
892 /* Upgrade to LDAPv3 if possible */
894 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
899 /* Start TLS if required */
901 rc = smb_ldap_start_tls(*ldap_struct, version);
906 /* Set alias dereferencing method */
907 deref = lp_ldap_deref();
909 if (ldap_set_option (*ldap_struct, LDAP_OPT_DEREF, &deref) != LDAP_OPT_SUCCESS) {
910 DEBUG(1,("smbldap_open_connection: Failed to set dereferencing method: %d\n", deref));
912 DEBUG(5,("Set dereferencing method: %d\n", deref));
916 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
920 /*******************************************************************
921 a rebind function for authenticated referrals
922 This version takes a void* that we can shove useful stuff in :-)
923 ******************************************************************/
924 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
926 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
927 int *methodp, int freeit, void *arg)
929 struct smbldap_state *ldap_state = arg;
931 /** @TODO Should we be doing something to check what servers we rebind to?
932 Could we get a referral to a machine that we don't want to give our
933 username and password to? */
938 memset(*credp, '\0', strlen(*credp));
942 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
943 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
945 if (ldap_state->anonymous) {
949 *whop = SMB_STRDUP(ldap_state->bind_dn);
951 return LDAP_NO_MEMORY;
953 *credp = SMB_STRDUP(ldap_state->bind_secret);
956 return LDAP_NO_MEMORY;
959 *methodp = LDAP_AUTH_SIMPLE;
962 GetTimeOfDay(&ldap_state->last_rebind);
966 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
968 /*******************************************************************
969 a rebind function for authenticated referrals
970 This version takes a void* that we can shove useful stuff in :-)
971 and actually does the connection.
972 ******************************************************************/
973 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
974 static int rebindproc_connect_with_state (LDAP *ldap_struct,
975 LDAP_CONST char *url,
977 ber_int_t msgid, void *arg)
979 struct smbldap_state *ldap_state =
980 (struct smbldap_state *)arg;
984 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
985 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
987 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
988 * itself) before rebinding to another LDAP server to avoid to expose
989 * our credentials. At least *try* to secure the connection - Guenther */
991 smb_ldap_upgrade_conn(ldap_struct, &version);
992 smb_ldap_start_tls(ldap_struct, version);
994 /** @TODO Should we be doing something to check what servers we rebind to?
995 Could we get a referral to a machine that we don't want to give our
996 username and password to? */
998 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1000 /* only set the last rebind timestamp when we did rebind after a
1001 * non-read LDAP operation. That way we avoid the replication sleep
1002 * after a simple redirected search operation - Guenther */
1006 case LDAP_REQ_MODIFY:
1008 case LDAP_REQ_DELETE:
1009 case LDAP_REQ_MODDN:
1010 case LDAP_REQ_EXTENDED:
1011 DEBUG(10,("rebindproc_connect_with_state: "
1012 "setting last_rebind timestamp "
1013 "(req: 0x%02x)\n", (unsigned int)request));
1014 GetTimeOfDay(&ldap_state->last_rebind);
1017 ZERO_STRUCT(ldap_state->last_rebind);
1023 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1025 /*******************************************************************
1026 Add a rebind function for authenticated referrals
1027 ******************************************************************/
1028 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1030 # if LDAP_SET_REBIND_PROC_ARGS == 2
1031 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
1032 int *method, int freeit )
1034 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
1036 return rebindproc_with_state(ldap_struct, whop, credp,
1037 method, freeit, ldap_state);
1039 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1040 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1042 /*******************************************************************
1043 a rebind function for authenticated referrals
1044 this also does the connection, but no void*.
1045 ******************************************************************/
1046 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1047 # if LDAP_SET_REBIND_PROC_ARGS == 2
1048 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
1051 struct smbldap_state *ldap_state = smbldap_find_state(ld);
1053 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
1056 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1057 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1059 /*******************************************************************
1060 connect to the ldap server under system privilege.
1061 ******************************************************************/
1062 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
1067 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
1068 char *bind_dn = NULL;
1069 char *bind_secret = NULL;
1071 /* get the default dn and password only if they are not set already */
1072 if (!fetch_ldap_pw(&bind_dn, &bind_secret)) {
1073 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
1074 return LDAP_INVALID_CREDENTIALS;
1076 smbldap_set_creds(ldap_state, false, bind_dn, bind_secret);
1078 memset(bind_secret, '\0', strlen(bind_secret));
1079 SAFE_FREE(bind_secret);
1082 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
1083 (OpenLDAP) doesnt' seem to support it */
1085 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
1086 ldap_state->uri, ldap_state->bind_dn));
1088 #ifdef HAVE_LDAP_SET_REBIND_PROC
1089 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1090 # if LDAP_SET_REBIND_PROC_ARGS == 2
1091 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
1093 # if LDAP_SET_REBIND_PROC_ARGS == 3
1094 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
1096 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1097 # if LDAP_SET_REBIND_PROC_ARGS == 2
1098 ldap_set_rebind_proc(ldap_struct, &rebindproc);
1100 # if LDAP_SET_REBIND_PROC_ARGS == 3
1101 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
1103 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1106 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1108 if (rc != LDAP_SUCCESS) {
1109 char *ld_error = NULL;
1110 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
1112 DEBUG(ldap_state->num_failures ? 2 : 0,
1113 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
1115 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
1116 ldap_err2string(rc),
1117 ld_error ? ld_error : "(unknown)"));
1118 SAFE_FREE(ld_error);
1119 ldap_state->num_failures++;
1123 ldap_state->num_failures = 0;
1124 ldap_state->paged_results = False;
1126 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1128 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1129 ldap_state->paged_results = True;
1132 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1133 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1134 ldap_state->paged_results ? "does" : "does not"));
1138 static void smbldap_idle_fn(struct event_context *event_ctx,
1139 struct timed_event *te,
1141 void *private_data);
1143 /**********************************************************************
1144 Connect to LDAP server (called before every ldap operation)
1145 *********************************************************************/
1146 static int smbldap_open(struct smbldap_state *ldap_state)
1149 bool reopen = False;
1150 SMB_ASSERT(ldap_state);
1152 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1154 #ifdef HAVE_UNIXSOCKET
1155 struct sockaddr_un addr;
1157 struct sockaddr addr;
1159 socklen_t len = sizeof(addr);
1162 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1163 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1166 #ifdef HAVE_UNIXSOCKET
1167 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1171 /* the other end has died. reopen. */
1172 ldap_unbind(ldap_state->ldap_struct);
1173 ldap_state->ldap_struct = NULL;
1174 ldap_state->last_ping = (time_t)0;
1176 ldap_state->last_ping = time(NULL);
1180 if (ldap_state->ldap_struct != NULL) {
1181 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1182 return LDAP_SUCCESS;
1185 if ((rc = smbldap_open_connection(ldap_state))) {
1189 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1190 ldap_unbind(ldap_state->ldap_struct);
1191 ldap_state->ldap_struct = NULL;
1196 ldap_state->last_ping = time(NULL);
1197 ldap_state->pid = sys_getpid();
1199 TALLOC_FREE(ldap_state->idle_event);
1201 if (ldap_state->event_context != NULL) {
1202 ldap_state->idle_event = event_add_timed(
1203 ldap_state->event_context, NULL,
1204 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1205 smbldap_idle_fn, ldap_state);
1208 DEBUG(4,("The LDAP server is successfully connected\n"));
1210 return LDAP_SUCCESS;
1213 /**********************************************************************
1214 Disconnect from LDAP server
1215 *********************************************************************/
1216 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1219 return NT_STATUS_INVALID_PARAMETER;
1221 if (ldap_state->ldap_struct != NULL) {
1222 ldap_unbind(ldap_state->ldap_struct);
1223 ldap_state->ldap_struct = NULL;
1226 smbldap_delete_state(ldap_state);
1228 DEBUG(5,("The connection to the LDAP server was closed\n"));
1229 /* maybe free the results here --metze */
1231 return NT_STATUS_OK;
1234 static bool got_alarm;
1236 static void (*old_handler)(int);
1238 static void gotalarm_sig(int dummy)
1243 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1244 int *attempts, time_t endtime)
1246 time_t now = time(NULL);
1247 int open_rc = LDAP_SERVER_DOWN;
1249 if (*rc != LDAP_SERVER_DOWN)
1252 if (now >= endtime) {
1253 smbldap_close(ldap_state);
1258 if (*attempts == 0) {
1260 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1261 alarm(endtime - now);
1263 if (ldap_state->pid != sys_getpid())
1264 smbldap_close(ldap_state);
1274 open_rc = smbldap_open(ldap_state);
1276 if (open_rc == LDAP_SUCCESS) {
1277 ldap_state->last_use = now;
1281 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1282 /* The fact that we are non-root or any other
1283 * access-denied condition will not change in the next
1284 * round of trying */
1294 if (open_rc != LDAP_SUCCESS) {
1295 DEBUG(1, ("Connection to LDAP server failed for the "
1296 "%d try!\n", *attempts));
1301 CatchSignal(SIGALRM, old_handler);
1303 ldap_state->last_use = now;
1307 /*********************************************************************
1308 ********************************************************************/
1310 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1311 const char *base, int scope, const char *filter,
1312 const char *attrs[], int attrsonly,
1313 LDAPControl **sctrls, LDAPControl **cctrls,
1314 int sizelimit, LDAPMessage **res)
1316 int rc = LDAP_SERVER_DOWN;
1319 time_t endtime = time(NULL)+lp_ldap_timeout();
1320 struct timeval timeout;
1321 size_t converted_size;
1323 SMB_ASSERT(ldap_state);
1325 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1326 "scope => [%d]\n", base, filter, scope));
1328 if (ldap_state->last_rebind.tv_sec > 0) {
1329 struct timeval tval;
1334 GetTimeOfDay(&tval);
1336 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1337 tdiff /= 1000; /* Convert to milliseconds. */
1339 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1340 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1342 if (sleep_time > 0) {
1343 /* we wait for the LDAP replication */
1344 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1345 "for LDAP replication.\n",sleep_time));
1346 smb_msleep(sleep_time);
1347 DEBUG(5,("smbldap_search_ext: go on!\n"));
1349 ZERO_STRUCT(ldap_state->last_rebind);
1352 if (!push_utf8_talloc(talloc_tos(), &utf8_filter, filter, &converted_size)) {
1353 return LDAP_NO_MEMORY;
1356 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1357 timeout.tv_sec = lp_ldap_timeout();
1358 timeout.tv_usec = 0;
1360 /* Setup alarm timeout.... Do we need both of these ? JRA.
1361 * Yes, I think we do need both of these. The server timeout only
1362 * covers the case where the server's operation takes too long. It
1363 * does not cover the case where the request hangs on its way to the
1364 * server. The server side timeout is not strictly necessary, it's
1365 * just a bit more kind to the server. VL. */
1368 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1369 alarm(lp_ldap_timeout());
1370 /* End setup timeout. */
1372 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1373 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1375 CONST_DISCARD(char **, attrs),
1376 attrsonly, sctrls, cctrls, &timeout,
1378 if (rc != LDAP_SUCCESS) {
1379 char *ld_error = NULL;
1382 ldap_get_option(ldap_state->ldap_struct,
1383 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1385 ldap_get_option(ldap_state->ldap_struct,
1386 LDAP_OPT_ERROR_STRING, &ld_error);
1387 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1388 "(%s)\n", base, ld_errno,
1389 ldap_err2string(rc),
1390 ld_error ? ld_error : "unknown"));
1391 SAFE_FREE(ld_error);
1393 if (ld_errno == LDAP_SERVER_DOWN) {
1394 ldap_unbind(ldap_state->ldap_struct);
1395 ldap_state->ldap_struct = NULL;
1400 TALLOC_FREE(utf8_filter);
1402 /* Teardown timeout. */
1403 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1407 return LDAP_TIMELIMIT_EXCEEDED;
1412 int smbldap_search(struct smbldap_state *ldap_state,
1413 const char *base, int scope, const char *filter,
1414 const char *attrs[], int attrsonly,
1417 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1418 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1421 int smbldap_search_paged(struct smbldap_state *ldap_state,
1422 const char *base, int scope, const char *filter,
1423 const char **attrs, int attrsonly, int pagesize,
1424 LDAPMessage **res, void **cookie)
1427 LDAPControl **rcontrols;
1428 LDAPControl *controls[2] = { NULL, NULL};
1429 BerElement *cookie_be = NULL;
1430 struct berval *cookie_bv = NULL;
1432 bool critical = True;
1436 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1437 "scope => [%d], pagesize => [%d]\n",
1438 base, filter, scope, pagesize));
1440 cookie_be = ber_alloc_t(LBER_USE_DER);
1441 if (cookie_be == NULL) {
1442 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1444 return LDAP_NO_MEMORY;
1447 /* construct cookie */
1448 if (*cookie != NULL) {
1449 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1450 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1453 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1455 ber_flatten(cookie_be, &cookie_bv);
1457 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1458 pr.ldctl_iscritical = (char) critical;
1459 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1460 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1465 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1466 0, controls, NULL, LDAP_NO_LIMIT, res);
1468 ber_free(cookie_be, 1);
1469 ber_bvfree(cookie_bv);
1472 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1473 "failed with [%s]\n", filter, ldap_err2string(rc)));
1477 DEBUG(3,("smbldap_search_paged: search was successful\n"));
1479 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1480 NULL, NULL, &rcontrols, 0);
1482 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1483 "with [%s]\n", ldap_err2string(rc)));
1487 if (rcontrols == NULL)
1490 for (i=0; rcontrols[i]; i++) {
1492 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1495 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1496 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1497 /* the berval is the cookie, but must be freed when it is all
1499 if (cookie_bv->bv_len)
1500 *cookie=ber_bvdup(cookie_bv);
1503 ber_bvfree(cookie_bv);
1504 ber_free(cookie_be, 1);
1507 ldap_controls_free(rcontrols);
1512 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1514 int rc = LDAP_SERVER_DOWN;
1517 time_t endtime = time(NULL)+lp_ldap_timeout();
1518 size_t converted_size;
1520 SMB_ASSERT(ldap_state);
1522 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1524 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1525 return LDAP_NO_MEMORY;
1528 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1529 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1530 if (rc != LDAP_SUCCESS) {
1531 char *ld_error = NULL;
1534 ldap_get_option(ldap_state->ldap_struct,
1535 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1537 ldap_get_option(ldap_state->ldap_struct,
1538 LDAP_OPT_ERROR_STRING, &ld_error);
1539 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1540 "(%s)\n", dn, ld_errno,
1541 ldap_err2string(rc),
1542 ld_error ? ld_error : "unknown"));
1543 SAFE_FREE(ld_error);
1545 if (ld_errno == LDAP_SERVER_DOWN) {
1546 ldap_unbind(ldap_state->ldap_struct);
1547 ldap_state->ldap_struct = NULL;
1552 TALLOC_FREE(utf8_dn);
1556 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1558 int rc = LDAP_SERVER_DOWN;
1561 time_t endtime = time(NULL)+lp_ldap_timeout();
1562 size_t converted_size;
1564 SMB_ASSERT(ldap_state);
1566 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1568 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1569 return LDAP_NO_MEMORY;
1572 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1573 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1574 if (rc != LDAP_SUCCESS) {
1575 char *ld_error = NULL;
1578 ldap_get_option(ldap_state->ldap_struct,
1579 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1581 ldap_get_option(ldap_state->ldap_struct,
1582 LDAP_OPT_ERROR_STRING, &ld_error);
1583 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1584 "(%s)\n", dn, ld_errno,
1585 ldap_err2string(rc),
1586 ld_error ? ld_error : "unknown"));
1587 SAFE_FREE(ld_error);
1589 if (ld_errno == LDAP_SERVER_DOWN) {
1590 ldap_unbind(ldap_state->ldap_struct);
1591 ldap_state->ldap_struct = NULL;
1596 TALLOC_FREE(utf8_dn);
1600 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1602 int rc = LDAP_SERVER_DOWN;
1605 time_t endtime = time(NULL)+lp_ldap_timeout();
1606 size_t converted_size;
1608 SMB_ASSERT(ldap_state);
1610 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1612 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1613 return LDAP_NO_MEMORY;
1616 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1617 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
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, ("Failed to delete dn: %s, error: %d (%s) "
1628 "(%s)\n", dn, 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;
1640 TALLOC_FREE(utf8_dn);
1644 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1645 LDAP_CONST char *reqoid, struct berval *reqdata,
1646 LDAPControl **serverctrls, LDAPControl **clientctrls,
1647 char **retoidp, struct berval **retdatap)
1649 int rc = LDAP_SERVER_DOWN;
1651 time_t endtime = time(NULL)+lp_ldap_timeout();
1656 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1657 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1658 reqdata, serverctrls,
1659 clientctrls, retoidp, retdatap);
1660 if (rc != LDAP_SUCCESS) {
1661 char *ld_error = NULL;
1664 ldap_get_option(ldap_state->ldap_struct,
1665 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1667 ldap_get_option(ldap_state->ldap_struct,
1668 LDAP_OPT_ERROR_STRING, &ld_error);
1669 DEBUG(10, ("Extended operation failed with error: "
1670 "%d (%s) (%s)\n", ld_errno,
1671 ldap_err2string(rc),
1672 ld_error ? ld_error : "unknown"));
1673 SAFE_FREE(ld_error);
1675 if (ld_errno == LDAP_SERVER_DOWN) {
1676 ldap_unbind(ldap_state->ldap_struct);
1677 ldap_state->ldap_struct = NULL;
1685 /*******************************************************************
1686 run the search by name.
1687 ******************************************************************/
1688 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1689 const char *filter, const char **search_attr,
1690 LDAPMessage ** result)
1692 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1693 filter, search_attr, 0, result);
1696 static void smbldap_idle_fn(struct event_context *event_ctx,
1697 struct timed_event *te,
1701 struct smbldap_state *state = (struct smbldap_state *)private_data;
1703 TALLOC_FREE(state->idle_event);
1705 if (state->ldap_struct == NULL) {
1706 DEBUG(10,("ldap connection not connected...\n"));
1710 if ((state->last_use+SMBLDAP_IDLE_TIME) > now.tv_sec) {
1711 DEBUG(10,("ldap connection not idle...\n"));
1713 state->idle_event = event_add_timed(
1715 timeval_add(&now, SMBLDAP_IDLE_TIME, 0),
1721 DEBUG(7,("ldap connection idle...closing connection\n"));
1722 smbldap_close(state);
1725 /**********************************************************************
1727 *********************************************************************/
1729 void smbldap_free_struct(struct smbldap_state **ldap_state)
1731 smbldap_close(*ldap_state);
1733 if ((*ldap_state)->bind_secret) {
1734 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1737 SAFE_FREE((*ldap_state)->bind_dn);
1738 SAFE_FREE((*ldap_state)->bind_secret);
1740 TALLOC_FREE((*ldap_state)->idle_event);
1744 /* No need to free any further, as it is talloc()ed */
1748 /**********************************************************************
1749 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1750 *********************************************************************/
1752 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1753 const char *location,
1754 struct smbldap_state **smbldap_state)
1756 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1757 if (!*smbldap_state) {
1758 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1759 return NT_STATUS_NO_MEMORY;
1763 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1765 (*smbldap_state)->uri = "ldap://localhost";
1768 (*smbldap_state)->event_context = event_ctx;
1770 return NT_STATUS_OK;
1773 char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1776 char *utf8_dn, *unix_dn;
1777 size_t converted_size;
1779 utf8_dn = ldap_get_dn(ld, entry);
1781 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1784 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1785 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1786 "[%s]\n", utf8_dn));
1789 ldap_memfree(utf8_dn);
1793 /*******************************************************************
1794 Check if root-dse has a certain Control or Extension
1795 ********************************************************************/
1797 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1799 LDAPMessage *msg = NULL;
1800 LDAPMessage *entry = NULL;
1801 char **values = NULL;
1802 int rc, num_result, num_values, i;
1803 bool result = False;
1806 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1810 if (!strequal(attrs[0], "supportedExtension") &&
1811 !strequal(attrs[0], "supportedControl") &&
1812 !strequal(attrs[0], "namingContexts")) {
1813 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1817 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1818 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1820 if (rc != LDAP_SUCCESS) {
1821 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1825 num_result = ldap_count_entries(ld, msg);
1827 if (num_result != 1) {
1828 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1832 entry = ldap_first_entry(ld, msg);
1834 if (entry == NULL) {
1835 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1839 values = ldap_get_values(ld, entry, attrs[0]);
1841 if (values == NULL) {
1842 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1846 num_values = ldap_count_values(values);
1848 if (num_values == 0) {
1849 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1853 for (i=0; i<num_values; i++) {
1854 if (strcmp(values[i], value) == 0)
1861 ldap_value_free(values);
1869 /*******************************************************************
1870 Check if LDAP-Server supports a certain Control (OID in string format)
1871 ********************************************************************/
1873 bool smbldap_has_control(LDAP *ld, const char *control)
1875 const char *attrs[] = { "supportedControl", NULL };
1876 return smbldap_check_root_dse(ld, attrs, control);
1879 /*******************************************************************
1880 Check if LDAP-Server supports a certain Extension (OID in string format)
1881 ********************************************************************/
1883 bool smbldap_has_extension(LDAP *ld, const char *extension)
1885 const char *attrs[] = { "supportedExtension", NULL };
1886 return smbldap_check_root_dse(ld, attrs, extension);
1889 /*******************************************************************
1890 Check if LDAP-Server holds a given namingContext
1891 ********************************************************************/
1893 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1895 const char *attrs[] = { "namingContexts", NULL };
1896 return smbldap_check_root_dse(ld, attrs, naming_context);
1899 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1901 ldap_state->anonymous = anon;
1903 /* free any previously set credential */
1905 SAFE_FREE(ldap_state->bind_dn);
1906 if (ldap_state->bind_secret) {
1907 /* make sure secrets are zeroed out of memory */
1908 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1909 SAFE_FREE(ldap_state->bind_secret);
1913 ldap_state->bind_dn = SMB_STRDUP(dn);
1914 ldap_state->bind_secret = SMB_STRDUP(secret);