2 Unix SMB/CIFS mplementation.
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 2 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, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 #ifndef LDAP_OPT_SUCCESS
30 #define LDAP_OPT_SUCCESS 0
33 /* Try not to hit the up or down server forever */
35 #define SMBLDAP_DONT_PING_TIME 10 /* ping only all 10 seconds */
36 #define SMBLDAP_NUM_RETRIES 8 /* retry only 8 times */
38 #define SMBLDAP_IDLE_TIME 150 /* After 2.5 minutes disconnect */
41 /* attributes used by Samba 2.2 */
43 ATTRIB_MAP_ENTRY attrib_map_v22[] = {
44 { LDAP_ATTR_UID, "uid" },
45 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
46 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
47 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
48 { LDAP_ATTR_PWD_LAST_SET, "pwdLastSet" },
49 { LDAP_ATTR_PWD_CAN_CHANGE, "pwdCanChange" },
50 { LDAP_ATTR_PWD_MUST_CHANGE, "pwdMustChange" },
51 { LDAP_ATTR_LOGON_TIME, "logonTime" },
52 { LDAP_ATTR_LOGOFF_TIME, "logoffTime" },
53 { LDAP_ATTR_KICKOFF_TIME, "kickoffTime" },
54 { LDAP_ATTR_CN, "cn" },
55 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
56 { LDAP_ATTR_HOME_PATH, "smbHome" },
57 { LDAP_ATTR_HOME_DRIVE, "homeDrives" },
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_LIST_END, NULL }
72 /* attributes used by Samba 3.0's sambaSamAccount */
74 ATTRIB_MAP_ENTRY attrib_map_v30[] = {
75 { LDAP_ATTR_UID, "uid" },
76 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
77 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
78 { LDAP_ATTR_UNIX_HOME, "homeDirectory" },
79 { LDAP_ATTR_PWD_LAST_SET, "sambaPwdLastSet" },
80 { LDAP_ATTR_PWD_CAN_CHANGE, "sambaPwdCanChange" },
81 { LDAP_ATTR_PWD_MUST_CHANGE, "sambaPwdMustChange" },
82 { LDAP_ATTR_LOGON_TIME, "sambaLogonTime" },
83 { LDAP_ATTR_LOGOFF_TIME, "sambaLogoffTime" },
84 { LDAP_ATTR_KICKOFF_TIME, "sambaKickoffTime" },
85 { LDAP_ATTR_CN, "cn" },
86 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
87 { LDAP_ATTR_HOME_DRIVE, "sambaHomeDrive" },
88 { LDAP_ATTR_HOME_PATH, "sambaHomePath" },
89 { LDAP_ATTR_LOGON_SCRIPT, "sambaLogonScript" },
90 { LDAP_ATTR_PROFILE_PATH, "sambaProfilePath" },
91 { LDAP_ATTR_DESC, "description" },
92 { LDAP_ATTR_USER_WKS, "sambaUserWorkstations" },
93 { LDAP_ATTR_USER_SID, LDAP_ATTRIBUTE_SID },
94 { LDAP_ATTR_PRIMARY_GROUP_SID, "sambaPrimaryGroupSID" },
95 { LDAP_ATTR_LMPW, "sambaLMPassword" },
96 { LDAP_ATTR_NTPW, "sambaNTPassword" },
97 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
98 { LDAP_ATTR_OBJCLASS, "objectClass" },
99 { LDAP_ATTR_ACB_INFO, "sambaAcctFlags" },
100 { LDAP_ATTR_MUNGED_DIAL, "sambaMungedDial" },
101 { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
102 { LDAP_ATTR_BAD_PASSWORD_TIME, "sambaBadPasswordTime" },
103 { LDAP_ATTR_MOD_TIMESTAMP, "modifyTimestamp" },
104 { LDAP_ATTR_LIST_END, NULL }
107 /* attributes used for allocating RIDs */
109 ATTRIB_MAP_ENTRY dominfo_attr_list[] = {
110 { LDAP_ATTR_DOMAIN, "sambaDomainName" },
111 { LDAP_ATTR_NEXT_RID, "sambaNextRid" },
112 { LDAP_ATTR_NEXT_USERRID, "sambaNextUserRid" },
113 { LDAP_ATTR_NEXT_GROUPRID, "sambaNextGroupRid" },
114 { LDAP_ATTR_DOM_SID, LDAP_ATTRIBUTE_SID },
115 { LDAP_ATTR_ALGORITHMIC_RID_BASE,"sambaAlgorithmicRidBase"},
116 { LDAP_ATTR_OBJCLASS, "objectClass" },
117 { LDAP_ATTR_LIST_END, NULL },
120 /* Samba 3.0 group mapping attributes */
122 ATTRIB_MAP_ENTRY groupmap_attr_list[] = {
123 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
124 { LDAP_ATTR_GROUP_SID, LDAP_ATTRIBUTE_SID },
125 { LDAP_ATTR_GROUP_TYPE, "sambaGroupType" },
126 { LDAP_ATTR_DESC, "description" },
127 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
128 { LDAP_ATTR_CN, "cn" },
129 { LDAP_ATTR_OBJCLASS, "objectClass" },
130 { LDAP_ATTR_LIST_END, NULL }
133 ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete[] = {
134 { LDAP_ATTR_GROUP_SID, LDAP_ATTRIBUTE_SID },
135 { LDAP_ATTR_GROUP_TYPE, "sambaGroupType" },
136 { LDAP_ATTR_DESC, "description" },
137 { LDAP_ATTR_DISPLAY_NAME, "displayName" },
138 { LDAP_ATTR_LIST_END, NULL }
141 /* idmap_ldap sambaUnixIdPool */
143 ATTRIB_MAP_ENTRY idpool_attr_list[] = {
144 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
145 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
146 { LDAP_ATTR_OBJCLASS, "objectClass" },
147 { LDAP_ATTR_LIST_END, NULL }
150 ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
151 { LDAP_ATTR_SID, LDAP_ATTRIBUTE_SID },
152 { LDAP_ATTR_UIDNUMBER, LDAP_ATTRIBUTE_UIDNUMBER},
153 { LDAP_ATTR_GIDNUMBER, LDAP_ATTRIBUTE_GIDNUMBER},
154 { LDAP_ATTR_OBJCLASS, "objectClass" },
155 { LDAP_ATTR_LIST_END, NULL }
160 ATTRIB_MAP_ENTRY privilege_attr_list[] = {
161 { LDAP_ATTR_CN, "sambaPrivName" },
162 { LDAP_ATTR_SID_LIST, LDAP_ATTRIBUTE_SID_LIST },
163 { LDAP_ATTR_DESC, "description" },
164 { LDAP_ATTR_OBJCLASS, "objectClass" },
165 { LDAP_ATTR_LIST_END, NULL }
168 /**********************************************************************
169 perform a simple table lookup and return the attribute name
170 **********************************************************************/
172 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table[], int key )
176 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
177 if ( table[i].attrib == key )
178 return table[i].name;
186 /**********************************************************************
187 Return the list of attribute names from a mapping table
188 **********************************************************************/
190 char** get_attr_list( ATTRIB_MAP_ENTRY table[] )
195 while ( table[i].attrib != LDAP_ATTR_LIST_END )
199 names = (char**)malloc( sizeof(char*)*i );
201 DEBUG(0,("get_attr_list: out of memory\n"));
206 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
207 names[i] = strdup( table[i].name );
215 /*********************************************************************
217 ********************************************************************/
219 void free_attr_list( char **list )
227 SAFE_FREE( list[i] );
234 /*******************************************************************
235 find the ldap password
236 ******************************************************************/
237 static BOOL fetch_ldap_pw(char **dn, char** pw)
242 *dn = smb_xstrdup(lp_ldap_admin_dn());
244 if (asprintf(&key, "%s/%s", SECRETS_LDAP_BIND_PW, *dn) < 0) {
246 DEBUG(0, ("fetch_ldap_pw: asprintf failed!\n"));
249 *pw=secrets_fetch(key, &size);
253 /* Upgrade 2.2 style entry */
255 char* old_style_key = strdup(*dn);
257 fstring old_style_pw;
259 if (!old_style_key) {
260 DEBUG(0, ("fetch_ldap_pw: strdup failed!\n"));
264 for (p=old_style_key; *p; p++)
265 if (*p == ',') *p = '/';
267 data=secrets_fetch(old_style_key, &size);
268 if (!size && size < sizeof(old_style_pw)) {
269 DEBUG(0,("fetch_ldap_pw: neither ldap secret retrieved!\n"));
270 SAFE_FREE(old_style_key);
275 size = MIN(size, sizeof(fstring)-1);
276 strncpy(old_style_pw, data, size);
277 old_style_pw[size] = 0;
281 if (!secrets_store_ldap_pw(*dn, old_style_pw)) {
282 DEBUG(0,("fetch_ldap_pw: ldap secret could not be upgraded!\n"));
283 SAFE_FREE(old_style_key);
287 if (!secrets_delete(old_style_key)) {
288 DEBUG(0,("fetch_ldap_pw: old ldap secret could not be deleted!\n"));
291 SAFE_FREE(old_style_key);
293 *pw = smb_xstrdup(old_style_pw);
299 /*******************************************************************
300 Search an attribute and return the first value found.
301 ******************************************************************/
303 BOOL smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
304 const char *attribute, char *value,
314 if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
315 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
320 if (convert_string(CH_UTF8, CH_UNIX,values[0], -1, value, max_len, False) == (size_t)-1) {
321 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
322 attribute, values[0]));
323 ldap_value_free(values);
327 ldap_value_free(values);
328 #ifdef DEBUG_PASSWORDS
329 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
334 BOOL smbldap_get_single_pstring (LDAP * ldap_struct, LDAPMessage * entry,
335 const char *attribute, pstring value)
337 return smbldap_get_single_attribute(ldap_struct, entry,
342 /************************************************************************
343 Routine to manage the LDAPMod structure array
344 manage memory used by the array, by each struct, and values
345 ***********************************************************************/
347 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
355 /* sanity checks on the mod values */
357 if (attribute == NULL || *attribute == '\0')
359 #if 0 /* commented out after discussion with abartlet. Do not reenable.
360 left here so other so re-add similar code --jerry */
361 if (value == NULL || *value == '\0')
367 mods = (LDAPMod **) malloc(sizeof(LDAPMod *));
370 DEBUG(0, ("make_a_mod: out of memory!\n"));
376 for (i = 0; mods[i] != NULL; ++i) {
377 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
383 mods = (LDAPMod **) Realloc (mods, (i + 2) * sizeof (LDAPMod *));
386 DEBUG(0, ("make_a_mod: out of memory!\n"));
389 mods[i] = (LDAPMod *) malloc(sizeof(LDAPMod));
392 DEBUG(0, ("make_a_mod: out of memory!\n"));
395 mods[i]->mod_op = modop;
396 mods[i]->mod_values = NULL;
397 mods[i]->mod_type = strdup(attribute);
403 char *utf8_value = NULL;
406 if (mods[i]->mod_values != NULL) {
407 for (; mods[i]->mod_values[j] != NULL; j++);
409 mods[i]->mod_values = (char **)Realloc(mods[i]->mod_values,
410 (j + 2) * sizeof (char *));
412 if (mods[i]->mod_values == NULL) {
413 DEBUG (0, ("make_a_mod: Memory allocation failure!\n"));
417 if (push_utf8_allocate(&utf8_value, value) == (size_t)-1) {
418 DEBUG (0, ("make_a_mod: String conversion failure!\n"));
422 mods[i]->mod_values[j] = utf8_value;
424 mods[i]->mod_values[j + 1] = NULL;
429 /**********************************************************************
430 Set attribute to newval in LDAP, regardless of what value the
431 attribute had in LDAP before.
432 *********************************************************************/
434 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
436 const char *attribute, const char *newval)
438 char oldval[2048]; /* current largest allowed value is mungeddial */
441 if (existing != NULL) {
442 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
448 /* all of our string attributes are case insensitive */
450 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
452 /* Believe it or not, but LDAP will deny a delete and
453 an add at the same time if the values are the
459 /* There has been no value before, so don't delete it.
460 * Here's a possible race: We might end up with
461 * duplicate attributes */
462 /* By deleting exactly the value we found in the entry this
463 * should be race-free in the sense that the LDAP-Server will
464 * deny the complete operation if somebody changed the
465 * attribute behind our back. */
466 /* This will also allow modifying single valued attributes
467 * in Novell NDS. In NDS you have to first remove attribute and then
468 * you could add new value */
470 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
473 /* Regardless of the real operation (add or modify)
474 we add the new value here. We rely on deleting
475 the old value, should it exist. */
477 if ((newval != NULL) && (strlen(newval) > 0)) {
478 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
482 /**********************************************************************
483 Some varients of the LDAP rebind code do not pass in the third 'arg'
484 pointer to a void*, so we try and work around it by assuming that the
485 value of the 'LDAP *' pointer is the same as the one we had passed in
486 **********************************************************************/
488 struct smbldap_state_lookup {
490 struct smbldap_state *smbldap_state;
491 struct smbldap_state_lookup *prev, *next;
494 static struct smbldap_state_lookup *smbldap_state_lookup_list;
496 static struct smbldap_state *smbldap_find_state(LDAP *ld)
498 struct smbldap_state_lookup *t;
500 for (t = smbldap_state_lookup_list; t; t = t->next) {
502 return t->smbldap_state;
508 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
510 struct smbldap_state_lookup *t;
512 for (t = smbldap_state_lookup_list; t; t = t->next) {
513 if (t->smbldap_state == smbldap_state) {
514 DLIST_REMOVE(smbldap_state_lookup_list, t);
521 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
523 struct smbldap_state *tmp_ldap_state;
524 struct smbldap_state_lookup *t;
525 struct smbldap_state_lookup *tmp;
527 if ((tmp_ldap_state = smbldap_find_state(ld))) {
528 SMB_ASSERT(tmp_ldap_state == smbldap_state);
532 t = smb_xmalloc(sizeof(*t));
535 DLIST_ADD_END(smbldap_state_lookup_list, t, tmp);
537 t->smbldap_state = smbldap_state;
540 /*******************************************************************
541 open a connection to the ldap server.
542 ******************************************************************/
543 static int smbldap_open_connection (struct smbldap_state *ldap_state)
546 int rc = LDAP_SUCCESS;
548 BOOL ldap_v3 = False;
549 LDAP **ldap_struct = &ldap_state->ldap_struct;
551 #ifdef HAVE_LDAP_INITIALIZE
552 DEBUG(10, ("smbldap_open_connection: %s\n", ldap_state->uri));
554 if ((rc = ldap_initialize(ldap_struct, ldap_state->uri)) != LDAP_SUCCESS) {
555 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
560 /* Parse the string manually */
566 const char *p = ldap_state->uri;
567 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
569 /* skip leading "URL:" (if any) */
570 if ( strnequal( p, "URL:", 4 ) ) {
574 sscanf(p, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
577 if (strequal(protocol, "ldap")) {
579 } else if (strequal(protocol, "ldaps")) {
582 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
586 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
587 DEBUG(0, ("ldap_init failed !\n"));
588 return LDAP_OPERATIONS_ERROR;
591 if (strequal(protocol, "ldaps")) {
592 #ifdef LDAP_OPT_X_TLS
593 int tls = LDAP_OPT_X_TLS_HARD;
594 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
596 DEBUG(0, ("Failed to setup a TLS session\n"));
599 DEBUG(3,("LDAPS option set...!\n"));
601 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
602 return LDAP_OPERATIONS_ERROR;
608 /* Store the LDAP pointer in a lookup list */
610 smbldap_store_state(*ldap_struct, ldap_state);
612 /* Upgrade to LDAPv3 if possible */
614 if (ldap_get_option(*ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version) == LDAP_OPT_SUCCESS)
616 if (version != LDAP_VERSION3)
618 version = LDAP_VERSION3;
619 if (ldap_set_option (*ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version) == LDAP_OPT_SUCCESS) {
627 if (lp_ldap_ssl() == LDAP_SSL_START_TLS) {
628 #ifdef LDAP_OPT_X_TLS
630 if ((rc = ldap_start_tls_s (*ldap_struct, NULL, NULL)) != LDAP_SUCCESS)
632 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
633 ldap_err2string(rc)));
636 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
639 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
640 return LDAP_OPERATIONS_ERROR;
643 DEBUG(0,("smbldap_open_connection: StartTLS not supported by LDAP client libraries!\n"));
644 return LDAP_OPERATIONS_ERROR;
648 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
653 /*******************************************************************
654 a rebind function for authenticated referrals
655 This version takes a void* that we can shove useful stuff in :-)
656 ******************************************************************/
657 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
659 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
660 int *methodp, int freeit, void *arg)
662 struct smbldap_state *ldap_state = arg;
664 /** @TODO Should we be doing something to check what servers we rebind to?
665 Could we get a referral to a machine that we don't want to give our
666 username and password to? */
670 memset(*credp, '\0', strlen(*credp));
673 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
674 ldap_state->bind_dn));
676 *whop = strdup(ldap_state->bind_dn);
678 return LDAP_NO_MEMORY;
680 *credp = strdup(ldap_state->bind_secret);
683 return LDAP_NO_MEMORY;
685 *methodp = LDAP_AUTH_SIMPLE;
688 gettimeofday(&(ldap_state->last_rebind),NULL);
692 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
694 /*******************************************************************
695 a rebind function for authenticated referrals
696 This version takes a void* that we can shove useful stuff in :-)
697 and actually does the connection.
698 ******************************************************************/
699 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
700 static int rebindproc_connect_with_state (LDAP *ldap_struct,
701 LDAP_CONST char *url,
703 ber_int_t msgid, void *arg)
705 struct smbldap_state *ldap_state = arg;
707 DEBUG(5,("rebindproc_connect_with_state: Rebinding as \"%s\"\n",
708 ldap_state->bind_dn));
710 /** @TODO Should we be doing something to check what servers we rebind to?
711 Could we get a referral to a machine that we don't want to give our
712 username and password to? */
714 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
716 gettimeofday(&(ldap_state->last_rebind),NULL);
720 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
722 /*******************************************************************
723 Add a rebind function for authenticated referrals
724 ******************************************************************/
725 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
727 # if LDAP_SET_REBIND_PROC_ARGS == 2
728 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
729 int *method, int freeit )
731 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
733 return rebindproc_with_state(ldap_struct, whop, credp,
734 method, freeit, ldap_state);
737 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
738 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
740 /*******************************************************************
741 a rebind function for authenticated referrals
742 this also does the connection, but no void*.
743 ******************************************************************/
744 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
745 # if LDAP_SET_REBIND_PROC_ARGS == 2
746 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
749 struct smbldap_state *ldap_state = smbldap_find_state(ld);
751 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
754 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
755 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
757 /*******************************************************************
758 connect to the ldap server under system privilege.
759 ******************************************************************/
760 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
766 /* get the password */
767 if (!fetch_ldap_pw(&ldap_dn, &ldap_secret))
769 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
770 return LDAP_INVALID_CREDENTIALS;
773 ldap_state->bind_dn = ldap_dn;
774 ldap_state->bind_secret = ldap_secret;
776 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
777 (OpenLDAP) doesnt' seem to support it */
779 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
780 ldap_state->uri, ldap_dn));
782 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
783 # if LDAP_SET_REBIND_PROC_ARGS == 2
784 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
786 # if LDAP_SET_REBIND_PROC_ARGS == 3
787 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
789 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
790 # if LDAP_SET_REBIND_PROC_ARGS == 2
791 ldap_set_rebind_proc(ldap_struct, &rebindproc);
793 # if LDAP_SET_REBIND_PROC_ARGS == 3
794 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
796 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
798 rc = ldap_simple_bind_s(ldap_struct, ldap_dn, ldap_secret);
800 if (rc != LDAP_SUCCESS) {
801 char *ld_error = NULL;
802 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
804 DEBUG(ldap_state->num_failures ? 2 : 0,
805 ("failed to bind to server with dn= %s Error: %s\n\t%s\n",
806 ldap_dn ? ldap_dn : "(unknown)", ldap_err2string(rc),
807 ld_error ? ld_error : "(unknown)"));
809 ldap_state->num_failures++;
813 ldap_state->num_failures = 0;
815 DEBUG(3, ("ldap_connect_system: succesful connection to the LDAP server\n"));
819 /**********************************************************************
820 Connect to LDAP server (called before every ldap operation)
821 *********************************************************************/
822 static int smbldap_open(struct smbldap_state *ldap_state)
825 SMB_ASSERT(ldap_state);
827 #ifndef NO_LDAP_SECURITY
828 if (geteuid() != 0) {
829 DEBUG(0, ("smbldap_open: cannot access LDAP when not root..\n"));
830 return LDAP_INSUFFICIENT_ACCESS;
834 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
835 struct sockaddr_un addr;
836 socklen_t len = sizeof(addr);
838 if (ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd) == 0 &&
839 getpeername(sd, (struct sockaddr *) &addr, &len) < 0) {
840 /* the other end has died. reopen. */
841 ldap_unbind_ext(ldap_state->ldap_struct, NULL, NULL);
842 ldap_state->ldap_struct = NULL;
843 ldap_state->last_ping = (time_t)0;
845 ldap_state->last_ping = time(NULL);
849 if (ldap_state->ldap_struct != NULL) {
850 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
854 if ((rc = smbldap_open_connection(ldap_state))) {
858 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
859 ldap_unbind_ext(ldap_state->ldap_struct, NULL, NULL);
860 ldap_state->ldap_struct = NULL;
865 ldap_state->last_ping = time(NULL);
866 DEBUG(4,("The LDAP server is succesful connected\n"));
871 /**********************************************************************
872 Disconnect from LDAP server
873 *********************************************************************/
874 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
877 return NT_STATUS_INVALID_PARAMETER;
879 if (ldap_state->ldap_struct != NULL) {
880 ldap_unbind_ext(ldap_state->ldap_struct, NULL, NULL);
881 ldap_state->ldap_struct = NULL;
884 smbldap_delete_state(ldap_state);
886 DEBUG(5,("The connection to the LDAP server was closed\n"));
887 /* maybe free the results here --metze */
894 int smbldap_retry_open(struct smbldap_state *ldap_state, int *attempts)
898 SMB_ASSERT(ldap_state && attempts);
900 if (*attempts != 0) {
901 unsigned int sleep_time;
904 /* Sleep for a random timeout */
905 rand_byte = (char)(sys_random());
907 sleep_time = (((*attempts)*(*attempts))/2)*rand_byte*2;
908 /* we retry after (0.5, 1, 2, 3, 4.5, 6) seconds
911 DEBUG(3, ("Sleeping for %u milliseconds before reconnecting\n",
913 smb_msleep(sleep_time);
917 if ((rc = smbldap_open(ldap_state))) {
918 DEBUG(1,("Connection to LDAP Server failed for the %d try!\n",*attempts));
926 /*********************************************************************
927 ********************************************************************/
929 int smbldap_search(struct smbldap_state *ldap_state,
930 const char *base, int scope, const char *filter,
931 char *attrs[], int attrsonly,
934 int rc = LDAP_SERVER_DOWN;
938 SMB_ASSERT(ldap_state);
940 DEBUG(5,("smbldap_search: base => [%s], filter => [%s], scope => [%d]\n",
941 base, filter, scope));
943 if (ldap_state->last_rebind.tv_sec > 0) {
950 gettimeofday(&tval,NULL);
952 tdiff = 1000000 *(tval.tv_sec - ldap_state->last_rebind.tv_sec) +
953 (tval.tv_usec - ldap_state->last_rebind.tv_usec);
955 sleep_time = ((1000*lp_ldap_replication_sleep())-tdiff)/1000;
957 if (sleep_time > 0) {
958 /* we wait for the LDAP replication */
959 DEBUG(5,("smbldap_search: waiting %d milliseconds for LDAP replication.\n",sleep_time));
960 smb_msleep(sleep_time);
961 DEBUG(5,("smbldap_search: go on!\n"));
962 ZERO_STRUCT(ldap_state->last_rebind);
966 if (push_utf8_allocate(&utf8_filter, filter) == (size_t)-1) {
967 return LDAP_NO_MEMORY;
970 while ((rc == LDAP_SERVER_DOWN) && (attempts < SMBLDAP_NUM_RETRIES)) {
972 if ((rc = smbldap_retry_open(ldap_state,&attempts)) != LDAP_SUCCESS)
975 rc = ldap_search_s(ldap_state->ldap_struct, base, scope,
976 utf8_filter, attrs, attrsonly, res);
979 if (rc == LDAP_SERVER_DOWN) {
980 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO));
981 smbldap_close(ldap_state);
984 ldap_state->last_use = time(NULL);
986 SAFE_FREE(utf8_filter);
990 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
992 int rc = LDAP_SERVER_DOWN;
996 SMB_ASSERT(ldap_state);
998 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1000 if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1001 return LDAP_NO_MEMORY;
1004 while ((rc == LDAP_SERVER_DOWN) && (attempts < SMBLDAP_NUM_RETRIES)) {
1006 if ((rc = smbldap_retry_open(ldap_state,&attempts)) != LDAP_SUCCESS)
1009 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1012 if (rc == LDAP_SERVER_DOWN) {
1013 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO));
1014 smbldap_close(ldap_state);
1017 ldap_state->last_use = time(NULL);
1023 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1025 int rc = LDAP_SERVER_DOWN;
1029 SMB_ASSERT(ldap_state);
1031 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1033 if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1034 return LDAP_NO_MEMORY;
1037 while ((rc == LDAP_SERVER_DOWN) && (attempts < SMBLDAP_NUM_RETRIES)) {
1039 if ((rc = smbldap_retry_open(ldap_state,&attempts)) != LDAP_SUCCESS)
1042 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1045 if (rc == LDAP_SERVER_DOWN) {
1046 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO));
1047 smbldap_close(ldap_state);
1050 ldap_state->last_use = time(NULL);
1056 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1058 int rc = LDAP_SERVER_DOWN;
1062 SMB_ASSERT(ldap_state);
1064 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1066 if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1067 return LDAP_NO_MEMORY;
1070 while ((rc == LDAP_SERVER_DOWN) && (attempts < SMBLDAP_NUM_RETRIES)) {
1072 if ((rc = smbldap_retry_open(ldap_state,&attempts)) != LDAP_SUCCESS)
1075 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1078 if (rc == LDAP_SERVER_DOWN) {
1079 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO));
1080 smbldap_close(ldap_state);
1083 ldap_state->last_use = time(NULL);
1089 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1090 LDAP_CONST char *reqoid, struct berval *reqdata,
1091 LDAPControl **serverctrls, LDAPControl **clientctrls,
1092 char **retoidp, struct berval **retdatap)
1094 int rc = LDAP_SERVER_DOWN;
1100 while ((rc == LDAP_SERVER_DOWN) && (attempts < SMBLDAP_NUM_RETRIES)) {
1102 if ((rc = smbldap_retry_open(ldap_state,&attempts)) != LDAP_SUCCESS)
1105 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid, reqdata,
1106 serverctrls, clientctrls, retoidp, retdatap);
1109 if (rc == LDAP_SERVER_DOWN) {
1110 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO));
1111 smbldap_close(ldap_state);
1114 ldap_state->last_use = time(NULL);
1119 /*******************************************************************
1120 run the search by name.
1121 ******************************************************************/
1122 int smbldap_search_suffix (struct smbldap_state *ldap_state, const char *filter,
1123 char **search_attr, LDAPMessage ** result)
1125 int scope = LDAP_SCOPE_SUBTREE;
1128 rc = smbldap_search(ldap_state, lp_ldap_suffix(), scope, filter, search_attr, 0, result);
1130 if (rc != LDAP_SUCCESS) {
1131 char *ld_error = NULL;
1132 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
1134 DEBUG(0,("smbldap_search_suffix: Problem during the LDAP search: %s (%s)\n",
1135 ld_error?ld_error:"(unknown)", ldap_err2string (rc)));
1136 SAFE_FREE(ld_error);
1142 static void smbldap_idle_fn(void **data, time_t *interval, time_t now)
1144 struct smbldap_state *state = (struct smbldap_state *)(*data);
1146 if (state->ldap_struct == NULL) {
1147 DEBUG(10,("ldap connection not connected...\n"));
1151 if ((state->last_use+SMBLDAP_IDLE_TIME) > now) {
1152 DEBUG(10,("ldap connection not idle...\n"));
1156 DEBUG(7,("ldap connection idle...closing connection\n"));
1157 smbldap_close(state);
1160 /**********************************************************************
1162 *********************************************************************/
1164 void smbldap_free_struct(struct smbldap_state **ldap_state)
1166 smbldap_close(*ldap_state);
1168 if ((*ldap_state)->bind_secret) {
1169 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1172 SAFE_FREE((*ldap_state)->bind_dn);
1173 SAFE_FREE((*ldap_state)->bind_secret);
1175 smb_unregister_idle_event((*ldap_state)->event_id);
1179 /* No need to free any further, as it is talloc()ed */
1183 /**********************************************************************
1184 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1185 *********************************************************************/
1187 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, const char *location, struct smbldap_state **smbldap_state)
1189 *smbldap_state = talloc_zero(mem_ctx, sizeof(**smbldap_state));
1190 if (!*smbldap_state) {
1191 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1192 return NT_STATUS_NO_MEMORY;
1196 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1198 (*smbldap_state)->uri = "ldap://localhost";
1201 (*smbldap_state)->event_id =
1202 smb_register_idle_event(smbldap_idle_fn, (void *)(*smbldap_state),
1205 if ((*smbldap_state)->event_id == SMB_EVENT_ID_INVALID) {
1206 DEBUG(0,("Failed to register LDAP idle event!\n"));
1207 return NT_STATUS_INVALID_HANDLE;
1210 return NT_STATUS_OK;
1213 /*******************************************************************
1214 Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1215 ********************************************************************/
1217 char *smbldap_get_dn(LDAP *ld, LDAPMessage *entry)
1219 char *utf8_dn, *unix_dn;
1221 utf8_dn = ldap_get_dn(ld, entry);
1223 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1226 if (pull_utf8_allocate(&unix_dn, utf8_dn) == (size_t)-1) {
1227 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 [%s]\n", utf8_dn));
1230 ldap_memfree(utf8_dn);