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!");
418 for (i
= 0; mods
[i
] != NULL
; ++i
) {
419 if (mods
[i
]->mod_op
== modop
&& strequal(mods
[i
]->mod_type
, attribute
))
423 if (mods
[i
] == NULL
) {
424 mods
= SMB_REALLOC_ARRAY (mods
, LDAPMod
*, i
+ 2);
426 smb_panic("smbldap_set_mod: out of memory!");
429 mods
[i
] = SMB_MALLOC_P(LDAPMod
);
430 if (mods
[i
] == NULL
) {
431 smb_panic("smbldap_set_mod: out of memory!");
434 mods
[i
]->mod_op
= modop
;
435 mods
[i
]->mod_values
= NULL
;
436 mods
[i
]->mod_type
= SMB_STRDUP(attribute
);
441 char *utf8_value
= NULL
;
444 if (mods
[i
]->mod_values
!= NULL
) {
445 for (; mods
[i
]->mod_values
[j
] != NULL
; j
++);
447 mods
[i
]->mod_values
= SMB_REALLOC_ARRAY(mods
[i
]->mod_values
, char *, j
+ 2);
449 if (mods
[i
]->mod_values
== NULL
) {
450 smb_panic("smbldap_set_mod: out of memory!");
454 if (push_utf8_allocate(&utf8_value
, value
) == (size_t)-1) {
455 smb_panic("smbldap_set_mod: String conversion failure!");
459 mods
[i
]->mod_values
[j
] = utf8_value
;
461 mods
[i
]->mod_values
[j
+ 1] = NULL
;
466 /**********************************************************************
467 Set attribute to newval in LDAP, regardless of what value the
468 attribute had in LDAP before.
469 *********************************************************************/
471 void smbldap_make_mod(LDAP
*ldap_struct
, LDAPMessage
*existing
,
473 const char *attribute
, const char *newval
)
475 char oldval
[2048]; /* current largest allowed value is mungeddial */
478 if (attribute
== NULL
) {
479 /* This can actually happen for ldapsam_compat where we for
480 * example don't have a password history */
484 if (existing
!= NULL
) {
485 existed
= smbldap_get_single_attribute(ldap_struct
, existing
, attribute
, oldval
, sizeof(oldval
));
491 /* all of our string attributes are case insensitive */
493 if (existed
&& newval
&& (StrCaseCmp(oldval
, newval
) == 0)) {
495 /* Believe it or not, but LDAP will deny a delete and
496 an add at the same time if the values are the
498 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute
));
503 /* There has been no value before, so don't delete it.
504 * Here's a possible race: We might end up with
505 * duplicate attributes */
506 /* By deleting exactly the value we found in the entry this
507 * should be race-free in the sense that the LDAP-Server will
508 * deny the complete operation if somebody changed the
509 * attribute behind our back. */
510 /* This will also allow modifying single valued attributes
511 * in Novell NDS. In NDS you have to first remove attribute and then
512 * you could add new value */
514 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute
, oldval
));
515 smbldap_set_mod(mods
, LDAP_MOD_DELETE
, attribute
, oldval
);
518 /* Regardless of the real operation (add or modify)
519 we add the new value here. We rely on deleting
520 the old value, should it exist. */
522 if ((newval
!= NULL
) && (strlen(newval
) > 0)) {
523 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute
, newval
));
524 smbldap_set_mod(mods
, LDAP_MOD_ADD
, attribute
, newval
);
528 /**********************************************************************
529 Some varients of the LDAP rebind code do not pass in the third 'arg'
530 pointer to a void*, so we try and work around it by assuming that the
531 value of the 'LDAP *' pointer is the same as the one we had passed in
532 **********************************************************************/
534 struct smbldap_state_lookup
{
536 struct smbldap_state
*smbldap_state
;
537 struct smbldap_state_lookup
*prev
, *next
;
540 static struct smbldap_state_lookup
*smbldap_state_lookup_list
;
542 static struct smbldap_state
*smbldap_find_state(LDAP
*ld
)
544 struct smbldap_state_lookup
*t
;
546 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
548 return t
->smbldap_state
;
554 static void smbldap_delete_state(struct smbldap_state
*smbldap_state
)
556 struct smbldap_state_lookup
*t
;
558 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
559 if (t
->smbldap_state
== smbldap_state
) {
560 DLIST_REMOVE(smbldap_state_lookup_list
, t
);
567 static void smbldap_store_state(LDAP
*ld
, struct smbldap_state
*smbldap_state
)
569 struct smbldap_state
*tmp_ldap_state
;
570 struct smbldap_state_lookup
*t
;
572 if ((tmp_ldap_state
= smbldap_find_state(ld
))) {
573 SMB_ASSERT(tmp_ldap_state
== smbldap_state
);
577 t
= SMB_XMALLOC_P(struct smbldap_state_lookup
);
580 DLIST_ADD_END(smbldap_state_lookup_list
, t
, struct smbldap_state_lookup
*);
582 t
->smbldap_state
= smbldap_state
;
585 /********************************************************************
586 start TLS on an existing LDAP connection
587 *******************************************************************/
589 int smb_ldap_start_tls(LDAP
*ldap_struct
, int version
)
593 if (lp_ldap_ssl() != LDAP_SSL_START_TLS
) {
597 #ifdef LDAP_OPT_X_TLS
598 if (version
!= LDAP_VERSION3
) {
599 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
600 return LDAP_OPERATIONS_ERROR
;
603 if ((rc
= ldap_start_tls_s (ldap_struct
, NULL
, NULL
)) != LDAP_SUCCESS
) {
604 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
605 ldap_err2string(rc
)));
609 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
612 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
613 return LDAP_OPERATIONS_ERROR
;
617 /********************************************************************
618 setup a connection to the LDAP server based on a uri
619 *******************************************************************/
621 int smb_ldap_setup_conn(LDAP
**ldap_struct
, const char *uri
)
625 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri
));
627 #ifdef HAVE_LDAP_INITIALIZE
629 rc
= ldap_initialize(ldap_struct
, uri
);
631 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc
)));
637 /* Parse the string manually */
643 SMB_ASSERT(sizeof(protocol
)>10 && sizeof(host
)>254);
646 /* skip leading "URL:" (if any) */
647 if ( strnequal( uri
, "URL:", 4 ) ) {
651 sscanf(uri
, "%10[^:]://%254[^:/]:%d", protocol
, host
, &port
);
654 if (strequal(protocol
, "ldap")) {
656 } else if (strequal(protocol
, "ldaps")) {
659 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol
));
663 if ((*ldap_struct
= ldap_init(host
, port
)) == NULL
) {
664 DEBUG(0, ("ldap_init failed !\n"));
665 return LDAP_OPERATIONS_ERROR
;
668 if (strequal(protocol
, "ldaps")) {
669 #ifdef LDAP_OPT_X_TLS
670 int tls
= LDAP_OPT_X_TLS_HARD
;
671 if (ldap_set_option (*ldap_struct
, LDAP_OPT_X_TLS
, &tls
) != LDAP_SUCCESS
)
673 DEBUG(0, ("Failed to setup a TLS session\n"));
676 DEBUG(3,("LDAPS option set...!\n"));
678 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
679 return LDAP_OPERATIONS_ERROR
;
680 #endif /* LDAP_OPT_X_TLS */
684 #endif /* HAVE_LDAP_INITIALIZE */
688 /********************************************************************
689 try to upgrade to Version 3 LDAP if not already, in either case return current
691 *******************************************************************/
693 int smb_ldap_upgrade_conn(LDAP
*ldap_struct
, int *new_version
)
698 /* assume the worst */
699 *new_version
= LDAP_VERSION2
;
701 rc
= ldap_get_option(ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
706 if (version
== LDAP_VERSION3
) {
707 *new_version
= LDAP_VERSION3
;
712 version
= LDAP_VERSION3
;
713 rc
= ldap_set_option (ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
718 *new_version
= LDAP_VERSION3
;
722 /*******************************************************************
723 open a connection to the ldap server (just until the bind)
724 ******************************************************************/
726 int smb_ldap_setup_full_conn(LDAP
**ldap_struct
, const char *uri
)
730 rc
= smb_ldap_setup_conn(ldap_struct
, uri
);
735 rc
= smb_ldap_upgrade_conn(*ldap_struct
, &version
);
740 rc
= smb_ldap_start_tls(*ldap_struct
, version
);
748 /*******************************************************************
749 open a connection to the ldap server.
750 ******************************************************************/
751 static int smbldap_open_connection (struct smbldap_state
*ldap_state
)
754 int rc
= LDAP_SUCCESS
;
756 LDAP
**ldap_struct
= &ldap_state
->ldap_struct
;
758 rc
= smb_ldap_setup_conn(ldap_struct
, ldap_state
->uri
);
763 /* Store the LDAP pointer in a lookup list */
765 smbldap_store_state(*ldap_struct
, ldap_state
);
767 /* Upgrade to LDAPv3 if possible */
769 rc
= smb_ldap_upgrade_conn(*ldap_struct
, &version
);
774 /* Start TLS if required */
776 rc
= smb_ldap_start_tls(*ldap_struct
, version
);
781 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
785 /*******************************************************************
786 a rebind function for authenticated referrals
787 This version takes a void* that we can shove useful stuff in :-)
788 ******************************************************************/
789 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
791 static int rebindproc_with_state (LDAP
* ld
, char **whop
, char **credp
,
792 int *methodp
, int freeit
, void *arg
)
794 struct smbldap_state
*ldap_state
= arg
;
796 /** @TODO Should we be doing something to check what servers we rebind to?
797 Could we get a referral to a machine that we don't want to give our
798 username and password to? */
803 memset(*credp
, '\0', strlen(*credp
));
807 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
808 ldap_state
->bind_dn
?ldap_state
->bind_dn
:"[Anonymous bind]"));
810 if (ldap_state
->anonymous
) {
814 *whop
= SMB_STRDUP(ldap_state
->bind_dn
);
816 return LDAP_NO_MEMORY
;
818 *credp
= SMB_STRDUP(ldap_state
->bind_secret
);
821 return LDAP_NO_MEMORY
;
824 *methodp
= LDAP_AUTH_SIMPLE
;
827 GetTimeOfDay(&ldap_state
->last_rebind
);
831 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
833 /*******************************************************************
834 a rebind function for authenticated referrals
835 This version takes a void* that we can shove useful stuff in :-)
836 and actually does the connection.
837 ******************************************************************/
838 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
839 static int rebindproc_connect_with_state (LDAP
*ldap_struct
,
840 LDAP_CONST
char *url
,
842 ber_int_t msgid
, void *arg
)
844 struct smbldap_state
*ldap_state
=
845 (struct smbldap_state
*)arg
;
849 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
850 url
, ldap_state
->bind_dn
?ldap_state
->bind_dn
:"[Anonymous bind]"));
852 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
853 * itself) before rebinding to another LDAP server to avoid to expose
854 * our credentials. At least *try* to secure the connection - Guenther */
856 smb_ldap_upgrade_conn(ldap_struct
, &version
);
857 smb_ldap_start_tls(ldap_struct
, version
);
859 /** @TODO Should we be doing something to check what servers we rebind to?
860 Could we get a referral to a machine that we don't want to give our
861 username and password to? */
863 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
865 /* only set the last rebind timestamp when we did rebind after a
866 * non-read LDAP operation. That way we avoid the replication sleep
867 * after a simple redirected search operation - Guenther */
871 case LDAP_REQ_MODIFY
:
873 case LDAP_REQ_DELETE
:
875 case LDAP_REQ_EXTENDED
:
876 DEBUG(10,("rebindproc_connect_with_state: "
877 "setting last_rebind timestamp "
878 "(req: 0x%02x)\n", (unsigned int)request
));
879 GetTimeOfDay(&ldap_state
->last_rebind
);
882 ZERO_STRUCT(ldap_state
->last_rebind
);
888 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
890 /*******************************************************************
891 Add a rebind function for authenticated referrals
892 ******************************************************************/
893 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
895 # if LDAP_SET_REBIND_PROC_ARGS == 2
896 static int rebindproc (LDAP
*ldap_struct
, char **whop
, char **credp
,
897 int *method
, int freeit
)
899 struct smbldap_state
*ldap_state
= smbldap_find_state(ldap_struct
);
901 return rebindproc_with_state(ldap_struct
, whop
, credp
,
902 method
, freeit
, ldap_state
);
905 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
906 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
908 /*******************************************************************
909 a rebind function for authenticated referrals
910 this also does the connection, but no void*.
911 ******************************************************************/
912 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
913 # if LDAP_SET_REBIND_PROC_ARGS == 2
914 static int rebindproc_connect (LDAP
* ld
, LDAP_CONST
char *url
, int request
,
917 struct smbldap_state
*ldap_state
= smbldap_find_state(ld
);
919 return rebindproc_connect_with_state(ld
, url
, (ber_tag_t
)request
, msgid
,
922 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
923 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
925 /*******************************************************************
926 connect to the ldap server under system privilege.
927 ******************************************************************/
928 static int smbldap_connect_system(struct smbldap_state
*ldap_state
, LDAP
* ldap_struct
)
933 if (!ldap_state
->anonymous
&& !ldap_state
->bind_dn
) {
935 /* get the default dn and password only if they are not set already */
936 if (!fetch_ldap_pw(&ldap_state
->bind_dn
, &ldap_state
->bind_secret
)) {
937 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
938 return LDAP_INVALID_CREDENTIALS
;
942 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
943 (OpenLDAP) doesnt' seem to support it */
945 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
946 ldap_state
->uri
, ldap_state
->bind_dn
));
948 #ifdef HAVE_LDAP_SET_REBIND_PROC
949 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
950 # if LDAP_SET_REBIND_PROC_ARGS == 2
951 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect
);
953 # if LDAP_SET_REBIND_PROC_ARGS == 3
954 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect_with_state
, (void *)ldap_state
);
956 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
957 # if LDAP_SET_REBIND_PROC_ARGS == 2
958 ldap_set_rebind_proc(ldap_struct
, &rebindproc
);
960 # if LDAP_SET_REBIND_PROC_ARGS == 3
961 ldap_set_rebind_proc(ldap_struct
, &rebindproc_with_state
, (void *)ldap_state
);
963 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
966 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
968 if (rc
!= LDAP_SUCCESS
) {
969 char *ld_error
= NULL
;
970 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_ERROR_STRING
,
972 DEBUG(ldap_state
->num_failures
? 2 : 0,
973 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
975 ldap_state
->bind_dn
? ldap_state
->bind_dn
: "[Anonymous bind]",
977 ld_error
? ld_error
: "(unknown)"));
979 ldap_state
->num_failures
++;
983 ldap_state
->num_failures
= 0;
984 ldap_state
->paged_results
= False
;
986 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
988 if (smbldap_has_control(ldap_state
->ldap_struct
, ADS_PAGE_CTL_OID
) && version
== 3) {
989 ldap_state
->paged_results
= True
;
992 DEBUG(3, ("ldap_connect_system: succesful connection to the LDAP server\n"));
993 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
994 ldap_state
->paged_results
? "does" : "does not"));
998 static void smbldap_idle_fn(struct event_context
*event_ctx
,
999 struct timed_event
*te
,
1000 const struct timeval
*now
,
1001 void *private_data
);
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();
1066 TALLOC_FREE(ldap_state
->idle_event
);
1068 if (ldap_state
->event_context
!= NULL
) {
1069 ldap_state
->idle_event
= event_add_timed(
1070 ldap_state
->event_context
, NULL
,
1071 timeval_current_ofs(SMBLDAP_IDLE_TIME
, 0),
1072 "smbldap_idle_fn", smbldap_idle_fn
, ldap_state
);
1075 DEBUG(4,("The LDAP server is succesfully connected\n"));
1077 return LDAP_SUCCESS
;
1080 /**********************************************************************
1081 Disconnect from LDAP server
1082 *********************************************************************/
1083 static NTSTATUS
smbldap_close(struct smbldap_state
*ldap_state
)
1086 return NT_STATUS_INVALID_PARAMETER
;
1088 if (ldap_state
->ldap_struct
!= NULL
) {
1089 ldap_unbind(ldap_state
->ldap_struct
);
1090 ldap_state
->ldap_struct
= NULL
;
1093 smbldap_delete_state(ldap_state
);
1095 DEBUG(5,("The connection to the LDAP server was closed\n"));
1096 /* maybe free the results here --metze */
1098 return NT_STATUS_OK
;
1101 static BOOL got_alarm
;
1103 static void (*old_handler
)(int);
1105 static void gotalarm_sig(int dummy
)
1110 static int another_ldap_try(struct smbldap_state
*ldap_state
, int *rc
,
1111 int *attempts
, time_t endtime
)
1113 time_t now
= time(NULL
);
1114 int open_rc
= LDAP_SERVER_DOWN
;
1116 if (*rc
!= LDAP_SERVER_DOWN
)
1119 if (now
>= endtime
) {
1120 smbldap_close(ldap_state
);
1125 if (*attempts
== 0) {
1127 old_handler
= CatchSignal(SIGALRM
, gotalarm_sig
);
1128 alarm(endtime
- now
);
1130 if (ldap_state
->pid
!= sys_getpid())
1131 smbldap_close(ldap_state
);
1141 open_rc
= smbldap_open(ldap_state
);
1143 if (open_rc
== LDAP_SUCCESS
) {
1144 ldap_state
->last_use
= now
;
1148 if (open_rc
== LDAP_INSUFFICIENT_ACCESS
) {
1149 /* The fact that we are non-root or any other
1150 * access-denied condition will not change in the next
1151 * round of trying */
1161 if (open_rc
!= LDAP_SUCCESS
) {
1162 DEBUG(1, ("Connection to LDAP server failed for the "
1163 "%d try!\n", *attempts
));
1168 CatchSignal(SIGALRM
, old_handler
);
1170 ldap_state
->last_use
= now
;
1174 /*********************************************************************
1175 ********************************************************************/
1177 static int smbldap_search_ext(struct smbldap_state
*ldap_state
,
1178 const char *base
, int scope
, const char *filter
,
1179 const char *attrs
[], int attrsonly
,
1180 LDAPControl
**sctrls
, LDAPControl
**cctrls
,
1181 int sizelimit
, LDAPMessage
**res
)
1183 int rc
= LDAP_SERVER_DOWN
;
1186 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1187 struct timeval timeout
;
1189 SMB_ASSERT(ldap_state
);
1191 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1192 "scope => [%d]\n", base
, filter
, scope
));
1194 if (ldap_state
->last_rebind
.tv_sec
> 0) {
1195 struct timeval tval
;
1196 SMB_BIG_INT tdiff
= 0;
1200 GetTimeOfDay(&tval
);
1202 tdiff
= usec_time_diff(&tval
, &ldap_state
->last_rebind
);
1203 tdiff
/= 1000; /* Convert to milliseconds. */
1205 sleep_time
= lp_ldap_replication_sleep()-(int)tdiff
;
1206 sleep_time
= MIN(sleep_time
, MAX_LDAP_REPLICATION_SLEEP_TIME
);
1208 if (sleep_time
> 0) {
1209 /* we wait for the LDAP replication */
1210 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1211 "for LDAP replication.\n",sleep_time
));
1212 smb_msleep(sleep_time
);
1213 DEBUG(5,("smbldap_search_ext: go on!\n"));
1215 ZERO_STRUCT(ldap_state
->last_rebind
);
1218 if (push_utf8_allocate(&utf8_filter
, filter
) == (size_t)-1) {
1219 return LDAP_NO_MEMORY
;
1222 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1223 timeout
.tv_sec
= lp_ldap_timeout();
1224 timeout
.tv_usec
= 0;
1226 /* Setup alarm timeout.... Do we need both of these ? JRA.
1227 * Yes, I think we do need both of these. The server timeout only
1228 * covers the case where the server's operation takes too long. It
1229 * does not cover the case where the request hangs on its way to the
1230 * server. The server side timeout is not strictly necessary, it's
1231 * just a bit more kind to the server. VL. */
1234 CatchSignal(SIGALRM
, SIGNAL_CAST gotalarm_sig
);
1235 alarm(lp_ldap_timeout());
1236 /* End setup timeout. */
1238 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1239 rc
= ldap_search_ext_s(ldap_state
->ldap_struct
, base
, scope
,
1241 CONST_DISCARD(char **, attrs
),
1242 attrsonly
, sctrls
, cctrls
, &timeout
,
1244 if (rc
!= LDAP_SUCCESS
) {
1245 char *ld_error
= NULL
;
1248 ldap_get_option(ldap_state
->ldap_struct
,
1249 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1251 ldap_get_option(ldap_state
->ldap_struct
,
1252 LDAP_OPT_ERROR_STRING
, &ld_error
);
1253 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1254 "(%s)\n", base
, ld_errno
,
1255 ldap_err2string(rc
),
1256 ld_error
? ld_error
: "unknown"));
1257 SAFE_FREE(ld_error
);
1259 if (ld_errno
== LDAP_SERVER_DOWN
) {
1260 ldap_unbind(ldap_state
->ldap_struct
);
1261 ldap_state
->ldap_struct
= NULL
;
1266 SAFE_FREE(utf8_filter
);
1268 /* Teardown timeout. */
1269 CatchSignal(SIGALRM
, SIGNAL_CAST SIG_IGN
);
1273 return LDAP_TIMELIMIT_EXCEEDED
;
1278 int smbldap_search(struct smbldap_state
*ldap_state
,
1279 const char *base
, int scope
, const char *filter
,
1280 const char *attrs
[], int attrsonly
,
1283 return smbldap_search_ext(ldap_state
, base
, scope
, filter
, attrs
,
1284 attrsonly
, NULL
, NULL
, LDAP_NO_LIMIT
, res
);
1287 int smbldap_search_paged(struct smbldap_state
*ldap_state
,
1288 const char *base
, int scope
, const char *filter
,
1289 const char **attrs
, int attrsonly
, int pagesize
,
1290 LDAPMessage
**res
, void **cookie
)
1293 LDAPControl
**rcontrols
;
1294 LDAPControl
*controls
[2] = { NULL
, NULL
};
1295 BerElement
*cookie_be
= NULL
;
1296 struct berval
*cookie_bv
= NULL
;
1298 BOOL critical
= True
;
1302 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1303 "scope => [%d], pagesize => [%d]\n",
1304 base
, filter
, scope
, pagesize
));
1306 cookie_be
= ber_alloc_t(LBER_USE_DER
);
1307 if (cookie_be
== NULL
) {
1308 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1310 return LDAP_NO_MEMORY
;
1313 /* construct cookie */
1314 if (*cookie
!= NULL
) {
1315 ber_printf(cookie_be
, "{iO}", (ber_int_t
) pagesize
, *cookie
);
1316 ber_bvfree((struct berval
*)*cookie
); /* don't need it from last time */
1319 ber_printf(cookie_be
, "{io}", (ber_int_t
) pagesize
, "", 0);
1321 ber_flatten(cookie_be
, &cookie_bv
);
1323 pr
.ldctl_oid
= CONST_DISCARD(char *, ADS_PAGE_CTL_OID
);
1324 pr
.ldctl_iscritical
= (char) critical
;
1325 pr
.ldctl_value
.bv_len
= cookie_bv
->bv_len
;
1326 pr
.ldctl_value
.bv_val
= cookie_bv
->bv_val
;
1331 rc
= smbldap_search_ext(ldap_state
, base
, scope
, filter
, attrs
,
1332 0, controls
, NULL
, LDAP_NO_LIMIT
, res
);
1334 ber_free(cookie_be
, 1);
1335 ber_bvfree(cookie_bv
);
1338 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1339 "failed with [%s]\n", filter
, ldap_err2string(rc
)));
1343 DEBUG(3,("smbldap_search_paged: search was successfull\n"));
1345 rc
= ldap_parse_result(ldap_state
->ldap_struct
, *res
, NULL
, NULL
,
1346 NULL
, NULL
, &rcontrols
, 0);
1348 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1349 "with [%s]\n", ldap_err2string(rc
)));
1353 if (rcontrols
== NULL
)
1356 for (i
=0; rcontrols
[i
]; i
++) {
1358 if (strcmp(ADS_PAGE_CTL_OID
, rcontrols
[i
]->ldctl_oid
) != 0)
1361 cookie_be
= ber_init(&rcontrols
[i
]->ldctl_value
);
1362 ber_scanf(cookie_be
,"{iO}", &tmp
, &cookie_bv
);
1363 /* the berval is the cookie, but must be freed when it is all
1365 if (cookie_bv
->bv_len
)
1366 *cookie
=ber_bvdup(cookie_bv
);
1369 ber_bvfree(cookie_bv
);
1370 ber_free(cookie_be
, 1);
1373 ldap_controls_free(rcontrols
);
1378 int smbldap_modify(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
1380 int rc
= LDAP_SERVER_DOWN
;
1383 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1385 SMB_ASSERT(ldap_state
);
1387 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn
));
1389 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1390 return LDAP_NO_MEMORY
;
1393 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1394 rc
= ldap_modify_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
1395 if (rc
!= LDAP_SUCCESS
) {
1396 char *ld_error
= NULL
;
1399 ldap_get_option(ldap_state
->ldap_struct
,
1400 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1402 ldap_get_option(ldap_state
->ldap_struct
,
1403 LDAP_OPT_ERROR_STRING
, &ld_error
);
1404 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1405 "(%s)\n", dn
, ld_errno
,
1406 ldap_err2string(rc
),
1407 ld_error
? ld_error
: "unknown"));
1408 SAFE_FREE(ld_error
);
1410 if (ld_errno
== LDAP_SERVER_DOWN
) {
1411 ldap_unbind(ldap_state
->ldap_struct
);
1412 ldap_state
->ldap_struct
= NULL
;
1421 int smbldap_add(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
1423 int rc
= LDAP_SERVER_DOWN
;
1426 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1428 SMB_ASSERT(ldap_state
);
1430 DEBUG(5,("smbldap_add: dn => [%s]\n", dn
));
1432 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1433 return LDAP_NO_MEMORY
;
1436 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1437 rc
= ldap_add_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
1438 if (rc
!= LDAP_SUCCESS
) {
1439 char *ld_error
= NULL
;
1442 ldap_get_option(ldap_state
->ldap_struct
,
1443 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1445 ldap_get_option(ldap_state
->ldap_struct
,
1446 LDAP_OPT_ERROR_STRING
, &ld_error
);
1447 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1448 "(%s)\n", dn
, ld_errno
,
1449 ldap_err2string(rc
),
1450 ld_error
? ld_error
: "unknown"));
1451 SAFE_FREE(ld_error
);
1453 if (ld_errno
== LDAP_SERVER_DOWN
) {
1454 ldap_unbind(ldap_state
->ldap_struct
);
1455 ldap_state
->ldap_struct
= NULL
;
1464 int smbldap_delete(struct smbldap_state
*ldap_state
, const char *dn
)
1466 int rc
= LDAP_SERVER_DOWN
;
1469 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1471 SMB_ASSERT(ldap_state
);
1473 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn
));
1475 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1476 return LDAP_NO_MEMORY
;
1479 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1480 rc
= ldap_delete_s(ldap_state
->ldap_struct
, utf8_dn
);
1481 if (rc
!= LDAP_SUCCESS
) {
1482 char *ld_error
= NULL
;
1485 ldap_get_option(ldap_state
->ldap_struct
,
1486 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1488 ldap_get_option(ldap_state
->ldap_struct
,
1489 LDAP_OPT_ERROR_STRING
, &ld_error
);
1490 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1491 "(%s)\n", dn
, ld_errno
,
1492 ldap_err2string(rc
),
1493 ld_error
? ld_error
: "unknown"));
1494 SAFE_FREE(ld_error
);
1496 if (ld_errno
== LDAP_SERVER_DOWN
) {
1497 ldap_unbind(ldap_state
->ldap_struct
);
1498 ldap_state
->ldap_struct
= NULL
;
1507 int smbldap_extended_operation(struct smbldap_state
*ldap_state
,
1508 LDAP_CONST
char *reqoid
, struct berval
*reqdata
,
1509 LDAPControl
**serverctrls
, LDAPControl
**clientctrls
,
1510 char **retoidp
, struct berval
**retdatap
)
1512 int rc
= LDAP_SERVER_DOWN
;
1514 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1519 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1520 rc
= ldap_extended_operation_s(ldap_state
->ldap_struct
, reqoid
,
1521 reqdata
, serverctrls
,
1522 clientctrls
, retoidp
, retdatap
);
1523 if (rc
!= LDAP_SUCCESS
) {
1524 char *ld_error
= NULL
;
1527 ldap_get_option(ldap_state
->ldap_struct
,
1528 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1530 ldap_get_option(ldap_state
->ldap_struct
,
1531 LDAP_OPT_ERROR_STRING
, &ld_error
);
1532 DEBUG(10, ("Extended operation failed with error: "
1533 "%d (%s) (%s)\n", ld_errno
,
1534 ldap_err2string(rc
),
1535 ld_error
? ld_error
: "unknown"));
1536 SAFE_FREE(ld_error
);
1538 if (ld_errno
== LDAP_SERVER_DOWN
) {
1539 ldap_unbind(ldap_state
->ldap_struct
);
1540 ldap_state
->ldap_struct
= NULL
;
1548 /*******************************************************************
1549 run the search by name.
1550 ******************************************************************/
1551 int smbldap_search_suffix (struct smbldap_state
*ldap_state
,
1552 const char *filter
, const char **search_attr
,
1553 LDAPMessage
** result
)
1555 return smbldap_search(ldap_state
, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE
,
1556 filter
, search_attr
, 0, result
);
1559 static void smbldap_idle_fn(struct event_context
*event_ctx
,
1560 struct timed_event
*te
,
1561 const struct timeval
*now
,
1564 struct smbldap_state
*state
= (struct smbldap_state
*)private_data
;
1566 TALLOC_FREE(state
->idle_event
);
1568 if (state
->ldap_struct
== NULL
) {
1569 DEBUG(10,("ldap connection not connected...\n"));
1573 if ((state
->last_use
+SMBLDAP_IDLE_TIME
) > now
->tv_sec
) {
1574 DEBUG(10,("ldap connection not idle...\n"));
1576 state
->idle_event
= event_add_timed(
1578 timeval_add(now
, SMBLDAP_IDLE_TIME
, 0),
1579 "smbldap_idle_fn", smbldap_idle_fn
,
1584 DEBUG(7,("ldap connection idle...closing connection\n"));
1585 smbldap_close(state
);
1588 /**********************************************************************
1590 *********************************************************************/
1592 void smbldap_free_struct(struct smbldap_state
**ldap_state
)
1594 smbldap_close(*ldap_state
);
1596 if ((*ldap_state
)->bind_secret
) {
1597 memset((*ldap_state
)->bind_secret
, '\0', strlen((*ldap_state
)->bind_secret
));
1600 SAFE_FREE((*ldap_state
)->bind_dn
);
1601 SAFE_FREE((*ldap_state
)->bind_secret
);
1603 TALLOC_FREE((*ldap_state
)->idle_event
);
1607 /* No need to free any further, as it is talloc()ed */
1611 /**********************************************************************
1612 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1613 *********************************************************************/
1615 NTSTATUS
smbldap_init(TALLOC_CTX
*mem_ctx
, struct event_context
*event_ctx
,
1616 const char *location
,
1617 struct smbldap_state
**smbldap_state
)
1619 *smbldap_state
= TALLOC_ZERO_P(mem_ctx
, struct smbldap_state
);
1620 if (!*smbldap_state
) {
1621 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1622 return NT_STATUS_NO_MEMORY
;
1626 (*smbldap_state
)->uri
= talloc_strdup(mem_ctx
, location
);
1628 (*smbldap_state
)->uri
= "ldap://localhost";
1631 (*smbldap_state
)->event_context
= event_ctx
;
1633 return NT_STATUS_OK
;
1636 /*******************************************************************
1637 Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1638 ********************************************************************/
1639 char *smbldap_get_dn(LDAP
*ld
, LDAPMessage
*entry
)
1641 char *utf8_dn
, *unix_dn
;
1643 utf8_dn
= ldap_get_dn(ld
, entry
);
1645 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1648 if (pull_utf8_allocate(&unix_dn
, utf8_dn
) == (size_t)-1) {
1649 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 [%s]\n", utf8_dn
));
1652 ldap_memfree(utf8_dn
);
1656 const char *smbldap_talloc_dn(TALLOC_CTX
*mem_ctx
, LDAP
*ld
,
1659 char *utf8_dn
, *unix_dn
;
1661 utf8_dn
= ldap_get_dn(ld
, entry
);
1663 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1666 if (pull_utf8_talloc(mem_ctx
, &unix_dn
, utf8_dn
) == (size_t)-1) {
1667 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1668 "[%s]\n", utf8_dn
));
1671 ldap_memfree(utf8_dn
);
1675 /*******************************************************************
1676 Check if root-dse has a certain Control or Extension
1677 ********************************************************************/
1679 static BOOL
smbldap_check_root_dse(LDAP
*ld
, const char **attrs
, const char *value
)
1681 LDAPMessage
*msg
= NULL
;
1682 LDAPMessage
*entry
= NULL
;
1683 char **values
= NULL
;
1684 int rc
, num_result
, num_values
, i
;
1685 BOOL result
= False
;
1688 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1692 if (!strequal(attrs
[0], "supportedExtension") &&
1693 !strequal(attrs
[0], "supportedControl") &&
1694 !strequal(attrs
[0], "namingContexts")) {
1695 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs
[0]));
1699 rc
= ldap_search_s(ld
, "", LDAP_SCOPE_BASE
,
1700 "(objectclass=*)", CONST_DISCARD(char **, attrs
), 0 , &msg
);
1702 if (rc
!= LDAP_SUCCESS
) {
1703 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1707 num_result
= ldap_count_entries(ld
, msg
);
1709 if (num_result
!= 1) {
1710 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result
));
1714 entry
= ldap_first_entry(ld
, msg
);
1716 if (entry
== NULL
) {
1717 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1721 values
= ldap_get_values(ld
, entry
, attrs
[0]);
1723 if (values
== NULL
) {
1724 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs
[0]));
1728 num_values
= ldap_count_values(values
);
1730 if (num_values
== 0) {
1731 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs
[0]));
1735 for (i
=0; i
<num_values
; i
++) {
1736 if (strcmp(values
[i
], value
) == 0)
1743 ldap_value_free(values
);
1751 /*******************************************************************
1752 Check if LDAP-Server supports a certain Control (OID in string format)
1753 ********************************************************************/
1755 BOOL
smbldap_has_control(LDAP
*ld
, const char *control
)
1757 const char *attrs
[] = { "supportedControl", NULL
};
1758 return smbldap_check_root_dse(ld
, attrs
, control
);
1761 /*******************************************************************
1762 Check if LDAP-Server supports a certain Extension (OID in string format)
1763 ********************************************************************/
1765 BOOL
smbldap_has_extension(LDAP
*ld
, const char *extension
)
1767 const char *attrs
[] = { "supportedExtension", NULL
};
1768 return smbldap_check_root_dse(ld
, attrs
, extension
);
1771 /*******************************************************************
1772 Check if LDAP-Server holds a given namingContext
1773 ********************************************************************/
1775 BOOL
smbldap_has_naming_context(LDAP
*ld
, const char *naming_context
)
1777 const char *attrs
[] = { "namingContexts", NULL
};
1778 return smbldap_check_root_dse(ld
, attrs
, naming_context
);
1781 BOOL
smbldap_set_creds(struct smbldap_state
*ldap_state
, BOOL anon
, const char *dn
, const char *secret
)
1783 ldap_state
->anonymous
= anon
;
1785 /* free any previously set credential */
1787 SAFE_FREE(ldap_state
->bind_dn
);
1788 if (ldap_state
->bind_secret
) {
1789 /* make sure secrets are zeroed out of memory */
1790 memset(ldap_state
->bind_secret
, '\0', strlen(ldap_state
->bind_secret
));
1791 SAFE_FREE(ldap_state
->bind_secret
);
1795 ldap_state
->bind_dn
= SMB_STRDUP(dn
);
1796 ldap_state
->bind_secret
= SMB_STRDUP(secret
);