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_allocate(&utf8_value, value, &converted_size)) {
448 smb_panic("smbldap_set_mod: String conversion failure!");
452 mods[i]->mod_values[j] = utf8_value;
454 mods[i]->mod_values[j + 1] = NULL;
459 /**********************************************************************
460 Set attribute to newval in LDAP, regardless of what value the
461 attribute had in LDAP before.
462 *********************************************************************/
464 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
466 const char *attribute, const char *newval)
468 char oldval[2048]; /* current largest allowed value is mungeddial */
471 if (attribute == NULL) {
472 /* This can actually happen for ldapsam_compat where we for
473 * example don't have a password history */
477 if (existing != NULL) {
478 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
484 /* all of our string attributes are case insensitive */
486 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
488 /* Believe it or not, but LDAP will deny a delete and
489 an add at the same time if the values are the
491 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
496 /* There has been no value before, so don't delete it.
497 * Here's a possible race: We might end up with
498 * duplicate attributes */
499 /* By deleting exactly the value we found in the entry this
500 * should be race-free in the sense that the LDAP-Server will
501 * deny the complete operation if somebody changed the
502 * attribute behind our back. */
503 /* This will also allow modifying single valued attributes
504 * in Novell NDS. In NDS you have to first remove attribute and then
505 * you could add new value */
507 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
508 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
511 /* Regardless of the real operation (add or modify)
512 we add the new value here. We rely on deleting
513 the old value, should it exist. */
515 if ((newval != NULL) && (strlen(newval) > 0)) {
516 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
517 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
521 /**********************************************************************
522 Some varients of the LDAP rebind code do not pass in the third 'arg'
523 pointer to a void*, so we try and work around it by assuming that the
524 value of the 'LDAP *' pointer is the same as the one we had passed in
525 **********************************************************************/
527 struct smbldap_state_lookup {
529 struct smbldap_state *smbldap_state;
530 struct smbldap_state_lookup *prev, *next;
533 static struct smbldap_state_lookup *smbldap_state_lookup_list;
535 static struct smbldap_state *smbldap_find_state(LDAP *ld)
537 struct smbldap_state_lookup *t;
539 for (t = smbldap_state_lookup_list; t; t = t->next) {
541 return t->smbldap_state;
547 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
549 struct smbldap_state_lookup *t;
551 for (t = smbldap_state_lookup_list; t; t = t->next) {
552 if (t->smbldap_state == smbldap_state) {
553 DLIST_REMOVE(smbldap_state_lookup_list, t);
560 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
562 struct smbldap_state *tmp_ldap_state;
563 struct smbldap_state_lookup *t;
565 if ((tmp_ldap_state = smbldap_find_state(ld))) {
566 SMB_ASSERT(tmp_ldap_state == smbldap_state);
570 t = SMB_XMALLOC_P(struct smbldap_state_lookup);
573 DLIST_ADD_END(smbldap_state_lookup_list, t, struct smbldap_state_lookup *);
575 t->smbldap_state = smbldap_state;
578 /********************************************************************
579 start TLS on an existing LDAP connection
580 *******************************************************************/
582 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
586 if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
590 #ifdef LDAP_OPT_X_TLS
591 if (version != LDAP_VERSION3) {
592 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
593 return LDAP_OPERATIONS_ERROR;
596 if ((rc = ldap_start_tls_s (ldap_struct, NULL, NULL)) != LDAP_SUCCESS) {
597 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
598 ldap_err2string(rc)));
602 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
605 DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
606 return LDAP_OPERATIONS_ERROR;
610 /********************************************************************
611 setup a connection to the LDAP server based on a uri
612 *******************************************************************/
614 int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
618 DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
620 #ifdef HAVE_LDAP_INITIALIZE
622 rc = ldap_initialize(ldap_struct, uri);
624 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
630 /* Parse the string manually */
636 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
639 /* skip leading "URL:" (if any) */
640 if ( strnequal( uri, "URL:", 4 ) ) {
644 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
647 if (strequal(protocol, "ldap")) {
649 } else if (strequal(protocol, "ldaps")) {
652 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
656 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
657 DEBUG(0, ("ldap_init failed !\n"));
658 return LDAP_OPERATIONS_ERROR;
661 if (strequal(protocol, "ldaps")) {
662 #ifdef LDAP_OPT_X_TLS
663 int tls = LDAP_OPT_X_TLS_HARD;
664 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
666 DEBUG(0, ("Failed to setup a TLS session\n"));
669 DEBUG(3,("LDAPS option set...!\n"));
671 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
672 return LDAP_OPERATIONS_ERROR;
673 #endif /* LDAP_OPT_X_TLS */
677 #endif /* HAVE_LDAP_INITIALIZE */
681 /********************************************************************
682 try to upgrade to Version 3 LDAP if not already, in either case return current
684 *******************************************************************/
686 int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version)
691 /* assume the worst */
692 *new_version = LDAP_VERSION2;
694 rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
699 if (version == LDAP_VERSION3) {
700 *new_version = LDAP_VERSION3;
705 version = LDAP_VERSION3;
706 rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
711 *new_version = LDAP_VERSION3;
715 /*******************************************************************
716 open a connection to the ldap server (just until the bind)
717 ******************************************************************/
719 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
723 rc = smb_ldap_setup_conn(ldap_struct, uri);
728 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
733 rc = smb_ldap_start_tls(*ldap_struct, version);
741 /*******************************************************************
742 open a connection to the ldap server.
743 ******************************************************************/
744 static int smbldap_open_connection (struct smbldap_state *ldap_state)
747 int rc = LDAP_SUCCESS;
749 LDAP **ldap_struct = &ldap_state->ldap_struct;
751 rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
756 /* Store the LDAP pointer in a lookup list */
758 smbldap_store_state(*ldap_struct, ldap_state);
760 /* Upgrade to LDAPv3 if possible */
762 rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
767 /* Start TLS if required */
769 rc = smb_ldap_start_tls(*ldap_struct, version);
774 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
778 /*******************************************************************
779 a rebind function for authenticated referrals
780 This version takes a void* that we can shove useful stuff in :-)
781 ******************************************************************/
782 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
784 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
785 int *methodp, int freeit, void *arg)
787 struct smbldap_state *ldap_state = arg;
789 /** @TODO Should we be doing something to check what servers we rebind to?
790 Could we get a referral to a machine that we don't want to give our
791 username and password to? */
796 memset(*credp, '\0', strlen(*credp));
800 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
801 ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
803 if (ldap_state->anonymous) {
807 *whop = SMB_STRDUP(ldap_state->bind_dn);
809 return LDAP_NO_MEMORY;
811 *credp = SMB_STRDUP(ldap_state->bind_secret);
814 return LDAP_NO_MEMORY;
817 *methodp = LDAP_AUTH_SIMPLE;
820 GetTimeOfDay(&ldap_state->last_rebind);
824 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
826 /*******************************************************************
827 a rebind function for authenticated referrals
828 This version takes a void* that we can shove useful stuff in :-)
829 and actually does the connection.
830 ******************************************************************/
831 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
832 static int rebindproc_connect_with_state (LDAP *ldap_struct,
833 LDAP_CONST char *url,
835 ber_int_t msgid, void *arg)
837 struct smbldap_state *ldap_state =
838 (struct smbldap_state *)arg;
842 DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n",
843 url, ldap_state->bind_dn?ldap_state->bind_dn:"[Anonymous bind]"));
845 /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
846 * itself) before rebinding to another LDAP server to avoid to expose
847 * our credentials. At least *try* to secure the connection - Guenther */
849 smb_ldap_upgrade_conn(ldap_struct, &version);
850 smb_ldap_start_tls(ldap_struct, version);
852 /** @TODO Should we be doing something to check what servers we rebind to?
853 Could we get a referral to a machine that we don't want to give our
854 username and password to? */
856 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
858 /* only set the last rebind timestamp when we did rebind after a
859 * non-read LDAP operation. That way we avoid the replication sleep
860 * after a simple redirected search operation - Guenther */
864 case LDAP_REQ_MODIFY:
866 case LDAP_REQ_DELETE:
868 case LDAP_REQ_EXTENDED:
869 DEBUG(10,("rebindproc_connect_with_state: "
870 "setting last_rebind timestamp "
871 "(req: 0x%02x)\n", (unsigned int)request));
872 GetTimeOfDay(&ldap_state->last_rebind);
875 ZERO_STRUCT(ldap_state->last_rebind);
881 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
883 /*******************************************************************
884 Add a rebind function for authenticated referrals
885 ******************************************************************/
886 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
888 # if LDAP_SET_REBIND_PROC_ARGS == 2
889 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
890 int *method, int freeit )
892 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
894 return rebindproc_with_state(ldap_struct, whop, credp,
895 method, freeit, ldap_state);
898 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
899 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
901 /*******************************************************************
902 a rebind function for authenticated referrals
903 this also does the connection, but no void*.
904 ******************************************************************/
905 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
906 # if LDAP_SET_REBIND_PROC_ARGS == 2
907 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
910 struct smbldap_state *ldap_state = smbldap_find_state(ld);
912 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
915 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
916 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
918 /*******************************************************************
919 connect to the ldap server under system privilege.
920 ******************************************************************/
921 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
926 if (!ldap_state->anonymous && !ldap_state->bind_dn) {
928 /* get the default dn and password only if they are not set already */
929 if (!fetch_ldap_pw(&ldap_state->bind_dn, &ldap_state->bind_secret)) {
930 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
931 return LDAP_INVALID_CREDENTIALS;
935 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
936 (OpenLDAP) doesnt' seem to support it */
938 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
939 ldap_state->uri, ldap_state->bind_dn));
941 #ifdef HAVE_LDAP_SET_REBIND_PROC
942 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
943 # if LDAP_SET_REBIND_PROC_ARGS == 2
944 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
946 # if LDAP_SET_REBIND_PROC_ARGS == 3
947 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
949 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
950 # if LDAP_SET_REBIND_PROC_ARGS == 2
951 ldap_set_rebind_proc(ldap_struct, &rebindproc);
953 # if LDAP_SET_REBIND_PROC_ARGS == 3
954 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
956 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
959 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
961 if (rc != LDAP_SUCCESS) {
962 char *ld_error = NULL;
963 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
965 DEBUG(ldap_state->num_failures ? 2 : 0,
966 ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
968 ldap_state->bind_dn ? ldap_state->bind_dn : "[Anonymous bind]",
970 ld_error ? ld_error : "(unknown)"));
972 ldap_state->num_failures++;
976 ldap_state->num_failures = 0;
977 ldap_state->paged_results = False;
979 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
981 if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
982 ldap_state->paged_results = True;
985 DEBUG(3, ("ldap_connect_system: successful connection to the LDAP server\n"));
986 DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n",
987 ldap_state->paged_results ? "does" : "does not"));
991 static void smbldap_idle_fn(struct event_context *event_ctx,
992 struct timed_event *te,
993 const struct timeval *now,
996 /**********************************************************************
997 Connect to LDAP server (called before every ldap operation)
998 *********************************************************************/
999 static int smbldap_open(struct smbldap_state *ldap_state)
1002 bool reopen = False;
1003 SMB_ASSERT(ldap_state);
1005 #ifndef NO_LDAP_SECURITY
1006 if (geteuid() != 0) {
1007 DEBUG(0, ("smbldap_open: cannot access LDAP when not root..\n"));
1008 return LDAP_INSUFFICIENT_ACCESS;
1012 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1014 #ifdef HAVE_UNIXSOCKET
1015 struct sockaddr_un addr;
1017 struct sockaddr addr;
1019 socklen_t len = sizeof(addr);
1022 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1023 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1026 #ifdef HAVE_UNIXSOCKET
1027 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1031 /* the other end has died. reopen. */
1032 ldap_unbind(ldap_state->ldap_struct);
1033 ldap_state->ldap_struct = NULL;
1034 ldap_state->last_ping = (time_t)0;
1036 ldap_state->last_ping = time(NULL);
1040 if (ldap_state->ldap_struct != NULL) {
1041 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1042 return LDAP_SUCCESS;
1045 if ((rc = smbldap_open_connection(ldap_state))) {
1049 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1050 ldap_unbind(ldap_state->ldap_struct);
1051 ldap_state->ldap_struct = NULL;
1056 ldap_state->last_ping = time(NULL);
1057 ldap_state->pid = sys_getpid();
1059 TALLOC_FREE(ldap_state->idle_event);
1061 if (ldap_state->event_context != NULL) {
1062 ldap_state->idle_event = event_add_timed(
1063 ldap_state->event_context, NULL,
1064 timeval_current_ofs(SMBLDAP_IDLE_TIME, 0),
1065 "smbldap_idle_fn", smbldap_idle_fn, ldap_state);
1068 DEBUG(4,("The LDAP server is successfully connected\n"));
1070 return LDAP_SUCCESS;
1073 /**********************************************************************
1074 Disconnect from LDAP server
1075 *********************************************************************/
1076 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1079 return NT_STATUS_INVALID_PARAMETER;
1081 if (ldap_state->ldap_struct != NULL) {
1082 ldap_unbind(ldap_state->ldap_struct);
1083 ldap_state->ldap_struct = NULL;
1086 smbldap_delete_state(ldap_state);
1088 DEBUG(5,("The connection to the LDAP server was closed\n"));
1089 /* maybe free the results here --metze */
1091 return NT_STATUS_OK;
1094 static bool got_alarm;
1096 static void (*old_handler)(int);
1098 static void gotalarm_sig(int dummy)
1103 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1104 int *attempts, time_t endtime)
1106 time_t now = time(NULL);
1107 int open_rc = LDAP_SERVER_DOWN;
1109 if (*rc != LDAP_SERVER_DOWN)
1112 if (now >= endtime) {
1113 smbldap_close(ldap_state);
1118 if (*attempts == 0) {
1120 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1121 alarm(endtime - now);
1123 if (ldap_state->pid != sys_getpid())
1124 smbldap_close(ldap_state);
1134 open_rc = smbldap_open(ldap_state);
1136 if (open_rc == LDAP_SUCCESS) {
1137 ldap_state->last_use = now;
1141 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1142 /* The fact that we are non-root or any other
1143 * access-denied condition will not change in the next
1144 * round of trying */
1154 if (open_rc != LDAP_SUCCESS) {
1155 DEBUG(1, ("Connection to LDAP server failed for the "
1156 "%d try!\n", *attempts));
1161 CatchSignal(SIGALRM, old_handler);
1163 ldap_state->last_use = now;
1167 /*********************************************************************
1168 ********************************************************************/
1170 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1171 const char *base, int scope, const char *filter,
1172 const char *attrs[], int attrsonly,
1173 LDAPControl **sctrls, LDAPControl **cctrls,
1174 int sizelimit, LDAPMessage **res)
1176 int rc = LDAP_SERVER_DOWN;
1179 time_t endtime = time(NULL)+lp_ldap_timeout();
1180 struct timeval timeout;
1181 size_t converted_size;
1183 SMB_ASSERT(ldap_state);
1185 DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1186 "scope => [%d]\n", base, filter, scope));
1188 if (ldap_state->last_rebind.tv_sec > 0) {
1189 struct timeval tval;
1190 SMB_BIG_INT tdiff = 0;
1194 GetTimeOfDay(&tval);
1196 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1197 tdiff /= 1000; /* Convert to milliseconds. */
1199 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1200 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1202 if (sleep_time > 0) {
1203 /* we wait for the LDAP replication */
1204 DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1205 "for LDAP replication.\n",sleep_time));
1206 smb_msleep(sleep_time);
1207 DEBUG(5,("smbldap_search_ext: go on!\n"));
1209 ZERO_STRUCT(ldap_state->last_rebind);
1212 if (!push_utf8_allocate(&utf8_filter, filter, &converted_size)) {
1213 return LDAP_NO_MEMORY;
1216 /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1217 timeout.tv_sec = lp_ldap_timeout();
1218 timeout.tv_usec = 0;
1220 /* Setup alarm timeout.... Do we need both of these ? JRA.
1221 * Yes, I think we do need both of these. The server timeout only
1222 * covers the case where the server's operation takes too long. It
1223 * does not cover the case where the request hangs on its way to the
1224 * server. The server side timeout is not strictly necessary, it's
1225 * just a bit more kind to the server. VL. */
1228 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1229 alarm(lp_ldap_timeout());
1230 /* End setup timeout. */
1232 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1233 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope,
1235 CONST_DISCARD(char **, attrs),
1236 attrsonly, sctrls, cctrls, &timeout,
1238 if (rc != LDAP_SUCCESS) {
1239 char *ld_error = NULL;
1242 ldap_get_option(ldap_state->ldap_struct,
1243 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1245 ldap_get_option(ldap_state->ldap_struct,
1246 LDAP_OPT_ERROR_STRING, &ld_error);
1247 DEBUG(10, ("Failed search for base: %s, error: %d (%s) "
1248 "(%s)\n", base, ld_errno,
1249 ldap_err2string(rc),
1250 ld_error ? ld_error : "unknown"));
1251 SAFE_FREE(ld_error);
1253 if (ld_errno == LDAP_SERVER_DOWN) {
1254 ldap_unbind(ldap_state->ldap_struct);
1255 ldap_state->ldap_struct = NULL;
1260 SAFE_FREE(utf8_filter);
1262 /* Teardown timeout. */
1263 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1267 return LDAP_TIMELIMIT_EXCEEDED;
1272 int smbldap_search(struct smbldap_state *ldap_state,
1273 const char *base, int scope, const char *filter,
1274 const char *attrs[], int attrsonly,
1277 return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1278 attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1281 int smbldap_search_paged(struct smbldap_state *ldap_state,
1282 const char *base, int scope, const char *filter,
1283 const char **attrs, int attrsonly, int pagesize,
1284 LDAPMessage **res, void **cookie)
1287 LDAPControl **rcontrols;
1288 LDAPControl *controls[2] = { NULL, NULL};
1289 BerElement *cookie_be = NULL;
1290 struct berval *cookie_bv = NULL;
1292 bool critical = True;
1296 DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1297 "scope => [%d], pagesize => [%d]\n",
1298 base, filter, scope, pagesize));
1300 cookie_be = ber_alloc_t(LBER_USE_DER);
1301 if (cookie_be == NULL) {
1302 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1304 return LDAP_NO_MEMORY;
1307 /* construct cookie */
1308 if (*cookie != NULL) {
1309 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1310 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1313 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1315 ber_flatten(cookie_be, &cookie_bv);
1317 pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1318 pr.ldctl_iscritical = (char) critical;
1319 pr.ldctl_value.bv_len = cookie_bv->bv_len;
1320 pr.ldctl_value.bv_val = cookie_bv->bv_val;
1325 rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1326 0, controls, NULL, LDAP_NO_LIMIT, res);
1328 ber_free(cookie_be, 1);
1329 ber_bvfree(cookie_bv);
1332 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1333 "failed with [%s]\n", filter, ldap_err2string(rc)));
1337 DEBUG(3,("smbldap_search_paged: search was successfull\n"));
1339 rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL,
1340 NULL, NULL, &rcontrols, 0);
1342 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1343 "with [%s]\n", ldap_err2string(rc)));
1347 if (rcontrols == NULL)
1350 for (i=0; rcontrols[i]; i++) {
1352 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1355 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1356 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1357 /* the berval is the cookie, but must be freed when it is all
1359 if (cookie_bv->bv_len)
1360 *cookie=ber_bvdup(cookie_bv);
1363 ber_bvfree(cookie_bv);
1364 ber_free(cookie_be, 1);
1367 ldap_controls_free(rcontrols);
1372 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1374 int rc = LDAP_SERVER_DOWN;
1377 time_t endtime = time(NULL)+lp_ldap_timeout();
1378 size_t converted_size;
1380 SMB_ASSERT(ldap_state);
1382 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1384 if (!push_utf8_allocate(&utf8_dn, dn, &converted_size)) {
1385 return LDAP_NO_MEMORY;
1388 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1389 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1390 if (rc != LDAP_SUCCESS) {
1391 char *ld_error = NULL;
1394 ldap_get_option(ldap_state->ldap_struct,
1395 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1397 ldap_get_option(ldap_state->ldap_struct,
1398 LDAP_OPT_ERROR_STRING, &ld_error);
1399 DEBUG(10, ("Failed to modify dn: %s, error: %d (%s) "
1400 "(%s)\n", dn, ld_errno,
1401 ldap_err2string(rc),
1402 ld_error ? ld_error : "unknown"));
1403 SAFE_FREE(ld_error);
1405 if (ld_errno == LDAP_SERVER_DOWN) {
1406 ldap_unbind(ldap_state->ldap_struct);
1407 ldap_state->ldap_struct = NULL;
1416 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1418 int rc = LDAP_SERVER_DOWN;
1421 time_t endtime = time(NULL)+lp_ldap_timeout();
1422 size_t converted_size;
1424 SMB_ASSERT(ldap_state);
1426 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1428 if (!push_utf8_allocate(&utf8_dn, dn, &converted_size)) {
1429 return LDAP_NO_MEMORY;
1432 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1433 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1434 if (rc != LDAP_SUCCESS) {
1435 char *ld_error = NULL;
1438 ldap_get_option(ldap_state->ldap_struct,
1439 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1441 ldap_get_option(ldap_state->ldap_struct,
1442 LDAP_OPT_ERROR_STRING, &ld_error);
1443 DEBUG(10, ("Failed to add dn: %s, error: %d (%s) "
1444 "(%s)\n", dn, ld_errno,
1445 ldap_err2string(rc),
1446 ld_error ? ld_error : "unknown"));
1447 SAFE_FREE(ld_error);
1449 if (ld_errno == LDAP_SERVER_DOWN) {
1450 ldap_unbind(ldap_state->ldap_struct);
1451 ldap_state->ldap_struct = NULL;
1460 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1462 int rc = LDAP_SERVER_DOWN;
1465 time_t endtime = time(NULL)+lp_ldap_timeout();
1466 size_t converted_size;
1468 SMB_ASSERT(ldap_state);
1470 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1472 if (!push_utf8_allocate(&utf8_dn, dn, &converted_size)) {
1473 return LDAP_NO_MEMORY;
1476 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1477 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1478 if (rc != LDAP_SUCCESS) {
1479 char *ld_error = NULL;
1482 ldap_get_option(ldap_state->ldap_struct,
1483 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1485 ldap_get_option(ldap_state->ldap_struct,
1486 LDAP_OPT_ERROR_STRING, &ld_error);
1487 DEBUG(10, ("Failed to delete dn: %s, error: %d (%s) "
1488 "(%s)\n", dn, ld_errno,
1489 ldap_err2string(rc),
1490 ld_error ? ld_error : "unknown"));
1491 SAFE_FREE(ld_error);
1493 if (ld_errno == LDAP_SERVER_DOWN) {
1494 ldap_unbind(ldap_state->ldap_struct);
1495 ldap_state->ldap_struct = NULL;
1504 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1505 LDAP_CONST char *reqoid, struct berval *reqdata,
1506 LDAPControl **serverctrls, LDAPControl **clientctrls,
1507 char **retoidp, struct berval **retdatap)
1509 int rc = LDAP_SERVER_DOWN;
1511 time_t endtime = time(NULL)+lp_ldap_timeout();
1516 while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1517 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1518 reqdata, serverctrls,
1519 clientctrls, retoidp, retdatap);
1520 if (rc != LDAP_SUCCESS) {
1521 char *ld_error = NULL;
1524 ldap_get_option(ldap_state->ldap_struct,
1525 LDAP_OPT_ERROR_NUMBER, &ld_errno);
1527 ldap_get_option(ldap_state->ldap_struct,
1528 LDAP_OPT_ERROR_STRING, &ld_error);
1529 DEBUG(10, ("Extended operation failed with error: "
1530 "%d (%s) (%s)\n", ld_errno,
1531 ldap_err2string(rc),
1532 ld_error ? ld_error : "unknown"));
1533 SAFE_FREE(ld_error);
1535 if (ld_errno == LDAP_SERVER_DOWN) {
1536 ldap_unbind(ldap_state->ldap_struct);
1537 ldap_state->ldap_struct = NULL;
1545 /*******************************************************************
1546 run the search by name.
1547 ******************************************************************/
1548 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1549 const char *filter, const char **search_attr,
1550 LDAPMessage ** result)
1552 return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1553 filter, search_attr, 0, result);
1556 static void smbldap_idle_fn(struct event_context *event_ctx,
1557 struct timed_event *te,
1558 const struct timeval *now,
1561 struct smbldap_state *state = (struct smbldap_state *)private_data;
1563 TALLOC_FREE(state->idle_event);
1565 if (state->ldap_struct == NULL) {
1566 DEBUG(10,("ldap connection not connected...\n"));
1570 if ((state->last_use+SMBLDAP_IDLE_TIME) > now->tv_sec) {
1571 DEBUG(10,("ldap connection not idle...\n"));
1573 state->idle_event = event_add_timed(
1575 timeval_add(now, SMBLDAP_IDLE_TIME, 0),
1576 "smbldap_idle_fn", smbldap_idle_fn,
1581 DEBUG(7,("ldap connection idle...closing connection\n"));
1582 smbldap_close(state);
1585 /**********************************************************************
1587 *********************************************************************/
1589 void smbldap_free_struct(struct smbldap_state **ldap_state)
1591 smbldap_close(*ldap_state);
1593 if ((*ldap_state)->bind_secret) {
1594 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1597 SAFE_FREE((*ldap_state)->bind_dn);
1598 SAFE_FREE((*ldap_state)->bind_secret);
1600 TALLOC_FREE((*ldap_state)->idle_event);
1604 /* No need to free any further, as it is talloc()ed */
1608 /**********************************************************************
1609 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1610 *********************************************************************/
1612 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, struct event_context *event_ctx,
1613 const char *location,
1614 struct smbldap_state **smbldap_state)
1616 *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1617 if (!*smbldap_state) {
1618 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1619 return NT_STATUS_NO_MEMORY;
1623 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1625 (*smbldap_state)->uri = "ldap://localhost";
1628 (*smbldap_state)->event_context = event_ctx;
1630 return NT_STATUS_OK;
1633 /*******************************************************************
1634 Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1635 ********************************************************************/
1636 char *smbldap_get_dn(LDAP *ld, LDAPMessage *entry)
1638 char *utf8_dn, *unix_dn;
1639 size_t converted_size;
1641 utf8_dn = ldap_get_dn(ld, entry);
1643 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1646 if (!pull_utf8_allocate(&unix_dn, utf8_dn, &converted_size)) {
1647 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1648 "[%s]\n", utf8_dn));
1651 ldap_memfree(utf8_dn);
1655 const 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_get_dn: ldap_get_dn failed\n"));
1666 if (!pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn, &converted_size)) {
1667 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1668 "[%s]\n", utf8_dn));
1671 ldap_memfree(utf8_dn);
1675 /*******************************************************************
1676 Check if root-dse has a certain Control or Extension
1677 ********************************************************************/
1679 static bool smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value)
1681 LDAPMessage *msg = NULL;
1682 LDAPMessage *entry = NULL;
1683 char **values = NULL;
1684 int rc, num_result, num_values, i;
1685 bool result = False;
1688 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1692 if (!strequal(attrs[0], "supportedExtension") &&
1693 !strequal(attrs[0], "supportedControl") &&
1694 !strequal(attrs[0], "namingContexts")) {
1695 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1699 rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE,
1700 "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1702 if (rc != LDAP_SUCCESS) {
1703 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1707 num_result = ldap_count_entries(ld, msg);
1709 if (num_result != 1) {
1710 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1714 entry = ldap_first_entry(ld, msg);
1716 if (entry == NULL) {
1717 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1721 values = ldap_get_values(ld, entry, attrs[0]);
1723 if (values == NULL) {
1724 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1728 num_values = ldap_count_values(values);
1730 if (num_values == 0) {
1731 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1735 for (i=0; i<num_values; i++) {
1736 if (strcmp(values[i], value) == 0)
1743 ldap_value_free(values);
1751 /*******************************************************************
1752 Check if LDAP-Server supports a certain Control (OID in string format)
1753 ********************************************************************/
1755 bool smbldap_has_control(LDAP *ld, const char *control)
1757 const char *attrs[] = { "supportedControl", NULL };
1758 return smbldap_check_root_dse(ld, attrs, control);
1761 /*******************************************************************
1762 Check if LDAP-Server supports a certain Extension (OID in string format)
1763 ********************************************************************/
1765 bool smbldap_has_extension(LDAP *ld, const char *extension)
1767 const char *attrs[] = { "supportedExtension", NULL };
1768 return smbldap_check_root_dse(ld, attrs, extension);
1771 /*******************************************************************
1772 Check if LDAP-Server holds a given namingContext
1773 ********************************************************************/
1775 bool smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1777 const char *attrs[] = { "namingContexts", NULL };
1778 return smbldap_check_root_dse(ld, attrs, naming_context);
1781 bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret)
1783 ldap_state->anonymous = anon;
1785 /* free any previously set credential */
1787 SAFE_FREE(ldap_state->bind_dn);
1788 if (ldap_state->bind_secret) {
1789 /* make sure secrets are zeroed out of memory */
1790 memset(ldap_state->bind_secret, '\0', strlen(ldap_state->bind_secret));
1791 SAFE_FREE(ldap_state->bind_secret);
1795 ldap_state->bind_dn = SMB_STRDUP(dn);
1796 ldap_state->bind_secret = SMB_STRDUP(secret);