r17924: Get rid of warnings now that talloc is merged.
[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 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_SN,                 "sn"            },
56         { LDAP_ATTR_DISPLAY_NAME,       "displayName"   },
57         { LDAP_ATTR_HOME_PATH,          "smbHome"       },
58         { LDAP_ATTR_HOME_DRIVE,         "homeDrive"     },
59         { LDAP_ATTR_LOGON_SCRIPT,       "scriptPath"    },
60         { LDAP_ATTR_PROFILE_PATH,       "profilePath"   },
61         { LDAP_ATTR_DESC,               "description"   },
62         { LDAP_ATTR_USER_WKS,           "userWorkstations"},
63         { LDAP_ATTR_USER_RID,           "rid"           },
64         { LDAP_ATTR_PRIMARY_GROUP_RID,  "primaryGroupID"},
65         { LDAP_ATTR_LMPW,               "lmPassword"    },
66         { LDAP_ATTR_NTPW,               "ntPassword"    },
67         { LDAP_ATTR_DOMAIN,             "domain"        },
68         { LDAP_ATTR_OBJCLASS,           "objectClass"   },
69         { LDAP_ATTR_ACB_INFO,           "acctFlags"     },
70         { LDAP_ATTR_MOD_TIMESTAMP,      "modifyTimestamp"       },
71         { LDAP_ATTR_LIST_END,           NULL            }
72 };
73
74 ATTRIB_MAP_ENTRY attrib_map_to_delete_v22[] = {
75         { LDAP_ATTR_PWD_LAST_SET,       "pwdLastSet"    },
76         { LDAP_ATTR_PWD_CAN_CHANGE,     "pwdCanChange"  },
77         { LDAP_ATTR_PWD_MUST_CHANGE,    "pwdMustChange" },
78         { LDAP_ATTR_LOGON_TIME,         "logonTime"     },
79         { LDAP_ATTR_LOGOFF_TIME,        "logoffTime"    },
80         { LDAP_ATTR_KICKOFF_TIME,       "kickoffTime"   },
81         { LDAP_ATTR_DISPLAY_NAME,       "displayName"   },
82         { LDAP_ATTR_HOME_PATH,          "smbHome"       },
83         { LDAP_ATTR_HOME_DRIVE,         "homeDrives"    },
84         { LDAP_ATTR_LOGON_SCRIPT,       "scriptPath"    },
85         { LDAP_ATTR_PROFILE_PATH,       "profilePath"   },
86         { LDAP_ATTR_USER_WKS,           "userWorkstations"},
87         { LDAP_ATTR_USER_RID,           "rid"           },
88         { LDAP_ATTR_PRIMARY_GROUP_RID,  "primaryGroupID"},
89         { LDAP_ATTR_LMPW,               "lmPassword"    },
90         { LDAP_ATTR_NTPW,               "ntPassword"    },
91         { LDAP_ATTR_DOMAIN,             "domain"        },
92         { LDAP_ATTR_ACB_INFO,           "acctFlags"     },
93         { LDAP_ATTR_LIST_END,           NULL            }
94 };
95
96 /* attributes used by Samba 3.0's sambaSamAccount */
97
98 ATTRIB_MAP_ENTRY attrib_map_v30[] = {
99         { LDAP_ATTR_UID,                "uid"                   },
100         { LDAP_ATTR_UIDNUMBER,          LDAP_ATTRIBUTE_UIDNUMBER},
101         { LDAP_ATTR_GIDNUMBER,          LDAP_ATTRIBUTE_GIDNUMBER},
102         { LDAP_ATTR_UNIX_HOME,          "homeDirectory"         },
103         { LDAP_ATTR_PWD_LAST_SET,       "sambaPwdLastSet"       },
104         { LDAP_ATTR_PWD_CAN_CHANGE,     "sambaPwdCanChange"     },
105         { LDAP_ATTR_PWD_MUST_CHANGE,    "sambaPwdMustChange"    },
106         { LDAP_ATTR_LOGON_TIME,         "sambaLogonTime"        },
107         { LDAP_ATTR_LOGOFF_TIME,        "sambaLogoffTime"       },
108         { LDAP_ATTR_KICKOFF_TIME,       "sambaKickoffTime"      },
109         { LDAP_ATTR_CN,                 "cn"                    },
110         { LDAP_ATTR_SN,                 "sn"                    },
111         { LDAP_ATTR_DISPLAY_NAME,       "displayName"           },
112         { LDAP_ATTR_HOME_DRIVE,         "sambaHomeDrive"        },
113         { LDAP_ATTR_HOME_PATH,          "sambaHomePath"         },
114         { LDAP_ATTR_LOGON_SCRIPT,       "sambaLogonScript"      },
115         { LDAP_ATTR_PROFILE_PATH,       "sambaProfilePath"      },
116         { LDAP_ATTR_DESC,               "description"           },
117         { LDAP_ATTR_USER_WKS,           "sambaUserWorkstations" },
118         { LDAP_ATTR_USER_SID,           LDAP_ATTRIBUTE_SID      },
119         { LDAP_ATTR_PRIMARY_GROUP_SID,  "sambaPrimaryGroupSID"  },
120         { LDAP_ATTR_LMPW,               "sambaLMPassword"       },
121         { LDAP_ATTR_NTPW,               "sambaNTPassword"       },
122         { LDAP_ATTR_DOMAIN,             "sambaDomainName"       },
123         { LDAP_ATTR_OBJCLASS,           "objectClass"           },
124         { LDAP_ATTR_ACB_INFO,           "sambaAcctFlags"        },
125         { LDAP_ATTR_MUNGED_DIAL,        "sambaMungedDial"       },
126         { LDAP_ATTR_BAD_PASSWORD_COUNT, "sambaBadPasswordCount" },
127         { LDAP_ATTR_BAD_PASSWORD_TIME,  "sambaBadPasswordTime"  },
128         { LDAP_ATTR_PWD_HISTORY,        "sambaPasswordHistory"  },
129         { LDAP_ATTR_MOD_TIMESTAMP,      "modifyTimestamp"       },
130         { LDAP_ATTR_LOGON_HOURS,        "sambaLogonHours"       },
131         { LDAP_ATTR_LIST_END,           NULL                    }
132 };
133
134 ATTRIB_MAP_ENTRY attrib_map_to_delete_v30[] = {
135         { LDAP_ATTR_PWD_LAST_SET,       "sambaPwdLastSet"       },
136         { LDAP_ATTR_PWD_CAN_CHANGE,     "sambaPwdCanChange"     },
137         { LDAP_ATTR_PWD_MUST_CHANGE,    "sambaPwdMustChange"    },
138         { LDAP_ATTR_LOGON_TIME,         "sambaLogonTime"        },
139         { LDAP_ATTR_LOGOFF_TIME,        "sambaLogoffTime"       },
140         { LDAP_ATTR_KICKOFF_TIME,       "sambaKickoffTime"      },
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  BOOL smbldap_get_single_pstring (LDAP * ldap_struct, LDAPMessage * entry,
296                                   const char *attribute, pstring value)
297 {
298         return smbldap_get_single_attribute(ldap_struct, entry,
299                                             attribute, value, 
300                                             sizeof(pstring));
301 }
302
303  char * smbldap_talloc_single_attribute(LDAP *ldap_struct, LDAPMessage *entry,
304                                         const char *attribute,
305                                         TALLOC_CTX *mem_ctx)
306 {
307         char **values;
308         char *result;
309
310         if (attribute == NULL) {
311                 return NULL;
312         }
313
314         values = ldap_get_values(ldap_struct, entry, attribute);
315
316         if (values == NULL) {
317                 DEBUG(10, ("attribute %s does not exist\n", attribute));
318                 return NULL;
319         }
320
321         if (ldap_count_values(values) != 1) {
322                 DEBUG(10, ("attribute %s has %d values, expected only one\n",
323                            attribute, ldap_count_values(values)));
324                 ldap_value_free(values);
325                 return NULL;
326         }
327
328         if (pull_utf8_talloc(mem_ctx, &result, values[0]) == (size_t)-1) {
329                 DEBUG(10, ("pull_utf8_talloc failed\n"));
330                 ldap_value_free(values);
331                 return NULL;
332         }
333
334         ldap_value_free(values);
335
336 #ifdef DEBUG_PASSWORDS
337         DEBUG (100, ("smbldap_get_single_attribute: [%s] = [%s]\n",
338                      attribute, result));
339 #endif  
340         return result;
341 }
342
343  static int ldapmsg_destructor(LDAPMessage **result) {
344         ldap_msgfree(*result);
345         return 0;
346 }
347
348  void talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result)
349 {
350         LDAPMessage **handle;
351
352         if (result == NULL) {
353                 return;
354         }
355
356         handle = TALLOC_P(mem_ctx, LDAPMessage *);
357         SMB_ASSERT(handle != NULL);
358
359         *handle = result;
360         talloc_set_destructor(handle, ldapmsg_destructor);
361 }
362
363  static int ldapmod_destructor(LDAPMod ***mod) {
364         ldap_mods_free(*mod, 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 =
843                 (struct smbldap_state *)arg;
844         int rc;
845         int version;
846
847         DEBUG(5,("rebindproc_connect_with_state: Rebinding to %s as \"%s\"\n", 
848                  url, ldap_state->bind_dn));
849
850         /* call START_TLS again (ldaps:// is handled by the OpenLDAP library
851          * itself) before rebinding to another LDAP server to avoid to expose
852          * our credentials. At least *try* to secure the connection - Guenther */
853
854         smb_ldap_upgrade_conn(ldap_struct, &version);
855         smb_ldap_start_tls(ldap_struct, version);
856
857         /** @TODO Should we be doing something to check what servers we rebind to?
858             Could we get a referral to a machine that we don't want to give our
859             username and password to? */
860
861         rc = ldap_simple_bind_s(ldap_struct, ldap_state->bind_dn, ldap_state->bind_secret);
862
863         /* only set the last rebind timestamp when we did rebind after a
864          * non-read LDAP operation. That way we avoid the replication sleep
865          * after a simple redirected search operation - Guenther */
866
867         switch (request) {
868
869                 case LDAP_REQ_MODIFY:
870                 case LDAP_REQ_ADD:
871                 case LDAP_REQ_DELETE:
872                 case LDAP_REQ_MODDN:
873                 case LDAP_REQ_EXTENDED:
874                         DEBUG(10,("rebindproc_connect_with_state: "
875                                 "setting last_rebind timestamp "
876                                 "(req: 0x%02x)\n", (unsigned int)request));
877                         GetTimeOfDay(&ldap_state->last_rebind);
878                         break;
879                 default:
880                         ZERO_STRUCT(ldap_state->last_rebind);
881                         break;
882         }
883
884         return rc;
885 }
886 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
887
888 /*******************************************************************
889  Add a rebind function for authenticated referrals
890 ******************************************************************/
891 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
892 #else
893 # if LDAP_SET_REBIND_PROC_ARGS == 2
894 static int rebindproc (LDAP *ldap_struct, char **whop, char **credp,
895                        int *method, int freeit )
896 {
897         struct smbldap_state *ldap_state = smbldap_find_state(ldap_struct);
898
899         return rebindproc_with_state(ldap_struct, whop, credp,
900                                      method, freeit, ldap_state);
901         
902 }
903 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
904 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
905
906 /*******************************************************************
907  a rebind function for authenticated referrals
908  this also does the connection, but no void*.
909 ******************************************************************/
910 #if defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)
911 # if LDAP_SET_REBIND_PROC_ARGS == 2
912 static int rebindproc_connect (LDAP * ld, LDAP_CONST char *url, int request,
913                                ber_int_t msgid)
914 {
915         struct smbldap_state *ldap_state = smbldap_find_state(ld);
916
917         return rebindproc_connect_with_state(ld, url, (ber_tag_t)request, msgid, 
918                                              ldap_state);
919 }
920 # endif /*LDAP_SET_REBIND_PROC_ARGS == 2*/
921 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
922
923 /*******************************************************************
924  connect to the ldap server under system privilege.
925 ******************************************************************/
926 static int smbldap_connect_system(struct smbldap_state *ldap_state, LDAP * ldap_struct)
927 {
928         int rc;
929         char *ldap_dn;
930         char *ldap_secret;
931         int version;
932
933         /* get the password */
934         if (!fetch_ldap_pw(&ldap_dn, &ldap_secret)) {
935                 DEBUG(0, ("ldap_connect_system: Failed to retrieve password from secrets.tdb\n"));
936                 return LDAP_INVALID_CREDENTIALS;
937         }
938
939         ldap_state->bind_dn = ldap_dn;
940         ldap_state->bind_secret = ldap_secret;
941
942         /* removed the sasl_bind_s "EXTERNAL" stuff, as my testsuite 
943            (OpenLDAP) doesnt' seem to support it */
944            
945         DEBUG(10,("ldap_connect_system: Binding to ldap server %s as \"%s\"\n",
946                   ldap_state->uri, ldap_dn));
947
948 #ifdef HAVE_LDAP_SET_REBIND_PROC
949 #if 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_connect); 
952 # endif
953 # if LDAP_SET_REBIND_PROC_ARGS == 3     
954         ldap_set_rebind_proc(ldap_struct, &rebindproc_connect_with_state, (void *)ldap_state);  
955 # endif
956 #else /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
957 # if LDAP_SET_REBIND_PROC_ARGS == 2     
958         ldap_set_rebind_proc(ldap_struct, &rebindproc); 
959 # endif
960 # if LDAP_SET_REBIND_PROC_ARGS == 3     
961         ldap_set_rebind_proc(ldap_struct, &rebindproc_with_state, (void *)ldap_state);  
962 # endif
963 #endif /*defined(LDAP_API_FEATURE_X_OPENLDAP) && (LDAP_API_VERSION > 2000)*/
964 #endif
965
966         rc = ldap_simple_bind_s(ldap_struct, ldap_dn, ldap_secret);
967
968         if (rc != LDAP_SUCCESS) {
969                 char *ld_error = NULL;
970                 ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_ERROR_STRING,
971                                 &ld_error);
972                 DEBUG(ldap_state->num_failures ? 2 : 0,
973                       ("failed to bind to server %s with dn=\"%s\" Error: %s\n\t%s\n",
974                                ldap_state->uri,
975                                ldap_dn ? ldap_dn : "(unknown)", ldap_err2string(rc),
976                                ld_error ? ld_error : "(unknown)"));
977                 SAFE_FREE(ld_error);
978                 ldap_state->num_failures++;
979                 return rc;
980         }
981
982         ldap_state->num_failures = 0;
983         ldap_state->paged_results = False;
984
985         ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_PROTOCOL_VERSION, &version);
986
987         if (smbldap_has_control(ldap_state->ldap_struct, ADS_PAGE_CTL_OID) && version == 3) {
988                 ldap_state->paged_results = True;
989         }
990
991         DEBUG(3, ("ldap_connect_system: succesful connection to the LDAP server\n"));
992         DEBUGADD(10, ("ldap_connect_system: LDAP server %s support paged results\n", 
993                 ldap_state->paged_results ? "does" : "does not"));
994         return rc;
995 }
996
997 /**********************************************************************
998  Connect to LDAP server (called before every ldap operation)
999 *********************************************************************/
1000 static int smbldap_open(struct smbldap_state *ldap_state)
1001 {
1002         int rc, opt_rc;
1003         BOOL reopen = False;
1004         SMB_ASSERT(ldap_state);
1005                 
1006 #ifndef NO_LDAP_SECURITY
1007         if (geteuid() != 0) {
1008                 DEBUG(0, ("smbldap_open: cannot access LDAP when not root..\n"));
1009                 return  LDAP_INSUFFICIENT_ACCESS;
1010         }
1011 #endif
1012
1013         if ((ldap_state->ldap_struct != NULL) && ((ldap_state->last_ping + SMBLDAP_DONT_PING_TIME) < time(NULL))) {
1014
1015 #ifdef HAVE_UNIXSOCKET
1016                 struct sockaddr_un addr;
1017 #else
1018                 struct sockaddr addr;
1019 #endif
1020                 socklen_t len = sizeof(addr);
1021                 int sd;
1022
1023                 opt_rc = ldap_get_option(ldap_state->ldap_struct, LDAP_OPT_DESC, &sd);
1024                 if (opt_rc == 0 && (getpeername(sd, (struct sockaddr *) &addr, &len)) < 0 )
1025                         reopen = True;
1026
1027 #ifdef HAVE_UNIXSOCKET
1028                 if (opt_rc == 0 && addr.sun_family == AF_UNIX)
1029                         reopen = True;
1030 #endif
1031                 if (reopen) {
1032                         /* the other end has died. reopen. */
1033                         ldap_unbind(ldap_state->ldap_struct);
1034                         ldap_state->ldap_struct = NULL;
1035                         ldap_state->last_ping = (time_t)0;
1036                 } else {
1037                         ldap_state->last_ping = time(NULL);
1038                 } 
1039         }
1040
1041         if (ldap_state->ldap_struct != NULL) {
1042                 DEBUG(11,("smbldap_open: already connected to the LDAP server\n"));
1043                 return LDAP_SUCCESS;
1044         }
1045
1046         if ((rc = smbldap_open_connection(ldap_state))) {
1047                 return rc;
1048         }
1049
1050         if ((rc = smbldap_connect_system(ldap_state, ldap_state->ldap_struct))) {
1051                 ldap_unbind(ldap_state->ldap_struct);
1052                 ldap_state->ldap_struct = NULL;
1053                 return rc;
1054         }
1055
1056
1057         ldap_state->last_ping = time(NULL);
1058         ldap_state->pid = sys_getpid();
1059         DEBUG(4,("The LDAP server is succesfully connected\n"));
1060
1061         return LDAP_SUCCESS;
1062 }
1063
1064 /**********************************************************************
1065 Disconnect from LDAP server 
1066 *********************************************************************/
1067 static NTSTATUS smbldap_close(struct smbldap_state *ldap_state)
1068 {
1069         if (!ldap_state)
1070                 return NT_STATUS_INVALID_PARAMETER;
1071                 
1072         if (ldap_state->ldap_struct != NULL) {
1073                 ldap_unbind(ldap_state->ldap_struct);
1074                 ldap_state->ldap_struct = NULL;
1075         }
1076
1077         smbldap_delete_state(ldap_state);
1078         
1079         DEBUG(5,("The connection to the LDAP server was closed\n"));
1080         /* maybe free the results here --metze */
1081         
1082         
1083
1084         return NT_STATUS_OK;
1085 }
1086
1087 static BOOL got_alarm;
1088
1089 static void (*old_handler)(int);
1090
1091 static void gotalarm_sig(int dummy)
1092 {
1093         got_alarm = True;
1094 }
1095
1096 static int another_ldap_try(struct smbldap_state *ldap_state, int *rc,
1097                             int *attempts, time_t endtime)
1098 {
1099         time_t now = time(NULL);
1100         int open_rc = LDAP_SERVER_DOWN;
1101
1102         if (*rc != LDAP_SERVER_DOWN)
1103                 goto no_next;
1104
1105         if (now >= endtime) {
1106                 smbldap_close(ldap_state);
1107                 *rc = LDAP_TIMEOUT;
1108                 goto no_next;
1109         }
1110
1111         if (*attempts == 0) {
1112                 got_alarm = False;
1113                 old_handler = CatchSignal(SIGALRM, gotalarm_sig);
1114                 alarm(endtime - now);
1115
1116                 if (ldap_state->pid != sys_getpid())
1117                         smbldap_close(ldap_state);
1118         }
1119
1120         while (1) {
1121
1122                 if (*attempts != 0)
1123                         smb_msleep(1000);
1124
1125                 *attempts += 1;
1126
1127                 open_rc = smbldap_open(ldap_state);
1128
1129                 if (open_rc == LDAP_SUCCESS) {
1130                         ldap_state->last_use = now;
1131                         return True;
1132                 }
1133
1134                 if (open_rc == LDAP_INSUFFICIENT_ACCESS) {
1135                         /* The fact that we are non-root or any other
1136                          * access-denied condition will not change in the next
1137                          * round of trying */
1138                         *rc = open_rc;
1139                         break;
1140                 }
1141
1142                 if (got_alarm) {
1143                         *rc = LDAP_TIMEOUT;
1144                         break;
1145                 }
1146
1147                 if (open_rc != LDAP_SUCCESS) {
1148                         DEBUG(1, ("Connection to LDAP server failed for the "
1149                                   "%d try!\n", *attempts));
1150                 }
1151         }
1152
1153  no_next:
1154         CatchSignal(SIGALRM, old_handler);
1155         alarm(0);
1156         ldap_state->last_use = now;
1157         return False;
1158 }
1159
1160 /*********************************************************************
1161  ********************************************************************/
1162
1163 static int smbldap_search_ext(struct smbldap_state *ldap_state,
1164                               const char *base, int scope, const char *filter, 
1165                               const char *attrs[], int attrsonly,
1166                               LDAPControl **sctrls, LDAPControl **cctrls, 
1167                               int sizelimit, LDAPMessage **res)
1168 {
1169         int             rc = LDAP_SERVER_DOWN;
1170         int             attempts = 0;
1171         char           *utf8_filter;
1172         time_t          endtime = time(NULL)+lp_ldap_timeout();
1173         struct          timeval timeout;
1174
1175         SMB_ASSERT(ldap_state);
1176         
1177         DEBUG(5,("smbldap_search_ext: base => [%s], filter => [%s], "
1178                  "scope => [%d]\n", base, filter, scope));
1179
1180         if (ldap_state->last_rebind.tv_sec > 0) {
1181                 struct timeval  tval;
1182                 SMB_BIG_INT     tdiff = 0;
1183                 int             sleep_time = 0;
1184
1185                 ZERO_STRUCT(tval);
1186                 GetTimeOfDay(&tval);
1187
1188                 tdiff = usec_time_diff(&tval, &ldap_state->last_rebind);
1189                 tdiff /= 1000; /* Convert to milliseconds. */
1190
1191                 sleep_time = lp_ldap_replication_sleep()-(int)tdiff;
1192                 sleep_time = MIN(sleep_time, MAX_LDAP_REPLICATION_SLEEP_TIME);
1193
1194                 if (sleep_time > 0) {
1195                         /* we wait for the LDAP replication */
1196                         DEBUG(5,("smbldap_search_ext: waiting %d milliseconds "
1197                                  "for LDAP replication.\n",sleep_time));
1198                         smb_msleep(sleep_time);
1199                         DEBUG(5,("smbldap_search_ext: go on!\n"));
1200                 }
1201                 ZERO_STRUCT(ldap_state->last_rebind);
1202         }
1203
1204         if (push_utf8_allocate(&utf8_filter, filter) == (size_t)-1) {
1205                 return LDAP_NO_MEMORY;
1206         }
1207
1208         /* Setup timeout for the ldap_search_ext_s call - local and remote. */
1209         timeout.tv_sec = lp_ldap_timeout();
1210         timeout.tv_usec = 0;
1211
1212         /* Setup alarm timeout.... Do we need both of these ? JRA.
1213          * Yes, I think we do need both of these. The server timeout only
1214          * covers the case where the server's operation takes too long. It
1215          * does not cover the case where the request hangs on its way to the
1216          * server. The server side timeout is not strictly necessary, it's
1217          * just a bit more kind to the server. VL. */
1218
1219         got_alarm = 0;
1220         CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
1221         alarm(lp_ldap_timeout());
1222         /* End setup timeout. */
1223
1224         while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1225                 rc = ldap_search_ext_s(ldap_state->ldap_struct, base, scope, 
1226                                        utf8_filter,
1227                                        CONST_DISCARD(char **, attrs),
1228                                        attrsonly, sctrls, cctrls, &timeout,
1229                                        sizelimit, res);
1230                 if (rc != LDAP_SUCCESS) {
1231                         char *ld_error = NULL;
1232                         ldap_get_option(ldap_state->ldap_struct,
1233                                         LDAP_OPT_ERROR_STRING, &ld_error);
1234                         DEBUG(10,("Failed search for base: %s, error: %s "
1235                                   "(%s)\n", base, ldap_err2string(rc),
1236                                   ld_error ? ld_error : "unknown"));
1237                         SAFE_FREE(ld_error);
1238                 }
1239         }
1240
1241         SAFE_FREE(utf8_filter);
1242
1243         /* Teardown timeout. */
1244         CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
1245         alarm(0);
1246
1247         if (got_alarm != 0)
1248                 return LDAP_TIMELIMIT_EXCEEDED;
1249
1250         return rc;
1251 }
1252
1253 int smbldap_search(struct smbldap_state *ldap_state, 
1254                    const char *base, int scope, const char *filter, 
1255                    const char *attrs[], int attrsonly, 
1256                    LDAPMessage **res)
1257 {
1258         return smbldap_search_ext(ldap_state, base, scope, filter, attrs,
1259                                   attrsonly, NULL, NULL, LDAP_NO_LIMIT, res);
1260 }
1261
1262 int smbldap_search_paged(struct smbldap_state *ldap_state, 
1263                          const char *base, int scope, const char *filter, 
1264                          const char **attrs, int attrsonly, int pagesize,
1265                          LDAPMessage **res, void **cookie)
1266 {
1267         LDAPControl     pr;
1268         LDAPControl     **rcontrols;
1269         LDAPControl     *controls[2] = { NULL, NULL};
1270         BerElement      *cookie_be = NULL;
1271         struct berval   *cookie_bv = NULL;
1272         int             tmp = 0, i, rc;
1273         BOOL            critical = True;
1274
1275         *res = NULL;
1276
1277         DEBUG(3,("smbldap_search_paged: base => [%s], filter => [%s],"
1278                  "scope => [%d], pagesize => [%d]\n",
1279                  base, filter, scope, pagesize));
1280
1281         cookie_be = ber_alloc_t(LBER_USE_DER);
1282         if (cookie_be == NULL) {
1283                 DEBUG(0,("smbldap_create_page_control: ber_alloc_t returns "
1284                          "NULL\n"));
1285                 return LDAP_NO_MEMORY;
1286         }
1287
1288         /* construct cookie */
1289         if (*cookie != NULL) {
1290                 ber_printf(cookie_be, "{iO}", (ber_int_t) pagesize, *cookie);
1291                 ber_bvfree((struct berval *)*cookie); /* don't need it from last time */
1292                 *cookie = NULL;
1293         } else {
1294                 ber_printf(cookie_be, "{io}", (ber_int_t) pagesize, "", 0);
1295         }
1296         ber_flatten(cookie_be, &cookie_bv);
1297
1298         pr.ldctl_oid = CONST_DISCARD(char *, ADS_PAGE_CTL_OID);
1299         pr.ldctl_iscritical = (char) critical;
1300         pr.ldctl_value.bv_len = cookie_bv->bv_len;
1301         pr.ldctl_value.bv_val = cookie_bv->bv_val;
1302
1303         controls[0] = &pr;
1304         controls[1] = NULL;
1305
1306         rc = smbldap_search_ext(ldap_state, base, scope, filter, attrs, 
1307                                  0, controls, NULL, LDAP_NO_LIMIT, res);
1308
1309         ber_free(cookie_be, 1);
1310         ber_bvfree(cookie_bv);
1311
1312         if (rc != 0) {
1313                 DEBUG(3,("smbldap_search_paged: smbldap_search_ext(%s) "
1314                          "failed with [%s]\n", filter, ldap_err2string(rc)));
1315                 goto done;
1316         }
1317
1318         DEBUG(3,("smbldap_search_paged: search was successfull\n"));
1319
1320         rc = ldap_parse_result(ldap_state->ldap_struct, *res, NULL, NULL, 
1321                                NULL, NULL, &rcontrols,  0);
1322         if (rc != 0) {
1323                 DEBUG(3,("smbldap_search_paged: ldap_parse_result failed " \
1324                          "with [%s]\n", ldap_err2string(rc)));
1325                 goto done;
1326         }
1327
1328         if (rcontrols == NULL)
1329                 goto done;
1330
1331         for (i=0; rcontrols[i]; i++) {
1332
1333                 if (strcmp(ADS_PAGE_CTL_OID, rcontrols[i]->ldctl_oid) != 0)
1334                         continue;
1335
1336                 cookie_be = ber_init(&rcontrols[i]->ldctl_value);
1337                 ber_scanf(cookie_be,"{iO}", &tmp, &cookie_bv);
1338                 /* the berval is the cookie, but must be freed when it is all
1339                    done */
1340                 if (cookie_bv->bv_len)
1341                         *cookie=ber_bvdup(cookie_bv);
1342                 else
1343                         *cookie=NULL;
1344                 ber_bvfree(cookie_bv);
1345                 ber_free(cookie_be, 1);
1346                 break;
1347         }
1348         ldap_controls_free(rcontrols);
1349 done:   
1350         return rc;
1351 }
1352
1353 int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1354 {
1355         int             rc = LDAP_SERVER_DOWN;
1356         int             attempts = 0;
1357         char           *utf8_dn;
1358         time_t          endtime = time(NULL)+lp_ldap_timeout();
1359
1360         SMB_ASSERT(ldap_state);
1361
1362         DEBUG(5,("smbldap_modify: dn => [%s]\n", dn ));
1363
1364         if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1365                 return LDAP_NO_MEMORY;
1366         }
1367
1368         while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1369                 rc = ldap_modify_s(ldap_state->ldap_struct, utf8_dn, attrs);
1370                 if (rc != LDAP_SUCCESS) {
1371                         char *ld_error = NULL;
1372                         ldap_get_option(ldap_state->ldap_struct,
1373                                         LDAP_OPT_ERROR_STRING, &ld_error);
1374                         DEBUG(10,("Failed to modify dn: %s, error: %s "
1375                                   "(%s)\n", dn, ldap_err2string(rc),
1376                                   ld_error ? ld_error : "unknown"));
1377                         SAFE_FREE(ld_error);
1378                 }
1379         }
1380                 
1381         SAFE_FREE(utf8_dn);
1382         return rc;
1383 }
1384
1385 int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[])
1386 {
1387         int             rc = LDAP_SERVER_DOWN;
1388         int             attempts = 0;
1389         char           *utf8_dn;
1390         time_t          endtime = time(NULL)+lp_ldap_timeout();
1391         
1392         SMB_ASSERT(ldap_state);
1393
1394         DEBUG(5,("smbldap_add: dn => [%s]\n", dn ));
1395
1396         if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1397                 return LDAP_NO_MEMORY;
1398         }
1399
1400         while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1401                 rc = ldap_add_s(ldap_state->ldap_struct, utf8_dn, attrs);
1402                 if (rc != LDAP_SUCCESS) {
1403                         char *ld_error = NULL;
1404                         ldap_get_option(ldap_state->ldap_struct,
1405                                         LDAP_OPT_ERROR_STRING, &ld_error);
1406                         DEBUG(10,("Failed to add dn: %s, error: %s "
1407                                   "(%s)\n", dn, ldap_err2string(rc),
1408                                   ld_error ? ld_error : "unknown"));
1409                         SAFE_FREE(ld_error);
1410                 }
1411         }
1412         
1413         SAFE_FREE(utf8_dn);
1414         return rc;
1415 }
1416
1417 int smbldap_delete(struct smbldap_state *ldap_state, const char *dn)
1418 {
1419         int             rc = LDAP_SERVER_DOWN;
1420         int             attempts = 0;
1421         char           *utf8_dn;
1422         time_t          endtime = time(NULL)+lp_ldap_timeout();
1423         
1424         SMB_ASSERT(ldap_state);
1425
1426         DEBUG(5,("smbldap_delete: dn => [%s]\n", dn ));
1427
1428         if (push_utf8_allocate(&utf8_dn, dn) == (size_t)-1) {
1429                 return LDAP_NO_MEMORY;
1430         }
1431
1432         while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1433                 rc = ldap_delete_s(ldap_state->ldap_struct, utf8_dn);
1434                 if (rc != LDAP_SUCCESS) {
1435                         char *ld_error = NULL;
1436                         ldap_get_option(ldap_state->ldap_struct,
1437                                         LDAP_OPT_ERROR_STRING, &ld_error);
1438                         DEBUG(10,("Failed to delete dn: %s, error: %s "
1439                                   "(%s)\n", dn, ldap_err2string(rc),
1440                                   ld_error ? ld_error : "unknown"));
1441                         SAFE_FREE(ld_error);
1442                 }
1443         }
1444         
1445         SAFE_FREE(utf8_dn);
1446         return rc;
1447 }
1448
1449 int smbldap_extended_operation(struct smbldap_state *ldap_state, 
1450                                LDAP_CONST char *reqoid, struct berval *reqdata, 
1451                                LDAPControl **serverctrls, LDAPControl **clientctrls, 
1452                                char **retoidp, struct berval **retdatap)
1453 {
1454         int             rc = LDAP_SERVER_DOWN;
1455         int             attempts = 0;
1456         time_t          endtime = time(NULL)+lp_ldap_timeout();
1457         
1458         if (!ldap_state)
1459                 return (-1);
1460
1461         while (another_ldap_try(ldap_state, &rc, &attempts, endtime)) {
1462                 rc = ldap_extended_operation_s(ldap_state->ldap_struct, reqoid,
1463                                                reqdata, serverctrls,
1464                                                clientctrls, retoidp, retdatap);
1465                 if (rc != LDAP_SUCCESS) {
1466                         char *ld_error = NULL;
1467                         ldap_get_option(ldap_state->ldap_struct,
1468                                         LDAP_OPT_ERROR_STRING, &ld_error);
1469                         DEBUG(10,("Extended operation failed with error: %s "
1470                                   "(%s)\n", ldap_err2string(rc),
1471                                   ld_error ? ld_error : "unknown"));
1472                         SAFE_FREE(ld_error);
1473                 }
1474         }
1475                 
1476         return rc;
1477 }
1478
1479 /*******************************************************************
1480  run the search by name.
1481 ******************************************************************/
1482 int smbldap_search_suffix (struct smbldap_state *ldap_state,
1483                            const char *filter, const char **search_attr,
1484                            LDAPMessage ** result)
1485 {
1486         return smbldap_search(ldap_state, lp_ldap_suffix(), LDAP_SCOPE_SUBTREE,
1487                               filter, search_attr, 0, result);
1488 }
1489
1490 static void smbldap_idle_fn(void **data, time_t *interval, time_t now)
1491 {
1492         struct smbldap_state *state = (struct smbldap_state *)(*data);
1493
1494         if (state->ldap_struct == NULL) {
1495                 DEBUG(10,("ldap connection not connected...\n"));
1496                 return;
1497         }
1498                 
1499         if ((state->last_use+SMBLDAP_IDLE_TIME) > now) {
1500                 DEBUG(10,("ldap connection not idle...\n"));
1501                 return;
1502         }
1503                 
1504         DEBUG(7,("ldap connection idle...closing connection\n"));
1505         smbldap_close(state);
1506 }
1507
1508 /**********************************************************************
1509  Housekeeping
1510  *********************************************************************/
1511
1512 void smbldap_free_struct(struct smbldap_state **ldap_state) 
1513 {
1514         smbldap_close(*ldap_state);
1515         
1516         if ((*ldap_state)->bind_secret) {
1517                 memset((*ldap_state)->bind_secret, '\0', strlen((*ldap_state)->bind_secret));
1518         }
1519
1520         SAFE_FREE((*ldap_state)->bind_dn);
1521         SAFE_FREE((*ldap_state)->bind_secret);
1522
1523         smb_unregister_idle_event((*ldap_state)->event_id);
1524
1525         *ldap_state = NULL;
1526
1527         /* No need to free any further, as it is talloc()ed */
1528 }
1529
1530
1531 /**********************************************************************
1532  Intitalise the 'general' ldap structures, on which ldap operations may be conducted
1533  *********************************************************************/
1534
1535 NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx, const char *location, struct smbldap_state **smbldap_state) 
1536 {
1537         *smbldap_state = TALLOC_ZERO_P(mem_ctx, struct smbldap_state);
1538         if (!*smbldap_state) {
1539                 DEBUG(0, ("talloc() failed for ldapsam private_data!\n"));
1540                 return NT_STATUS_NO_MEMORY;
1541         }
1542
1543         if (location) {
1544                 (*smbldap_state)->uri = talloc_strdup(mem_ctx, location);
1545         } else {
1546                 (*smbldap_state)->uri = "ldap://localhost";
1547         }
1548
1549         (*smbldap_state)->event_id =
1550                 smb_register_idle_event(smbldap_idle_fn, (void *)(*smbldap_state),
1551                                         SMBLDAP_IDLE_TIME);
1552
1553         if ((*smbldap_state)->event_id == SMB_EVENT_ID_INVALID) {
1554                 DEBUG(0,("Failed to register LDAP idle event!\n"));
1555                 return NT_STATUS_INVALID_HANDLE;
1556         }
1557
1558         return NT_STATUS_OK;
1559 }
1560
1561 /*******************************************************************
1562  Return a copy of the DN for a LDAPMessage. Convert from utf8 to CH_UNIX.
1563 ********************************************************************/
1564 char *smbldap_get_dn(LDAP *ld, LDAPMessage *entry)
1565 {
1566         char *utf8_dn, *unix_dn;
1567
1568         utf8_dn = ldap_get_dn(ld, entry);
1569         if (!utf8_dn) {
1570                 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1571                 return NULL;
1572         }
1573         if (pull_utf8_allocate(&unix_dn, utf8_dn) == (size_t)-1) {
1574                 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 [%s]\n", utf8_dn));
1575                 return NULL;
1576         }
1577         ldap_memfree(utf8_dn);
1578         return unix_dn;
1579 }
1580
1581  const char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
1582                                LDAPMessage *entry)
1583 {
1584         char *utf8_dn, *unix_dn;
1585
1586         utf8_dn = ldap_get_dn(ld, entry);
1587         if (!utf8_dn) {
1588                 DEBUG (5, ("smbldap_get_dn: ldap_get_dn failed\n"));
1589                 return NULL;
1590         }
1591         if (pull_utf8_talloc(mem_ctx, &unix_dn, utf8_dn) == (size_t)-1) {
1592                 DEBUG (0, ("smbldap_get_dn: String conversion failure utf8 "
1593                            "[%s]\n", utf8_dn));
1594                 return NULL;
1595         }
1596         ldap_memfree(utf8_dn);
1597         return unix_dn;
1598 }
1599
1600 /*******************************************************************
1601  Check if root-dse has a certain Control or Extension
1602 ********************************************************************/
1603
1604 static BOOL smbldap_check_root_dse(LDAP *ld, const char **attrs, const char *value) 
1605 {
1606         LDAPMessage *msg = NULL;
1607         LDAPMessage *entry = NULL;
1608         char **values = NULL;
1609         int rc, num_result, num_values, i;
1610         BOOL result = False;
1611
1612         if (!attrs[0]) {
1613                 DEBUG(3,("smbldap_check_root_dse: nothing to look for\n"));
1614                 return False;
1615         }
1616
1617         if (!strequal(attrs[0], "supportedExtension") && 
1618             !strequal(attrs[0], "supportedControl") && 
1619             !strequal(attrs[0], "namingContexts")) {
1620                 DEBUG(3,("smbldap_check_root_dse: no idea what to query root-dse for: %s ?\n", attrs[0]));
1621                 return False;
1622         }
1623
1624         rc = ldap_search_s(ld, "", LDAP_SCOPE_BASE, 
1625                            "(objectclass=*)", CONST_DISCARD(char **, attrs), 0 , &msg);
1626
1627         if (rc != LDAP_SUCCESS) {
1628                 DEBUG(3,("smbldap_check_root_dse: Could not search rootDSE\n"));
1629                 return False;
1630         }
1631
1632         num_result = ldap_count_entries(ld, msg);
1633
1634         if (num_result != 1) {
1635                 DEBUG(3,("smbldap_check_root_dse: Expected one rootDSE, got %d\n", num_result));
1636                 goto done;
1637         }
1638
1639         entry = ldap_first_entry(ld, msg);
1640
1641         if (entry == NULL) {
1642                 DEBUG(3,("smbldap_check_root_dse: Could not retrieve rootDSE\n"));
1643                 goto done;
1644         }
1645
1646         values = ldap_get_values(ld, entry, attrs[0]);
1647
1648         if (values == NULL) {
1649                 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not support any %s\n", attrs[0]));
1650                 goto done;
1651         }
1652
1653         num_values = ldap_count_values(values);
1654
1655         if (num_values == 0) {
1656                 DEBUG(5,("smbldap_check_root_dse: LDAP Server does not have any %s\n", attrs[0]));
1657                 goto done;
1658         }
1659
1660         for (i=0; i<num_values; i++) {
1661                 if (strcmp(values[i], value) == 0)
1662                         result = True;
1663         }
1664
1665
1666  done:
1667         if (values != NULL)
1668                 ldap_value_free(values);
1669         if (msg != NULL)
1670                 ldap_msgfree(msg);
1671
1672         return result;
1673
1674 }
1675
1676 /*******************************************************************
1677  Check if LDAP-Server supports a certain Control (OID in string format)
1678 ********************************************************************/
1679
1680 BOOL smbldap_has_control(LDAP *ld, const char *control)
1681 {
1682         const char *attrs[] = { "supportedControl", NULL };
1683         return smbldap_check_root_dse(ld, attrs, control);
1684 }
1685
1686 /*******************************************************************
1687  Check if LDAP-Server supports a certain Extension (OID in string format)
1688 ********************************************************************/
1689
1690 BOOL smbldap_has_extension(LDAP *ld, const char *extension)
1691 {
1692         const char *attrs[] = { "supportedExtension", NULL };
1693         return smbldap_check_root_dse(ld, attrs, extension);
1694 }
1695
1696 /*******************************************************************
1697  Check if LDAP-Server holds a given namingContext
1698 ********************************************************************/
1699
1700 BOOL smbldap_has_naming_context(LDAP *ld, const char *naming_context)
1701 {
1702         const char *attrs[] = { "namingContexts", NULL };
1703         return smbldap_check_root_dse(ld, attrs, naming_context);
1704 }