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 #include "../libcli/security/security.h"
30 /* Try not to hit the up or down server forever */
32 #define SMBLDAP_DONT_PING_TIME 10 /* ping only all 10 seconds */
33 #define SMBLDAP_NUM_RETRIES 8 /* retry only 8 times */
35 #define SMBLDAP_IDLE_TIME 150 /* After 2.5 minutes disconnect */
38 /* attributes used by Samba 2.2 */
40 ATTRIB_MAP_ENTRY attrib_map_v22[] = {
41 { LDAP_ATTR_UID, "uid" },
42 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
43 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
44 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
45 { LDAP_ATTR_PWD_LAST_SET, "pwdLastSet" },
46 { LDAP_ATTR_PWD_CAN_CHANGE, "pwdCanChange" },
47 { LDAP_ATTR_PWD_MUST_CHANGE, "pwdMustChange" },
48 { LDAP_ATTR_LOGON_TIME, "logonTime" },
49 { LDAP_ATTR_LOGOFF_TIME, "logoffTime" },
50 { LDAP_ATTR_KICKOFF_TIME, "kickoffTime" },
51 { LDAP_ATTR_CN, "cn" },
52 { LDAP_ATTR_SN, "sn" },
53 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
54 { LDAP_ATTR_HOME_PATH, "smbHome" },
55 { LDAP_ATTR_HOME_DRIVE, "homeDrive" },
56 { LDAP_ATTR_LOGON_SCRIPT, "scriptPath" },
57 { LDAP_ATTR_PROFILE_PATH, "profilePath" },
58 { LDAP_ATTR_DESC, "description" },
59 { LDAP_ATTR_USER_WKS, "userWorkstations"},
60 { LDAP_ATTR_USER_RID, "rid" },
61 { LDAP_ATTR_PRIMARY_GROUP_RID, "primaryGroupID"},
62 { LDAP_ATTR_LMPW, "lmPassword" },
63 { LDAP_ATTR_NTPW, "ntPassword" },
64 { LDAP_ATTR_DOMAIN, "domain" },
65 { LDAP_ATTR_OBJCLASS, "objectClass" },
66 { LDAP_ATTR_ACB_INFO, "acctFlags" },
67 { LDAP_ATTR_MOD_TIMESTAMP, "modifyTimestamp" },
68 { LDAP_ATTR_LIST_END, NULL }
71 ATTRIB_MAP_ENTRY attrib_map_to_delete_v22[] = {
72 { LDAP_ATTR_PWD_LAST_SET, "pwdLastSet" },
73 { LDAP_ATTR_PWD_CAN_CHANGE, "pwdCanChange" },
74 { LDAP_ATTR_PWD_MUST_CHANGE, "pwdMustChange" },
75 { LDAP_ATTR_LOGON_TIME, "logonTime" },
76 { LDAP_ATTR_LOGOFF_TIME, "logoffTime" },
77 { LDAP_ATTR_KICKOFF_TIME, "kickoffTime" },
78 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
79 { LDAP_ATTR_HOME_PATH, "smbHome" },
80 { LDAP_ATTR_HOME_DRIVE, "homeDrives" },
81 { LDAP_ATTR_LOGON_SCRIPT, "scriptPath" },
82 { LDAP_ATTR_PROFILE_PATH, "profilePath" },
83 { LDAP_ATTR_USER_WKS, "userWorkstations"},
84 { LDAP_ATTR_USER_RID, "rid" },
85 { LDAP_ATTR_PRIMARY_GROUP_RID, "primaryGroupID"},
86 { LDAP_ATTR_LMPW, "lmPassword" },
87 { LDAP_ATTR_NTPW, "ntPassword" },
88 { LDAP_ATTR_DOMAIN, "domain" },
89 { LDAP_ATTR_ACB_INFO, "acctFlags" },
90 { LDAP_ATTR_LIST_END, NULL }
93 /* attributes used by Samba 3.0's sambaSamAccount */
95 ATTRIB_MAP_ENTRY attrib_map_v30[] = {
96 { LDAP_ATTR_UID, "uid" },
97 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
98 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
99 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
100 { LDAP_ATTR_PWD_LAST_SET, "sambaPwdLastSet" },
101 { LDAP_ATTR_PWD_CAN_CHANGE, "sambaPwdCanChange" },
102 { LDAP_ATTR_PWD_MUST_CHANGE, "sambaPwdMustChange" },
103 { LDAP_ATTR_LOGON_TIME, "sambaLogonTime" },
104 { LDAP_ATTR_LOGOFF_TIME, "sambaLogoffTime" },
105 { LDAP_ATTR_KICKOFF_TIME, "sambaKickoffTime" },
106 { LDAP_ATTR_CN, "cn" },
107 { LDAP_ATTR_SN, "sn" },
108 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
109 { LDAP_ATTR_HOME_DRIVE, "sambaHomeDrive" },
110 { LDAP_ATTR_HOME_PATH, "sambaHomePath" },
111 { LDAP_ATTR_LOGON_SCRIPT, "sambaLogonScript" },
112 { LDAP_ATTR_PROFILE_PATH, "sambaProfilePath" },
113 { LDAP_ATTR_DESC, "description" },
114 { LDAP_ATTR_USER_WKS, "sambaUserWorkstations" },
115 { LDAP_ATTR_USER_SID, LDAP_ATTRIBUTE_SID },
116 { LDAP_ATTR_PRIMARY_GROUP_SID, "sambaPrimaryGroupSID" },
117 { LDAP_ATTR_LMPW, "sambaLMPassword" },
118 { LDAP_ATTR_NTPW, "sambaNTPassword" },
119 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
120 { LDAP_ATTR_OBJCLASS, "objectClass" },
121 { LDAP_ATTR_ACB_INFO, "sambaAcctFlags" },
122 { LDAP_ATTR_MUNGED_DIAL, "sambaMungedDial" },
123 { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
124 { LDAP_ATTR_BAD_PASSWORD_TIME, "sambaBadPasswordTime" },
125 { LDAP_ATTR_PWD_HISTORY, "sambaPasswordHistory" },
126 { LDAP_ATTR_MOD_TIMESTAMP, "modifyTimestamp" },
127 { LDAP_ATTR_LOGON_HOURS, "sambaLogonHours" },
128 { LDAP_ATTR_LIST_END, NULL }
131 ATTRIB_MAP_ENTRY attrib_map_to_delete_v30[] = {
132 { LDAP_ATTR_PWD_LAST_SET, "sambaPwdLastSet" },
133 { LDAP_ATTR_PWD_CAN_CHANGE, "sambaPwdCanChange" },
134 { LDAP_ATTR_PWD_MUST_CHANGE, "sambaPwdMustChange" },
135 { LDAP_ATTR_LOGON_TIME, "sambaLogonTime" },
136 { LDAP_ATTR_LOGOFF_TIME, "sambaLogoffTime" },
137 { LDAP_ATTR_KICKOFF_TIME, "sambaKickoffTime" },
138 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
139 { LDAP_ATTR_HOME_DRIVE, "sambaHomeDrive" },
140 { LDAP_ATTR_HOME_PATH, "sambaHomePath" },
141 { LDAP_ATTR_LOGON_SCRIPT, "sambaLogonScript" },
142 { LDAP_ATTR_PROFILE_PATH, "sambaProfilePath" },
143 { LDAP_ATTR_USER_WKS, "sambaUserWorkstations" },
144 { LDAP_ATTR_USER_SID, LDAP_ATTRIBUTE_SID },
145 { LDAP_ATTR_PRIMARY_GROUP_SID, "sambaPrimaryGroupSID" },
146 { LDAP_ATTR_LMPW, "sambaLMPassword" },
147 { LDAP_ATTR_NTPW, "sambaNTPassword" },
148 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
149 { LDAP_ATTR_ACB_INFO, "sambaAcctFlags" },
150 { LDAP_ATTR_MUNGED_DIAL, "sambaMungedDial" },
151 { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
152 { LDAP_ATTR_BAD_PASSWORD_TIME, "sambaBadPasswordTime" },
153 { LDAP_ATTR_PWD_HISTORY, "sambaPasswordHistory" },
154 { LDAP_ATTR_LOGON_HOURS, "sambaLogonHours" },
155 { LDAP_ATTR_LIST_END, NULL }
158 /* attributes used for allocating RIDs */
160 ATTRIB_MAP_ENTRY dominfo_attr_list[] = {
161 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
162 { LDAP_ATTR_NEXT_RID, "sambaNextRid" },
163 { LDAP_ATTR_NEXT_USERRID, "sambaNextUserRid" },
164 { LDAP_ATTR_NEXT_GROUPRID, "sambaNextGroupRid" },
165 { LDAP_ATTR_DOM_SID, LDAP_ATTRIBUTE_SID },
166 { LDAP_ATTR_ALGORITHMIC_RID_BASE,"sambaAlgorithmicRidBase"},
167 { LDAP_ATTR_OBJCLASS, "objectClass" },
168 { LDAP_ATTR_LIST_END, NULL },
171 /* Samba 3.0 group mapping attributes */
173 ATTRIB_MAP_ENTRY groupmap_attr_list[] = {
174 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
175 { LDAP_ATTR_GROUP_SID, LDAP_ATTRIBUTE_SID },
176 { LDAP_ATTR_GROUP_TYPE, "sambaGroupType" },
177 { LDAP_ATTR_SID_LIST, "sambaSIDList" },
178 { LDAP_ATTR_DESC, "description" },
179 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
180 { LDAP_ATTR_CN, "cn" },
181 { LDAP_ATTR_OBJCLASS, "objectClass" },
182 { LDAP_ATTR_LIST_END, NULL }
185 ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete[] = {
186 { LDAP_ATTR_GROUP_SID, LDAP_ATTRIBUTE_SID },
187 { LDAP_ATTR_GROUP_TYPE, "sambaGroupType" },
188 { LDAP_ATTR_DESC, "description" },
189 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
190 { LDAP_ATTR_SID_LIST, "sambaSIDList" },
191 { LDAP_ATTR_LIST_END, NULL }
194 /* idmap_ldap sambaUnixIdPool */
196 ATTRIB_MAP_ENTRY idpool_attr_list[] = {
197 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
198 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
199 { LDAP_ATTR_OBJCLASS, "objectClass" },
200 { LDAP_ATTR_LIST_END, NULL }
203 ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
204 { LDAP_ATTR_SID, LDAP_ATTRIBUTE_SID },
205 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
206 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
207 { LDAP_ATTR_OBJCLASS, "objectClass" },
208 { LDAP_ATTR_LIST_END, NULL }
211 /**********************************************************************
212 perform a simple table lookup and return the attribute name
213 **********************************************************************/
215 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table[], int key )
219 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
220 if ( table[i].attrib == key )
221 return table[i].name;
229 /**********************************************************************
230 Return the list of attribute names from a mapping table
231 **********************************************************************/
233 const char** get_attr_list( TALLOC_CTX *mem_ctx, ATTRIB_MAP_ENTRY table[] )
238 while ( table[i].attrib != LDAP_ATTR_LIST_END )
242 names = TALLOC_ARRAY( mem_ctx, const char*, i );
244 DEBUG(0,("get_attr_list: out of memory\n"));
249 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
250 names[i] = talloc_strdup( names, table[i].name );
258 /*******************************************************************
259 Search an attribute and return the first value found.
260 ******************************************************************/
262 bool smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
263 const char *attribute, char *value,
274 if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
275 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
280 if (!convert_string(CH_UTF8, CH_UNIX,values[0], -1, value, max_len, &size)) {
281 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
282 attribute, values[0]));
283 ldap_value_free(values);
287 ldap_value_free(values);
288 #ifdef DEBUG_PASSWORDS
289 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
294 char * smbldap_talloc_single_attribute(LDAP *ldap_struct, LDAPMessage *entry,
295 const char *attribute,
300 size_t converted_size;
302 if (attribute == NULL) {
306 values = ldap_get_values(ldap_struct, entry, attribute);
308 if (values == NULL) {
309 DEBUG(10, ("attribute %s does not exist\n", attribute));
313 if (ldap_count_values(values) != 1) {
314 DEBUG(10, ("attribute %s has %d values, expected only one\n",
315 attribute, ldap_count_values(values)));
316 ldap_value_free(values);
320 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
321 DEBUG(10, ("pull_utf8_talloc failed\n"));
322 ldap_value_free(values);
326 ldap_value_free(values);
328 #ifdef DEBUG_PASSWORDS
329 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
335 char * smbldap_talloc_first_attribute(LDAP *ldap_struct, LDAPMessage *entry,
336 const char *attribute,
341 size_t converted_size;
343 if (attribute == NULL) {
347 values = ldap_get_values(ldap_struct, entry, attribute);
349 if (values == NULL) {
350 DEBUG(10, ("attribute %s does not exist\n", attribute));
354 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
355 DEBUG(10, ("pull_utf8_talloc failed\n"));
356 ldap_value_free(values);
360 ldap_value_free(values);
362 #ifdef DEBUG_PASSWORDS
363 DEBUG (100, ("smbldap_get_first_attribute: [%s] = [%s]\n",
369 char * smbldap_talloc_smallest_attribute(LDAP *ldap_struct, LDAPMessage *entry,
370 const char *attribute,
375 size_t converted_size;
378 if (attribute == NULL) {
382 values = ldap_get_values(ldap_struct, entry, attribute);
384 if (values == NULL) {
385 DEBUG(10, ("attribute %s does not exist\n", attribute));
389 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
390 DEBUG(10, ("pull_utf8_talloc failed\n"));
391 ldap_value_free(values);
395 num_values = ldap_count_values(values);
397 for (i=1; i<num_values; i++) {
400 if (!pull_utf8_talloc(mem_ctx, &tmp, values[i],
402 DEBUG(10, ("pull_utf8_talloc failed\n"));
404 ldap_value_free(values);
408 if (StrCaseCmp(tmp, result) < 0) {
416 ldap_value_free(values);
418 #ifdef DEBUG_PASSWORDS
419 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
425 bool smbldap_talloc_single_blob(TALLOC_CTX *mem_ctx, LDAP *ld,
426 LDAPMessage *msg, const char *attrib,
429 struct berval **values;
431 values = ldap_get_values_len(ld, msg, attrib);
436 if (ldap_count_values_len(values) != 1) {
437 DEBUG(10, ("Expected one value for %s, got %d\n", attrib,
438 ldap_count_values_len(values)));
442 *blob = data_blob_talloc(mem_ctx, values[0]->bv_val,
444 ldap_value_free_len(values);
446 return (blob->data != NULL);
449 bool smbldap_pull_sid(LDAP *ld, LDAPMessage *msg, const char *attrib,
455 if (!smbldap_talloc_single_blob(talloc_tos(), ld, msg, attrib,
459 ret = sid_parse((char *)blob.data, blob.length, sid);
460 TALLOC_FREE(blob.data);
464 static int ldapmsg_destructor(LDAPMessage **result) {
465 ldap_msgfree(*result);
469 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
471 LDAPMessage **handle;
473 if (result == NULL) {
477 handle = TALLOC_P(mem_ctx, LDAPMessage *);
478 SMB_ASSERT(handle != NULL);
481 talloc_set_destructor(handle, ldapmsg_destructor);
484 static int ldapmod_destructor(LDAPMod ***mod) {
485 ldap_mods_free(*mod, True);
489 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
497 handle = TALLOC_P(mem_ctx, LDAPMod **);
498 SMB_ASSERT(handle != NULL);
501 talloc_set_destructor(handle, ldapmod_destructor);
504 /************************************************************************
505 Routine to manage the LDAPMod structure array
506 manage memory used by the array, by each struct, and values
507 ***********************************************************************/
509 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
517 /* sanity checks on the mod values */
519 if (attribute == NULL || *attribute == '\0') {
523 #if 0 /* commented out after discussion with abartlet. Do not reenable.
524 left here so other do not re-add similar code --jerry */
525 if (value == NULL || *value == '\0')
530 mods = SMB_MALLOC_P(LDAPMod *);
532 smb_panic("smbldap_set_mod: out of memory!");
538 for (i = 0; mods[i] != NULL; ++i) {
539 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
543 if (mods[i] == NULL) {
544 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
546 smb_panic("smbldap_set_mod: out of memory!");
549 mods[i] = SMB_MALLOC_P(LDAPMod);
550 if (mods[i] == NULL) {
551 smb_panic("smbldap_set_mod: out of memory!");
554 mods[i]->mod_op = modop;
555 mods[i]->mod_values = NULL;
556 mods[i]->mod_type = SMB_STRDUP(attribute);
561 char *utf8_value = NULL;
562 size_t converted_size;
565 if (mods[i]->mod_values != NULL) {
566 for (; mods[i]->mod_values[j] != NULL; j++);
568 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
570 if (mods[i]->mod_values == NULL) {
571 smb_panic("smbldap_set_mod: out of memory!");
575 if (!push_utf8_talloc(talloc_tos(), &utf8_value, value, &converted_size)) {
576 smb_panic("smbldap_set_mod: String conversion failure!");
580 mods[i]->mod_values[j] = SMB_STRDUP(utf8_value);
581 TALLOC_FREE(utf8_value);
582 SMB_ASSERT(mods[i]->mod_values[j] != NULL);
584 mods[i]->mod_values[j + 1] = NULL;
589 /**********************************************************************
590 Set attribute to newval in LDAP, regardless of what value the
591 attribute had in LDAP before.
592 *********************************************************************/
594 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
596 const char *attribute, const char *newval)
598 char oldval[2048]; /* current largest allowed value is mungeddial */
601 if (attribute == NULL) {
602 /* This can actually happen for ldapsam_compat where we for
603 * example don't have a password history */
607 if (existing != NULL) {
608 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
614 /* all of our string attributes are case insensitive */
616 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
618 /* Believe it or not, but LDAP will deny a delete and
619 an add at the same time if the values are the
621 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
626 /* There has been no value before, so don't delete it.
627 * Here's a possible race: We might end up with
628 * duplicate attributes */
629 /* By deleting exactly the value we found in the entry this
630 * should be race-free in the sense that the LDAP-Server will
631 * deny the complete operation if somebody changed the
632 * attribute behind our back. */
633 /* This will also allow modifying single valued attributes
634 * in Novell NDS. In NDS you have to first remove attribute and then
635 * you could add new value */
637 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
638 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
641 /* Regardless of the real operation (add or modify)
642 we add the new value here. We rely on deleting
643 the old value, should it exist. */
645 if ((newval != NULL) && (strlen(newval) > 0)) {
646 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
647 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
651 /**********************************************************************
652 Some varients of the LDAP rebind code do not pass in the third 'arg'
653 pointer to a void*, so we try and work around it by assuming that the
654 value of the 'LDAP *' pointer is the same as the one we had passed in
655 **********************************************************************/
657 struct smbldap_state_lookup {
659 struct smbldap_state *smbldap_state;
660 struct smbldap_state_lookup *prev, *next;
663 static struct smbldap_state_lookup *smbldap_state_lookup_list;
665 static struct smbldap_state *smbldap_find_state(LDAP *ld)
667 struct smbldap_state_lookup *t;
669 for (t = smbldap_state_lookup_list; t; t = t->next) {
671 return t->smbldap_state;
677 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
679 struct smbldap_state_lookup *t;
681 for (t = smbldap_state_lookup_list; t; t = t->next) {
682 if (t->smbldap_state == smbldap_state) {
683 DLIST_REMOVE(smbldap_state_lookup_list, t);
690 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
692 struct smbldap_state *tmp_ldap_state;
693 struct smbldap_state_lookup *t;
695 if ((tmp_ldap_state = smbldap_find_state(ld))) {
696 SMB_ASSERT(tmp_ldap_state == smbldap_state);
700 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
703 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
705 t->smbldap_state = smbldap_state;
708 /********************************************************************
709 start TLS on an existing LDAP connection
710 *******************************************************************/
712 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
714 #ifdef LDAP_OPT_X_TLS
718 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
722 #ifdef LDAP_OPT_X_TLS
723 if (version != LDAP_VERSION3) {
724 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
725 return LDAP_OPERATIONS_ERROR;
728 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
729 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
730 ldap_err2string(rc)));
734 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
737 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
738 return LDAP_OPERATIONS_ERROR;
742 /********************************************************************
743 setup a connection to the LDAP server based on a uri
744 *******************************************************************/
746 static int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
750 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
752 #ifdef HAVE_LDAP_INITIALIZE
754 rc = ldap_initialize(ldap_struct, uri);
756 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
760 if (lp_ldap_follow_referral() != Auto) {
761 rc = ldap_set_option(*ldap_struct, LDAP_OPT_REFERRALS,
762 lp_ldap_follow_referral() ? LDAP_OPT_ON : LDAP_OPT_OFF);
763 if (rc != LDAP_SUCCESS)
764 DEBUG(0, ("Failed to set LDAP_OPT_REFERRALS: %s\n",
765 ldap_err2string(rc)));
771 /* Parse the string manually */
777 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
780 /* skip leading "URL:" (if any) */
781 if ( strnequal( uri, "URL:", 4 ) ) {
785 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
788 if (strequal(protocol, "ldap")) {
790 } else if (strequal(protocol, "ldaps")) {
793 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
797 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
798 DEBUG(0, ("ldap_init failed !\n"));
799 return LDAP_OPERATIONS_ERROR;
802 if (strequal(protocol, "ldaps")) {
803 #ifdef LDAP_OPT_X_TLS
804 int tls = LDAP_OPT_X_TLS_HARD;
805 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
807 DEBUG(0, ("Failed to setup a TLS session\n"));
810 DEBUG(3,("LDAPS option set...!\n"));
812 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
813 return LDAP_OPERATIONS_ERROR;
814 #endif /* LDAP_OPT_X_TLS */
817 #endif /* HAVE_LDAP_INITIALIZE */
819 /* now set connection timeout */
820 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
822 int ct = lp_ldap_connection_timeout()*1000;
823 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
824 if (rc != LDAP_SUCCESS) {
825 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
826 ct, ldap_err2string(rc)));
829 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
833 ct.tv_sec = lp_ldap_connection_timeout();
834 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
835 if (rc != LDAP_SUCCESS) {
836 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
837 (int)ct.tv_sec, ldap_err2string(rc)));
845 /********************************************************************
846 try to upgrade to Version 3 LDAP if not already, in either case return current
848 *******************************************************************/
850 static int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
855 /* assume the worst */
856 *new_version = LDAP_VERSION2;
858 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
863 if (version == LDAP_VERSION3) {
864 *new_version = LDAP_VERSION3;
869 version = LDAP_VERSION3;
870 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
875 *new_version = LDAP_VERSION3;
879 /*******************************************************************
880 open a connection to the ldap server (just until the bind)
881 ******************************************************************/
883 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
887 rc = smb_ldap_setup_conn(ldap_struct, uri);
892 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
897 rc = smb_ldap_start_tls(*ldap_struct, version);
905 /*******************************************************************
906 open a connection to the ldap server.
907 ******************************************************************/
908 static int smbldap_open_connection (struct smbldap_state *ldap_state)
911 int rc = LDAP_SUCCESS;
914 LDAP **ldap_struct = &ldap_state->ldap_struct;
916 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
921 /* Store the LDAP pointer in a lookup list */
923 smbldap_store_state(*ldap_struct, ldap_state);
925 /* Upgrade to LDAPv3 if possible */
927 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
932 /* Start TLS if required */
934 rc = smb_ldap_start_tls(*ldap_struct, version);
939 /* Set alias dereferencing method */
940 deref = lp_ldap_deref();
942 if (ldap_set_option (*ldap_struct, LDAP_OPT_DEREF, &deref) != LDAP_OPT_SUCCESS) {
943 DEBUG(1,("smbldap_open_connection: Failed to set dereferencing method: %d\n", deref));
945 DEBUG(5,("Set dereferencing method: %d\n", deref));
949 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
953 /*******************************************************************
954 a rebind function for authenticated referrals
955 This version takes a void* that we can shove useful stuff in :-)
956 ******************************************************************/
957 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
959 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
960 int *methodp, int freeit, void *arg)
962 struct smbldap_state *ldap_state = arg;
965 /** @TODO Should we be doing something to check what servers we rebind to?
966 Could we get a referral to a machine that we don't want to give our
967 username and password to? */
972 memset(*credp, '\0', strlen(*credp));
976 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
977 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
979 if (ldap_state->anonymous) {
983 *whop = SMB_STRDUP(ldap_state->bind_dn);
985 return LDAP_NO_MEMORY;
987 *credp = SMB_STRDUP(ldap_state->bind_secret);
990 return LDAP_NO_MEMORY;
993 *methodp = LDAP_AUTH_SIMPLE;
996 clock_gettime_mono(&ts);
997 ldap_state->last_rebind = convert_timespec_to_timeval(ts);
1001 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1003 /*******************************************************************
1004 a rebind function for authenticated referrals
1005 This version takes a void* that we can shove useful stuff in :-)
1006 and actually does the connection.
1007 ******************************************************************/
1008 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1009 static int rebindproc_connect_with_state (LDAP *ldap_struct,
1010 LDAP_CONST char *url,
1012 ber_int_t msgid, void *arg)
1014 struct smbldap_state *ldap_state =
1015 (struct smbldap_state *)arg;
1020 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
1021 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
1023 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
1024 * itself) before rebinding to another LDAP server to avoid to expose
1025 * our credentials. At least *try* to secure the connection - Guenther */
1027 smb_ldap_upgrade_conn(ldap_struct, &version);
1028 smb_ldap_start_tls(ldap_struct, version);
1030 /** @TODO Should we be doing something to check what servers we rebind to?
1031 Could we get a referral to a machine that we don't want to give our
1032 username and password to? */
1034 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1036 /* only set the last rebind timestamp when we did rebind after a
1037 * non-read LDAP operation. That way we avoid the replication sleep
1038 * after a simple redirected search operation - Guenther */
1042 case LDAP_REQ_MODIFY:
1044 case LDAP_REQ_DELETE:
1045 case LDAP_REQ_MODDN:
1046 case LDAP_REQ_EXTENDED:
1047 DEBUG(10,("rebindproc_connect_with_state: "
1048 "setting last_rebind timestamp "
1049 "(req: 0x%02x)\n", (unsigned int)request));
1050 clock_gettime_mono(&ts);
1051 ldap_state->last_rebind = convert_timespec_to_timeval(ts);
1054 ZERO_STRUCT(ldap_state->last_rebind);
1060 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1062 /*******************************************************************
1063 Add a rebind function for authenticated referrals
1064 ******************************************************************/
1065 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1067 # if LDAP_SET_REBIND_PROC_ARGS == 2
1068 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
1069 int *method, int freeit )
1071 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
1073 return rebindproc_with_state(ldap_struct, whop, credp,
1074 method, freeit, ldap_state);
1076 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1077 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1079 /*******************************************************************
1080 a rebind function for authenticated referrals
1081 this also does the connection, but no void*.
1082 ******************************************************************/
1083 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1084 # if LDAP_SET_REBIND_PROC_ARGS == 2
1085 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
1088 struct smbldap_state *ldap_state = smbldap_find_state(ld);
1090 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
1093 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1094 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1096 /*******************************************************************
1097 connect to the ldap server under system privilege.
1098 ******************************************************************/
1099 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
1104 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
1105 char *bind_dn = NULL;
1106 char *bind_secret = NULL;
1108 /* get the default dn and password only if they are not set already */
1109 if (!fetch_ldap_pw(&bind_dn, &bind_secret)) {
1110 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
1111 return LDAP_INVALID_CREDENTIALS;
1113 smbldap_set_creds(ldap_state, false, bind_dn, bind_secret);
1115 memset(bind_secret, '\0', strlen(bind_secret));
1116 SAFE_FREE(bind_secret);
1119 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
1120 (OpenLDAP) doesnt' seem to support it */
1122 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
1123 ldap_state->uri, ldap_state->bind_dn));
1125 #ifdef HAVE_LDAP_SET_REBIND_PROC
1126 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1127 # if LDAP_SET_REBIND_PROC_ARGS == 2
1128 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
1130 # if LDAP_SET_REBIND_PROC_ARGS == 3
1131 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
1133 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1134 # if LDAP_SET_REBIND_PROC_ARGS == 2
1135 ldap_set_rebind_proc(ldap_struct, &rebindproc);
1137 # if LDAP_SET_REBIND_PROC_ARGS == 3
1138 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
1140 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1143 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1145 if (rc != LDAP_SUCCESS) {
1146 char *ld_error = NULL;
1147 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
1149 DEBUG(ldap_state->num_failures ? 2 : 0,
1150 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
1152 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
1153 ldap_err2string(rc),
1154 ld_error ? ld_error : "(unknown)"));
1155 SAFE_FREE(ld_error);
1156 ldap_state->num_failures++;
1160 ldap_state->num_failures = 0;
1161 ldap_state->paged_results = False;
1163 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1165 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1166 ldap_state->paged_results = True;
1169 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1170 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1171 ldap_state->paged_results ? "does" : "does not"));
1175 static void smbldap_idle_fn(struct event_context *event_ctx,
1176 struct timed_event *te,
1177 struct timeval now_abs,
1178 void *private_data);
1180 /**********************************************************************
1181 Connect to LDAP server (called before every ldap operation)
1182 *********************************************************************/
1183 static int smbldap_open(struct smbldap_state *ldap_state)
1186 bool reopen = False;
1187 SMB_ASSERT(ldap_state);
1189 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time_mono(NULL))) {
1191 #ifdef HAVE_UNIXSOCKET
1192 struct sockaddr_un addr;
1194 struct sockaddr addr;
1196 socklen_t len = sizeof(addr);
1199 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1200 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1203 #ifdef HAVE_UNIXSOCKET
1204 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1208 /* the other end has died. reopen. */
1209 ldap_unbind(ldap_state->ldap_struct);
1210 ldap_state->ldap_struct = NULL;
1211 ldap_state->last_ping = (time_t)0;
1213 ldap_state->last_ping = time_mono(NULL);
1217 if (ldap_state->ldap_struct != NULL) {
1218 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1219 return LDAP_SUCCESS;
1222 if ((rc = smbldap_open_connection(ldap_state))) {
1226 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1227 ldap_unbind(ldap_state->ldap_struct);
1228 ldap_state->ldap_struct = NULL;
1233 ldap_state->last_ping = time_mono(NULL);
1234 ldap_state->pid = sys_getpid();
1236 TALLOC_FREE(ldap_state->idle_event);
1238 if (ldap_state->event_context != NULL) {
1239 ldap_state->idle_event = event_add_timed(
1240 ldap_state->event_context, NULL,
1241 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1242 smbldap_idle_fn, ldap_state);
1245 DEBUG(4,("The LDAP server is successfully connected\n"));
1247 return LDAP_SUCCESS;
1250 /**********************************************************************
1251 Disconnect from LDAP server
1252 *********************************************************************/
1253 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1256 return NT_STATUS_INVALID_PARAMETER;
1258 if (ldap_state->ldap_struct != NULL) {
1259 ldap_unbind(ldap_state->ldap_struct);
1260 ldap_state->ldap_struct = NULL;
1263 smbldap_delete_state(ldap_state);
1265 DEBUG(5,("The connection to the LDAP server was closed\n"));
1266 /* maybe free the results here --metze */
1268 return NT_STATUS_OK;
1271 static bool got_alarm;
1273 static void (*old_handler)(int);
1275 static void gotalarm_sig(int dummy)
1280 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1281 int *attempts, time_t endtime)
1283 time_t now = time_mono(NULL);
1284 int open_rc = LDAP_SERVER_DOWN;
1286 if (*rc != LDAP_SERVER_DOWN)
1289 if (now >= endtime) {
1290 smbldap_close(ldap_state);
1295 if (*attempts == 0) {
1297 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1298 alarm(endtime - now);
1300 if (ldap_state->pid != sys_getpid())
1301 smbldap_close(ldap_state);
1311 open_rc = smbldap_open(ldap_state);
1313 if (open_rc == LDAP_SUCCESS) {
1314 ldap_state->last_use = now;
1318 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1319 /* The fact that we are non-root or any other
1320 * access-denied condition will not change in the next
1321 * round of trying */
1331 if (open_rc != LDAP_SUCCESS) {
1332 DEBUG(1, ("Connection to LDAP server failed for the "
1333 "%d try!\n", *attempts));
1338 CatchSignal(SIGALRM, old_handler);
1340 ldap_state->last_use = now;
1344 /*********************************************************************
1345 ********************************************************************/
1347 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1348 const char *base, int scope, const char *filter,
1349 const char *attrs[], int attrsonly,
1350 LDAPControl **sctrls, LDAPControl **cctrls,
1351 int sizelimit, LDAPMessage **res)
1353 int rc = LDAP_SERVER_DOWN;
1356 time_t endtime = time_mono(NULL)+lp_ldap_timeout();
1357 struct timeval timeout;
1358 size_t converted_size;
1360 SMB_ASSERT(ldap_state);
1362 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1363 "scope => [%d]\n", base, filter, scope));
1365 if (ldap_state->last_rebind.tv_sec > 0) {
1366 struct timeval tval;
1371 clock_gettime_mono(&ts);
1372 tval = convert_timespec_to_timeval(ts);
1374 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1375 tdiff /= 1000; /* Convert to milliseconds. */
1377 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1378 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1380 if (sleep_time > 0) {
1381 /* we wait for the LDAP replication */
1382 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1383 "for LDAP replication.\n",sleep_time));
1384 smb_msleep(sleep_time);
1385 DEBUG(5,("smbldap_search_ext: go on!\n"));
1387 ZERO_STRUCT(ldap_state->last_rebind);
1390 if (!push_utf8_talloc(talloc_tos(), &utf8_filter, filter, &converted_size)) {
1391 return LDAP_NO_MEMORY;
1394 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1395 timeout.tv_sec = lp_ldap_timeout();
1396 timeout.tv_usec = 0;
1398 /* Setup alarm timeout.... Do we need both of these ? JRA.
1399 * Yes, I think we do need both of these. The server timeout only
1400 * covers the case where the server's operation takes too long. It
1401 * does not cover the case where the request hangs on its way to the
1402 * server. The server side timeout is not strictly necessary, it's
1403 * just a bit more kind to the server. VL. */
1406 CatchSignal(SIGALRM, gotalarm_sig);
1407 alarm(lp_ldap_timeout());
1408 /* End setup timeout. */
1410 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1411 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1413 CONST_DISCARD(char **, attrs),
1414 attrsonly, sctrls, cctrls, &timeout,
1416 if (rc != LDAP_SUCCESS) {
1417 char *ld_error = NULL;
1420 ldap_get_option(ldap_state->ldap_struct,
1421 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1423 ldap_get_option(ldap_state->ldap_struct,
1424 LDAP_OPT_ERROR_STRING, &ld_error);
1425 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1426 "(%s)\n", base, ld_errno,
1427 ldap_err2string(rc),
1428 ld_error ? ld_error : "unknown"));
1429 SAFE_FREE(ld_error);
1431 if (ld_errno == LDAP_SERVER_DOWN) {
1432 ldap_unbind(ldap_state->ldap_struct);
1433 ldap_state->ldap_struct = NULL;
1438 TALLOC_FREE(utf8_filter);
1440 /* Teardown timeout. */
1441 CatchSignal(SIGALRM, SIG_IGN);
1445 return LDAP_TIMELIMIT_EXCEEDED;
1450 int smbldap_search(struct smbldap_state *ldap_state,
1451 const char *base, int scope, const char *filter,
1452 const char *attrs[], int attrsonly,
1455 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1456 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1459 int smbldap_search_paged(struct smbldap_state *ldap_state,
1460 const char *base, int scope, const char *filter,
1461 const char **attrs, int attrsonly, int pagesize,
1462 LDAPMessage **res, void **cookie)
1465 LDAPControl **rcontrols;
1466 LDAPControl *controls[2] = { NULL, NULL};
1467 BerElement *cookie_be = NULL;
1468 struct berval *cookie_bv = NULL;
1470 bool critical = True;
1474 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1475 "scope => [%d], pagesize => [%d]\n",
1476 base, filter, scope, pagesize));
1478 cookie_be = ber_alloc_t(LBER_USE_DER);
1479 if (cookie_be == NULL) {
1480 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1482 return LDAP_NO_MEMORY;
1485 /* construct cookie */
1486 if (*cookie != NULL) {
1487 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1488 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1491 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1493 ber_flatten(cookie_be, &cookie_bv);
1495 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1496 pr.ldctl_iscritical = (char) critical;
1497 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1498 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1503 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1504 0, controls, NULL, LDAP_NO_LIMIT, res);
1506 ber_free(cookie_be, 1);
1507 ber_bvfree(cookie_bv);
1510 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1511 "failed with [%s]\n", filter, ldap_err2string(rc)));
1515 DEBUG(3,("smbldap_search_paged: search was successful\n"));
1517 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1518 NULL, NULL, &rcontrols, 0);
1520 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1521 "with [%s]\n", ldap_err2string(rc)));
1525 if (rcontrols == NULL)
1528 for (i=0; rcontrols[i]; i++) {
1530 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1533 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1534 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1535 /* the berval is the cookie, but must be freed when it is all
1537 if (cookie_bv->bv_len)
1538 *cookie=ber_bvdup(cookie_bv);
1541 ber_bvfree(cookie_bv);
1542 ber_free(cookie_be, 1);
1545 ldap_controls_free(rcontrols);
1550 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1552 int rc = LDAP_SERVER_DOWN;
1555 time_t endtime = time_mono(NULL)+lp_ldap_timeout();
1556 size_t converted_size;
1558 SMB_ASSERT(ldap_state);
1560 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1562 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1563 return LDAP_NO_MEMORY;
1566 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1567 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1568 if (rc != LDAP_SUCCESS) {
1569 char *ld_error = NULL;
1572 ldap_get_option(ldap_state->ldap_struct,
1573 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1575 ldap_get_option(ldap_state->ldap_struct,
1576 LDAP_OPT_ERROR_STRING, &ld_error);
1577 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1578 "(%s)\n", dn, ld_errno,
1579 ldap_err2string(rc),
1580 ld_error ? ld_error : "unknown"));
1581 SAFE_FREE(ld_error);
1583 if (ld_errno == LDAP_SERVER_DOWN) {
1584 ldap_unbind(ldap_state->ldap_struct);
1585 ldap_state->ldap_struct = NULL;
1590 TALLOC_FREE(utf8_dn);
1594 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1596 int rc = LDAP_SERVER_DOWN;
1599 time_t endtime = time_mono(NULL)+lp_ldap_timeout();
1600 size_t converted_size;
1602 SMB_ASSERT(ldap_state);
1604 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1606 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1607 return LDAP_NO_MEMORY;
1610 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1611 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1612 if (rc != LDAP_SUCCESS) {
1613 char *ld_error = NULL;
1616 ldap_get_option(ldap_state->ldap_struct,
1617 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1619 ldap_get_option(ldap_state->ldap_struct,
1620 LDAP_OPT_ERROR_STRING, &ld_error);
1621 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1622 "(%s)\n", dn, ld_errno,
1623 ldap_err2string(rc),
1624 ld_error ? ld_error : "unknown"));
1625 SAFE_FREE(ld_error);
1627 if (ld_errno == LDAP_SERVER_DOWN) {
1628 ldap_unbind(ldap_state->ldap_struct);
1629 ldap_state->ldap_struct = NULL;
1634 TALLOC_FREE(utf8_dn);
1638 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1640 int rc = LDAP_SERVER_DOWN;
1643 time_t endtime = time_mono(NULL)+lp_ldap_timeout();
1644 size_t converted_size;
1646 SMB_ASSERT(ldap_state);
1648 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1650 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1651 return LDAP_NO_MEMORY;
1654 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1655 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1656 if (rc != LDAP_SUCCESS) {
1657 char *ld_error = NULL;
1660 ldap_get_option(ldap_state->ldap_struct,
1661 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1663 ldap_get_option(ldap_state->ldap_struct,
1664 LDAP_OPT_ERROR_STRING, &ld_error);
1665 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1666 "(%s)\n", dn, ld_errno,
1667 ldap_err2string(rc),
1668 ld_error ? ld_error : "unknown"));
1669 SAFE_FREE(ld_error);
1671 if (ld_errno == LDAP_SERVER_DOWN) {
1672 ldap_unbind(ldap_state->ldap_struct);
1673 ldap_state->ldap_struct = NULL;
1678 TALLOC_FREE(utf8_dn);
1682 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1683 LDAP_CONST char *reqoid, struct berval *reqdata,
1684 LDAPControl **serverctrls, LDAPControl **clientctrls,
1685 char **retoidp, struct berval **retdatap)
1687 int rc = LDAP_SERVER_DOWN;
1689 time_t endtime = time_mono(NULL)+lp_ldap_timeout();
1694 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1695 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1696 reqdata, serverctrls,
1697 clientctrls, retoidp, retdatap);
1698 if (rc != LDAP_SUCCESS) {
1699 char *ld_error = NULL;
1702 ldap_get_option(ldap_state->ldap_struct,
1703 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1705 ldap_get_option(ldap_state->ldap_struct,
1706 LDAP_OPT_ERROR_STRING, &ld_error);
1707 DEBUG(10, ("Extended operation failed with error: "
1708 "%d (%s) (%s)\n", ld_errno,
1709 ldap_err2string(rc),
1710 ld_error ? ld_error : "unknown"));
1711 SAFE_FREE(ld_error);
1713 if (ld_errno == LDAP_SERVER_DOWN) {
1714 ldap_unbind(ldap_state->ldap_struct);
1715 ldap_state->ldap_struct = NULL;
1723 /*******************************************************************
1724 run the search by name.
1725 ******************************************************************/
1726 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1727 const char *filter, const char **search_attr,
1728 LDAPMessage ** result)
1730 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1731 filter, search_attr, 0, result);
1734 static void smbldap_idle_fn(struct event_context *event_ctx,
1735 struct timed_event *te,
1736 struct timeval now_abs,
1739 struct smbldap_state *state = (struct smbldap_state *)private_data;
1741 TALLOC_FREE(state->idle_event);
1743 if (state->ldap_struct == NULL) {
1744 DEBUG(10,("ldap connection not connected...\n"));
1748 if ((state->last_use+SMBLDAP_IDLE_TIME) > time_mono(NULL)) {
1749 DEBUG(10,("ldap connection not idle...\n"));
1751 /* this needs to be made monotonic clock aware inside tevent: */
1752 state->idle_event = event_add_timed(
1754 timeval_add(&now_abs, SMBLDAP_IDLE_TIME, 0),
1760 DEBUG(7,("ldap connection idle...closing connection\n"));
1761 smbldap_close(state);
1764 /**********************************************************************
1766 *********************************************************************/
1768 void smbldap_free_struct(struct smbldap_state **ldap_state)
1770 smbldap_close(*ldap_state);
1772 if ((*ldap_state)->bind_secret) {
1773 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1776 SAFE_FREE((*ldap_state)->bind_dn);
1777 SAFE_FREE((*ldap_state)->bind_secret);
1779 TALLOC_FREE((*ldap_state)->idle_event);
1783 /* No need to free any further, as it is talloc()ed */
1787 /**********************************************************************
1788 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1789 *********************************************************************/
1791 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1792 const char *location,
1793 struct smbldap_state **smbldap_state)
1795 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1796 if (!*smbldap_state) {
1797 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1798 return NT_STATUS_NO_MEMORY;
1802 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1804 (*smbldap_state)->uri = "ldap://localhost";
1807 (*smbldap_state)->event_context = event_ctx;
1809 return NT_STATUS_OK;
1812 char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1815 char *utf8_dn, *unix_dn;
1816 size_t converted_size;
1818 utf8_dn = ldap_get_dn(ld, entry);
1820 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1823 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1824 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1825 "[%s]\n", utf8_dn));
1828 ldap_memfree(utf8_dn);
1832 /*******************************************************************
1833 Check if root-dse has a certain Control or Extension
1834 ********************************************************************/
1836 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1838 LDAPMessage *msg = NULL;
1839 LDAPMessage *entry = NULL;
1840 char **values = NULL;
1841 int rc, num_result, num_values, i;
1842 bool result = False;
1845 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1849 if (!strequal(attrs[0], "supportedExtension") &&
1850 !strequal(attrs[0], "supportedControl") &&
1851 !strequal(attrs[0], "namingContexts")) {
1852 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1856 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1857 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1859 if (rc != LDAP_SUCCESS) {
1860 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1864 num_result = ldap_count_entries(ld, msg);
1866 if (num_result != 1) {
1867 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1871 entry = ldap_first_entry(ld, msg);
1873 if (entry == NULL) {
1874 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1878 values = ldap_get_values(ld, entry, attrs[0]);
1880 if (values == NULL) {
1881 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1885 num_values = ldap_count_values(values);
1887 if (num_values == 0) {
1888 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1892 for (i=0; i<num_values; i++) {
1893 if (strcmp(values[i], value) == 0)
1900 ldap_value_free(values);
1908 /*******************************************************************
1909 Check if LDAP-Server supports a certain Control (OID in string format)
1910 ********************************************************************/
1912 bool smbldap_has_control(LDAP *ld, const char *control)
1914 const char *attrs[] = { "supportedControl", NULL };
1915 return smbldap_check_root_dse(ld, attrs, control);
1918 /*******************************************************************
1919 Check if LDAP-Server supports a certain Extension (OID in string format)
1920 ********************************************************************/
1922 bool smbldap_has_extension(LDAP *ld, const char *extension)
1924 const char *attrs[] = { "supportedExtension", NULL };
1925 return smbldap_check_root_dse(ld, attrs, extension);
1928 /*******************************************************************
1929 Check if LDAP-Server holds a given namingContext
1930 ********************************************************************/
1932 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1934 const char *attrs[] = { "namingContexts", NULL };
1935 return smbldap_check_root_dse(ld, attrs, naming_context);
1938 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1940 ldap_state->anonymous = anon;
1942 /* free any previously set credential */
1944 SAFE_FREE(ldap_state->bind_dn);
1945 if (ldap_state->bind_secret) {
1946 /* make sure secrets are zeroed out of memory */
1947 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1948 SAFE_FREE(ldap_state->bind_secret);
1952 ldap_state->bind_dn = SMB_STRDUP(dn);
1953 ldap_state->bind_secret = SMB_STRDUP(secret);