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
,
273 if ((values
= ldap_get_values (ldap_struct
, entry
, attribute
)) == NULL
) {
274 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute
));
279 if (convert_string(CH_UTF8
, CH_UNIX
,values
[0], -1, value
, max_len
, False
) == (size_t)-1) {
280 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
281 attribute
, values
[0]));
282 ldap_value_free(values
);
286 ldap_value_free(values
);
287 #ifdef DEBUG_PASSWORDS
288 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute
, value
));
293 char * smbldap_talloc_single_attribute(LDAP
*ldap_struct
, LDAPMessage
*entry
,
294 const char *attribute
,
299 size_t converted_size
;
301 if (attribute
== NULL
) {
305 values
= ldap_get_values(ldap_struct
, entry
, attribute
);
307 if (values
== NULL
) {
308 DEBUG(10, ("attribute %s does not exist\n", attribute
));
312 if (ldap_count_values(values
) != 1) {
313 DEBUG(10, ("attribute %s has %d values, expected only one\n",
314 attribute
, ldap_count_values(values
)));
315 ldap_value_free(values
);
319 if (!pull_utf8_talloc(mem_ctx
, &result
, values
[0], &converted_size
)) {
320 DEBUG(10, ("pull_utf8_talloc failed\n"));
321 ldap_value_free(values
);
325 ldap_value_free(values
);
327 #ifdef DEBUG_PASSWORDS
328 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
334 char * smbldap_talloc_first_attribute(LDAP
*ldap_struct
, LDAPMessage
*entry
,
335 const char *attribute
,
340 size_t converted_size
;
342 if (attribute
== NULL
) {
346 values
= ldap_get_values(ldap_struct
, entry
, attribute
);
348 if (values
== NULL
) {
349 DEBUG(10, ("attribute %s does not exist\n", attribute
));
353 if (!pull_utf8_talloc(mem_ctx
, &result
, values
[0], &converted_size
)) {
354 DEBUG(10, ("pull_utf8_talloc failed\n"));
355 ldap_value_free(values
);
359 ldap_value_free(values
);
361 #ifdef DEBUG_PASSWORDS
362 DEBUG (100, ("smbldap_get_first_attribute: [%s] = [%s]\n",
368 char * smbldap_talloc_smallest_attribute(LDAP
*ldap_struct
, LDAPMessage
*entry
,
369 const char *attribute
,
374 size_t converted_size
;
377 if (attribute
== NULL
) {
381 values
= ldap_get_values(ldap_struct
, entry
, attribute
);
383 if (values
== NULL
) {
384 DEBUG(10, ("attribute %s does not exist\n", attribute
));
388 if (!pull_utf8_talloc(mem_ctx
, &result
, values
[0], &converted_size
)) {
389 DEBUG(10, ("pull_utf8_talloc failed\n"));
390 ldap_value_free(values
);
394 num_values
= ldap_count_values(values
);
396 for (i
=1; i
<num_values
; i
++) {
399 if (!pull_utf8_talloc(mem_ctx
, &tmp
, values
[i
],
401 DEBUG(10, ("pull_utf8_talloc failed\n"));
403 ldap_value_free(values
);
407 if (StrCaseCmp(tmp
, result
) < 0) {
415 ldap_value_free(values
);
417 #ifdef DEBUG_PASSWORDS
418 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
424 bool smbldap_talloc_single_blob(TALLOC_CTX
*mem_ctx
, LDAP
*ld
,
425 LDAPMessage
*msg
, const char *attrib
,
428 struct berval
**values
;
430 values
= ldap_get_values_len(ld
, msg
, attrib
);
435 if (ldap_count_values_len(values
) != 1) {
436 DEBUG(10, ("Expected one value for %s, got %d\n", attrib
,
437 ldap_count_values_len(values
)));
441 *blob
= data_blob_talloc(mem_ctx
, values
[0]->bv_val
,
443 ldap_value_free_len(values
);
445 return (blob
->data
!= NULL
);
448 bool smbldap_pull_sid(LDAP
*ld
, LDAPMessage
*msg
, const char *attrib
,
454 if (!smbldap_talloc_single_blob(talloc_tos(), ld
, msg
, attrib
,
458 ret
= sid_parse((char *)blob
.data
, blob
.length
, sid
);
459 TALLOC_FREE(blob
.data
);
463 static int ldapmsg_destructor(LDAPMessage
**result
) {
464 ldap_msgfree(*result
);
468 void talloc_autofree_ldapmsg(TALLOC_CTX
*mem_ctx
, LDAPMessage
*result
)
470 LDAPMessage
**handle
;
472 if (result
== NULL
) {
476 handle
= TALLOC_P(mem_ctx
, LDAPMessage
*);
477 SMB_ASSERT(handle
!= NULL
);
480 talloc_set_destructor(handle
, ldapmsg_destructor
);
483 static int ldapmod_destructor(LDAPMod
***mod
) {
484 ldap_mods_free(*mod
, True
);
488 void talloc_autofree_ldapmod(TALLOC_CTX
*mem_ctx
, LDAPMod
**mod
)
496 handle
= TALLOC_P(mem_ctx
, LDAPMod
**);
497 SMB_ASSERT(handle
!= NULL
);
500 talloc_set_destructor(handle
, ldapmod_destructor
);
503 /************************************************************************
504 Routine to manage the LDAPMod structure array
505 manage memory used by the array, by each struct, and values
506 ***********************************************************************/
508 void smbldap_set_mod (LDAPMod
*** modlist
, int modop
, const char *attribute
, const char *value
)
516 /* sanity checks on the mod values */
518 if (attribute
== NULL
|| *attribute
== '\0') {
522 #if 0 /* commented out after discussion with abartlet. Do not reenable.
523 left here so other do not re-add similar code --jerry */
524 if (value
== NULL
|| *value
== '\0')
529 mods
= SMB_MALLOC_P(LDAPMod
*);
531 smb_panic("smbldap_set_mod: out of memory!");
537 for (i
= 0; mods
[i
] != NULL
; ++i
) {
538 if (mods
[i
]->mod_op
== modop
&& strequal(mods
[i
]->mod_type
, attribute
))
542 if (mods
[i
] == NULL
) {
543 mods
= SMB_REALLOC_ARRAY (mods
, LDAPMod
*, i
+ 2);
545 smb_panic("smbldap_set_mod: out of memory!");
548 mods
[i
] = SMB_MALLOC_P(LDAPMod
);
549 if (mods
[i
] == NULL
) {
550 smb_panic("smbldap_set_mod: out of memory!");
553 mods
[i
]->mod_op
= modop
;
554 mods
[i
]->mod_values
= NULL
;
555 mods
[i
]->mod_type
= SMB_STRDUP(attribute
);
560 char *utf8_value
= NULL
;
561 size_t converted_size
;
564 if (mods
[i
]->mod_values
!= NULL
) {
565 for (; mods
[i
]->mod_values
[j
] != NULL
; j
++);
567 mods
[i
]->mod_values
= SMB_REALLOC_ARRAY(mods
[i
]->mod_values
, char *, j
+ 2);
569 if (mods
[i
]->mod_values
== NULL
) {
570 smb_panic("smbldap_set_mod: out of memory!");
574 if (!push_utf8_talloc(talloc_tos(), &utf8_value
, value
, &converted_size
)) {
575 smb_panic("smbldap_set_mod: String conversion failure!");
579 mods
[i
]->mod_values
[j
] = SMB_STRDUP(utf8_value
);
580 TALLOC_FREE(utf8_value
);
581 SMB_ASSERT(mods
[i
]->mod_values
[j
] != NULL
);
583 mods
[i
]->mod_values
[j
+ 1] = NULL
;
588 /**********************************************************************
589 Set attribute to newval in LDAP, regardless of what value the
590 attribute had in LDAP before.
591 *********************************************************************/
593 void smbldap_make_mod(LDAP
*ldap_struct
, LDAPMessage
*existing
,
595 const char *attribute
, const char *newval
)
597 char oldval
[2048]; /* current largest allowed value is mungeddial */
600 if (attribute
== NULL
) {
601 /* This can actually happen for ldapsam_compat where we for
602 * example don't have a password history */
606 if (existing
!= NULL
) {
607 existed
= smbldap_get_single_attribute(ldap_struct
, existing
, attribute
, oldval
, sizeof(oldval
));
613 /* all of our string attributes are case insensitive */
615 if (existed
&& newval
&& (StrCaseCmp(oldval
, newval
) == 0)) {
617 /* Believe it or not, but LDAP will deny a delete and
618 an add at the same time if the values are the
620 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute
));
625 /* There has been no value before, so don't delete it.
626 * Here's a possible race: We might end up with
627 * duplicate attributes */
628 /* By deleting exactly the value we found in the entry this
629 * should be race-free in the sense that the LDAP-Server will
630 * deny the complete operation if somebody changed the
631 * attribute behind our back. */
632 /* This will also allow modifying single valued attributes
633 * in Novell NDS. In NDS you have to first remove attribute and then
634 * you could add new value */
636 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute
, oldval
));
637 smbldap_set_mod(mods
, LDAP_MOD_DELETE
, attribute
, oldval
);
640 /* Regardless of the real operation (add or modify)
641 we add the new value here. We rely on deleting
642 the old value, should it exist. */
644 if ((newval
!= NULL
) && (strlen(newval
) > 0)) {
645 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute
, newval
));
646 smbldap_set_mod(mods
, LDAP_MOD_ADD
, attribute
, newval
);
650 /**********************************************************************
651 Some varients of the LDAP rebind code do not pass in the third 'arg'
652 pointer to a void*, so we try and work around it by assuming that the
653 value of the 'LDAP *' pointer is the same as the one we had passed in
654 **********************************************************************/
656 struct smbldap_state_lookup
{
658 struct smbldap_state
*smbldap_state
;
659 struct smbldap_state_lookup
*prev
, *next
;
662 static struct smbldap_state_lookup
*smbldap_state_lookup_list
;
664 static struct smbldap_state
*smbldap_find_state(LDAP
*ld
)
666 struct smbldap_state_lookup
*t
;
668 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
670 return t
->smbldap_state
;
676 static void smbldap_delete_state(struct smbldap_state
*smbldap_state
)
678 struct smbldap_state_lookup
*t
;
680 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
681 if (t
->smbldap_state
== smbldap_state
) {
682 DLIST_REMOVE(smbldap_state_lookup_list
, t
);
689 static void smbldap_store_state(LDAP
*ld
, struct smbldap_state
*smbldap_state
)
691 struct smbldap_state
*tmp_ldap_state
;
692 struct smbldap_state_lookup
*t
;
694 if ((tmp_ldap_state
= smbldap_find_state(ld
))) {
695 SMB_ASSERT(tmp_ldap_state
== smbldap_state
);
699 t
= SMB_XMALLOC_P(struct smbldap_state_lookup
);
702 DLIST_ADD_END(smbldap_state_lookup_list
, t
, struct smbldap_state_lookup
*);
704 t
->smbldap_state
= smbldap_state
;
707 /********************************************************************
708 start TLS on an existing LDAP connection
709 *******************************************************************/
711 int smb_ldap_start_tls(LDAP
*ldap_struct
, int version
)
713 #ifdef LDAP_OPT_X_TLS
717 if (lp_ldap_ssl() != LDAP_SSL_START_TLS
) {
721 #ifdef LDAP_OPT_X_TLS
722 if (version
!= LDAP_VERSION3
) {
723 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
724 return LDAP_OPERATIONS_ERROR
;
727 if ((rc
= ldap_start_tls_s (ldap_struct
, NULL
, NULL
)) != LDAP_SUCCESS
) {
728 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
729 ldap_err2string(rc
)));
733 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
736 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
737 return LDAP_OPERATIONS_ERROR
;
741 /********************************************************************
742 setup a connection to the LDAP server based on a uri
743 *******************************************************************/
745 static int smb_ldap_setup_conn(LDAP
**ldap_struct
, const char *uri
)
749 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri
));
751 #ifdef HAVE_LDAP_INITIALIZE
753 rc
= ldap_initialize(ldap_struct
, uri
);
755 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc
)));
759 if (lp_ldap_follow_referral() != Auto
) {
760 rc
= ldap_set_option(*ldap_struct
, LDAP_OPT_REFERRALS
,
761 lp_ldap_follow_referral() ? LDAP_OPT_ON
: LDAP_OPT_OFF
);
762 if (rc
!= LDAP_SUCCESS
)
763 DEBUG(0, ("Failed to set LDAP_OPT_REFERRALS: %s\n",
764 ldap_err2string(rc
)));
770 /* Parse the string manually */
776 SMB_ASSERT(sizeof(protocol
)>10 && sizeof(host
)>254);
779 /* skip leading "URL:" (if any) */
780 if ( strnequal( uri
, "URL:", 4 ) ) {
784 sscanf(uri
, "%10[^:]://%254[^:/]:%d", protocol
, host
, &port
);
787 if (strequal(protocol
, "ldap")) {
789 } else if (strequal(protocol
, "ldaps")) {
792 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol
));
796 if ((*ldap_struct
= ldap_init(host
, port
)) == NULL
) {
797 DEBUG(0, ("ldap_init failed !\n"));
798 return LDAP_OPERATIONS_ERROR
;
801 if (strequal(protocol
, "ldaps")) {
802 #ifdef LDAP_OPT_X_TLS
803 int tls
= LDAP_OPT_X_TLS_HARD
;
804 if (ldap_set_option (*ldap_struct
, LDAP_OPT_X_TLS
, &tls
) != LDAP_SUCCESS
)
806 DEBUG(0, ("Failed to setup a TLS session\n"));
809 DEBUG(3,("LDAPS option set...!\n"));
811 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
812 return LDAP_OPERATIONS_ERROR
;
813 #endif /* LDAP_OPT_X_TLS */
816 #endif /* HAVE_LDAP_INITIALIZE */
818 /* now set connection timeout */
819 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
821 int ct
= lp_ldap_connection_timeout()*1000;
822 rc
= ldap_set_option(*ldap_struct
, LDAP_X_OPT_CONNECT_TIMEOUT
, &ct
);
823 if (rc
!= LDAP_SUCCESS
) {
824 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
825 ct
, ldap_err2string(rc
)));
828 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
832 ct
.tv_sec
= lp_ldap_connection_timeout();
833 rc
= ldap_set_option(*ldap_struct
, LDAP_OPT_NETWORK_TIMEOUT
, &ct
);
834 if (rc
!= LDAP_SUCCESS
) {
835 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
836 (int)ct
.tv_sec
, ldap_err2string(rc
)));
844 /********************************************************************
845 try to upgrade to Version 3 LDAP if not already, in either case return current
847 *******************************************************************/
849 static int smb_ldap_upgrade_conn(LDAP
*ldap_struct
, int *new_version
)
854 /* assume the worst */
855 *new_version
= LDAP_VERSION2
;
857 rc
= ldap_get_option(ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
862 if (version
== LDAP_VERSION3
) {
863 *new_version
= LDAP_VERSION3
;
868 version
= LDAP_VERSION3
;
869 rc
= ldap_set_option (ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
874 *new_version
= LDAP_VERSION3
;
878 /*******************************************************************
879 open a connection to the ldap server (just until the bind)
880 ******************************************************************/
882 int smb_ldap_setup_full_conn(LDAP
**ldap_struct
, const char *uri
)
886 rc
= smb_ldap_setup_conn(ldap_struct
, uri
);
891 rc
= smb_ldap_upgrade_conn(*ldap_struct
, &version
);
896 rc
= smb_ldap_start_tls(*ldap_struct
, version
);
904 /*******************************************************************
905 open a connection to the ldap server.
906 ******************************************************************/
907 static int smbldap_open_connection (struct smbldap_state
*ldap_state
)
910 int rc
= LDAP_SUCCESS
;
913 LDAP
**ldap_struct
= &ldap_state
->ldap_struct
;
915 rc
= smb_ldap_setup_conn(ldap_struct
, ldap_state
->uri
);
920 /* Store the LDAP pointer in a lookup list */
922 smbldap_store_state(*ldap_struct
, ldap_state
);
924 /* Upgrade to LDAPv3 if possible */
926 rc
= smb_ldap_upgrade_conn(*ldap_struct
, &version
);
931 /* Start TLS if required */
933 rc
= smb_ldap_start_tls(*ldap_struct
, version
);
938 /* Set alias dereferencing method */
939 deref
= lp_ldap_deref();
941 if (ldap_set_option (*ldap_struct
, LDAP_OPT_DEREF
, &deref
) != LDAP_OPT_SUCCESS
) {
942 DEBUG(1,("smbldap_open_connection: Failed to set dereferencing method: %d\n", deref
));
944 DEBUG(5,("Set dereferencing method: %d\n", deref
));
948 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
952 /*******************************************************************
953 a rebind function for authenticated referrals
954 This version takes a void* that we can shove useful stuff in :-)
955 ******************************************************************/
956 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
958 static int rebindproc_with_state (LDAP
* ld
, char **whop
, char **credp
,
959 int *methodp
, int freeit
, void *arg
)
961 struct smbldap_state
*ldap_state
= arg
;
964 /** @TODO Should we be doing something to check what servers we rebind to?
965 Could we get a referral to a machine that we don't want to give our
966 username and password to? */
971 memset(*credp
, '\0', strlen(*credp
));
975 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
976 ldap_state
->bind_dn
?ldap_state
->bind_dn
:"[Anonymous bind]"));
978 if (ldap_state
->anonymous
) {
982 *whop
= SMB_STRDUP(ldap_state
->bind_dn
);
984 return LDAP_NO_MEMORY
;
986 *credp
= SMB_STRDUP(ldap_state
->bind_secret
);
989 return LDAP_NO_MEMORY
;
992 *methodp
= LDAP_AUTH_SIMPLE
;
995 clock_gettime_mono(&ts
);
996 ldap_state
->last_rebind
= convert_timespec_to_timeval(ts
);
1000 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1002 /*******************************************************************
1003 a rebind function for authenticated referrals
1004 This version takes a void* that we can shove useful stuff in :-)
1005 and actually does the connection.
1006 ******************************************************************/
1007 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1008 static int rebindproc_connect_with_state (LDAP
*ldap_struct
,
1009 LDAP_CONST
char *url
,
1011 ber_int_t msgid
, void *arg
)
1013 struct smbldap_state
*ldap_state
=
1014 (struct smbldap_state
*)arg
;
1019 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
1020 url
, ldap_state
->bind_dn
?ldap_state
->bind_dn
:"[Anonymous bind]"));
1022 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
1023 * itself) before rebinding to another LDAP server to avoid to expose
1024 * our credentials. At least *try* to secure the connection - Guenther */
1026 smb_ldap_upgrade_conn(ldap_struct
, &version
);
1027 smb_ldap_start_tls(ldap_struct
, version
);
1029 /** @TODO Should we be doing something to check what servers we rebind to?
1030 Could we get a referral to a machine that we don't want to give our
1031 username and password to? */
1033 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
1035 /* only set the last rebind timestamp when we did rebind after a
1036 * non-read LDAP operation. That way we avoid the replication sleep
1037 * after a simple redirected search operation - Guenther */
1041 case LDAP_REQ_MODIFY
:
1043 case LDAP_REQ_DELETE
:
1044 case LDAP_REQ_MODDN
:
1045 case LDAP_REQ_EXTENDED
:
1046 DEBUG(10,("rebindproc_connect_with_state: "
1047 "setting last_rebind timestamp "
1048 "(req: 0x%02x)\n", (unsigned int)request
));
1049 clock_gettime_mono(&ts
);
1050 ldap_state
->last_rebind
= convert_timespec_to_timeval(ts
);
1053 ZERO_STRUCT(ldap_state
->last_rebind
);
1059 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1061 /*******************************************************************
1062 Add a rebind function for authenticated referrals
1063 ******************************************************************/
1064 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1066 # if LDAP_SET_REBIND_PROC_ARGS == 2
1067 static int rebindproc (LDAP
*ldap_struct
, char **whop
, char **credp
,
1068 int *method
, int freeit
)
1070 struct smbldap_state
*ldap_state
= smbldap_find_state(ldap_struct
);
1072 return rebindproc_with_state(ldap_struct
, whop
, credp
,
1073 method
, freeit
, ldap_state
);
1075 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1076 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1078 /*******************************************************************
1079 a rebind function for authenticated referrals
1080 this also does the connection, but no void*.
1081 ******************************************************************/
1082 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1083 # if LDAP_SET_REBIND_PROC_ARGS == 2
1084 static int rebindproc_connect (LDAP
* ld
, LDAP_CONST
char *url
, int request
,
1087 struct smbldap_state
*ldap_state
= smbldap_find_state(ld
);
1089 return rebindproc_connect_with_state(ld
, url
, (ber_tag_t
)request
, msgid
,
1092 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1093 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1095 /*******************************************************************
1096 connect to the ldap server under system privilege.
1097 ******************************************************************/
1098 static int smbldap_connect_system(struct smbldap_state
*ldap_state
, LDAP
* ldap_struct
)
1103 if (!ldap_state
->anonymous
&& !ldap_state
->bind_dn
) {
1104 char *bind_dn
= NULL
;
1105 char *bind_secret
= NULL
;
1107 /* get the default dn and password only if they are not set already */
1108 if (!fetch_ldap_pw(&bind_dn
, &bind_secret
)) {
1109 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
1110 return LDAP_INVALID_CREDENTIALS
;
1112 smbldap_set_creds(ldap_state
, false, bind_dn
, bind_secret
);
1114 memset(bind_secret
, '\0', strlen(bind_secret
));
1115 SAFE_FREE(bind_secret
);
1118 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
1119 (OpenLDAP) doesnt' seem to support it */
1121 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
1122 ldap_state
->uri
, ldap_state
->bind_dn
));
1124 #ifdef HAVE_LDAP_SET_REBIND_PROC
1125 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1126 # if LDAP_SET_REBIND_PROC_ARGS == 2
1127 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect
);
1129 # if LDAP_SET_REBIND_PROC_ARGS == 3
1130 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect_with_state
, (void *)ldap_state
);
1132 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1133 # if LDAP_SET_REBIND_PROC_ARGS == 2
1134 ldap_set_rebind_proc(ldap_struct
, &rebindproc
);
1136 # if LDAP_SET_REBIND_PROC_ARGS == 3
1137 ldap_set_rebind_proc(ldap_struct
, &rebindproc_with_state
, (void *)ldap_state
);
1139 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1142 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
1144 if (rc
!= LDAP_SUCCESS
) {
1145 char *ld_error
= NULL
;
1146 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_ERROR_STRING
,
1148 DEBUG(ldap_state
->num_failures
? 2 : 0,
1149 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
1151 ldap_state
->bind_dn
? ldap_state
->bind_dn
: "[Anonymous bind]",
1152 ldap_err2string(rc
),
1153 ld_error
? ld_error
: "(unknown)"));
1154 SAFE_FREE(ld_error
);
1155 ldap_state
->num_failures
++;
1159 ldap_state
->num_failures
= 0;
1160 ldap_state
->paged_results
= False
;
1162 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
1164 if (smbldap_has_control(ldap_state
->ldap_struct
, ADS_PAGE_CTL_OID
) && version
== 3) {
1165 ldap_state
->paged_results
= True
;
1168 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1169 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1170 ldap_state
->paged_results
? "does" : "does not"));
1174 static void smbldap_idle_fn(struct event_context
*event_ctx
,
1175 struct timed_event
*te
,
1176 struct timeval now_abs
,
1177 void *private_data
);
1179 /**********************************************************************
1180 Connect to LDAP server (called before every ldap operation)
1181 *********************************************************************/
1182 static int smbldap_open(struct smbldap_state
*ldap_state
)
1185 bool reopen
= False
;
1186 SMB_ASSERT(ldap_state
);
1188 if ((ldap_state
->ldap_struct
!= NULL
) && ((ldap_state
->last_ping
+ SMBLDAP_DONT_PING_TIME
) < time_mono(NULL
))) {
1190 #ifdef HAVE_UNIXSOCKET
1191 struct sockaddr_un addr
;
1193 struct sockaddr addr
;
1195 socklen_t len
= sizeof(addr
);
1198 opt_rc
= ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_DESC
, &sd
);
1199 if (opt_rc
== 0 && (getpeername(sd
, (struct sockaddr
*) &addr
, &len
)) < 0 )
1202 #ifdef HAVE_UNIXSOCKET
1203 if (opt_rc
== 0 && addr
.sun_family
== AF_UNIX
)
1207 /* the other end has died. reopen. */
1208 ldap_unbind(ldap_state
->ldap_struct
);
1209 ldap_state
->ldap_struct
= NULL
;
1210 ldap_state
->last_ping
= (time_t)0;
1212 ldap_state
->last_ping
= time_mono(NULL
);
1216 if (ldap_state
->ldap_struct
!= NULL
) {
1217 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1218 return LDAP_SUCCESS
;
1221 if ((rc
= smbldap_open_connection(ldap_state
))) {
1225 if ((rc
= smbldap_connect_system(ldap_state
, ldap_state
->ldap_struct
))) {
1226 ldap_unbind(ldap_state
->ldap_struct
);
1227 ldap_state
->ldap_struct
= NULL
;
1232 ldap_state
->last_ping
= time_mono(NULL
);
1233 ldap_state
->pid
= sys_getpid();
1235 TALLOC_FREE(ldap_state
->idle_event
);
1237 if (ldap_state
->event_context
!= NULL
) {
1238 ldap_state
->idle_event
= event_add_timed(
1239 ldap_state
->event_context
, NULL
,
1240 timeval_current_ofs(SMBLDAP_IDLE_TIME
, 0),
1241 smbldap_idle_fn
, ldap_state
);
1244 DEBUG(4,("The LDAP server is successfully connected\n"));
1246 return LDAP_SUCCESS
;
1249 /**********************************************************************
1250 Disconnect from LDAP server
1251 *********************************************************************/
1252 static NTSTATUS
smbldap_close(struct smbldap_state
*ldap_state
)
1255 return NT_STATUS_INVALID_PARAMETER
;
1257 if (ldap_state
->ldap_struct
!= NULL
) {
1258 ldap_unbind(ldap_state
->ldap_struct
);
1259 ldap_state
->ldap_struct
= NULL
;
1262 smbldap_delete_state(ldap_state
);
1264 DEBUG(5,("The connection to the LDAP server was closed\n"));
1265 /* maybe free the results here --metze */
1267 return NT_STATUS_OK
;
1270 static bool got_alarm
;
1272 static void (*old_handler
)(int);
1274 static void gotalarm_sig(int dummy
)
1279 static int another_ldap_try(struct smbldap_state
*ldap_state
, int *rc
,
1280 int *attempts
, time_t endtime
)
1282 time_t now
= time_mono(NULL
);
1283 int open_rc
= LDAP_SERVER_DOWN
;
1285 if (*rc
!= LDAP_SERVER_DOWN
)
1288 if (now
>= endtime
) {
1289 smbldap_close(ldap_state
);
1294 if (*attempts
== 0) {
1296 old_handler
= CatchSignal(SIGALRM
, gotalarm_sig
);
1297 alarm(endtime
- now
);
1299 if (ldap_state
->pid
!= sys_getpid())
1300 smbldap_close(ldap_state
);
1310 open_rc
= smbldap_open(ldap_state
);
1312 if (open_rc
== LDAP_SUCCESS
) {
1313 ldap_state
->last_use
= now
;
1317 if (open_rc
== LDAP_INSUFFICIENT_ACCESS
) {
1318 /* The fact that we are non-root or any other
1319 * access-denied condition will not change in the next
1320 * round of trying */
1330 if (open_rc
!= LDAP_SUCCESS
) {
1331 DEBUG(1, ("Connection to LDAP server failed for the "
1332 "%d try!\n", *attempts
));
1337 CatchSignal(SIGALRM
, old_handler
);
1339 ldap_state
->last_use
= now
;
1343 /*********************************************************************
1344 ********************************************************************/
1346 static int smbldap_search_ext(struct smbldap_state
*ldap_state
,
1347 const char *base
, int scope
, const char *filter
,
1348 const char *attrs
[], int attrsonly
,
1349 LDAPControl
**sctrls
, LDAPControl
**cctrls
,
1350 int sizelimit
, LDAPMessage
**res
)
1352 int rc
= LDAP_SERVER_DOWN
;
1355 time_t endtime
= time_mono(NULL
)+lp_ldap_timeout();
1356 struct timeval timeout
;
1357 size_t converted_size
;
1359 SMB_ASSERT(ldap_state
);
1361 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1362 "scope => [%d]\n", base
, filter
, scope
));
1364 if (ldap_state
->last_rebind
.tv_sec
> 0) {
1365 struct timeval tval
;
1370 clock_gettime_mono(&ts
);
1371 tval
= convert_timespec_to_timeval(ts
);
1373 tdiff
= usec_time_diff(&tval
, &ldap_state
->last_rebind
);
1374 tdiff
/= 1000; /* Convert to milliseconds. */
1376 sleep_time
= lp_ldap_replication_sleep()-(int)tdiff
;
1377 sleep_time
= MIN(sleep_time
, MAX_LDAP_REPLICATION_SLEEP_TIME
);
1379 if (sleep_time
> 0) {
1380 /* we wait for the LDAP replication */
1381 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1382 "for LDAP replication.\n",sleep_time
));
1383 smb_msleep(sleep_time
);
1384 DEBUG(5,("smbldap_search_ext: go on!\n"));
1386 ZERO_STRUCT(ldap_state
->last_rebind
);
1389 if (!push_utf8_talloc(talloc_tos(), &utf8_filter
, filter
, &converted_size
)) {
1390 return LDAP_NO_MEMORY
;
1393 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1394 timeout
.tv_sec
= lp_ldap_timeout();
1395 timeout
.tv_usec
= 0;
1397 /* Setup alarm timeout.... Do we need both of these ? JRA.
1398 * Yes, I think we do need both of these. The server timeout only
1399 * covers the case where the server's operation takes too long. It
1400 * does not cover the case where the request hangs on its way to the
1401 * server. The server side timeout is not strictly necessary, it's
1402 * just a bit more kind to the server. VL. */
1405 CatchSignal(SIGALRM
, gotalarm_sig
);
1406 alarm(lp_ldap_timeout());
1407 /* End setup timeout. */
1409 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1410 rc
= ldap_search_ext_s(ldap_state
->ldap_struct
, base
, scope
,
1412 CONST_DISCARD(char **, attrs
),
1413 attrsonly
, sctrls
, cctrls
, &timeout
,
1415 if (rc
!= LDAP_SUCCESS
) {
1416 char *ld_error
= NULL
;
1419 ldap_get_option(ldap_state
->ldap_struct
,
1420 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1422 ldap_get_option(ldap_state
->ldap_struct
,
1423 LDAP_OPT_ERROR_STRING
, &ld_error
);
1424 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1425 "(%s)\n", base
, ld_errno
,
1426 ldap_err2string(rc
),
1427 ld_error
? ld_error
: "unknown"));
1428 SAFE_FREE(ld_error
);
1430 if (ld_errno
== LDAP_SERVER_DOWN
) {
1431 ldap_unbind(ldap_state
->ldap_struct
);
1432 ldap_state
->ldap_struct
= NULL
;
1437 TALLOC_FREE(utf8_filter
);
1439 /* Teardown timeout. */
1440 CatchSignal(SIGALRM
, SIG_IGN
);
1444 return LDAP_TIMELIMIT_EXCEEDED
;
1449 int smbldap_search(struct smbldap_state
*ldap_state
,
1450 const char *base
, int scope
, const char *filter
,
1451 const char *attrs
[], int attrsonly
,
1454 return smbldap_search_ext(ldap_state
, base
, scope
, filter
, attrs
,
1455 attrsonly
, NULL
, NULL
, LDAP_NO_LIMIT
, res
);
1458 int smbldap_search_paged(struct smbldap_state
*ldap_state
,
1459 const char *base
, int scope
, const char *filter
,
1460 const char **attrs
, int attrsonly
, int pagesize
,
1461 LDAPMessage
**res
, void **cookie
)
1464 LDAPControl
**rcontrols
;
1465 LDAPControl
*controls
[2] = { NULL
, NULL
};
1466 BerElement
*cookie_be
= NULL
;
1467 struct berval
*cookie_bv
= NULL
;
1469 bool critical
= True
;
1473 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1474 "scope => [%d], pagesize => [%d]\n",
1475 base
, filter
, scope
, pagesize
));
1477 cookie_be
= ber_alloc_t(LBER_USE_DER
);
1478 if (cookie_be
== NULL
) {
1479 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1481 return LDAP_NO_MEMORY
;
1484 /* construct cookie */
1485 if (*cookie
!= NULL
) {
1486 ber_printf(cookie_be
, "{iO}", (ber_int_t
) pagesize
, *cookie
);
1487 ber_bvfree((struct berval
*)*cookie
); /* don't need it from last time */
1490 ber_printf(cookie_be
, "{io}", (ber_int_t
) pagesize
, "", 0);
1492 ber_flatten(cookie_be
, &cookie_bv
);
1494 pr
.ldctl_oid
= CONST_DISCARD(char *, ADS_PAGE_CTL_OID
);
1495 pr
.ldctl_iscritical
= (char) critical
;
1496 pr
.ldctl_value
.bv_len
= cookie_bv
->bv_len
;
1497 pr
.ldctl_value
.bv_val
= cookie_bv
->bv_val
;
1502 rc
= smbldap_search_ext(ldap_state
, base
, scope
, filter
, attrs
,
1503 0, controls
, NULL
, LDAP_NO_LIMIT
, res
);
1505 ber_free(cookie_be
, 1);
1506 ber_bvfree(cookie_bv
);
1509 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1510 "failed with [%s]\n", filter
, ldap_err2string(rc
)));
1514 DEBUG(3,("smbldap_search_paged: search was successful\n"));
1516 rc
= ldap_parse_result(ldap_state
->ldap_struct
, *res
, NULL
, NULL
,
1517 NULL
, NULL
, &rcontrols
, 0);
1519 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1520 "with [%s]\n", ldap_err2string(rc
)));
1524 if (rcontrols
== NULL
)
1527 for (i
=0; rcontrols
[i
]; i
++) {
1529 if (strcmp(ADS_PAGE_CTL_OID
, rcontrols
[i
]->ldctl_oid
) != 0)
1532 cookie_be
= ber_init(&rcontrols
[i
]->ldctl_value
);
1533 ber_scanf(cookie_be
,"{iO}", &tmp
, &cookie_bv
);
1534 /* the berval is the cookie, but must be freed when it is all
1536 if (cookie_bv
->bv_len
)
1537 *cookie
=ber_bvdup(cookie_bv
);
1540 ber_bvfree(cookie_bv
);
1541 ber_free(cookie_be
, 1);
1544 ldap_controls_free(rcontrols
);
1549 int smbldap_modify(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
1551 int rc
= LDAP_SERVER_DOWN
;
1554 time_t endtime
= time_mono(NULL
)+lp_ldap_timeout();
1555 size_t converted_size
;
1557 SMB_ASSERT(ldap_state
);
1559 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn
));
1561 if (!push_utf8_talloc(talloc_tos(), &utf8_dn
, dn
, &converted_size
)) {
1562 return LDAP_NO_MEMORY
;
1565 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1566 rc
= ldap_modify_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
1567 if (rc
!= LDAP_SUCCESS
) {
1568 char *ld_error
= NULL
;
1571 ldap_get_option(ldap_state
->ldap_struct
,
1572 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1574 ldap_get_option(ldap_state
->ldap_struct
,
1575 LDAP_OPT_ERROR_STRING
, &ld_error
);
1576 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1577 "(%s)\n", dn
, ld_errno
,
1578 ldap_err2string(rc
),
1579 ld_error
? ld_error
: "unknown"));
1580 SAFE_FREE(ld_error
);
1582 if (ld_errno
== LDAP_SERVER_DOWN
) {
1583 ldap_unbind(ldap_state
->ldap_struct
);
1584 ldap_state
->ldap_struct
= NULL
;
1589 TALLOC_FREE(utf8_dn
);
1593 int smbldap_add(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
1595 int rc
= LDAP_SERVER_DOWN
;
1598 time_t endtime
= time_mono(NULL
)+lp_ldap_timeout();
1599 size_t converted_size
;
1601 SMB_ASSERT(ldap_state
);
1603 DEBUG(5,("smbldap_add: dn => [%s]\n", dn
));
1605 if (!push_utf8_talloc(talloc_tos(), &utf8_dn
, dn
, &converted_size
)) {
1606 return LDAP_NO_MEMORY
;
1609 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1610 rc
= ldap_add_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
1611 if (rc
!= LDAP_SUCCESS
) {
1612 char *ld_error
= NULL
;
1615 ldap_get_option(ldap_state
->ldap_struct
,
1616 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1618 ldap_get_option(ldap_state
->ldap_struct
,
1619 LDAP_OPT_ERROR_STRING
, &ld_error
);
1620 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1621 "(%s)\n", dn
, ld_errno
,
1622 ldap_err2string(rc
),
1623 ld_error
? ld_error
: "unknown"));
1624 SAFE_FREE(ld_error
);
1626 if (ld_errno
== LDAP_SERVER_DOWN
) {
1627 ldap_unbind(ldap_state
->ldap_struct
);
1628 ldap_state
->ldap_struct
= NULL
;
1633 TALLOC_FREE(utf8_dn
);
1637 int smbldap_delete(struct smbldap_state
*ldap_state
, const char *dn
)
1639 int rc
= LDAP_SERVER_DOWN
;
1642 time_t endtime
= time_mono(NULL
)+lp_ldap_timeout();
1643 size_t converted_size
;
1645 SMB_ASSERT(ldap_state
);
1647 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn
));
1649 if (!push_utf8_talloc(talloc_tos(), &utf8_dn
, dn
, &converted_size
)) {
1650 return LDAP_NO_MEMORY
;
1653 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1654 rc
= ldap_delete_s(ldap_state
->ldap_struct
, utf8_dn
);
1655 if (rc
!= LDAP_SUCCESS
) {
1656 char *ld_error
= NULL
;
1659 ldap_get_option(ldap_state
->ldap_struct
,
1660 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1662 ldap_get_option(ldap_state
->ldap_struct
,
1663 LDAP_OPT_ERROR_STRING
, &ld_error
);
1664 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1665 "(%s)\n", dn
, ld_errno
,
1666 ldap_err2string(rc
),
1667 ld_error
? ld_error
: "unknown"));
1668 SAFE_FREE(ld_error
);
1670 if (ld_errno
== LDAP_SERVER_DOWN
) {
1671 ldap_unbind(ldap_state
->ldap_struct
);
1672 ldap_state
->ldap_struct
= NULL
;
1677 TALLOC_FREE(utf8_dn
);
1681 int smbldap_extended_operation(struct smbldap_state
*ldap_state
,
1682 LDAP_CONST
char *reqoid
, struct berval
*reqdata
,
1683 LDAPControl
**serverctrls
, LDAPControl
**clientctrls
,
1684 char **retoidp
, struct berval
**retdatap
)
1686 int rc
= LDAP_SERVER_DOWN
;
1688 time_t endtime
= time_mono(NULL
)+lp_ldap_timeout();
1693 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1694 rc
= ldap_extended_operation_s(ldap_state
->ldap_struct
, reqoid
,
1695 reqdata
, serverctrls
,
1696 clientctrls
, retoidp
, retdatap
);
1697 if (rc
!= LDAP_SUCCESS
) {
1698 char *ld_error
= NULL
;
1701 ldap_get_option(ldap_state
->ldap_struct
,
1702 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1704 ldap_get_option(ldap_state
->ldap_struct
,
1705 LDAP_OPT_ERROR_STRING
, &ld_error
);
1706 DEBUG(10, ("Extended operation failed with error: "
1707 "%d (%s) (%s)\n", ld_errno
,
1708 ldap_err2string(rc
),
1709 ld_error
? ld_error
: "unknown"));
1710 SAFE_FREE(ld_error
);
1712 if (ld_errno
== LDAP_SERVER_DOWN
) {
1713 ldap_unbind(ldap_state
->ldap_struct
);
1714 ldap_state
->ldap_struct
= NULL
;
1722 /*******************************************************************
1723 run the search by name.
1724 ******************************************************************/
1725 int smbldap_search_suffix (struct smbldap_state
*ldap_state
,
1726 const char *filter
, const char **search_attr
,
1727 LDAPMessage
** result
)
1729 return smbldap_search(ldap_state
, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE
,
1730 filter
, search_attr
, 0, result
);
1733 static void smbldap_idle_fn(struct event_context
*event_ctx
,
1734 struct timed_event
*te
,
1735 struct timeval now_abs
,
1738 struct smbldap_state
*state
= (struct smbldap_state
*)private_data
;
1740 TALLOC_FREE(state
->idle_event
);
1742 if (state
->ldap_struct
== NULL
) {
1743 DEBUG(10,("ldap connection not connected...\n"));
1747 if ((state
->last_use
+SMBLDAP_IDLE_TIME
) > time_mono(NULL
)) {
1748 DEBUG(10,("ldap connection not idle...\n"));
1750 /* this needs to be made monotonic clock aware inside tevent: */
1751 state
->idle_event
= event_add_timed(
1753 timeval_add(&now_abs
, SMBLDAP_IDLE_TIME
, 0),
1759 DEBUG(7,("ldap connection idle...closing connection\n"));
1760 smbldap_close(state
);
1763 /**********************************************************************
1765 *********************************************************************/
1767 void smbldap_free_struct(struct smbldap_state
**ldap_state
)
1769 smbldap_close(*ldap_state
);
1771 if ((*ldap_state
)->bind_secret
) {
1772 memset((*ldap_state
)->bind_secret
, '\0', strlen((*ldap_state
)->bind_secret
));
1775 SAFE_FREE((*ldap_state
)->bind_dn
);
1776 SAFE_FREE((*ldap_state
)->bind_secret
);
1778 TALLOC_FREE((*ldap_state
)->idle_event
);
1782 /* No need to free any further, as it is talloc()ed */
1786 /**********************************************************************
1787 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1788 *********************************************************************/
1790 NTSTATUS
smbldap_init(TALLOC_CTX
*mem_ctx
, struct event_context
*event_ctx
,
1791 const char *location
,
1792 struct smbldap_state
**smbldap_state
)
1794 *smbldap_state
= TALLOC_ZERO_P(mem_ctx
, struct smbldap_state
);
1795 if (!*smbldap_state
) {
1796 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1797 return NT_STATUS_NO_MEMORY
;
1801 (*smbldap_state
)->uri
= talloc_strdup(mem_ctx
, location
);
1803 (*smbldap_state
)->uri
= "ldap://localhost";
1806 (*smbldap_state
)->event_context
= event_ctx
;
1808 return NT_STATUS_OK
;
1811 char *smbldap_talloc_dn(TALLOC_CTX
*mem_ctx
, LDAP
*ld
,
1814 char *utf8_dn
, *unix_dn
;
1815 size_t converted_size
;
1817 utf8_dn
= ldap_get_dn(ld
, entry
);
1819 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1822 if (!pull_utf8_talloc(mem_ctx
, &unix_dn
, utf8_dn
, &converted_size
)) {
1823 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1824 "[%s]\n", utf8_dn
));
1827 ldap_memfree(utf8_dn
);
1831 /*******************************************************************
1832 Check if root-dse has a certain Control or Extension
1833 ********************************************************************/
1835 static bool smbldap_check_root_dse(LDAP
*ld
, const char **attrs
, const char *value
)
1837 LDAPMessage
*msg
= NULL
;
1838 LDAPMessage
*entry
= NULL
;
1839 char **values
= NULL
;
1840 int rc
, num_result
, num_values
, i
;
1841 bool result
= False
;
1844 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1848 if (!strequal(attrs
[0], "supportedExtension") &&
1849 !strequal(attrs
[0], "supportedControl") &&
1850 !strequal(attrs
[0], "namingContexts")) {
1851 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs
[0]));
1855 rc
= ldap_search_s(ld
, "", LDAP_SCOPE_BASE
,
1856 "(objectclass=*)", CONST_DISCARD(char **, attrs
), 0 , &msg
);
1858 if (rc
!= LDAP_SUCCESS
) {
1859 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1863 num_result
= ldap_count_entries(ld
, msg
);
1865 if (num_result
!= 1) {
1866 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result
));
1870 entry
= ldap_first_entry(ld
, msg
);
1872 if (entry
== NULL
) {
1873 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1877 values
= ldap_get_values(ld
, entry
, attrs
[0]);
1879 if (values
== NULL
) {
1880 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs
[0]));
1884 num_values
= ldap_count_values(values
);
1886 if (num_values
== 0) {
1887 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs
[0]));
1891 for (i
=0; i
<num_values
; i
++) {
1892 if (strcmp(values
[i
], value
) == 0)
1899 ldap_value_free(values
);
1907 /*******************************************************************
1908 Check if LDAP-Server supports a certain Control (OID in string format)
1909 ********************************************************************/
1911 bool smbldap_has_control(LDAP
*ld
, const char *control
)
1913 const char *attrs
[] = { "supportedControl", NULL
};
1914 return smbldap_check_root_dse(ld
, attrs
, control
);
1917 /*******************************************************************
1918 Check if LDAP-Server supports a certain Extension (OID in string format)
1919 ********************************************************************/
1921 bool smbldap_has_extension(LDAP
*ld
, const char *extension
)
1923 const char *attrs
[] = { "supportedExtension", NULL
};
1924 return smbldap_check_root_dse(ld
, attrs
, extension
);
1927 /*******************************************************************
1928 Check if LDAP-Server holds a given namingContext
1929 ********************************************************************/
1931 bool smbldap_has_naming_context(LDAP
*ld
, const char *naming_context
)
1933 const char *attrs
[] = { "namingContexts", NULL
};
1934 return smbldap_check_root_dse(ld
, attrs
, naming_context
);
1937 bool smbldap_set_creds(struct smbldap_state
*ldap_state
, bool anon
, const char *dn
, const char *secret
)
1939 ldap_state
->anonymous
= anon
;
1941 /* free any previously set credential */
1943 SAFE_FREE(ldap_state
->bind_dn
);
1944 if (ldap_state
->bind_secret
) {
1945 /* make sure secrets are zeroed out of memory */
1946 memset(ldap_state
->bind_secret
, '\0', strlen(ldap_state
->bind_secret
));
1947 SAFE_FREE(ldap_state
->bind_secret
);
1951 ldap_state
->bind_dn
= SMB_STRDUP(dn
);
1952 ldap_state
->bind_secret
= SMB_STRDUP(secret
);