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_LIST_END
, NULL
}
104 /* attributes used for alalocating RIDs */
106 ATTRIB_MAP_ENTRY dominfo_attr_list
[] = {
107 { LDAP_ATTR_DOMAIN
, "sambaDomainName" },
108 { LDAP_ATTR_NEXT_RID
, "sambaNextRid" },
109 { LDAP_ATTR_NEXT_USERRID
, "sambaNextUserRid" },
110 { LDAP_ATTR_NEXT_GROUPRID
, "sambaNextGroupRid" },
111 { LDAP_ATTR_DOM_SID
, LDAP_ATTRIBUTE_SID
},
112 { LDAP_ATTR_ALGORITHMIC_RID_BASE
,"sambaAlgorithmicRidBase"},
113 { LDAP_ATTR_OBJCLASS
, "objectClass" },
114 { LDAP_ATTR_LIST_END
, NULL
},
117 /* Samba 3.0 group mapping attributes */
119 ATTRIB_MAP_ENTRY groupmap_attr_list
[] = {
120 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
121 { LDAP_ATTR_GROUP_SID
, LDAP_ATTRIBUTE_SID
},
122 { LDAP_ATTR_GROUP_TYPE
, "sambaGroupType" },
123 { LDAP_ATTR_DESC
, "description" },
124 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
125 { LDAP_ATTR_CN
, "cn" },
126 { LDAP_ATTR_OBJCLASS
, "objectClass" },
127 { LDAP_ATTR_LIST_END
, NULL
}
130 ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete
[] = {
131 { LDAP_ATTR_GROUP_SID
, LDAP_ATTRIBUTE_SID
},
132 { LDAP_ATTR_GROUP_TYPE
, "sambaGroupType" },
133 { LDAP_ATTR_DESC
, "description" },
134 { LDAP_ATTR_DISPLAY_NAME
, "displayName" },
135 { LDAP_ATTR_LIST_END
, NULL
}
138 /* idmap_ldap sambaUnixIdPool */
140 ATTRIB_MAP_ENTRY idpool_attr_list
[] = {
141 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
142 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
143 { LDAP_ATTR_OBJCLASS
, "objectClass" },
144 { LDAP_ATTR_LIST_END
, NULL
}
147 ATTRIB_MAP_ENTRY sidmap_attr_list
[] = {
148 { LDAP_ATTR_SID
, LDAP_ATTRIBUTE_SID
},
149 { LDAP_ATTR_UIDNUMBER
, LDAP_ATTRIBUTE_UIDNUMBER
},
150 { LDAP_ATTR_GIDNUMBER
, LDAP_ATTRIBUTE_GIDNUMBER
},
151 { LDAP_ATTR_OBJCLASS
, "objectClass" },
152 { LDAP_ATTR_LIST_END
, NULL
}
155 /**********************************************************************
156 perform a simple table lookup and return the attribute name
157 **********************************************************************/
159 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table
[], int key
)
163 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
) {
164 if ( table
[i
].attrib
== key
)
165 return table
[i
].name
;
173 /**********************************************************************
174 Return the list of attribute names from a mapping table
175 **********************************************************************/
177 char** get_attr_list( ATTRIB_MAP_ENTRY table
[] )
182 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
)
186 names
= (char**)malloc( sizeof(char*)*i
);
188 DEBUG(0,("get_attr_list: out of memory\n"));
193 while ( table
[i
].attrib
!= LDAP_ATTR_LIST_END
) {
194 names
[i
] = strdup( table
[i
].name
);
202 /*********************************************************************
204 ********************************************************************/
206 void free_attr_list( char **list
)
214 SAFE_FREE( list
[i
] );
221 /*******************************************************************
222 find the ldap password
223 ******************************************************************/
224 BOOL
fetch_ldap_pw(char **dn
, char** pw
)
229 *dn
= smb_xstrdup(lp_ldap_admin_dn());
231 if (asprintf(&key
, "%s/%s", SECRETS_LDAP_BIND_PW
, *dn
) < 0) {
233 DEBUG(0, ("fetch_ldap_pw: asprintf failed!\n"));
236 *pw
=secrets_fetch(key
, &size
);
240 /* Upgrade 2.2 style entry */
242 char* old_style_key
= strdup(*dn
);
244 fstring old_style_pw
;
246 if (!old_style_key
) {
247 DEBUG(0, ("fetch_ldap_pw: strdup failed!\n"));
251 for (p
=old_style_key
; *p
; p
++)
252 if (*p
== ',') *p
= '/';
254 data
=secrets_fetch(old_style_key
, &size
);
255 if (!size
&& size
< sizeof(old_style_pw
)) {
256 DEBUG(0,("fetch_ldap_pw: neither ldap secret retrieved!\n"));
257 SAFE_FREE(old_style_key
);
262 size
= MIN(size
, sizeof(fstring
)-1);
263 strncpy(old_style_pw
, data
, size
);
264 old_style_pw
[size
] = 0;
268 if (!secrets_store_ldap_pw(*dn
, old_style_pw
)) {
269 DEBUG(0,("fetch_ldap_pw: ldap secret could not be upgraded!\n"));
270 SAFE_FREE(old_style_key
);
274 if (!secrets_delete(old_style_key
)) {
275 DEBUG(0,("fetch_ldap_pw: old ldap secret could not be deleted!\n"));
278 SAFE_FREE(old_style_key
);
280 *pw
= smb_xstrdup(old_style_pw
);
286 /*******************************************************************
287 Search an attribute and return the first value found.
288 ******************************************************************/
290 BOOL
smbldap_get_single_attribute (LDAP
* ldap_struct
, LDAPMessage
* entry
,
291 const char *attribute
, pstring value
)
300 if ((values
= ldap_get_values (ldap_struct
, entry
, attribute
)) == NULL
) {
301 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute
));
306 if (convert_string(CH_UTF8
, CH_UNIX
,values
[0], -1, value
, sizeof(pstring
)) == (size_t)-1) {
307 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n",
308 attribute
, values
[0]));
309 ldap_value_free(values
);
313 ldap_value_free(values
);
314 #ifdef DEBUG_PASSWORDS
315 DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute
, value
));
320 /************************************************************************
321 Routine to manage the LDAPMod structure array
322 manage memory used by the array, by each struct, and values
323 ***********************************************************************/
325 void smbldap_set_mod (LDAPMod
*** modlist
, int modop
, const char *attribute
, const char *value
)
333 /* sanity checks on the mod values */
335 if (attribute
== NULL
|| *attribute
== '\0')
337 #if 0 /* commented out after discussion with abartlet. Do not reenable.
338 left here so other so re-add similar code --jerry */
339 if (value
== NULL
|| *value
== '\0')
345 mods
= (LDAPMod
**) malloc(sizeof(LDAPMod
*));
348 DEBUG(0, ("make_a_mod: out of memory!\n"));
354 for (i
= 0; mods
[i
] != NULL
; ++i
) {
355 if (mods
[i
]->mod_op
== modop
&& strequal(mods
[i
]->mod_type
, attribute
))
361 mods
= (LDAPMod
**) Realloc (mods
, (i
+ 2) * sizeof (LDAPMod
*));
364 DEBUG(0, ("make_a_mod: out of memory!\n"));
367 mods
[i
] = (LDAPMod
*) malloc(sizeof(LDAPMod
));
370 DEBUG(0, ("make_a_mod: out of memory!\n"));
373 mods
[i
]->mod_op
= modop
;
374 mods
[i
]->mod_values
= NULL
;
375 mods
[i
]->mod_type
= strdup(attribute
);
381 char *utf8_value
= NULL
;
384 if (mods
[i
]->mod_values
!= NULL
) {
385 for (; mods
[i
]->mod_values
[j
] != NULL
; j
++);
387 mods
[i
]->mod_values
= (char **)Realloc(mods
[i
]->mod_values
,
388 (j
+ 2) * sizeof (char *));
390 if (mods
[i
]->mod_values
== NULL
) {
391 DEBUG (0, ("make_a_mod: Memory allocation failure!\n"));
395 if (push_utf8_allocate(&utf8_value
, value
) == (size_t)-1) {
396 DEBUG (0, ("make_a_mod: String conversion failure!\n"));
400 mods
[i
]->mod_values
[j
] = utf8_value
;
402 mods
[i
]->mod_values
[j
+ 1] = NULL
;
407 /**********************************************************************
408 Set attribute to newval in LDAP, regardless of what value the
409 attribute had in LDAP before.
410 *********************************************************************/
412 void smbldap_make_mod(LDAP
*ldap_struct
, LDAPMessage
*existing
,
414 const char *attribute
, const char *newval
)
419 if (existing
!= NULL
) {
420 existed
= smbldap_get_single_attribute(ldap_struct
, existing
, attribute
, oldval
);
426 /* all of our string attributes are case insensitive */
428 if (existed
&& (StrCaseCmp(oldval
, newval
) == 0)) {
430 /* Believe it or not, but LDAP will deny a delete and
431 an add at the same time if the values are the
436 /* Regardless of the real operation (add or modify)
437 we add the new value here. We rely on deleting
438 the old value, should it exist. */
440 if ((newval
!= NULL
) && (strlen(newval
) > 0)) {
441 smbldap_set_mod(mods
, LDAP_MOD_ADD
, attribute
, newval
);
445 /* There has been no value before, so don't delete it.
446 Here's a possible race: We might end up with
447 duplicate attributes */
451 /* By deleting exactly the value we found in the entry this
452 should be race-free in the sense that the LDAP-Server will
453 deny the complete operation if somebody changed the
454 attribute behind our back. */
456 smbldap_set_mod(mods
, LDAP_MOD_DELETE
, attribute
, oldval
);
459 /**********************************************************************
460 Some varients of the LDAP rebind code do not pass in the third 'arg'
461 pointer to a void*, so we try and work around it by assuming that the
462 value of the 'LDAP *' pointer is the same as the one we had passed in
463 **********************************************************************/
465 struct smbldap_state_lookup
{
467 struct smbldap_state
*smbldap_state
;
468 struct smbldap_state_lookup
*prev
, *next
;
471 static struct smbldap_state_lookup
*smbldap_state_lookup_list
;
473 static struct smbldap_state
*smbldap_find_state(LDAP
*ld
)
475 struct smbldap_state_lookup
*t
;
477 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
479 return t
->smbldap_state
;
485 static void smbldap_delete_state(struct smbldap_state
*smbldap_state
)
487 struct smbldap_state_lookup
*t
;
489 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
490 if (t
->smbldap_state
== smbldap_state
) {
491 DLIST_REMOVE(smbldap_state_lookup_list
, t
);
498 static void smbldap_store_state(LDAP
*ld
, struct smbldap_state
*smbldap_state
)
500 struct smbldap_state
*tmp_ldap_state
;
501 struct smbldap_state_lookup
*t
;
502 struct smbldap_state_lookup
*tmp
;
504 if ((tmp_ldap_state
= smbldap_find_state(ld
))) {
505 SMB_ASSERT(tmp_ldap_state
== smbldap_state
);
509 t
= smb_xmalloc(sizeof(*t
));
512 DLIST_ADD_END(smbldap_state_lookup_list
, t
, tmp
);
514 t
->smbldap_state
= smbldap_state
;
517 /*******************************************************************
518 open a connection to the ldap server.
519 ******************************************************************/
520 static int smbldap_open_connection (struct smbldap_state
*ldap_state
)
523 int rc
= LDAP_SUCCESS
;
525 BOOL ldap_v3
= False
;
526 LDAP
**ldap_struct
= &ldap_state
->ldap_struct
;
528 #ifdef HAVE_LDAP_INITIALIZE
529 DEBUG(10, ("smbldap_open_connection: %s\n", ldap_state
->uri
));
531 if ((rc
= ldap_initialize(ldap_struct
, ldap_state
->uri
)) != LDAP_SUCCESS
) {
532 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc
)));
537 /* Parse the string manually */
543 const char *p
= ldap_state
->uri
;
544 SMB_ASSERT(sizeof(protocol
)>10 && sizeof(host
)>254);
546 /* skip leading "URL:" (if any) */
547 if ( strnequal( p
, "URL:", 4 ) ) {
551 sscanf(p
, "%10[^:]://%254[^:/]:%d", protocol
, host
, &port
);
554 if (strequal(protocol
, "ldap")) {
556 } else if (strequal(protocol
, "ldaps")) {
559 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol
));
563 if ((*ldap_struct
= ldap_init(host
, port
)) == NULL
) {
564 DEBUG(0, ("ldap_init failed !\n"));
565 return LDAP_OPERATIONS_ERROR
;
568 if (strequal(protocol
, "ldaps")) {
569 #ifdef LDAP_OPT_X_TLS
570 int tls
= LDAP_OPT_X_TLS_HARD
;
571 if (ldap_set_option (*ldap_struct
, LDAP_OPT_X_TLS
, &tls
) != LDAP_SUCCESS
)
573 DEBUG(0, ("Failed to setup a TLS session\n"));
576 DEBUG(3,("LDAPS option set...!\n"));
578 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
579 return LDAP_OPERATIONS_ERROR
;
585 /* Store the LDAP pointer in a lookup list */
587 smbldap_store_state(*ldap_struct
, ldap_state
);
589 /* Upgrade to LDAPv3 if possible */
591 if (ldap_get_option(*ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
) == LDAP_OPT_SUCCESS
)
593 if (version
!= LDAP_VERSION3
)
595 version
= LDAP_VERSION3
;
596 if (ldap_set_option (*ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
) == LDAP_OPT_SUCCESS
) {
604 if (lp_ldap_ssl() == LDAP_SSL_START_TLS
) {
605 #ifdef LDAP_OPT_X_TLS
607 if ((rc
= ldap_start_tls_s (*ldap_struct
, NULL
, NULL
)) != LDAP_SUCCESS
)
609 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
610 ldap_err2string(rc
)));
613 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
616 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
617 return LDAP_OPERATIONS_ERROR
;
620 DEBUG(0,("smbldap_open_connection: StartTLS not supported by LDAP client libraries!\n"));
621 return LDAP_OPERATIONS_ERROR
;
625 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
630 /*******************************************************************
631 a rebind function for authenticated referrals
632 This version takes a void* that we can shove useful stuff in :-)
633 ******************************************************************/
634 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
636 static int rebindproc_with_state (LDAP
* ld
, char **whop
, char **credp
,
637 int *methodp
, int freeit
, void *arg
)
639 struct smbldap_state
*ldap_state
= arg
;
641 /** @TODO Should we be doing something to check what servers we rebind to?
642 Could we get a referral to a machine that we don't want to give our
643 username and password to? */
647 memset(*credp
, '\0', strlen(*credp
));
650 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
651 ldap_state
->bind_dn
));
653 *whop
= strdup(ldap_state
->bind_dn
);
655 return LDAP_NO_MEMORY
;
657 *credp
= strdup(ldap_state
->bind_secret
);
660 return LDAP_NO_MEMORY
;
662 *methodp
= LDAP_AUTH_SIMPLE
;
666 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
668 /*******************************************************************
669 a rebind function for authenticated referrals
670 This version takes a void* that we can shove useful stuff in :-)
671 and actually does the connection.
672 ******************************************************************/
673 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
674 static int rebindproc_connect_with_state (LDAP
*ldap_struct
,
675 LDAP_CONST
char *url
,
677 ber_int_t msgid
, void *arg
)
679 struct smbldap_state
*ldap_state
= arg
;
681 DEBUG(5,("rebindproc_connect_with_state: Rebinding as \"%s\"\n",
682 ldap_state
->bind_dn
));
684 /** @TODO Should we be doing something to check what servers we rebind to?
685 Could we get a referral to a machine that we don't want to give our
686 username and password to? */
688 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
692 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
694 /*******************************************************************
695 Add a rebind function for authenticated referrals
696 ******************************************************************/
697 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
699 # if LDAP_SET_REBIND_PROC_ARGS == 2
700 static int rebindproc (LDAP
*ldap_struct
, char **whop
, char **credp
,
701 int *method
, int freeit
)
703 struct smbldap_state
*ldap_state
= smbldap_find_state(ldap_struct
);
705 return rebindproc_with_state(ldap_struct
, whop
, credp
,
706 method
, freeit
, ldap_state
);
709 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
710 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
712 /*******************************************************************
713 a rebind function for authenticated referrals
714 this also does the connection, but no void*.
715 ******************************************************************/
716 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
717 # if LDAP_SET_REBIND_PROC_ARGS == 2
718 static int rebindproc_connect (LDAP
* ld
, LDAP_CONST
char *url
, int request
,
721 struct smbldap_state
*ldap_state
= smbldap_find_state(ld
);
723 return rebindproc_connect_with_state(ld
, url
, (ber_tag_t
)request
, msgid
,
726 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
727 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
729 /*******************************************************************
730 connect to the ldap server under system privilege.
731 ******************************************************************/
732 static int smbldap_connect_system(struct smbldap_state
*ldap_state
, LDAP
* ldap_struct
)
738 /* get the password */
739 if (!fetch_ldap_pw(&ldap_dn
, &ldap_secret
))
741 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
742 return LDAP_INVALID_CREDENTIALS
;
745 ldap_state
->bind_dn
= ldap_dn
;
746 ldap_state
->bind_secret
= ldap_secret
;
748 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
749 (OpenLDAP) doesnt' seem to support it */
751 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
752 ldap_state
->uri
, ldap_dn
));
754 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
755 # if LDAP_SET_REBIND_PROC_ARGS == 2
756 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect
);
758 # if LDAP_SET_REBIND_PROC_ARGS == 3
759 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect_with_state
, (void *)ldap_state
);
761 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
762 # if LDAP_SET_REBIND_PROC_ARGS == 2
763 ldap_set_rebind_proc(ldap_struct
, &rebindproc
);
765 # if LDAP_SET_REBIND_PROC_ARGS == 3
766 ldap_set_rebind_proc(ldap_struct
, &rebindproc_with_state
, (void *)ldap_state
);
768 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
770 rc
= ldap_simple_bind_s(ldap_struct
, ldap_dn
, ldap_secret
);
772 if (rc
!= LDAP_SUCCESS
) {
773 char *ld_error
= NULL
;
774 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_ERROR_STRING
,
776 DEBUG(ldap_state
->num_failures
? 2 : 0,
777 ("failed to bind to server with dn= %s Error: %s\n\t%s\n",
778 ldap_dn
? ldap_dn
: "(unknown)", ldap_err2string(rc
),
779 ld_error
? ld_error
: "(unknown)"));
781 ldap_state
->num_failures
++;
785 ldap_state
->num_failures
= 0;
787 DEBUG(3, ("ldap_connect_system: succesful connection to the LDAP server\n"));
791 /**********************************************************************
792 Connect to LDAP server (called before every ldap operation)
793 *********************************************************************/
794 static int smbldap_open(struct smbldap_state
*ldap_state
)
797 SMB_ASSERT(ldap_state
);
799 #ifndef NO_LDAP_SECURITY
800 if (geteuid() != 0) {
801 DEBUG(0, ("smbldap_open: cannot access LDAP when not root..\n"));
802 return LDAP_INSUFFICIENT_ACCESS
;
806 if ((ldap_state
->ldap_struct
!= NULL
) && ((ldap_state
->last_ping
+ SMBLDAP_DONT_PING_TIME
) < time(NULL
))) {
807 struct sockaddr_un addr
;
808 socklen_t len
= sizeof(addr
);
810 if (ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_DESC
, &sd
) == 0 &&
811 getpeername(sd
, (struct sockaddr
*) &addr
, &len
) < 0) {
812 /* the other end has died. reopen. */
813 ldap_unbind_ext(ldap_state
->ldap_struct
, NULL
, NULL
);
814 ldap_state
->ldap_struct
= NULL
;
815 ldap_state
->last_ping
= (time_t)0;
817 ldap_state
->last_ping
= time(NULL
);
821 if (ldap_state
->ldap_struct
!= NULL
) {
822 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
826 if ((rc
= smbldap_open_connection(ldap_state
))) {
830 if ((rc
= smbldap_connect_system(ldap_state
, ldap_state
->ldap_struct
))) {
831 ldap_unbind_ext(ldap_state
->ldap_struct
, NULL
, NULL
);
832 ldap_state
->ldap_struct
= NULL
;
837 ldap_state
->last_ping
= time(NULL
);
838 DEBUG(4,("The LDAP server is succesful connected\n"));
843 /**********************************************************************
844 Disconnect from LDAP server
845 *********************************************************************/
846 static NTSTATUS
smbldap_close(struct smbldap_state
*ldap_state
)
849 return NT_STATUS_INVALID_PARAMETER
;
851 if (ldap_state
->ldap_struct
!= NULL
) {
852 ldap_unbind_ext(ldap_state
->ldap_struct
, NULL
, NULL
);
853 ldap_state
->ldap_struct
= NULL
;
856 smbldap_delete_state(ldap_state
);
858 DEBUG(5,("The connection to the LDAP server was closed\n"));
859 /* maybe free the results here --metze */
866 int smbldap_retry_open(struct smbldap_state
*ldap_state
, int *attempts
)
870 SMB_ASSERT(ldap_state
&& attempts
);
872 if (*attempts
!= 0) {
873 unsigned int sleep_time
;
876 /* Sleep for a random timeout */
877 rand_byte
= (char)(sys_random());
879 sleep_time
= (((*attempts
)*(*attempts
))/2)*rand_byte
*2;
880 /* we retry after (0.5, 1, 2, 3, 4.5, 6) seconds
883 DEBUG(3, ("Sleeping for %u milliseconds before reconnecting\n",
889 if ((rc
= smbldap_open(ldap_state
))) {
890 DEBUG(1,("Connection to LDAP Server failed for the %d try!\n",*attempts
));
898 /*********************************************************************
899 ********************************************************************/
901 int smbldap_search(struct smbldap_state
*ldap_state
,
902 const char *base
, int scope
, const char *filter
,
903 char *attrs
[], int attrsonly
,
906 int rc
= LDAP_SERVER_DOWN
;
910 SMB_ASSERT(ldap_state
);
912 if (push_utf8_allocate(&utf8_filter
, filter
) == (size_t)-1) {
913 return LDAP_NO_MEMORY
;
916 while ((rc
== LDAP_SERVER_DOWN
) && (attempts
< SMBLDAP_NUM_RETRIES
)) {
918 if ((rc
= smbldap_retry_open(ldap_state
,&attempts
)) != LDAP_SUCCESS
)
921 rc
= ldap_search_s(ldap_state
->ldap_struct
, base
, scope
,
922 utf8_filter
, attrs
, attrsonly
, res
);
925 if (rc
== LDAP_SERVER_DOWN
) {
926 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO
));
927 smbldap_close(ldap_state
);
930 ldap_state
->last_use
= time(NULL
);
932 SAFE_FREE(utf8_filter
);
936 int smbldap_modify(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
938 int rc
= LDAP_SERVER_DOWN
;
942 SMB_ASSERT(ldap_state
);
944 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
945 return LDAP_NO_MEMORY
;
948 while ((rc
== LDAP_SERVER_DOWN
) && (attempts
< SMBLDAP_NUM_RETRIES
)) {
950 if ((rc
= smbldap_retry_open(ldap_state
,&attempts
)) != LDAP_SUCCESS
)
953 rc
= ldap_modify_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
956 if (rc
== LDAP_SERVER_DOWN
) {
957 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO
));
958 smbldap_close(ldap_state
);
961 ldap_state
->last_use
= time(NULL
);
967 int smbldap_add(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
969 int rc
= LDAP_SERVER_DOWN
;
973 SMB_ASSERT(ldap_state
);
975 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
976 return LDAP_NO_MEMORY
;
979 while ((rc
== LDAP_SERVER_DOWN
) && (attempts
< SMBLDAP_NUM_RETRIES
)) {
981 if ((rc
= smbldap_retry_open(ldap_state
,&attempts
)) != LDAP_SUCCESS
)
984 rc
= ldap_add_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
987 if (rc
== LDAP_SERVER_DOWN
) {
988 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO
));
989 smbldap_close(ldap_state
);
992 ldap_state
->last_use
= time(NULL
);
998 int smbldap_delete(struct smbldap_state
*ldap_state
, const char *dn
)
1000 int rc
= LDAP_SERVER_DOWN
;
1004 SMB_ASSERT(ldap_state
);
1006 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1007 return LDAP_NO_MEMORY
;
1010 while ((rc
== LDAP_SERVER_DOWN
) && (attempts
< SMBLDAP_NUM_RETRIES
)) {
1012 if ((rc
= smbldap_retry_open(ldap_state
,&attempts
)) != LDAP_SUCCESS
)
1015 rc
= ldap_delete_s(ldap_state
->ldap_struct
, utf8_dn
);
1018 if (rc
== LDAP_SERVER_DOWN
) {
1019 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO
));
1020 smbldap_close(ldap_state
);
1023 ldap_state
->last_use
= time(NULL
);
1029 int smbldap_extended_operation(struct smbldap_state
*ldap_state
,
1030 LDAP_CONST
char *reqoid
, struct berval
*reqdata
,
1031 LDAPControl
**serverctrls
, LDAPControl
**clientctrls
,
1032 char **retoidp
, struct berval
**retdatap
)
1034 int rc
= LDAP_SERVER_DOWN
;
1040 while ((rc
== LDAP_SERVER_DOWN
) && (attempts
< SMBLDAP_NUM_RETRIES
)) {
1042 if ((rc
= smbldap_retry_open(ldap_state
,&attempts
)) != LDAP_SUCCESS
)
1045 rc
= ldap_extended_operation_s(ldap_state
->ldap_struct
, reqoid
, reqdata
,
1046 serverctrls
, clientctrls
, retoidp
, retdatap
);
1049 if (rc
== LDAP_SERVER_DOWN
) {
1050 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO
));
1051 smbldap_close(ldap_state
);
1054 ldap_state
->last_use
= time(NULL
);
1059 /*******************************************************************
1060 run the search by name.
1061 ******************************************************************/
1062 int smbldap_search_suffix (struct smbldap_state
*ldap_state
, const char *filter
,
1063 char **search_attr
, LDAPMessage
** result
)
1065 int scope
= LDAP_SCOPE_SUBTREE
;
1068 DEBUG(2, ("smbldap_search_suffix: searching for:[%s]\n", filter
));
1070 rc
= smbldap_search(ldap_state
, lp_ldap_suffix(), scope
, filter
, search_attr
, 0, result
);
1072 if (rc
!= LDAP_SUCCESS
) {
1073 char *ld_error
= NULL
;
1074 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_ERROR_STRING
,
1076 DEBUG(0,("smbldap_search_suffix: Problem during the LDAP search: %s (%s)\n",
1077 ld_error
?ld_error
:"(unknown)", ldap_err2string (rc
)));
1078 DEBUG(3,("smbldap_search_suffix: Query was: %s, %s\n", lp_ldap_suffix(),
1080 SAFE_FREE(ld_error
);
1086 static void smbldap_idle_fn(void **data
, time_t *interval
, time_t now
)
1088 struct smbldap_state
*state
= (struct smbldap_state
*)(*data
);
1090 if (state
->ldap_struct
== NULL
) {
1091 DEBUG(10,("ldap connection not connected...\n"));
1095 if ((state
->last_use
+SMBLDAP_IDLE_TIME
) > now
) {
1096 DEBUG(10,("ldap connection not idle...\n"));
1100 DEBUG(7,("ldap connection idle...closing connection\n"));
1101 smbldap_close(state
);
1104 /**********************************************************************
1106 *********************************************************************/
1108 void smbldap_free_struct(struct smbldap_state
**ldap_state
)
1110 smbldap_close(*ldap_state
);
1112 if ((*ldap_state
)->bind_secret
) {
1113 memset((*ldap_state
)->bind_secret
, '\0', strlen((*ldap_state
)->bind_secret
));
1116 SAFE_FREE((*ldap_state
)->bind_dn
);
1117 SAFE_FREE((*ldap_state
)->bind_secret
);
1119 smb_unregister_idle_event((*ldap_state
)->event_id
);
1123 /* No need to free any further, as it is talloc()ed */
1127 /**********************************************************************
1128 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1129 *********************************************************************/
1131 NTSTATUS
smbldap_init(TALLOC_CTX
*mem_ctx
, const char *location
, struct smbldap_state
**smbldap_state
)
1133 *smbldap_state
= talloc_zero(mem_ctx
, sizeof(**smbldap_state
));
1134 if (!*smbldap_state
) {
1135 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1136 return NT_STATUS_NO_MEMORY
;
1140 (*smbldap_state
)->uri
= talloc_strdup(mem_ctx
, location
);
1142 (*smbldap_state
)->uri
= "ldap://localhost";
1145 (*smbldap_state
)->event_id
=
1146 smb_register_idle_event(smbldap_idle_fn
, (void *)(*smbldap_state
),
1149 if ((*smbldap_state
)->event_id
== SMB_EVENT_ID_INVALID
) {
1150 DEBUG(0,("Failed to register LDAP idle event!\n"));
1151 return NT_STATUS_INVALID_HANDLE
;
1154 return NT_STATUS_OK
;
1157 /**********************************************************************
1158 Add the sambaDomain to LDAP, so we don't have to search for this stuff
1159 again. This is a once-add operation for now.
1161 TODO: Add other attributes, and allow modification.
1162 *********************************************************************/
1163 static NTSTATUS
add_new_domain_info(struct smbldap_state
*ldap_state
,
1164 const char *domain_name
)
1167 fstring algorithmic_rid_base_string
;
1169 LDAPMod
**mods
= NULL
;
1172 LDAPMessage
*result
= NULL
;
1175 uid_t u_low
, u_high
;
1176 gid_t g_low
, g_high
;
1177 uint32 rid_low
, rid_high
;
1179 slprintf (filter
, sizeof (filter
) - 1, "(&(%s=%s)(objectclass=%s))",
1180 get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_DOMAIN
),
1181 domain_name
, LDAP_OBJ_DOMINFO
);
1183 attr_list
= get_attr_list( dominfo_attr_list
);
1184 rc
= smbldap_search_suffix(ldap_state
, filter
, attr_list
, &result
);
1185 free_attr_list( attr_list
);
1187 if (rc
!= LDAP_SUCCESS
) {
1188 return NT_STATUS_UNSUCCESSFUL
;
1191 num_result
= ldap_count_entries(ldap_state
->ldap_struct
, result
);
1193 if (num_result
> 1) {
1194 DEBUG (0, ("More than domain with that name exists: bailing out!\n"));
1195 ldap_msgfree(result
);
1196 return NT_STATUS_UNSUCCESSFUL
;
1199 /* Check if we need to add an entry */
1200 DEBUG(3,("Adding new domain\n"));
1201 ldap_op
= LDAP_MOD_ADD
;
1203 pstr_sprintf(dn
, "%s=%s,%s", get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_DOMAIN
),
1204 domain_name
, lp_ldap_suffix());
1206 /* Free original search */
1207 ldap_msgfree(result
);
1209 /* make the changes - the entry *must* not already have samba attributes */
1210 smbldap_set_mod(&mods
, LDAP_MOD_ADD
, get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_DOMAIN
),
1213 /* If we don't have an entry, then ask secrets.tdb for what it thinks.
1214 It may choose to make it up */
1216 sid_to_string(sid_string
, get_global_sam_sid());
1217 smbldap_set_mod(&mods
, LDAP_MOD_ADD
, get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_DOM_SID
), sid_string
);
1219 slprintf(algorithmic_rid_base_string
, sizeof(algorithmic_rid_base_string
) - 1, "%i", algorithmic_rid_base());
1220 smbldap_set_mod(&mods
, LDAP_MOD_ADD
, get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_ALGORITHMIC_RID_BASE
),
1221 algorithmic_rid_base_string
);
1222 smbldap_set_mod(&mods
, LDAP_MOD_ADD
, "objectclass", LDAP_OBJ_DOMINFO
);
1224 /* add the sambaNext[User|Group]Rid attributes if the idmap ranges are set.
1225 TODO: fix all the places where the line between idmap and normal operations
1226 needed by smbd gets fuzzy --jerry 2003-08-11 */
1228 if ( lp_idmap_uid(&u_low
, &u_high
) && lp_idmap_gid(&g_low
, &g_high
)
1229 && get_free_rid_range(&rid_low
, &rid_high
) )
1233 fstr_sprintf( rid_str
, "%i", rid_high
|USER_RID_TYPE
);
1234 DEBUG(10,("setting next available user rid [%s]\n", rid_str
));
1235 smbldap_set_mod(&mods
, LDAP_MOD_ADD
,
1236 get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_NEXT_USERRID
),
1239 fstr_sprintf( rid_str
, "%i", rid_high
|GROUP_RID_TYPE
);
1240 DEBUG(10,("setting next available group rid [%s]\n", rid_str
));
1241 smbldap_set_mod(&mods
, LDAP_MOD_ADD
,
1242 get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_NEXT_GROUPRID
),
1251 rc
= smbldap_add(ldap_state
, dn
, mods
);
1253 case LDAP_MOD_REPLACE
:
1254 rc
= smbldap_modify(ldap_state
, dn
, mods
);
1257 DEBUG(0,("Wrong LDAP operation type: %d!\n", ldap_op
));
1258 return NT_STATUS_INVALID_PARAMETER
;
1261 if (rc
!=LDAP_SUCCESS
) {
1262 char *ld_error
= NULL
;
1263 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_ERROR_STRING
, &ld_error
);
1264 DEBUG(1,("failed to %s domain dn= %s with: %s\n\t%s\n",
1265 ldap_op
== LDAP_MOD_ADD
? "add" : "modify",
1266 dn
, ldap_err2string(rc
),
1267 ld_error
?ld_error
:"unknown"));
1268 SAFE_FREE(ld_error
);
1270 ldap_mods_free(mods
, True
);
1271 return NT_STATUS_UNSUCCESSFUL
;
1274 DEBUG(2,("added: domain = %s in the LDAP database\n", domain_name
));
1275 ldap_mods_free(mods
, True
);
1276 return NT_STATUS_OK
;
1279 /**********************************************************************
1280 Search for the domain info entry
1281 *********************************************************************/
1282 NTSTATUS
smbldap_search_domain_info(struct smbldap_state
*ldap_state
,
1283 LDAPMessage
** result
, const char *domain_name
,
1286 NTSTATUS ret
= NT_STATUS_UNSUCCESSFUL
;
1292 pstr_sprintf(filter
, "(&(objectClass=%s)(%s=%s))",
1294 get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_DOMAIN
),
1297 DEBUG(2, ("Searching for:[%s]\n", filter
));
1300 attr_list
= get_attr_list( dominfo_attr_list
);
1301 rc
= smbldap_search_suffix(ldap_state
, filter
, attr_list
, result
);
1302 free_attr_list( attr_list
);
1304 if (rc
!= LDAP_SUCCESS
) {
1305 DEBUG(2,("Problem during LDAPsearch: %s\n", ldap_err2string (rc
)));
1306 DEBUG(2,("Query was: %s, %s\n", lp_ldap_suffix(), filter
));
1307 } else if (ldap_count_entries(ldap_state
->ldap_struct
, *result
) < 1) {
1308 DEBUG(3, ("Got no domain info entries for domain\n"));
1309 ldap_msgfree(*result
);
1311 if (try_add
&& NT_STATUS_IS_OK(ret
= add_new_domain_info(ldap_state
, domain_name
))) {
1312 return smbldap_search_domain_info(ldap_state
, result
, domain_name
, False
);
1315 DEBUG(0, ("Adding domain info for %s failed with %s\n",
1316 domain_name
, nt_errstr(ret
)));
1319 } else if ((count
= ldap_count_entries(ldap_state
->ldap_struct
, *result
)) > 1) {
1320 DEBUG(0, ("Got too many (%d) domain info entries for domain %s\n",
1321 count
, domain_name
));
1322 ldap_msgfree(*result
);
1326 return NT_STATUS_OK
;
1332 /*******************************************************************
1333 Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1334 ********************************************************************/
1336 char *smbldap_get_dn(LDAP
*ld
, LDAPMessage
*entry
)
1338 char *utf8_dn
, *unix_dn
;
1340 utf8_dn
= ldap_get_dn(ld
, entry
);
1342 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1345 if (pull_utf8_allocate((void **) &unix_dn
, utf8_dn
) == (size_t)-1) {
1346 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 [%s]\n", utf8_dn
));
1349 ldap_memfree(utf8_dn
);