2 Unix SMB/CIFS implementation.
3 LDAP protocol helper functions for SAMBA
4 Copyright (C) Jean François Micouleau 1998
5 Copyright (C) Gerald Carter 2001-2003
6 Copyright (C) Shahms King 2001
7 Copyright (C) Andrew Bartlett 2002-2003
8 Copyright (C) Stefan (metze) Metzmacher 2002-2003
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #ifndef LDAP_OPT_SUCCESS
29 #define LDAP_OPT_SUCCESS 0
32 /* Try not to hit the up or down server forever */
34 #define SMBLDAP_DONT_PING_TIME 10 /* ping only all 10 seconds */
35 #define SMBLDAP_NUM_RETRIES 8 /* retry only 8 times */
37 #define SMBLDAP_IDLE_TIME 150 /* After 2.5 minutes disconnect */
40 /* attributes used by Samba 2.2 */
42 ATTRIB_MAP_ENTRY attrib_map_v22
[] = {
43 { LDAP_ATTR_UID
, "uid" },
44 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
45 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
46 { LDAP_ATTR_UNIX_HOME
, "homeDirectory" },
47 { LDAP_ATTR_PWD_LAST_SET
, "pwdLastSet" },
48 { LDAP_ATTR_PWD_CAN_CHANGE
, "pwdCanChange" },
49 { LDAP_ATTR_PWD_MUST_CHANGE
, "pwdMustChange" },
50 { LDAP_ATTR_LOGON_TIME
, "logonTime" },
51 { LDAP_ATTR_LOGOFF_TIME
, "logoffTime" },
52 { LDAP_ATTR_KICKOFF_TIME
, "kickoffTime" },
53 { LDAP_ATTR_CN
, "cn" },
54 { LDAP_ATTR_SN
, "sn" },
55 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
56 { LDAP_ATTR_HOME_PATH
, "smbHome" },
57 { LDAP_ATTR_HOME_DRIVE
, "homeDrive" },
58 { LDAP_ATTR_LOGON_SCRIPT
, "scriptPath" },
59 { LDAP_ATTR_PROFILE_PATH
, "profilePath" },
60 { LDAP_ATTR_DESC
, "description" },
61 { LDAP_ATTR_USER_WKS
, "userWorkstations"},
62 { LDAP_ATTR_USER_RID
, "rid" },
63 { LDAP_ATTR_PRIMARY_GROUP_RID
, "primaryGroupID"},
64 { LDAP_ATTR_LMPW
, "lmPassword" },
65 { LDAP_ATTR_NTPW
, "ntPassword" },
66 { LDAP_ATTR_DOMAIN
, "domain" },
67 { LDAP_ATTR_OBJCLASS
, "objectClass" },
68 { LDAP_ATTR_ACB_INFO
, "acctFlags" },
69 { LDAP_ATTR_MOD_TIMESTAMP
, "modifyTimestamp" },
70 { LDAP_ATTR_LIST_END
, NULL
}
73 ATTRIB_MAP_ENTRY attrib_map_to_delete_v22
[] = {
74 { LDAP_ATTR_PWD_LAST_SET
, "pwdLastSet" },
75 { LDAP_ATTR_PWD_CAN_CHANGE
, "pwdCanChange" },
76 { LDAP_ATTR_PWD_MUST_CHANGE
, "pwdMustChange" },
77 { LDAP_ATTR_LOGON_TIME
, "logonTime" },
78 { LDAP_ATTR_LOGOFF_TIME
, "logoffTime" },
79 { LDAP_ATTR_KICKOFF_TIME
, "kickoffTime" },
80 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
81 { LDAP_ATTR_HOME_PATH
, "smbHome" },
82 { LDAP_ATTR_HOME_DRIVE
, "homeDrives" },
83 { LDAP_ATTR_LOGON_SCRIPT
, "scriptPath" },
84 { LDAP_ATTR_PROFILE_PATH
, "profilePath" },
85 { LDAP_ATTR_USER_WKS
, "userWorkstations"},
86 { LDAP_ATTR_USER_RID
, "rid" },
87 { LDAP_ATTR_PRIMARY_GROUP_RID
, "primaryGroupID"},
88 { LDAP_ATTR_LMPW
, "lmPassword" },
89 { LDAP_ATTR_NTPW
, "ntPassword" },
90 { LDAP_ATTR_DOMAIN
, "domain" },
91 { LDAP_ATTR_ACB_INFO
, "acctFlags" },
92 { LDAP_ATTR_LIST_END
, NULL
}
95 /* attributes used by Samba 3.0's sambaSamAccount */
97 ATTRIB_MAP_ENTRY attrib_map_v30
[] = {
98 { LDAP_ATTR_UID
, "uid" },
99 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
100 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
101 { LDAP_ATTR_UNIX_HOME
, "homeDirectory" },
102 { LDAP_ATTR_PWD_LAST_SET
, "sambaPwdLastSet" },
103 { LDAP_ATTR_PWD_CAN_CHANGE
, "sambaPwdCanChange" },
104 { LDAP_ATTR_PWD_MUST_CHANGE
, "sambaPwdMustChange" },
105 { LDAP_ATTR_LOGON_TIME
, "sambaLogonTime" },
106 { LDAP_ATTR_LOGOFF_TIME
, "sambaLogoffTime" },
107 { LDAP_ATTR_KICKOFF_TIME
, "sambaKickoffTime" },
108 { LDAP_ATTR_CN
, "cn" },
109 { LDAP_ATTR_SN
, "sn" },
110 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
111 { LDAP_ATTR_HOME_DRIVE
, "sambaHomeDrive" },
112 { LDAP_ATTR_HOME_PATH
, "sambaHomePath" },
113 { LDAP_ATTR_LOGON_SCRIPT
, "sambaLogonScript" },
114 { LDAP_ATTR_PROFILE_PATH
, "sambaProfilePath" },
115 { LDAP_ATTR_DESC
, "description" },
116 { LDAP_ATTR_USER_WKS
, "sambaUserWorkstations" },
117 { LDAP_ATTR_USER_SID
, LDAP_ATTRIBUTE_SID
},
118 { LDAP_ATTR_PRIMARY_GROUP_SID
, "sambaPrimaryGroupSID" },
119 { LDAP_ATTR_LMPW
, "sambaLMPassword" },
120 { LDAP_ATTR_NTPW
, "sambaNTPassword" },
121 { LDAP_ATTR_DOMAIN
, "sambaDomainName" },
122 { LDAP_ATTR_OBJCLASS
, "objectClass" },
123 { LDAP_ATTR_ACB_INFO
, "sambaAcctFlags" },
124 { LDAP_ATTR_MUNGED_DIAL
, "sambaMungedDial" },
125 { LDAP_ATTR_BAD_PASSWORD_COUNT
, "sambaBadPasswordCount" },
126 { LDAP_ATTR_BAD_PASSWORD_TIME
, "sambaBadPasswordTime" },
127 { LDAP_ATTR_PWD_HISTORY
, "sambaPasswordHistory" },
128 { LDAP_ATTR_MOD_TIMESTAMP
, "modifyTimestamp" },
129 { LDAP_ATTR_LOGON_HOURS
, "sambaLogonHours" },
130 { LDAP_ATTR_LIST_END
, NULL
}
133 ATTRIB_MAP_ENTRY attrib_map_to_delete_v30
[] = {
134 { LDAP_ATTR_PWD_LAST_SET
, "sambaPwdLastSet" },
135 { LDAP_ATTR_PWD_CAN_CHANGE
, "sambaPwdCanChange" },
136 { LDAP_ATTR_PWD_MUST_CHANGE
, "sambaPwdMustChange" },
137 { LDAP_ATTR_LOGON_TIME
, "sambaLogonTime" },
138 { LDAP_ATTR_LOGOFF_TIME
, "sambaLogoffTime" },
139 { LDAP_ATTR_KICKOFF_TIME
, "sambaKickoffTime" },
140 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
141 { LDAP_ATTR_HOME_DRIVE
, "sambaHomeDrive" },
142 { LDAP_ATTR_HOME_PATH
, "sambaHomePath" },
143 { LDAP_ATTR_LOGON_SCRIPT
, "sambaLogonScript" },
144 { LDAP_ATTR_PROFILE_PATH
, "sambaProfilePath" },
145 { LDAP_ATTR_USER_WKS
, "sambaUserWorkstations" },
146 { LDAP_ATTR_USER_SID
, LDAP_ATTRIBUTE_SID
},
147 { LDAP_ATTR_PRIMARY_GROUP_SID
, "sambaPrimaryGroupSID" },
148 { LDAP_ATTR_LMPW
, "sambaLMPassword" },
149 { LDAP_ATTR_NTPW
, "sambaNTPassword" },
150 { LDAP_ATTR_DOMAIN
, "sambaDomainName" },
151 { LDAP_ATTR_ACB_INFO
, "sambaAcctFlags" },
152 { LDAP_ATTR_MUNGED_DIAL
, "sambaMungedDial" },
153 { LDAP_ATTR_BAD_PASSWORD_COUNT
, "sambaBadPasswordCount" },
154 { LDAP_ATTR_BAD_PASSWORD_TIME
, "sambaBadPasswordTime" },
155 { LDAP_ATTR_PWD_HISTORY
, "sambaPasswordHistory" },
156 { LDAP_ATTR_LOGON_HOURS
, "sambaLogonHours" },
157 { LDAP_ATTR_LIST_END
, NULL
}
160 /* attributes used for allocating RIDs */
162 ATTRIB_MAP_ENTRY dominfo_attr_list
[] = {
163 { LDAP_ATTR_DOMAIN
, "sambaDomainName" },
164 { LDAP_ATTR_NEXT_RID
, "sambaNextRid" },
165 { LDAP_ATTR_NEXT_USERRID
, "sambaNextUserRid" },
166 { LDAP_ATTR_NEXT_GROUPRID
, "sambaNextGroupRid" },
167 { LDAP_ATTR_DOM_SID
, LDAP_ATTRIBUTE_SID
},
168 { LDAP_ATTR_ALGORITHMIC_RID_BASE
,"sambaAlgorithmicRidBase"},
169 { LDAP_ATTR_OBJCLASS
, "objectClass" },
170 { LDAP_ATTR_LIST_END
, NULL
},
173 /* Samba 3.0 group mapping attributes */
175 ATTRIB_MAP_ENTRY groupmap_attr_list
[] = {
176 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
177 { LDAP_ATTR_GROUP_SID
, LDAP_ATTRIBUTE_SID
},
178 { LDAP_ATTR_GROUP_TYPE
, "sambaGroupType" },
179 { LDAP_ATTR_SID_LIST
, "sambaSIDList" },
180 { LDAP_ATTR_DESC
, "description" },
181 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
182 { LDAP_ATTR_CN
, "cn" },
183 { LDAP_ATTR_OBJCLASS
, "objectClass" },
184 { LDAP_ATTR_LIST_END
, NULL
}
187 ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete
[] = {
188 { LDAP_ATTR_GROUP_SID
, LDAP_ATTRIBUTE_SID
},
189 { LDAP_ATTR_GROUP_TYPE
, "sambaGroupType" },
190 { LDAP_ATTR_DESC
, "description" },
191 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
192 { LDAP_ATTR_SID_LIST
, "sambaSIDList" },
193 { LDAP_ATTR_LIST_END
, NULL
}
196 /* idmap_ldap sambaUnixIdPool */
198 ATTRIB_MAP_ENTRY idpool_attr_list
[] = {
199 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
200 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
201 { LDAP_ATTR_OBJCLASS
, "objectClass" },
202 { LDAP_ATTR_LIST_END
, NULL
}
205 ATTRIB_MAP_ENTRY sidmap_attr_list
[] = {
206 { LDAP_ATTR_SID
, LDAP_ATTRIBUTE_SID
},
207 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
208 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
209 { LDAP_ATTR_OBJCLASS
, "objectClass" },
210 { LDAP_ATTR_LIST_END
, NULL
}
213 /**********************************************************************
214 perform a simple table lookup and return the attribute name
215 **********************************************************************/
217 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table
[], int key
)
221 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
) {
222 if ( table
[i
].attrib
== key
)
223 return table
[i
].name
;
231 /**********************************************************************
232 Return the list of attribute names from a mapping table
233 **********************************************************************/
235 const char** get_attr_list( TALLOC_CTX
*mem_ctx
, ATTRIB_MAP_ENTRY table
[] )
240 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
)
244 names
= TALLOC_ARRAY( mem_ctx
, const char*, i
);
246 DEBUG(0,("get_attr_list: out of memory\n"));
251 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
) {
252 names
[i
] = talloc_strdup( names
, table
[i
].name
);
260 /*******************************************************************
261 Search an attribute and return the first value found.
262 ******************************************************************/
264 bool smbldap_get_single_attribute (LDAP
* ldap_struct
, LDAPMessage
* entry
,
265 const char *attribute
, char *value
,
275 if ((values
= ldap_get_values (ldap_struct
, entry
, attribute
)) == NULL
) {
276 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute
));
281 if (convert_string(CH_UTF8
, CH_UNIX
,values
[0], -1, value
, max_len
, False
) == (size_t)-1) {
282 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
283 attribute
, values
[0]));
284 ldap_value_free(values
);
288 ldap_value_free(values
);
289 #ifdef DEBUG_PASSWORDS
290 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute
, value
));
295 char * smbldap_talloc_single_attribute(LDAP
*ldap_struct
, LDAPMessage
*entry
,
296 const char *attribute
,
302 if (attribute
== NULL
) {
306 values
= ldap_get_values(ldap_struct
, entry
, attribute
);
308 if (values
== NULL
) {
309 DEBUG(10, ("attribute %s does not exist\n", attribute
));
313 if (ldap_count_values(values
) != 1) {
314 DEBUG(10, ("attribute %s has %d values, expected only one\n",
315 attribute
, ldap_count_values(values
)));
316 ldap_value_free(values
);
320 if (pull_utf8_talloc(mem_ctx
, &result
, values
[0]) == (size_t)-1) {
321 DEBUG(10, ("pull_utf8_talloc failed\n"));
322 ldap_value_free(values
);
326 ldap_value_free(values
);
328 #ifdef DEBUG_PASSWORDS
329 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
335 static int ldapmsg_destructor(LDAPMessage
**result
) {
336 ldap_msgfree(*result
);
340 void talloc_autofree_ldapmsg(TALLOC_CTX
*mem_ctx
, LDAPMessage
*result
)
342 LDAPMessage
**handle
;
344 if (result
== NULL
) {
348 handle
= TALLOC_P(mem_ctx
, LDAPMessage
*);
349 SMB_ASSERT(handle
!= NULL
);
352 talloc_set_destructor(handle
, ldapmsg_destructor
);
355 static int ldapmod_destructor(LDAPMod
***mod
) {
356 ldap_mods_free(*mod
, True
);
360 void talloc_autofree_ldapmod(TALLOC_CTX
*mem_ctx
, LDAPMod
**mod
)
368 handle
= TALLOC_P(mem_ctx
, LDAPMod
**);
369 SMB_ASSERT(handle
!= NULL
);
372 talloc_set_destructor(handle
, ldapmod_destructor
);
375 /************************************************************************
376 Routine to manage the LDAPMod structure array
377 manage memory used by the array, by each struct, and values
378 ***********************************************************************/
380 void smbldap_set_mod (LDAPMod
*** modlist
, int modop
, const char *attribute
, const char *value
)
388 /* sanity checks on the mod values */
390 if (attribute
== NULL
|| *attribute
== '\0') {
394 #if 0 /* commented out after discussion with abartlet. Do not reenable.
395 left here so other do not re-add similar code --jerry */
396 if (value
== NULL
|| *value
== '\0')
401 mods
= SMB_MALLOC_P(LDAPMod
*);
403 smb_panic("smbldap_set_mod: out of memory!");
409 for (i
= 0; mods
[i
] != NULL
; ++i
) {
410 if (mods
[i
]->mod_op
== modop
&& strequal(mods
[i
]->mod_type
, attribute
))
414 if (mods
[i
] == NULL
) {
415 mods
= SMB_REALLOC_ARRAY (mods
, LDAPMod
*, i
+ 2);
417 smb_panic("smbldap_set_mod: out of memory!");
420 mods
[i
] = SMB_MALLOC_P(LDAPMod
);
421 if (mods
[i
] == NULL
) {
422 smb_panic("smbldap_set_mod: out of memory!");
425 mods
[i
]->mod_op
= modop
;
426 mods
[i
]->mod_values
= NULL
;
427 mods
[i
]->mod_type
= SMB_STRDUP(attribute
);
432 char *utf8_value
= NULL
;
435 if (mods
[i
]->mod_values
!= NULL
) {
436 for (; mods
[i
]->mod_values
[j
] != NULL
; j
++);
438 mods
[i
]->mod_values
= SMB_REALLOC_ARRAY(mods
[i
]->mod_values
, char *, j
+ 2);
440 if (mods
[i
]->mod_values
== NULL
) {
441 smb_panic("smbldap_set_mod: out of memory!");
445 if (push_utf8_allocate(&utf8_value
, value
) == (size_t)-1) {
446 smb_panic("smbldap_set_mod: String conversion failure!");
450 mods
[i
]->mod_values
[j
] = utf8_value
;
452 mods
[i
]->mod_values
[j
+ 1] = NULL
;
457 /**********************************************************************
458 Set attribute to newval in LDAP, regardless of what value the
459 attribute had in LDAP before.
460 *********************************************************************/
462 void smbldap_make_mod(LDAP
*ldap_struct
, LDAPMessage
*existing
,
464 const char *attribute
, const char *newval
)
466 char oldval
[2048]; /* current largest allowed value is mungeddial */
469 if (attribute
== NULL
) {
470 /* This can actually happen for ldapsam_compat where we for
471 * example don't have a password history */
475 if (existing
!= NULL
) {
476 existed
= smbldap_get_single_attribute(ldap_struct
, existing
, attribute
, oldval
, sizeof(oldval
));
482 /* all of our string attributes are case insensitive */
484 if (existed
&& newval
&& (StrCaseCmp(oldval
, newval
) == 0)) {
486 /* Believe it or not, but LDAP will deny a delete and
487 an add at the same time if the values are the
489 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute
));
494 /* There has been no value before, so don't delete it.
495 * Here's a possible race: We might end up with
496 * duplicate attributes */
497 /* By deleting exactly the value we found in the entry this
498 * should be race-free in the sense that the LDAP-Server will
499 * deny the complete operation if somebody changed the
500 * attribute behind our back. */
501 /* This will also allow modifying single valued attributes
502 * in Novell NDS. In NDS you have to first remove attribute and then
503 * you could add new value */
505 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute
, oldval
));
506 smbldap_set_mod(mods
, LDAP_MOD_DELETE
, attribute
, oldval
);
509 /* Regardless of the real operation (add or modify)
510 we add the new value here. We rely on deleting
511 the old value, should it exist. */
513 if ((newval
!= NULL
) && (strlen(newval
) > 0)) {
514 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute
, newval
));
515 smbldap_set_mod(mods
, LDAP_MOD_ADD
, attribute
, newval
);
519 /**********************************************************************
520 Some varients of the LDAP rebind code do not pass in the third 'arg'
521 pointer to a void*, so we try and work around it by assuming that the
522 value of the 'LDAP *' pointer is the same as the one we had passed in
523 **********************************************************************/
525 struct smbldap_state_lookup
{
527 struct smbldap_state
*smbldap_state
;
528 struct smbldap_state_lookup
*prev
, *next
;
531 static struct smbldap_state_lookup
*smbldap_state_lookup_list
;
533 static struct smbldap_state
*smbldap_find_state(LDAP
*ld
)
535 struct smbldap_state_lookup
*t
;
537 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
539 return t
->smbldap_state
;
545 static void smbldap_delete_state(struct smbldap_state
*smbldap_state
)
547 struct smbldap_state_lookup
*t
;
549 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
550 if (t
->smbldap_state
== smbldap_state
) {
551 DLIST_REMOVE(smbldap_state_lookup_list
, t
);
558 static void smbldap_store_state(LDAP
*ld
, struct smbldap_state
*smbldap_state
)
560 struct smbldap_state
*tmp_ldap_state
;
561 struct smbldap_state_lookup
*t
;
563 if ((tmp_ldap_state
= smbldap_find_state(ld
))) {
564 SMB_ASSERT(tmp_ldap_state
== smbldap_state
);
568 t
= SMB_XMALLOC_P(struct smbldap_state_lookup
);
571 DLIST_ADD_END(smbldap_state_lookup_list
, t
, struct smbldap_state_lookup
*);
573 t
->smbldap_state
= smbldap_state
;
576 /********************************************************************
577 start TLS on an existing LDAP connection
578 *******************************************************************/
580 int smb_ldap_start_tls(LDAP
*ldap_struct
, int version
)
584 if (lp_ldap_ssl() != LDAP_SSL_START_TLS
) {
588 #ifdef LDAP_OPT_X_TLS
589 if (version
!= LDAP_VERSION3
) {
590 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
591 return LDAP_OPERATIONS_ERROR
;
594 if ((rc
= ldap_start_tls_s (ldap_struct
, NULL
, NULL
)) != LDAP_SUCCESS
) {
595 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
596 ldap_err2string(rc
)));
600 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
603 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
604 return LDAP_OPERATIONS_ERROR
;
608 /********************************************************************
609 setup a connection to the LDAP server based on a uri
610 *******************************************************************/
612 int smb_ldap_setup_conn(LDAP
**ldap_struct
, const char *uri
)
616 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri
));
618 #ifdef HAVE_LDAP_INITIALIZE
620 rc
= ldap_initialize(ldap_struct
, uri
);
622 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc
)));
628 /* Parse the string manually */
634 SMB_ASSERT(sizeof(protocol
)>10 && sizeof(host
)>254);
637 /* skip leading "URL:" (if any) */
638 if ( strnequal( uri
, "URL:", 4 ) ) {
642 sscanf(uri
, "%10[^:]://%254[^:/]:%d", protocol
, host
, &port
);
645 if (strequal(protocol
, "ldap")) {
647 } else if (strequal(protocol
, "ldaps")) {
650 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol
));
654 if ((*ldap_struct
= ldap_init(host
, port
)) == NULL
) {
655 DEBUG(0, ("ldap_init failed !\n"));
656 return LDAP_OPERATIONS_ERROR
;
659 if (strequal(protocol
, "ldaps")) {
660 #ifdef LDAP_OPT_X_TLS
661 int tls
= LDAP_OPT_X_TLS_HARD
;
662 if (ldap_set_option (*ldap_struct
, LDAP_OPT_X_TLS
, &tls
) != LDAP_SUCCESS
)
664 DEBUG(0, ("Failed to setup a TLS session\n"));
667 DEBUG(3,("LDAPS option set...!\n"));
669 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
670 return LDAP_OPERATIONS_ERROR
;
671 #endif /* LDAP_OPT_X_TLS */
675 #endif /* HAVE_LDAP_INITIALIZE */
679 /********************************************************************
680 try to upgrade to Version 3 LDAP if not already, in either case return current
682 *******************************************************************/
684 int smb_ldap_upgrade_conn(LDAP
*ldap_struct
, int *new_version
)
689 /* assume the worst */
690 *new_version
= LDAP_VERSION2
;
692 rc
= ldap_get_option(ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
697 if (version
== LDAP_VERSION3
) {
698 *new_version
= LDAP_VERSION3
;
703 version
= LDAP_VERSION3
;
704 rc
= ldap_set_option (ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
709 *new_version
= LDAP_VERSION3
;
713 /*******************************************************************
714 open a connection to the ldap server (just until the bind)
715 ******************************************************************/
717 int smb_ldap_setup_full_conn(LDAP
**ldap_struct
, const char *uri
)
721 rc
= smb_ldap_setup_conn(ldap_struct
, uri
);
726 rc
= smb_ldap_upgrade_conn(*ldap_struct
, &version
);
731 rc
= smb_ldap_start_tls(*ldap_struct
, version
);
739 /*******************************************************************
740 open a connection to the ldap server.
741 ******************************************************************/
742 static int smbldap_open_connection (struct smbldap_state
*ldap_state
)
745 int rc
= LDAP_SUCCESS
;
747 LDAP
**ldap_struct
= &ldap_state
->ldap_struct
;
749 rc
= smb_ldap_setup_conn(ldap_struct
, ldap_state
->uri
);
754 /* Store the LDAP pointer in a lookup list */
756 smbldap_store_state(*ldap_struct
, ldap_state
);
758 /* Upgrade to LDAPv3 if possible */
760 rc
= smb_ldap_upgrade_conn(*ldap_struct
, &version
);
765 /* Start TLS if required */
767 rc
= smb_ldap_start_tls(*ldap_struct
, version
);
772 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
776 /*******************************************************************
777 a rebind function for authenticated referrals
778 This version takes a void* that we can shove useful stuff in :-)
779 ******************************************************************/
780 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
782 static int rebindproc_with_state (LDAP
* ld
, char **whop
, char **credp
,
783 int *methodp
, int freeit
, void *arg
)
785 struct smbldap_state
*ldap_state
= arg
;
787 /** @TODO Should we be doing something to check what servers we rebind to?
788 Could we get a referral to a machine that we don't want to give our
789 username and password to? */
794 memset(*credp
, '\0', strlen(*credp
));
798 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
799 ldap_state
->bind_dn
?ldap_state
->bind_dn
:"[Anonymous bind]"));
801 if (ldap_state
->anonymous
) {
805 *whop
= SMB_STRDUP(ldap_state
->bind_dn
);
807 return LDAP_NO_MEMORY
;
809 *credp
= SMB_STRDUP(ldap_state
->bind_secret
);
812 return LDAP_NO_MEMORY
;
815 *methodp
= LDAP_AUTH_SIMPLE
;
818 GetTimeOfDay(&ldap_state
->last_rebind
);
822 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
824 /*******************************************************************
825 a rebind function for authenticated referrals
826 This version takes a void* that we can shove useful stuff in :-)
827 and actually does the connection.
828 ******************************************************************/
829 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
830 static int rebindproc_connect_with_state (LDAP
*ldap_struct
,
831 LDAP_CONST
char *url
,
833 ber_int_t msgid
, void *arg
)
835 struct smbldap_state
*ldap_state
=
836 (struct smbldap_state
*)arg
;
840 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
841 url
, ldap_state
->bind_dn
?ldap_state
->bind_dn
:"[Anonymous bind]"));
843 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
844 * itself) before rebinding to another LDAP server to avoid to expose
845 * our credentials. At least *try* to secure the connection - Guenther */
847 smb_ldap_upgrade_conn(ldap_struct
, &version
);
848 smb_ldap_start_tls(ldap_struct
, version
);
850 /** @TODO Should we be doing something to check what servers we rebind to?
851 Could we get a referral to a machine that we don't want to give our
852 username and password to? */
854 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
856 /* only set the last rebind timestamp when we did rebind after a
857 * non-read LDAP operation. That way we avoid the replication sleep
858 * after a simple redirected search operation - Guenther */
862 case LDAP_REQ_MODIFY
:
864 case LDAP_REQ_DELETE
:
866 case LDAP_REQ_EXTENDED
:
867 DEBUG(10,("rebindproc_connect_with_state: "
868 "setting last_rebind timestamp "
869 "(req: 0x%02x)\n", (unsigned int)request
));
870 GetTimeOfDay(&ldap_state
->last_rebind
);
873 ZERO_STRUCT(ldap_state
->last_rebind
);
879 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
881 /*******************************************************************
882 Add a rebind function for authenticated referrals
883 ******************************************************************/
884 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
886 # if LDAP_SET_REBIND_PROC_ARGS == 2
887 static int rebindproc (LDAP
*ldap_struct
, char **whop
, char **credp
,
888 int *method
, int freeit
)
890 struct smbldap_state
*ldap_state
= smbldap_find_state(ldap_struct
);
892 return rebindproc_with_state(ldap_struct
, whop
, credp
,
893 method
, freeit
, ldap_state
);
896 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
897 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
899 /*******************************************************************
900 a rebind function for authenticated referrals
901 this also does the connection, but no void*.
902 ******************************************************************/
903 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
904 # if LDAP_SET_REBIND_PROC_ARGS == 2
905 static int rebindproc_connect (LDAP
* ld
, LDAP_CONST
char *url
, int request
,
908 struct smbldap_state
*ldap_state
= smbldap_find_state(ld
);
910 return rebindproc_connect_with_state(ld
, url
, (ber_tag_t
)request
, msgid
,
913 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
914 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
916 /*******************************************************************
917 connect to the ldap server under system privilege.
918 ******************************************************************/
919 static int smbldap_connect_system(struct smbldap_state
*ldap_state
, LDAP
* ldap_struct
)
924 if (!ldap_state
->anonymous
&& !ldap_state
->bind_dn
) {
926 /* get the default dn and password only if they are not set already */
927 if (!fetch_ldap_pw(&ldap_state
->bind_dn
, &ldap_state
->bind_secret
)) {
928 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
929 return LDAP_INVALID_CREDENTIALS
;
933 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
934 (OpenLDAP) doesnt' seem to support it */
936 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
937 ldap_state
->uri
, ldap_state
->bind_dn
));
939 #ifdef HAVE_LDAP_SET_REBIND_PROC
940 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
941 # if LDAP_SET_REBIND_PROC_ARGS == 2
942 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect
);
944 # if LDAP_SET_REBIND_PROC_ARGS == 3
945 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect_with_state
, (void *)ldap_state
);
947 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
948 # if LDAP_SET_REBIND_PROC_ARGS == 2
949 ldap_set_rebind_proc(ldap_struct
, &rebindproc
);
951 # if LDAP_SET_REBIND_PROC_ARGS == 3
952 ldap_set_rebind_proc(ldap_struct
, &rebindproc_with_state
, (void *)ldap_state
);
954 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
957 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
959 if (rc
!= LDAP_SUCCESS
) {
960 char *ld_error
= NULL
;
961 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_ERROR_STRING
,
963 DEBUG(ldap_state
->num_failures
? 2 : 0,
964 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
966 ldap_state
->bind_dn
? ldap_state
->bind_dn
: "[Anonymous bind]",
968 ld_error
? ld_error
: "(unknown)"));
970 ldap_state
->num_failures
++;
974 ldap_state
->num_failures
= 0;
975 ldap_state
->paged_results
= False
;
977 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
);
979 if (smbldap_has_control(ldap_state
->ldap_struct
, ADS_PAGE_CTL_OID
) && version
== 3) {
980 ldap_state
->paged_results
= True
;
983 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
984 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
985 ldap_state
->paged_results
? "does" : "does not"));
989 static void smbldap_idle_fn(struct event_context
*event_ctx
,
990 struct timed_event
*te
,
991 const struct timeval
*now
,
994 /**********************************************************************
995 Connect to LDAP server (called before every ldap operation)
996 *********************************************************************/
997 static int smbldap_open(struct smbldap_state
*ldap_state
)
1000 bool reopen
= False
;
1001 SMB_ASSERT(ldap_state
);
1003 #ifndef NO_LDAP_SECURITY
1004 if (geteuid() != 0) {
1005 DEBUG(0, ("smbldap_open: cannot access LDAP when not root..\n"));
1006 return LDAP_INSUFFICIENT_ACCESS
;
1010 if ((ldap_state
->ldap_struct
!= NULL
) && ((ldap_state
->last_ping
+ SMBLDAP_DONT_PING_TIME
) < time(NULL
))) {
1012 #ifdef HAVE_UNIXSOCKET
1013 struct sockaddr_un addr
;
1015 struct sockaddr addr
;
1017 socklen_t len
= sizeof(addr
);
1020 opt_rc
= ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_DESC
, &sd
);
1021 if (opt_rc
== 0 && (getpeername(sd
, (struct sockaddr
*) &addr
, &len
)) < 0 )
1024 #ifdef HAVE_UNIXSOCKET
1025 if (opt_rc
== 0 && addr
.sun_family
== AF_UNIX
)
1029 /* the other end has died. reopen. */
1030 ldap_unbind(ldap_state
->ldap_struct
);
1031 ldap_state
->ldap_struct
= NULL
;
1032 ldap_state
->last_ping
= (time_t)0;
1034 ldap_state
->last_ping
= time(NULL
);
1038 if (ldap_state
->ldap_struct
!= NULL
) {
1039 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1040 return LDAP_SUCCESS
;
1043 if ((rc
= smbldap_open_connection(ldap_state
))) {
1047 if ((rc
= smbldap_connect_system(ldap_state
, ldap_state
->ldap_struct
))) {
1048 ldap_unbind(ldap_state
->ldap_struct
);
1049 ldap_state
->ldap_struct
= NULL
;
1054 ldap_state
->last_ping
= time(NULL
);
1055 ldap_state
->pid
= sys_getpid();
1057 TALLOC_FREE(ldap_state
->idle_event
);
1059 if (ldap_state
->event_context
!= NULL
) {
1060 ldap_state
->idle_event
= event_add_timed(
1061 ldap_state
->event_context
, NULL
,
1062 timeval_current_ofs(SMBLDAP_IDLE_TIME
, 0),
1063 "smbldap_idle_fn", smbldap_idle_fn
, ldap_state
);
1066 DEBUG(4,("The LDAP server is successfully connected\n"));
1068 return LDAP_SUCCESS
;
1071 /**********************************************************************
1072 Disconnect from LDAP server
1073 *********************************************************************/
1074 static NTSTATUS
smbldap_close(struct smbldap_state
*ldap_state
)
1077 return NT_STATUS_INVALID_PARAMETER
;
1079 if (ldap_state
->ldap_struct
!= NULL
) {
1080 ldap_unbind(ldap_state
->ldap_struct
);
1081 ldap_state
->ldap_struct
= NULL
;
1084 smbldap_delete_state(ldap_state
);
1086 DEBUG(5,("The connection to the LDAP server was closed\n"));
1087 /* maybe free the results here --metze */
1089 return NT_STATUS_OK
;
1092 static bool got_alarm
;
1094 static void (*old_handler
)(int);
1096 static void gotalarm_sig(int dummy
)
1101 static int another_ldap_try(struct smbldap_state
*ldap_state
, int *rc
,
1102 int *attempts
, time_t endtime
)
1104 time_t now
= time(NULL
);
1105 int open_rc
= LDAP_SERVER_DOWN
;
1107 if (*rc
!= LDAP_SERVER_DOWN
)
1110 if (now
>= endtime
) {
1111 smbldap_close(ldap_state
);
1116 if (*attempts
== 0) {
1118 old_handler
= CatchSignal(SIGALRM
, gotalarm_sig
);
1119 alarm(endtime
- now
);
1121 if (ldap_state
->pid
!= sys_getpid())
1122 smbldap_close(ldap_state
);
1132 open_rc
= smbldap_open(ldap_state
);
1134 if (open_rc
== LDAP_SUCCESS
) {
1135 ldap_state
->last_use
= now
;
1139 if (open_rc
== LDAP_INSUFFICIENT_ACCESS
) {
1140 /* The fact that we are non-root or any other
1141 * access-denied condition will not change in the next
1142 * round of trying */
1152 if (open_rc
!= LDAP_SUCCESS
) {
1153 DEBUG(1, ("Connection to LDAP server failed for the "
1154 "%d try!\n", *attempts
));
1159 CatchSignal(SIGALRM
, old_handler
);
1161 ldap_state
->last_use
= now
;
1165 /*********************************************************************
1166 ********************************************************************/
1168 static int smbldap_search_ext(struct smbldap_state
*ldap_state
,
1169 const char *base
, int scope
, const char *filter
,
1170 const char *attrs
[], int attrsonly
,
1171 LDAPControl
**sctrls
, LDAPControl
**cctrls
,
1172 int sizelimit
, LDAPMessage
**res
)
1174 int rc
= LDAP_SERVER_DOWN
;
1177 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1178 struct timeval timeout
;
1180 SMB_ASSERT(ldap_state
);
1182 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1183 "scope => [%d]\n", base
, filter
, scope
));
1185 if (ldap_state
->last_rebind
.tv_sec
> 0) {
1186 struct timeval tval
;
1187 SMB_BIG_INT tdiff
= 0;
1191 GetTimeOfDay(&tval
);
1193 tdiff
= usec_time_diff(&tval
, &ldap_state
->last_rebind
);
1194 tdiff
/= 1000; /* Convert to milliseconds. */
1196 sleep_time
= lp_ldap_replication_sleep()-(int)tdiff
;
1197 sleep_time
= MIN(sleep_time
, MAX_LDAP_REPLICATION_SLEEP_TIME
);
1199 if (sleep_time
> 0) {
1200 /* we wait for the LDAP replication */
1201 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1202 "for LDAP replication.\n",sleep_time
));
1203 smb_msleep(sleep_time
);
1204 DEBUG(5,("smbldap_search_ext: go on!\n"));
1206 ZERO_STRUCT(ldap_state
->last_rebind
);
1209 if (push_utf8_allocate(&utf8_filter
, filter
) == (size_t)-1) {
1210 return LDAP_NO_MEMORY
;
1213 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1214 timeout
.tv_sec
= lp_ldap_timeout();
1215 timeout
.tv_usec
= 0;
1217 /* Setup alarm timeout.... Do we need both of these ? JRA.
1218 * Yes, I think we do need both of these. The server timeout only
1219 * covers the case where the server's operation takes too long. It
1220 * does not cover the case where the request hangs on its way to the
1221 * server. The server side timeout is not strictly necessary, it's
1222 * just a bit more kind to the server. VL. */
1225 CatchSignal(SIGALRM
, SIGNAL_CAST gotalarm_sig
);
1226 alarm(lp_ldap_timeout());
1227 /* End setup timeout. */
1229 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1230 rc
= ldap_search_ext_s(ldap_state
->ldap_struct
, base
, scope
,
1232 CONST_DISCARD(char **, attrs
),
1233 attrsonly
, sctrls
, cctrls
, &timeout
,
1235 if (rc
!= LDAP_SUCCESS
) {
1236 char *ld_error
= NULL
;
1239 ldap_get_option(ldap_state
->ldap_struct
,
1240 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1242 ldap_get_option(ldap_state
->ldap_struct
,
1243 LDAP_OPT_ERROR_STRING
, &ld_error
);
1244 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1245 "(%s)\n", base
, ld_errno
,
1246 ldap_err2string(rc
),
1247 ld_error
? ld_error
: "unknown"));
1248 SAFE_FREE(ld_error
);
1250 if (ld_errno
== LDAP_SERVER_DOWN
) {
1251 ldap_unbind(ldap_state
->ldap_struct
);
1252 ldap_state
->ldap_struct
= NULL
;
1257 SAFE_FREE(utf8_filter
);
1259 /* Teardown timeout. */
1260 CatchSignal(SIGALRM
, SIGNAL_CAST SIG_IGN
);
1264 return LDAP_TIMELIMIT_EXCEEDED
;
1269 int smbldap_search(struct smbldap_state
*ldap_state
,
1270 const char *base
, int scope
, const char *filter
,
1271 const char *attrs
[], int attrsonly
,
1274 return smbldap_search_ext(ldap_state
, base
, scope
, filter
, attrs
,
1275 attrsonly
, NULL
, NULL
, LDAP_NO_LIMIT
, res
);
1278 int smbldap_search_paged(struct smbldap_state
*ldap_state
,
1279 const char *base
, int scope
, const char *filter
,
1280 const char **attrs
, int attrsonly
, int pagesize
,
1281 LDAPMessage
**res
, void **cookie
)
1284 LDAPControl
**rcontrols
;
1285 LDAPControl
*controls
[2] = { NULL
, NULL
};
1286 BerElement
*cookie_be
= NULL
;
1287 struct berval
*cookie_bv
= NULL
;
1289 bool critical
= True
;
1293 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1294 "scope => [%d], pagesize => [%d]\n",
1295 base
, filter
, scope
, pagesize
));
1297 cookie_be
= ber_alloc_t(LBER_USE_DER
);
1298 if (cookie_be
== NULL
) {
1299 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1301 return LDAP_NO_MEMORY
;
1304 /* construct cookie */
1305 if (*cookie
!= NULL
) {
1306 ber_printf(cookie_be
, "{iO}", (ber_int_t
) pagesize
, *cookie
);
1307 ber_bvfree((struct berval
*)*cookie
); /* don't need it from last time */
1310 ber_printf(cookie_be
, "{io}", (ber_int_t
) pagesize
, "", 0);
1312 ber_flatten(cookie_be
, &cookie_bv
);
1314 pr
.ldctl_oid
= CONST_DISCARD(char *, ADS_PAGE_CTL_OID
);
1315 pr
.ldctl_iscritical
= (char) critical
;
1316 pr
.ldctl_value
.bv_len
= cookie_bv
->bv_len
;
1317 pr
.ldctl_value
.bv_val
= cookie_bv
->bv_val
;
1322 rc
= smbldap_search_ext(ldap_state
, base
, scope
, filter
, attrs
,
1323 0, controls
, NULL
, LDAP_NO_LIMIT
, res
);
1325 ber_free(cookie_be
, 1);
1326 ber_bvfree(cookie_bv
);
1329 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1330 "failed with [%s]\n", filter
, ldap_err2string(rc
)));
1334 DEBUG(3,("smbldap_search_paged: search was successfull\n"));
1336 rc
= ldap_parse_result(ldap_state
->ldap_struct
, *res
, NULL
, NULL
,
1337 NULL
, NULL
, &rcontrols
, 0);
1339 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1340 "with [%s]\n", ldap_err2string(rc
)));
1344 if (rcontrols
== NULL
)
1347 for (i
=0; rcontrols
[i
]; i
++) {
1349 if (strcmp(ADS_PAGE_CTL_OID
, rcontrols
[i
]->ldctl_oid
) != 0)
1352 cookie_be
= ber_init(&rcontrols
[i
]->ldctl_value
);
1353 ber_scanf(cookie_be
,"{iO}", &tmp
, &cookie_bv
);
1354 /* the berval is the cookie, but must be freed when it is all
1356 if (cookie_bv
->bv_len
)
1357 *cookie
=ber_bvdup(cookie_bv
);
1360 ber_bvfree(cookie_bv
);
1361 ber_free(cookie_be
, 1);
1364 ldap_controls_free(rcontrols
);
1369 int smbldap_modify(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
1371 int rc
= LDAP_SERVER_DOWN
;
1374 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1376 SMB_ASSERT(ldap_state
);
1378 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn
));
1380 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1381 return LDAP_NO_MEMORY
;
1384 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1385 rc
= ldap_modify_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
1386 if (rc
!= LDAP_SUCCESS
) {
1387 char *ld_error
= NULL
;
1390 ldap_get_option(ldap_state
->ldap_struct
,
1391 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1393 ldap_get_option(ldap_state
->ldap_struct
,
1394 LDAP_OPT_ERROR_STRING
, &ld_error
);
1395 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1396 "(%s)\n", dn
, ld_errno
,
1397 ldap_err2string(rc
),
1398 ld_error
? ld_error
: "unknown"));
1399 SAFE_FREE(ld_error
);
1401 if (ld_errno
== LDAP_SERVER_DOWN
) {
1402 ldap_unbind(ldap_state
->ldap_struct
);
1403 ldap_state
->ldap_struct
= NULL
;
1412 int smbldap_add(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
1414 int rc
= LDAP_SERVER_DOWN
;
1417 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1419 SMB_ASSERT(ldap_state
);
1421 DEBUG(5,("smbldap_add: dn => [%s]\n", dn
));
1423 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1424 return LDAP_NO_MEMORY
;
1427 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1428 rc
= ldap_add_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
1429 if (rc
!= LDAP_SUCCESS
) {
1430 char *ld_error
= NULL
;
1433 ldap_get_option(ldap_state
->ldap_struct
,
1434 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1436 ldap_get_option(ldap_state
->ldap_struct
,
1437 LDAP_OPT_ERROR_STRING
, &ld_error
);
1438 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1439 "(%s)\n", dn
, ld_errno
,
1440 ldap_err2string(rc
),
1441 ld_error
? ld_error
: "unknown"));
1442 SAFE_FREE(ld_error
);
1444 if (ld_errno
== LDAP_SERVER_DOWN
) {
1445 ldap_unbind(ldap_state
->ldap_struct
);
1446 ldap_state
->ldap_struct
= NULL
;
1455 int smbldap_delete(struct smbldap_state
*ldap_state
, const char *dn
)
1457 int rc
= LDAP_SERVER_DOWN
;
1460 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1462 SMB_ASSERT(ldap_state
);
1464 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn
));
1466 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1467 return LDAP_NO_MEMORY
;
1470 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1471 rc
= ldap_delete_s(ldap_state
->ldap_struct
, utf8_dn
);
1472 if (rc
!= LDAP_SUCCESS
) {
1473 char *ld_error
= NULL
;
1476 ldap_get_option(ldap_state
->ldap_struct
,
1477 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1479 ldap_get_option(ldap_state
->ldap_struct
,
1480 LDAP_OPT_ERROR_STRING
, &ld_error
);
1481 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1482 "(%s)\n", dn
, ld_errno
,
1483 ldap_err2string(rc
),
1484 ld_error
? ld_error
: "unknown"));
1485 SAFE_FREE(ld_error
);
1487 if (ld_errno
== LDAP_SERVER_DOWN
) {
1488 ldap_unbind(ldap_state
->ldap_struct
);
1489 ldap_state
->ldap_struct
= NULL
;
1498 int smbldap_extended_operation(struct smbldap_state
*ldap_state
,
1499 LDAP_CONST
char *reqoid
, struct berval
*reqdata
,
1500 LDAPControl
**serverctrls
, LDAPControl
**clientctrls
,
1501 char **retoidp
, struct berval
**retdatap
)
1503 int rc
= LDAP_SERVER_DOWN
;
1505 time_t endtime
= time(NULL
)+lp_ldap_timeout();
1510 while (another_ldap_try(ldap_state
, &rc
, &attempts
, endtime
)) {
1511 rc
= ldap_extended_operation_s(ldap_state
->ldap_struct
, reqoid
,
1512 reqdata
, serverctrls
,
1513 clientctrls
, retoidp
, retdatap
);
1514 if (rc
!= LDAP_SUCCESS
) {
1515 char *ld_error
= NULL
;
1518 ldap_get_option(ldap_state
->ldap_struct
,
1519 LDAP_OPT_ERROR_NUMBER
, &ld_errno
);
1521 ldap_get_option(ldap_state
->ldap_struct
,
1522 LDAP_OPT_ERROR_STRING
, &ld_error
);
1523 DEBUG(10, ("Extended operation failed with error: "
1524 "%d (%s) (%s)\n", ld_errno
,
1525 ldap_err2string(rc
),
1526 ld_error
? ld_error
: "unknown"));
1527 SAFE_FREE(ld_error
);
1529 if (ld_errno
== LDAP_SERVER_DOWN
) {
1530 ldap_unbind(ldap_state
->ldap_struct
);
1531 ldap_state
->ldap_struct
= NULL
;
1539 /*******************************************************************
1540 run the search by name.
1541 ******************************************************************/
1542 int smbldap_search_suffix (struct smbldap_state
*ldap_state
,
1543 const char *filter
, const char **search_attr
,
1544 LDAPMessage
** result
)
1546 return smbldap_search(ldap_state
, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE
,
1547 filter
, search_attr
, 0, result
);
1550 static void smbldap_idle_fn(struct event_context
*event_ctx
,
1551 struct timed_event
*te
,
1552 const struct timeval
*now
,
1555 struct smbldap_state
*state
= (struct smbldap_state
*)private_data
;
1557 TALLOC_FREE(state
->idle_event
);
1559 if (state
->ldap_struct
== NULL
) {
1560 DEBUG(10,("ldap connection not connected...\n"));
1564 if ((state
->last_use
+SMBLDAP_IDLE_TIME
) > now
->tv_sec
) {
1565 DEBUG(10,("ldap connection not idle...\n"));
1567 state
->idle_event
= event_add_timed(
1569 timeval_add(now
, SMBLDAP_IDLE_TIME
, 0),
1570 "smbldap_idle_fn", smbldap_idle_fn
,
1575 DEBUG(7,("ldap connection idle...closing connection\n"));
1576 smbldap_close(state
);
1579 /**********************************************************************
1581 *********************************************************************/
1583 void smbldap_free_struct(struct smbldap_state
**ldap_state
)
1585 smbldap_close(*ldap_state
);
1587 if ((*ldap_state
)->bind_secret
) {
1588 memset((*ldap_state
)->bind_secret
, '\0', strlen((*ldap_state
)->bind_secret
));
1591 SAFE_FREE((*ldap_state
)->bind_dn
);
1592 SAFE_FREE((*ldap_state
)->bind_secret
);
1594 TALLOC_FREE((*ldap_state
)->idle_event
);
1598 /* No need to free any further, as it is talloc()ed */
1602 /**********************************************************************
1603 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1604 *********************************************************************/
1606 NTSTATUS
smbldap_init(TALLOC_CTX
*mem_ctx
, struct event_context
*event_ctx
,
1607 const char *location
,
1608 struct smbldap_state
**smbldap_state
)
1610 *smbldap_state
= TALLOC_ZERO_P(mem_ctx
, struct smbldap_state
);
1611 if (!*smbldap_state
) {
1612 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1613 return NT_STATUS_NO_MEMORY
;
1617 (*smbldap_state
)->uri
= talloc_strdup(mem_ctx
, location
);
1619 (*smbldap_state
)->uri
= "ldap://localhost";
1622 (*smbldap_state
)->event_context
= event_ctx
;
1624 return NT_STATUS_OK
;
1627 /*******************************************************************
1628 Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1629 ********************************************************************/
1630 char *smbldap_get_dn(LDAP
*ld
, LDAPMessage
*entry
)
1632 char *utf8_dn
, *unix_dn
;
1634 utf8_dn
= ldap_get_dn(ld
, entry
);
1636 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1639 if (pull_utf8_allocate(&unix_dn
, utf8_dn
) == (size_t)-1) {
1640 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 [%s]\n", utf8_dn
));
1643 ldap_memfree(utf8_dn
);
1647 const char *smbldap_talloc_dn(TALLOC_CTX
*mem_ctx
, LDAP
*ld
,
1650 char *utf8_dn
, *unix_dn
;
1652 utf8_dn
= ldap_get_dn(ld
, entry
);
1654 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1657 if (pull_utf8_talloc(mem_ctx
, &unix_dn
, utf8_dn
) == (size_t)-1) {
1658 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1659 "[%s]\n", utf8_dn
));
1662 ldap_memfree(utf8_dn
);
1666 /*******************************************************************
1667 Check if root-dse has a certain Control or Extension
1668 ********************************************************************/
1670 static bool smbldap_check_root_dse(LDAP
*ld
, const char **attrs
, const char *value
)
1672 LDAPMessage
*msg
= NULL
;
1673 LDAPMessage
*entry
= NULL
;
1674 char **values
= NULL
;
1675 int rc
, num_result
, num_values
, i
;
1676 bool result
= False
;
1679 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1683 if (!strequal(attrs
[0], "supportedExtension") &&
1684 !strequal(attrs
[0], "supportedControl") &&
1685 !strequal(attrs
[0], "namingContexts")) {
1686 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs
[0]));
1690 rc
= ldap_search_s(ld
, "", LDAP_SCOPE_BASE
,
1691 "(objectclass=*)", CONST_DISCARD(char **, attrs
), 0 , &msg
);
1693 if (rc
!= LDAP_SUCCESS
) {
1694 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1698 num_result
= ldap_count_entries(ld
, msg
);
1700 if (num_result
!= 1) {
1701 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result
));
1705 entry
= ldap_first_entry(ld
, msg
);
1707 if (entry
== NULL
) {
1708 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1712 values
= ldap_get_values(ld
, entry
, attrs
[0]);
1714 if (values
== NULL
) {
1715 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs
[0]));
1719 num_values
= ldap_count_values(values
);
1721 if (num_values
== 0) {
1722 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs
[0]));
1726 for (i
=0; i
<num_values
; i
++) {
1727 if (strcmp(values
[i
], value
) == 0)
1734 ldap_value_free(values
);
1742 /*******************************************************************
1743 Check if LDAP-Server supports a certain Control (OID in string format)
1744 ********************************************************************/
1746 bool smbldap_has_control(LDAP
*ld
, const char *control
)
1748 const char *attrs
[] = { "supportedControl", NULL
};
1749 return smbldap_check_root_dse(ld
, attrs
, control
);
1752 /*******************************************************************
1753 Check if LDAP-Server supports a certain Extension (OID in string format)
1754 ********************************************************************/
1756 bool smbldap_has_extension(LDAP
*ld
, const char *extension
)
1758 const char *attrs
[] = { "supportedExtension", NULL
};
1759 return smbldap_check_root_dse(ld
, attrs
, extension
);
1762 /*******************************************************************
1763 Check if LDAP-Server holds a given namingContext
1764 ********************************************************************/
1766 bool smbldap_has_naming_context(LDAP
*ld
, const char *naming_context
)
1768 const char *attrs
[] = { "namingContexts", NULL
};
1769 return smbldap_check_root_dse(ld
, attrs
, naming_context
);
1772 bool smbldap_set_creds(struct smbldap_state
*ldap_state
, bool anon
, const char *dn
, const char *secret
)
1774 ldap_state
->anonymous
= anon
;
1776 /* free any previously set credential */
1778 SAFE_FREE(ldap_state
->bind_dn
);
1779 if (ldap_state
->bind_secret
) {
1780 /* make sure secrets are zeroed out of memory */
1781 memset(ldap_state
->bind_secret
, '\0', strlen(ldap_state
->bind_secret
));
1782 SAFE_FREE(ldap_state
->bind_secret
);
1786 ldap_state
->bind_dn
= SMB_STRDUP(dn
);
1787 ldap_state
->bind_secret
= SMB_STRDUP(secret
);