- bit a bit manipulation bug in find_name_search()
[kai/samba.git] / source3 / namedbname.c
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 1.9.
4    NBT netbios routines and daemon - version 2
5    Copyright (C) Andrew Tridgell 1994-1996
6    
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20    
21    Module name: namedbname.c
22
23    Revision History:
24
25    14 jan 96: lkcl@pires.co.uk
26    added multiple workgroup domain master support
27
28    04 jul 96: lkcl@pires.co.uk
29    created module namedbname containing name database functions
30 */
31
32 #include "includes.h"
33
34 extern int DEBUGLEVEL;
35
36 extern pstring scope;
37 extern struct in_addr ipzero;
38 extern struct in_addr ipgrp;
39
40 extern struct subnet_record *subnetlist;
41
42 #define WINS_LIST "wins.dat"
43
44 uint16 nb_type = 0; /* samba's NetBIOS name type */
45
46
47 /****************************************************************************
48   samba's NetBIOS name type
49
50   XXXX maybe functionality could be set: B, M, P or H name registration
51   and resolution could be set through nb_type. just a thought.  
52   ****************************************************************************/
53 void set_samba_nb_type(void)
54 {
55         if (lp_wins_support() || (*lp_wins_server()))
56         {
57                 nb_type = NB_MFLAG; /* samba is a 'hybrid' node type */
58         }
59         else
60         {
61                 nb_type = NB_BFLAG; /* samba is broadcast-only node type */
62         }
63 }
64
65
66 /****************************************************************************
67   true if two netbios names are equal
68 ****************************************************************************/
69 BOOL name_equal(struct nmb_name *n1,struct nmb_name *n2)
70 {
71   return n1->name_type == n2->name_type &&
72                  strequal(n1->name ,n2->name ) &&
73          strequal(n1->scope,n2->scope);
74 }
75
76
77 /****************************************************************************
78   true if the netbios name is ^1^2__MSBROWSE__^2^1
79
80   note: this name is registered if as a master browser or backup browser
81   you are responsible for a workgroup (when you announce a domain by
82   broadcasting on your local subnet, you announce it as coming from this
83   name: see announce_host()).
84
85   **************************************************************************/
86 BOOL ms_browser_name(char *name, int type)
87 {
88   return strequal(name,MSBROWSE) && type == 0x01;
89 }
90
91
92 /****************************************************************************
93   add a netbios name into the namelist
94   **************************************************************************/
95 static void add_name(struct subnet_record *d, struct name_record *n)
96 {
97   struct name_record *n2;
98
99   if (!d) return;
100
101   if (!d->namelist)
102   {
103     d->namelist = n;
104     n->prev = NULL;
105     n->next = NULL;
106     return;
107   }
108
109   for (n2 = d->namelist; n2->next; n2 = n2->next) ;
110
111   n2->next = n;
112   n->next = NULL;
113   n->prev = n2;
114 }
115
116
117 /****************************************************************************
118   remove a name from the namelist. The pointer must be an element just 
119   retrieved
120   **************************************************************************/
121 void remove_name(struct subnet_record *d, struct name_record *n)
122 {
123   struct name_record *nlist;
124   if (!d) return;
125
126   nlist = d->namelist;
127
128   while (nlist && nlist != n) nlist = nlist->next;
129
130   if (nlist)
131   {
132     if (nlist->next) nlist->next->prev = nlist->prev;
133     if (nlist->prev) nlist->prev->next = nlist->next;
134     free(nlist);
135   }
136 }
137
138
139 /****************************************************************************
140   find a name in a namelist.
141   **************************************************************************/
142 struct name_record *find_name(struct name_record *n,
143                         struct nmb_name *name,
144                         int search)
145 {
146         struct name_record *ret;
147   
148         for (ret = n; ret; ret = ret->next)
149         {
150                 if (name_equal(&ret->name,name))
151                 {
152                         /* self search: self names only */
153                         if ((search&FIND_SELF) == FIND_SELF && ret->source != SELF)
154                                 continue;
155           
156                         return ret;
157                 }
158         }
159     return NULL;
160 }
161
162
163 /****************************************************************************
164   find a name in the domain database namelist 
165   search can be any of:
166   FIND_SELF - look exclusively for names the samba server has added for itself
167   FIND_LOCAL - look for names in the local subnet record.
168   FIND_WINS - look for names in the WINS record
169   **************************************************************************/
170 struct name_record *find_name_search(struct subnet_record **d,
171                         struct nmb_name *name,
172                         int search, struct in_addr ip)
173 {
174         if (d == NULL) return NULL; /* bad error! */
175         
176     if (search & FIND_LOCAL) {
177       if (*d != NULL) {
178         struct name_record *n = find_name((*d)->namelist, name, search);
179         DEBUG(4,("find_name on local: %s %s search %x\n",
180                  namestr(name),inet_ntoa(ip), search));
181         if (n) return n;
182       }
183     }
184
185     if (!(search & FIND_WINS)) return NULL;
186
187     /* find WINS subnet record. */
188     *d = find_subnet(ipgrp);
189     
190     if (*d == NULL) return NULL;
191     
192     DEBUG(4,("find_name on WINS: %s %s search %x\n",
193              namestr(name),inet_ntoa(ip), search));
194     return find_name((*d)->namelist, name, search);
195 }
196
197
198 /****************************************************************************
199   dump a copy of the name table
200   **************************************************************************/
201 void dump_names(void)
202 {
203   struct name_record *n;
204   struct subnet_record *d;
205   fstring fname, fnamenew;
206   time_t t = time(NULL);
207   
208   FILE *f;
209   
210   strcpy(fname,lp_lockdir());
211   trim_string(fname,NULL,"/");
212   strcat(fname,"/");
213   strcat(fname,WINS_LIST);
214   strcpy(fnamenew,fname);
215   strcat(fnamenew,".");
216   
217   f = fopen(fnamenew,"w");
218   
219   if (!f)
220   {
221     DEBUG(4,("Can't open %s - %s\n",fnamenew,strerror(errno)));
222   }
223   
224   DEBUG(3,("Dump of local name table:\n"));
225   
226   for (d = subnetlist; d; d = d->next)
227    for (n = d->namelist; n; n = n->next)
228     {
229       int i;
230
231           DEBUG(3,("%15s ", inet_ntoa(d->bcast_ip)));
232           DEBUG(3,("%15s ", inet_ntoa(d->mask_ip)));
233       DEBUG(3,("%-19s TTL=%ld ",
234                namestr(&n->name),
235                n->death_time?n->death_time-t:0));
236
237         for (i = 0; i < n->num_ips; i++)
238         {
239            DEBUG(3,("%15s NB=%2x source=%d",
240                     inet_ntoa(n->ip_flgs[i].ip),
241                     n->ip_flgs[i].nb_flags,n->source));
242
243         }
244                 DEBUG(3,("\n"));
245
246       if (f && ip_equal(d->bcast_ip, ipgrp) && n->source == REGISTER)
247       {
248       /* XXXX i have little imagination as to how to output nb_flags as
249          anything other than as a hexadecimal number :-) */
250
251         fprintf(f, "%s#%02x %ld ",
252                n->name.name,n->name.name_type, /* XXXX ignore scope for now */
253                n->death_time);
254
255         for (i = 0; i < n->num_ips; i++)
256         {
257            fprintf(f, "%s %2x ",
258                                                 inet_ntoa(n->ip_flgs[i].ip),
259                                                 n->ip_flgs[i].nb_flags);
260         }
261                 fprintf(f, "\n");
262       }
263
264     }
265
266   fclose(f);
267   unlink(fname);
268   chmod(fnamenew,0644);
269   rename(fnamenew,fname);   
270
271   DEBUG(3,("Wrote wins database %s\n",fname));
272 }
273
274
275 /****************************************************************************
276   load a netbios name database file
277
278   XXXX we cannot cope with loading Internet Group names, yet
279   ****************************************************************************/
280 void load_netbios_names(void)
281 {
282   struct subnet_record *d = find_subnet(ipgrp);
283   fstring fname;
284
285   FILE *f;
286   pstring line;
287
288   if (!d) return;
289
290   strcpy(fname,lp_lockdir());
291   trim_string(fname,NULL,"/");
292   strcat(fname,"/");
293   strcat(fname,WINS_LIST);
294
295   f = fopen(fname,"r");
296
297   if (!f) {
298     DEBUG(2,("Can't open wins database file %s\n",fname));
299     return;
300   }
301
302   while (!feof(f))
303     {
304       pstring name_str, ip_str, ttd_str, nb_flags_str;
305
306       pstring name;
307       int type = 0;
308       unsigned int nb_flags;
309       time_t ttd;
310           struct in_addr ipaddr;
311
312           enum name_source source;
313
314       char *ptr;
315           int count = 0;
316
317       char *p;
318
319       if (!fgets_slash(line,sizeof(pstring),f)) continue;
320
321       if (*line == '#') continue;
322
323         ptr = line;
324
325         if (next_token(&ptr,name_str    ,NULL)) ++count;
326         if (next_token(&ptr,ttd_str     ,NULL)) ++count;
327         if (next_token(&ptr,ip_str      ,NULL)) ++count;
328         if (next_token(&ptr,nb_flags_str,NULL)) ++count;
329
330         if (count <= 0) continue;
331
332         if (count != 4) {
333           DEBUG(0,("Ill formed wins line"));
334           DEBUG(0,("[%s]: name#type abs_time ip nb_flags\n",line));
335           continue;
336         }
337
338       /* netbios name. # divides the name from the type (hex): netbios#xx */
339       strcpy(name,name_str);
340
341       p = strchr(name,'#');
342
343       if (p) {
344             *p = 0;
345             sscanf(p+1,"%x",&type);
346       }
347
348       /* decode the netbios flags (hex) and the time-to-die (seconds) */
349           sscanf(nb_flags_str,"%x",&nb_flags);
350           sscanf(ttd_str,"%ld",&ttd);
351
352           ipaddr = *interpret_addr2(ip_str);
353
354       if (ip_equal(ipaddr,ipzero)) {
355          source = SELF;
356       }
357       else
358       {
359          source = REGISTER;
360       }
361
362       DEBUG(4, ("add WINS line: %s#%02x %ld %s %2x\n",
363                name,type, ttd, inet_ntoa(ipaddr), nb_flags));
364
365       /* add all entries that have 60 seconds or more to live */
366       if (ttd - 60 > time(NULL) || ttd == 0)
367       {
368         time_t t = (ttd?ttd-time(NULL):0) / 3;
369
370         /* add netbios entry read from the wins.dat file. IF it's ok */
371         add_netbios_entry(d,name,type,nb_flags,t,source,ipaddr,True,True);
372       }
373     }
374
375   fclose(f);
376 }
377
378
379 /****************************************************************************
380   remove an entry from the name list
381   ****************************************************************************/
382 void remove_netbios_name(struct subnet_record *d,
383                         char *name,int type, enum name_source source,
384                          struct in_addr ip)
385 {
386   struct nmb_name nn;
387   struct name_record *n;
388
389   make_nmb_name(&nn, name, type, scope);
390   n = find_name_search(&d, &nn, FIND_LOCAL, ip);
391   
392   if (n && n->source == source) remove_name(d,n);
393 }
394
395
396 /****************************************************************************
397   add an entry to the name list.
398
399   this is a multi-purpose function.
400
401   it adds samba's own names in to its records on each interface, keeping a
402   record of whether it is a master browser, domain master, or WINS server.
403
404   it also keeps a record of WINS entries.
405
406   ****************************************************************************/
407 struct name_record *add_netbios_entry(struct subnet_record *d,
408                 char *name, int type, int nb_flags, 
409                 int ttl, enum name_source source, struct in_addr ip,
410                 BOOL new_only,BOOL wins)
411 {
412   struct name_record *n;
413   struct name_record *n2=NULL;
414   int search = 0;
415   BOOL self = source == SELF;
416
417   /* add the name to the WINS list if the name comes from a directed query */
418   search |= wins ? FIND_WINS : FIND_LOCAL;
419   /* search for SELF names only */
420   search |= self ? FIND_SELF : 0;
421
422   if (!self)
423   {
424     if (!wins && type != 0x1b)
425     {
426        /* the only broadcast (non-WINS) names we are adding are ours
427           (SELF) and Domain Master type names */
428        return NULL;
429     }
430   }
431
432   n = (struct name_record *)malloc(sizeof(*n));
433   if (!n) return(NULL);
434
435   bzero((char *)n,sizeof(*n));
436
437   n->num_ips = 1; /* XXXX ONLY USE THIS FUNCTION FOR ONE ENTRY */
438   n->ip_flgs = (struct nmb_ip*)malloc(sizeof(*n->ip_flgs) * n->num_ips);
439   if (!n->ip_flgs)
440   {
441      free(n);
442      return NULL;
443   }
444
445   make_nmb_name(&n->name,name,type,scope);
446
447   if ((n2 = find_name_search(&d, &n->name, search, new_only?ipzero:ip)))
448   {
449     free(n->ip_flgs);
450     free(n);
451     if (new_only || (n2->source==SELF && source!=SELF)) return n2;
452     n = n2;
453   }
454
455   if (ttl)
456      n->death_time = time(NULL)+ttl*3;
457   n->refresh_time = time(NULL)+GET_TTL(ttl);
458
459   /* XXXX only one entry expected with this function */
460   n->ip_flgs[0].ip = ip;
461   n->ip_flgs[0].nb_flags = nb_flags;
462
463   n->source = source;
464   
465   if (!n2) add_name(d,n);
466
467   DEBUG(3,("Added netbios name %s at %s ttl=%d nb_flags=%2x\n",
468                 namestr(&n->name),inet_ntoa(ip),ttl,nb_flags));
469
470   return(n);
471 }
472
473
474 /*******************************************************************
475   expires old names in the namelist
476   ******************************************************************/
477 void expire_names(time_t t)
478 {
479         struct name_record *n;
480         struct name_record *next;
481         struct subnet_record *d;
482
483         /* expire old names */
484         for (d = subnetlist; d; d = d->next)
485         {
486           for (n = d->namelist; n; n = next)
487             {
488               next = n->next;
489               if (n->death_time && n->death_time < t)
490                 {
491                   if (n->source == SELF) {
492                     DEBUG(3,("not expiring SELF name %s\n", namestr(&n->name)));
493                     n->death_time += 300;
494                     continue;
495                   }
496                   DEBUG(3,("Removing dead name %s\n", namestr(&n->name)));
497                   
498                   if (n->prev) n->prev->next = n->next;
499                   if (n->next) n->next->prev = n->prev;
500                   
501                   if (d->namelist == n) d->namelist = n->next; 
502                   
503                   free(n->ip_flgs);
504                   free(n);
505                 }
506             }
507         }
508 }
509
510
511 /***************************************************************************
512   reply to a name query
513   ****************************************************************************/
514 struct name_record *search_for_name(struct subnet_record **d,
515                                         struct nmb_name *question,
516                                     struct in_addr ip, int Time, int search)
517 {
518   int name_type = question->name_type;
519   char *qname = question->name;
520   BOOL dns_type = name_type == 0x20 || name_type == 0;
521   
522   struct name_record *n;
523   
524   DEBUG(3,("Search for %s from %s - ", namestr(question), inet_ntoa(ip)));
525   
526   /* first look up name in cache */
527   n = find_name_search(d,question,search,ip);
528   
529   if (*d == NULL) return NULL;
530
531   DEBUG(4,("subnet %s ", inet_ntoa((*d)->bcast_ip)));
532
533   /* now try DNS lookup. */
534   if (!n)
535     {
536       struct in_addr dns_ip;
537       uint32 a;
538       
539       /* only do DNS lookups if the query is for type 0x20 or type 0x0 */
540       if (!dns_type && name_type != 0x1b)
541         {
542           DEBUG(3,("types 0x20 0x1b 0x0 only: name not found\n"));
543           return NULL;
544         }
545       
546       /* look it up with DNS */      
547       a = interpret_addr(qname);
548       
549       putip((char *)&dns_ip,(char *)&a);
550       
551       if (!a)
552         {
553           /* no luck with DNS. We could possibly recurse here XXXX */
554           DEBUG(3,("no recursion.\n"));
555       /* add the fail to our WINS cache of names. give it 1 hour in the cache */
556           add_netbios_entry(*d,qname,name_type,NB_ACTIVE,60*60,DNSFAIL,dns_ip,
557                                                 True, True);
558           return NULL;
559         }
560       
561       /* add it to our WINS cache of names. give it 2 hours in the cache */
562       n = add_netbios_entry(*d,qname,name_type,NB_ACTIVE,2*60*60,DNS,dns_ip,
563                                                 True,True);
564       
565       /* failed to add it? yikes! */
566       if (!n) return NULL;
567     }
568   
569   /* is our entry already dead? */
570   if (n->death_time)
571     {
572       if (n->death_time < Time) return False;
573     }
574   
575   /* it may have been an earlier failure */
576   if (n->source == DNSFAIL)
577     {
578       DEBUG(3,("DNSFAIL\n"));
579       return NULL;
580     }
581   
582   DEBUG(3,("OK %s\n",inet_ntoa(n->ip_flgs[0].ip)));      
583   
584   return n;
585 }
586
587