2 Unix SMB/CIFS implementation.
3 LDAP protocol helper functions for SAMBA
4 Copyright (C) Jean François Micouleau 1998
5 Copyright (C) Gerald Carter 2001-2003
6 Copyright (C) Shahms King 2001
7 Copyright (C) Andrew Bartlett 2002-2003
8 Copyright (C) Stefan (metze) Metzmacher 2002-2003
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #ifndef LDAP_OPT_SUCCESS
29 #define LDAP_OPT_SUCCESS 0
32 /* Try not to hit the up or down server forever */
34 #define SMBLDAP_DONT_PING_TIME 10 /* ping only all 10 seconds */
35 #define SMBLDAP_NUM_RETRIES 8 /* retry only 8 times */
37 #define SMBLDAP_IDLE_TIME 150 /* After 2.5 minutes disconnect */
40 /* attributes used by Samba 2.2 */
42 ATTRIB_MAP_ENTRY attrib_map_v22[] = {
43 { LDAP_ATTR_UID, "uid" },
44 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
45 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
46 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
47 { LDAP_ATTR_PWD_LAST_SET, "pwdLastSet" },
48 { LDAP_ATTR_PWD_CAN_CHANGE, "pwdCanChange" },
49 { LDAP_ATTR_PWD_MUST_CHANGE, "pwdMustChange" },
50 { LDAP_ATTR_LOGON_TIME, "logonTime" },
51 { LDAP_ATTR_LOGOFF_TIME, "logoffTime" },
52 { LDAP_ATTR_KICKOFF_TIME, "kickoffTime" },
53 { LDAP_ATTR_CN, "cn" },
54 { LDAP_ATTR_SN, "sn" },
55 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
56 { LDAP_ATTR_HOME_PATH, "smbHome" },
57 { LDAP_ATTR_HOME_DRIVE, "homeDrive" },
58 { LDAP_ATTR_LOGON_SCRIPT, "scriptPath" },
59 { LDAP_ATTR_PROFILE_PATH, "profilePath" },
60 { LDAP_ATTR_DESC, "description" },
61 { LDAP_ATTR_USER_WKS, "userWorkstations"},
62 { LDAP_ATTR_USER_RID, "rid" },
63 { LDAP_ATTR_PRIMARY_GROUP_RID, "primaryGroupID"},
64 { LDAP_ATTR_LMPW, "lmPassword" },
65 { LDAP_ATTR_NTPW, "ntPassword" },
66 { LDAP_ATTR_DOMAIN, "domain" },
67 { LDAP_ATTR_OBJCLASS, "objectClass" },
68 { LDAP_ATTR_ACB_INFO, "acctFlags" },
69 { LDAP_ATTR_MOD_TIMESTAMP, "modifyTimestamp" },
70 { LDAP_ATTR_LIST_END, NULL }
73 ATTRIB_MAP_ENTRY attrib_map_to_delete_v22[] = {
74 { LDAP_ATTR_PWD_LAST_SET, "pwdLastSet" },
75 { LDAP_ATTR_PWD_CAN_CHANGE, "pwdCanChange" },
76 { LDAP_ATTR_PWD_MUST_CHANGE, "pwdMustChange" },
77 { LDAP_ATTR_LOGON_TIME, "logonTime" },
78 { LDAP_ATTR_LOGOFF_TIME, "logoffTime" },
79 { LDAP_ATTR_KICKOFF_TIME, "kickoffTime" },
80 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
81 { LDAP_ATTR_HOME_PATH, "smbHome" },
82 { LDAP_ATTR_HOME_DRIVE, "homeDrives" },
83 { LDAP_ATTR_LOGON_SCRIPT, "scriptPath" },
84 { LDAP_ATTR_PROFILE_PATH, "profilePath" },
85 { LDAP_ATTR_USER_WKS, "userWorkstations"},
86 { LDAP_ATTR_USER_RID, "rid" },
87 { LDAP_ATTR_PRIMARY_GROUP_RID, "primaryGroupID"},
88 { LDAP_ATTR_LMPW, "lmPassword" },
89 { LDAP_ATTR_NTPW, "ntPassword" },
90 { LDAP_ATTR_DOMAIN, "domain" },
91 { LDAP_ATTR_ACB_INFO, "acctFlags" },
92 { LDAP_ATTR_LIST_END, NULL }
95 /* attributes used by Samba 3.0's sambaSamAccount */
97 ATTRIB_MAP_ENTRY attrib_map_v30[] = {
98 { LDAP_ATTR_UID, "uid" },
99 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
100 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
101 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
102 { LDAP_ATTR_PWD_LAST_SET, "sambaPwdLastSet" },
103 { LDAP_ATTR_PWD_CAN_CHANGE, "sambaPwdCanChange" },
104 { LDAP_ATTR_PWD_MUST_CHANGE, "sambaPwdMustChange" },
105 { LDAP_ATTR_LOGON_TIME, "sambaLogonTime" },
106 { LDAP_ATTR_LOGOFF_TIME, "sambaLogoffTime" },
107 { LDAP_ATTR_KICKOFF_TIME, "sambaKickoffTime" },
108 { LDAP_ATTR_CN, "cn" },
109 { LDAP_ATTR_SN, "sn" },
110 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
111 { LDAP_ATTR_HOME_DRIVE, "sambaHomeDrive" },
112 { LDAP_ATTR_HOME_PATH, "sambaHomePath" },
113 { LDAP_ATTR_LOGON_SCRIPT, "sambaLogonScript" },
114 { LDAP_ATTR_PROFILE_PATH, "sambaProfilePath" },
115 { LDAP_ATTR_DESC, "description" },
116 { LDAP_ATTR_USER_WKS, "sambaUserWorkstations" },
117 { LDAP_ATTR_USER_SID, LDAP_ATTRIBUTE_SID },
118 { LDAP_ATTR_PRIMARY_GROUP_SID, "sambaPrimaryGroupSID" },
119 { LDAP_ATTR_LMPW, "sambaLMPassword" },
120 { LDAP_ATTR_NTPW, "sambaNTPassword" },
121 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
122 { LDAP_ATTR_OBJCLASS, "objectClass" },
123 { LDAP_ATTR_ACB_INFO, "sambaAcctFlags" },
124 { LDAP_ATTR_MUNGED_DIAL, "sambaMungedDial" },
125 { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
126 { LDAP_ATTR_BAD_PASSWORD_TIME, "sambaBadPasswordTime" },
127 { LDAP_ATTR_PWD_HISTORY, "sambaPasswordHistory" },
128 { LDAP_ATTR_MOD_TIMESTAMP, "modifyTimestamp" },
129 { LDAP_ATTR_LOGON_HOURS, "sambaLogonHours" },
130 { LDAP_ATTR_LIST_END, NULL }
133 ATTRIB_MAP_ENTRY attrib_map_to_delete_v30[] = {
134 { LDAP_ATTR_PWD_LAST_SET, "sambaPwdLastSet" },
135 { LDAP_ATTR_PWD_CAN_CHANGE, "sambaPwdCanChange" },
136 { LDAP_ATTR_PWD_MUST_CHANGE, "sambaPwdMustChange" },
137 { LDAP_ATTR_LOGON_TIME, "sambaLogonTime" },
138 { LDAP_ATTR_LOGOFF_TIME, "sambaLogoffTime" },
139 { LDAP_ATTR_KICKOFF_TIME, "sambaKickoffTime" },
140 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
141 { LDAP_ATTR_HOME_DRIVE, "sambaHomeDrive" },
142 { LDAP_ATTR_HOME_PATH, "sambaHomePath" },
143 { LDAP_ATTR_LOGON_SCRIPT, "sambaLogonScript" },
144 { LDAP_ATTR_PROFILE_PATH, "sambaProfilePath" },
145 { LDAP_ATTR_USER_WKS, "sambaUserWorkstations" },
146 { LDAP_ATTR_USER_SID, LDAP_ATTRIBUTE_SID },
147 { LDAP_ATTR_PRIMARY_GROUP_SID, "sambaPrimaryGroupSID" },
148 { LDAP_ATTR_LMPW, "sambaLMPassword" },
149 { LDAP_ATTR_NTPW, "sambaNTPassword" },
150 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
151 { LDAP_ATTR_ACB_INFO, "sambaAcctFlags" },
152 { LDAP_ATTR_MUNGED_DIAL, "sambaMungedDial" },
153 { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
154 { LDAP_ATTR_BAD_PASSWORD_TIME, "sambaBadPasswordTime" },
155 { LDAP_ATTR_PWD_HISTORY, "sambaPasswordHistory" },
156 { LDAP_ATTR_LOGON_HOURS, "sambaLogonHours" },
157 { LDAP_ATTR_LIST_END, NULL }
160 /* attributes used for allocating RIDs */
162 ATTRIB_MAP_ENTRY dominfo_attr_list[] = {
163 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
164 { LDAP_ATTR_NEXT_RID, "sambaNextRid" },
165 { LDAP_ATTR_NEXT_USERRID, "sambaNextUserRid" },
166 { LDAP_ATTR_NEXT_GROUPRID, "sambaNextGroupRid" },
167 { LDAP_ATTR_DOM_SID, LDAP_ATTRIBUTE_SID },
168 { LDAP_ATTR_ALGORITHMIC_RID_BASE,"sambaAlgorithmicRidBase"},
169 { LDAP_ATTR_OBJCLASS, "objectClass" },
170 { LDAP_ATTR_LIST_END, NULL },
173 /* Samba 3.0 group mapping attributes */
175 ATTRIB_MAP_ENTRY groupmap_attr_list[] = {
176 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
177 { LDAP_ATTR_GROUP_SID, LDAP_ATTRIBUTE_SID },
178 { LDAP_ATTR_GROUP_TYPE, "sambaGroupType" },
179 { LDAP_ATTR_SID_LIST, "sambaSIDList" },
180 { LDAP_ATTR_DESC, "description" },
181 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
182 { LDAP_ATTR_CN, "cn" },
183 { LDAP_ATTR_OBJCLASS, "objectClass" },
184 { LDAP_ATTR_LIST_END, NULL }
187 ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete[] = {
188 { LDAP_ATTR_GROUP_SID, LDAP_ATTRIBUTE_SID },
189 { LDAP_ATTR_GROUP_TYPE, "sambaGroupType" },
190 { LDAP_ATTR_DESC, "description" },
191 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
192 { LDAP_ATTR_SID_LIST, "sambaSIDList" },
193 { LDAP_ATTR_LIST_END, NULL }
196 /* idmap_ldap sambaUnixIdPool */
198 ATTRIB_MAP_ENTRY idpool_attr_list[] = {
199 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
200 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
201 { LDAP_ATTR_OBJCLASS, "objectClass" },
202 { LDAP_ATTR_LIST_END, NULL }
205 ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
206 { LDAP_ATTR_SID, LDAP_ATTRIBUTE_SID },
207 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
208 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
209 { LDAP_ATTR_OBJCLASS, "objectClass" },
210 { LDAP_ATTR_LIST_END, NULL }
213 /**********************************************************************
214 perform a simple table lookup and return the attribute name
215 **********************************************************************/
217 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table[], int key )
221 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
222 if ( table[i].attrib == key )
223 return table[i].name;
231 /**********************************************************************
232 Return the list of attribute names from a mapping table
233 **********************************************************************/
235 const char** get_attr_list( TALLOC_CTX *mem_ctx, ATTRIB_MAP_ENTRY table[] )
240 while ( table[i].attrib != LDAP_ATTR_LIST_END )
244 names = TALLOC_ARRAY( mem_ctx, const char*, i );
246 DEBUG(0,("get_attr_list: out of memory\n"));
251 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
252 names[i] = talloc_strdup( names, table[i].name );
260 /*******************************************************************
261 Search an attribute and return the first value found.
262 ******************************************************************/
264 bool smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
265 const char *attribute, char *value,
275 if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
276 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
281 if (convert_string(CH_UTF8, CH_UNIX,values[0], -1, value, max_len, False) == (size_t)-1) {
282 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
283 attribute, values[0]));
284 ldap_value_free(values);
288 ldap_value_free(values);
289 #ifdef DEBUG_PASSWORDS
290 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
295 char * smbldap_talloc_single_attribute(LDAP *ldap_struct, LDAPMessage *entry,
296 const char *attribute,
301 size_t converted_size;
303 if (attribute == NULL) {
307 values = ldap_get_values(ldap_struct, entry, attribute);
309 if (values == NULL) {
310 DEBUG(10, ("attribute %s does not exist\n", attribute));
314 if (ldap_count_values(values) != 1) {
315 DEBUG(10, ("attribute %s has %d values, expected only one\n",
316 attribute, ldap_count_values(values)));
317 ldap_value_free(values);
321 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
322 DEBUG(10, ("pull_utf8_talloc failed\n"));
323 ldap_value_free(values);
327 ldap_value_free(values);
329 #ifdef DEBUG_PASSWORDS
330 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
336 char * smbldap_talloc_smallest_attribute(LDAP *ldap_struct, LDAPMessage *entry,
337 const char *attribute,
342 size_t converted_size;
345 if (attribute == NULL) {
349 values = ldap_get_values(ldap_struct, entry, attribute);
351 if (values == NULL) {
352 DEBUG(10, ("attribute %s does not exist\n", attribute));
356 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
357 DEBUG(10, ("pull_utf8_talloc failed\n"));
358 ldap_value_free(values);
362 num_values = ldap_count_values(values);
364 for (i=1; i<num_values; i++) {
367 if (!pull_utf8_talloc(mem_ctx, &tmp, values[i],
369 DEBUG(10, ("pull_utf8_talloc failed\n"));
371 ldap_value_free(values);
375 if (StrCaseCmp(tmp, result) < 0) {
383 ldap_value_free(values);
385 #ifdef DEBUG_PASSWORDS
386 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
392 bool smbldap_talloc_single_blob(TALLOC_CTX *mem_ctx, LDAP *ld,
393 LDAPMessage *msg, const char *attrib,
396 struct berval **values;
398 values = ldap_get_values_len(ld, msg, attrib);
403 if (ldap_count_values_len(values) != 1) {
404 DEBUG(10, ("Expected one value for %s, got %d\n", attrib,
405 ldap_count_values_len(values)));
409 *blob = data_blob_talloc(mem_ctx, values[0]->bv_val,
411 ldap_value_free_len(values);
413 return (blob->data != NULL);
416 bool smbldap_pull_sid(LDAP *ld, LDAPMessage *msg, const char *attrib,
422 if (!smbldap_talloc_single_blob(talloc_tos(), ld, msg, attrib,
426 ret = sid_parse((char *)blob.data, blob.length, sid);
427 TALLOC_FREE(blob.data);
431 static int ldapmsg_destructor(LDAPMessage **result) {
432 ldap_msgfree(*result);
436 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
438 LDAPMessage **handle;
440 if (result == NULL) {
444 handle = TALLOC_P(mem_ctx, LDAPMessage *);
445 SMB_ASSERT(handle != NULL);
448 talloc_set_destructor(handle, ldapmsg_destructor);
451 static int ldapmod_destructor(LDAPMod ***mod) {
452 ldap_mods_free(*mod, True);
456 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
464 handle = TALLOC_P(mem_ctx, LDAPMod **);
465 SMB_ASSERT(handle != NULL);
468 talloc_set_destructor(handle, ldapmod_destructor);
471 /************************************************************************
472 Routine to manage the LDAPMod structure array
473 manage memory used by the array, by each struct, and values
474 ***********************************************************************/
476 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
484 /* sanity checks on the mod values */
486 if (attribute == NULL || *attribute == '\0') {
490 #if 0 /* commented out after discussion with abartlet. Do not reenable.
491 left here so other do not re-add similar code --jerry */
492 if (value == NULL || *value == '\0')
497 mods = SMB_MALLOC_P(LDAPMod *);
499 smb_panic("smbldap_set_mod: out of memory!");
505 for (i = 0; mods[i] != NULL; ++i) {
506 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
510 if (mods[i] == NULL) {
511 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
513 smb_panic("smbldap_set_mod: out of memory!");
516 mods[i] = SMB_MALLOC_P(LDAPMod);
517 if (mods[i] == NULL) {
518 smb_panic("smbldap_set_mod: out of memory!");
521 mods[i]->mod_op = modop;
522 mods[i]->mod_values = NULL;
523 mods[i]->mod_type = SMB_STRDUP(attribute);
528 char *utf8_value = NULL;
529 size_t converted_size;
532 if (mods[i]->mod_values != NULL) {
533 for (; mods[i]->mod_values[j] != NULL; j++);
535 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
537 if (mods[i]->mod_values == NULL) {
538 smb_panic("smbldap_set_mod: out of memory!");
542 if (!push_utf8_talloc(talloc_tos(), &utf8_value, value, &converted_size)) {
543 smb_panic("smbldap_set_mod: String conversion failure!");
548 mods[i]->mod_values[j] = SMB_STRDUP(utf8_value);
549 TALLOC_FREE(utf8_value);
550 SMB_ASSERT(mods[i]->mod_values[j] != NULL);
552 mods[i]->mod_values[j + 1] = NULL;
557 /**********************************************************************
558 Set attribute to newval in LDAP, regardless of what value the
559 attribute had in LDAP before.
560 *********************************************************************/
562 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
564 const char *attribute, const char *newval)
566 char oldval[2048]; /* current largest allowed value is mungeddial */
569 if (attribute == NULL) {
570 /* This can actually happen for ldapsam_compat where we for
571 * example don't have a password history */
575 if (existing != NULL) {
576 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
582 /* all of our string attributes are case insensitive */
584 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
586 /* Believe it or not, but LDAP will deny a delete and
587 an add at the same time if the values are the
589 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
594 /* There has been no value before, so don't delete it.
595 * Here's a possible race: We might end up with
596 * duplicate attributes */
597 /* By deleting exactly the value we found in the entry this
598 * should be race-free in the sense that the LDAP-Server will
599 * deny the complete operation if somebody changed the
600 * attribute behind our back. */
601 /* This will also allow modifying single valued attributes
602 * in Novell NDS. In NDS you have to first remove attribute and then
603 * you could add new value */
605 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
606 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
609 /* Regardless of the real operation (add or modify)
610 we add the new value here. We rely on deleting
611 the old value, should it exist. */
613 if ((newval != NULL) && (strlen(newval) > 0)) {
614 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
615 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
619 /**********************************************************************
620 Some varients of the LDAP rebind code do not pass in the third 'arg'
621 pointer to a void*, so we try and work around it by assuming that the
622 value of the 'LDAP *' pointer is the same as the one we had passed in
623 **********************************************************************/
625 struct smbldap_state_lookup {
627 struct smbldap_state *smbldap_state;
628 struct smbldap_state_lookup *prev, *next;
631 static struct smbldap_state_lookup *smbldap_state_lookup_list;
633 static struct smbldap_state *smbldap_find_state(LDAP *ld)
635 struct smbldap_state_lookup *t;
637 for (t = smbldap_state_lookup_list; t; t = t->next) {
639 return t->smbldap_state;
645 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
647 struct smbldap_state_lookup *t;
649 for (t = smbldap_state_lookup_list; t; t = t->next) {
650 if (t->smbldap_state == smbldap_state) {
651 DLIST_REMOVE(smbldap_state_lookup_list, t);
658 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
660 struct smbldap_state *tmp_ldap_state;
661 struct smbldap_state_lookup *t;
663 if ((tmp_ldap_state = smbldap_find_state(ld))) {
664 SMB_ASSERT(tmp_ldap_state == smbldap_state);
668 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
671 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
673 t->smbldap_state = smbldap_state;
676 /********************************************************************
677 start TLS on an existing LDAP connection
678 *******************************************************************/
680 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
682 #ifdef LDAP_OPT_X_TLS
686 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
690 #ifdef LDAP_OPT_X_TLS
691 if (version != LDAP_VERSION3) {
692 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
693 return LDAP_OPERATIONS_ERROR;
696 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
697 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
698 ldap_err2string(rc)));
702 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
705 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
706 return LDAP_OPERATIONS_ERROR;
710 /********************************************************************
711 setup a connection to the LDAP server based on a uri
712 *******************************************************************/
714 int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
718 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
720 #ifdef HAVE_LDAP_INITIALIZE
722 rc = ldap_initialize(ldap_struct, uri);
724 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
730 /* Parse the string manually */
736 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
739 /* skip leading "URL:" (if any) */
740 if ( strnequal( uri, "URL:", 4 ) ) {
744 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
747 if (strequal(protocol, "ldap")) {
749 } else if (strequal(protocol, "ldaps")) {
752 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
756 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
757 DEBUG(0, ("ldap_init failed !\n"));
758 return LDAP_OPERATIONS_ERROR;
761 if (strequal(protocol, "ldaps")) {
762 #ifdef LDAP_OPT_X_TLS
763 int tls = LDAP_OPT_X_TLS_HARD;
764 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
766 DEBUG(0, ("Failed to setup a TLS session\n"));
769 DEBUG(3,("LDAPS option set...!\n"));
771 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
772 return LDAP_OPERATIONS_ERROR;
773 #endif /* LDAP_OPT_X_TLS */
776 #endif /* HAVE_LDAP_INITIALIZE */
779 /* now set connection timeout */
780 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
782 int ct = lp_ldap_connection_timeout()*1000;
783 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
784 if (rc != LDAP_SUCCESS) {
785 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
786 ct, ldap_err2string(rc)));
789 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
793 ct.tv_sec = lp_ldap_connection_timeout();
794 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
795 if (rc != LDAP_SUCCESS) {
796 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
797 (int)ct.tv_sec, ldap_err2string(rc)));
805 /********************************************************************
806 try to upgrade to Version 3 LDAP if not already, in either case return current
808 *******************************************************************/
810 int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
815 /* assume the worst */
816 *new_version = LDAP_VERSION2;
818 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
823 if (version == LDAP_VERSION3) {
824 *new_version = LDAP_VERSION3;
829 version = LDAP_VERSION3;
830 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
835 *new_version = LDAP_VERSION3;
839 /*******************************************************************
840 open a connection to the ldap server (just until the bind)
841 ******************************************************************/
843 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
847 rc = smb_ldap_setup_conn(ldap_struct, uri);
852 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
857 rc = smb_ldap_start_tls(*ldap_struct, version);
865 /*******************************************************************
866 open a connection to the ldap server.
867 ******************************************************************/
868 static int smbldap_open_connection (struct smbldap_state *ldap_state)
871 int rc = LDAP_SUCCESS;
873 LDAP **ldap_struct = &ldap_state->ldap_struct;
875 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
880 /* Store the LDAP pointer in a lookup list */
882 smbldap_store_state(*ldap_struct, ldap_state);
884 /* Upgrade to LDAPv3 if possible */
886 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
891 /* Start TLS if required */
893 rc = smb_ldap_start_tls(*ldap_struct, version);
898 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
902 /*******************************************************************
903 a rebind function for authenticated referrals
904 This version takes a void* that we can shove useful stuff in :-)
905 ******************************************************************/
906 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
908 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
909 int *methodp, int freeit, void *arg)
911 struct smbldap_state *ldap_state = arg;
913 /** @TODO Should we be doing something to check what servers we rebind to?
914 Could we get a referral to a machine that we don't want to give our
915 username and password to? */
920 memset(*credp, '\0', strlen(*credp));
924 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
925 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
927 if (ldap_state->anonymous) {
931 *whop = SMB_STRDUP(ldap_state->bind_dn);
933 return LDAP_NO_MEMORY;
935 *credp = SMB_STRDUP(ldap_state->bind_secret);
938 return LDAP_NO_MEMORY;
941 *methodp = LDAP_AUTH_SIMPLE;
944 GetTimeOfDay(&ldap_state->last_rebind);
948 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
950 /*******************************************************************
951 a rebind function for authenticated referrals
952 This version takes a void* that we can shove useful stuff in :-)
953 and actually does the connection.
954 ******************************************************************/
955 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
956 static int rebindproc_connect_with_state (LDAP *ldap_struct,
957 LDAP_CONST char *url,
959 ber_int_t msgid, void *arg)
961 struct smbldap_state *ldap_state =
962 (struct smbldap_state *)arg;
966 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
967 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
969 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
970 * itself) before rebinding to another LDAP server to avoid to expose
971 * our credentials. At least *try* to secure the connection - Guenther */
973 smb_ldap_upgrade_conn(ldap_struct, &version);
974 smb_ldap_start_tls(ldap_struct, version);
976 /** @TODO Should we be doing something to check what servers we rebind to?
977 Could we get a referral to a machine that we don't want to give our
978 username and password to? */
980 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
982 /* only set the last rebind timestamp when we did rebind after a
983 * non-read LDAP operation. That way we avoid the replication sleep
984 * after a simple redirected search operation - Guenther */
988 case LDAP_REQ_MODIFY:
990 case LDAP_REQ_DELETE:
992 case LDAP_REQ_EXTENDED:
993 DEBUG(10,("rebindproc_connect_with_state: "
994 "setting last_rebind timestamp "
995 "(req: 0x%02x)\n", (unsigned int)request));
996 GetTimeOfDay(&ldap_state->last_rebind);
999 ZERO_STRUCT(ldap_state->last_rebind);
1005 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1007 /*******************************************************************
1008 Add a rebind function for authenticated referrals
1009 ******************************************************************/
1010 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1012 # if LDAP_SET_REBIND_PROC_ARGS == 2
1013 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
1014 int *method, int freeit )
1016 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
1018 return rebindproc_with_state(ldap_struct, whop, credp,
1019 method, freeit, ldap_state);
1022 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1023 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1025 /*******************************************************************
1026 a rebind function for authenticated referrals
1027 this also does the connection, but no void*.
1028 ******************************************************************/
1029 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1030 # if LDAP_SET_REBIND_PROC_ARGS == 2
1031 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
1034 struct smbldap_state *ldap_state = smbldap_find_state(ld);
1036 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
1039 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1040 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1042 /*******************************************************************
1043 connect to the ldap server under system privilege.
1044 ******************************************************************/
1045 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
1050 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
1052 /* get the default dn and password only if they are not set already */
1053 if (!fetch_ldap_pw(&ldap_state->bind_dn, &ldap_state->bind_secret)) {
1054 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
1055 return LDAP_INVALID_CREDENTIALS;
1059 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
1060 (OpenLDAP) doesnt' seem to support it */
1062 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
1063 ldap_state->uri, ldap_state->bind_dn));
1065 #ifdef HAVE_LDAP_SET_REBIND_PROC
1066 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1067 # if LDAP_SET_REBIND_PROC_ARGS == 2
1068 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
1070 # if LDAP_SET_REBIND_PROC_ARGS == 3
1071 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
1073 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1074 # if LDAP_SET_REBIND_PROC_ARGS == 2
1075 ldap_set_rebind_proc(ldap_struct, &rebindproc);
1077 # if LDAP_SET_REBIND_PROC_ARGS == 3
1078 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
1080 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1083 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1085 if (rc != LDAP_SUCCESS) {
1086 char *ld_error = NULL;
1087 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
1089 DEBUG(ldap_state->num_failures ? 2 : 0,
1090 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
1092 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
1093 ldap_err2string(rc),
1094 ld_error ? ld_error : "(unknown)"));
1095 SAFE_FREE(ld_error);
1096 ldap_state->num_failures++;
1100 ldap_state->num_failures = 0;
1101 ldap_state->paged_results = False;
1103 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1105 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1106 ldap_state->paged_results = True;
1109 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1110 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1111 ldap_state->paged_results ? "does" : "does not"));
1115 static void smbldap_idle_fn(struct event_context *event_ctx,
1116 struct timed_event *te,
1118 void *private_data);
1120 /**********************************************************************
1121 Connect to LDAP server (called before every ldap operation)
1122 *********************************************************************/
1123 static int smbldap_open(struct smbldap_state *ldap_state)
1126 bool reopen = False;
1127 SMB_ASSERT(ldap_state);
1129 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1131 #ifdef HAVE_UNIXSOCKET
1132 struct sockaddr_un addr;
1134 struct sockaddr addr;
1136 socklen_t len = sizeof(addr);
1139 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1140 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1143 #ifdef HAVE_UNIXSOCKET
1144 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1148 /* the other end has died. reopen. */
1149 ldap_unbind(ldap_state->ldap_struct);
1150 ldap_state->ldap_struct = NULL;
1151 ldap_state->last_ping = (time_t)0;
1153 ldap_state->last_ping = time(NULL);
1157 if (ldap_state->ldap_struct != NULL) {
1158 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1159 return LDAP_SUCCESS;
1162 if ((rc = smbldap_open_connection(ldap_state))) {
1166 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1167 ldap_unbind(ldap_state->ldap_struct);
1168 ldap_state->ldap_struct = NULL;
1173 ldap_state->last_ping = time(NULL);
1174 ldap_state->pid = sys_getpid();
1176 TALLOC_FREE(ldap_state->idle_event);
1178 if (ldap_state->event_context != NULL) {
1179 ldap_state->idle_event = event_add_timed(
1180 ldap_state->event_context, NULL,
1181 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1182 smbldap_idle_fn, ldap_state);
1185 DEBUG(4,("The LDAP server is successfully connected\n"));
1187 return LDAP_SUCCESS;
1190 /**********************************************************************
1191 Disconnect from LDAP server
1192 *********************************************************************/
1193 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1196 return NT_STATUS_INVALID_PARAMETER;
1198 if (ldap_state->ldap_struct != NULL) {
1199 ldap_unbind(ldap_state->ldap_struct);
1200 ldap_state->ldap_struct = NULL;
1203 smbldap_delete_state(ldap_state);
1205 DEBUG(5,("The connection to the LDAP server was closed\n"));
1206 /* maybe free the results here --metze */
1208 return NT_STATUS_OK;
1211 static bool got_alarm;
1213 static void (*old_handler)(int);
1215 static void gotalarm_sig(int dummy)
1220 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1221 int *attempts, time_t endtime)
1223 time_t now = time(NULL);
1224 int open_rc = LDAP_SERVER_DOWN;
1226 if (*rc != LDAP_SERVER_DOWN)
1229 if (now >= endtime) {
1230 smbldap_close(ldap_state);
1235 if (*attempts == 0) {
1237 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1238 alarm(endtime - now);
1240 if (ldap_state->pid != sys_getpid())
1241 smbldap_close(ldap_state);
1251 open_rc = smbldap_open(ldap_state);
1253 if (open_rc == LDAP_SUCCESS) {
1254 ldap_state->last_use = now;
1258 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1259 /* The fact that we are non-root or any other
1260 * access-denied condition will not change in the next
1261 * round of trying */
1271 if (open_rc != LDAP_SUCCESS) {
1272 DEBUG(1, ("Connection to LDAP server failed for the "
1273 "%d try!\n", *attempts));
1278 CatchSignal(SIGALRM, old_handler);
1280 ldap_state->last_use = now;
1284 /*********************************************************************
1285 ********************************************************************/
1287 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1288 const char *base, int scope, const char *filter,
1289 const char *attrs[], int attrsonly,
1290 LDAPControl **sctrls, LDAPControl **cctrls,
1291 int sizelimit, LDAPMessage **res)
1293 int rc = LDAP_SERVER_DOWN;
1296 time_t endtime = time(NULL)+lp_ldap_timeout();
1297 struct timeval timeout;
1298 size_t converted_size;
1300 SMB_ASSERT(ldap_state);
1302 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1303 "scope => [%d]\n", base, filter, scope));
1305 if (ldap_state->last_rebind.tv_sec > 0) {
1306 struct timeval tval;
1311 GetTimeOfDay(&tval);
1313 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1314 tdiff /= 1000; /* Convert to milliseconds. */
1316 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1317 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1319 if (sleep_time > 0) {
1320 /* we wait for the LDAP replication */
1321 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1322 "for LDAP replication.\n",sleep_time));
1323 smb_msleep(sleep_time);
1324 DEBUG(5,("smbldap_search_ext: go on!\n"));
1326 ZERO_STRUCT(ldap_state->last_rebind);
1329 if (!push_utf8_talloc(talloc_tos(), &utf8_filter, filter, &converted_size)) {
1330 return LDAP_NO_MEMORY;
1333 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1334 timeout.tv_sec = lp_ldap_timeout();
1335 timeout.tv_usec = 0;
1337 /* Setup alarm timeout.... Do we need both of these ? JRA.
1338 * Yes, I think we do need both of these. The server timeout only
1339 * covers the case where the server's operation takes too long. It
1340 * does not cover the case where the request hangs on its way to the
1341 * server. The server side timeout is not strictly necessary, it's
1342 * just a bit more kind to the server. VL. */
1345 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1346 alarm(lp_ldap_timeout());
1347 /* End setup timeout. */
1349 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1350 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1352 CONST_DISCARD(char **, attrs),
1353 attrsonly, sctrls, cctrls, &timeout,
1355 if (rc != LDAP_SUCCESS) {
1356 char *ld_error = NULL;
1359 ldap_get_option(ldap_state->ldap_struct,
1360 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1362 ldap_get_option(ldap_state->ldap_struct,
1363 LDAP_OPT_ERROR_STRING, &ld_error);
1364 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1365 "(%s)\n", base, ld_errno,
1366 ldap_err2string(rc),
1367 ld_error ? ld_error : "unknown"));
1368 SAFE_FREE(ld_error);
1370 if (ld_errno == LDAP_SERVER_DOWN) {
1371 ldap_unbind(ldap_state->ldap_struct);
1372 ldap_state->ldap_struct = NULL;
1377 TALLOC_FREE(utf8_filter);
1379 /* Teardown timeout. */
1380 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1384 return LDAP_TIMELIMIT_EXCEEDED;
1389 int smbldap_search(struct smbldap_state *ldap_state,
1390 const char *base, int scope, const char *filter,
1391 const char *attrs[], int attrsonly,
1394 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1395 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1398 int smbldap_search_paged(struct smbldap_state *ldap_state,
1399 const char *base, int scope, const char *filter,
1400 const char **attrs, int attrsonly, int pagesize,
1401 LDAPMessage **res, void **cookie)
1404 LDAPControl **rcontrols;
1405 LDAPControl *controls[2] = { NULL, NULL};
1406 BerElement *cookie_be = NULL;
1407 struct berval *cookie_bv = NULL;
1409 bool critical = True;
1413 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1414 "scope => [%d], pagesize => [%d]\n",
1415 base, filter, scope, pagesize));
1417 cookie_be = ber_alloc_t(LBER_USE_DER);
1418 if (cookie_be == NULL) {
1419 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1421 return LDAP_NO_MEMORY;
1424 /* construct cookie */
1425 if (*cookie != NULL) {
1426 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1427 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1430 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1432 ber_flatten(cookie_be, &cookie_bv);
1434 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1435 pr.ldctl_iscritical = (char) critical;
1436 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1437 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1442 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1443 0, controls, NULL, LDAP_NO_LIMIT, res);
1445 ber_free(cookie_be, 1);
1446 ber_bvfree(cookie_bv);
1449 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1450 "failed with [%s]\n", filter, ldap_err2string(rc)));
1454 DEBUG(3,("smbldap_search_paged: search was successfull\n"));
1456 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1457 NULL, NULL, &rcontrols, 0);
1459 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1460 "with [%s]\n", ldap_err2string(rc)));
1464 if (rcontrols == NULL)
1467 for (i=0; rcontrols[i]; i++) {
1469 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1472 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1473 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1474 /* the berval is the cookie, but must be freed when it is all
1476 if (cookie_bv->bv_len)
1477 *cookie=ber_bvdup(cookie_bv);
1480 ber_bvfree(cookie_bv);
1481 ber_free(cookie_be, 1);
1484 ldap_controls_free(rcontrols);
1489 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1491 int rc = LDAP_SERVER_DOWN;
1494 time_t endtime = time(NULL)+lp_ldap_timeout();
1495 size_t converted_size;
1497 SMB_ASSERT(ldap_state);
1499 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1501 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1502 return LDAP_NO_MEMORY;
1505 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1506 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1507 if (rc != LDAP_SUCCESS) {
1508 char *ld_error = NULL;
1511 ldap_get_option(ldap_state->ldap_struct,
1512 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1514 ldap_get_option(ldap_state->ldap_struct,
1515 LDAP_OPT_ERROR_STRING, &ld_error);
1516 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1517 "(%s)\n", dn, ld_errno,
1518 ldap_err2string(rc),
1519 ld_error ? ld_error : "unknown"));
1520 SAFE_FREE(ld_error);
1522 if (ld_errno == LDAP_SERVER_DOWN) {
1523 ldap_unbind(ldap_state->ldap_struct);
1524 ldap_state->ldap_struct = NULL;
1529 TALLOC_FREE(utf8_dn);
1533 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1535 int rc = LDAP_SERVER_DOWN;
1538 time_t endtime = time(NULL)+lp_ldap_timeout();
1539 size_t converted_size;
1541 SMB_ASSERT(ldap_state);
1543 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1545 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1546 return LDAP_NO_MEMORY;
1549 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1550 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1551 if (rc != LDAP_SUCCESS) {
1552 char *ld_error = NULL;
1555 ldap_get_option(ldap_state->ldap_struct,
1556 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1558 ldap_get_option(ldap_state->ldap_struct,
1559 LDAP_OPT_ERROR_STRING, &ld_error);
1560 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1561 "(%s)\n", dn, ld_errno,
1562 ldap_err2string(rc),
1563 ld_error ? ld_error : "unknown"));
1564 SAFE_FREE(ld_error);
1566 if (ld_errno == LDAP_SERVER_DOWN) {
1567 ldap_unbind(ldap_state->ldap_struct);
1568 ldap_state->ldap_struct = NULL;
1573 TALLOC_FREE(utf8_dn);
1577 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1579 int rc = LDAP_SERVER_DOWN;
1582 time_t endtime = time(NULL)+lp_ldap_timeout();
1583 size_t converted_size;
1585 SMB_ASSERT(ldap_state);
1587 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1589 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1590 return LDAP_NO_MEMORY;
1593 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1594 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1595 if (rc != LDAP_SUCCESS) {
1596 char *ld_error = NULL;
1599 ldap_get_option(ldap_state->ldap_struct,
1600 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1602 ldap_get_option(ldap_state->ldap_struct,
1603 LDAP_OPT_ERROR_STRING, &ld_error);
1604 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1605 "(%s)\n", dn, ld_errno,
1606 ldap_err2string(rc),
1607 ld_error ? ld_error : "unknown"));
1608 SAFE_FREE(ld_error);
1610 if (ld_errno == LDAP_SERVER_DOWN) {
1611 ldap_unbind(ldap_state->ldap_struct);
1612 ldap_state->ldap_struct = NULL;
1617 TALLOC_FREE(utf8_dn);
1621 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1622 LDAP_CONST char *reqoid, struct berval *reqdata,
1623 LDAPControl **serverctrls, LDAPControl **clientctrls,
1624 char **retoidp, struct berval **retdatap)
1626 int rc = LDAP_SERVER_DOWN;
1628 time_t endtime = time(NULL)+lp_ldap_timeout();
1633 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1634 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1635 reqdata, serverctrls,
1636 clientctrls, retoidp, retdatap);
1637 if (rc != LDAP_SUCCESS) {
1638 char *ld_error = NULL;
1641 ldap_get_option(ldap_state->ldap_struct,
1642 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1644 ldap_get_option(ldap_state->ldap_struct,
1645 LDAP_OPT_ERROR_STRING, &ld_error);
1646 DEBUG(10, ("Extended operation failed with error: "
1647 "%d (%s) (%s)\n", ld_errno,
1648 ldap_err2string(rc),
1649 ld_error ? ld_error : "unknown"));
1650 SAFE_FREE(ld_error);
1652 if (ld_errno == LDAP_SERVER_DOWN) {
1653 ldap_unbind(ldap_state->ldap_struct);
1654 ldap_state->ldap_struct = NULL;
1662 /*******************************************************************
1663 run the search by name.
1664 ******************************************************************/
1665 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1666 const char *filter, const char **search_attr,
1667 LDAPMessage ** result)
1669 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1670 filter, search_attr, 0, result);
1673 static void smbldap_idle_fn(struct event_context *event_ctx,
1674 struct timed_event *te,
1678 struct smbldap_state *state = (struct smbldap_state *)private_data;
1680 TALLOC_FREE(state->idle_event);
1682 if (state->ldap_struct == NULL) {
1683 DEBUG(10,("ldap connection not connected...\n"));
1687 if ((state->last_use+SMBLDAP_IDLE_TIME) > now.tv_sec) {
1688 DEBUG(10,("ldap connection not idle...\n"));
1690 state->idle_event = event_add_timed(
1692 timeval_add(&now, SMBLDAP_IDLE_TIME, 0),
1698 DEBUG(7,("ldap connection idle...closing connection\n"));
1699 smbldap_close(state);
1702 /**********************************************************************
1704 *********************************************************************/
1706 void smbldap_free_struct(struct smbldap_state **ldap_state)
1708 smbldap_close(*ldap_state);
1710 if ((*ldap_state)->bind_secret) {
1711 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1714 SAFE_FREE((*ldap_state)->bind_dn);
1715 SAFE_FREE((*ldap_state)->bind_secret);
1717 TALLOC_FREE((*ldap_state)->idle_event);
1721 /* No need to free any further, as it is talloc()ed */
1725 /**********************************************************************
1726 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1727 *********************************************************************/
1729 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1730 const char *location,
1731 struct smbldap_state **smbldap_state)
1733 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1734 if (!*smbldap_state) {
1735 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1736 return NT_STATUS_NO_MEMORY;
1740 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1742 (*smbldap_state)->uri = "ldap://localhost";
1745 (*smbldap_state)->event_context = event_ctx;
1747 return NT_STATUS_OK;
1750 char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1753 char *utf8_dn, *unix_dn;
1754 size_t converted_size;
1756 utf8_dn = ldap_get_dn(ld, entry);
1758 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1761 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1762 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1763 "[%s]\n", utf8_dn));
1766 ldap_memfree(utf8_dn);
1770 /*******************************************************************
1771 Check if root-dse has a certain Control or Extension
1772 ********************************************************************/
1774 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1776 LDAPMessage *msg = NULL;
1777 LDAPMessage *entry = NULL;
1778 char **values = NULL;
1779 int rc, num_result, num_values, i;
1780 bool result = False;
1783 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1787 if (!strequal(attrs[0], "supportedExtension") &&
1788 !strequal(attrs[0], "supportedControl") &&
1789 !strequal(attrs[0], "namingContexts")) {
1790 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1794 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1795 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1797 if (rc != LDAP_SUCCESS) {
1798 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1802 num_result = ldap_count_entries(ld, msg);
1804 if (num_result != 1) {
1805 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1809 entry = ldap_first_entry(ld, msg);
1811 if (entry == NULL) {
1812 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1816 values = ldap_get_values(ld, entry, attrs[0]);
1818 if (values == NULL) {
1819 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1823 num_values = ldap_count_values(values);
1825 if (num_values == 0) {
1826 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1830 for (i=0; i<num_values; i++) {
1831 if (strcmp(values[i], value) == 0)
1838 ldap_value_free(values);
1846 /*******************************************************************
1847 Check if LDAP-Server supports a certain Control (OID in string format)
1848 ********************************************************************/
1850 bool smbldap_has_control(LDAP *ld, const char *control)
1852 const char *attrs[] = { "supportedControl", NULL };
1853 return smbldap_check_root_dse(ld, attrs, control);
1856 /*******************************************************************
1857 Check if LDAP-Server supports a certain Extension (OID in string format)
1858 ********************************************************************/
1860 bool smbldap_has_extension(LDAP *ld, const char *extension)
1862 const char *attrs[] = { "supportedExtension", NULL };
1863 return smbldap_check_root_dse(ld, attrs, extension);
1866 /*******************************************************************
1867 Check if LDAP-Server holds a given namingContext
1868 ********************************************************************/
1870 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1872 const char *attrs[] = { "namingContexts", NULL };
1873 return smbldap_check_root_dse(ld, attrs, naming_context);
1876 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1878 ldap_state->anonymous = anon;
1880 /* free any previously set credential */
1882 SAFE_FREE(ldap_state->bind_dn);
1883 if (ldap_state->bind_secret) {
1884 /* make sure secrets are zeroed out of memory */
1885 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1886 SAFE_FREE(ldap_state->bind_secret);
1890 ldap_state->bind_dn = SMB_STRDUP(dn);
1891 ldap_state->bind_secret = SMB_STRDUP(secret);