r15995: Make smbldap obey config tests. Patch from "John E. Malmberg"
[samba.git] / source / lib / smbldap.c
1 /* 
2    Unix SMB/CIFS implementation.
3    LDAP protocol helper functions for SAMBA
4    Copyright (C) Jean François Micouleau       1998
5    Copyright (C) Gerald Carter                  2001-2003
6    Copyright (C) Shahms King                    2001
7    Copyright (C) Andrew Bartlett                2002-2003
8    Copyright (C) Stefan (metze) Metzmacher      2002-2003
9     
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.
14    
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.
19    
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.
23    
24 */
25
26 #include "includes.h"
27 #include "smbldap.h"
28
29 #ifndef LDAP_OPT_SUCCESS
30 #define LDAP_OPT_SUCCESS 0
31 #endif
32
33 /* Try not to hit the up or down server forever */
34
35 #define SMBLDAP_DONT_PING_TIME 10       /* ping only all 10 seconds */
36 #define SMBLDAP_NUM_RETRIES 8           /* retry only 8 times */
37
38 #define SMBLDAP_IDLE_TIME 150           /* After 2.5 minutes disconnect */
39
40
41 /* attributes used by Samba 2.2 */
42
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,         "homeDrive"     },
58         { LDAP_ATTR_LOGON_SCRIPT,       "scriptPath"    },
59         { LDAP_ATTR_PROFILE_PATH,       "profilePath"   },
60         { LDAP_ATTR_DESC,               "description"   },
61         { LDAP_ATTR_USER_WKS,           "userWorkstations"},
62         { LDAP_ATTR_USER_RID,           "rid"           },
63         { LDAP_ATTR_PRIMARY_GROUP_RID,  "primaryGroupID"},
64         { LDAP_ATTR_LMPW,               "lmPassword"    },
65         { LDAP_ATTR_NTPW,               "ntPassword"    },
66         { LDAP_ATTR_DOMAIN,             "domain"        },
67         { LDAP_ATTR_OBJCLASS,           "objectClass"   },
68         { LDAP_ATTR_ACB_INFO,           "acctFlags"     },
69         { LDAP_ATTR_MOD_TIMESTAMP,      "modifyTimestamp"       },
70         { LDAP_ATTR_LIST_END,           NULL            }
71 };
72
73 ATTRIB_MAP_ENTRY attrib_map_to_delete_v22[] = {
74         { LDAP_ATTR_PWD_LAST_SET,       "pwdLastSet"    },
75         { LDAP_ATTR_PWD_CAN_CHANGE,     "pwdCanChange"  },
76         { LDAP_ATTR_PWD_MUST_CHANGE,    "pwdMustChange" },
77         { LDAP_ATTR_LOGON_TIME,         "logonTime"     },
78         { LDAP_ATTR_LOGOFF_TIME,        "logoffTime"    },
79         { LDAP_ATTR_KICKOFF_TIME,       "kickoffTime"   },
80         { LDAP_ATTR_DISPLAY_NAME,       "displayName"   },
81         { LDAP_ATTR_HOME_PATH,          "smbHome"       },
82         { LDAP_ATTR_HOME_DRIVE,         "homeDrives"    },
83         { LDAP_ATTR_LOGON_SCRIPT,       "scriptPath"    },
84         { LDAP_ATTR_PROFILE_PATH,       "profilePath"   },
85         { LDAP_ATTR_USER_WKS,           "userWorkstations"},
86         { LDAP_ATTR_USER_RID,           "rid"           },
87         { LDAP_ATTR_PRIMARY_GROUP_RID,  "primaryGroupID"},
88         { LDAP_ATTR_LMPW,               "lmPassword"    },
89         { LDAP_ATTR_NTPW,               "ntPassword"    },
90         { LDAP_ATTR_DOMAIN,             "domain"        },
91         { LDAP_ATTR_ACB_INFO,           "acctFlags"     },
92         { LDAP_ATTR_LIST_END,           NULL            }
93 };
94
95 /* attributes used by Samba 3.0's sambaSamAccount */
96
97 ATTRIB_MAP_ENTRY attrib_map_v30[] = {
98         { LDAP_ATTR_UID,                "uid"                   },
99         { LDAP_ATTR_UIDNUMBER,          LDAP_ATTRIBUTE_UIDNUMBER},
100         { LDAP_ATTR_GIDNUMBER,          LDAP_ATTRIBUTE_GIDNUMBER},
101         { LDAP_ATTR_UNIX_HOME,          "homeDirectory"         },
102         { LDAP_ATTR_PWD_LAST_SET,       "sambaPwdLastSet"       },
103         { LDAP_ATTR_PWD_CAN_CHANGE,     "sambaPwdCanChange"     },
104         { LDAP_ATTR_PWD_MUST_CHANGE,    "sambaPwdMustChange"    },
105         { LDAP_ATTR_LOGON_TIME,         "sambaLogonTime"        },
106         { LDAP_ATTR_LOGOFF_TIME,        "sambaLogoffTime"       },
107         { LDAP_ATTR_KICKOFF_TIME,       "sambaKickoffTime"      },
108         { LDAP_ATTR_CN,                 "cn"                    },
109         { LDAP_ATTR_DISPLAY_NAME,       "displayName"           },
110         { LDAP_ATTR_HOME_DRIVE,         "sambaHomeDrive"        },
111         { LDAP_ATTR_HOME_PATH,          "sambaHomePath"         },
112         { LDAP_ATTR_LOGON_SCRIPT,       "sambaLogonScript"      },
113         { LDAP_ATTR_PROFILE_PATH,       "sambaProfilePath"      },
114         { LDAP_ATTR_DESC,               "description"           },
115         { LDAP_ATTR_USER_WKS,           "sambaUserWorkstations" },
116         { LDAP_ATTR_USER_SID,           LDAP_ATTRIBUTE_SID      },
117         { LDAP_ATTR_PRIMARY_GROUP_SID,  "sambaPrimaryGroupSID"  },
118         { LDAP_ATTR_LMPW,               "sambaLMPassword"       },
119         { LDAP_ATTR_NTPW,               "sambaNTPassword"       },
120         { LDAP_ATTR_DOMAIN,             "sambaDomainName"       },
121         { LDAP_ATTR_OBJCLASS,           "objectClass"           },
122         { LDAP_ATTR_ACB_INFO,           "sambaAcctFlags"        },
123         { LDAP_ATTR_MUNGED_DIAL,        "sambaMungedDial"       },
124         { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
125         { LDAP_ATTR_BAD_PASSWORD_TIME,  "sambaBadPasswordTime"  },
126         { LDAP_ATTR_PWD_HISTORY,        "sambaPasswordHistory"  },
127         { LDAP_ATTR_MOD_TIMESTAMP,      "modifyTimestamp"       },
128         { LDAP_ATTR_LOGON_HOURS,        "sambaLogonHours"       },
129         { LDAP_ATTR_LIST_END,           NULL                    }
130 };
131
132 ATTRIB_MAP_ENTRY attrib_map_to_delete_v30[] = {
133         { LDAP_ATTR_PWD_LAST_SET,       "sambaPwdLastSet"       },
134         { LDAP_ATTR_PWD_CAN_CHANGE,     "sambaPwdCanChange"     },
135         { LDAP_ATTR_PWD_MUST_CHANGE,    "sambaPwdMustChange"    },
136         { LDAP_ATTR_LOGON_TIME,         "sambaLogonTime"        },
137         { LDAP_ATTR_LOGOFF_TIME,        "sambaLogoffTime"       },
138         { LDAP_ATTR_KICKOFF_TIME,       "sambaKickoffTime"      },
139         { LDAP_ATTR_HOME_DRIVE,         "sambaHomeDrive"        },
140         { LDAP_ATTR_HOME_PATH,          "sambaHomePath"         },
141         { LDAP_ATTR_LOGON_SCRIPT,       "sambaLogonScript"      },
142         { LDAP_ATTR_PROFILE_PATH,       "sambaProfilePath"      },
143         { LDAP_ATTR_USER_WKS,           "sambaUserWorkstations" },
144         { LDAP_ATTR_USER_SID,           LDAP_ATTRIBUTE_SID      },
145         { LDAP_ATTR_PRIMARY_GROUP_SID,  "sambaPrimaryGroupSID"  },
146         { LDAP_ATTR_LMPW,               "sambaLMPassword"       },
147         { LDAP_ATTR_NTPW,               "sambaNTPassword"       },
148         { LDAP_ATTR_DOMAIN,             "sambaDomainName"       },
149         { LDAP_ATTR_ACB_INFO,           "sambaAcctFlags"        },
150         { LDAP_ATTR_MUNGED_DIAL,        "sambaMungedDial"       },
151         { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
152         { LDAP_ATTR_BAD_PASSWORD_TIME,  "sambaBadPasswordTime"  },
153         { LDAP_ATTR_PWD_HISTORY,        "sambaPasswordHistory"  },
154         { LDAP_ATTR_LOGON_HOURS,        "sambaLogonHours"       },
155         { LDAP_ATTR_LIST_END,           NULL                    }
156 };
157
158 /* attributes used for allocating RIDs */
159
160 ATTRIB_MAP_ENTRY dominfo_attr_list[] = {
161         { LDAP_ATTR_DOMAIN,             "sambaDomainName"       },
162         { LDAP_ATTR_NEXT_RID,           "sambaNextRid"          },
163         { LDAP_ATTR_NEXT_USERRID,       "sambaNextUserRid"      },
164         { LDAP_ATTR_NEXT_GROUPRID,      "sambaNextGroupRid"     },
165         { LDAP_ATTR_DOM_SID,            LDAP_ATTRIBUTE_SID      },
166         { LDAP_ATTR_ALGORITHMIC_RID_BASE,"sambaAlgorithmicRidBase"},
167         { LDAP_ATTR_OBJCLASS,           "objectClass"           },
168         { LDAP_ATTR_LIST_END,           NULL                    },
169 };
170
171 /* Samba 3.0 group mapping attributes */
172
173 ATTRIB_MAP_ENTRY groupmap_attr_list[] = {
174         { LDAP_ATTR_GIDNUMBER,          LDAP_ATTRIBUTE_GIDNUMBER},
175         { LDAP_ATTR_GROUP_SID,          LDAP_ATTRIBUTE_SID      },
176         { LDAP_ATTR_GROUP_TYPE,         "sambaGroupType"        },
177         { LDAP_ATTR_SID_LIST,           "sambaSIDList"          },
178         { LDAP_ATTR_DESC,               "description"           },
179         { LDAP_ATTR_DISPLAY_NAME,       "displayName"           },
180         { LDAP_ATTR_CN,                 "cn"                    },
181         { LDAP_ATTR_OBJCLASS,           "objectClass"           },
182         { LDAP_ATTR_LIST_END,           NULL                    }       
183 };
184
185 ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete[] = {
186         { LDAP_ATTR_GROUP_SID,          LDAP_ATTRIBUTE_SID      },
187         { LDAP_ATTR_GROUP_TYPE,         "sambaGroupType"        },
188         { LDAP_ATTR_DESC,               "description"           },
189         { LDAP_ATTR_DISPLAY_NAME,       "displayName"           },
190         { LDAP_ATTR_SID_LIST,           "sambaSIDList"          },
191         { LDAP_ATTR_LIST_END,           NULL                    }       
192 };
193
194 /* idmap_ldap sambaUnixIdPool */
195
196 ATTRIB_MAP_ENTRY idpool_attr_list[] = {
197         { LDAP_ATTR_UIDNUMBER,          LDAP_ATTRIBUTE_UIDNUMBER},
198         { LDAP_ATTR_GIDNUMBER,          LDAP_ATTRIBUTE_GIDNUMBER},
199         { LDAP_ATTR_OBJCLASS,           "objectClass"           },
200         { LDAP_ATTR_LIST_END,           NULL                    }       
201 };
202
203 ATTRIB_MAP_ENTRY sidmap_attr_list[] = {
204         { LDAP_ATTR_SID,                LDAP_ATTRIBUTE_SID      },
205         { LDAP_ATTR_UIDNUMBER,          LDAP_ATTRIBUTE_UIDNUMBER},
206         { LDAP_ATTR_GIDNUMBER,          LDAP_ATTRIBUTE_GIDNUMBER},
207         { LDAP_ATTR_OBJCLASS,           "objectClass"           },
208         { LDAP_ATTR_LIST_END,           NULL                    }       
209 };
210
211 /**********************************************************************
212  perform a simple table lookup and return the attribute name 
213  **********************************************************************/
214  
215  const char* get_attr_key2string( ATTRIB_MAP_ENTRY table[], int key )
216 {
217         int i = 0;
218         
219         while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
220                 if ( table[i].attrib == key )
221                         return table[i].name;
222                 i++;
223         }
224         
225         return NULL;
226 }
227
228
229 /**********************************************************************
230  Return the list of attribute names from a mapping table
231  **********************************************************************/
232
233  const char** get_attr_list( TALLOC_CTX *mem_ctx, ATTRIB_MAP_ENTRY table[] )
234 {
235         const char **names;
236         int i = 0;
237         
238         while ( table[i].attrib != LDAP_ATTR_LIST_END )
239                 i++;
240         i++;
241
242         names = TALLOC_ARRAY( mem_ctx, const char*, i );
243         if ( !names ) {
244                 DEBUG(0,("get_attr_list: out of memory\n"));
245                 return NULL;
246         }
247
248         i = 0;
249         while ( table[i].attrib != LDAP_ATTR_LIST_END ) {
250                 names[i] = talloc_strdup( names, table[i].name );
251                 i++;
252         }
253         names[i] = NULL;
254         
255         return names;
256 }
257
258 /*******************************************************************
259  Search an attribute and return the first value found.
260 ******************************************************************/
261
262  BOOL smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
263                                     const char *attribute, char *value,
264                                     int max_len)
265 {
266         char **values;
267         
268         if ( !attribute )
269                 return False;
270                 
271         value[0] = '\0';
272
273         if ((values = ldap_get_values (ldap_struct, entry, attribute)) == NULL) {
274                 DEBUG (10, ("smbldap_get_single_attribute: [%s] = [<does not exist>]\n", attribute));
275                 
276                 return False;
277         }
278         
279         if (convert_string(CH_UTF8, CH_UNIX,values[0], -1, value, max_len, False) == (size_t)-1) {
280                 DEBUG(1, ("smbldap_get_single_attribute: string conversion of [%s] = [%s] failed!\n", 
281                           attribute, values[0]));
282                 ldap_value_free(values);
283                 return False;
284         }
285         
286         ldap_value_free(values);
287 #ifdef DEBUG_PASSWORDS
288         DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n", attribute, value));
289 #endif  
290         return True;
291 }
292
293  BOOL smbldap_get_single_pstring (LDAP * ldap_struct, LDAPMessage * entry,
294                                   const char *attribute, pstring value)
295 {
296         return smbldap_get_single_attribute(ldap_struct, entry,
297                                             attribute, value, 
298                                             sizeof(pstring));
299 }
300
301  char * smbldap_talloc_single_attribute(LDAP *ldap_struct, LDAPMessage *entry,
302                                         const char *attribute,
303                                         TALLOC_CTX *mem_ctx)
304 {
305         char **values;
306         char *result;
307
308         if (attribute == NULL) {
309                 return NULL;
310         }
311
312         values = ldap_get_values(ldap_struct, entry, attribute);
313
314         if (values == NULL) {
315                 DEBUG(10, ("attribute %s does not exist\n", attribute));
316                 return NULL;
317         }
318
319         if (ldap_count_values(values) != 1) {
320                 DEBUG(10, ("attribute %s has %d values, expected only one\n",
321                            attribute, ldap_count_values(values)));
322                 ldap_value_free(values);
323                 return NULL;
324         }
325
326         if (pull_utf8_talloc(mem_ctx, &result, values[0]) < 0) {
327                 DEBUG(10, ("pull_utf8_talloc failed\n"));
328                 ldap_value_free(values);
329                 return NULL;
330         }
331
332         ldap_value_free(values);
333
334 #ifdef DEBUG_PASSWORDS
335         DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
336                      attribute, result));
337 #endif  
338         return result;
339 }
340
341  static int ldapmsg_destructor(void *p) {
342         LDAPMessage **result = talloc_get_type_abort(p, LDAPMessage *);
343         ldap_msgfree(*result);
344         return 0;
345 }
346
347  void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
348 {
349         LDAPMessage **handle;
350
351         if (result == NULL) {
352                 return;
353         }
354
355         handle = TALLOC_P(mem_ctx, LDAPMessage *);
356         SMB_ASSERT(handle != NULL);
357
358         *handle = result;
359         talloc_set_destructor(handle, ldapmsg_destructor);
360 }
361
362  static int ldapmod_destructor(void *p) {
363         LDAPMod ***result = talloc_get_type_abort(p, LDAPMod **);
364         ldap_mods_free(*result, True);
365         return 0;
366 }
367
368  void talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod)
369 {
370         LDAPMod ***handle;
371
372         if (mod == NULL) {
373                 return;
374         }
375
376         handle = TALLOC_P(mem_ctx, LDAPMod **);
377         SMB_ASSERT(handle != NULL);
378
379         *handle = mod;
380         talloc_set_destructor(handle, ldapmod_destructor);
381 }
382
383 /************************************************************************
384  Routine to manage the LDAPMod structure array
385  manage memory used by the array, by each struct, and values
386  ***********************************************************************/
387
388  void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value)
389 {
390         LDAPMod **mods;
391         int i;
392         int j;
393
394         mods = *modlist;
395
396         /* sanity checks on the mod values */
397
398         if (attribute == NULL || *attribute == '\0') {
399                 return; 
400         }
401
402 #if 0   /* commented out after discussion with abartlet.  Do not reenable.
403            left here so other do not re-add similar code   --jerry */
404         if (value == NULL || *value == '\0')
405                 return;
406 #endif
407
408         if (mods == NULL) {
409                 mods = SMB_MALLOC_P(LDAPMod *);
410                 if (mods == NULL) {
411                         smb_panic("smbldap_set_mod: out of memory!\n");
412                         /* notreached. */
413                         abort();
414                 }
415                 mods[0] = NULL;
416         }
417
418         for (i = 0; mods[i] != NULL; ++i) {
419                 if (mods[i]->mod_op == modop && strequal(mods[i]->mod_type, attribute))
420                         break;
421         }
422
423         if (mods[i] == NULL) {
424                 mods = SMB_REALLOC_ARRAY (mods, LDAPMod *, i + 2);
425                 if (mods == NULL) {
426                         smb_panic("smbldap_set_mod: out of memory!\n");
427                         /* notreached. */
428                         abort();
429                 }
430                 mods[i] = SMB_MALLOC_P(LDAPMod);
431                 if (mods[i] == NULL) {
432                         smb_panic("smbldap_set_mod: out of memory!\n");
433                         /* notreached. */
434                         abort();
435                 }
436                 mods[i]->mod_op = modop;
437                 mods[i]->mod_values = NULL;
438                 mods[i]->mod_type = SMB_STRDUP(attribute);
439                 mods[i + 1] = NULL;
440         }
441
442         if (value != NULL) {
443                 char *utf8_value = NULL;
444
445                 j = 0;
446                 if (mods[i]->mod_values != NULL) {
447                         for (; mods[i]->mod_values[j] != NULL; j++);
448                 }
449                 mods[i]->mod_values = SMB_REALLOC_ARRAY(mods[i]->mod_values, char *, j + 2);
450                                                
451                 if (mods[i]->mod_values == NULL) {
452                         smb_panic("smbldap_set_mod: out of memory!\n");
453                         /* notreached. */
454                         abort();
455                 }
456
457                 if (push_utf8_allocate(&utf8_value, value) == (size_t)-1) {
458                         smb_panic("smbldap_set_mod: String conversion failure!\n");
459                         /* notreached. */
460                         abort();
461                 }
462
463                 mods[i]->mod_values[j] = utf8_value;
464
465                 mods[i]->mod_values[j + 1] = NULL;
466         }
467         *modlist = mods;
468 }
469
470 /**********************************************************************
471   Set attribute to newval in LDAP, regardless of what value the
472   attribute had in LDAP before.
473 *********************************************************************/
474
475  void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
476                       LDAPMod ***mods,
477                       const char *attribute, const char *newval)
478 {
479         char oldval[2048]; /* current largest allowed value is mungeddial */
480         BOOL existed;
481
482         if (attribute == NULL) {
483                 /* This can actually happen for ldapsam_compat where we for
484                  * example don't have a password history */
485                 return;
486         }
487
488         if (existing != NULL) {
489                 existed = smbldap_get_single_attribute(ldap_struct, existing, attribute, oldval, sizeof(oldval));
490         } else {
491                 existed = False;
492                 *oldval = '\0';
493         }
494
495         /* all of our string attributes are case insensitive */
496         
497         if (existed && newval && (StrCaseCmp(oldval, newval) == 0)) {
498                 
499                 /* Believe it or not, but LDAP will deny a delete and
500                    an add at the same time if the values are the
501                    same... */
502                 DEBUG(10,("smbldap_make_mod: attribute |%s| not changed.\n", attribute));
503                 return;
504         }
505
506         if (existed) {
507                 /* There has been no value before, so don't delete it.
508                  * Here's a possible race: We might end up with
509                  * duplicate attributes */
510                 /* By deleting exactly the value we found in the entry this
511                  * should be race-free in the sense that the LDAP-Server will
512                  * deny the complete operation if somebody changed the
513                  * attribute behind our back. */
514                 /* This will also allow modifying single valued attributes 
515                  * in Novell NDS. In NDS you have to first remove attribute and then
516                  * you could add new value */
517                 
518                 DEBUG(10,("smbldap_make_mod: deleting attribute |%s| values |%s|\n", attribute, oldval));
519                 smbldap_set_mod(mods, LDAP_MOD_DELETE, attribute, oldval);
520         }
521
522         /* Regardless of the real operation (add or modify)
523            we add the new value here. We rely on deleting
524            the old value, should it exist. */
525
526         if ((newval != NULL) && (strlen(newval) > 0)) {
527                 DEBUG(10,("smbldap_make_mod: adding attribute |%s| value |%s|\n", attribute, newval));
528                 smbldap_set_mod(mods, LDAP_MOD_ADD, attribute, newval);
529         }
530 }
531
532 /**********************************************************************
533  Some varients of the LDAP rebind code do not pass in the third 'arg' 
534  pointer to a void*, so we try and work around it by assuming that the 
535  value of the 'LDAP *' pointer is the same as the one we had passed in
536  **********************************************************************/
537
538 struct smbldap_state_lookup {
539         LDAP *ld;
540         struct smbldap_state *smbldap_state;
541         struct smbldap_state_lookup *prev, *next;
542 };
543
544 static struct smbldap_state_lookup *smbldap_state_lookup_list;
545
546 static struct smbldap_state *smbldap_find_state(LDAP *ld) 
547 {
548         struct smbldap_state_lookup *t;
549
550         for (t = smbldap_state_lookup_list; t; t = t->next) {
551                 if (t->ld == ld) {
552                         return t->smbldap_state;
553                 }
554         }
555         return NULL;
556 }
557
558 static void smbldap_delete_state(struct smbldap_state *smbldap_state) 
559 {
560         struct smbldap_state_lookup *t;
561
562         for (t = smbldap_state_lookup_list; t; t = t->next) {
563                 if (t->smbldap_state == smbldap_state) {
564                         DLIST_REMOVE(smbldap_state_lookup_list, t);
565                         SAFE_FREE(t);
566                         return;
567                 }
568         }
569 }
570
571 static void smbldap_store_state(LDAP *ld, struct smbldap_state *smbldap_state) 
572 {
573         struct smbldap_state *tmp_ldap_state;
574         struct smbldap_state_lookup *t;
575         struct smbldap_state_lookup *tmp;
576         
577         if ((tmp_ldap_state = smbldap_find_state(ld))) {
578                 SMB_ASSERT(tmp_ldap_state == smbldap_state);
579                 return;
580         }
581
582         t = SMB_XMALLOC_P(struct smbldap_state_lookup);
583         ZERO_STRUCTP(t);
584         
585         DLIST_ADD_END(smbldap_state_lookup_list, t, tmp);
586         t->ld = ld;
587         t->smbldap_state = smbldap_state;
588 }
589
590 /********************************************************************
591  start TLS on an existing LDAP connection
592 *******************************************************************/
593
594 int smb_ldap_start_tls(LDAP *ldap_struct, int version)
595
596         int rc;
597         
598         if (lp_ldap_ssl() != LDAP_SSL_START_TLS) {
599                 return LDAP_SUCCESS;
600         }
601         
602 #ifdef LDAP_OPT_X_TLS
603         if (version != LDAP_VERSION3) {
604                 DEBUG(0, ("Need LDAPv3 for Start TLS\n"));
605                 return LDAP_OPERATIONS_ERROR;
606         }
607
608         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)));
611                 return rc;
612         }
613
614         DEBUG (3, ("StartTLS issued: using a TLS connection\n"));
615         return LDAP_SUCCESS;
616 #else
617         DEBUG(0,("StartTLS not supported by LDAP client libraries!\n"));
618         return LDAP_OPERATIONS_ERROR;
619 #endif
620 }
621
622 /********************************************************************
623  setup a connection to the LDAP server based on a uri
624 *******************************************************************/
625
626 int smb_ldap_setup_conn(LDAP **ldap_struct, const char *uri)
627 {
628         int rc;
629
630         DEBUG(10, ("smb_ldap_setup_connection: %s\n", uri));
631         
632 #ifdef HAVE_LDAP_INITIALIZE
633         
634         rc = ldap_initialize(ldap_struct, uri);
635         if (rc) {
636                 DEBUG(0, ("ldap_initialize: %s\n", ldap_err2string(rc)));
637         }
638
639         return rc;
640 #else 
641
642         /* Parse the string manually */
643
644         {
645                 int port = 0;
646                 fstring protocol;
647                 fstring host;
648                 SMB_ASSERT(sizeof(protocol)>10 && sizeof(host)>254);
649
650
651                 /* skip leading "URL:" (if any) */
652                 if ( strnequal( uri, "URL:", 4 ) ) {
653                         uri += 4;
654                 }
655                 
656                 sscanf(uri, "%10[^:]://%254[^:/]:%d", protocol, host, &port);
657                 
658                 if (port == 0) {
659                         if (strequal(protocol, "ldap")) {
660                                 port = LDAP_PORT;
661                         } else if (strequal(protocol, "ldaps")) {
662                                 port = LDAPS_PORT;
663                         } else {
664                                 DEBUG(0, ("unrecognised protocol (%s)!\n", protocol));
665                         }
666                 }
667                 
668                 if ((*ldap_struct = ldap_init(host, port)) == NULL)     {
669                         DEBUG(0, ("ldap_init failed !\n"));
670                         return LDAP_OPERATIONS_ERROR;
671                 }
672                 
673                 if (strequal(protocol, "ldaps")) {
674 #ifdef LDAP_OPT_X_TLS
675                         int tls = LDAP_OPT_X_TLS_HARD;
676                         if (ldap_set_option (*ldap_struct, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
677                         {
678                                 DEBUG(0, ("Failed to setup a TLS session\n"));
679                         }
680                         
681                         DEBUG(3,("LDAPS option set...!\n"));
682 #else
683                         DEBUG(0,("smbldap_open_connection: Secure connection not supported by LDAP client libraries!\n"));
684                         return LDAP_OPERATIONS_ERROR;
685 #endif /* LDAP_OPT_X_TLS */
686                 }
687
688         }
689 #endif /* HAVE_LDAP_INITIALIZE */
690         return LDAP_SUCCESS;
691 }
692
693 /********************************************************************
694  try to upgrade to Version 3 LDAP if not already, in either case return current
695  version 
696  *******************************************************************/
697
698 int smb_ldap_upgrade_conn(LDAP *ldap_struct, int *new_version) 
699 {
700         int version;
701         int rc;
702         
703         /* assume the worst */
704         *new_version = LDAP_VERSION2;
705
706         rc = ldap_get_option(ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
707         if (rc) {
708                 return rc;
709         }
710
711         if (version == LDAP_VERSION3) {
712                 *new_version = LDAP_VERSION3;
713                 return LDAP_SUCCESS;
714         }
715
716         /* try upgrade */
717         version = LDAP_VERSION3;
718         rc = ldap_set_option (ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
719         if (rc) {
720                 return rc;
721         }
722                 
723         *new_version = LDAP_VERSION3;
724         return LDAP_SUCCESS;
725 }
726
727 /*******************************************************************
728  open a connection to the ldap server (just until the bind)
729  ******************************************************************/
730
731 int smb_ldap_setup_full_conn(LDAP **ldap_struct, const char *uri)
732 {
733         int rc, version;
734
735         rc = smb_ldap_setup_conn(ldap_struct, uri);
736         if (rc) {
737                 return rc;
738         }
739
740         rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
741         if (rc) {
742                 return rc;
743         }
744
745         rc = smb_ldap_start_tls(*ldap_struct, version);
746         if (rc) {
747                 return rc;
748         }
749
750         return LDAP_SUCCESS;
751 }
752
753 /*******************************************************************
754  open a connection to the ldap server.
755 ******************************************************************/
756 static int smbldap_open_connection (struct smbldap_state *ldap_state)
757
758 {
759         int rc = LDAP_SUCCESS;
760         int version;
761         LDAP **ldap_struct = &ldap_state->ldap_struct;
762
763         rc = smb_ldap_setup_conn(ldap_struct, ldap_state->uri);
764         if (rc) {
765                 return rc;
766         }
767
768         /* Store the LDAP pointer in a lookup list */
769
770         smbldap_store_state(*ldap_struct, ldap_state);
771
772         /* Upgrade to LDAPv3 if possible */
773
774         rc = smb_ldap_upgrade_conn(*ldap_struct, &version);
775         if (rc) {
776                 return rc;
777         }
778
779         /* Start TLS if required */
780
781         rc = smb_ldap_start_tls(*ldap_struct, version);
782         if (rc) {
783                 return rc;
784         }
785         
786         DEBUG(2, ("smbldap_open_connection: connection opened\n"));
787         return rc;
788 }
789
790 /*******************************************************************
791  a rebind function for authenticated referrals
792  This version takes a void* that we can shove useful stuff in :-)
793 ******************************************************************/
794 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
795 #else
796 static int rebindproc_with_state  (LDAP * ld, char **whop, char **credp, 
797                                    int *methodp, int freeit, void *arg)
798 {
799         struct smbldap_state *ldap_state = arg;
800         
801         /** @TODO Should we be doing something to check what servers we rebind to?
802             Could we get a referral to a machine that we don't want to give our
803             username and password to? */
804         
805         if (freeit) {
806                 SAFE_FREE(*whop);
807                 memset(*credp, '\0', strlen(*credp));
808                 SAFE_FREE(*credp);
809         } else {
810                 DEBUG(5,("rebind_proc_with_state: Rebinding as \"%s\"\n", 
811                           ldap_state->bind_dn));
812
813                 *whop = SMB_STRDUP(ldap_state->bind_dn);
814                 if (!*whop) {
815                         return LDAP_NO_MEMORY;
816                 }
817                 *credp = SMB_STRDUP(ldap_state->bind_secret);
818                 if (!*credp) {
819                         SAFE_FREE(*whop);
820                         return LDAP_NO_MEMORY;
821                 }
822                 *methodp = LDAP_AUTH_SIMPLE;
823         }
824
825         GetTimeOfDay(&ldap_state->last_rebind);
826                 
827         return 0;
828 }
829 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
830
831 /*******************************************************************
832  a rebind function for authenticated referrals
833  This version takes a void* that we can shove useful stuff in :-)
834  and actually does the connection.
835 ******************************************************************/
836 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
837 static int rebindproc_connect_with_state (LDAP *ldap_struct, 
838                                           LDAP_CONST char *url, 
839                                           ber_tag_t request,
840                                           ber_int_t msgid, void *arg)
841 {
842         struct smbldap_state *ldap_state = arg;
843         int rc;
844         int version;
845
846         DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n", 
847                  url, ldap_state->bind_dn));
848
849         /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
850          * itself) before rebinding to another LDAP server to avoid to expose
851          * our credentials. At least *try* to secure the connection - Guenther */
852
853         smb_ldap_upgrade_conn(ldap_struct, &version);
854         smb_ldap_start_tls(ldap_struct, version);
855
856         /** @TODO Should we be doing something to check what servers we rebind to?
857             Could we get a referral to a machine that we don't want to give our
858             username and password to? */
859
860         rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
861
862         /* only set the last rebind timestamp when we did rebind after a
863          * non-read LDAP operation. That way we avoid the replication sleep
864          * after a simple redirected search operation - Guenther */
865
866         switch (request) {
867
868                 case LDAP_REQ_MODIFY:
869                 case LDAP_REQ_ADD:
870                 case LDAP_REQ_DELETE:
871                 case LDAP_REQ_MODDN:
872                 case LDAP_REQ_EXTENDED:
873                         DEBUG(10,("rebindproc_connect_with_state: "
874                                 "setting last_rebind timestamp "
875                                 "(req: 0x%02x)\n", (unsigned int)request));
876                         GetTimeOfDay(&ldap_state->last_rebind);
877                         break;
878                 default:
879                         ZERO_STRUCT(ldap_state->last_rebind);
880                         break;
881         }
882
883         return rc;
884 }
885 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
886
887 /*******************************************************************
888  Add a rebind function for authenticated referrals
889 ******************************************************************/
890 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
891 #else
892 # if LDAP_SET_REBIND_PROC_ARGS == 2
893 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
894                        int *method, int freeit )
895 {
896         struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
897
898         return rebindproc_with_state(ldap_struct, whop, credp,
899                                      method, freeit, ldap_state);
900         
901 }
902 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
903 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
904
905 /*******************************************************************
906  a rebind function for authenticated referrals
907  this also does the connection, but no void*.
908 ******************************************************************/
909 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
910 # if LDAP_SET_REBIND_PROC_ARGS == 2
911 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
912                                ber_int_t msgid)
913 {
914         struct smbldap_state *ldap_state = smbldap_find_state(ld);
915
916         return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid, 
917                                              ldap_state);
918 }
919 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
920 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
921
922 /*******************************************************************
923  connect to the ldap server under system privilege.
924 ******************************************************************/
925 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
926 {
927         int rc;
928         char *ldap_dn;
929         char *ldap_secret;
930         int version;
931
932         /* get the password */
933         if (!fetch_ldap_pw(&ldap_dn, &ldap_secret)) {
934                 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
935                 return LDAP_INVALID_CREDENTIALS;
936         }
937
938         ldap_state->bind_dn = ldap_dn;
939         ldap_state->bind_secret = ldap_secret;
940
941         /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite 
942            (OpenLDAP) doesnt' seem to support it */
943            
944         DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
945                   ldap_state->uri, ldap_dn));
946
947 #ifdef HAVE_LDAP_SET_REBIND_PROC
948 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
949 # if LDAP_SET_REBIND_PROC_ARGS == 2     
950         ldap_set_rebind_proc(ldap_struct, &rebindproc_connect); 
951 # endif
952 # if LDAP_SET_REBIND_PROC_ARGS == 3     
953         ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);  
954 # endif
955 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
956 # if LDAP_SET_REBIND_PROC_ARGS == 2     
957         ldap_set_rebind_proc(ldap_struct, &rebindproc); 
958 # endif
959 # if LDAP_SET_REBIND_PROC_ARGS == 3     
960         ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);  
961 # endif
962 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
963 #endif
964
965         rc = ldap_simple_bind_s(ldap_struct, ldap_dn, ldap_secret);
966
967         if (rc != LDAP_SUCCESS) {
968                 char *ld_error = NULL;
969                 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
970                                 &ld_error);
971                 DEBUG(ldap_state->num_failures ? 2 : 0,
972                       ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
973                                ldap_state->uri,
974                                ldap_dn ? ldap_dn : "(unknown)", ldap_err2string(rc),
975                                ld_error ? ld_error : "(unknown)"));
976                 SAFE_FREE(ld_error);
977                 ldap_state->num_failures++;
978                 return rc;
979         }
980
981         ldap_state->num_failures = 0;
982         ldap_state->paged_results = False;
983
984         ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
985
986         if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
987                 ldap_state->paged_results = True;
988         }
989
990         DEBUG(3, ("ldap_connect_system: succesful connection to the LDAP server\n"));
991         DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n", 
992                 ldap_state->paged_results ? "does" : "does not"));
993         return rc;
994 }
995
996 /**********************************************************************
997  Connect to LDAP server (called before every ldap operation)
998 *********************************************************************/
999 static int smbldap_open(struct smbldap_state *ldap_state)
1000 {
1001         int rc, opt_rc;
1002         BOOL reopen = False;
1003         SMB_ASSERT(ldap_state);
1004                 
1005 #ifndef NO_LDAP_SECURITY
1006         if (geteuid() != 0) {
1007                 DEBUG(0, ("smbldap_open: cannot access LDAP when not root..\n"));
1008                 return  LDAP_INSUFFICIENT_ACCESS;
1009         }
1010 #endif
1011
1012         if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1013
1014 #ifdef HAVE_UNIXSOCKET
1015                 struct sockaddr_un addr;
1016 #else
1017                 struct sockaddr addr;
1018 #endif
1019                 socklen_t len = sizeof(addr);
1020                 int sd;
1021
1022                 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1023                 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1024                         reopen = True;
1025
1026 #ifdef HAVE_UNIXSOCKET
1027                 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1028                         reopen = True;
1029 #endif
1030                 if (reopen) {
1031                         /* the other end has died. reopen. */
1032                         ldap_unbind(ldap_state->ldap_struct);
1033                         ldap_state->ldap_struct = NULL;
1034                         ldap_state->last_ping = (time_t)0;
1035                 } else {
1036                         ldap_state->last_ping = time(NULL);
1037                 } 
1038         }
1039
1040         if (ldap_state->ldap_struct != NULL) {
1041                 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1042                 return LDAP_SUCCESS;
1043         }
1044
1045         if ((rc = smbldap_open_connection(ldap_state))) {
1046                 return rc;
1047         }
1048
1049         if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1050                 ldap_unbind(ldap_state->ldap_struct);
1051                 ldap_state->ldap_struct = NULL;
1052                 return rc;
1053         }
1054
1055
1056         ldap_state->last_ping = time(NULL);
1057         ldap_state->pid = sys_getpid();
1058         DEBUG(4,("The LDAP server is succesfully connected\n"));
1059
1060         return LDAP_SUCCESS;
1061 }
1062
1063 /**********************************************************************
1064 Disconnect from LDAP server 
1065 *********************************************************************/
1066 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1067 {
1068         if (!ldap_state)
1069                 return NT_STATUS_INVALID_PARAMETER;
1070                 
1071         if (ldap_state->ldap_struct != NULL) {
1072                 ldap_unbind(ldap_state->ldap_struct);
1073                 ldap_state->ldap_struct = NULL;
1074         }
1075
1076         smbldap_delete_state(ldap_state);
1077         
1078         DEBUG(5,("The connection to the LDAP server was closed\n"));
1079         /* maybe free the results here --metze */
1080         
1081         
1082
1083         return NT_STATUS_OK;
1084 }
1085
1086 static BOOL got_alarm;
1087
1088 static void (*old_handler)(int);
1089
1090 static void gotalarm_sig(int dummy)
1091 {
1092         got_alarm = True;
1093 }
1094
1095 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1096                             int *attempts, time_t endtime)
1097 {
1098         time_t now = time(NULL);
1099         int open_rc = LDAP_SERVER_DOWN;
1100
1101         if (*rc != LDAP_SERVER_DOWN)
1102                 goto no_next;
1103
1104         if (now >= endtime) {
1105                 smbldap_close(ldap_state);
1106                 *rc = LDAP_TIMEOUT;
1107                 goto no_next;
1108         }
1109
1110         if (*attempts == 0) {
1111                 got_alarm = False;
1112                 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1113                 alarm(endtime - now);
1114
1115                 if (ldap_state->pid != sys_getpid())
1116                         smbldap_close(ldap_state);
1117         }
1118
1119         while (1) {
1120
1121                 if (*attempts != 0)
1122                         smb_msleep(1000);
1123
1124                 *attempts += 1;
1125
1126                 open_rc = smbldap_open(ldap_state);
1127
1128                 if (open_rc == LDAP_SUCCESS) {
1129                         ldap_state->last_use = now;
1130                         return True;
1131                 }
1132
1133                 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1134                         /* The fact that we are non-root or any other
1135                          * access-denied condition will not change in the next
1136                          * round of trying */
1137                         *rc = open_rc;
1138                         break;
1139                 }
1140
1141                 if (got_alarm) {
1142                         *rc = LDAP_TIMEOUT;
1143                         break;
1144                 }
1145
1146                 if (open_rc != LDAP_SUCCESS) {
1147                         DEBUG(1, ("Connection to LDAP server failed for the "
1148                                   "%d try!\n", *attempts));
1149                 }
1150         }
1151
1152  no_next:
1153         CatchSignal(SIGALRM, old_handler);
1154         alarm(0);
1155         ldap_state->last_use = now;
1156         return False;
1157 }
1158
1159 /*********************************************************************
1160  ********************************************************************/
1161
1162 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1163                               const char *base, int scope, const char *filter, 
1164                               const char *attrs[], int attrsonly,
1165                               LDAPControl **sctrls, LDAPControl **cctrls, 
1166                               int sizelimit, LDAPMessage **res)
1167 {
1168         int             rc = LDAP_SERVER_DOWN;
1169         int             attempts = 0;
1170         char           *utf8_filter;
1171         time_t          endtime = time(NULL)+lp_ldap_timeout();
1172         struct          timeval timeout;
1173
1174         SMB_ASSERT(ldap_state);
1175         
1176         DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1177                  "scope => [%d]\n", base, filter, scope));
1178
1179         if (ldap_state->last_rebind.tv_sec > 0) {
1180                 struct timeval  tval;
1181                 SMB_BIG_INT     tdiff = 0;
1182                 int             sleep_time = 0;
1183
1184                 ZERO_STRUCT(tval);
1185                 GetTimeOfDay(&tval);
1186
1187                 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1188                 tdiff /= 1000; /* Convert to milliseconds. */
1189
1190                 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1191                 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1192
1193                 if (sleep_time > 0) {
1194                         /* we wait for the LDAP replication */
1195                         DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1196                                  "for LDAP replication.\n",sleep_time));
1197                         smb_msleep(sleep_time);
1198                         DEBUG(5,("smbldap_search_ext: go on!\n"));
1199                 }
1200                 ZERO_STRUCT(ldap_state->last_rebind);
1201         }
1202
1203         if (push_utf8_allocate(&utf8_filter, filter) == (size_t)-1) {
1204                 return LDAP_NO_MEMORY;
1205         }
1206
1207         /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1208         timeout.tv_sec = lp_ldap_timeout();
1209         timeout.tv_usec = 0;
1210
1211         /* Setup alarm timeout.... Do we need both of these ? JRA.
1212          * Yes, I think we do need both of these. The server timeout only
1213          * covers the case where the server's operation takes too long. It
1214          * does not cover the case where the request hangs on its way to the
1215          * server. The server side timeout is not strictly necessary, it's
1216          * just a bit more kind to the server. VL. */
1217
1218         got_alarm = 0;
1219         CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1220         alarm(lp_ldap_timeout());
1221         /* End setup timeout. */
1222
1223         while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1224                 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope, 
1225                                        utf8_filter,
1226                                        CONST_DISCARD(char **, attrs),
1227                                        attrsonly, sctrls, cctrls, &timeout,
1228                                        sizelimit, res);
1229                 if (rc != LDAP_SUCCESS) {
1230                         char *ld_error = NULL;
1231                         ldap_get_option(ldap_state->ldap_struct,
1232                                         LDAP_OPT_ERROR_STRING, &ld_error);
1233                         DEBUG(10,("Failed search for base: %s, error: %s "
1234                                   "(%s)\n", base, ldap_err2string(rc),
1235                                   ld_error ? ld_error : "unknown"));
1236                         SAFE_FREE(ld_error);
1237                 }
1238         }
1239
1240         SAFE_FREE(utf8_filter);
1241
1242         /* Teardown timeout. */
1243         CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1244         alarm(0);
1245
1246         if (got_alarm != 0)
1247                 return LDAP_TIMELIMIT_EXCEEDED;
1248
1249         return rc;
1250 }
1251
1252 int smbldap_search(struct smbldap_state *ldap_state, 
1253                    const char *base, int scope, const char *filter, 
1254                    const char *attrs[], int attrsonly, 
1255                    LDAPMessage **res)
1256 {
1257         return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1258                                   attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1259 }
1260
1261 int smbldap_search_paged(struct smbldap_state *ldap_state, 
1262                          const char *base, int scope, const char *filter, 
1263                          const char **attrs, int attrsonly, int pagesize,
1264                          LDAPMessage **res, void **cookie)
1265 {
1266         LDAPControl     pr;
1267         LDAPControl     **rcontrols;
1268         LDAPControl     *controls[2] = { NULL, NULL};
1269         BerElement      *cookie_be = NULL;
1270         struct berval   *cookie_bv = NULL;
1271         int             tmp = 0, i, rc;
1272         BOOL            critical = True;
1273
1274         *res = NULL;
1275
1276         DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1277                  "scope => [%d], pagesize => [%d]\n",
1278                  base, filter, scope, pagesize));
1279
1280         cookie_be = ber_alloc_t(LBER_USE_DER);
1281         if (cookie_be == NULL) {
1282                 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1283                          "NULL\n"));
1284                 return LDAP_NO_MEMORY;
1285         }
1286
1287         /* construct cookie */
1288         if (*cookie != NULL) {
1289                 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1290                 ber_bvfree(*cookie); /* don't need it from last time */
1291                 *cookie = NULL;
1292         } else {
1293                 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1294         }
1295         ber_flatten(cookie_be, &cookie_bv);
1296
1297         pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1298         pr.ldctl_iscritical = (char) critical;
1299         pr.ldctl_value.bv_len = cookie_bv->bv_len;
1300         pr.ldctl_value.bv_val = cookie_bv->bv_val;
1301
1302         controls[0] = &pr;
1303         controls[1] = NULL;
1304
1305         rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs, 
1306                                  0, controls, NULL, LDAP_NO_LIMIT, res);
1307
1308         ber_free(cookie_be, 1);
1309         ber_bvfree(cookie_bv);
1310
1311         if (rc != 0) {
1312                 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1313                          "failed with [%s]\n", filter, ldap_err2string(rc)));
1314                 goto done;
1315         }
1316
1317         DEBUG(3,("smbldap_search_paged: search was successfull\n"));
1318
1319         rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL, 
1320                                NULL, NULL, &rcontrols,  0);
1321         if (rc != 0) {
1322                 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1323                          "with [%s]\n", ldap_err2string(rc)));
1324                 goto done;
1325         }
1326
1327         if (rcontrols == NULL)
1328                 goto done;
1329
1330         for (i=0; rcontrols[i]; i++) {
1331
1332                 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1333                         continue;
1334
1335                 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1336                 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1337                 /* the berval is the cookie, but must be freed when it is all
1338                    done */
1339                 if (cookie_bv->bv_len)
1340                         *cookie=ber_bvdup(cookie_bv);
1341                 else
1342                         *cookie=NULL;
1343                 ber_bvfree(cookie_bv);
1344                 ber_free(cookie_be, 1);
1345                 break;
1346         }
1347         ldap_controls_free(rcontrols);
1348 done:   
1349         return rc;
1350 }
1351
1352 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1353 {
1354         int             rc = LDAP_SERVER_DOWN;
1355         int             attempts = 0;
1356         char           *utf8_dn;
1357         time_t          endtime = time(NULL)+lp_ldap_timeout();
1358
1359         SMB_ASSERT(ldap_state);
1360
1361         DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1362
1363         if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1364                 return LDAP_NO_MEMORY;
1365         }
1366
1367         while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1368                 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1369                 if (rc != LDAP_SUCCESS) {
1370                         char *ld_error = NULL;
1371                         ldap_get_option(ldap_state->ldap_struct,
1372                                         LDAP_OPT_ERROR_STRING, &ld_error);
1373                         DEBUG(10,("Failed to modify dn: %s, error: %s "
1374                                   "(%s)\n", dn, ldap_err2string(rc),
1375                                   ld_error ? ld_error : "unknown"));
1376                         SAFE_FREE(ld_error);
1377                 }
1378         }
1379                 
1380         SAFE_FREE(utf8_dn);
1381         return rc;
1382 }
1383
1384 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1385 {
1386         int             rc = LDAP_SERVER_DOWN;
1387         int             attempts = 0;
1388         char           *utf8_dn;
1389         time_t          endtime = time(NULL)+lp_ldap_timeout();
1390         
1391         SMB_ASSERT(ldap_state);
1392
1393         DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1394
1395         if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1396                 return LDAP_NO_MEMORY;
1397         }
1398
1399         while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1400                 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1401                 if (rc != LDAP_SUCCESS) {
1402                         char *ld_error = NULL;
1403                         ldap_get_option(ldap_state->ldap_struct,
1404                                         LDAP_OPT_ERROR_STRING, &ld_error);
1405                         DEBUG(10,("Failed to add dn: %s, error: %s "
1406                                   "(%s)\n", dn, ldap_err2string(rc),
1407                                   ld_error ? ld_error : "unknown"));
1408                         SAFE_FREE(ld_error);
1409                 }
1410         }
1411         
1412         SAFE_FREE(utf8_dn);
1413         return rc;
1414 }
1415
1416 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1417 {
1418         int             rc = LDAP_SERVER_DOWN;
1419         int             attempts = 0;
1420         char           *utf8_dn;
1421         time_t          endtime = time(NULL)+lp_ldap_timeout();
1422         
1423         SMB_ASSERT(ldap_state);
1424
1425         DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1426
1427         if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1428                 return LDAP_NO_MEMORY;
1429         }
1430
1431         while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1432                 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1433                 if (rc != LDAP_SUCCESS) {
1434                         char *ld_error = NULL;
1435                         ldap_get_option(ldap_state->ldap_struct,
1436                                         LDAP_OPT_ERROR_STRING, &ld_error);
1437                         DEBUG(10,("Failed to delete dn: %s, error: %s "
1438                                   "(%s)\n", dn, ldap_err2string(rc),
1439                                   ld_error ? ld_error : "unknown"));
1440                         SAFE_FREE(ld_error);
1441                 }
1442         }
1443         
1444         SAFE_FREE(utf8_dn);
1445         return rc;
1446 }
1447
1448 int smbldap_extended_operation(struct smbldap_state *ldap_state, 
1449                                LDAP_CONST char *reqoid, struct berval *reqdata, 
1450                                LDAPControl **serverctrls, LDAPControl **clientctrls, 
1451                                char **retoidp, struct berval **retdatap)
1452 {
1453         int             rc = LDAP_SERVER_DOWN;
1454         int             attempts = 0;
1455         time_t          endtime = time(NULL)+lp_ldap_timeout();
1456         
1457         if (!ldap_state)
1458                 return (-1);
1459
1460         while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1461                 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1462                                                reqdata, serverctrls,
1463                                                clientctrls, retoidp, retdatap);
1464                 if (rc != LDAP_SUCCESS) {
1465                         char *ld_error = NULL;
1466                         ldap_get_option(ldap_state->ldap_struct,
1467                                         LDAP_OPT_ERROR_STRING, &ld_error);
1468                         DEBUG(10,("Extended operation failed with error: %s "
1469                                   "(%s)\n", ldap_err2string(rc),
1470                                   ld_error ? ld_error : "unknown"));
1471                         SAFE_FREE(ld_error);
1472                 }
1473         }
1474                 
1475         return rc;
1476 }
1477
1478 /*******************************************************************
1479  run the search by name.
1480 ******************************************************************/
1481 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1482                            const char *filter, const char **search_attr,
1483                            LDAPMessage ** result)
1484 {
1485         return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1486                               filter, search_attr, 0, result);
1487 }
1488
1489 static void smbldap_idle_fn(void **data, time_t *interval, time_t now)
1490 {
1491         struct smbldap_state *state = (struct smbldap_state *)(*data);
1492
1493         if (state->ldap_struct == NULL) {
1494                 DEBUG(10,("ldap connection not connected...\n"));
1495                 return;
1496         }
1497                 
1498         if ((state->last_use+SMBLDAP_IDLE_TIME) > now) {
1499                 DEBUG(10,("ldap connection not idle...\n"));
1500                 return;
1501         }
1502                 
1503         DEBUG(7,("ldap connection idle...closing connection\n"));
1504         smbldap_close(state);
1505 }
1506
1507 /**********************************************************************
1508  Housekeeping
1509  *********************************************************************/
1510
1511 void smbldap_free_struct(struct smbldap_state **ldap_state) 
1512 {
1513         smbldap_close(*ldap_state);
1514         
1515         if ((*ldap_state)->bind_secret) {
1516                 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1517         }
1518
1519         SAFE_FREE((*ldap_state)->bind_dn);
1520         SAFE_FREE((*ldap_state)->bind_secret);
1521
1522         smb_unregister_idle_event((*ldap_state)->event_id);
1523
1524         *ldap_state = NULL;
1525
1526         /* No need to free any further, as it is talloc()ed */
1527 }
1528
1529
1530 /**********************************************************************
1531  Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1532  *********************************************************************/
1533
1534 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, const char *location, struct smbldap_state **smbldap_state) 
1535 {
1536         *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1537         if (!*smbldap_state) {
1538                 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1539                 return NT_STATUS_NO_MEMORY;
1540         }
1541
1542         if (location) {
1543                 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1544         } else {
1545                 (*smbldap_state)->uri = "ldap://localhost";
1546         }
1547
1548         (*smbldap_state)->event_id =
1549                 smb_register_idle_event(smbldap_idle_fn, (void *)(*smbldap_state),
1550                                         SMBLDAP_IDLE_TIME);
1551
1552         if ((*smbldap_state)->event_id == SMB_EVENT_ID_INVALID) {
1553                 DEBUG(0,("Failed to register LDAP idle event!\n"));
1554                 return NT_STATUS_INVALID_HANDLE;
1555         }
1556
1557         return NT_STATUS_OK;
1558 }
1559
1560 /*******************************************************************
1561  Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1562 ********************************************************************/
1563 char *smbldap_get_dn(LDAP *ld, LDAPMessage *entry)
1564 {
1565         char *utf8_dn, *unix_dn;
1566
1567         utf8_dn = ldap_get_dn(ld, entry);
1568         if (!utf8_dn) {
1569                 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1570                 return NULL;
1571         }
1572         if (pull_utf8_allocate(&unix_dn, utf8_dn) == (size_t)-1) {
1573                 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 [%s]\n", utf8_dn));
1574                 return NULL;
1575         }
1576         ldap_memfree(utf8_dn);
1577         return unix_dn;
1578 }
1579
1580  const char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1581                                LDAPMessage *entry)
1582 {
1583         char *utf8_dn, *unix_dn;
1584
1585         utf8_dn = ldap_get_dn(ld, entry);
1586         if (!utf8_dn) {
1587                 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1588                 return NULL;
1589         }
1590         if (pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn) == (size_t)-1) {
1591                 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1592                            "[%s]\n", utf8_dn));
1593                 return NULL;
1594         }
1595         ldap_memfree(utf8_dn);
1596         return unix_dn;
1597 }
1598
1599 /*******************************************************************
1600  Check if root-dse has a certain Control or Extension
1601 ********************************************************************/
1602
1603 static BOOL smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value) 
1604 {
1605         LDAPMessage *msg = NULL;
1606         LDAPMessage *entry = NULL;
1607         char **values = NULL;
1608         int rc, num_result, num_values, i;
1609         BOOL result = False;
1610
1611         if (!attrs[0]) {
1612                 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1613                 return False;
1614         }
1615
1616         if (!strequal(attrs[0], "supportedExtension") && 
1617             !strequal(attrs[0], "supportedControl") && 
1618             !strequal(attrs[0], "namingContexts")) {
1619                 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1620                 return False;
1621         }
1622
1623         rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE, 
1624                            "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1625
1626         if (rc != LDAP_SUCCESS) {
1627                 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1628                 return False;
1629         }
1630
1631         num_result = ldap_count_entries(ld, msg);
1632
1633         if (num_result != 1) {
1634                 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1635                 goto done;
1636         }
1637
1638         entry = ldap_first_entry(ld, msg);
1639
1640         if (entry == NULL) {
1641                 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1642                 goto done;
1643         }
1644
1645         values = ldap_get_values(ld, entry, attrs[0]);
1646
1647         if (values == NULL) {
1648                 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1649                 goto done;
1650         }
1651
1652         num_values = ldap_count_values(values);
1653
1654         if (num_values == 0) {
1655                 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1656                 goto done;
1657         }
1658
1659         for (i=0; i<num_values; i++) {
1660                 if (strcmp(values[i], value) == 0)
1661                         result = True;
1662         }
1663
1664
1665  done:
1666         if (values != NULL)
1667                 ldap_value_free(values);
1668         if (msg != NULL)
1669                 ldap_msgfree(msg);
1670
1671         return result;
1672
1673 }
1674
1675 /*******************************************************************
1676  Check if LDAP-Server supports a certain Control (OID in string format)
1677 ********************************************************************/
1678
1679 BOOL smbldap_has_control(LDAP *ld, const char *control)
1680 {
1681         const char *attrs[] = { "supportedControl", NULL };
1682         return smbldap_check_root_dse(ld, attrs, control);
1683 }
1684
1685 /*******************************************************************
1686  Check if LDAP-Server supports a certain Extension (OID in string format)
1687 ********************************************************************/
1688
1689 BOOL smbldap_has_extension(LDAP *ld, const char *extension)
1690 {
1691         const char *attrs[] = { "supportedExtension", NULL };
1692         return smbldap_check_root_dse(ld, attrs, extension);
1693 }
1694
1695 /*******************************************************************
1696  Check if LDAP-Server holds a given namingContext
1697 ********************************************************************/
1698
1699 BOOL smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1700 {
1701         const char *attrs[] = { "namingContexts", NULL };
1702         return smbldap_check_root_dse(ld, attrs, naming_context);
1703 }