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