2 Unix SMB/CIFS implementation.
3 LDAP protocol helper functions for SAMBA
4 Copyright (C) Jean François Micouleau 1998
5 Copyright (C) Gerald Carter 2001-2003
6 Copyright (C) Shahms King 2001
7 Copyright (C) Andrew Bartlett 2002-2003
8 Copyright (C) Stefan (metze) Metzmacher 2002-2003
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #ifndef LDAP_OPT_SUCCESS
29 #define LDAP_OPT_SUCCESS 0
32 /* Try not to hit the up or down server forever */
34 #define SMBLDAP_DONT_PING_TIME 10 /* ping only all 10 seconds */
35 #define SMBLDAP_NUM_RETRIES 8 /* retry only 8 times */
37 #define SMBLDAP_IDLE_TIME 150 /* After 2.5 minutes disconnect */
40 /* attributes used by Samba 2.2 */
42 ATTRIB_MAP_ENTRY attrib_map_v22[] = {
43 { LDAP_ATTR_UID, "uid" },
44 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
45 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
46 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
47 { LDAP_ATTR_PWD_LAST_SET, "pwdLastSet" },
48 { LDAP_ATTR_PWD_CAN_CHANGE, "pwdCanChange" },
49 { LDAP_ATTR_PWD_MUST_CHANGE, "pwdMustChange" },
50 { LDAP_ATTR_LOGON_TIME, "logonTime" },
51 { LDAP_ATTR_LOGOFF_TIME, "logoffTime" },
52 { LDAP_ATTR_KICKOFF_TIME, "kickoffTime" },
53 { LDAP_ATTR_CN, "cn" },
54 { LDAP_ATTR_SN, "sn" },
55 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
56 { LDAP_ATTR_HOME_PATH, "smbHome" },
57 { LDAP_ATTR_HOME_DRIVE, "homeDrive" },
58 { LDAP_ATTR_LOGON_SCRIPT, "scriptPath" },
59 { LDAP_ATTR_PROFILE_PATH, "profilePath" },
60 { LDAP_ATTR_DESC, "description" },
61 { LDAP_ATTR_USER_WKS, "userWorkstations"},
62 { LDAP_ATTR_USER_RID, "rid" },
63 { LDAP_ATTR_PRIMARY_GROUP_RID, "primaryGroupID"},
64 { LDAP_ATTR_LMPW, "lmPassword" },
65 { LDAP_ATTR_NTPW, "ntPassword" },
66 { LDAP_ATTR_DOMAIN, "domain" },
67 { LDAP_ATTR_OBJCLASS, "objectClass" },
68 { LDAP_ATTR_ACB_INFO, "acctFlags" },
69 { LDAP_ATTR_MOD_TIMESTAMP, "modifyTimestamp" },
70 { LDAP_ATTR_LIST_END, NULL }
73 ATTRIB_MAP_ENTRY attrib_map_to_delete_v22[] = {
74 { LDAP_ATTR_PWD_LAST_SET, "pwdLastSet" },
75 { LDAP_ATTR_PWD_CAN_CHANGE, "pwdCanChange" },
76 { LDAP_ATTR_PWD_MUST_CHANGE, "pwdMustChange" },
77 { LDAP_ATTR_LOGON_TIME, "logonTime" },
78 { LDAP_ATTR_LOGOFF_TIME, "logoffTime" },
79 { LDAP_ATTR_KICKOFF_TIME, "kickoffTime" },
80 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
81 { LDAP_ATTR_HOME_PATH, "smbHome" },
82 { LDAP_ATTR_HOME_DRIVE, "homeDrives" },
83 { LDAP_ATTR_LOGON_SCRIPT, "scriptPath" },
84 { LDAP_ATTR_PROFILE_PATH, "profilePath" },
85 { LDAP_ATTR_USER_WKS, "userWorkstations"},
86 { LDAP_ATTR_USER_RID, "rid" },
87 { LDAP_ATTR_PRIMARY_GROUP_RID, "primaryGroupID"},
88 { LDAP_ATTR_LMPW, "lmPassword" },
89 { LDAP_ATTR_NTPW, "ntPassword" },
90 { LDAP_ATTR_DOMAIN, "domain" },
91 { LDAP_ATTR_ACB_INFO, "acctFlags" },
92 { LDAP_ATTR_LIST_END, NULL }
95 /* attributes used by Samba 3.0's sambaSamAccount */
97 ATTRIB_MAP_ENTRY attrib_map_v30[] = {
98 { LDAP_ATTR_UID, "uid" },
99 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
100 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
101 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
102 { LDAP_ATTR_PWD_LAST_SET, "sambaPwdLastSet" },
103 { LDAP_ATTR_PWD_CAN_CHANGE, "sambaPwdCanChange" },
104 { LDAP_ATTR_PWD_MUST_CHANGE, "sambaPwdMustChange" },
105 { LDAP_ATTR_LOGON_TIME, "sambaLogonTime" },
106 { LDAP_ATTR_LOGOFF_TIME, "sambaLogoffTime" },
107 { LDAP_ATTR_KICKOFF_TIME, "sambaKickoffTime" },
108 { LDAP_ATTR_CN, "cn" },
109 { LDAP_ATTR_SN, "sn" },
110 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
111 { LDAP_ATTR_HOME_DRIVE, "sambaHomeDrive" },
112 { LDAP_ATTR_HOME_PATH, "sambaHomePath" },
113 { LDAP_ATTR_LOGON_SCRIPT, "sambaLogonScript" },
114 { LDAP_ATTR_PROFILE_PATH, "sambaProfilePath" },
115 { LDAP_ATTR_DESC, "description" },
116 { LDAP_ATTR_USER_WKS, "sambaUserWorkstations" },
117 { LDAP_ATTR_USER_SID, LDAP_ATTRIBUTE_SID },
118 { LDAP_ATTR_PRIMARY_GROUP_SID, "sambaPrimaryGroupSID" },
119 { LDAP_ATTR_LMPW, "sambaLMPassword" },
120 { LDAP_ATTR_NTPW, "sambaNTPassword" },
121 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
122 { LDAP_ATTR_OBJCLASS, "objectClass" },
123 { LDAP_ATTR_ACB_INFO, "sambaAcctFlags" },
124 { LDAP_ATTR_MUNGED_DIAL, "sambaMungedDial" },
125 { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
126 { LDAP_ATTR_BAD_PASSWORD_TIME, "sambaBadPasswordTime" },
127 { LDAP_ATTR_PWD_HISTORY, "sambaPasswordHistory" },
128 { LDAP_ATTR_MOD_TIMESTAMP, "modifyTimestamp" },
129 { LDAP_ATTR_LOGON_HOURS, "sambaLogonHours" },
130 { LDAP_ATTR_LIST_END, NULL }
133 ATTRIB_MAP_ENTRY attrib_map_to_delete_v30[] = {
134 { LDAP_ATTR_PWD_LAST_SET, "sambaPwdLastSet" },
135 { LDAP_ATTR_PWD_CAN_CHANGE, "sambaPwdCanChange" },
136 { LDAP_ATTR_PWD_MUST_CHANGE, "sambaPwdMustChange" },
137 { LDAP_ATTR_LOGON_TIME, "sambaLogonTime" },
138 { LDAP_ATTR_LOGOFF_TIME, "sambaLogoffTime" },
139 { LDAP_ATTR_KICKOFF_TIME, "sambaKickoffTime" },
140 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
141 { LDAP_ATTR_HOME_DRIVE, "sambaHomeDrive" },
142 { LDAP_ATTR_HOME_PATH, "sambaHomePath" },
143 { LDAP_ATTR_LOGON_SCRIPT, "sambaLogonScript" },
144 { LDAP_ATTR_PROFILE_PATH, "sambaProfilePath" },
145 { LDAP_ATTR_USER_WKS, "sambaUserWorkstations" },
146 { LDAP_ATTR_USER_SID, LDAP_ATTRIBUTE_SID },
147 { LDAP_ATTR_PRIMARY_GROUP_SID, "sambaPrimaryGroupSID" },
148 { LDAP_ATTR_LMPW, "sambaLMPassword" },
149 { LDAP_ATTR_NTPW, "sambaNTPassword" },
150 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
151 { LDAP_ATTR_ACB_INFO, "sambaAcctFlags" },
152 { LDAP_ATTR_MUNGED_DIAL, "sambaMungedDial" },
153 { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
154 { LDAP_ATTR_BAD_PASSWORD_TIME, "sambaBadPasswordTime" },
155 { LDAP_ATTR_PWD_HISTORY, "sambaPasswordHistory" },
156 { LDAP_ATTR_LOGON_HOURS, "sambaLogonHours" },
157 { LDAP_ATTR_LIST_END, NULL }
160 /* attributes used for allocating RIDs */
162 ATTRIB_MAP_ENTRY dominfo_attr_list[] = {
163 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
164 { LDAP_ATTR_NEXT_RID, "sambaNextRid" },
165 { LDAP_ATTR_NEXT_USERRID, "sambaNextUserRid" },
166 { LDAP_ATTR_NEXT_GROUPRID, "sambaNextGroupRid" },
167 { LDAP_ATTR_DOM_SID, LDAP_ATTRIBUTE_SID },
168 { LDAP_ATTR_ALGORITHMIC_RID_BASE,"sambaAlgorithmicRidBase"},
169 { LDAP_ATTR_OBJCLASS, "objectClass" },
170 { LDAP_ATTR_LIST_END, NULL },
173 /* Samba 3.0 group mapping attributes */
175 ATTRIB_MAP_ENTRY groupmap_attr_list[] = {
176 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
177 { LDAP_ATTR_GROUP_SID, LDAP_ATTRIBUTE_SID },
178 { LDAP_ATTR_GROUP_TYPE, "sambaGroupType" },
179 { LDAP_ATTR_SID_LIST, "sambaSIDList" },
180 { LDAP_ATTR_DESC, "description" },
181 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
182 { LDAP_ATTR_CN, "cn" },
183 { LDAP_ATTR_OBJCLASS, "objectClass" },
184 { LDAP_ATTR_LIST_END, NULL }
187 ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete[] = {
188 { LDAP_ATTR_GROUP_SID, LDAP_ATTRIBUTE_SID },
189 { LDAP_ATTR_GROUP_TYPE, "sambaGroupType" },
190 { LDAP_ATTR_DESC, "description" },
191 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
192 { LDAP_ATTR_SID_LIST, "sambaSIDList" },
193 { LDAP_ATTR_LIST_END, NULL }
196 /* idmap_ldap sambaUnixIdPool */
198 ATTRIB_MAP_ENTRY idpool_attr_list[] = {
199 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
200 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
201 { LDAP_ATTR_OBJCLASS, "objectClass" },
202 { LDAP_ATTR_LIST_END, NULL }
205 ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
206 { LDAP_ATTR_SID, LDAP_ATTRIBUTE_SID },
207 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
208 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
209 { LDAP_ATTR_OBJCLASS, "objectClass" },
210 { LDAP_ATTR_LIST_END, NULL }
213 /**********************************************************************
214 perform a simple table lookup and return the attribute name
215 **********************************************************************/
217 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table[], int key )
221 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
222 if ( table[i].attrib == key )
223 return table[i].name;
231 /**********************************************************************
232 Return the list of attribute names from a mapping table
233 **********************************************************************/
235 const char** get_attr_list( TALLOC_CTX *mem_ctx, ATTRIB_MAP_ENTRY table[] )
240 while ( table[i].attrib != LDAP_ATTR_LIST_END )
244 names = TALLOC_ARRAY( mem_ctx, const char*, i );
246 DEBUG(0,("get_attr_list: out of memory\n"));
251 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
252 names[i] = talloc_strdup( names, table[i].name );
260 /*******************************************************************
261 Search an attribute and return the first value found.
262 ******************************************************************/
264 bool smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
265 const char *attribute, char *value,
275 if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
276 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
281 if (convert_string(CH_UTF8, CH_UNIX,values[0], -1, value, max_len, False) == (size_t)-1) {
282 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
283 attribute, values[0]));
284 ldap_value_free(values);
288 ldap_value_free(values);
289 #ifdef DEBUG_PASSWORDS
290 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
295 char * smbldap_talloc_single_attribute(LDAP *ldap_struct, LDAPMessage *entry,
296 const char *attribute,
301 size_t converted_size;
303 if (attribute == NULL) {
307 values = ldap_get_values(ldap_struct, entry, attribute);
309 if (values == NULL) {
310 DEBUG(10, ("attribute %s does not exist\n", attribute));
314 if (ldap_count_values(values) != 1) {
315 DEBUG(10, ("attribute %s has %d values, expected only one\n",
316 attribute, ldap_count_values(values)));
317 ldap_value_free(values);
321 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
322 DEBUG(10, ("pull_utf8_talloc failed\n"));
323 ldap_value_free(values);
327 ldap_value_free(values);
329 #ifdef DEBUG_PASSWORDS
330 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
336 char * smbldap_talloc_smallest_attribute(LDAP *ldap_struct, LDAPMessage *entry,
337 const char *attribute,
342 size_t converted_size;
345 if (attribute == NULL) {
349 values = ldap_get_values(ldap_struct, entry, attribute);
351 if (values == NULL) {
352 DEBUG(10, ("attribute %s does not exist\n", attribute));
356 if (!pull_utf8_talloc(mem_ctx, &result, values[0], &converted_size)) {
357 DEBUG(10, ("pull_utf8_talloc failed\n"));
358 ldap_value_free(values);
362 num_values = ldap_count_values(values);
364 for (i=1; i<num_values; i++) {
367 if (!pull_utf8_talloc(mem_ctx, &tmp, values[i],
369 DEBUG(10, ("pull_utf8_talloc failed\n"));
371 ldap_value_free(values);
375 if (StrCaseCmp(tmp, result) < 0) {
383 ldap_value_free(values);
385 #ifdef DEBUG_PASSWORDS
386 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
392 bool smbldap_talloc_single_blob(TALLOC_CTX *mem_ctx, LDAP *ld,
393 LDAPMessage *msg, const char *attrib,
396 struct berval **values;
398 values = ldap_get_values_len(ld, msg, attrib);
403 if (ldap_count_values_len(values) != 1) {
404 DEBUG(10, ("Expected one value for %s, got %d\n", attrib,
405 ldap_count_values_len(values)));
409 *blob = data_blob_talloc(mem_ctx, values[0]->bv_val,
411 ldap_value_free_len(values);
413 return (blob->data != NULL);
416 bool smbldap_pull_sid(LDAP *ld, LDAPMessage *msg, const char *attrib,
422 if (!smbldap_talloc_single_blob(talloc_tos(), ld, msg, attrib,
426 ret = sid_parse((char *)blob.data, blob.length, sid);
427 TALLOC_FREE(blob.data);
431 static int ldapmsg_destructor(LDAPMessage **result) {
432 ldap_msgfree(*result);
436 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
438 LDAPMessage **handle;
440 if (result == NULL) {
444 handle = TALLOC_P(mem_ctx, LDAPMessage *);
445 SMB_ASSERT(handle != NULL);
448 talloc_set_destructor(handle, ldapmsg_destructor);
451 static int ldapmod_destructor(LDAPMod ***mod) {
452 ldap_mods_free(*mod, True);
456 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
464 handle = TALLOC_P(mem_ctx, LDAPMod **);
465 SMB_ASSERT(handle != NULL);
468 talloc_set_destructor(handle, ldapmod_destructor);
471 /************************************************************************
472 Routine to manage the LDAPMod structure array
473 manage memory used by the array, by each struct, and values
474 ***********************************************************************/
476 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
484 /* sanity checks on the mod values */
486 if (attribute == NULL || *attribute == '\0') {
490 #if 0 /* commented out after discussion with abartlet. Do not reenable.
491 left here so other do not re-add similar code --jerry */
492 if (value == NULL || *value == '\0')
497 mods = SMB_MALLOC_P(LDAPMod *);
499 smb_panic("smbldap_set_mod: out of memory!");
505 for (i = 0; mods[i] != NULL; ++i) {
506 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
510 if (mods[i] == NULL) {
511 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
513 smb_panic("smbldap_set_mod: out of memory!");
516 mods[i] = SMB_MALLOC_P(LDAPMod);
517 if (mods[i] == NULL) {
518 smb_panic("smbldap_set_mod: out of memory!");
521 mods[i]->mod_op = modop;
522 mods[i]->mod_values = NULL;
523 mods[i]->mod_type = SMB_STRDUP(attribute);
528 char *utf8_value = NULL;
529 size_t converted_size;
532 if (mods[i]->mod_values != NULL) {
533 for (; mods[i]->mod_values[j] != NULL; j++);
535 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
537 if (mods[i]->mod_values == NULL) {
538 smb_panic("smbldap_set_mod: out of memory!");
542 if (!push_utf8_talloc(talloc_tos(), &utf8_value, value, &converted_size)) {
543 smb_panic("smbldap_set_mod: String conversion failure!");
547 mods[i]->mod_values[j] = SMB_STRDUP(utf8_value);
548 TALLOC_FREE(utf8_value);
549 SMB_ASSERT(mods[i]->mod_values[j] != NULL);
551 mods[i]->mod_values[j + 1] = NULL;
556 /**********************************************************************
557 Set attribute to newval in LDAP, regardless of what value the
558 attribute had in LDAP before.
559 *********************************************************************/
561 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
563 const char *attribute, const char *newval)
565 char oldval[2048]; /* current largest allowed value is mungeddial */
568 if (attribute == NULL) {
569 /* This can actually happen for ldapsam_compat where we for
570 * example don't have a password history */
574 if (existing != NULL) {
575 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
581 /* all of our string attributes are case insensitive */
583 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
585 /* Believe it or not, but LDAP will deny a delete and
586 an add at the same time if the values are the
588 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
593 /* There has been no value before, so don't delete it.
594 * Here's a possible race: We might end up with
595 * duplicate attributes */
596 /* By deleting exactly the value we found in the entry this
597 * should be race-free in the sense that the LDAP-Server will
598 * deny the complete operation if somebody changed the
599 * attribute behind our back. */
600 /* This will also allow modifying single valued attributes
601 * in Novell NDS. In NDS you have to first remove attribute and then
602 * you could add new value */
604 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
605 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
608 /* Regardless of the real operation (add or modify)
609 we add the new value here. We rely on deleting
610 the old value, should it exist. */
612 if ((newval != NULL) && (strlen(newval) > 0)) {
613 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
614 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
618 /**********************************************************************
619 Some varients of the LDAP rebind code do not pass in the third 'arg'
620 pointer to a void*, so we try and work around it by assuming that the
621 value of the 'LDAP *' pointer is the same as the one we had passed in
622 **********************************************************************/
624 struct smbldap_state_lookup {
626 struct smbldap_state *smbldap_state;
627 struct smbldap_state_lookup *prev, *next;
630 static struct smbldap_state_lookup *smbldap_state_lookup_list;
632 static struct smbldap_state *smbldap_find_state(LDAP *ld)
634 struct smbldap_state_lookup *t;
636 for (t = smbldap_state_lookup_list; t; t = t->next) {
638 return t->smbldap_state;
644 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
646 struct smbldap_state_lookup *t;
648 for (t = smbldap_state_lookup_list; t; t = t->next) {
649 if (t->smbldap_state == smbldap_state) {
650 DLIST_REMOVE(smbldap_state_lookup_list, t);
657 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
659 struct smbldap_state *tmp_ldap_state;
660 struct smbldap_state_lookup *t;
662 if ((tmp_ldap_state = smbldap_find_state(ld))) {
663 SMB_ASSERT(tmp_ldap_state == smbldap_state);
667 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
670 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
672 t->smbldap_state = smbldap_state;
675 /********************************************************************
676 start TLS on an existing LDAP connection
677 *******************************************************************/
679 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
681 #ifdef LDAP_OPT_X_TLS
685 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
689 #ifdef LDAP_OPT_X_TLS
690 if (version != LDAP_VERSION3) {
691 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
692 return LDAP_OPERATIONS_ERROR;
695 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
696 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
697 ldap_err2string(rc)));
701 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
704 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
705 return LDAP_OPERATIONS_ERROR;
709 /********************************************************************
710 setup a connection to the LDAP server based on a uri
711 *******************************************************************/
713 int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
717 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
719 #ifdef HAVE_LDAP_INITIALIZE
721 rc = ldap_initialize(ldap_struct, uri);
723 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
729 /* Parse the string manually */
735 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
738 /* skip leading "URL:" (if any) */
739 if ( strnequal( uri, "URL:", 4 ) ) {
743 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
746 if (strequal(protocol, "ldap")) {
748 } else if (strequal(protocol, "ldaps")) {
751 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
755 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
756 DEBUG(0, ("ldap_init failed !\n"));
757 return LDAP_OPERATIONS_ERROR;
760 if (strequal(protocol, "ldaps")) {
761 #ifdef LDAP_OPT_X_TLS
762 int tls = LDAP_OPT_X_TLS_HARD;
763 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
765 DEBUG(0, ("Failed to setup a TLS session\n"));
768 DEBUG(3,("LDAPS option set...!\n"));
770 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
771 return LDAP_OPERATIONS_ERROR;
772 #endif /* LDAP_OPT_X_TLS */
775 #endif /* HAVE_LDAP_INITIALIZE */
778 /* now set connection timeout */
779 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
781 int ct = lp_ldap_connection_timeout()*1000;
782 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
783 if (rc != LDAP_SUCCESS) {
784 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
785 ct, ldap_err2string(rc)));
788 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
792 ct.tv_sec = lp_ldap_connection_timeout();
793 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
794 if (rc != LDAP_SUCCESS) {
795 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
796 (int)ct.tv_sec, ldap_err2string(rc)));
804 /********************************************************************
805 try to upgrade to Version 3 LDAP if not already, in either case return current
807 *******************************************************************/
809 int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
814 /* assume the worst */
815 *new_version = LDAP_VERSION2;
817 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
822 if (version == LDAP_VERSION3) {
823 *new_version = LDAP_VERSION3;
828 version = LDAP_VERSION3;
829 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
834 *new_version = LDAP_VERSION3;
838 /*******************************************************************
839 open a connection to the ldap server (just until the bind)
840 ******************************************************************/
842 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
846 rc = smb_ldap_setup_conn(ldap_struct, uri);
851 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
856 rc = smb_ldap_start_tls(*ldap_struct, version);
864 /*******************************************************************
865 open a connection to the ldap server.
866 ******************************************************************/
867 static int smbldap_open_connection (struct smbldap_state *ldap_state)
870 int rc = LDAP_SUCCESS;
872 LDAP **ldap_struct = &ldap_state->ldap_struct;
874 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
879 /* Store the LDAP pointer in a lookup list */
881 smbldap_store_state(*ldap_struct, ldap_state);
883 /* Upgrade to LDAPv3 if possible */
885 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
890 /* Start TLS if required */
892 rc = smb_ldap_start_tls(*ldap_struct, version);
897 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
901 /*******************************************************************
902 a rebind function for authenticated referrals
903 This version takes a void* that we can shove useful stuff in :-)
904 ******************************************************************/
905 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
907 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
908 int *methodp, int freeit, void *arg)
910 struct smbldap_state *ldap_state = arg;
912 /** @TODO Should we be doing something to check what servers we rebind to?
913 Could we get a referral to a machine that we don't want to give our
914 username and password to? */
919 memset(*credp, '\0', strlen(*credp));
923 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
924 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
926 if (ldap_state->anonymous) {
930 *whop = SMB_STRDUP(ldap_state->bind_dn);
932 return LDAP_NO_MEMORY;
934 *credp = SMB_STRDUP(ldap_state->bind_secret);
937 return LDAP_NO_MEMORY;
940 *methodp = LDAP_AUTH_SIMPLE;
943 GetTimeOfDay(&ldap_state->last_rebind);
947 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
949 /*******************************************************************
950 a rebind function for authenticated referrals
951 This version takes a void* that we can shove useful stuff in :-)
952 and actually does the connection.
953 ******************************************************************/
954 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
955 static int rebindproc_connect_with_state (LDAP *ldap_struct,
956 LDAP_CONST char *url,
958 ber_int_t msgid, void *arg)
960 struct smbldap_state *ldap_state =
961 (struct smbldap_state *)arg;
965 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
966 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
968 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
969 * itself) before rebinding to another LDAP server to avoid to expose
970 * our credentials. At least *try* to secure the connection - Guenther */
972 smb_ldap_upgrade_conn(ldap_struct, &version);
973 smb_ldap_start_tls(ldap_struct, version);
975 /** @TODO Should we be doing something to check what servers we rebind to?
976 Could we get a referral to a machine that we don't want to give our
977 username and password to? */
979 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
981 /* only set the last rebind timestamp when we did rebind after a
982 * non-read LDAP operation. That way we avoid the replication sleep
983 * after a simple redirected search operation - Guenther */
987 case LDAP_REQ_MODIFY:
989 case LDAP_REQ_DELETE:
991 case LDAP_REQ_EXTENDED:
992 DEBUG(10,("rebindproc_connect_with_state: "
993 "setting last_rebind timestamp "
994 "(req: 0x%02x)\n", (unsigned int)request));
995 GetTimeOfDay(&ldap_state->last_rebind);
998 ZERO_STRUCT(ldap_state->last_rebind);
1004 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1006 /*******************************************************************
1007 Add a rebind function for authenticated referrals
1008 ******************************************************************/
1009 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1011 # if LDAP_SET_REBIND_PROC_ARGS == 2
1012 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
1013 int *method, int freeit )
1015 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
1017 return rebindproc_with_state(ldap_struct, whop, credp,
1018 method, freeit, ldap_state);
1020 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1021 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1023 /*******************************************************************
1024 a rebind function for authenticated referrals
1025 this also does the connection, but no void*.
1026 ******************************************************************/
1027 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1028 # if LDAP_SET_REBIND_PROC_ARGS == 2
1029 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
1032 struct smbldap_state *ldap_state = smbldap_find_state(ld);
1034 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
1037 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
1038 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1040 /*******************************************************************
1041 connect to the ldap server under system privilege.
1042 ******************************************************************/
1043 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
1048 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
1050 /* get the default dn and password only if they are not set already */
1051 if (!fetch_ldap_pw(&ldap_state->bind_dn, &ldap_state->bind_secret)) {
1052 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
1053 return LDAP_INVALID_CREDENTIALS;
1057 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
1058 (OpenLDAP) doesnt' seem to support it */
1060 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
1061 ldap_state->uri, ldap_state->bind_dn));
1063 #ifdef HAVE_LDAP_SET_REBIND_PROC
1064 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
1065 # if LDAP_SET_REBIND_PROC_ARGS == 2
1066 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
1068 # if LDAP_SET_REBIND_PROC_ARGS == 3
1069 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
1071 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1072 # if LDAP_SET_REBIND_PROC_ARGS == 2
1073 ldap_set_rebind_proc(ldap_struct, &rebindproc);
1075 # if LDAP_SET_REBIND_PROC_ARGS == 3
1076 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
1078 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
1081 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
1083 if (rc != LDAP_SUCCESS) {
1084 char *ld_error = NULL;
1085 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
1087 DEBUG(ldap_state->num_failures ? 2 : 0,
1088 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
1090 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
1091 ldap_err2string(rc),
1092 ld_error ? ld_error : "(unknown)"));
1093 SAFE_FREE(ld_error);
1094 ldap_state->num_failures++;
1098 ldap_state->num_failures = 0;
1099 ldap_state->paged_results = False;
1101 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1103 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1104 ldap_state->paged_results = True;
1107 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1108 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1109 ldap_state->paged_results ? "does" : "does not"));
1113 static void smbldap_idle_fn(struct event_context *event_ctx,
1114 struct timed_event *te,
1116 void *private_data);
1118 /**********************************************************************
1119 Connect to LDAP server (called before every ldap operation)
1120 *********************************************************************/
1121 static int smbldap_open(struct smbldap_state *ldap_state)
1124 bool reopen = False;
1125 SMB_ASSERT(ldap_state);
1127 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1129 #ifdef HAVE_UNIXSOCKET
1130 struct sockaddr_un addr;
1132 struct sockaddr addr;
1134 socklen_t len = sizeof(addr);
1137 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1138 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1141 #ifdef HAVE_UNIXSOCKET
1142 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1146 /* the other end has died. reopen. */
1147 ldap_unbind(ldap_state->ldap_struct);
1148 ldap_state->ldap_struct = NULL;
1149 ldap_state->last_ping = (time_t)0;
1151 ldap_state->last_ping = time(NULL);
1155 if (ldap_state->ldap_struct != NULL) {
1156 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1157 return LDAP_SUCCESS;
1160 if ((rc = smbldap_open_connection(ldap_state))) {
1164 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1165 ldap_unbind(ldap_state->ldap_struct);
1166 ldap_state->ldap_struct = NULL;
1171 ldap_state->last_ping = time(NULL);
1172 ldap_state->pid = sys_getpid();
1174 TALLOC_FREE(ldap_state->idle_event);
1176 if (ldap_state->event_context != NULL) {
1177 ldap_state->idle_event = event_add_timed(
1178 ldap_state->event_context, NULL,
1179 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1180 smbldap_idle_fn, ldap_state);
1183 DEBUG(4,("The LDAP server is successfully connected\n"));
1185 return LDAP_SUCCESS;
1188 /**********************************************************************
1189 Disconnect from LDAP server
1190 *********************************************************************/
1191 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1194 return NT_STATUS_INVALID_PARAMETER;
1196 if (ldap_state->ldap_struct != NULL) {
1197 ldap_unbind(ldap_state->ldap_struct);
1198 ldap_state->ldap_struct = NULL;
1201 smbldap_delete_state(ldap_state);
1203 DEBUG(5,("The connection to the LDAP server was closed\n"));
1204 /* maybe free the results here --metze */
1206 return NT_STATUS_OK;
1209 static bool got_alarm;
1211 static void (*old_handler)(int);
1213 static void gotalarm_sig(int dummy)
1218 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1219 int *attempts, time_t endtime)
1221 time_t now = time(NULL);
1222 int open_rc = LDAP_SERVER_DOWN;
1224 if (*rc != LDAP_SERVER_DOWN)
1227 if (now >= endtime) {
1228 smbldap_close(ldap_state);
1233 if (*attempts == 0) {
1235 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1236 alarm(endtime - now);
1238 if (ldap_state->pid != sys_getpid())
1239 smbldap_close(ldap_state);
1249 open_rc = smbldap_open(ldap_state);
1251 if (open_rc == LDAP_SUCCESS) {
1252 ldap_state->last_use = now;
1256 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1257 /* The fact that we are non-root or any other
1258 * access-denied condition will not change in the next
1259 * round of trying */
1269 if (open_rc != LDAP_SUCCESS) {
1270 DEBUG(1, ("Connection to LDAP server failed for the "
1271 "%d try!\n", *attempts));
1276 CatchSignal(SIGALRM, old_handler);
1278 ldap_state->last_use = now;
1282 /*********************************************************************
1283 ********************************************************************/
1285 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1286 const char *base, int scope, const char *filter,
1287 const char *attrs[], int attrsonly,
1288 LDAPControl **sctrls, LDAPControl **cctrls,
1289 int sizelimit, LDAPMessage **res)
1291 int rc = LDAP_SERVER_DOWN;
1294 time_t endtime = time(NULL)+lp_ldap_timeout();
1295 struct timeval timeout;
1296 size_t converted_size;
1298 SMB_ASSERT(ldap_state);
1300 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1301 "scope => [%d]\n", base, filter, scope));
1303 if (ldap_state->last_rebind.tv_sec > 0) {
1304 struct timeval tval;
1309 GetTimeOfDay(&tval);
1311 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1312 tdiff /= 1000; /* Convert to milliseconds. */
1314 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1315 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1317 if (sleep_time > 0) {
1318 /* we wait for the LDAP replication */
1319 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1320 "for LDAP replication.\n",sleep_time));
1321 smb_msleep(sleep_time);
1322 DEBUG(5,("smbldap_search_ext: go on!\n"));
1324 ZERO_STRUCT(ldap_state->last_rebind);
1327 if (!push_utf8_talloc(talloc_tos(), &utf8_filter, filter, &converted_size)) {
1328 return LDAP_NO_MEMORY;
1331 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1332 timeout.tv_sec = lp_ldap_timeout();
1333 timeout.tv_usec = 0;
1335 /* Setup alarm timeout.... Do we need both of these ? JRA.
1336 * Yes, I think we do need both of these. The server timeout only
1337 * covers the case where the server's operation takes too long. It
1338 * does not cover the case where the request hangs on its way to the
1339 * server. The server side timeout is not strictly necessary, it's
1340 * just a bit more kind to the server. VL. */
1343 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1344 alarm(lp_ldap_timeout());
1345 /* End setup timeout. */
1347 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1348 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1350 CONST_DISCARD(char **, attrs),
1351 attrsonly, sctrls, cctrls, &timeout,
1353 if (rc != LDAP_SUCCESS) {
1354 char *ld_error = NULL;
1357 ldap_get_option(ldap_state->ldap_struct,
1358 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1360 ldap_get_option(ldap_state->ldap_struct,
1361 LDAP_OPT_ERROR_STRING, &ld_error);
1362 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1363 "(%s)\n", base, ld_errno,
1364 ldap_err2string(rc),
1365 ld_error ? ld_error : "unknown"));
1366 SAFE_FREE(ld_error);
1368 if (ld_errno == LDAP_SERVER_DOWN) {
1369 ldap_unbind(ldap_state->ldap_struct);
1370 ldap_state->ldap_struct = NULL;
1375 TALLOC_FREE(utf8_filter);
1377 /* Teardown timeout. */
1378 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1382 return LDAP_TIMELIMIT_EXCEEDED;
1387 int smbldap_search(struct smbldap_state *ldap_state,
1388 const char *base, int scope, const char *filter,
1389 const char *attrs[], int attrsonly,
1392 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1393 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1396 int smbldap_search_paged(struct smbldap_state *ldap_state,
1397 const char *base, int scope, const char *filter,
1398 const char **attrs, int attrsonly, int pagesize,
1399 LDAPMessage **res, void **cookie)
1402 LDAPControl **rcontrols;
1403 LDAPControl *controls[2] = { NULL, NULL};
1404 BerElement *cookie_be = NULL;
1405 struct berval *cookie_bv = NULL;
1407 bool critical = True;
1411 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1412 "scope => [%d], pagesize => [%d]\n",
1413 base, filter, scope, pagesize));
1415 cookie_be = ber_alloc_t(LBER_USE_DER);
1416 if (cookie_be == NULL) {
1417 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1419 return LDAP_NO_MEMORY;
1422 /* construct cookie */
1423 if (*cookie != NULL) {
1424 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1425 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1428 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1430 ber_flatten(cookie_be, &cookie_bv);
1432 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1433 pr.ldctl_iscritical = (char) critical;
1434 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1435 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1440 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1441 0, controls, NULL, LDAP_NO_LIMIT, res);
1443 ber_free(cookie_be, 1);
1444 ber_bvfree(cookie_bv);
1447 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1448 "failed with [%s]\n", filter, ldap_err2string(rc)));
1452 DEBUG(3,("smbldap_search_paged: search was successfull\n"));
1454 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1455 NULL, NULL, &rcontrols, 0);
1457 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1458 "with [%s]\n", ldap_err2string(rc)));
1462 if (rcontrols == NULL)
1465 for (i=0; rcontrols[i]; i++) {
1467 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1470 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1471 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1472 /* the berval is the cookie, but must be freed when it is all
1474 if (cookie_bv->bv_len)
1475 *cookie=ber_bvdup(cookie_bv);
1478 ber_bvfree(cookie_bv);
1479 ber_free(cookie_be, 1);
1482 ldap_controls_free(rcontrols);
1487 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1489 int rc = LDAP_SERVER_DOWN;
1492 time_t endtime = time(NULL)+lp_ldap_timeout();
1493 size_t converted_size;
1495 SMB_ASSERT(ldap_state);
1497 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1499 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1500 return LDAP_NO_MEMORY;
1503 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1504 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1505 if (rc != LDAP_SUCCESS) {
1506 char *ld_error = NULL;
1509 ldap_get_option(ldap_state->ldap_struct,
1510 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1512 ldap_get_option(ldap_state->ldap_struct,
1513 LDAP_OPT_ERROR_STRING, &ld_error);
1514 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1515 "(%s)\n", dn, ld_errno,
1516 ldap_err2string(rc),
1517 ld_error ? ld_error : "unknown"));
1518 SAFE_FREE(ld_error);
1520 if (ld_errno == LDAP_SERVER_DOWN) {
1521 ldap_unbind(ldap_state->ldap_struct);
1522 ldap_state->ldap_struct = NULL;
1527 TALLOC_FREE(utf8_dn);
1531 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1533 int rc = LDAP_SERVER_DOWN;
1536 time_t endtime = time(NULL)+lp_ldap_timeout();
1537 size_t converted_size;
1539 SMB_ASSERT(ldap_state);
1541 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1543 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1544 return LDAP_NO_MEMORY;
1547 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1548 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1549 if (rc != LDAP_SUCCESS) {
1550 char *ld_error = NULL;
1553 ldap_get_option(ldap_state->ldap_struct,
1554 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1556 ldap_get_option(ldap_state->ldap_struct,
1557 LDAP_OPT_ERROR_STRING, &ld_error);
1558 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1559 "(%s)\n", dn, ld_errno,
1560 ldap_err2string(rc),
1561 ld_error ? ld_error : "unknown"));
1562 SAFE_FREE(ld_error);
1564 if (ld_errno == LDAP_SERVER_DOWN) {
1565 ldap_unbind(ldap_state->ldap_struct);
1566 ldap_state->ldap_struct = NULL;
1571 TALLOC_FREE(utf8_dn);
1575 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1577 int rc = LDAP_SERVER_DOWN;
1580 time_t endtime = time(NULL)+lp_ldap_timeout();
1581 size_t converted_size;
1583 SMB_ASSERT(ldap_state);
1585 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1587 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1588 return LDAP_NO_MEMORY;
1591 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1592 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1593 if (rc != LDAP_SUCCESS) {
1594 char *ld_error = NULL;
1597 ldap_get_option(ldap_state->ldap_struct,
1598 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1600 ldap_get_option(ldap_state->ldap_struct,
1601 LDAP_OPT_ERROR_STRING, &ld_error);
1602 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1603 "(%s)\n", dn, ld_errno,
1604 ldap_err2string(rc),
1605 ld_error ? ld_error : "unknown"));
1606 SAFE_FREE(ld_error);
1608 if (ld_errno == LDAP_SERVER_DOWN) {
1609 ldap_unbind(ldap_state->ldap_struct);
1610 ldap_state->ldap_struct = NULL;
1615 TALLOC_FREE(utf8_dn);
1619 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1620 LDAP_CONST char *reqoid, struct berval *reqdata,
1621 LDAPControl **serverctrls, LDAPControl **clientctrls,
1622 char **retoidp, struct berval **retdatap)
1624 int rc = LDAP_SERVER_DOWN;
1626 time_t endtime = time(NULL)+lp_ldap_timeout();
1631 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1632 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1633 reqdata, serverctrls,
1634 clientctrls, retoidp, retdatap);
1635 if (rc != LDAP_SUCCESS) {
1636 char *ld_error = NULL;
1639 ldap_get_option(ldap_state->ldap_struct,
1640 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1642 ldap_get_option(ldap_state->ldap_struct,
1643 LDAP_OPT_ERROR_STRING, &ld_error);
1644 DEBUG(10, ("Extended operation failed with error: "
1645 "%d (%s) (%s)\n", ld_errno,
1646 ldap_err2string(rc),
1647 ld_error ? ld_error : "unknown"));
1648 SAFE_FREE(ld_error);
1650 if (ld_errno == LDAP_SERVER_DOWN) {
1651 ldap_unbind(ldap_state->ldap_struct);
1652 ldap_state->ldap_struct = NULL;
1660 /*******************************************************************
1661 run the search by name.
1662 ******************************************************************/
1663 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1664 const char *filter, const char **search_attr,
1665 LDAPMessage ** result)
1667 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1668 filter, search_attr, 0, result);
1671 static void smbldap_idle_fn(struct event_context *event_ctx,
1672 struct timed_event *te,
1676 struct smbldap_state *state = (struct smbldap_state *)private_data;
1678 TALLOC_FREE(state->idle_event);
1680 if (state->ldap_struct == NULL) {
1681 DEBUG(10,("ldap connection not connected...\n"));
1685 if ((state->last_use+SMBLDAP_IDLE_TIME) > now.tv_sec) {
1686 DEBUG(10,("ldap connection not idle...\n"));
1688 state->idle_event = event_add_timed(
1690 timeval_add(&now, SMBLDAP_IDLE_TIME, 0),
1696 DEBUG(7,("ldap connection idle...closing connection\n"));
1697 smbldap_close(state);
1700 /**********************************************************************
1702 *********************************************************************/
1704 void smbldap_free_struct(struct smbldap_state **ldap_state)
1706 smbldap_close(*ldap_state);
1708 if ((*ldap_state)->bind_secret) {
1709 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1712 SAFE_FREE((*ldap_state)->bind_dn);
1713 SAFE_FREE((*ldap_state)->bind_secret);
1715 TALLOC_FREE((*ldap_state)->idle_event);
1719 /* No need to free any further, as it is talloc()ed */
1723 /**********************************************************************
1724 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1725 *********************************************************************/
1727 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1728 const char *location,
1729 struct smbldap_state **smbldap_state)
1731 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1732 if (!*smbldap_state) {
1733 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1734 return NT_STATUS_NO_MEMORY;
1738 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1740 (*smbldap_state)->uri = "ldap://localhost";
1743 (*smbldap_state)->event_context = event_ctx;
1745 return NT_STATUS_OK;
1748 char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1751 char *utf8_dn, *unix_dn;
1752 size_t converted_size;
1754 utf8_dn = ldap_get_dn(ld, entry);
1756 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1759 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1760 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1761 "[%s]\n", utf8_dn));
1764 ldap_memfree(utf8_dn);
1768 /*******************************************************************
1769 Check if root-dse has a certain Control or Extension
1770 ********************************************************************/
1772 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1774 LDAPMessage *msg = NULL;
1775 LDAPMessage *entry = NULL;
1776 char **values = NULL;
1777 int rc, num_result, num_values, i;
1778 bool result = False;
1781 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1785 if (!strequal(attrs[0], "supportedExtension") &&
1786 !strequal(attrs[0], "supportedControl") &&
1787 !strequal(attrs[0], "namingContexts")) {
1788 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1792 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1793 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1795 if (rc != LDAP_SUCCESS) {
1796 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1800 num_result = ldap_count_entries(ld, msg);
1802 if (num_result != 1) {
1803 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1807 entry = ldap_first_entry(ld, msg);
1809 if (entry == NULL) {
1810 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1814 values = ldap_get_values(ld, entry, attrs[0]);
1816 if (values == NULL) {
1817 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1821 num_values = ldap_count_values(values);
1823 if (num_values == 0) {
1824 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1828 for (i=0; i<num_values; i++) {
1829 if (strcmp(values[i], value) == 0)
1836 ldap_value_free(values);
1844 /*******************************************************************
1845 Check if LDAP-Server supports a certain Control (OID in string format)
1846 ********************************************************************/
1848 bool smbldap_has_control(LDAP *ld, const char *control)
1850 const char *attrs[] = { "supportedControl", NULL };
1851 return smbldap_check_root_dse(ld, attrs, control);
1854 /*******************************************************************
1855 Check if LDAP-Server supports a certain Extension (OID in string format)
1856 ********************************************************************/
1858 bool smbldap_has_extension(LDAP *ld, const char *extension)
1860 const char *attrs[] = { "supportedExtension", NULL };
1861 return smbldap_check_root_dse(ld, attrs, extension);
1864 /*******************************************************************
1865 Check if LDAP-Server holds a given namingContext
1866 ********************************************************************/
1868 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1870 const char *attrs[] = { "namingContexts", NULL };
1871 return smbldap_check_root_dse(ld, attrs, naming_context);
1874 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1876 ldap_state->anonymous = anon;
1878 /* free any previously set credential */
1880 SAFE_FREE(ldap_state->bind_dn);
1881 if (ldap_state->bind_secret) {
1882 /* make sure secrets are zeroed out of memory */
1883 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1884 SAFE_FREE(ldap_state->bind_secret);
1888 ldap_state->bind_dn = SMB_STRDUP(dn);
1889 ldap_state->bind_secret = SMB_STRDUP(secret);