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 static int ldapmsg_destructor(LDAPMessage **result) {
337 ldap_msgfree(*result);
341 void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
343 LDAPMessage **handle;
345 if (result == NULL) {
349 handle = TALLOC_P(mem_ctx, LDAPMessage *);
350 SMB_ASSERT(handle != NULL);
353 talloc_set_destructor(handle, ldapmsg_destructor);
356 static int ldapmod_destructor(LDAPMod ***mod) {
357 ldap_mods_free(*mod, True);
361 void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
369 handle = TALLOC_P(mem_ctx, LDAPMod **);
370 SMB_ASSERT(handle != NULL);
373 talloc_set_destructor(handle, ldapmod_destructor);
376 /************************************************************************
377 Routine to manage the LDAPMod structure array
378 manage memory used by the array, by each struct, and values
379 ***********************************************************************/
381 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
389 /* sanity checks on the mod values */
391 if (attribute == NULL || *attribute == '\0') {
395 #if 0 /* commented out after discussion with abartlet. Do not reenable.
396 left here so other do not re-add similar code --jerry */
397 if (value == NULL || *value == '\0')
402 mods = SMB_MALLOC_P(LDAPMod *);
404 smb_panic("smbldap_set_mod: out of memory!");
410 for (i = 0; mods[i] != NULL; ++i) {
411 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
415 if (mods[i] == NULL) {
416 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
418 smb_panic("smbldap_set_mod: out of memory!");
421 mods[i] = SMB_MALLOC_P(LDAPMod);
422 if (mods[i] == NULL) {
423 smb_panic("smbldap_set_mod: out of memory!");
426 mods[i]->mod_op = modop;
427 mods[i]->mod_values = NULL;
428 mods[i]->mod_type = SMB_STRDUP(attribute);
433 char *utf8_value = NULL;
434 size_t converted_size;
437 if (mods[i]->mod_values != NULL) {
438 for (; mods[i]->mod_values[j] != NULL; j++);
440 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
442 if (mods[i]->mod_values == NULL) {
443 smb_panic("smbldap_set_mod: out of memory!");
447 if (!push_utf8_talloc(talloc_tos(), &utf8_value, value, &converted_size)) {
448 smb_panic("smbldap_set_mod: String conversion failure!");
453 mods[i]->mod_values[j] = SMB_STRDUP(utf8_value);
454 TALLOC_FREE(utf8_value);
455 SMB_ASSERT(mods[i]->mod_values[j] != NULL);
457 mods[i]->mod_values[j + 1] = NULL;
462 /**********************************************************************
463 Set attribute to newval in LDAP, regardless of what value the
464 attribute had in LDAP before.
465 *********************************************************************/
467 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
469 const char *attribute, const char *newval)
471 char oldval[2048]; /* current largest allowed value is mungeddial */
474 if (attribute == NULL) {
475 /* This can actually happen for ldapsam_compat where we for
476 * example don't have a password history */
480 if (existing != NULL) {
481 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
487 /* all of our string attributes are case insensitive */
489 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
491 /* Believe it or not, but LDAP will deny a delete and
492 an add at the same time if the values are the
494 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
499 /* There has been no value before, so don't delete it.
500 * Here's a possible race: We might end up with
501 * duplicate attributes */
502 /* By deleting exactly the value we found in the entry this
503 * should be race-free in the sense that the LDAP-Server will
504 * deny the complete operation if somebody changed the
505 * attribute behind our back. */
506 /* This will also allow modifying single valued attributes
507 * in Novell NDS. In NDS you have to first remove attribute and then
508 * you could add new value */
510 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
511 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
514 /* Regardless of the real operation (add or modify)
515 we add the new value here. We rely on deleting
516 the old value, should it exist. */
518 if ((newval != NULL) && (strlen(newval) > 0)) {
519 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
520 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
524 /**********************************************************************
525 Some varients of the LDAP rebind code do not pass in the third 'arg'
526 pointer to a void*, so we try and work around it by assuming that the
527 value of the 'LDAP *' pointer is the same as the one we had passed in
528 **********************************************************************/
530 struct smbldap_state_lookup {
532 struct smbldap_state *smbldap_state;
533 struct smbldap_state_lookup *prev, *next;
536 static struct smbldap_state_lookup *smbldap_state_lookup_list;
538 static struct smbldap_state *smbldap_find_state(LDAP *ld)
540 struct smbldap_state_lookup *t;
542 for (t = smbldap_state_lookup_list; t; t = t->next) {
544 return t->smbldap_state;
550 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
552 struct smbldap_state_lookup *t;
554 for (t = smbldap_state_lookup_list; t; t = t->next) {
555 if (t->smbldap_state == smbldap_state) {
556 DLIST_REMOVE(smbldap_state_lookup_list, t);
563 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
565 struct smbldap_state *tmp_ldap_state;
566 struct smbldap_state_lookup *t;
568 if ((tmp_ldap_state = smbldap_find_state(ld))) {
569 SMB_ASSERT(tmp_ldap_state == smbldap_state);
573 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
576 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
578 t->smbldap_state = smbldap_state;
581 /********************************************************************
582 start TLS on an existing LDAP connection
583 *******************************************************************/
585 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
587 #ifdef LDAP_OPT_X_TLS
591 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
595 #ifdef LDAP_OPT_X_TLS
596 if (version != LDAP_VERSION3) {
597 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
598 return LDAP_OPERATIONS_ERROR;
601 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
602 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
603 ldap_err2string(rc)));
607 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
610 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
611 return LDAP_OPERATIONS_ERROR;
615 /********************************************************************
616 setup a connection to the LDAP server based on a uri
617 *******************************************************************/
619 int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
623 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
625 #ifdef HAVE_LDAP_INITIALIZE
627 rc = ldap_initialize(ldap_struct, uri);
629 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
635 /* Parse the string manually */
641 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
644 /* skip leading "URL:" (if any) */
645 if ( strnequal( uri, "URL:", 4 ) ) {
649 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
652 if (strequal(protocol, "ldap")) {
654 } else if (strequal(protocol, "ldaps")) {
657 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
661 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
662 DEBUG(0, ("ldap_init failed !\n"));
663 return LDAP_OPERATIONS_ERROR;
666 if (strequal(protocol, "ldaps")) {
667 #ifdef LDAP_OPT_X_TLS
668 int tls = LDAP_OPT_X_TLS_HARD;
669 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
671 DEBUG(0, ("Failed to setup a TLS session\n"));
674 DEBUG(3,("LDAPS option set...!\n"));
676 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
677 return LDAP_OPERATIONS_ERROR;
678 #endif /* LDAP_OPT_X_TLS */
681 #endif /* HAVE_LDAP_INITIALIZE */
684 /* now set connection timeout */
685 #ifdef LDAP_X_OPT_CONNECT_TIMEOUT /* Netscape */
687 int ct = lp_ldap_connection_timeout()*1000;
688 rc = ldap_set_option(*ldap_struct, LDAP_X_OPT_CONNECT_TIMEOUT, &ct);
689 if (rc != LDAP_SUCCESS) {
690 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
691 ct, ldap_err2string(rc)));
694 #elif defined (LDAP_OPT_NETWORK_TIMEOUT) /* OpenLDAP */
698 ct.tv_sec = lp_ldap_connection_timeout();
699 rc = ldap_set_option(*ldap_struct, LDAP_OPT_NETWORK_TIMEOUT, &ct);
700 if (rc != LDAP_SUCCESS) {
701 DEBUG(0,("Failed to setup an ldap connection timeout %d: %s\n",
702 (int)ct.tv_sec, ldap_err2string(rc)));
710 /********************************************************************
711 try to upgrade to Version 3 LDAP if not already, in either case return current
713 *******************************************************************/
715 int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
720 /* assume the worst */
721 *new_version = LDAP_VERSION2;
723 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
728 if (version == LDAP_VERSION3) {
729 *new_version = LDAP_VERSION3;
734 version = LDAP_VERSION3;
735 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
740 *new_version = LDAP_VERSION3;
744 /*******************************************************************
745 open a connection to the ldap server (just until the bind)
746 ******************************************************************/
748 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
752 rc = smb_ldap_setup_conn(ldap_struct, uri);
757 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
762 rc = smb_ldap_start_tls(*ldap_struct, version);
770 /*******************************************************************
771 open a connection to the ldap server.
772 ******************************************************************/
773 static int smbldap_open_connection (struct smbldap_state *ldap_state)
776 int rc = LDAP_SUCCESS;
778 LDAP **ldap_struct = &ldap_state->ldap_struct;
780 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
785 /* Store the LDAP pointer in a lookup list */
787 smbldap_store_state(*ldap_struct, ldap_state);
789 /* Upgrade to LDAPv3 if possible */
791 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
796 /* Start TLS if required */
798 rc = smb_ldap_start_tls(*ldap_struct, version);
803 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
807 /*******************************************************************
808 a rebind function for authenticated referrals
809 This version takes a void* that we can shove useful stuff in :-)
810 ******************************************************************/
811 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
813 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
814 int *methodp, int freeit, void *arg)
816 struct smbldap_state *ldap_state = arg;
818 /** @TODO Should we be doing something to check what servers we rebind to?
819 Could we get a referral to a machine that we don't want to give our
820 username and password to? */
825 memset(*credp, '\0', strlen(*credp));
829 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
830 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
832 if (ldap_state->anonymous) {
836 *whop = SMB_STRDUP(ldap_state->bind_dn);
838 return LDAP_NO_MEMORY;
840 *credp = SMB_STRDUP(ldap_state->bind_secret);
843 return LDAP_NO_MEMORY;
846 *methodp = LDAP_AUTH_SIMPLE;
849 GetTimeOfDay(&ldap_state->last_rebind);
853 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
855 /*******************************************************************
856 a rebind function for authenticated referrals
857 This version takes a void* that we can shove useful stuff in :-)
858 and actually does the connection.
859 ******************************************************************/
860 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
861 static int rebindproc_connect_with_state (LDAP *ldap_struct,
862 LDAP_CONST char *url,
864 ber_int_t msgid, void *arg)
866 struct smbldap_state *ldap_state =
867 (struct smbldap_state *)arg;
871 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
872 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
874 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
875 * itself) before rebinding to another LDAP server to avoid to expose
876 * our credentials. At least *try* to secure the connection - Guenther */
878 smb_ldap_upgrade_conn(ldap_struct, &version);
879 smb_ldap_start_tls(ldap_struct, version);
881 /** @TODO Should we be doing something to check what servers we rebind to?
882 Could we get a referral to a machine that we don't want to give our
883 username and password to? */
885 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
887 /* only set the last rebind timestamp when we did rebind after a
888 * non-read LDAP operation. That way we avoid the replication sleep
889 * after a simple redirected search operation - Guenther */
893 case LDAP_REQ_MODIFY:
895 case LDAP_REQ_DELETE:
897 case LDAP_REQ_EXTENDED:
898 DEBUG(10,("rebindproc_connect_with_state: "
899 "setting last_rebind timestamp "
900 "(req: 0x%02x)\n", (unsigned int)request));
901 GetTimeOfDay(&ldap_state->last_rebind);
904 ZERO_STRUCT(ldap_state->last_rebind);
910 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
912 /*******************************************************************
913 Add a rebind function for authenticated referrals
914 ******************************************************************/
915 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
917 # if LDAP_SET_REBIND_PROC_ARGS == 2
918 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
919 int *method, int freeit )
921 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
923 return rebindproc_with_state(ldap_struct, whop, credp,
924 method, freeit, ldap_state);
927 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
928 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
930 /*******************************************************************
931 a rebind function for authenticated referrals
932 this also does the connection, but no void*.
933 ******************************************************************/
934 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
935 # if LDAP_SET_REBIND_PROC_ARGS == 2
936 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
939 struct smbldap_state *ldap_state = smbldap_find_state(ld);
941 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
944 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
945 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
947 /*******************************************************************
948 connect to the ldap server under system privilege.
949 ******************************************************************/
950 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
955 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
957 /* get the default dn and password only if they are not set already */
958 if (!fetch_ldap_pw(&ldap_state->bind_dn, &ldap_state->bind_secret)) {
959 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
960 return LDAP_INVALID_CREDENTIALS;
964 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
965 (OpenLDAP) doesnt' seem to support it */
967 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
968 ldap_state->uri, ldap_state->bind_dn));
970 #ifdef HAVE_LDAP_SET_REBIND_PROC
971 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
972 # if LDAP_SET_REBIND_PROC_ARGS == 2
973 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
975 # if LDAP_SET_REBIND_PROC_ARGS == 3
976 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
978 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
979 # if LDAP_SET_REBIND_PROC_ARGS == 2
980 ldap_set_rebind_proc(ldap_struct, &rebindproc);
982 # if LDAP_SET_REBIND_PROC_ARGS == 3
983 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
985 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
988 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
990 if (rc != LDAP_SUCCESS) {
991 char *ld_error = NULL;
992 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
994 DEBUG(ldap_state->num_failures ? 2 : 0,
995 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
997 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
999 ld_error ? ld_error : "(unknown)"));
1000 SAFE_FREE(ld_error);
1001 ldap_state->num_failures++;
1005 ldap_state->num_failures = 0;
1006 ldap_state->paged_results = False;
1008 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
1010 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
1011 ldap_state->paged_results = True;
1014 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
1015 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
1016 ldap_state->paged_results ? "does" : "does not"));
1020 static void smbldap_idle_fn(struct event_context *event_ctx,
1021 struct timed_event *te,
1023 void *private_data);
1025 /**********************************************************************
1026 Connect to LDAP server (called before every ldap operation)
1027 *********************************************************************/
1028 static int smbldap_open(struct smbldap_state *ldap_state)
1031 bool reopen = False;
1032 SMB_ASSERT(ldap_state);
1034 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1036 #ifdef HAVE_UNIXSOCKET
1037 struct sockaddr_un addr;
1039 struct sockaddr addr;
1041 socklen_t len = sizeof(addr);
1044 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1045 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1048 #ifdef HAVE_UNIXSOCKET
1049 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1053 /* the other end has died. reopen. */
1054 ldap_unbind(ldap_state->ldap_struct);
1055 ldap_state->ldap_struct = NULL;
1056 ldap_state->last_ping = (time_t)0;
1058 ldap_state->last_ping = time(NULL);
1062 if (ldap_state->ldap_struct != NULL) {
1063 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1064 return LDAP_SUCCESS;
1067 if ((rc = smbldap_open_connection(ldap_state))) {
1071 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1072 ldap_unbind(ldap_state->ldap_struct);
1073 ldap_state->ldap_struct = NULL;
1078 ldap_state->last_ping = time(NULL);
1079 ldap_state->pid = sys_getpid();
1081 TALLOC_FREE(ldap_state->idle_event);
1083 if (ldap_state->event_context != NULL) {
1084 ldap_state->idle_event = event_add_timed(
1085 ldap_state->event_context, NULL,
1086 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1087 smbldap_idle_fn, ldap_state);
1090 DEBUG(4,("The LDAP server is successfully connected\n"));
1092 return LDAP_SUCCESS;
1095 /**********************************************************************
1096 Disconnect from LDAP server
1097 *********************************************************************/
1098 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1101 return NT_STATUS_INVALID_PARAMETER;
1103 if (ldap_state->ldap_struct != NULL) {
1104 ldap_unbind(ldap_state->ldap_struct);
1105 ldap_state->ldap_struct = NULL;
1108 smbldap_delete_state(ldap_state);
1110 DEBUG(5,("The connection to the LDAP server was closed\n"));
1111 /* maybe free the results here --metze */
1113 return NT_STATUS_OK;
1116 static bool got_alarm;
1118 static void (*old_handler)(int);
1120 static void gotalarm_sig(int dummy)
1125 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1126 int *attempts, time_t endtime)
1128 time_t now = time(NULL);
1129 int open_rc = LDAP_SERVER_DOWN;
1131 if (*rc != LDAP_SERVER_DOWN)
1134 if (now >= endtime) {
1135 smbldap_close(ldap_state);
1140 if (*attempts == 0) {
1142 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1143 alarm(endtime - now);
1145 if (ldap_state->pid != sys_getpid())
1146 smbldap_close(ldap_state);
1156 open_rc = smbldap_open(ldap_state);
1158 if (open_rc == LDAP_SUCCESS) {
1159 ldap_state->last_use = now;
1163 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1164 /* The fact that we are non-root or any other
1165 * access-denied condition will not change in the next
1166 * round of trying */
1176 if (open_rc != LDAP_SUCCESS) {
1177 DEBUG(1, ("Connection to LDAP server failed for the "
1178 "%d try!\n", *attempts));
1183 CatchSignal(SIGALRM, old_handler);
1185 ldap_state->last_use = now;
1189 /*********************************************************************
1190 ********************************************************************/
1192 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1193 const char *base, int scope, const char *filter,
1194 const char *attrs[], int attrsonly,
1195 LDAPControl **sctrls, LDAPControl **cctrls,
1196 int sizelimit, LDAPMessage **res)
1198 int rc = LDAP_SERVER_DOWN;
1201 time_t endtime = time(NULL)+lp_ldap_timeout();
1202 struct timeval timeout;
1203 size_t converted_size;
1205 SMB_ASSERT(ldap_state);
1207 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1208 "scope => [%d]\n", base, filter, scope));
1210 if (ldap_state->last_rebind.tv_sec > 0) {
1211 struct timeval tval;
1216 GetTimeOfDay(&tval);
1218 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1219 tdiff /= 1000; /* Convert to milliseconds. */
1221 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1222 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1224 if (sleep_time > 0) {
1225 /* we wait for the LDAP replication */
1226 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1227 "for LDAP replication.\n",sleep_time));
1228 smb_msleep(sleep_time);
1229 DEBUG(5,("smbldap_search_ext: go on!\n"));
1231 ZERO_STRUCT(ldap_state->last_rebind);
1234 if (!push_utf8_talloc(talloc_tos(), &utf8_filter, filter, &converted_size)) {
1235 return LDAP_NO_MEMORY;
1238 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1239 timeout.tv_sec = lp_ldap_timeout();
1240 timeout.tv_usec = 0;
1242 /* Setup alarm timeout.... Do we need both of these ? JRA.
1243 * Yes, I think we do need both of these. The server timeout only
1244 * covers the case where the server's operation takes too long. It
1245 * does not cover the case where the request hangs on its way to the
1246 * server. The server side timeout is not strictly necessary, it's
1247 * just a bit more kind to the server. VL. */
1250 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1251 alarm(lp_ldap_timeout());
1252 /* End setup timeout. */
1254 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1255 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1257 CONST_DISCARD(char **, attrs),
1258 attrsonly, sctrls, cctrls, &timeout,
1260 if (rc != LDAP_SUCCESS) {
1261 char *ld_error = NULL;
1264 ldap_get_option(ldap_state->ldap_struct,
1265 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1267 ldap_get_option(ldap_state->ldap_struct,
1268 LDAP_OPT_ERROR_STRING, &ld_error);
1269 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1270 "(%s)\n", base, ld_errno,
1271 ldap_err2string(rc),
1272 ld_error ? ld_error : "unknown"));
1273 SAFE_FREE(ld_error);
1275 if (ld_errno == LDAP_SERVER_DOWN) {
1276 ldap_unbind(ldap_state->ldap_struct);
1277 ldap_state->ldap_struct = NULL;
1282 TALLOC_FREE(utf8_filter);
1284 /* Teardown timeout. */
1285 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1289 return LDAP_TIMELIMIT_EXCEEDED;
1294 int smbldap_search(struct smbldap_state *ldap_state,
1295 const char *base, int scope, const char *filter,
1296 const char *attrs[], int attrsonly,
1299 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1300 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1303 int smbldap_search_paged(struct smbldap_state *ldap_state,
1304 const char *base, int scope, const char *filter,
1305 const char **attrs, int attrsonly, int pagesize,
1306 LDAPMessage **res, void **cookie)
1309 LDAPControl **rcontrols;
1310 LDAPControl *controls[2] = { NULL, NULL};
1311 BerElement *cookie_be = NULL;
1312 struct berval *cookie_bv = NULL;
1314 bool critical = True;
1318 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1319 "scope => [%d], pagesize => [%d]\n",
1320 base, filter, scope, pagesize));
1322 cookie_be = ber_alloc_t(LBER_USE_DER);
1323 if (cookie_be == NULL) {
1324 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1326 return LDAP_NO_MEMORY;
1329 /* construct cookie */
1330 if (*cookie != NULL) {
1331 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1332 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1335 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1337 ber_flatten(cookie_be, &cookie_bv);
1339 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1340 pr.ldctl_iscritical = (char) critical;
1341 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1342 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1347 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1348 0, controls, NULL, LDAP_NO_LIMIT, res);
1350 ber_free(cookie_be, 1);
1351 ber_bvfree(cookie_bv);
1354 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1355 "failed with [%s]\n", filter, ldap_err2string(rc)));
1359 DEBUG(3,("smbldap_search_paged: search was successfull\n"));
1361 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1362 NULL, NULL, &rcontrols, 0);
1364 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1365 "with [%s]\n", ldap_err2string(rc)));
1369 if (rcontrols == NULL)
1372 for (i=0; rcontrols[i]; i++) {
1374 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1377 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1378 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1379 /* the berval is the cookie, but must be freed when it is all
1381 if (cookie_bv->bv_len)
1382 *cookie=ber_bvdup(cookie_bv);
1385 ber_bvfree(cookie_bv);
1386 ber_free(cookie_be, 1);
1389 ldap_controls_free(rcontrols);
1394 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1396 int rc = LDAP_SERVER_DOWN;
1399 time_t endtime = time(NULL)+lp_ldap_timeout();
1400 size_t converted_size;
1402 SMB_ASSERT(ldap_state);
1404 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1406 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1407 return LDAP_NO_MEMORY;
1410 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1411 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1412 if (rc != LDAP_SUCCESS) {
1413 char *ld_error = NULL;
1416 ldap_get_option(ldap_state->ldap_struct,
1417 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1419 ldap_get_option(ldap_state->ldap_struct,
1420 LDAP_OPT_ERROR_STRING, &ld_error);
1421 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1422 "(%s)\n", dn, ld_errno,
1423 ldap_err2string(rc),
1424 ld_error ? ld_error : "unknown"));
1425 SAFE_FREE(ld_error);
1427 if (ld_errno == LDAP_SERVER_DOWN) {
1428 ldap_unbind(ldap_state->ldap_struct);
1429 ldap_state->ldap_struct = NULL;
1434 TALLOC_FREE(utf8_dn);
1438 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1440 int rc = LDAP_SERVER_DOWN;
1443 time_t endtime = time(NULL)+lp_ldap_timeout();
1444 size_t converted_size;
1446 SMB_ASSERT(ldap_state);
1448 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1450 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1451 return LDAP_NO_MEMORY;
1454 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1455 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1456 if (rc != LDAP_SUCCESS) {
1457 char *ld_error = NULL;
1460 ldap_get_option(ldap_state->ldap_struct,
1461 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1463 ldap_get_option(ldap_state->ldap_struct,
1464 LDAP_OPT_ERROR_STRING, &ld_error);
1465 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1466 "(%s)\n", dn, ld_errno,
1467 ldap_err2string(rc),
1468 ld_error ? ld_error : "unknown"));
1469 SAFE_FREE(ld_error);
1471 if (ld_errno == LDAP_SERVER_DOWN) {
1472 ldap_unbind(ldap_state->ldap_struct);
1473 ldap_state->ldap_struct = NULL;
1478 TALLOC_FREE(utf8_dn);
1482 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1484 int rc = LDAP_SERVER_DOWN;
1487 time_t endtime = time(NULL)+lp_ldap_timeout();
1488 size_t converted_size;
1490 SMB_ASSERT(ldap_state);
1492 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1494 if (!push_utf8_talloc(talloc_tos(), &utf8_dn, dn, &converted_size)) {
1495 return LDAP_NO_MEMORY;
1498 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1499 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1500 if (rc != LDAP_SUCCESS) {
1501 char *ld_error = NULL;
1504 ldap_get_option(ldap_state->ldap_struct,
1505 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1507 ldap_get_option(ldap_state->ldap_struct,
1508 LDAP_OPT_ERROR_STRING, &ld_error);
1509 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1510 "(%s)\n", dn, ld_errno,
1511 ldap_err2string(rc),
1512 ld_error ? ld_error : "unknown"));
1513 SAFE_FREE(ld_error);
1515 if (ld_errno == LDAP_SERVER_DOWN) {
1516 ldap_unbind(ldap_state->ldap_struct);
1517 ldap_state->ldap_struct = NULL;
1522 TALLOC_FREE(utf8_dn);
1526 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1527 LDAP_CONST char *reqoid, struct berval *reqdata,
1528 LDAPControl **serverctrls, LDAPControl **clientctrls,
1529 char **retoidp, struct berval **retdatap)
1531 int rc = LDAP_SERVER_DOWN;
1533 time_t endtime = time(NULL)+lp_ldap_timeout();
1538 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1539 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1540 reqdata, serverctrls,
1541 clientctrls, retoidp, retdatap);
1542 if (rc != LDAP_SUCCESS) {
1543 char *ld_error = NULL;
1546 ldap_get_option(ldap_state->ldap_struct,
1547 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1549 ldap_get_option(ldap_state->ldap_struct,
1550 LDAP_OPT_ERROR_STRING, &ld_error);
1551 DEBUG(10, ("Extended operation failed with error: "
1552 "%d (%s) (%s)\n", ld_errno,
1553 ldap_err2string(rc),
1554 ld_error ? ld_error : "unknown"));
1555 SAFE_FREE(ld_error);
1557 if (ld_errno == LDAP_SERVER_DOWN) {
1558 ldap_unbind(ldap_state->ldap_struct);
1559 ldap_state->ldap_struct = NULL;
1567 /*******************************************************************
1568 run the search by name.
1569 ******************************************************************/
1570 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1571 const char *filter, const char **search_attr,
1572 LDAPMessage ** result)
1574 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1575 filter, search_attr, 0, result);
1578 static void smbldap_idle_fn(struct event_context *event_ctx,
1579 struct timed_event *te,
1583 struct smbldap_state *state = (struct smbldap_state *)private_data;
1585 TALLOC_FREE(state->idle_event);
1587 if (state->ldap_struct == NULL) {
1588 DEBUG(10,("ldap connection not connected...\n"));
1592 if ((state->last_use+SMBLDAP_IDLE_TIME) > now.tv_sec) {
1593 DEBUG(10,("ldap connection not idle...\n"));
1595 state->idle_event = event_add_timed(
1597 timeval_add(&now, SMBLDAP_IDLE_TIME, 0),
1603 DEBUG(7,("ldap connection idle...closing connection\n"));
1604 smbldap_close(state);
1607 /**********************************************************************
1609 *********************************************************************/
1611 void smbldap_free_struct(struct smbldap_state **ldap_state)
1613 smbldap_close(*ldap_state);
1615 if ((*ldap_state)->bind_secret) {
1616 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1619 SAFE_FREE((*ldap_state)->bind_dn);
1620 SAFE_FREE((*ldap_state)->bind_secret);
1622 TALLOC_FREE((*ldap_state)->idle_event);
1626 /* No need to free any further, as it is talloc()ed */
1630 /**********************************************************************
1631 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1632 *********************************************************************/
1634 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1635 const char *location,
1636 struct smbldap_state **smbldap_state)
1638 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1639 if (!*smbldap_state) {
1640 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1641 return NT_STATUS_NO_MEMORY;
1645 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1647 (*smbldap_state)->uri = "ldap://localhost";
1650 (*smbldap_state)->event_context = event_ctx;
1652 return NT_STATUS_OK;
1655 char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1658 char *utf8_dn, *unix_dn;
1659 size_t converted_size;
1661 utf8_dn = ldap_get_dn(ld, entry);
1663 DEBUG (5, ("smbldap_talloc_dn: ldap_get_dn failed\n"));
1666 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1667 DEBUG (0, ("smbldap_talloc_dn: String conversion failure utf8 "
1668 "[%s]\n", utf8_dn));
1671 ldap_memfree(utf8_dn);
1675 /*******************************************************************
1676 Check if root-dse has a certain Control or Extension
1677 ********************************************************************/
1679 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1681 LDAPMessage *msg = NULL;
1682 LDAPMessage *entry = NULL;
1683 char **values = NULL;
1684 int rc, num_result, num_values, i;
1685 bool result = False;
1688 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1692 if (!strequal(attrs[0], "supportedExtension") &&
1693 !strequal(attrs[0], "supportedControl") &&
1694 !strequal(attrs[0], "namingContexts")) {
1695 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1699 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1700 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1702 if (rc != LDAP_SUCCESS) {
1703 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1707 num_result = ldap_count_entries(ld, msg);
1709 if (num_result != 1) {
1710 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1714 entry = ldap_first_entry(ld, msg);
1716 if (entry == NULL) {
1717 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1721 values = ldap_get_values(ld, entry, attrs[0]);
1723 if (values == NULL) {
1724 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1728 num_values = ldap_count_values(values);
1730 if (num_values == 0) {
1731 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1735 for (i=0; i<num_values; i++) {
1736 if (strcmp(values[i], value) == 0)
1743 ldap_value_free(values);
1751 /*******************************************************************
1752 Check if LDAP-Server supports a certain Control (OID in string format)
1753 ********************************************************************/
1755 bool smbldap_has_control(LDAP *ld, const char *control)
1757 const char *attrs[] = { "supportedControl", NULL };
1758 return smbldap_check_root_dse(ld, attrs, control);
1761 /*******************************************************************
1762 Check if LDAP-Server supports a certain Extension (OID in string format)
1763 ********************************************************************/
1765 bool smbldap_has_extension(LDAP *ld, const char *extension)
1767 const char *attrs[] = { "supportedExtension", NULL };
1768 return smbldap_check_root_dse(ld, attrs, extension);
1771 /*******************************************************************
1772 Check if LDAP-Server holds a given namingContext
1773 ********************************************************************/
1775 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1777 const char *attrs[] = { "namingContexts", NULL };
1778 return smbldap_check_root_dse(ld, attrs, naming_context);
1781 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1783 ldap_state->anonymous = anon;
1785 /* free any previously set credential */
1787 SAFE_FREE(ldap_state->bind_dn);
1788 if (ldap_state->bind_secret) {
1789 /* make sure secrets are zeroed out of memory */
1790 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1791 SAFE_FREE(ldap_state->bind_secret);
1795 ldap_state->bind_dn = SMB_STRDUP(dn);
1796 ldap_state->bind_secret = SMB_STRDUP(secret);