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)) {
442 /* There has been no value before, so don't delete it.
443 * Here's a possible race: We might end up with
444 * duplicate attributes */
445 /* By deleting exactly the value we found in the entry this
446 * should be race-free in the sense that the LDAP-Server will
447 * deny the complete operation if somebody changed the
448 * attribute behind our back. */
449 /* This will also allow modifying single valued attributes
450 * in Novell NDS. In NDS you have to first remove attribute and then
451 * you could add new value */
453 smbldap_set_mod(mods
, LDAP_MOD_DELETE
, attribute
, oldval
);
456 smbldap_set_mod(mods
, LDAP_MOD_ADD
, attribute
, newval
);
460 /**********************************************************************
461 Some varients of the LDAP rebind code do not pass in the third 'arg'
462 pointer to a void*, so we try and work around it by assuming that the
463 value of the 'LDAP *' pointer is the same as the one we had passed in
464 **********************************************************************/
466 struct smbldap_state_lookup
{
468 struct smbldap_state
*smbldap_state
;
469 struct smbldap_state_lookup
*prev
, *next
;
472 static struct smbldap_state_lookup
*smbldap_state_lookup_list
;
474 static struct smbldap_state
*smbldap_find_state(LDAP
*ld
)
476 struct smbldap_state_lookup
*t
;
478 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
480 return t
->smbldap_state
;
486 static void smbldap_delete_state(struct smbldap_state
*smbldap_state
)
488 struct smbldap_state_lookup
*t
;
490 for (t
= smbldap_state_lookup_list
; t
; t
= t
->next
) {
491 if (t
->smbldap_state
== smbldap_state
) {
492 DLIST_REMOVE(smbldap_state_lookup_list
, t
);
499 static void smbldap_store_state(LDAP
*ld
, struct smbldap_state
*smbldap_state
)
501 struct smbldap_state
*tmp_ldap_state
;
502 struct smbldap_state_lookup
*t
;
503 struct smbldap_state_lookup
*tmp
;
505 if ((tmp_ldap_state
= smbldap_find_state(ld
))) {
506 SMB_ASSERT(tmp_ldap_state
== smbldap_state
);
510 t
= smb_xmalloc(sizeof(*t
));
513 DLIST_ADD_END(smbldap_state_lookup_list
, t
, tmp
);
515 t
->smbldap_state
= smbldap_state
;
518 /*******************************************************************
519 open a connection to the ldap server.
520 ******************************************************************/
521 static int smbldap_open_connection (struct smbldap_state
*ldap_state
)
524 int rc
= LDAP_SUCCESS
;
526 BOOL ldap_v3
= False
;
527 LDAP
**ldap_struct
= &ldap_state
->ldap_struct
;
529 #ifdef HAVE_LDAP_INITIALIZE
530 DEBUG(10, ("smbldap_open_connection: %s\n", ldap_state
->uri
));
532 if ((rc
= ldap_initialize(ldap_struct
, ldap_state
->uri
)) != LDAP_SUCCESS
) {
533 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc
)));
538 /* Parse the string manually */
544 const char *p
= ldap_state
->uri
;
545 SMB_ASSERT(sizeof(protocol
)>10 && sizeof(host
)>254);
547 /* skip leading "URL:" (if any) */
548 if ( strnequal( p
, "URL:", 4 ) ) {
552 sscanf(p
, "%10[^:]://%254[^:/]:%d", protocol
, host
, &port
);
555 if (strequal(protocol
, "ldap")) {
557 } else if (strequal(protocol
, "ldaps")) {
560 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol
));
564 if ((*ldap_struct
= ldap_init(host
, port
)) == NULL
) {
565 DEBUG(0, ("ldap_init failed !\n"));
566 return LDAP_OPERATIONS_ERROR
;
569 if (strequal(protocol
, "ldaps")) {
570 #ifdef LDAP_OPT_X_TLS
571 int tls
= LDAP_OPT_X_TLS_HARD
;
572 if (ldap_set_option (*ldap_struct
, LDAP_OPT_X_TLS
, &tls
) != LDAP_SUCCESS
)
574 DEBUG(0, ("Failed to setup a TLS session\n"));
577 DEBUG(3,("LDAPS option set...!\n"));
579 DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
580 return LDAP_OPERATIONS_ERROR
;
586 /* Store the LDAP pointer in a lookup list */
588 smbldap_store_state(*ldap_struct
, ldap_state
);
590 /* Upgrade to LDAPv3 if possible */
592 if (ldap_get_option(*ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
) == LDAP_OPT_SUCCESS
)
594 if (version
!= LDAP_VERSION3
)
596 version
= LDAP_VERSION3
;
597 if (ldap_set_option (*ldap_struct
, LDAP_OPT_PROTOCOL_VERSION
, &version
) == LDAP_OPT_SUCCESS
) {
605 if (lp_ldap_ssl() == LDAP_SSL_START_TLS
) {
606 #ifdef LDAP_OPT_X_TLS
608 if ((rc
= ldap_start_tls_s (*ldap_struct
, NULL
, NULL
)) != LDAP_SUCCESS
)
610 DEBUG(0,("Failed to issue the StartTLS instruction: %s\n",
611 ldap_err2string(rc
)));
614 DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
617 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
618 return LDAP_OPERATIONS_ERROR
;
621 DEBUG(0,("smbldap_open_connection: StartTLS not supported by LDAP client libraries!\n"));
622 return LDAP_OPERATIONS_ERROR
;
626 DEBUG(2, ("smbldap_open_connection: connection opened\n"));
631 /*******************************************************************
632 a rebind function for authenticated referrals
633 This version takes a void* that we can shove useful stuff in :-)
634 ******************************************************************/
635 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
637 static int rebindproc_with_state (LDAP
* ld
, char **whop
, char **credp
,
638 int *methodp
, int freeit
, void *arg
)
640 struct smbldap_state
*ldap_state
= arg
;
642 /** @TODO Should we be doing something to check what servers we rebind to?
643 Could we get a referral to a machine that we don't want to give our
644 username and password to? */
648 memset(*credp
, '\0', strlen(*credp
));
651 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n",
652 ldap_state
->bind_dn
));
654 *whop
= strdup(ldap_state
->bind_dn
);
656 return LDAP_NO_MEMORY
;
658 *credp
= strdup(ldap_state
->bind_secret
);
661 return LDAP_NO_MEMORY
;
663 *methodp
= LDAP_AUTH_SIMPLE
;
666 gettimeofday(&(ldap_state
->last_rebind
),NULL
);
670 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
672 /*******************************************************************
673 a rebind function for authenticated referrals
674 This version takes a void* that we can shove useful stuff in :-)
675 and actually does the connection.
676 ******************************************************************/
677 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
678 static int rebindproc_connect_with_state (LDAP
*ldap_struct
,
679 LDAP_CONST
char *url
,
681 ber_int_t msgid
, void *arg
)
683 struct smbldap_state
*ldap_state
= arg
;
685 DEBUG(5,("rebindproc_connect_with_state: Rebinding as \"%s\"\n",
686 ldap_state
->bind_dn
));
688 /** @TODO Should we be doing something to check what servers we rebind to?
689 Could we get a referral to a machine that we don't want to give our
690 username and password to? */
692 rc
= ldap_simple_bind_s(ldap_struct
, ldap_state
->bind_dn
, ldap_state
->bind_secret
);
694 gettimeofday(&(ldap_state
->last_rebind
),NULL
);
698 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
700 /*******************************************************************
701 Add a rebind function for authenticated referrals
702 ******************************************************************/
703 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
705 # if LDAP_SET_REBIND_PROC_ARGS == 2
706 static int rebindproc (LDAP
*ldap_struct
, char **whop
, char **credp
,
707 int *method
, int freeit
)
709 struct smbldap_state
*ldap_state
= smbldap_find_state(ldap_struct
);
711 return rebindproc_with_state(ldap_struct
, whop
, credp
,
712 method
, freeit
, ldap_state
);
715 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
716 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
718 /*******************************************************************
719 a rebind function for authenticated referrals
720 this also does the connection, but no void*.
721 ******************************************************************/
722 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
723 # if LDAP_SET_REBIND_PROC_ARGS == 2
724 static int rebindproc_connect (LDAP
* ld
, LDAP_CONST
char *url
, int request
,
727 struct smbldap_state
*ldap_state
= smbldap_find_state(ld
);
729 return rebindproc_connect_with_state(ld
, url
, (ber_tag_t
)request
, msgid
,
732 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
733 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
735 /*******************************************************************
736 connect to the ldap server under system privilege.
737 ******************************************************************/
738 static int smbldap_connect_system(struct smbldap_state
*ldap_state
, LDAP
* ldap_struct
)
744 /* get the password */
745 if (!fetch_ldap_pw(&ldap_dn
, &ldap_secret
))
747 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
748 return LDAP_INVALID_CREDENTIALS
;
751 ldap_state
->bind_dn
= ldap_dn
;
752 ldap_state
->bind_secret
= ldap_secret
;
754 /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite
755 (OpenLDAP) doesnt' seem to support it */
757 DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
758 ldap_state
->uri
, ldap_dn
));
760 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
761 # if LDAP_SET_REBIND_PROC_ARGS == 2
762 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect
);
764 # if LDAP_SET_REBIND_PROC_ARGS == 3
765 ldap_set_rebind_proc(ldap_struct
, &rebindproc_connect_with_state
, (void *)ldap_state
);
767 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
768 # if LDAP_SET_REBIND_PROC_ARGS == 2
769 ldap_set_rebind_proc(ldap_struct
, &rebindproc
);
771 # if LDAP_SET_REBIND_PROC_ARGS == 3
772 ldap_set_rebind_proc(ldap_struct
, &rebindproc_with_state
, (void *)ldap_state
);
774 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
776 rc
= ldap_simple_bind_s(ldap_struct
, ldap_dn
, ldap_secret
);
778 if (rc
!= LDAP_SUCCESS
) {
779 char *ld_error
= NULL
;
780 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_ERROR_STRING
,
782 DEBUG(ldap_state
->num_failures
? 2 : 0,
783 ("failed to bind to server with dn= %s Error: %s\n\t%s\n",
784 ldap_dn
? ldap_dn
: "(unknown)", ldap_err2string(rc
),
785 ld_error
? ld_error
: "(unknown)"));
787 ldap_state
->num_failures
++;
791 ldap_state
->num_failures
= 0;
793 DEBUG(3, ("ldap_connect_system: succesful connection to the LDAP server\n"));
797 /**********************************************************************
798 Connect to LDAP server (called before every ldap operation)
799 *********************************************************************/
800 static int smbldap_open(struct smbldap_state
*ldap_state
)
803 SMB_ASSERT(ldap_state
);
805 #ifndef NO_LDAP_SECURITY
806 if (geteuid() != 0) {
807 DEBUG(0, ("smbldap_open: cannot access LDAP when not root..\n"));
808 return LDAP_INSUFFICIENT_ACCESS
;
812 if ((ldap_state
->ldap_struct
!= NULL
) && ((ldap_state
->last_ping
+ SMBLDAP_DONT_PING_TIME
) < time(NULL
))) {
813 struct sockaddr_un addr
;
814 socklen_t len
= sizeof(addr
);
816 if (ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_DESC
, &sd
) == 0 &&
817 getpeername(sd
, (struct sockaddr
*) &addr
, &len
) < 0) {
818 /* the other end has died. reopen. */
819 ldap_unbind_ext(ldap_state
->ldap_struct
, NULL
, NULL
);
820 ldap_state
->ldap_struct
= NULL
;
821 ldap_state
->last_ping
= (time_t)0;
823 ldap_state
->last_ping
= time(NULL
);
827 if (ldap_state
->ldap_struct
!= NULL
) {
828 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
832 if ((rc
= smbldap_open_connection(ldap_state
))) {
836 if ((rc
= smbldap_connect_system(ldap_state
, ldap_state
->ldap_struct
))) {
837 ldap_unbind_ext(ldap_state
->ldap_struct
, NULL
, NULL
);
838 ldap_state
->ldap_struct
= NULL
;
843 ldap_state
->last_ping
= time(NULL
);
844 DEBUG(4,("The LDAP server is succesful connected\n"));
849 /**********************************************************************
850 Disconnect from LDAP server
851 *********************************************************************/
852 static NTSTATUS
smbldap_close(struct smbldap_state
*ldap_state
)
855 return NT_STATUS_INVALID_PARAMETER
;
857 if (ldap_state
->ldap_struct
!= NULL
) {
858 ldap_unbind_ext(ldap_state
->ldap_struct
, NULL
, NULL
);
859 ldap_state
->ldap_struct
= NULL
;
862 smbldap_delete_state(ldap_state
);
864 DEBUG(5,("The connection to the LDAP server was closed\n"));
865 /* maybe free the results here --metze */
872 int smbldap_retry_open(struct smbldap_state
*ldap_state
, int *attempts
)
876 SMB_ASSERT(ldap_state
&& attempts
);
878 if (*attempts
!= 0) {
879 unsigned int sleep_time
;
882 /* Sleep for a random timeout */
883 rand_byte
= (char)(sys_random());
885 sleep_time
= (((*attempts
)*(*attempts
))/2)*rand_byte
*2;
886 /* we retry after (0.5, 1, 2, 3, 4.5, 6) seconds
889 DEBUG(3, ("Sleeping for %u milliseconds before reconnecting\n",
895 if ((rc
= smbldap_open(ldap_state
))) {
896 DEBUG(1,("Connection to LDAP Server failed for the %d try!\n",*attempts
));
904 /*********************************************************************
905 ********************************************************************/
907 int smbldap_search(struct smbldap_state
*ldap_state
,
908 const char *base
, int scope
, const char *filter
,
909 char *attrs
[], int attrsonly
,
912 int rc
= LDAP_SERVER_DOWN
;
916 SMB_ASSERT(ldap_state
);
918 if (ldap_state
->last_rebind
.tv_sec
> 0) {
925 gettimeofday(&tval
,NULL
);
927 tdiff
= 1000000 *(tval
.tv_sec
- ldap_state
->last_rebind
.tv_sec
) +
928 (tval
.tv_usec
- ldap_state
->last_rebind
.tv_usec
);
930 sleep_time
= ((1000*lp_ldap_replication_sleep())-tdiff
)/1000;
932 if (sleep_time
> 0) {
933 /* we wait for the LDAP replication */
934 DEBUG(5,("smbldap_search: waiting %d milliseconds for LDAP replication.\n",sleep_time
));
936 DEBUG(5,("smbldap_search: go on!\n"));
937 ZERO_STRUCT(ldap_state
->last_rebind
);
941 if (push_utf8_allocate(&utf8_filter
, filter
) == (size_t)-1) {
942 return LDAP_NO_MEMORY
;
945 while ((rc
== LDAP_SERVER_DOWN
) && (attempts
< SMBLDAP_NUM_RETRIES
)) {
947 if ((rc
= smbldap_retry_open(ldap_state
,&attempts
)) != LDAP_SUCCESS
)
950 rc
= ldap_search_s(ldap_state
->ldap_struct
, base
, scope
,
951 utf8_filter
, attrs
, attrsonly
, res
);
954 if (rc
== LDAP_SERVER_DOWN
) {
955 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO
));
956 smbldap_close(ldap_state
);
959 ldap_state
->last_use
= time(NULL
);
961 SAFE_FREE(utf8_filter
);
965 int smbldap_modify(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
967 int rc
= LDAP_SERVER_DOWN
;
971 SMB_ASSERT(ldap_state
);
973 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
974 return LDAP_NO_MEMORY
;
977 while ((rc
== LDAP_SERVER_DOWN
) && (attempts
< SMBLDAP_NUM_RETRIES
)) {
979 if ((rc
= smbldap_retry_open(ldap_state
,&attempts
)) != LDAP_SUCCESS
)
982 rc
= ldap_modify_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
985 if (rc
== LDAP_SERVER_DOWN
) {
986 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO
));
987 smbldap_close(ldap_state
);
990 ldap_state
->last_use
= time(NULL
);
996 int smbldap_add(struct smbldap_state
*ldap_state
, const char *dn
, LDAPMod
*attrs
[])
998 int rc
= LDAP_SERVER_DOWN
;
1002 SMB_ASSERT(ldap_state
);
1004 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1005 return LDAP_NO_MEMORY
;
1008 while ((rc
== LDAP_SERVER_DOWN
) && (attempts
< SMBLDAP_NUM_RETRIES
)) {
1010 if ((rc
= smbldap_retry_open(ldap_state
,&attempts
)) != LDAP_SUCCESS
)
1013 rc
= ldap_add_s(ldap_state
->ldap_struct
, utf8_dn
, attrs
);
1016 if (rc
== LDAP_SERVER_DOWN
) {
1017 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO
));
1018 smbldap_close(ldap_state
);
1021 ldap_state
->last_use
= time(NULL
);
1027 int smbldap_delete(struct smbldap_state
*ldap_state
, const char *dn
)
1029 int rc
= LDAP_SERVER_DOWN
;
1033 SMB_ASSERT(ldap_state
);
1035 if (push_utf8_allocate(&utf8_dn
, dn
) == (size_t)-1) {
1036 return LDAP_NO_MEMORY
;
1039 while ((rc
== LDAP_SERVER_DOWN
) && (attempts
< SMBLDAP_NUM_RETRIES
)) {
1041 if ((rc
= smbldap_retry_open(ldap_state
,&attempts
)) != LDAP_SUCCESS
)
1044 rc
= ldap_delete_s(ldap_state
->ldap_struct
, utf8_dn
);
1047 if (rc
== LDAP_SERVER_DOWN
) {
1048 DEBUG(0,("%s: LDAP server is down!\n",FUNCTION_MACRO
));
1049 smbldap_close(ldap_state
);
1052 ldap_state
->last_use
= time(NULL
);
1058 int smbldap_extended_operation(struct smbldap_state
*ldap_state
,
1059 LDAP_CONST
char *reqoid
, struct berval
*reqdata
,
1060 LDAPControl
**serverctrls
, LDAPControl
**clientctrls
,
1061 char **retoidp
, struct berval
**retdatap
)
1063 int rc
= LDAP_SERVER_DOWN
;
1069 while ((rc
== LDAP_SERVER_DOWN
) && (attempts
< SMBLDAP_NUM_RETRIES
)) {
1071 if ((rc
= smbldap_retry_open(ldap_state
,&attempts
)) != LDAP_SUCCESS
)
1074 rc
= ldap_extended_operation_s(ldap_state
->ldap_struct
, reqoid
, reqdata
,
1075 serverctrls
, clientctrls
, retoidp
, retdatap
);
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
);
1088 /*******************************************************************
1089 run the search by name.
1090 ******************************************************************/
1091 int smbldap_search_suffix (struct smbldap_state
*ldap_state
, const char *filter
,
1092 char **search_attr
, LDAPMessage
** result
)
1094 int scope
= LDAP_SCOPE_SUBTREE
;
1097 DEBUG(2, ("smbldap_search_suffix: searching for:[%s]\n", filter
));
1099 rc
= smbldap_search(ldap_state
, lp_ldap_suffix(), scope
, filter
, search_attr
, 0, result
);
1101 if (rc
!= LDAP_SUCCESS
) {
1102 char *ld_error
= NULL
;
1103 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_ERROR_STRING
,
1105 DEBUG(0,("smbldap_search_suffix: Problem during the LDAP search: %s (%s)\n",
1106 ld_error
?ld_error
:"(unknown)", ldap_err2string (rc
)));
1107 DEBUG(3,("smbldap_search_suffix: Query was: %s, %s\n", lp_ldap_suffix(),
1109 SAFE_FREE(ld_error
);
1115 static void smbldap_idle_fn(void **data
, time_t *interval
, time_t now
)
1117 struct smbldap_state
*state
= (struct smbldap_state
*)(*data
);
1119 if (state
->ldap_struct
== NULL
) {
1120 DEBUG(10,("ldap connection not connected...\n"));
1124 if ((state
->last_use
+SMBLDAP_IDLE_TIME
) > now
) {
1125 DEBUG(10,("ldap connection not idle...\n"));
1129 DEBUG(7,("ldap connection idle...closing connection\n"));
1130 smbldap_close(state
);
1133 /**********************************************************************
1135 *********************************************************************/
1137 void smbldap_free_struct(struct smbldap_state
**ldap_state
)
1139 smbldap_close(*ldap_state
);
1141 if ((*ldap_state
)->bind_secret
) {
1142 memset((*ldap_state
)->bind_secret
, '\0', strlen((*ldap_state
)->bind_secret
));
1145 SAFE_FREE((*ldap_state
)->bind_dn
);
1146 SAFE_FREE((*ldap_state
)->bind_secret
);
1148 smb_unregister_idle_event((*ldap_state
)->event_id
);
1152 /* No need to free any further, as it is talloc()ed */
1156 /**********************************************************************
1157 Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1158 *********************************************************************/
1160 NTSTATUS
smbldap_init(TALLOC_CTX
*mem_ctx
, const char *location
, struct smbldap_state
**smbldap_state
)
1162 *smbldap_state
= talloc_zero(mem_ctx
, sizeof(**smbldap_state
));
1163 if (!*smbldap_state
) {
1164 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1165 return NT_STATUS_NO_MEMORY
;
1169 (*smbldap_state
)->uri
= talloc_strdup(mem_ctx
, location
);
1171 (*smbldap_state
)->uri
= "ldap://localhost";
1174 (*smbldap_state
)->event_id
=
1175 smb_register_idle_event(smbldap_idle_fn
, (void *)(*smbldap_state
),
1178 if ((*smbldap_state
)->event_id
== SMB_EVENT_ID_INVALID
) {
1179 DEBUG(0,("Failed to register LDAP idle event!\n"));
1180 return NT_STATUS_INVALID_HANDLE
;
1183 return NT_STATUS_OK
;
1186 /**********************************************************************
1187 Add the sambaDomain to LDAP, so we don't have to search for this stuff
1188 again. This is a once-add operation for now.
1190 TODO: Add other attributes, and allow modification.
1191 *********************************************************************/
1192 static NTSTATUS
add_new_domain_info(struct smbldap_state
*ldap_state
,
1193 const char *domain_name
)
1196 fstring algorithmic_rid_base_string
;
1198 LDAPMod
**mods
= NULL
;
1201 LDAPMessage
*result
= NULL
;
1204 uid_t u_low
, u_high
;
1205 gid_t g_low
, g_high
;
1206 uint32 rid_low
, rid_high
;
1208 slprintf (filter
, sizeof (filter
) - 1, "(&(%s=%s)(objectclass=%s))",
1209 get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_DOMAIN
),
1210 domain_name
, LDAP_OBJ_DOMINFO
);
1212 attr_list
= get_attr_list( dominfo_attr_list
);
1213 rc
= smbldap_search_suffix(ldap_state
, filter
, attr_list
, &result
);
1214 free_attr_list( attr_list
);
1216 if (rc
!= LDAP_SUCCESS
) {
1217 return NT_STATUS_UNSUCCESSFUL
;
1220 num_result
= ldap_count_entries(ldap_state
->ldap_struct
, result
);
1222 if (num_result
> 1) {
1223 DEBUG (0, ("More than domain with that name exists: bailing out!\n"));
1224 ldap_msgfree(result
);
1225 return NT_STATUS_UNSUCCESSFUL
;
1228 /* Check if we need to add an entry */
1229 DEBUG(3,("Adding new domain\n"));
1230 ldap_op
= LDAP_MOD_ADD
;
1232 pstr_sprintf(dn
, "%s=%s,%s", get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_DOMAIN
),
1233 domain_name
, lp_ldap_suffix());
1235 /* Free original search */
1236 ldap_msgfree(result
);
1238 /* make the changes - the entry *must* not already have samba attributes */
1239 smbldap_set_mod(&mods
, LDAP_MOD_ADD
, get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_DOMAIN
),
1242 /* If we don't have an entry, then ask secrets.tdb for what it thinks.
1243 It may choose to make it up */
1245 sid_to_string(sid_string
, get_global_sam_sid());
1246 smbldap_set_mod(&mods
, LDAP_MOD_ADD
, get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_DOM_SID
), sid_string
);
1248 slprintf(algorithmic_rid_base_string
, sizeof(algorithmic_rid_base_string
) - 1, "%i", algorithmic_rid_base());
1249 smbldap_set_mod(&mods
, LDAP_MOD_ADD
, get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_ALGORITHMIC_RID_BASE
),
1250 algorithmic_rid_base_string
);
1251 smbldap_set_mod(&mods
, LDAP_MOD_ADD
, "objectclass", LDAP_OBJ_DOMINFO
);
1253 /* add the sambaNext[User|Group]Rid attributes if the idmap ranges are set.
1254 TODO: fix all the places where the line between idmap and normal operations
1255 needed by smbd gets fuzzy --jerry 2003-08-11 */
1257 if ( lp_idmap_uid(&u_low
, &u_high
) && lp_idmap_gid(&g_low
, &g_high
)
1258 && get_free_rid_range(&rid_low
, &rid_high
) )
1262 fstr_sprintf( rid_str
, "%i", rid_high
|USER_RID_TYPE
);
1263 DEBUG(10,("setting next available user rid [%s]\n", rid_str
));
1264 smbldap_set_mod(&mods
, LDAP_MOD_ADD
,
1265 get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_NEXT_USERRID
),
1268 fstr_sprintf( rid_str
, "%i", rid_high
|GROUP_RID_TYPE
);
1269 DEBUG(10,("setting next available group rid [%s]\n", rid_str
));
1270 smbldap_set_mod(&mods
, LDAP_MOD_ADD
,
1271 get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_NEXT_GROUPRID
),
1280 rc
= smbldap_add(ldap_state
, dn
, mods
);
1282 case LDAP_MOD_REPLACE
:
1283 rc
= smbldap_modify(ldap_state
, dn
, mods
);
1286 DEBUG(0,("Wrong LDAP operation type: %d!\n", ldap_op
));
1287 return NT_STATUS_INVALID_PARAMETER
;
1290 if (rc
!=LDAP_SUCCESS
) {
1291 char *ld_error
= NULL
;
1292 ldap_get_option(ldap_state
->ldap_struct
, LDAP_OPT_ERROR_STRING
, &ld_error
);
1293 DEBUG(1,("failed to %s domain dn= %s with: %s\n\t%s\n",
1294 ldap_op
== LDAP_MOD_ADD
? "add" : "modify",
1295 dn
, ldap_err2string(rc
),
1296 ld_error
?ld_error
:"unknown"));
1297 SAFE_FREE(ld_error
);
1299 ldap_mods_free(mods
, True
);
1300 return NT_STATUS_UNSUCCESSFUL
;
1303 DEBUG(2,("added: domain = %s in the LDAP database\n", domain_name
));
1304 ldap_mods_free(mods
, True
);
1305 return NT_STATUS_OK
;
1308 /**********************************************************************
1309 Search for the domain info entry
1310 *********************************************************************/
1311 NTSTATUS
smbldap_search_domain_info(struct smbldap_state
*ldap_state
,
1312 LDAPMessage
** result
, const char *domain_name
,
1315 NTSTATUS ret
= NT_STATUS_UNSUCCESSFUL
;
1321 pstr_sprintf(filter
, "(&(objectClass=%s)(%s=%s))",
1323 get_attr_key2string(dominfo_attr_list
, LDAP_ATTR_DOMAIN
),
1326 DEBUG(2, ("Searching for:[%s]\n", filter
));
1329 attr_list
= get_attr_list( dominfo_attr_list
);
1330 rc
= smbldap_search_suffix(ldap_state
, filter
, attr_list
, result
);
1331 free_attr_list( attr_list
);
1333 if (rc
!= LDAP_SUCCESS
) {
1334 DEBUG(2,("Problem during LDAPsearch: %s\n", ldap_err2string (rc
)));
1335 DEBUG(2,("Query was: %s, %s\n", lp_ldap_suffix(), filter
));
1336 } else if (ldap_count_entries(ldap_state
->ldap_struct
, *result
) < 1) {
1337 DEBUG(3, ("Got no domain info entries for domain\n"));
1338 ldap_msgfree(*result
);
1340 if (try_add
&& NT_STATUS_IS_OK(ret
= add_new_domain_info(ldap_state
, domain_name
))) {
1341 return smbldap_search_domain_info(ldap_state
, result
, domain_name
, False
);
1344 DEBUG(0, ("Adding domain info for %s failed with %s\n",
1345 domain_name
, nt_errstr(ret
)));
1348 } else if ((count
= ldap_count_entries(ldap_state
->ldap_struct
, *result
)) > 1) {
1349 DEBUG(0, ("Got too many (%d) domain info entries for domain %s\n",
1350 count
, domain_name
));
1351 ldap_msgfree(*result
);
1355 return NT_STATUS_OK
;
1361 /*******************************************************************
1362 Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1363 ********************************************************************/
1365 char *smbldap_get_dn(LDAP
*ld
, LDAPMessage
*entry
)
1367 char *utf8_dn
, *unix_dn
;
1369 utf8_dn
= ldap_get_dn(ld
, entry
);
1371 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1374 if (pull_utf8_allocate(&unix_dn
, utf8_dn
) == (size_t)-1) {
1375 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 [%s]\n", utf8_dn
));
1378 ldap_memfree(utf8_dn
);