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