2 Unix SMB/CIFS implementation.
3 LDAP protocol helper functions for SAMBA
4 Copyright (C) Jean François Micouleau 1998
5 Copyright (C) Gerald Carter 2001-2003
6 Copyright (C) Shahms King 2001
7 Copyright (C) Andrew Bartlett 2002-2003
8 Copyright (C) Stefan (metze) Metzmacher 2002-2003
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #ifndef LDAP_OPT_SUCCESS
29 #define LDAP_OPT_SUCCESS 0
32 /* Try not to hit the up or down server forever */
34 #define SMBLDAP_DONT_PING_TIME 10 /* ping only all 10 seconds */
35 #define SMBLDAP_NUM_RETRIES 8 /* retry only 8 times */
37 #define SMBLDAP_IDLE_TIME 150 /* After 2.5 minutes disconnect */
40 /* attributes used by Samba 2.2 */
42 ATTRIB_MAP_ENTRY attrib_map_v22
[] = {
43 { LDAP_ATTR_UID
, "uid" },
44 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
45 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
46 { LDAP_ATTR_UNIX_HOME
, "homeDirectory" },
47 { LDAP_ATTR_PWD_LAST_SET
, "pwdLastSet" },
48 { LDAP_ATTR_PWD_CAN_CHANGE
, "pwdCanChange" },
49 { LDAP_ATTR_PWD_MUST_CHANGE
, "pwdMustChange" },
50 { LDAP_ATTR_LOGON_TIME
, "logonTime" },
51 { LDAP_ATTR_LOGOFF_TIME
, "logoffTime" },
52 { LDAP_ATTR_KICKOFF_TIME
, "kickoffTime" },
53 { LDAP_ATTR_CN
, "cn" },
54 { LDAP_ATTR_SN
, "sn" },
55 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
56 { LDAP_ATTR_HOME_PATH
, "smbHome" },
57 { LDAP_ATTR_HOME_DRIVE
, "homeDrive" },
58 { LDAP_ATTR_LOGON_SCRIPT
, "scriptPath" },
59 { LDAP_ATTR_PROFILE_PATH
, "profilePath" },
60 { LDAP_ATTR_DESC
, "description" },
61 { LDAP_ATTR_USER_WKS
, "userWorkstations"},
62 { LDAP_ATTR_USER_RID
, "rid" },
63 { LDAP_ATTR_PRIMARY_GROUP_RID
, "primaryGroupID"},
64 { LDAP_ATTR_LMPW
, "lmPassword" },
65 { LDAP_ATTR_NTPW
, "ntPassword" },
66 { LDAP_ATTR_DOMAIN
, "domain" },
67 { LDAP_ATTR_OBJCLASS
, "objectClass" },
68 { LDAP_ATTR_ACB_INFO
, "acctFlags" },
69 { LDAP_ATTR_MOD_TIMESTAMP
, "modifyTimestamp" },
70 { LDAP_ATTR_LIST_END
, NULL
}
73 ATTRIB_MAP_ENTRY attrib_map_to_delete_v22
[] = {
74 { LDAP_ATTR_PWD_LAST_SET
, "pwdLastSet" },
75 { LDAP_ATTR_PWD_CAN_CHANGE
, "pwdCanChange" },
76 { LDAP_ATTR_PWD_MUST_CHANGE
, "pwdMustChange" },
77 { LDAP_ATTR_LOGON_TIME
, "logonTime" },
78 { LDAP_ATTR_LOGOFF_TIME
, "logoffTime" },
79 { LDAP_ATTR_KICKOFF_TIME
, "kickoffTime" },
80 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
81 { LDAP_ATTR_HOME_PATH
, "smbHome" },
82 { LDAP_ATTR_HOME_DRIVE
, "homeDrives" },
83 { LDAP_ATTR_LOGON_SCRIPT
, "scriptPath" },
84 { LDAP_ATTR_PROFILE_PATH
, "profilePath" },
85 { LDAP_ATTR_USER_WKS
, "userWorkstations"},
86 { LDAP_ATTR_USER_RID
, "rid" },
87 { LDAP_ATTR_PRIMARY_GROUP_RID
, "primaryGroupID"},
88 { LDAP_ATTR_LMPW
, "lmPassword" },
89 { LDAP_ATTR_NTPW
, "ntPassword" },
90 { LDAP_ATTR_DOMAIN
, "domain" },
91 { LDAP_ATTR_ACB_INFO
, "acctFlags" },
92 { LDAP_ATTR_LIST_END
, NULL
}
95 /* attributes used by Samba 3.0's sambaSamAccount */
97 ATTRIB_MAP_ENTRY attrib_map_v30
[] = {
98 { LDAP_ATTR_UID
, "uid" },
99 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
100 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
101 { LDAP_ATTR_UNIX_HOME
, "homeDirectory" },
102 { LDAP_ATTR_PWD_LAST_SET
, "sambaPwdLastSet" },
103 { LDAP_ATTR_PWD_CAN_CHANGE
, "sambaPwdCanChange" },
104 { LDAP_ATTR_PWD_MUST_CHANGE
, "sambaPwdMustChange" },
105 { LDAP_ATTR_LOGON_TIME
, "sambaLogonTime" },
106 { LDAP_ATTR_LOGOFF_TIME
, "sambaLogoffTime" },
107 { LDAP_ATTR_KICKOFF_TIME
, "sambaKickoffTime" },
108 { LDAP_ATTR_CN
, "cn" },
109 { LDAP_ATTR_SN
, "sn" },
110 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
111 { LDAP_ATTR_HOME_DRIVE
, "sambaHomeDrive" },
112 { LDAP_ATTR_HOME_PATH
, "sambaHomePath" },
113 { LDAP_ATTR_LOGON_SCRIPT
, "sambaLogonScript" },
114 { LDAP_ATTR_PROFILE_PATH
, "sambaProfilePath" },
115 { LDAP_ATTR_DESC
, "description" },
116 { LDAP_ATTR_USER_WKS
, "sambaUserWorkstations" },
117 { LDAP_ATTR_USER_SID
, LDAP_ATTRIBUTE_SID
},
118 { LDAP_ATTR_PRIMARY_GROUP_SID
, "sambaPrimaryGroupSID" },
119 { LDAP_ATTR_LMPW
, "sambaLMPassword" },
120 { LDAP_ATTR_NTPW
, "sambaNTPassword" },
121 { LDAP_ATTR_DOMAIN
, "sambaDomainName" },
122 { LDAP_ATTR_OBJCLASS
, "objectClass" },
123 { LDAP_ATTR_ACB_INFO
, "sambaAcctFlags" },
124 { LDAP_ATTR_MUNGED_DIAL
, "sambaMungedDial" },
125 { LDAP_ATTR_BAD_PASSWORD_COUNT
, "sambaBadPasswordCount" },
126 { LDAP_ATTR_BAD_PASSWORD_TIME
, "sambaBadPasswordTime" },
127 { LDAP_ATTR_PWD_HISTORY
, "sambaPasswordHistory" },
128 { LDAP_ATTR_MOD_TIMESTAMP
, "modifyTimestamp" },
129 { LDAP_ATTR_LOGON_HOURS
, "sambaLogonHours" },
130 { LDAP_ATTR_LIST_END
, NULL
}
133 ATTRIB_MAP_ENTRY attrib_map_to_delete_v30
[] = {
134 { LDAP_ATTR_PWD_LAST_SET
, "sambaPwdLastSet" },
135 { LDAP_ATTR_PWD_CAN_CHANGE
, "sambaPwdCanChange" },
136 { LDAP_ATTR_PWD_MUST_CHANGE
, "sambaPwdMustChange" },
137 { LDAP_ATTR_LOGON_TIME
, "sambaLogonTime" },
138 { LDAP_ATTR_LOGOFF_TIME
, "sambaLogoffTime" },
139 { LDAP_ATTR_KICKOFF_TIME
, "sambaKickoffTime" },
140 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
141 { LDAP_ATTR_HOME_DRIVE
, "sambaHomeDrive" },
142 { LDAP_ATTR_HOME_PATH
, "sambaHomePath" },
143 { LDAP_ATTR_LOGON_SCRIPT
, "sambaLogonScript" },
144 { LDAP_ATTR_PROFILE_PATH
, "sambaProfilePath" },
145 { LDAP_ATTR_USER_WKS
, "sambaUserWorkstations" },
146 { LDAP_ATTR_USER_SID
, LDAP_ATTRIBUTE_SID
},
147 { LDAP_ATTR_PRIMARY_GROUP_SID
, "sambaPrimaryGroupSID" },
148 { LDAP_ATTR_LMPW
, "sambaLMPassword" },
149 { LDAP_ATTR_NTPW
, "sambaNTPassword" },
150 { LDAP_ATTR_DOMAIN
, "sambaDomainName" },
151 { LDAP_ATTR_ACB_INFO
, "sambaAcctFlags" },
152 { LDAP_ATTR_MUNGED_DIAL
, "sambaMungedDial" },
153 { LDAP_ATTR_BAD_PASSWORD_COUNT
, "sambaBadPasswordCount" },
154 { LDAP_ATTR_BAD_PASSWORD_TIME
, "sambaBadPasswordTime" },
155 { LDAP_ATTR_PWD_HISTORY
, "sambaPasswordHistory" },
156 { LDAP_ATTR_LOGON_HOURS
, "sambaLogonHours" },
157 { LDAP_ATTR_LIST_END
, NULL
}
160 /* attributes used for allocating RIDs */
162 ATTRIB_MAP_ENTRY dominfo_attr_list
[] = {
163 { LDAP_ATTR_DOMAIN
, "sambaDomainName" },
164 { LDAP_ATTR_NEXT_RID
, "sambaNextRid" },
165 { LDAP_ATTR_NEXT_USERRID
, "sambaNextUserRid" },
166 { LDAP_ATTR_NEXT_GROUPRID
, "sambaNextGroupRid" },
167 { LDAP_ATTR_DOM_SID
, LDAP_ATTRIBUTE_SID
},
168 { LDAP_ATTR_ALGORITHMIC_RID_BASE
,"sambaAlgorithmicRidBase"},
169 { LDAP_ATTR_OBJCLASS
, "objectClass" },
170 { LDAP_ATTR_LIST_END
, NULL
},
173 /* Samba 3.0 group mapping attributes */
175 ATTRIB_MAP_ENTRY groupmap_attr_list
[] = {
176 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
177 { LDAP_ATTR_GROUP_SID
, LDAP_ATTRIBUTE_SID
},
178 { LDAP_ATTR_GROUP_TYPE
, "sambaGroupType" },
179 { LDAP_ATTR_SID_LIST
, "sambaSIDList" },
180 { LDAP_ATTR_DESC
, "description" },
181 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
182 { LDAP_ATTR_CN
, "cn" },
183 { LDAP_ATTR_OBJCLASS
, "objectClass" },
184 { LDAP_ATTR_LIST_END
, NULL
}
187 ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete
[] = {
188 { LDAP_ATTR_GROUP_SID
, LDAP_ATTRIBUTE_SID
},
189 { LDAP_ATTR_GROUP_TYPE
, "sambaGroupType" },
190 { LDAP_ATTR_DESC
, "description" },
191 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
192 { LDAP_ATTR_SID_LIST
, "sambaSIDList" },
193 { LDAP_ATTR_LIST_END
, NULL
}
196 /* idmap_ldap sambaUnixIdPool */
198 ATTRIB_MAP_ENTRY idpool_attr_list
[] = {
199 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
200 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
201 { LDAP_ATTR_OBJCLASS
, "objectClass" },
202 { LDAP_ATTR_LIST_END
, NULL
}
205 ATTRIB_MAP_ENTRY sidmap_attr_list
[] = {
206 { LDAP_ATTR_SID
, LDAP_ATTRIBUTE_SID
},
207 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
208 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
209 { LDAP_ATTR_OBJCLASS
, "objectClass" },
210 { LDAP_ATTR_LIST_END
, NULL
}
213 /**********************************************************************
214 perform a simple table lookup and return the attribute name
215 **********************************************************************/
217 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table
[], int key
)
221 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
) {
222 if ( table
[i
].attrib
== key
)
223 return table
[i
].name
;
231 /**********************************************************************
232 Return the list of attribute names from a mapping table
233 **********************************************************************/
235 const char** get_attr_list( TALLOC_CTX
*mem_ctx
, ATTRIB_MAP_ENTRY table
[] )
240 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
)
244 names
= TALLOC_ARRAY( mem_ctx
, const char*, i
);
246 DEBUG(0,("get_attr_list: out of memory\n"));
251 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
) {
252 names
[i
] = talloc_strdup( names
, table
[i
].name
);
260 /*******************************************************************
261 Search an attribute and return the first value found.
262 ******************************************************************/
264 bool smbldap_get_single_attribute (LDAP
* ldap_struct
, LDAPMessage
* entry
,
265 const char *attribute
, char *value
,
275 if ((values
= ldap_get_values (ldap_struct
, entry
, attribute
)) == NULL
) {
276 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute
));
281 if (convert_string(CH_UTF8
, CH_UNIX
,values
[0], -1, value
, max_len
, False
) == (size_t)-1) {
282 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
283 attribute
, values
[0]));
284 ldap_value_free(values
);
288 ldap_value_free(values
);
289 #ifdef DEBUG_PASSWORDS
290 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute
, value
));
295 char * smbldap_talloc_single_attribute(LDAP
*ldap_struct
, LDAPMessage
*entry
,
296 const char *attribute
,
301 size_t converted_size
;
303 if (attribute
== NULL
) {
307 values
= ldap_get_values(ldap_struct
, entry
, attribute
);
309 if (values
== NULL
) {
310 DEBUG(10, ("attribute %s does not exist\n", attribute
));
314 if (ldap_count_values(values
) != 1) {
315 DEBUG(10, ("attribute %s has %d values, expected only one\n",
316 attribute
, ldap_count_values(values
)));
317 ldap_value_free(values
);
321 if (!pull_utf8_talloc(mem_ctx
, &result
, values
[0], &converted_size
)) {
322 DEBUG(10, ("pull_utf8_talloc failed\n"));
323 ldap_value_free(values
);
327 ldap_value_free(values
);
329 #ifdef DEBUG_PASSWORDS
330 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
336 char * smbldap_talloc_smallest_attribute(LDAP
*ldap_struct
, LDAPMessage
*entry
,
337 const char *attribute
,
342 size_t converted_size
;
345 if (attribute
== NULL
) {
349 values
= ldap_get_values(ldap_struct
, entry
, attribute
);
351 if (values
== NULL
) {
352 DEBUG(10, ("attribute %s does not exist\n", attribute
));
356 if (!pull_utf8_talloc(mem_ctx
, &result
, values
[0], &converted_size
)) {
357 DEBUG(10, ("pull_utf8_talloc failed\n"));
358 ldap_value_free(values
);
362 num_values
= ldap_count_values(values
);
364 for (i
=1; i
<num_values
; i
++) {
367 if (!pull_utf8_talloc(mem_ctx
, &tmp
, values
[i
],
369 DEBUG(10, ("pull_utf8_talloc failed\n"));
371 ldap_value_free(values
);
375 if (StrCaseCmp(tmp
, result
) < 0) {
383 ldap_value_free(values
);
385 #ifdef DEBUG_PASSWORDS
386 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
392 bool smbldap_talloc_single_blob(TALLOC_CTX
*mem_ctx
, LDAP
*ld
,
393 LDAPMessage
*msg
, const char *attrib
,
396 struct berval
**values
;
398 values
= ldap_get_values_len(ld
, msg
, attrib
);
403 if (ldap_count_values_len(values
) != 1) {
404 DEBUG(10, ("Expected one value for %s, got %d\n", attrib
,
405 ldap_count_values_len(values
)));
409 *blob
= data_blob_talloc(mem_ctx
, values
[0]->bv_val
,
411 ldap_value_free_len(values
);
413 return (blob
->data
!= NULL
);
416 bool smbldap_pull_sid(LDAP
*ld
, LDAPMessage
*msg
, const char *attrib
,
422 if (!smbldap_talloc_single_blob(talloc_tos(), ld
, msg
, attrib
,
426 ret
= sid_parse((char *)blob
.data
, blob
.length
, sid
);
427 TALLOC_FREE(blob
.data
);
431 static int ldapmsg_destructor(LDAPMessage
**result
) {
432 ldap_msgfree(*result
);
436 void talloc_autofree_ldapmsg(TALLOC_CTX
*mem_ctx
, LDAPMessage
*result
)
438 LDAPMessage
**handle
;
440 if (result
== NULL
) {
444 handle
= TALLOC_P(mem_ctx
, LDAPMessage
*);
445 SMB_ASSERT(handle
!= NULL
);
448 talloc_set_destructor(handle
, ldapmsg_destructor
);
451 static int ldapmod_destructor(LDAPMod
***mod
) {
452 ldap_mods_free(*mod
, True
);
456 void talloc_autofree_ldapmod(TALLOC_CTX
*mem_ctx
, LDAPMod
**mod
)
464 handle
= TALLOC_P(mem_ctx
, LDAPMod
**);
465 SMB_ASSERT(handle
!= NULL
);
468 talloc_set_destructor(handle
, ldapmod_destructor
);
471 /************************************************************************
472 Routine to manage the LDAPMod structure array
473 manage memory used by the array, by each struct, and values
474 ***********************************************************************/
476 void smbldap_set_mod (LDAPMod
*** modlist
, int modop
, const char *attribute
, const char *value
)
484 /* sanity checks on the mod values */
486 if (attribute
== NULL
|| *attribute
== '\0') {
490 #if 0 /* commented out after discussion with abartlet. Do not reenable.
491 left here so other do not re-add similar code --jerry */
492 if (value
== NULL
|| *value
== '\0')
497 mods
= SMB_MALLOC_P(LDAPMod
*);
499 smb_panic("smbldap_set_mod: out of memory!");
505 for (i
= 0; mods
[i
] != NULL
; ++i
) {
506 if (mods
[i
]->mod_op
== modop
&& strequal(mods
[i
]->mod_type
, attribute
))
510 if (mods
[i
] == NULL
) {
511 mods
= SMB_REALLOC_ARRAY (mods
, LDAPMod
*, i
+ 2);
513 smb_panic("smbldap_set_mod: out of memory!");
516 mods
[i
] = SMB_MALLOC_P(LDAPMod
);
517 if (mods
[i
] == NULL
) {
518 smb_panic("smbldap_set_mod: out of memory!");
521 mods
[i
]->mod_op
= modop
;
522 mods
[i
]->mod_values
= NULL
;
523 mods
[i
]->mod_type
= SMB_STRDUP(attribute
);
528 char *utf8_value
= NULL
;
529 size_t converted_size
;
532 if (mods
[i
]->mod_values
!= NULL
) {
533 for (; mods
[i
]->mod_values
[j
] != NULL
; j
++);
535 mods
[i
]->mod_values
= SMB_REALLOC_ARRAY(mods
[i
]->mod_values
, char *, j
+ 2);
537 if (mods
[i
]->mod_values
== NULL
) {
538 smb_panic("smbldap_set_mod: out of memory!");
542 if (!push_utf8_talloc(talloc_tos(), &utf8_value
, value
, &converted_size
)) {
543 smb_panic("smbldap_set_mod: String conversion failure!");
547 mods
[i
]->mod_values
[j
] = SMB_STRDUP(utf8_value
);
548 TALLOC_FREE(utf8_value
);
549 SMB_ASSERT(mods
[i
]->mod_values
[j
] != NULL
);
551 mods
[i
]->mod_values
[j
+ 1] = NULL
;
556 /**********************************************************************
557 Set attribute to newval in LDAP, regardless of what value the
558 attribute had in LDAP before.
559 *********************************************************************/
561 void smbldap_make_mod(LDAP
*ldap_struct
, LDAPMessage
*existing
,
563 const char *attribute
, const char *newval
)
565 char oldval
[2048]; /* current largest allowed value is mungeddial */
568 if (attribute
== NULL
) {
569 /* This can actually happen for ldapsam_compat where we for
570 * example don't have a password history */
574 if (existing
!= NULL
) {
575 existed
= smbldap_get_single_attribute(ldap_struct
, existing
, attribute
, oldval
, sizeof(oldval
));
581 /* all of our string attributes are case insensitive */
583 if (existed
&& newval
&& (StrCaseCmp(oldval
, newval
) == 0)) {
585 /* Believe it or not, but LDAP will deny a delete and
586 an add at the same time if the values are the
588 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute
));
593 /* There has been no value before, so don't delete it.
594 * Here's a possible race: We might end up with
595 * duplicate attributes */
596 /* By deleting exactly the value we found in the entry this
597 * should be race-free in the sense that the LDAP-Server will
598 * deny the complete operation if somebody changed the
599 * attribute behind our back. */
600 /* This will also allow modifying single valued attributes
601 * in Novell NDS. In NDS you have to first remove attribute and then
602 * you could add new value */
604 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute
, oldval
));
605 smbldap_set_mod(mods
, LDAP_MOD_DELETE
, attribute
, oldval
);
608 /* Regardless of the real operation (add or modify)
609 we add the new value here. We rely on deleting
610 the old value, should it exist. */
612 if ((newval
!= NULL
) && (strlen(newval
) > 0)) {
613 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute
, newval
));
614 smbldap_set_mod(mods
, LDAP_MOD_ADD
, attribute
, newval
);
618 /**********************************************************************
619 Some varients of the LDAP rebind code do not pass in the third 'arg'
620 pointer to a void*, so we try and work around it by assuming that the
621 value of the 'LDAP *' pointer is the same as the one we had passed in
622 **********************************************************************/
624 struct smbldap_state_lookup
{
626 struct smbldap_state
*smbldap_state
;
627 struct smbldap_state_lookup
*prev
, *next
;
630 static struct smbldap_state_lookup
*smbldap_state_lookup_list
;
632 static struct smbldap_state
*smbldap_find_state(LDAP
*ld
)
634 struct smbldap_state_lookup
*t
;
636 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
638 return t
->smbldap_state
;
644 static void smbldap_delete_state(struct smbldap_state
*smbldap_state
)
646 struct smbldap_state_lookup
*t
;
648 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
649 if (t
->smbldap_state
== smbldap_state
) {
650 DLIST_REMOVE(smbldap_state_lookup_list
, t
);
657 static void smbldap_store_state(LDAP
*ld
, struct smbldap_state
*smbldap_state
)
659 struct smbldap_state
*tmp_ldap_state
;
660 struct smbldap_state_lookup
*t
;
662 if ((tmp_ldap_state
= smbldap_find_state(ld
))) {
663 SMB_ASSERT(tmp_ldap_state
== smbldap_state
);
667 t
= SMB_XMALLOC_P(struct smbldap_state_lookup
);
670 DLIST_ADD_END(smbldap_state_lookup_list
, t
, struct smbldap_state_lookup
*);
672 t
->smbldap_state
= smbldap_state
;
675 /********************************************************************
676 start TLS on an existing LDAP connection
677 *******************************************************************/
679 int smb_ldap_start_tls(LDAP
*ldap_struct
, int version
)
681 #ifdef LDAP_OPT_X_TLS
685 if (lp_ldap_ssl() != LDAP_SSL_START_TLS
) {
689 #ifdef LDAP_OPT_X_TLS
690 if (version
!= LDAP_VERSION3
) {
691 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
692 return LDAP_OPERATIONS_ERROR
;
695 if ((rc
= ldap_start_tls_s (ldap_struct
, NULL
, NULL
)) != LDAP_SUCCESS
) {
696 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
697 ldap_err2string(rc
)));
701 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
704 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
705 return LDAP_OPERATIONS_ERROR
;
709 /********************************************************************
710 setup a connection to the LDAP server based on a uri
711 *******************************************************************/
713 int smb_ldap_setup_conn(LDAP
**ldap_struct
, const char *uri
)
717 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri
));
719 #ifdef HAVE_LDAP_INITIALIZE
721 rc
= ldap_initialize(ldap_struct
, uri
);
723 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc
)));
727 if (lp_ldap_ref_follow() != Auto
) {
728 rc
= ldap_set_option(*ldap_struct
, LDAP_OPT_REFERRALS
,
729 lp_ldap_ref_follow() ? LDAP_OPT_ON
: LDAP_OPT_OFF
);
730 if (rc
!= LDAP_SUCCESS
)
731 DEBUG(0, ("Failed to set LDAP_OPT_REFERRALS: %s\n",
732 ldap_err2string(rc
)));
738 /* Parse the string manually */
744 SMB_ASSERT(sizeof(protocol
)>10 && sizeof(host
)>254);
747 /* skip leading "URL:" (if any) */
748 if ( strnequal( uri
, "URL:", 4 ) ) {
752 sscanf(uri
, "%10[^:]://%254[^:/]:%d", protocol
, host
, &port
);
755 if (strequal(protocol
, "ldap")) {
757 } else if (strequal(protocol
, "ldaps")) {
760 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol
));
764 if ((*ldap_struct
= ldap_init(host
, port
)) == NULL
) {
765 DEBUG(0, ("ldap_init failed !\n"));
766 return LDAP_OPERATIONS_ERROR
;
769 if (strequal(protocol
, "ldaps")) {
770 #ifdef LDAP_OPT_X_TLS
771 int tls
= LDAP_OPT_X_TLS_HARD
;
772 if (ldap_set_option (*ldap_struct
, LDAP_OPT_X_TLS
, &tls
) != LDAP_SUCCESS
)
774 DEBUG(0, ("Failed to setup a TLS session\n"));
777 DEBUG(3,("LDAPS option set...!\n"));
779 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
780 return LDAP_OPERATIONS_ERROR
;
781 #endif /* LDAP_OPT_X_TLS */
784 #endif /* HAVE_LDAP_INITIALIZE */
786 /* now set connection timeout */
787 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
789 int ct
= lp_ldap_connection_timeout()*1000;
790 rc
= ldap_set_option(*ldap_struct
, LDAP_X_OPT_CONNECT_TIMEOUT
, &ct
);
791 if (rc
!= LDAP_SUCCESS
) {
792 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
793 ct
, ldap_err2string(rc
)));
796 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
800 ct
.tv_sec
= lp_ldap_connection_timeout();
801 rc
= ldap_set_option(*ldap_struct
, LDAP_OPT_NETWORK_TIMEOUT
, &ct
);
802 if (rc
!= LDAP_SUCCESS
) {
803 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
804 (int)ct
.tv_sec
, ldap_err2string(rc
)));
812 /********************************************************************
813 try to upgrade to Version 3 LDAP if not already, in either case return current
815 *******************************************************************/
817 int smb_ldap_upgrade_conn(LDAP
*ldap_struct
, int *new_version
)
822 /* assume the worst */
823 *new_version
= LDAP_VERSION2
;
825 rc
= ldap_get_option(ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
830 if (version
== LDAP_VERSION3
) {
831 *new_version
= LDAP_VERSION3
;
836 version
= LDAP_VERSION3
;
837 rc
= ldap_set_option (ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
842 *new_version
= LDAP_VERSION3
;
846 /*******************************************************************
847 open a connection to the ldap server (just until the bind)
848 ******************************************************************/
850 int smb_ldap_setup_full_conn(LDAP
**ldap_struct
, const char *uri
)
854 rc
= smb_ldap_setup_conn(ldap_struct
, uri
);
859 rc
= smb_ldap_upgrade_conn(*ldap_struct
, &version
);
864 rc
= smb_ldap_start_tls(*ldap_struct
, version
);
872 /*******************************************************************
873 open a connection to the ldap server.
874 ******************************************************************/
875 static int smbldap_open_connection (struct smbldap_state
*ldap_state
)
878 int rc
= LDAP_SUCCESS
;
880 LDAP
**ldap_struct
= &ldap_state
->ldap_struct
;
882 rc
= smb_ldap_setup_conn(ldap_struct
, ldap_state
->uri
);
887 /* Store the LDAP pointer in a lookup list */
889 smbldap_store_state(*ldap_struct
, ldap_state
);
891 /* Upgrade to LDAPv3 if possible */
893 rc
= smb_ldap_upgrade_conn(*ldap_struct
, &version
);
898 /* Start TLS if required */
900 rc
= smb_ldap_start_tls(*ldap_struct
, version
);
905 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
909 /*******************************************************************
910 a rebind function for authenticated referrals
911 This version takes a void* that we can shove useful stuff in :-)
912 ******************************************************************/
913 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
915 static int rebindproc_with_state (LDAP
* ld
, char **whop
, char **credp
,
916 int *methodp
, int freeit
, void *arg
)
918 struct smbldap_state
*ldap_state
= arg
;
920 /** @TODO Should we be doing something to check what servers we rebind to?
921 Could we get a referral to a machine that we don't want to give our
922 username and password to? */
927 memset(*credp
, '\0', strlen(*credp
));
931 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
932 ldap_state
->bind_dn
?ldap_state
->bind_dn
:"[Anonymous bind]"));
934 if (ldap_state
->anonymous
) {
938 *whop
= SMB_STRDUP(ldap_state
->bind_dn
);
940 return LDAP_NO_MEMORY
;
942 *credp
= SMB_STRDUP(ldap_state
->bind_secret
);
945 return LDAP_NO_MEMORY
;
948 *methodp
= LDAP_AUTH_SIMPLE
;
951 GetTimeOfDay(&ldap_state
->last_rebind
);
955 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
957 /*******************************************************************
958 a rebind function for authenticated referrals
959 This version takes a void* that we can shove useful stuff in :-)
960 and actually does the connection.
961 ******************************************************************/
962 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
963 static int rebindproc_connect_with_state (LDAP
*ldap_struct
,
964 LDAP_CONST
char *url
,
966 ber_int_t msgid
, void *arg
)
968 struct smbldap_state
*ldap_state
=
969 (struct smbldap_state
*)arg
;
973 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
974 url
, ldap_state
->bind_dn
?ldap_state
->bind_dn
:"[Anonymous bind]"));
976 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
977 * itself) before rebinding to another LDAP server to avoid to expose
978 * our credentials. At least *try* to secure the connection - Guenther */
980 smb_ldap_upgrade_conn(ldap_struct
, &version
);
981 smb_ldap_start_tls(ldap_struct
, version
);
983 /** @TODO Should we be doing something to check what servers we rebind to?
984 Could we get a referral to a machine that we don't want to give our
985 username and password to? */
987 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
989 /* only set the last rebind timestamp when we did rebind after a
990 * non-read LDAP operation. That way we avoid the replication sleep
991 * after a simple redirected search operation - Guenther */
995 case LDAP_REQ_MODIFY
:
997 case LDAP_REQ_DELETE
:
999 case LDAP_REQ_EXTENDED
:
1000 DEBUG(10,("rebindproc_connect_with_state: "
1001 "setting last_rebind timestamp "
1002 "(req: 0x%02x)\n", (unsigned int)request
));
1003 GetTimeOfDay(&ldap_state
->last_rebind
);
1006 ZERO_STRUCT(ldap_state
->last_rebind
);
1012 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1014 /*******************************************************************
1015 Add a rebind function for authenticated referrals
1016 ******************************************************************/
1017 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1019 # if LDAP_SET_REBIND_PROC_ARGS == 2
1020 static int rebindproc (LDAP
*ldap_struct
, char **whop
, char **credp
,
1021 int *method
, int freeit
)
1023 struct smbldap_state
*ldap_state
= smbldap_find_state(ldap_struct
);
1025 return rebindproc_with_state(ldap_struct
, whop
, credp
,
1026 method
, freeit
, ldap_state
);
1028 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1029 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1031 /*******************************************************************
1032 a rebind function for authenticated referrals
1033 this also does the connection, but no void*.
1034 ******************************************************************/
1035 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1036 # if LDAP_SET_REBIND_PROC_ARGS == 2
1037 static int rebindproc_connect (LDAP
* ld
, LDAP_CONST
char *url
, int request
,
1040 struct smbldap_state
*ldap_state
= smbldap_find_state(ld
);
1042 return rebindproc_connect_with_state(ld
, url
, (ber_tag_t
)request
, msgid
,
1045 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1046 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1048 /*******************************************************************
1049 connect to the ldap server under system privilege.
1050 ******************************************************************/
1051 static int smbldap_connect_system(struct smbldap_state
*ldap_state
, LDAP
* ldap_struct
)
1056 if (!ldap_state
->anonymous
&& !ldap_state
->bind_dn
) {
1057 char *bind_dn
= NULL
;
1058 char *bind_secret
= NULL
;
1060 /* get the default dn and password only if they are not set already */
1061 if (!fetch_ldap_pw(&bind_dn
, &bind_secret
)) {
1062 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
1063 return LDAP_INVALID_CREDENTIALS
;
1065 smbldap_set_creds(ldap_state
, false, bind_dn
, bind_secret
);
1067 memset(bind_secret
, '\0', strlen(bind_secret
));
1068 SAFE_FREE(bind_secret
);
1071 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
1072 (OpenLDAP) doesnt' seem to support it */
1074 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
1075 ldap_state
->uri
, ldap_state
->bind_dn
));
1077 #ifdef HAVE_LDAP_SET_REBIND_PROC
1078 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1079 # if LDAP_SET_REBIND_PROC_ARGS == 2
1080 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect
);
1082 # if LDAP_SET_REBIND_PROC_ARGS == 3
1083 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect_with_state
, (void *)ldap_state
);
1085 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1086 # if LDAP_SET_REBIND_PROC_ARGS == 2
1087 ldap_set_rebind_proc(ldap_struct
, &rebindproc
);
1089 # if LDAP_SET_REBIND_PROC_ARGS == 3
1090 ldap_set_rebind_proc(ldap_struct
, &rebindproc_with_state
, (void *)ldap_state
);
1092 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1095 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
1097 if (rc
!= LDAP_SUCCESS
) {
1098 char *ld_error
= NULL
;
1099 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_ERROR_STRING
,
1101 DEBUG(ldap_state
->num_failures
? 2 : 0,
1102 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
1104 ldap_state
->bind_dn
? ldap_state
->bind_dn
: "[Anonymous bind]",
1105 ldap_err2string(rc
),
1106 ld_error
? ld_error
: "(unknown)"));
1107 SAFE_FREE(ld_error
);
1108 ldap_state
->num_failures
++;
1112 ldap_state
->num_failures
= 0;
1113 ldap_state
->paged_results
= False
;
1115 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
1117 if (smbldap_has_control(ldap_state
->ldap_struct
, ADS_PAGE_CTL_OID
) && version
== 3) {
1118 ldap_state
->paged_results
= True
;
1121 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1122 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1123 ldap_state
->paged_results
? "does" : "does not"));
1127 static void smbldap_idle_fn(struct event_context
*event_ctx
,
1128 struct timed_event
*te
,
1130 void *private_data
);
1132 /**********************************************************************
1133 Connect to LDAP server (called before every ldap operation)
1134 *********************************************************************/
1135 static int smbldap_open(struct smbldap_state
*ldap_state
)
1138 bool reopen
= False
;
1139 SMB_ASSERT(ldap_state
);
1141 if ((ldap_state
->ldap_struct
!= NULL
) && ((ldap_state
->last_ping
+ SMBLDAP_DONT_PING_TIME
) < time(NULL
))) {
1143 #ifdef HAVE_UNIXSOCKET
1144 struct sockaddr_un addr
;
1146 struct sockaddr addr
;
1148 socklen_t len
= sizeof(addr
);
1151 opt_rc
= ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_DESC
, &sd
);
1152 if (opt_rc
== 0 && (getpeername(sd
, (struct sockaddr
*) &addr
, &len
)) < 0 )
1155 #ifdef HAVE_UNIXSOCKET
1156 if (opt_rc
== 0 && addr
.sun_family
== AF_UNIX
)
1160 /* the other end has died. reopen. */
1161 ldap_unbind(ldap_state
->ldap_struct
);
1162 ldap_state
->ldap_struct
= NULL
;
1163 ldap_state
->last_ping
= (time_t)0;
1165 ldap_state
->last_ping
= time(NULL
);
1169 if (ldap_state
->ldap_struct
!= NULL
) {
1170 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1171 return LDAP_SUCCESS
;
1174 if ((rc
= smbldap_open_connection(ldap_state
))) {
1178 if ((rc
= smbldap_connect_system(ldap_state
, ldap_state
->ldap_struct
))) {
1179 ldap_unbind(ldap_state
->ldap_struct
);
1180 ldap_state
->ldap_struct
= NULL
;
1185 ldap_state
->last_ping
= time(NULL
);
1186 ldap_state
->pid
= sys_getpid();
1188 TALLOC_FREE(ldap_state
->idle_event
);
1190 if (ldap_state
->event_context
!= NULL
) {
1191 ldap_state
->idle_event
= event_add_timed(
1192 ldap_state
->event_context
, NULL
,
1193 timeval_current_ofs(SMBLDAP_IDLE_TIME
, 0),
1194 smbldap_idle_fn
, ldap_state
);
1197 DEBUG(4,("The LDAP server is successfully connected\n"));
1199 return LDAP_SUCCESS
;
1202 /**********************************************************************
1203 Disconnect from LDAP server
1204 *********************************************************************/
1205 static NTSTATUS
smbldap_close(struct smbldap_state
*ldap_state
)
1208 return NT_STATUS_INVALID_PARAMETER
;
1210 if (ldap_state
->ldap_struct
!= NULL
) {
1211 ldap_unbind(ldap_state
->ldap_struct
);
1212 ldap_state
->ldap_struct
= NULL
;
1215 smbldap_delete_state(ldap_state
);
1217 DEBUG(5,("The connection to the LDAP server was closed\n"));
1218 /* maybe free the results here --metze */
1220 return NT_STATUS_OK
;
1223 static bool got_alarm
;
1225 static void (*old_handler
)(int);
1227 static void gotalarm_sig(int dummy
)
1232 static int another_ldap_try(struct smbldap_state
*ldap_state
, int *rc
,
1233 int *attempts
, time_t endtime
)
1235 time_t now
= time(NULL
);
1236 int open_rc
= LDAP_SERVER_DOWN
;
1238 if (*rc
!= LDAP_SERVER_DOWN
)
1241 if (now
>= endtime
) {
1242 smbldap_close(ldap_state
);
1247 if (*attempts
== 0) {
1249 old_handler
= CatchSignal(SIGALRM
, gotalarm_sig
);
1250 alarm(endtime
- now
);
1252 if (ldap_state
->pid
!= sys_getpid())
1253 smbldap_close(ldap_state
);
1263 open_rc
= smbldap_open(ldap_state
);
1265 if (open_rc
== LDAP_SUCCESS
) {
1266 ldap_state
->last_use
= now
;
1270 if (open_rc
== LDAP_INSUFFICIENT_ACCESS
) {
1271 /* The fact that we are non-root or any other
1272 * access-denied condition will not change in the next
1273 * round of trying */
1283 if (open_rc
!= LDAP_SUCCESS
) {
1284 DEBUG(1, ("Connection to LDAP server failed for the "
1285 "%d try!\n", *attempts
));
1290 CatchSignal(SIGALRM
, old_handler
);
1292 ldap_state
->last_use
= now
;
1296 /*********************************************************************
1297 ********************************************************************/
1299 static int smbldap_search_ext(struct smbldap_state
*ldap_state
,
1300 const char *base
, int scope
, const char *filter
,
1301 const char *attrs
[], int attrsonly
,
1302 LDAPControl
**sctrls
, LDAPControl
**cctrls
,
1303 int sizelimit
, LDAPMessage
**res
)
1305 int rc
= LDAP_SERVER_DOWN
;
1308 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1309 struct timeval timeout
;
1310 size_t converted_size
;
1312 SMB_ASSERT(ldap_state
);
1314 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1315 "scope => [%d]\n", base
, filter
, scope
));
1317 if (ldap_state
->last_rebind
.tv_sec
> 0) {
1318 struct timeval tval
;
1323 GetTimeOfDay(&tval
);
1325 tdiff
= usec_time_diff(&tval
, &ldap_state
->last_rebind
);
1326 tdiff
/= 1000; /* Convert to milliseconds. */
1328 sleep_time
= lp_ldap_replication_sleep()-(int)tdiff
;
1329 sleep_time
= MIN(sleep_time
, MAX_LDAP_REPLICATION_SLEEP_TIME
);
1331 if (sleep_time
> 0) {
1332 /* we wait for the LDAP replication */
1333 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1334 "for LDAP replication.\n",sleep_time
));
1335 smb_msleep(sleep_time
);
1336 DEBUG(5,("smbldap_search_ext: go on!\n"));
1338 ZERO_STRUCT(ldap_state
->last_rebind
);
1341 if (!push_utf8_talloc(talloc_tos(), &utf8_filter
, filter
, &converted_size
)) {
1342 return LDAP_NO_MEMORY
;
1345 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1346 timeout
.tv_sec
= lp_ldap_timeout();
1347 timeout
.tv_usec
= 0;
1349 /* Setup alarm timeout.... Do we need both of these ? JRA.
1350 * Yes, I think we do need both of these. The server timeout only
1351 * covers the case where the server's operation takes too long. It
1352 * does not cover the case where the request hangs on its way to the
1353 * server. The server side timeout is not strictly necessary, it's
1354 * just a bit more kind to the server. VL. */
1357 CatchSignal(SIGALRM
, SIGNAL_CAST gotalarm_sig
);
1358 alarm(lp_ldap_timeout());
1359 /* End setup timeout. */
1361 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1362 rc
= ldap_search_ext_s(ldap_state
->ldap_struct
, base
, scope
,
1364 CONST_DISCARD(char **, attrs
),
1365 attrsonly
, sctrls
, cctrls
, &timeout
,
1367 if (rc
!= LDAP_SUCCESS
) {
1368 char *ld_error
= NULL
;
1371 ldap_get_option(ldap_state
->ldap_struct
,
1372 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1374 ldap_get_option(ldap_state
->ldap_struct
,
1375 LDAP_OPT_ERROR_STRING
, &ld_error
);
1376 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1377 "(%s)\n", base
, ld_errno
,
1378 ldap_err2string(rc
),
1379 ld_error
? ld_error
: "unknown"));
1380 SAFE_FREE(ld_error
);
1382 if (ld_errno
== LDAP_SERVER_DOWN
) {
1383 ldap_unbind(ldap_state
->ldap_struct
);
1384 ldap_state
->ldap_struct
= NULL
;
1389 TALLOC_FREE(utf8_filter
);
1391 /* Teardown timeout. */
1392 CatchSignal(SIGALRM
, SIGNAL_CAST SIG_IGN
);
1396 return LDAP_TIMELIMIT_EXCEEDED
;
1401 int smbldap_search(struct smbldap_state
*ldap_state
,
1402 const char *base
, int scope
, const char *filter
,
1403 const char *attrs
[], int attrsonly
,
1406 return smbldap_search_ext(ldap_state
, base
, scope
, filter
, attrs
,
1407 attrsonly
, NULL
, NULL
, LDAP_NO_LIMIT
, res
);
1410 int smbldap_search_paged(struct smbldap_state
*ldap_state
,
1411 const char *base
, int scope
, const char *filter
,
1412 const char **attrs
, int attrsonly
, int pagesize
,
1413 LDAPMessage
**res
, void **cookie
)
1416 LDAPControl
**rcontrols
;
1417 LDAPControl
*controls
[2] = { NULL
, NULL
};
1418 BerElement
*cookie_be
= NULL
;
1419 struct berval
*cookie_bv
= NULL
;
1421 bool critical
= True
;
1425 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1426 "scope => [%d], pagesize => [%d]\n",
1427 base
, filter
, scope
, pagesize
));
1429 cookie_be
= ber_alloc_t(LBER_USE_DER
);
1430 if (cookie_be
== NULL
) {
1431 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1433 return LDAP_NO_MEMORY
;
1436 /* construct cookie */
1437 if (*cookie
!= NULL
) {
1438 ber_printf(cookie_be
, "{iO}", (ber_int_t
) pagesize
, *cookie
);
1439 ber_bvfree((struct berval
*)*cookie
); /* don't need it from last time */
1442 ber_printf(cookie_be
, "{io}", (ber_int_t
) pagesize
, "", 0);
1444 ber_flatten(cookie_be
, &cookie_bv
);
1446 pr
.ldctl_oid
= CONST_DISCARD(char *, ADS_PAGE_CTL_OID
);
1447 pr
.ldctl_iscritical
= (char) critical
;
1448 pr
.ldctl_value
.bv_len
= cookie_bv
->bv_len
;
1449 pr
.ldctl_value
.bv_val
= cookie_bv
->bv_val
;
1454 rc
= smbldap_search_ext(ldap_state
, base
, scope
, filter
, attrs
,
1455 0, controls
, NULL
, LDAP_NO_LIMIT
, res
);
1457 ber_free(cookie_be
, 1);
1458 ber_bvfree(cookie_bv
);
1461 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1462 "failed with [%s]\n", filter
, ldap_err2string(rc
)));
1466 DEBUG(3,("smbldap_search_paged: search was successful\n"));
1468 rc
= ldap_parse_result(ldap_state
->ldap_struct
, *res
, NULL
, NULL
,
1469 NULL
, NULL
, &rcontrols
, 0);
1471 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1472 "with [%s]\n", ldap_err2string(rc
)));
1476 if (rcontrols
== NULL
)
1479 for (i
=0; rcontrols
[i
]; i
++) {
1481 if (strcmp(ADS_PAGE_CTL_OID
, rcontrols
[i
]->ldctl_oid
) != 0)
1484 cookie_be
= ber_init(&rcontrols
[i
]->ldctl_value
);
1485 ber_scanf(cookie_be
,"{iO}", &tmp
, &cookie_bv
);
1486 /* the berval is the cookie, but must be freed when it is all
1488 if (cookie_bv
->bv_len
)
1489 *cookie
=ber_bvdup(cookie_bv
);
1492 ber_bvfree(cookie_bv
);
1493 ber_free(cookie_be
, 1);
1496 ldap_controls_free(rcontrols
);
1501 int smbldap_modify(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
1503 int rc
= LDAP_SERVER_DOWN
;
1506 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1507 size_t converted_size
;
1509 SMB_ASSERT(ldap_state
);
1511 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn
));
1513 if (!push_utf8_talloc(talloc_tos(), &utf8_dn
, dn
, &converted_size
)) {
1514 return LDAP_NO_MEMORY
;
1517 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1518 rc
= ldap_modify_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
1519 if (rc
!= LDAP_SUCCESS
) {
1520 char *ld_error
= NULL
;
1523 ldap_get_option(ldap_state
->ldap_struct
,
1524 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1526 ldap_get_option(ldap_state
->ldap_struct
,
1527 LDAP_OPT_ERROR_STRING
, &ld_error
);
1528 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1529 "(%s)\n", dn
, ld_errno
,
1530 ldap_err2string(rc
),
1531 ld_error
? ld_error
: "unknown"));
1532 SAFE_FREE(ld_error
);
1534 if (ld_errno
== LDAP_SERVER_DOWN
) {
1535 ldap_unbind(ldap_state
->ldap_struct
);
1536 ldap_state
->ldap_struct
= NULL
;
1541 TALLOC_FREE(utf8_dn
);
1545 int smbldap_add(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
1547 int rc
= LDAP_SERVER_DOWN
;
1550 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1551 size_t converted_size
;
1553 SMB_ASSERT(ldap_state
);
1555 DEBUG(5,("smbldap_add: dn => [%s]\n", dn
));
1557 if (!push_utf8_talloc(talloc_tos(), &utf8_dn
, dn
, &converted_size
)) {
1558 return LDAP_NO_MEMORY
;
1561 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1562 rc
= ldap_add_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
1563 if (rc
!= LDAP_SUCCESS
) {
1564 char *ld_error
= NULL
;
1567 ldap_get_option(ldap_state
->ldap_struct
,
1568 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1570 ldap_get_option(ldap_state
->ldap_struct
,
1571 LDAP_OPT_ERROR_STRING
, &ld_error
);
1572 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1573 "(%s)\n", dn
, ld_errno
,
1574 ldap_err2string(rc
),
1575 ld_error
? ld_error
: "unknown"));
1576 SAFE_FREE(ld_error
);
1578 if (ld_errno
== LDAP_SERVER_DOWN
) {
1579 ldap_unbind(ldap_state
->ldap_struct
);
1580 ldap_state
->ldap_struct
= NULL
;
1585 TALLOC_FREE(utf8_dn
);
1589 int smbldap_delete(struct smbldap_state
*ldap_state
, const char *dn
)
1591 int rc
= LDAP_SERVER_DOWN
;
1594 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1595 size_t converted_size
;
1597 SMB_ASSERT(ldap_state
);
1599 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn
));
1601 if (!push_utf8_talloc(talloc_tos(), &utf8_dn
, dn
, &converted_size
)) {
1602 return LDAP_NO_MEMORY
;
1605 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1606 rc
= ldap_delete_s(ldap_state
->ldap_struct
, utf8_dn
);
1607 if (rc
!= LDAP_SUCCESS
) {
1608 char *ld_error
= NULL
;
1611 ldap_get_option(ldap_state
->ldap_struct
,
1612 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1614 ldap_get_option(ldap_state
->ldap_struct
,
1615 LDAP_OPT_ERROR_STRING
, &ld_error
);
1616 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1617 "(%s)\n", dn
, ld_errno
,
1618 ldap_err2string(rc
),
1619 ld_error
? ld_error
: "unknown"));
1620 SAFE_FREE(ld_error
);
1622 if (ld_errno
== LDAP_SERVER_DOWN
) {
1623 ldap_unbind(ldap_state
->ldap_struct
);
1624 ldap_state
->ldap_struct
= NULL
;
1629 TALLOC_FREE(utf8_dn
);
1633 int smbldap_extended_operation(struct smbldap_state
*ldap_state
,
1634 LDAP_CONST
char *reqoid
, struct berval
*reqdata
,
1635 LDAPControl
**serverctrls
, LDAPControl
**clientctrls
,
1636 char **retoidp
, struct berval
**retdatap
)
1638 int rc
= LDAP_SERVER_DOWN
;
1640 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1645 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1646 rc
= ldap_extended_operation_s(ldap_state
->ldap_struct
, reqoid
,
1647 reqdata
, serverctrls
,
1648 clientctrls
, retoidp
, retdatap
);
1649 if (rc
!= LDAP_SUCCESS
) {
1650 char *ld_error
= NULL
;
1653 ldap_get_option(ldap_state
->ldap_struct
,
1654 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1656 ldap_get_option(ldap_state
->ldap_struct
,
1657 LDAP_OPT_ERROR_STRING
, &ld_error
);
1658 DEBUG(10, ("Extended operation failed with error: "
1659 "%d (%s) (%s)\n", ld_errno
,
1660 ldap_err2string(rc
),
1661 ld_error
? ld_error
: "unknown"));
1662 SAFE_FREE(ld_error
);
1664 if (ld_errno
== LDAP_SERVER_DOWN
) {
1665 ldap_unbind(ldap_state
->ldap_struct
);
1666 ldap_state
->ldap_struct
= NULL
;
1674 /*******************************************************************
1675 run the search by name.
1676 ******************************************************************/
1677 int smbldap_search_suffix (struct smbldap_state
*ldap_state
,
1678 const char *filter
, const char **search_attr
,
1679 LDAPMessage
** result
)
1681 return smbldap_search(ldap_state
, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE
,
1682 filter
, search_attr
, 0, result
);
1685 static void smbldap_idle_fn(struct event_context
*event_ctx
,
1686 struct timed_event
*te
,
1690 struct smbldap_state
*state
= (struct smbldap_state
*)private_data
;
1692 TALLOC_FREE(state
->idle_event
);
1694 if (state
->ldap_struct
== NULL
) {
1695 DEBUG(10,("ldap connection not connected...\n"));
1699 if ((state
->last_use
+SMBLDAP_IDLE_TIME
) > now
.tv_sec
) {
1700 DEBUG(10,("ldap connection not idle...\n"));
1702 state
->idle_event
= event_add_timed(
1704 timeval_add(&now
, SMBLDAP_IDLE_TIME
, 0),
1710 DEBUG(7,("ldap connection idle...closing connection\n"));
1711 smbldap_close(state
);
1714 /**********************************************************************
1716 *********************************************************************/
1718 void smbldap_free_struct(struct smbldap_state
**ldap_state
)
1720 smbldap_close(*ldap_state
);
1722 if ((*ldap_state
)->bind_secret
) {
1723 memset((*ldap_state
)->bind_secret
, '\0', strlen((*ldap_state
)->bind_secret
));
1726 SAFE_FREE((*ldap_state
)->bind_dn
);
1727 SAFE_FREE((*ldap_state
)->bind_secret
);
1729 TALLOC_FREE((*ldap_state
)->idle_event
);
1733 /* No need to free any further, as it is talloc()ed */
1737 /**********************************************************************
1738 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1739 *********************************************************************/
1741 NTSTATUS
smbldap_init(TALLOC_CTX
*mem_ctx
, struct event_context
*event_ctx
,
1742 const char *location
,
1743 struct smbldap_state
**smbldap_state
)
1745 *smbldap_state
= TALLOC_ZERO_P(mem_ctx
, struct smbldap_state
);
1746 if (!*smbldap_state
) {
1747 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1748 return NT_STATUS_NO_MEMORY
;
1752 (*smbldap_state
)->uri
= talloc_strdup(mem_ctx
, location
);
1754 (*smbldap_state
)->uri
= "ldap://localhost";
1757 (*smbldap_state
)->event_context
= event_ctx
;
1759 return NT_STATUS_OK
;
1762 char *smbldap_talloc_dn(TALLOC_CTX
*mem_ctx
, LDAP
*ld
,
1765 char *utf8_dn
, *unix_dn
;
1766 size_t converted_size
;
1768 utf8_dn
= ldap_get_dn(ld
, entry
);
1770 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1773 if (!pull_utf8_talloc(mem_ctx
, &unix_dn
, utf8_dn
, &converted_size
)) {
1774 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1775 "[%s]\n", utf8_dn
));
1778 ldap_memfree(utf8_dn
);
1782 /*******************************************************************
1783 Check if root-dse has a certain Control or Extension
1784 ********************************************************************/
1786 static bool smbldap_check_root_dse(LDAP
*ld
, const char **attrs
, const char *value
)
1788 LDAPMessage
*msg
= NULL
;
1789 LDAPMessage
*entry
= NULL
;
1790 char **values
= NULL
;
1791 int rc
, num_result
, num_values
, i
;
1792 bool result
= False
;
1795 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1799 if (!strequal(attrs
[0], "supportedExtension") &&
1800 !strequal(attrs
[0], "supportedControl") &&
1801 !strequal(attrs
[0], "namingContexts")) {
1802 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs
[0]));
1806 rc
= ldap_search_s(ld
, "", LDAP_SCOPE_BASE
,
1807 "(objectclass=*)", CONST_DISCARD(char **, attrs
), 0 , &msg
);
1809 if (rc
!= LDAP_SUCCESS
) {
1810 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1814 num_result
= ldap_count_entries(ld
, msg
);
1816 if (num_result
!= 1) {
1817 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result
));
1821 entry
= ldap_first_entry(ld
, msg
);
1823 if (entry
== NULL
) {
1824 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1828 values
= ldap_get_values(ld
, entry
, attrs
[0]);
1830 if (values
== NULL
) {
1831 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs
[0]));
1835 num_values
= ldap_count_values(values
);
1837 if (num_values
== 0) {
1838 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs
[0]));
1842 for (i
=0; i
<num_values
; i
++) {
1843 if (strcmp(values
[i
], value
) == 0)
1850 ldap_value_free(values
);
1858 /*******************************************************************
1859 Check if LDAP-Server supports a certain Control (OID in string format)
1860 ********************************************************************/
1862 bool smbldap_has_control(LDAP
*ld
, const char *control
)
1864 const char *attrs
[] = { "supportedControl", NULL
};
1865 return smbldap_check_root_dse(ld
, attrs
, control
);
1868 /*******************************************************************
1869 Check if LDAP-Server supports a certain Extension (OID in string format)
1870 ********************************************************************/
1872 bool smbldap_has_extension(LDAP
*ld
, const char *extension
)
1874 const char *attrs
[] = { "supportedExtension", NULL
};
1875 return smbldap_check_root_dse(ld
, attrs
, extension
);
1878 /*******************************************************************
1879 Check if LDAP-Server holds a given namingContext
1880 ********************************************************************/
1882 bool smbldap_has_naming_context(LDAP
*ld
, const char *naming_context
)
1884 const char *attrs
[] = { "namingContexts", NULL
};
1885 return smbldap_check_root_dse(ld
, attrs
, naming_context
);
1888 bool smbldap_set_creds(struct smbldap_state
*ldap_state
, bool anon
, const char *dn
, const char *secret
)
1890 ldap_state
->anonymous
= anon
;
1892 /* free any previously set credential */
1894 SAFE_FREE(ldap_state
->bind_dn
);
1895 if (ldap_state
->bind_secret
) {
1896 /* make sure secrets are zeroed out of memory */
1897 memset(ldap_state
->bind_secret
, '\0', strlen(ldap_state
->bind_secret
));
1898 SAFE_FREE(ldap_state
->bind_secret
);
1902 ldap_state
->bind_dn
= SMB_STRDUP(dn
);
1903 ldap_state
->bind_secret
= SMB_STRDUP(secret
);