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 2 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, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 #ifndef LDAP_OPT_SUCCESS
30 #define LDAP_OPT_SUCCESS 0
33 /* Try not to hit the up or down server forever */
35 #define SMBLDAP_DONT_PING_TIME 10 /* ping only all 10 seconds */
36 #define SMBLDAP_NUM_RETRIES 8 /* retry only 8 times */
38 #define SMBLDAP_IDLE_TIME 150 /* After 2.5 minutes disconnect */
41 /* attributes used by Samba 2.2 */
43 ATTRIB_MAP_ENTRY attrib_map_v22
[] = {
44 { LDAP_ATTR_UID
, "uid" },
45 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
46 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
47 { LDAP_ATTR_UNIX_HOME
, "homeDirectory" },
48 { LDAP_ATTR_PWD_LAST_SET
, "pwdLastSet" },
49 { LDAP_ATTR_PWD_CAN_CHANGE
, "pwdCanChange" },
50 { LDAP_ATTR_PWD_MUST_CHANGE
, "pwdMustChange" },
51 { LDAP_ATTR_LOGON_TIME
, "logonTime" },
52 { LDAP_ATTR_LOGOFF_TIME
, "logoffTime" },
53 { LDAP_ATTR_KICKOFF_TIME
, "kickoffTime" },
54 { LDAP_ATTR_CN
, "cn" },
55 { LDAP_ATTR_SN
, "sn" },
56 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
57 { LDAP_ATTR_HOME_PATH
, "smbHome" },
58 { LDAP_ATTR_HOME_DRIVE
, "homeDrive" },
59 { LDAP_ATTR_LOGON_SCRIPT
, "scriptPath" },
60 { LDAP_ATTR_PROFILE_PATH
, "profilePath" },
61 { LDAP_ATTR_DESC
, "description" },
62 { LDAP_ATTR_USER_WKS
, "userWorkstations"},
63 { LDAP_ATTR_USER_RID
, "rid" },
64 { LDAP_ATTR_PRIMARY_GROUP_RID
, "primaryGroupID"},
65 { LDAP_ATTR_LMPW
, "lmPassword" },
66 { LDAP_ATTR_NTPW
, "ntPassword" },
67 { LDAP_ATTR_DOMAIN
, "domain" },
68 { LDAP_ATTR_OBJCLASS
, "objectClass" },
69 { LDAP_ATTR_ACB_INFO
, "acctFlags" },
70 { LDAP_ATTR_MOD_TIMESTAMP
, "modifyTimestamp" },
71 { LDAP_ATTR_LIST_END
, NULL
}
74 ATTRIB_MAP_ENTRY attrib_map_to_delete_v22
[] = {
75 { LDAP_ATTR_PWD_LAST_SET
, "pwdLastSet" },
76 { LDAP_ATTR_PWD_CAN_CHANGE
, "pwdCanChange" },
77 { LDAP_ATTR_PWD_MUST_CHANGE
, "pwdMustChange" },
78 { LDAP_ATTR_LOGON_TIME
, "logonTime" },
79 { LDAP_ATTR_LOGOFF_TIME
, "logoffTime" },
80 { LDAP_ATTR_KICKOFF_TIME
, "kickoffTime" },
81 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
82 { LDAP_ATTR_HOME_PATH
, "smbHome" },
83 { LDAP_ATTR_HOME_DRIVE
, "homeDrives" },
84 { LDAP_ATTR_LOGON_SCRIPT
, "scriptPath" },
85 { LDAP_ATTR_PROFILE_PATH
, "profilePath" },
86 { LDAP_ATTR_USER_WKS
, "userWorkstations"},
87 { LDAP_ATTR_USER_RID
, "rid" },
88 { LDAP_ATTR_PRIMARY_GROUP_RID
, "primaryGroupID"},
89 { LDAP_ATTR_LMPW
, "lmPassword" },
90 { LDAP_ATTR_NTPW
, "ntPassword" },
91 { LDAP_ATTR_DOMAIN
, "domain" },
92 { LDAP_ATTR_ACB_INFO
, "acctFlags" },
93 { LDAP_ATTR_LIST_END
, NULL
}
96 /* attributes used by Samba 3.0's sambaSamAccount */
98 ATTRIB_MAP_ENTRY attrib_map_v30
[] = {
99 { LDAP_ATTR_UID
, "uid" },
100 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
101 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
102 { LDAP_ATTR_UNIX_HOME
, "homeDirectory" },
103 { LDAP_ATTR_PWD_LAST_SET
, "sambaPwdLastSet" },
104 { LDAP_ATTR_PWD_CAN_CHANGE
, "sambaPwdCanChange" },
105 { LDAP_ATTR_PWD_MUST_CHANGE
, "sambaPwdMustChange" },
106 { LDAP_ATTR_LOGON_TIME
, "sambaLogonTime" },
107 { LDAP_ATTR_LOGOFF_TIME
, "sambaLogoffTime" },
108 { LDAP_ATTR_KICKOFF_TIME
, "sambaKickoffTime" },
109 { LDAP_ATTR_CN
, "cn" },
110 { LDAP_ATTR_SN
, "sn" },
111 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
112 { LDAP_ATTR_HOME_DRIVE
, "sambaHomeDrive" },
113 { LDAP_ATTR_HOME_PATH
, "sambaHomePath" },
114 { LDAP_ATTR_LOGON_SCRIPT
, "sambaLogonScript" },
115 { LDAP_ATTR_PROFILE_PATH
, "sambaProfilePath" },
116 { LDAP_ATTR_DESC
, "description" },
117 { LDAP_ATTR_USER_WKS
, "sambaUserWorkstations" },
118 { LDAP_ATTR_USER_SID
, LDAP_ATTRIBUTE_SID
},
119 { LDAP_ATTR_PRIMARY_GROUP_SID
, "sambaPrimaryGroupSID" },
120 { LDAP_ATTR_LMPW
, "sambaLMPassword" },
121 { LDAP_ATTR_NTPW
, "sambaNTPassword" },
122 { LDAP_ATTR_DOMAIN
, "sambaDomainName" },
123 { LDAP_ATTR_OBJCLASS
, "objectClass" },
124 { LDAP_ATTR_ACB_INFO
, "sambaAcctFlags" },
125 { LDAP_ATTR_MUNGED_DIAL
, "sambaMungedDial" },
126 { LDAP_ATTR_BAD_PASSWORD_COUNT
, "sambaBadPasswordCount" },
127 { LDAP_ATTR_BAD_PASSWORD_TIME
, "sambaBadPasswordTime" },
128 { LDAP_ATTR_PWD_HISTORY
, "sambaPasswordHistory" },
129 { LDAP_ATTR_MOD_TIMESTAMP
, "modifyTimestamp" },
130 { LDAP_ATTR_LOGON_HOURS
, "sambaLogonHours" },
131 { LDAP_ATTR_LIST_END
, NULL
}
134 ATTRIB_MAP_ENTRY attrib_map_to_delete_v30
[] = {
135 { LDAP_ATTR_PWD_LAST_SET
, "sambaPwdLastSet" },
136 { LDAP_ATTR_PWD_CAN_CHANGE
, "sambaPwdCanChange" },
137 { LDAP_ATTR_PWD_MUST_CHANGE
, "sambaPwdMustChange" },
138 { LDAP_ATTR_LOGON_TIME
, "sambaLogonTime" },
139 { LDAP_ATTR_LOGOFF_TIME
, "sambaLogoffTime" },
140 { LDAP_ATTR_KICKOFF_TIME
, "sambaKickoffTime" },
141 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
142 { LDAP_ATTR_HOME_DRIVE
, "sambaHomeDrive" },
143 { LDAP_ATTR_HOME_PATH
, "sambaHomePath" },
144 { LDAP_ATTR_LOGON_SCRIPT
, "sambaLogonScript" },
145 { LDAP_ATTR_PROFILE_PATH
, "sambaProfilePath" },
146 { LDAP_ATTR_USER_WKS
, "sambaUserWorkstations" },
147 { LDAP_ATTR_USER_SID
, LDAP_ATTRIBUTE_SID
},
148 { LDAP_ATTR_PRIMARY_GROUP_SID
, "sambaPrimaryGroupSID" },
149 { LDAP_ATTR_LMPW
, "sambaLMPassword" },
150 { LDAP_ATTR_NTPW
, "sambaNTPassword" },
151 { LDAP_ATTR_DOMAIN
, "sambaDomainName" },
152 { LDAP_ATTR_ACB_INFO
, "sambaAcctFlags" },
153 { LDAP_ATTR_MUNGED_DIAL
, "sambaMungedDial" },
154 { LDAP_ATTR_BAD_PASSWORD_COUNT
, "sambaBadPasswordCount" },
155 { LDAP_ATTR_BAD_PASSWORD_TIME
, "sambaBadPasswordTime" },
156 { LDAP_ATTR_PWD_HISTORY
, "sambaPasswordHistory" },
157 { LDAP_ATTR_LOGON_HOURS
, "sambaLogonHours" },
158 { LDAP_ATTR_LIST_END
, NULL
}
161 /* attributes used for allocating RIDs */
163 ATTRIB_MAP_ENTRY dominfo_attr_list
[] = {
164 { LDAP_ATTR_DOMAIN
, "sambaDomainName" },
165 { LDAP_ATTR_NEXT_RID
, "sambaNextRid" },
166 { LDAP_ATTR_NEXT_USERRID
, "sambaNextUserRid" },
167 { LDAP_ATTR_NEXT_GROUPRID
, "sambaNextGroupRid" },
168 { LDAP_ATTR_DOM_SID
, LDAP_ATTRIBUTE_SID
},
169 { LDAP_ATTR_ALGORITHMIC_RID_BASE
,"sambaAlgorithmicRidBase"},
170 { LDAP_ATTR_OBJCLASS
, "objectClass" },
171 { LDAP_ATTR_LIST_END
, NULL
},
174 /* Samba 3.0 group mapping attributes */
176 ATTRIB_MAP_ENTRY groupmap_attr_list
[] = {
177 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
178 { LDAP_ATTR_GROUP_SID
, LDAP_ATTRIBUTE_SID
},
179 { LDAP_ATTR_GROUP_TYPE
, "sambaGroupType" },
180 { LDAP_ATTR_SID_LIST
, "sambaSIDList" },
181 { LDAP_ATTR_DESC
, "description" },
182 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
183 { LDAP_ATTR_CN
, "cn" },
184 { LDAP_ATTR_OBJCLASS
, "objectClass" },
185 { LDAP_ATTR_LIST_END
, NULL
}
188 ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete
[] = {
189 { LDAP_ATTR_GROUP_SID
, LDAP_ATTRIBUTE_SID
},
190 { LDAP_ATTR_GROUP_TYPE
, "sambaGroupType" },
191 { LDAP_ATTR_DESC
, "description" },
192 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
193 { LDAP_ATTR_SID_LIST
, "sambaSIDList" },
194 { LDAP_ATTR_LIST_END
, NULL
}
197 /* idmap_ldap sambaUnixIdPool */
199 ATTRIB_MAP_ENTRY idpool_attr_list
[] = {
200 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
201 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
202 { LDAP_ATTR_OBJCLASS
, "objectClass" },
203 { LDAP_ATTR_LIST_END
, NULL
}
206 ATTRIB_MAP_ENTRY sidmap_attr_list
[] = {
207 { LDAP_ATTR_SID
, LDAP_ATTRIBUTE_SID
},
208 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
209 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
210 { LDAP_ATTR_OBJCLASS
, "objectClass" },
211 { LDAP_ATTR_LIST_END
, NULL
}
214 /**********************************************************************
215 perform a simple table lookup and return the attribute name
216 **********************************************************************/
218 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table
[], int key
)
222 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
) {
223 if ( table
[i
].attrib
== key
)
224 return table
[i
].name
;
232 /**********************************************************************
233 Return the list of attribute names from a mapping table
234 **********************************************************************/
236 const char** get_attr_list( TALLOC_CTX
*mem_ctx
, ATTRIB_MAP_ENTRY table
[] )
241 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
)
245 names
= TALLOC_ARRAY( mem_ctx
, const char*, i
);
247 DEBUG(0,("get_attr_list: out of memory\n"));
252 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
) {
253 names
[i
] = talloc_strdup( names
, table
[i
].name
);
261 /*******************************************************************
262 Search an attribute and return the first value found.
263 ******************************************************************/
265 BOOL
smbldap_get_single_attribute (LDAP
* ldap_struct
, LDAPMessage
* entry
,
266 const char *attribute
, char *value
,
276 if ((values
= ldap_get_values (ldap_struct
, entry
, attribute
)) == NULL
) {
277 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute
));
282 if (convert_string(CH_UTF8
, CH_UNIX
,values
[0], -1, value
, max_len
, False
) == (size_t)-1) {
283 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
284 attribute
, values
[0]));
285 ldap_value_free(values
);
289 ldap_value_free(values
);
290 #ifdef DEBUG_PASSWORDS
291 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute
, value
));
296 BOOL
smbldap_get_single_pstring (LDAP
* ldap_struct
, LDAPMessage
* entry
,
297 const char *attribute
, pstring value
)
299 return smbldap_get_single_attribute(ldap_struct
, entry
,
304 char * smbldap_talloc_single_attribute(LDAP
*ldap_struct
, LDAPMessage
*entry
,
305 const char *attribute
,
311 if (attribute
== NULL
) {
315 values
= ldap_get_values(ldap_struct
, entry
, attribute
);
317 if (values
== NULL
) {
318 DEBUG(10, ("attribute %s does not exist\n", attribute
));
322 if (ldap_count_values(values
) != 1) {
323 DEBUG(10, ("attribute %s has %d values, expected only one\n",
324 attribute
, ldap_count_values(values
)));
325 ldap_value_free(values
);
329 if (pull_utf8_talloc(mem_ctx
, &result
, values
[0]) == (size_t)-1) {
330 DEBUG(10, ("pull_utf8_talloc failed\n"));
331 ldap_value_free(values
);
335 ldap_value_free(values
);
337 #ifdef DEBUG_PASSWORDS
338 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
344 static int ldapmsg_destructor(LDAPMessage
**result
) {
345 ldap_msgfree(*result
);
349 void talloc_autofree_ldapmsg(TALLOC_CTX
*mem_ctx
, LDAPMessage
*result
)
351 LDAPMessage
**handle
;
353 if (result
== NULL
) {
357 handle
= TALLOC_P(mem_ctx
, LDAPMessage
*);
358 SMB_ASSERT(handle
!= NULL
);
361 talloc_set_destructor(handle
, ldapmsg_destructor
);
364 static int ldapmod_destructor(LDAPMod
***mod
) {
365 ldap_mods_free(*mod
, True
);
369 void talloc_autofree_ldapmod(TALLOC_CTX
*mem_ctx
, LDAPMod
**mod
)
377 handle
= TALLOC_P(mem_ctx
, LDAPMod
**);
378 SMB_ASSERT(handle
!= NULL
);
381 talloc_set_destructor(handle
, ldapmod_destructor
);
384 /************************************************************************
385 Routine to manage the LDAPMod structure array
386 manage memory used by the array, by each struct, and values
387 ***********************************************************************/
389 void smbldap_set_mod (LDAPMod
*** modlist
, int modop
, const char *attribute
, const char *value
)
397 /* sanity checks on the mod values */
399 if (attribute
== NULL
|| *attribute
== '\0') {
403 #if 0 /* commented out after discussion with abartlet. Do not reenable.
404 left here so other do not re-add similar code --jerry */
405 if (value
== NULL
|| *value
== '\0')
410 mods
= SMB_MALLOC_P(LDAPMod
*);
412 smb_panic("smbldap_set_mod: out of memory!\n");
419 for (i
= 0; mods
[i
] != NULL
; ++i
) {
420 if (mods
[i
]->mod_op
== modop
&& strequal(mods
[i
]->mod_type
, attribute
))
424 if (mods
[i
] == NULL
) {
425 mods
= SMB_REALLOC_ARRAY (mods
, LDAPMod
*, i
+ 2);
427 smb_panic("smbldap_set_mod: out of memory!\n");
431 mods
[i
] = SMB_MALLOC_P(LDAPMod
);
432 if (mods
[i
] == NULL
) {
433 smb_panic("smbldap_set_mod: out of memory!\n");
437 mods
[i
]->mod_op
= modop
;
438 mods
[i
]->mod_values
= NULL
;
439 mods
[i
]->mod_type
= SMB_STRDUP(attribute
);
444 char *utf8_value
= NULL
;
447 if (mods
[i
]->mod_values
!= NULL
) {
448 for (; mods
[i
]->mod_values
[j
] != NULL
; j
++);
450 mods
[i
]->mod_values
= SMB_REALLOC_ARRAY(mods
[i
]->mod_values
, char *, j
+ 2);
452 if (mods
[i
]->mod_values
== NULL
) {
453 smb_panic("smbldap_set_mod: out of memory!\n");
458 if (push_utf8_allocate(&utf8_value
, value
) == (size_t)-1) {
459 smb_panic("smbldap_set_mod: String conversion failure!\n");
464 mods
[i
]->mod_values
[j
] = utf8_value
;
466 mods
[i
]->mod_values
[j
+ 1] = NULL
;
471 /**********************************************************************
472 Set attribute to newval in LDAP, regardless of what value the
473 attribute had in LDAP before.
474 *********************************************************************/
476 void smbldap_make_mod(LDAP
*ldap_struct
, LDAPMessage
*existing
,
478 const char *attribute
, const char *newval
)
480 char oldval
[2048]; /* current largest allowed value is mungeddial */
483 if (attribute
== NULL
) {
484 /* This can actually happen for ldapsam_compat where we for
485 * example don't have a password history */
489 if (existing
!= NULL
) {
490 existed
= smbldap_get_single_attribute(ldap_struct
, existing
, attribute
, oldval
, sizeof(oldval
));
496 /* all of our string attributes are case insensitive */
498 if (existed
&& newval
&& (StrCaseCmp(oldval
, newval
) == 0)) {
500 /* Believe it or not, but LDAP will deny a delete and
501 an add at the same time if the values are the
503 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute
));
508 /* There has been no value before, so don't delete it.
509 * Here's a possible race: We might end up with
510 * duplicate attributes */
511 /* By deleting exactly the value we found in the entry this
512 * should be race-free in the sense that the LDAP-Server will
513 * deny the complete operation if somebody changed the
514 * attribute behind our back. */
515 /* This will also allow modifying single valued attributes
516 * in Novell NDS. In NDS you have to first remove attribute and then
517 * you could add new value */
519 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute
, oldval
));
520 smbldap_set_mod(mods
, LDAP_MOD_DELETE
, attribute
, oldval
);
523 /* Regardless of the real operation (add or modify)
524 we add the new value here. We rely on deleting
525 the old value, should it exist. */
527 if ((newval
!= NULL
) && (strlen(newval
) > 0)) {
528 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute
, newval
));
529 smbldap_set_mod(mods
, LDAP_MOD_ADD
, attribute
, newval
);
533 /**********************************************************************
534 Some varients of the LDAP rebind code do not pass in the third 'arg'
535 pointer to a void*, so we try and work around it by assuming that the
536 value of the 'LDAP *' pointer is the same as the one we had passed in
537 **********************************************************************/
539 struct smbldap_state_lookup
{
541 struct smbldap_state
*smbldap_state
;
542 struct smbldap_state_lookup
*prev
, *next
;
545 static struct smbldap_state_lookup
*smbldap_state_lookup_list
;
547 static struct smbldap_state
*smbldap_find_state(LDAP
*ld
)
549 struct smbldap_state_lookup
*t
;
551 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
553 return t
->smbldap_state
;
559 static void smbldap_delete_state(struct smbldap_state
*smbldap_state
)
561 struct smbldap_state_lookup
*t
;
563 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
564 if (t
->smbldap_state
== smbldap_state
) {
565 DLIST_REMOVE(smbldap_state_lookup_list
, t
);
572 static void smbldap_store_state(LDAP
*ld
, struct smbldap_state
*smbldap_state
)
574 struct smbldap_state
*tmp_ldap_state
;
575 struct smbldap_state_lookup
*t
;
577 if ((tmp_ldap_state
= smbldap_find_state(ld
))) {
578 SMB_ASSERT(tmp_ldap_state
== smbldap_state
);
582 t
= SMB_XMALLOC_P(struct smbldap_state_lookup
);
585 DLIST_ADD_END(smbldap_state_lookup_list
, t
, struct smbldap_state_lookup
*);
587 t
->smbldap_state
= smbldap_state
;
590 /********************************************************************
591 start TLS on an existing LDAP connection
592 *******************************************************************/
594 int smb_ldap_start_tls(LDAP
*ldap_struct
, int version
)
598 if (lp_ldap_ssl() != LDAP_SSL_START_TLS
) {
602 #ifdef LDAP_OPT_X_TLS
603 if (version
!= LDAP_VERSION3
) {
604 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
605 return LDAP_OPERATIONS_ERROR
;
608 if ((rc
= ldap_start_tls_s (ldap_struct
, NULL
, NULL
)) != LDAP_SUCCESS
) {
609 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
610 ldap_err2string(rc
)));
614 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
617 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
618 return LDAP_OPERATIONS_ERROR
;
622 /********************************************************************
623 setup a connection to the LDAP server based on a uri
624 *******************************************************************/
626 int smb_ldap_setup_conn(LDAP
**ldap_struct
, const char *uri
)
630 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri
));
632 #ifdef HAVE_LDAP_INITIALIZE
634 rc
= ldap_initialize(ldap_struct
, uri
);
636 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc
)));
642 /* Parse the string manually */
648 SMB_ASSERT(sizeof(protocol
)>10 && sizeof(host
)>254);
651 /* skip leading "URL:" (if any) */
652 if ( strnequal( uri
, "URL:", 4 ) ) {
656 sscanf(uri
, "%10[^:]://%254[^:/]:%d", protocol
, host
, &port
);
659 if (strequal(protocol
, "ldap")) {
661 } else if (strequal(protocol
, "ldaps")) {
664 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol
));
668 if ((*ldap_struct
= ldap_init(host
, port
)) == NULL
) {
669 DEBUG(0, ("ldap_init failed !\n"));
670 return LDAP_OPERATIONS_ERROR
;
673 if (strequal(protocol
, "ldaps")) {
674 #ifdef LDAP_OPT_X_TLS
675 int tls
= LDAP_OPT_X_TLS_HARD
;
676 if (ldap_set_option (*ldap_struct
, LDAP_OPT_X_TLS
, &tls
) != LDAP_SUCCESS
)
678 DEBUG(0, ("Failed to setup a TLS session\n"));
681 DEBUG(3,("LDAPS option set...!\n"));
683 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
684 return LDAP_OPERATIONS_ERROR
;
685 #endif /* LDAP_OPT_X_TLS */
689 #endif /* HAVE_LDAP_INITIALIZE */
693 /********************************************************************
694 try to upgrade to Version 3 LDAP if not already, in either case return current
696 *******************************************************************/
698 int smb_ldap_upgrade_conn(LDAP
*ldap_struct
, int *new_version
)
703 /* assume the worst */
704 *new_version
= LDAP_VERSION2
;
706 rc
= ldap_get_option(ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
711 if (version
== LDAP_VERSION3
) {
712 *new_version
= LDAP_VERSION3
;
717 version
= LDAP_VERSION3
;
718 rc
= ldap_set_option (ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
723 *new_version
= LDAP_VERSION3
;
727 /*******************************************************************
728 open a connection to the ldap server (just until the bind)
729 ******************************************************************/
731 int smb_ldap_setup_full_conn(LDAP
**ldap_struct
, const char *uri
)
735 rc
= smb_ldap_setup_conn(ldap_struct
, uri
);
740 rc
= smb_ldap_upgrade_conn(*ldap_struct
, &version
);
745 rc
= smb_ldap_start_tls(*ldap_struct
, version
);
753 /*******************************************************************
754 open a connection to the ldap server.
755 ******************************************************************/
756 static int smbldap_open_connection (struct smbldap_state
*ldap_state
)
759 int rc
= LDAP_SUCCESS
;
761 LDAP
**ldap_struct
= &ldap_state
->ldap_struct
;
763 rc
= smb_ldap_setup_conn(ldap_struct
, ldap_state
->uri
);
768 /* Store the LDAP pointer in a lookup list */
770 smbldap_store_state(*ldap_struct
, ldap_state
);
772 /* Upgrade to LDAPv3 if possible */
774 rc
= smb_ldap_upgrade_conn(*ldap_struct
, &version
);
779 /* Start TLS if required */
781 rc
= smb_ldap_start_tls(*ldap_struct
, version
);
786 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
790 /*******************************************************************
791 a rebind function for authenticated referrals
792 This version takes a void* that we can shove useful stuff in :-)
793 ******************************************************************/
794 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
796 static int rebindproc_with_state (LDAP
* ld
, char **whop
, char **credp
,
797 int *methodp
, int freeit
, void *arg
)
799 struct smbldap_state
*ldap_state
= arg
;
801 /** @TODO Should we be doing something to check what servers we rebind to?
802 Could we get a referral to a machine that we don't want to give our
803 username and password to? */
808 memset(*credp
, '\0', strlen(*credp
));
812 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
813 ldap_state
->bind_dn
?ldap_state
->bind_dn
:"[Anonymous bind]"));
815 if (ldap_state
->anonymous
) {
819 *whop
= SMB_STRDUP(ldap_state
->bind_dn
);
821 return LDAP_NO_MEMORY
;
823 *credp
= SMB_STRDUP(ldap_state
->bind_secret
);
826 return LDAP_NO_MEMORY
;
829 *methodp
= LDAP_AUTH_SIMPLE
;
832 GetTimeOfDay(&ldap_state
->last_rebind
);
836 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
838 /*******************************************************************
839 a rebind function for authenticated referrals
840 This version takes a void* that we can shove useful stuff in :-)
841 and actually does the connection.
842 ******************************************************************/
843 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
844 static int rebindproc_connect_with_state (LDAP
*ldap_struct
,
845 LDAP_CONST
char *url
,
847 ber_int_t msgid
, void *arg
)
849 struct smbldap_state
*ldap_state
=
850 (struct smbldap_state
*)arg
;
854 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
855 url
, ldap_state
->bind_dn
?ldap_state
->bind_dn
:"[Anonymous bind]"));
857 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
858 * itself) before rebinding to another LDAP server to avoid to expose
859 * our credentials. At least *try* to secure the connection - Guenther */
861 smb_ldap_upgrade_conn(ldap_struct
, &version
);
862 smb_ldap_start_tls(ldap_struct
, version
);
864 /** @TODO Should we be doing something to check what servers we rebind to?
865 Could we get a referral to a machine that we don't want to give our
866 username and password to? */
868 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
870 /* only set the last rebind timestamp when we did rebind after a
871 * non-read LDAP operation. That way we avoid the replication sleep
872 * after a simple redirected search operation - Guenther */
876 case LDAP_REQ_MODIFY
:
878 case LDAP_REQ_DELETE
:
880 case LDAP_REQ_EXTENDED
:
881 DEBUG(10,("rebindproc_connect_with_state: "
882 "setting last_rebind timestamp "
883 "(req: 0x%02x)\n", (unsigned int)request
));
884 GetTimeOfDay(&ldap_state
->last_rebind
);
887 ZERO_STRUCT(ldap_state
->last_rebind
);
893 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
895 /*******************************************************************
896 Add a rebind function for authenticated referrals
897 ******************************************************************/
898 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
900 # if LDAP_SET_REBIND_PROC_ARGS == 2
901 static int rebindproc (LDAP
*ldap_struct
, char **whop
, char **credp
,
902 int *method
, int freeit
)
904 struct smbldap_state
*ldap_state
= smbldap_find_state(ldap_struct
);
906 return rebindproc_with_state(ldap_struct
, whop
, credp
,
907 method
, freeit
, ldap_state
);
910 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
911 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
913 /*******************************************************************
914 a rebind function for authenticated referrals
915 this also does the connection, but no void*.
916 ******************************************************************/
917 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
918 # if LDAP_SET_REBIND_PROC_ARGS == 2
919 static int rebindproc_connect (LDAP
* ld
, LDAP_CONST
char *url
, int request
,
922 struct smbldap_state
*ldap_state
= smbldap_find_state(ld
);
924 return rebindproc_connect_with_state(ld
, url
, (ber_tag_t
)request
, msgid
,
927 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
928 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
930 /*******************************************************************
931 connect to the ldap server under system privilege.
932 ******************************************************************/
933 static int smbldap_connect_system(struct smbldap_state
*ldap_state
, LDAP
* ldap_struct
)
938 if (!ldap_state
->anonymous
&& !ldap_state
->bind_dn
) {
940 /* get the default dn and password only if they are not set already */
941 if (!fetch_ldap_pw(&ldap_state
->bind_dn
, &ldap_state
->bind_secret
)) {
942 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
943 return LDAP_INVALID_CREDENTIALS
;
947 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
948 (OpenLDAP) doesnt' seem to support it */
950 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
951 ldap_state
->uri
, ldap_state
->bind_dn
));
953 #ifdef HAVE_LDAP_SET_REBIND_PROC
954 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
955 # if LDAP_SET_REBIND_PROC_ARGS == 2
956 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect
);
958 # if LDAP_SET_REBIND_PROC_ARGS == 3
959 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect_with_state
, (void *)ldap_state
);
961 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
962 # if LDAP_SET_REBIND_PROC_ARGS == 2
963 ldap_set_rebind_proc(ldap_struct
, &rebindproc
);
965 # if LDAP_SET_REBIND_PROC_ARGS == 3
966 ldap_set_rebind_proc(ldap_struct
, &rebindproc_with_state
, (void *)ldap_state
);
968 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
971 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
973 if (rc
!= LDAP_SUCCESS
) {
974 char *ld_error
= NULL
;
975 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_ERROR_STRING
,
977 DEBUG(ldap_state
->num_failures
? 2 : 0,
978 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
980 ldap_state
->bind_dn
? ldap_state
->bind_dn
: "[Anonymous bind]",
982 ld_error
? ld_error
: "(unknown)"));
984 ldap_state
->num_failures
++;
988 ldap_state
->num_failures
= 0;
989 ldap_state
->paged_results
= False
;
991 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
993 if (smbldap_has_control(ldap_state
->ldap_struct
, ADS_PAGE_CTL_OID
) && version
== 3) {
994 ldap_state
->paged_results
= True
;
997 DEBUG(3, ("ldap_connect_system: succesful connection to the LDAP server\n"));
998 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
999 ldap_state
->paged_results
? "does" : "does not"));
1003 /**********************************************************************
1004 Connect to LDAP server (called before every ldap operation)
1005 *********************************************************************/
1006 static int smbldap_open(struct smbldap_state
*ldap_state
)
1009 BOOL reopen
= False
;
1010 SMB_ASSERT(ldap_state
);
1012 #ifndef NO_LDAP_SECURITY
1013 if (geteuid() != 0) {
1014 DEBUG(0, ("smbldap_open: cannot access LDAP when not root..\n"));
1015 return LDAP_INSUFFICIENT_ACCESS
;
1019 if ((ldap_state
->ldap_struct
!= NULL
) && ((ldap_state
->last_ping
+ SMBLDAP_DONT_PING_TIME
) < time(NULL
))) {
1021 #ifdef HAVE_UNIXSOCKET
1022 struct sockaddr_un addr
;
1024 struct sockaddr addr
;
1026 socklen_t len
= sizeof(addr
);
1029 opt_rc
= ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_DESC
, &sd
);
1030 if (opt_rc
== 0 && (getpeername(sd
, (struct sockaddr
*) &addr
, &len
)) < 0 )
1033 #ifdef HAVE_UNIXSOCKET
1034 if (opt_rc
== 0 && addr
.sun_family
== AF_UNIX
)
1038 /* the other end has died. reopen. */
1039 ldap_unbind(ldap_state
->ldap_struct
);
1040 ldap_state
->ldap_struct
= NULL
;
1041 ldap_state
->last_ping
= (time_t)0;
1043 ldap_state
->last_ping
= time(NULL
);
1047 if (ldap_state
->ldap_struct
!= NULL
) {
1048 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1049 return LDAP_SUCCESS
;
1052 if ((rc
= smbldap_open_connection(ldap_state
))) {
1056 if ((rc
= smbldap_connect_system(ldap_state
, ldap_state
->ldap_struct
))) {
1057 ldap_unbind(ldap_state
->ldap_struct
);
1058 ldap_state
->ldap_struct
= NULL
;
1063 ldap_state
->last_ping
= time(NULL
);
1064 ldap_state
->pid
= sys_getpid();
1065 DEBUG(4,("The LDAP server is succesfully connected\n"));
1067 return LDAP_SUCCESS
;
1070 /**********************************************************************
1071 Disconnect from LDAP server
1072 *********************************************************************/
1073 static NTSTATUS
smbldap_close(struct smbldap_state
*ldap_state
)
1076 return NT_STATUS_INVALID_PARAMETER
;
1078 if (ldap_state
->ldap_struct
!= NULL
) {
1079 ldap_unbind(ldap_state
->ldap_struct
);
1080 ldap_state
->ldap_struct
= NULL
;
1083 smbldap_delete_state(ldap_state
);
1085 DEBUG(5,("The connection to the LDAP server was closed\n"));
1086 /* maybe free the results here --metze */
1088 return NT_STATUS_OK
;
1091 static BOOL got_alarm
;
1093 static void (*old_handler
)(int);
1095 static void gotalarm_sig(int dummy
)
1100 static int another_ldap_try(struct smbldap_state
*ldap_state
, int *rc
,
1101 int *attempts
, time_t endtime
)
1103 time_t now
= time(NULL
);
1104 int open_rc
= LDAP_SERVER_DOWN
;
1106 if (*rc
!= LDAP_SERVER_DOWN
)
1109 if (now
>= endtime
) {
1110 smbldap_close(ldap_state
);
1115 if (*attempts
== 0) {
1117 old_handler
= CatchSignal(SIGALRM
, gotalarm_sig
);
1118 alarm(endtime
- now
);
1120 if (ldap_state
->pid
!= sys_getpid())
1121 smbldap_close(ldap_state
);
1131 open_rc
= smbldap_open(ldap_state
);
1133 if (open_rc
== LDAP_SUCCESS
) {
1134 ldap_state
->last_use
= now
;
1138 if (open_rc
== LDAP_INSUFFICIENT_ACCESS
) {
1139 /* The fact that we are non-root or any other
1140 * access-denied condition will not change in the next
1141 * round of trying */
1151 if (open_rc
!= LDAP_SUCCESS
) {
1152 DEBUG(1, ("Connection to LDAP server failed for the "
1153 "%d try!\n", *attempts
));
1158 CatchSignal(SIGALRM
, old_handler
);
1160 ldap_state
->last_use
= now
;
1164 /*********************************************************************
1165 ********************************************************************/
1167 static int smbldap_search_ext(struct smbldap_state
*ldap_state
,
1168 const char *base
, int scope
, const char *filter
,
1169 const char *attrs
[], int attrsonly
,
1170 LDAPControl
**sctrls
, LDAPControl
**cctrls
,
1171 int sizelimit
, LDAPMessage
**res
)
1173 int rc
= LDAP_SERVER_DOWN
;
1176 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1177 struct timeval timeout
;
1179 SMB_ASSERT(ldap_state
);
1181 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1182 "scope => [%d]\n", base
, filter
, scope
));
1184 if (ldap_state
->last_rebind
.tv_sec
> 0) {
1185 struct timeval tval
;
1186 SMB_BIG_INT tdiff
= 0;
1190 GetTimeOfDay(&tval
);
1192 tdiff
= usec_time_diff(&tval
, &ldap_state
->last_rebind
);
1193 tdiff
/= 1000; /* Convert to milliseconds. */
1195 sleep_time
= lp_ldap_replication_sleep()-(int)tdiff
;
1196 sleep_time
= MIN(sleep_time
, MAX_LDAP_REPLICATION_SLEEP_TIME
);
1198 if (sleep_time
> 0) {
1199 /* we wait for the LDAP replication */
1200 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1201 "for LDAP replication.\n",sleep_time
));
1202 smb_msleep(sleep_time
);
1203 DEBUG(5,("smbldap_search_ext: go on!\n"));
1205 ZERO_STRUCT(ldap_state
->last_rebind
);
1208 if (push_utf8_allocate(&utf8_filter
, filter
) == (size_t)-1) {
1209 return LDAP_NO_MEMORY
;
1212 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1213 timeout
.tv_sec
= lp_ldap_timeout();
1214 timeout
.tv_usec
= 0;
1216 /* Setup alarm timeout.... Do we need both of these ? JRA.
1217 * Yes, I think we do need both of these. The server timeout only
1218 * covers the case where the server's operation takes too long. It
1219 * does not cover the case where the request hangs on its way to the
1220 * server. The server side timeout is not strictly necessary, it's
1221 * just a bit more kind to the server. VL. */
1224 CatchSignal(SIGALRM
, SIGNAL_CAST gotalarm_sig
);
1225 alarm(lp_ldap_timeout());
1226 /* End setup timeout. */
1228 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1229 rc
= ldap_search_ext_s(ldap_state
->ldap_struct
, base
, scope
,
1231 CONST_DISCARD(char **, attrs
),
1232 attrsonly
, sctrls
, cctrls
, &timeout
,
1234 if (rc
!= LDAP_SUCCESS
) {
1235 char *ld_error
= NULL
;
1238 ldap_get_option(ldap_state
->ldap_struct
,
1239 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1241 ldap_get_option(ldap_state
->ldap_struct
,
1242 LDAP_OPT_ERROR_STRING
, &ld_error
);
1243 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1244 "(%s)\n", base
, ld_errno
,
1245 ldap_err2string(rc
),
1246 ld_error
? ld_error
: "unknown"));
1247 SAFE_FREE(ld_error
);
1249 if (ld_errno
== LDAP_SERVER_DOWN
) {
1250 ldap_unbind(ldap_state
->ldap_struct
);
1251 ldap_state
->ldap_struct
= NULL
;
1256 SAFE_FREE(utf8_filter
);
1258 /* Teardown timeout. */
1259 CatchSignal(SIGALRM
, SIGNAL_CAST SIG_IGN
);
1263 return LDAP_TIMELIMIT_EXCEEDED
;
1268 int smbldap_search(struct smbldap_state
*ldap_state
,
1269 const char *base
, int scope
, const char *filter
,
1270 const char *attrs
[], int attrsonly
,
1273 return smbldap_search_ext(ldap_state
, base
, scope
, filter
, attrs
,
1274 attrsonly
, NULL
, NULL
, LDAP_NO_LIMIT
, res
);
1277 int smbldap_search_paged(struct smbldap_state
*ldap_state
,
1278 const char *base
, int scope
, const char *filter
,
1279 const char **attrs
, int attrsonly
, int pagesize
,
1280 LDAPMessage
**res
, void **cookie
)
1283 LDAPControl
**rcontrols
;
1284 LDAPControl
*controls
[2] = { NULL
, NULL
};
1285 BerElement
*cookie_be
= NULL
;
1286 struct berval
*cookie_bv
= NULL
;
1288 BOOL critical
= True
;
1292 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1293 "scope => [%d], pagesize => [%d]\n",
1294 base
, filter
, scope
, pagesize
));
1296 cookie_be
= ber_alloc_t(LBER_USE_DER
);
1297 if (cookie_be
== NULL
) {
1298 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1300 return LDAP_NO_MEMORY
;
1303 /* construct cookie */
1304 if (*cookie
!= NULL
) {
1305 ber_printf(cookie_be
, "{iO}", (ber_int_t
) pagesize
, *cookie
);
1306 ber_bvfree((struct berval
*)*cookie
); /* don't need it from last time */
1309 ber_printf(cookie_be
, "{io}", (ber_int_t
) pagesize
, "", 0);
1311 ber_flatten(cookie_be
, &cookie_bv
);
1313 pr
.ldctl_oid
= CONST_DISCARD(char *, ADS_PAGE_CTL_OID
);
1314 pr
.ldctl_iscritical
= (char) critical
;
1315 pr
.ldctl_value
.bv_len
= cookie_bv
->bv_len
;
1316 pr
.ldctl_value
.bv_val
= cookie_bv
->bv_val
;
1321 rc
= smbldap_search_ext(ldap_state
, base
, scope
, filter
, attrs
,
1322 0, controls
, NULL
, LDAP_NO_LIMIT
, res
);
1324 ber_free(cookie_be
, 1);
1325 ber_bvfree(cookie_bv
);
1328 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1329 "failed with [%s]\n", filter
, ldap_err2string(rc
)));
1333 DEBUG(3,("smbldap_search_paged: search was successfull\n"));
1335 rc
= ldap_parse_result(ldap_state
->ldap_struct
, *res
, NULL
, NULL
,
1336 NULL
, NULL
, &rcontrols
, 0);
1338 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1339 "with [%s]\n", ldap_err2string(rc
)));
1343 if (rcontrols
== NULL
)
1346 for (i
=0; rcontrols
[i
]; i
++) {
1348 if (strcmp(ADS_PAGE_CTL_OID
, rcontrols
[i
]->ldctl_oid
) != 0)
1351 cookie_be
= ber_init(&rcontrols
[i
]->ldctl_value
);
1352 ber_scanf(cookie_be
,"{iO}", &tmp
, &cookie_bv
);
1353 /* the berval is the cookie, but must be freed when it is all
1355 if (cookie_bv
->bv_len
)
1356 *cookie
=ber_bvdup(cookie_bv
);
1359 ber_bvfree(cookie_bv
);
1360 ber_free(cookie_be
, 1);
1363 ldap_controls_free(rcontrols
);
1368 int smbldap_modify(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
1370 int rc
= LDAP_SERVER_DOWN
;
1373 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1375 SMB_ASSERT(ldap_state
);
1377 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn
));
1379 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1380 return LDAP_NO_MEMORY
;
1383 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1384 rc
= ldap_modify_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
1385 if (rc
!= LDAP_SUCCESS
) {
1386 char *ld_error
= NULL
;
1389 ldap_get_option(ldap_state
->ldap_struct
,
1390 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1392 ldap_get_option(ldap_state
->ldap_struct
,
1393 LDAP_OPT_ERROR_STRING
, &ld_error
);
1394 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1395 "(%s)\n", dn
, ld_errno
,
1396 ldap_err2string(rc
),
1397 ld_error
? ld_error
: "unknown"));
1398 SAFE_FREE(ld_error
);
1400 if (ld_errno
== LDAP_SERVER_DOWN
) {
1401 ldap_unbind(ldap_state
->ldap_struct
);
1402 ldap_state
->ldap_struct
= NULL
;
1411 int smbldap_add(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
1413 int rc
= LDAP_SERVER_DOWN
;
1416 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1418 SMB_ASSERT(ldap_state
);
1420 DEBUG(5,("smbldap_add: dn => [%s]\n", dn
));
1422 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1423 return LDAP_NO_MEMORY
;
1426 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1427 rc
= ldap_add_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
1428 if (rc
!= LDAP_SUCCESS
) {
1429 char *ld_error
= NULL
;
1432 ldap_get_option(ldap_state
->ldap_struct
,
1433 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1435 ldap_get_option(ldap_state
->ldap_struct
,
1436 LDAP_OPT_ERROR_STRING
, &ld_error
);
1437 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1438 "(%s)\n", dn
, ld_errno
,
1439 ldap_err2string(rc
),
1440 ld_error
? ld_error
: "unknown"));
1441 SAFE_FREE(ld_error
);
1443 if (ld_errno
== LDAP_SERVER_DOWN
) {
1444 ldap_unbind(ldap_state
->ldap_struct
);
1445 ldap_state
->ldap_struct
= NULL
;
1454 int smbldap_delete(struct smbldap_state
*ldap_state
, const char *dn
)
1456 int rc
= LDAP_SERVER_DOWN
;
1459 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1461 SMB_ASSERT(ldap_state
);
1463 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn
));
1465 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1466 return LDAP_NO_MEMORY
;
1469 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1470 rc
= ldap_delete_s(ldap_state
->ldap_struct
, utf8_dn
);
1471 if (rc
!= LDAP_SUCCESS
) {
1472 char *ld_error
= NULL
;
1475 ldap_get_option(ldap_state
->ldap_struct
,
1476 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1478 ldap_get_option(ldap_state
->ldap_struct
,
1479 LDAP_OPT_ERROR_STRING
, &ld_error
);
1480 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1481 "(%s)\n", dn
, ld_errno
,
1482 ldap_err2string(rc
),
1483 ld_error
? ld_error
: "unknown"));
1484 SAFE_FREE(ld_error
);
1486 if (ld_errno
== LDAP_SERVER_DOWN
) {
1487 ldap_unbind(ldap_state
->ldap_struct
);
1488 ldap_state
->ldap_struct
= NULL
;
1497 int smbldap_extended_operation(struct smbldap_state
*ldap_state
,
1498 LDAP_CONST
char *reqoid
, struct berval
*reqdata
,
1499 LDAPControl
**serverctrls
, LDAPControl
**clientctrls
,
1500 char **retoidp
, struct berval
**retdatap
)
1502 int rc
= LDAP_SERVER_DOWN
;
1504 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1509 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1510 rc
= ldap_extended_operation_s(ldap_state
->ldap_struct
, reqoid
,
1511 reqdata
, serverctrls
,
1512 clientctrls
, retoidp
, retdatap
);
1513 if (rc
!= LDAP_SUCCESS
) {
1514 char *ld_error
= NULL
;
1517 ldap_get_option(ldap_state
->ldap_struct
,
1518 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1520 ldap_get_option(ldap_state
->ldap_struct
,
1521 LDAP_OPT_ERROR_STRING
, &ld_error
);
1522 DEBUG(10, ("Extended operation failed with error: "
1523 "%d (%s) (%s)\n", ld_errno
,
1524 ldap_err2string(rc
),
1525 ld_error
? ld_error
: "unknown"));
1526 SAFE_FREE(ld_error
);
1528 if (ld_errno
== LDAP_SERVER_DOWN
) {
1529 ldap_unbind(ldap_state
->ldap_struct
);
1530 ldap_state
->ldap_struct
= NULL
;
1538 /*******************************************************************
1539 run the search by name.
1540 ******************************************************************/
1541 int smbldap_search_suffix (struct smbldap_state
*ldap_state
,
1542 const char *filter
, const char **search_attr
,
1543 LDAPMessage
** result
)
1545 return smbldap_search(ldap_state
, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE
,
1546 filter
, search_attr
, 0, result
);
1549 static void smbldap_idle_fn(void **data
, time_t *interval
, time_t now
)
1551 struct smbldap_state
*state
= (struct smbldap_state
*)(*data
);
1553 if (state
->ldap_struct
== NULL
) {
1554 DEBUG(10,("ldap connection not connected...\n"));
1558 if ((state
->last_use
+SMBLDAP_IDLE_TIME
) > now
) {
1559 DEBUG(10,("ldap connection not idle...\n"));
1563 DEBUG(7,("ldap connection idle...closing connection\n"));
1564 smbldap_close(state
);
1567 /**********************************************************************
1569 *********************************************************************/
1571 void smbldap_free_struct(struct smbldap_state
**ldap_state
)
1573 smbldap_close(*ldap_state
);
1575 if ((*ldap_state
)->bind_secret
) {
1576 memset((*ldap_state
)->bind_secret
, '\0', strlen((*ldap_state
)->bind_secret
));
1579 SAFE_FREE((*ldap_state
)->bind_dn
);
1580 SAFE_FREE((*ldap_state
)->bind_secret
);
1582 smb_unregister_idle_event((*ldap_state
)->event_id
);
1586 /* No need to free any further, as it is talloc()ed */
1590 /**********************************************************************
1591 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1592 *********************************************************************/
1594 NTSTATUS
smbldap_init(TALLOC_CTX
*mem_ctx
, const char *location
, struct smbldap_state
**smbldap_state
)
1596 *smbldap_state
= TALLOC_ZERO_P(mem_ctx
, struct smbldap_state
);
1597 if (!*smbldap_state
) {
1598 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1599 return NT_STATUS_NO_MEMORY
;
1603 (*smbldap_state
)->uri
= talloc_strdup(mem_ctx
, location
);
1605 (*smbldap_state
)->uri
= "ldap://localhost";
1608 (*smbldap_state
)->event_id
=
1609 smb_register_idle_event(smbldap_idle_fn
, (void *)(*smbldap_state
),
1612 if ((*smbldap_state
)->event_id
== SMB_EVENT_ID_INVALID
) {
1613 DEBUG(0,("Failed to register LDAP idle event!\n"));
1614 return NT_STATUS_INVALID_HANDLE
;
1617 return NT_STATUS_OK
;
1620 /*******************************************************************
1621 Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1622 ********************************************************************/
1623 char *smbldap_get_dn(LDAP
*ld
, LDAPMessage
*entry
)
1625 char *utf8_dn
, *unix_dn
;
1627 utf8_dn
= ldap_get_dn(ld
, entry
);
1629 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1632 if (pull_utf8_allocate(&unix_dn
, utf8_dn
) == (size_t)-1) {
1633 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 [%s]\n", utf8_dn
));
1636 ldap_memfree(utf8_dn
);
1640 const char *smbldap_talloc_dn(TALLOC_CTX
*mem_ctx
, LDAP
*ld
,
1643 char *utf8_dn
, *unix_dn
;
1645 utf8_dn
= ldap_get_dn(ld
, entry
);
1647 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1650 if (pull_utf8_talloc(mem_ctx
, &unix_dn
, utf8_dn
) == (size_t)-1) {
1651 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1652 "[%s]\n", utf8_dn
));
1655 ldap_memfree(utf8_dn
);
1659 /*******************************************************************
1660 Check if root-dse has a certain Control or Extension
1661 ********************************************************************/
1663 static BOOL
smbldap_check_root_dse(LDAP
*ld
, const char **attrs
, const char *value
)
1665 LDAPMessage
*msg
= NULL
;
1666 LDAPMessage
*entry
= NULL
;
1667 char **values
= NULL
;
1668 int rc
, num_result
, num_values
, i
;
1669 BOOL result
= False
;
1672 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1676 if (!strequal(attrs
[0], "supportedExtension") &&
1677 !strequal(attrs
[0], "supportedControl") &&
1678 !strequal(attrs
[0], "namingContexts")) {
1679 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs
[0]));
1683 rc
= ldap_search_s(ld
, "", LDAP_SCOPE_BASE
,
1684 "(objectclass=*)", CONST_DISCARD(char **, attrs
), 0 , &msg
);
1686 if (rc
!= LDAP_SUCCESS
) {
1687 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1691 num_result
= ldap_count_entries(ld
, msg
);
1693 if (num_result
!= 1) {
1694 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result
));
1698 entry
= ldap_first_entry(ld
, msg
);
1700 if (entry
== NULL
) {
1701 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1705 values
= ldap_get_values(ld
, entry
, attrs
[0]);
1707 if (values
== NULL
) {
1708 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs
[0]));
1712 num_values
= ldap_count_values(values
);
1714 if (num_values
== 0) {
1715 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs
[0]));
1719 for (i
=0; i
<num_values
; i
++) {
1720 if (strcmp(values
[i
], value
) == 0)
1727 ldap_value_free(values
);
1735 /*******************************************************************
1736 Check if LDAP-Server supports a certain Control (OID in string format)
1737 ********************************************************************/
1739 BOOL
smbldap_has_control(LDAP
*ld
, const char *control
)
1741 const char *attrs
[] = { "supportedControl", NULL
};
1742 return smbldap_check_root_dse(ld
, attrs
, control
);
1745 /*******************************************************************
1746 Check if LDAP-Server supports a certain Extension (OID in string format)
1747 ********************************************************************/
1749 BOOL
smbldap_has_extension(LDAP
*ld
, const char *extension
)
1751 const char *attrs
[] = { "supportedExtension", NULL
};
1752 return smbldap_check_root_dse(ld
, attrs
, extension
);
1755 /*******************************************************************
1756 Check if LDAP-Server holds a given namingContext
1757 ********************************************************************/
1759 BOOL
smbldap_has_naming_context(LDAP
*ld
, const char *naming_context
)
1761 const char *attrs
[] = { "namingContexts", NULL
};
1762 return smbldap_check_root_dse(ld
, attrs
, naming_context
);
1765 BOOL
smbldap_set_creds(struct smbldap_state
*ldap_state
, BOOL anon
, const char *dn
, const char *secret
)
1767 ldap_state
->anonymous
= anon
;
1769 /* free any previously set credential */
1771 SAFE_FREE(ldap_state
->bind_dn
);
1772 if (ldap_state
->bind_secret
) {
1773 /* make sure secrets are zeroed out of memory */
1774 memset(ldap_state
->bind_secret
, '\0', strlen(ldap_state
->bind_secret
));
1775 SAFE_FREE(ldap_state
->bind_secret
);
1779 ldap_state
->bind_dn
= SMB_STRDUP(dn
);
1780 ldap_state
->bind_secret
= SMB_STRDUP(secret
);