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 }
158 /**********************************************************************
159 perform a simple table lookup and return the attribute name
160 **********************************************************************/
162 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table[], int key )
166 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
167 if ( table[i].attrib == key )
168 return table[i].name;
176 /**********************************************************************
177 Return the list of attribute names from a mapping table
178 **********************************************************************/
180 char** get_attr_list( ATTRIB_MAP_ENTRY table[] )
185 while ( table[i].attrib != LDAP_ATTR_LIST_END )
189 names = (char**)malloc( sizeof(char*)*i );
191 DEBUG(0,("get_attr_list: out of memory\n"));
196 while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
197 names[i] = strdup( table[i].name );
205 /*********************************************************************
207 ********************************************************************/
209 void free_attr_list( char **list )
217 SAFE_FREE( list[i] );
224 /*******************************************************************
225 find the ldap password
226 ******************************************************************/
227 static BOOL fetch_ldap_pw(char **dn, char** pw)
232 *dn = smb_xstrdup(lp_ldap_admin_dn());
234 if (asprintf(&key, "%s/%s", SECRETS_LDAP_BIND_PW, *dn) < 0) {
236 DEBUG(0, ("fetch_ldap_pw: asprintf failed!\n"));
239 *pw=secrets_fetch(key, &size);
243 /* Upgrade 2.2 style entry */
245 char* old_style_key = strdup(*dn);
247 fstring old_style_pw;
249 if (!old_style_key) {
250 DEBUG(0, ("fetch_ldap_pw: strdup failed!\n"));
254 for (p=old_style_key; *p; p++)
255 if (*p == ',') *p = '/';
257 data=secrets_fetch(old_style_key, &size);
258 if (!size && size < sizeof(old_style_pw)) {
259 DEBUG(0,("fetch_ldap_pw: neither ldap secret retrieved!\n"));
260 SAFE_FREE(old_style_key);
265 size = MIN(size, sizeof(fstring)-1);
266 strncpy(old_style_pw, data, size);
267 old_style_pw[size] = 0;
271 if (!secrets_store_ldap_pw(*dn, old_style_pw)) {
272 DEBUG(0,("fetch_ldap_pw: ldap secret could not be upgraded!\n"));
273 SAFE_FREE(old_style_key);
277 if (!secrets_delete(old_style_key)) {
278 DEBUG(0,("fetch_ldap_pw: old ldap secret could not be deleted!\n"));
281 SAFE_FREE(old_style_key);
283 *pw = smb_xstrdup(old_style_pw);
289 /*******************************************************************
290 Search an attribute and return the first value found.
291 ******************************************************************/
293 BOOL smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
294 const char *attribute, char *value,
304 if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
305 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
310 if (convert_string(CH_UTF8, CH_UNIX,values[0], -1, value, max_len, False) == (size_t)-1) {
311 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
312 attribute, values[0]));
313 ldap_value_free(values);
317 ldap_value_free(values);
318 #ifdef DEBUG_PASSWORDS
319 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
324 BOOL smbldap_get_single_pstring (LDAP * ldap_struct, LDAPMessage * entry,
325 const char *attribute, pstring value)
327 return smbldap_get_single_attribute(ldap_struct, entry,
332 /************************************************************************
333 Routine to manage the LDAPMod structure array
334 manage memory used by the array, by each struct, and values
335 ***********************************************************************/
337 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
345 /* sanity checks on the mod values */
347 if (attribute == NULL || *attribute == '\0')
349 #if 0 /* commented out after discussion with abartlet. Do not reenable.
350 left here so other so re-add similar code --jerry */
351 if (value == NULL || *value == '\0')
357 mods = (LDAPMod **) malloc(sizeof(LDAPMod *));
360 DEBUG(0, ("make_a_mod: out of memory!\n"));
366 for (i = 0; mods[i] != NULL; ++i) {
367 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
373 mods = (LDAPMod **) Realloc (mods, (i + 2) * sizeof (LDAPMod *));
376 DEBUG(0, ("make_a_mod: out of memory!\n"));
379 mods[i] = (LDAPMod *) malloc(sizeof(LDAPMod));
382 DEBUG(0, ("make_a_mod: out of memory!\n"));
385 mods[i]->mod_op = modop;
386 mods[i]->mod_values = NULL;
387 mods[i]->mod_type = strdup(attribute);
393 char *utf8_value = NULL;
396 if (mods[i]->mod_values != NULL) {
397 for (; mods[i]->mod_values[j] != NULL; j++);
399 mods[i]->mod_values = (char **)Realloc(mods[i]->mod_values,
400 (j + 2) * sizeof (char *));
402 if (mods[i]->mod_values == NULL) {
403 DEBUG (0, ("make_a_mod: Memory allocation failure!\n"));
407 if (push_utf8_allocate(&utf8_value, value) == (size_t)-1) {
408 DEBUG (0, ("make_a_mod: String conversion failure!\n"));
412 mods[i]->mod_values[j] = utf8_value;
414 mods[i]->mod_values[j + 1] = NULL;
419 /**********************************************************************
420 Set attribute to newval in LDAP, regardless of what value the
421 attribute had in LDAP before.
422 *********************************************************************/
424 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
426 const char *attribute, const char *newval)
428 char oldval[2048]; /* current largest allowed value is mungeddial */
431 if (existing != NULL) {
432 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
438 /* all of our string attributes are case insensitive */
440 if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
442 /* Believe it or not, but LDAP will deny a delete and
443 an add at the same time if the values are the
449 /* There has been no value before, so don't delete it.
450 * Here's a possible race: We might end up with
451 * duplicate attributes */
452 /* By deleting exactly the value we found in the entry this
453 * should be race-free in the sense that the LDAP-Server will
454 * deny the complete operation if somebody changed the
455 * attribute behind our back. */
456 /* This will also allow modifying single valued attributes
457 * in Novell NDS. In NDS you have to first remove attribute and then
458 * you could add new value */
460 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
463 /* Regardless of the real operation (add or modify)
464 we add the new value here. We rely on deleting
465 the old value, should it exist. */
467 if ((newval != NULL) && (strlen(newval) > 0)) {
468 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
472 /**********************************************************************
473 Some varients of the LDAP rebind code do not pass in the third 'arg'
474 pointer to a void*, so we try and work around it by assuming that the
475 value of the 'LDAP *' pointer is the same as the one we had passed in
476 **********************************************************************/
478 struct smbldap_state_lookup {
480 struct smbldap_state *smbldap_state;
481 struct smbldap_state_lookup *prev, *next;
484 static struct smbldap_state_lookup *smbldap_state_lookup_list;
486 static struct smbldap_state *smbldap_find_state(LDAP *ld)
488 struct smbldap_state_lookup *t;
490 for (t = smbldap_state_lookup_list; t; t = t->next) {
492 return t->smbldap_state;
498 static void smbldap_delete_state(struct smbldap_state *smbldap_state)
500 struct smbldap_state_lookup *t;
502 for (t = smbldap_state_lookup_list; t; t = t->next) {
503 if (t->smbldap_state == smbldap_state) {
504 DLIST_REMOVE(smbldap_state_lookup_list, t);
511 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state)
513 struct smbldap_state *tmp_ldap_state;
514 struct smbldap_state_lookup *t;
515 struct smbldap_state_lookup *tmp;
517 if ((tmp_ldap_state = smbldap_find_state(ld))) {
518 SMB_ASSERT(tmp_ldap_state == smbldap_state);
522 t = smb_xmalloc(sizeof(*t));
525 DLIST_ADD_END(smbldap_state_lookup_list, t, tmp);
527 t->smbldap_state = smbldap_state;
530 /*******************************************************************
531 open a connection to the ldap server.
532 ******************************************************************/
533 static int smbldap_open_connection (struct smbldap_state *ldap_state)
536 int rc = LDAP_SUCCESS;
538 BOOL ldap_v3 = False;
539 LDAP **ldap_struct = &ldap_state->ldap_struct;
541 #ifdef HAVE_LDAP_INITIALIZE
542 DEBUG(10, ("smbldap_open_connection: %s\n", ldap_state->uri));
544 if ((rc = ldap_initialize(ldap_struct, ldap_state->uri)) != LDAP_SUCCESS) {
545 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
550 /* Parse the string manually */
556 const char *p = ldap_state->uri;
557 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
559 /* skip leading "URL:" (if any) */
560 if ( strnequal( p, "URL:", 4 ) ) {
564 sscanf(p, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
567 if (strequal(protocol, "ldap")) {
569 } else if (strequal(protocol, "ldaps")) {
572 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
576 if ((*ldap_struct = ldap_init(host, port)) == NULL) {
577 DEBUG(0, ("ldap_init failed !\n"));
578 return LDAP_OPERATIONS_ERROR;
581 if (strequal(protocol, "ldaps")) {
582 #ifdef LDAP_OPT_X_TLS
583 int tls = LDAP_OPT_X_TLS_HARD;
584 if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
586 DEBUG(0, ("Failed to setup a TLS session\n"));
589 DEBUG(3,("LDAPS option set...!\n"));
591 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
592 return LDAP_OPERATIONS_ERROR;
598 /* Store the LDAP pointer in a lookup list */
600 smbldap_store_state(*ldap_struct, ldap_state);
602 /* Upgrade to LDAPv3 if possible */
604 if (ldap_get_option(*ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version) == LDAP_OPT_SUCCESS)
606 if (version != LDAP_VERSION3)
608 version = LDAP_VERSION3;
609 if (ldap_set_option (*ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version) == LDAP_OPT_SUCCESS) {
617 if (lp_ldap_ssl() == LDAP_SSL_START_TLS) {
618 #ifdef LDAP_OPT_X_TLS
620 if ((rc = ldap_start_tls_s (*ldap_struct, NULL, NULL)) != LDAP_SUCCESS)
622 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
623 ldap_err2string(rc)));
626 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
629 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
630 return LDAP_OPERATIONS_ERROR;
633 DEBUG(0,("smbldap_open_connection: StartTLS not supported by LDAP client libraries!\n"));
634 return LDAP_OPERATIONS_ERROR;
638 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
643 /*******************************************************************
644 a rebind function for authenticated referrals
645 This version takes a void* that we can shove useful stuff in :-)
646 ******************************************************************/
647 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
649 static int rebindproc_with_state (LDAP * ld, char **whop, char **credp,
650 int *methodp, int freeit, void *arg)
652 struct smbldap_state *ldap_state = arg;
654 /** @TODO Should we be doing something to check what servers we rebind to?
655 Could we get a referral to a machine that we don't want to give our
656 username and password to? */
660 memset(*credp, '\0', strlen(*credp));
663 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
664 ldap_state->bind_dn));
666 *whop = strdup(ldap_state->bind_dn);
668 return LDAP_NO_MEMORY;
670 *credp = strdup(ldap_state->bind_secret);
673 return LDAP_NO_MEMORY;
675 *methodp = LDAP_AUTH_SIMPLE;
678 gettimeofday(&(ldap_state->last_rebind),NULL);
682 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
684 /*******************************************************************
685 a rebind function for authenticated referrals
686 This version takes a void* that we can shove useful stuff in :-)
687 and actually does the connection.
688 ******************************************************************/
689 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
690 static int rebindproc_connect_with_state (LDAP *ldap_struct,
691 LDAP_CONST char *url,
693 ber_int_t msgid, void *arg)
695 struct smbldap_state *ldap_state = arg;
697 DEBUG(5,("rebindproc_connect_with_state: Rebinding as \"%s\"\n",
698 ldap_state->bind_dn));
700 /** @TODO Should we be doing something to check what servers we rebind to?
701 Could we get a referral to a machine that we don't want to give our
702 username and password to? */
704 rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
706 gettimeofday(&(ldap_state->last_rebind),NULL);
710 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
712 /*******************************************************************
713 Add a rebind function for authenticated referrals
714 ******************************************************************/
715 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
717 # if LDAP_SET_REBIND_PROC_ARGS == 2
718 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
719 int *method, int freeit )
721 struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
723 return rebindproc_with_state(ldap_struct, whop, credp,
724 method, freeit, ldap_state);
727 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
728 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
730 /*******************************************************************
731 a rebind function for authenticated referrals
732 this also does the connection, but no void*.
733 ******************************************************************/
734 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
735 # if LDAP_SET_REBIND_PROC_ARGS == 2
736 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
739 struct smbldap_state *ldap_state = smbldap_find_state(ld);
741 return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid,
744 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
745 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
747 /*******************************************************************
748 connect to the ldap server under system privilege.
749 ******************************************************************/
750 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
756 /* get the password */
757 if (!fetch_ldap_pw(&ldap_dn, &ldap_secret))
759 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
760 return LDAP_INVALID_CREDENTIALS;
763 ldap_state->bind_dn = ldap_dn;
764 ldap_state->bind_secret = ldap_secret;
766 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
767 (OpenLDAP) doesnt' seem to support it */
769 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
770 ldap_state->uri, ldap_dn));
772 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
773 # if LDAP_SET_REBIND_PROC_ARGS == 2
774 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect);
776 # if LDAP_SET_REBIND_PROC_ARGS == 3
777 ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);
779 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
780 # if LDAP_SET_REBIND_PROC_ARGS == 2
781 ldap_set_rebind_proc(ldap_struct, &rebindproc);
783 # if LDAP_SET_REBIND_PROC_ARGS == 3
784 ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);
786 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
788 rc = ldap_simple_bind_s(ldap_struct, ldap_dn, ldap_secret);
790 if (rc != LDAP_SUCCESS) {
791 char *ld_error = NULL;
792 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
794 DEBUG(ldap_state->num_failures ? 2 : 0,
795 ("failed to bind to server with dn= %s Error: %s\n\t%s\n",
796 ldap_dn ? ldap_dn : "(unknown)", ldap_err2string(rc),
797 ld_error ? ld_error : "(unknown)"));
799 ldap_state->num_failures++;
803 ldap_state->num_failures = 0;
805 DEBUG(3, ("ldap_connect_system: succesful connection to the LDAP server\n"));
809 /**********************************************************************
810 Connect to LDAP server (called before every ldap operation)
811 *********************************************************************/
812 static int smbldap_open(struct smbldap_state *ldap_state)
815 SMB_ASSERT(ldap_state);
817 #ifndef NO_LDAP_SECURITY
818 if (geteuid() != 0) {
819 DEBUG(0, ("smbldap_open: cannot access LDAP when not root..\n"));
820 return LDAP_INSUFFICIENT_ACCESS;
824 if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
825 struct sockaddr_un addr;
826 socklen_t len = sizeof(addr);
828 if (ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd) == 0 &&
829 getpeername(sd, (struct sockaddr *) &addr, &len) < 0) {
830 /* the other end has died. reopen. */
831 ldap_unbind_ext(ldap_state->ldap_struct, NULL, NULL);
832 ldap_state->ldap_struct = NULL;
833 ldap_state->last_ping = (time_t)0;
835 ldap_state->last_ping = time(NULL);
839 if (ldap_state->ldap_struct != NULL) {
840 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
844 if ((rc = smbldap_open_connection(ldap_state))) {
848 if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
849 ldap_unbind_ext(ldap_state->ldap_struct, NULL, NULL);
850 ldap_state->ldap_struct = NULL;
855 ldap_state->last_ping = time(NULL);
856 DEBUG(4,("The LDAP server is succesful connected\n"));
861 /**********************************************************************
862 Disconnect from LDAP server
863 *********************************************************************/
864 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
867 return NT_STATUS_INVALID_PARAMETER;
869 if (ldap_state->ldap_struct != NULL) {
870 ldap_unbind_ext(ldap_state->ldap_struct, NULL, NULL);
871 ldap_state->ldap_struct = NULL;
874 smbldap_delete_state(ldap_state);
876 DEBUG(5,("The connection to the LDAP server was closed\n"));
877 /* maybe free the results here --metze */
884 int smbldap_retry_open(struct smbldap_state *ldap_state, int *attempts)
888 SMB_ASSERT(ldap_state && attempts);
890 if (*attempts != 0) {
891 unsigned int sleep_time;
894 /* Sleep for a random timeout */
895 rand_byte = (char)(sys_random());
897 sleep_time = (((*attempts)*(*attempts))/2)*rand_byte*2;
898 /* we retry after (0.5, 1, 2, 3, 4.5, 6) seconds
901 DEBUG(3, ("Sleeping for %u milliseconds before reconnecting\n",
903 smb_msleep(sleep_time);
907 if ((rc = smbldap_open(ldap_state))) {
908 DEBUG(1,("Connection to LDAP Server failed for the %d try!\n",*attempts));
916 /*********************************************************************
917 ********************************************************************/
919 int smbldap_search(struct smbldap_state *ldap_state,
920 const char *base, int scope, const char *filter,
921 char *attrs[], int attrsonly,
924 int rc = LDAP_SERVER_DOWN;
928 SMB_ASSERT(ldap_state);
930 DEBUG(5,("smbldap_search: base => [%s], filter => [%s], scope => [%d]\n",
931 base, filter, scope));
933 if (ldap_state->last_rebind.tv_sec > 0) {
940 gettimeofday(&tval,NULL);
942 tdiff = 1000000 *(tval.tv_sec - ldap_state->last_rebind.tv_sec) +
943 (tval.tv_usec - ldap_state->last_rebind.tv_usec);
945 sleep_time = ((1000*lp_ldap_replication_sleep())-tdiff)/1000;
947 if (sleep_time > 0) {
948 /* we wait for the LDAP replication */
949 DEBUG(5,("smbldap_search: waiting %d milliseconds for LDAP replication.\n",sleep_time));
950 smb_msleep(sleep_time);
951 DEBUG(5,("smbldap_search: go on!\n"));
952 ZERO_STRUCT(ldap_state->last_rebind);
956 if (push_utf8_allocate(&utf8_filter, filter) == (size_t)-1) {
957 return LDAP_NO_MEMORY;
960 while ((rc == LDAP_SERVER_DOWN) && (attempts < SMBLDAP_NUM_RETRIES)) {
962 if ((rc = smbldap_retry_open(ldap_state,&attempts)) != LDAP_SUCCESS)
965 rc = ldap_search_s(ldap_state->ldap_struct, base, scope,
966 utf8_filter, attrs, attrsonly, res);
969 if (rc == LDAP_SERVER_DOWN) {
970 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO));
971 smbldap_close(ldap_state);
974 ldap_state->last_use = time(NULL);
976 SAFE_FREE(utf8_filter);
980 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
982 int rc = LDAP_SERVER_DOWN;
986 SMB_ASSERT(ldap_state);
988 DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
990 if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
991 return LDAP_NO_MEMORY;
994 while ((rc == LDAP_SERVER_DOWN) && (attempts < SMBLDAP_NUM_RETRIES)) {
996 if ((rc = smbldap_retry_open(ldap_state,&attempts)) != LDAP_SUCCESS)
999 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1002 if (rc == LDAP_SERVER_DOWN) {
1003 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO));
1004 smbldap_close(ldap_state);
1007 ldap_state->last_use = time(NULL);
1013 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1015 int rc = LDAP_SERVER_DOWN;
1019 SMB_ASSERT(ldap_state);
1021 DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1023 if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1024 return LDAP_NO_MEMORY;
1027 while ((rc == LDAP_SERVER_DOWN) && (attempts < SMBLDAP_NUM_RETRIES)) {
1029 if ((rc = smbldap_retry_open(ldap_state,&attempts)) != LDAP_SUCCESS)
1032 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1035 if (rc == LDAP_SERVER_DOWN) {
1036 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO));
1037 smbldap_close(ldap_state);
1040 ldap_state->last_use = time(NULL);
1046 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1048 int rc = LDAP_SERVER_DOWN;
1052 SMB_ASSERT(ldap_state);
1054 DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1056 if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1057 return LDAP_NO_MEMORY;
1060 while ((rc == LDAP_SERVER_DOWN) && (attempts < SMBLDAP_NUM_RETRIES)) {
1062 if ((rc = smbldap_retry_open(ldap_state,&attempts)) != LDAP_SUCCESS)
1065 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1068 if (rc == LDAP_SERVER_DOWN) {
1069 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO));
1070 smbldap_close(ldap_state);
1073 ldap_state->last_use = time(NULL);
1079 int smbldap_extended_operation(struct smbldap_state *ldap_state,
1080 LDAP_CONST char *reqoid, struct berval *reqdata,
1081 LDAPControl **serverctrls, LDAPControl **clientctrls,
1082 char **retoidp, struct berval **retdatap)
1084 int rc = LDAP_SERVER_DOWN;
1090 while ((rc == LDAP_SERVER_DOWN) && (attempts < SMBLDAP_NUM_RETRIES)) {
1092 if ((rc = smbldap_retry_open(ldap_state,&attempts)) != LDAP_SUCCESS)
1095 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid, reqdata,
1096 serverctrls, clientctrls, retoidp, retdatap);
1099 if (rc == LDAP_SERVER_DOWN) {
1100 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO));
1101 smbldap_close(ldap_state);
1104 ldap_state->last_use = time(NULL);
1109 /*******************************************************************
1110 run the search by name.
1111 ******************************************************************/
1112 int smbldap_search_suffix (struct smbldap_state *ldap_state, const char *filter,
1113 char **search_attr, LDAPMessage ** result)
1115 int scope = LDAP_SCOPE_SUBTREE;
1118 rc = smbldap_search(ldap_state, lp_ldap_suffix(), scope, filter, search_attr, 0, result);
1120 if (rc != LDAP_SUCCESS) {
1121 char *ld_error = NULL;
1122 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
1124 DEBUG(0,("smbldap_search_suffix: Problem during the LDAP search: %s (%s)\n",
1125 ld_error?ld_error:"(unknown)", ldap_err2string (rc)));
1126 SAFE_FREE(ld_error);
1132 static void smbldap_idle_fn(void **data, time_t *interval, time_t now)
1134 struct smbldap_state *state = (struct smbldap_state *)(*data);
1136 if (state->ldap_struct == NULL) {
1137 DEBUG(10,("ldap connection not connected...\n"));
1141 if ((state->last_use+SMBLDAP_IDLE_TIME) > now) {
1142 DEBUG(10,("ldap connection not idle...\n"));
1146 DEBUG(7,("ldap connection idle...closing connection\n"));
1147 smbldap_close(state);
1150 /**********************************************************************
1152 *********************************************************************/
1154 void smbldap_free_struct(struct smbldap_state **ldap_state)
1156 smbldap_close(*ldap_state);
1158 if ((*ldap_state)->bind_secret) {
1159 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1162 SAFE_FREE((*ldap_state)->bind_dn);
1163 SAFE_FREE((*ldap_state)->bind_secret);
1165 smb_unregister_idle_event((*ldap_state)->event_id);
1169 /* No need to free any further, as it is talloc()ed */
1173 /**********************************************************************
1174 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1175 *********************************************************************/
1177 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, const char *location, struct smbldap_state **smbldap_state)
1179 *smbldap_state = talloc_zero(mem_ctx, sizeof(**smbldap_state));
1180 if (!*smbldap_state) {
1181 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1182 return NT_STATUS_NO_MEMORY;
1186 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1188 (*smbldap_state)->uri = "ldap://localhost";
1191 (*smbldap_state)->event_id =
1192 smb_register_idle_event(smbldap_idle_fn, (void *)(*smbldap_state),
1195 if ((*smbldap_state)->event_id == SMB_EVENT_ID_INVALID) {
1196 DEBUG(0,("Failed to register LDAP idle event!\n"));
1197 return NT_STATUS_INVALID_HANDLE;
1200 return NT_STATUS_OK;
1203 /**********************************************************************
1204 Add the sambaDomain to LDAP, so we don't have to search for this stuff
1205 again. This is a once-add operation for now.
1207 TODO: Add other attributes, and allow modification.
1208 *********************************************************************/
1209 static NTSTATUS add_new_domain_info(struct smbldap_state *ldap_state,
1210 const char *domain_name)
1213 fstring algorithmic_rid_base_string;
1215 LDAPMod **mods = NULL;
1218 LDAPMessage *result = NULL;
1221 uid_t u_low, u_high;
1222 gid_t g_low, g_high;
1223 uint32 rid_low, rid_high;
1225 slprintf (filter, sizeof (filter) - 1, "(&(%s=%s)(objectclass=%s))",
1226 get_attr_key2string(dominfo_attr_list, LDAP_ATTR_DOMAIN),
1227 domain_name, LDAP_OBJ_DOMINFO);
1229 attr_list = get_attr_list( dominfo_attr_list );
1230 rc = smbldap_search_suffix(ldap_state, filter, attr_list, &result);
1231 free_attr_list( attr_list );
1233 if (rc != LDAP_SUCCESS) {
1234 return NT_STATUS_UNSUCCESSFUL;
1237 num_result = ldap_count_entries(ldap_state->ldap_struct, result);
1239 if (num_result > 1) {
1240 DEBUG (0, ("More than domain with that name exists: bailing out!\n"));
1241 ldap_msgfree(result);
1242 return NT_STATUS_UNSUCCESSFUL;
1245 /* Check if we need to add an entry */
1246 DEBUG(3,("Adding new domain\n"));
1247 ldap_op = LDAP_MOD_ADD;
1249 pstr_sprintf(dn, "%s=%s,%s", get_attr_key2string(dominfo_attr_list, LDAP_ATTR_DOMAIN),
1250 domain_name, lp_ldap_suffix());
1252 /* Free original search */
1253 ldap_msgfree(result);
1255 /* make the changes - the entry *must* not already have samba attributes */
1256 smbldap_set_mod(&mods, LDAP_MOD_ADD, get_attr_key2string(dominfo_attr_list, LDAP_ATTR_DOMAIN),
1259 /* If we don't have an entry, then ask secrets.tdb for what it thinks.
1260 It may choose to make it up */
1262 sid_to_string(sid_string, get_global_sam_sid());
1263 smbldap_set_mod(&mods, LDAP_MOD_ADD, get_attr_key2string(dominfo_attr_list, LDAP_ATTR_DOM_SID), sid_string);
1265 slprintf(algorithmic_rid_base_string, sizeof(algorithmic_rid_base_string) - 1, "%i", algorithmic_rid_base());
1266 smbldap_set_mod(&mods, LDAP_MOD_ADD, get_attr_key2string(dominfo_attr_list, LDAP_ATTR_ALGORITHMIC_RID_BASE),
1267 algorithmic_rid_base_string);
1268 smbldap_set_mod(&mods, LDAP_MOD_ADD, "objectclass", LDAP_OBJ_DOMINFO);
1270 /* add the sambaNext[User|Group]Rid attributes if the idmap ranges are set.
1271 TODO: fix all the places where the line between idmap and normal operations
1272 needed by smbd gets fuzzy --jerry 2003-08-11 */
1274 if ( lp_idmap_uid(&u_low, &u_high) && lp_idmap_gid(&g_low, &g_high)
1275 && get_free_rid_range(&rid_low, &rid_high) )
1279 fstr_sprintf( rid_str, "%i", rid_high|USER_RID_TYPE );
1280 DEBUG(10,("setting next available user rid [%s]\n", rid_str));
1281 smbldap_set_mod(&mods, LDAP_MOD_ADD,
1282 get_attr_key2string(dominfo_attr_list, LDAP_ATTR_NEXT_USERRID),
1285 fstr_sprintf( rid_str, "%i", rid_high|GROUP_RID_TYPE );
1286 DEBUG(10,("setting next available group rid [%s]\n", rid_str));
1287 smbldap_set_mod(&mods, LDAP_MOD_ADD,
1288 get_attr_key2string(dominfo_attr_list, LDAP_ATTR_NEXT_GROUPRID),
1297 rc = smbldap_add(ldap_state, dn, mods);
1299 case LDAP_MOD_REPLACE:
1300 rc = smbldap_modify(ldap_state, dn, mods);
1303 DEBUG(0,("Wrong LDAP operation type: %d!\n", ldap_op));
1304 return NT_STATUS_INVALID_PARAMETER;
1307 if (rc!=LDAP_SUCCESS) {
1308 char *ld_error = NULL;
1309 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING, &ld_error);
1310 DEBUG(1,("failed to %s domain dn= %s with: %s\n\t%s\n",
1311 ldap_op == LDAP_MOD_ADD ? "add" : "modify",
1312 dn, ldap_err2string(rc),
1313 ld_error?ld_error:"unknown"));
1314 SAFE_FREE(ld_error);
1316 ldap_mods_free(mods, True);
1317 return NT_STATUS_UNSUCCESSFUL;
1320 DEBUG(2,("added: domain = %s in the LDAP database\n", domain_name));
1321 ldap_mods_free(mods, True);
1322 return NT_STATUS_OK;
1325 /**********************************************************************
1326 Search for the domain info entry
1327 *********************************************************************/
1328 NTSTATUS smbldap_search_domain_info(struct smbldap_state *ldap_state,
1329 LDAPMessage ** result, const char *domain_name,
1332 NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
1338 pstr_sprintf(filter, "(&(objectClass=%s)(%s=%s))",
1340 get_attr_key2string(dominfo_attr_list, LDAP_ATTR_DOMAIN),
1343 DEBUG(2, ("Searching for:[%s]\n", filter));
1346 attr_list = get_attr_list( dominfo_attr_list );
1347 rc = smbldap_search_suffix(ldap_state, filter, attr_list , result);
1348 free_attr_list( attr_list );
1350 if (rc != LDAP_SUCCESS) {
1351 DEBUG(2,("Problem during LDAPsearch: %s\n", ldap_err2string (rc)));
1352 DEBUG(2,("Query was: %s, %s\n", lp_ldap_suffix(), filter));
1353 } else if (ldap_count_entries(ldap_state->ldap_struct, *result) < 1) {
1354 DEBUG(3, ("Got no domain info entries for domain\n"));
1355 ldap_msgfree(*result);
1357 if (try_add && NT_STATUS_IS_OK(ret = add_new_domain_info(ldap_state, domain_name))) {
1358 return smbldap_search_domain_info(ldap_state, result, domain_name, False);
1361 DEBUG(0, ("Adding domain info for %s failed with %s\n",
1362 domain_name, nt_errstr(ret)));
1365 } else if ((count = ldap_count_entries(ldap_state->ldap_struct, *result)) > 1) {
1366 DEBUG(0, ("Got too many (%d) domain info entries for domain %s\n",
1367 count, domain_name));
1368 ldap_msgfree(*result);
1372 return NT_STATUS_OK;
1378 /*******************************************************************
1379 Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1380 ********************************************************************/
1382 char *smbldap_get_dn(LDAP *ld, LDAPMessage *entry)
1384 char *utf8_dn, *unix_dn;
1386 utf8_dn = ldap_get_dn(ld, entry);
1388 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1391 if (pull_utf8_allocate(&unix_dn, utf8_dn) == (size_t)-1) {
1392 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 [%s]\n", utf8_dn));
1395 ldap_memfree(utf8_dn);