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