docs: fix two typos in the mount.cifs manpage
[Samba.git] / source / nmbd / nmbd_namelistdb.c
bloba4ad6cfca3389bb39a08d1c5dccb421ef0f9367b
1 /*
2 Unix SMB/CIFS implementation.
3 NBT netbios routines and daemon - version 2
4 Copyright (C) Andrew Tridgell 1994-1998
5 Copyright (C) Luke Kenneth Casson Leighton 1994-1998
6 Copyright (C) Jeremy Allison 1994-2003
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include "includes.h"
26 uint16 samba_nb_type = 0; /* samba's NetBIOS name type */
29 /**************************************************************************
30 Set Samba's NetBIOS name type.
31 ***************************************************************************/
33 void set_samba_nb_type(void)
35 if( lp_wins_support() || wins_srv_count() ) {
36 samba_nb_type = NB_HFLAG; /* samba is a 'hybrid' node type. */
37 } else {
38 samba_nb_type = NB_BFLAG; /* samba is broadcast-only node type. */
42 /***************************************************************************
43 Convert a NetBIOS name to upper case.
44 ***************************************************************************/
46 static void upcase_name( struct nmb_name *target, const struct nmb_name *source )
48 int i;
49 unstring targ;
50 fstring scope;
52 if( NULL != source ) {
53 memcpy( target, source, sizeof( struct nmb_name ) );
56 pull_ascii_nstring(targ, sizeof(targ), target->name);
57 strupper_m( targ );
58 push_ascii_nstring( target->name, targ);
60 pull_ascii(scope, target->scope, 64, -1, STR_TERMINATE);
61 strupper_m( scope );
62 push_ascii(target->scope, scope, 64, STR_TERMINATE);
64 /* fudge... We're using a byte-by-byte compare, so we must be sure that
65 * unused space doesn't have garbage in it.
68 for( i = strlen( target->name ); i < sizeof( target->name ); i++ ) {
69 target->name[i] = '\0';
71 for( i = strlen( target->scope ); i < sizeof( target->scope ); i++ ) {
72 target->scope[i] = '\0';
76 /**************************************************************************
77 Remove a name from the namelist.
78 ***************************************************************************/
80 void remove_name_from_namelist(struct subnet_record *subrec,
81 struct name_record *namerec )
83 if (subrec == wins_server_subnet)
84 remove_name_from_wins_namelist(namerec);
85 else {
86 subrec->namelist_changed = True;
87 DLIST_REMOVE(subrec->namelist, namerec);
90 SAFE_FREE(namerec->data.ip);
91 ZERO_STRUCTP(namerec);
92 SAFE_FREE(namerec);
95 /**************************************************************************
96 Find a name in a subnet.
97 **************************************************************************/
99 struct name_record *find_name_on_subnet(struct subnet_record *subrec,
100 const struct nmb_name *nmbname,
101 BOOL self_only)
103 struct nmb_name uc_name;
104 struct name_record *name_ret;
106 upcase_name( &uc_name, nmbname );
108 if (subrec == wins_server_subnet) {
109 return find_name_on_wins_subnet(&uc_name, self_only);
112 for( name_ret = subrec->namelist; name_ret; name_ret = name_ret->next) {
113 if (memcmp(&uc_name, &name_ret->name, sizeof(struct nmb_name)) == 0) {
114 break;
118 if( name_ret ) {
119 /* Self names only - these include permanent names. */
120 if( self_only && (name_ret->data.source != SELF_NAME) && (name_ret->data.source != PERMANENT_NAME) ) {
121 DEBUG( 9, ( "find_name_on_subnet: on subnet %s - self name %s NOT FOUND\n",
122 subrec->subnet_name, nmb_namestr(nmbname) ) );
123 return NULL;
126 DEBUG( 9, ("find_name_on_subnet: on subnet %s - found name %s source=%d\n",
127 subrec->subnet_name, nmb_namestr(nmbname), name_ret->data.source) );
129 return name_ret;
132 DEBUG( 9, ( "find_name_on_subnet: on subnet %s - name %s NOT FOUND\n",
133 subrec->subnet_name, nmb_namestr(nmbname) ) );
135 return NULL;
138 /**************************************************************************
139 Find a name over all known broadcast subnets.
140 ************************************************************************/
142 struct name_record *find_name_for_remote_broadcast_subnet(struct nmb_name *nmbname,
143 BOOL self_only)
145 struct subnet_record *subrec;
146 struct name_record *namerec;
148 for( subrec = FIRST_SUBNET; subrec; subrec = NEXT_SUBNET_EXCLUDING_UNICAST(subrec) ) {
149 namerec = find_name_on_subnet(subrec, nmbname, self_only);
150 if (namerec) {
151 return namerec;
155 return NULL;
158 /**************************************************************************
159 Update the ttl of an entry in a subnet name list.
160 ***************************************************************************/
162 void update_name_ttl( struct name_record *namerec, int ttl )
164 time_t time_now = time(NULL);
166 if( namerec->data.death_time != PERMANENT_TTL) {
167 namerec->data.death_time = time_now + ttl;
170 namerec->data.refresh_time = time_now + MIN((ttl/2), MAX_REFRESH_TIME);
172 if (namerec->subnet == wins_server_subnet) {
173 wins_store_changed_namerec(namerec);
174 } else {
175 namerec->subnet->namelist_changed = True;
179 /**************************************************************************
180 Add an entry to a subnet name list.
181 ***********************************************************************/
183 BOOL add_name_to_subnet( struct subnet_record *subrec,
184 const char *name,
185 int type,
186 uint16 nb_flags,
187 int ttl,
188 enum name_source source,
189 int num_ips,
190 struct in_addr *iplist)
192 BOOL ret = False;
193 struct name_record *namerec;
194 time_t time_now = time(NULL);
196 namerec = SMB_MALLOC_P(struct name_record);
197 if( NULL == namerec ) {
198 DEBUG( 0, ( "add_name_to_subnet: malloc fail.\n" ) );
199 return False;
202 memset( (char *)namerec, '\0', sizeof(*namerec) );
203 namerec->data.ip = SMB_MALLOC_ARRAY( struct in_addr, num_ips );
204 if( NULL == namerec->data.ip ) {
205 DEBUG( 0, ( "add_name_to_subnet: malloc fail when creating ip_flgs.\n" ) );
206 ZERO_STRUCTP(namerec);
207 SAFE_FREE(namerec);
208 return False;
211 namerec->subnet = subrec;
213 make_nmb_name(&namerec->name, name, type);
214 upcase_name(&namerec->name, NULL );
216 /* Enter the name as active. */
217 namerec->data.nb_flags = nb_flags | NB_ACTIVE;
218 namerec->data.wins_flags = WINS_ACTIVE;
220 /* If it's our primary name, flag it as so. */
221 if (strequal( my_netbios_names(0), name )) {
222 namerec->data.nb_flags |= NB_PERM;
225 /* Copy the IPs. */
226 namerec->data.num_ips = num_ips;
227 memcpy( (namerec->data.ip), iplist, num_ips * sizeof(struct in_addr) );
229 /* Data source. */
230 namerec->data.source = source;
232 /* Setup the death_time and refresh_time. */
233 if (ttl == PERMANENT_TTL) {
234 namerec->data.death_time = PERMANENT_TTL;
235 } else {
236 namerec->data.death_time = time_now + ttl;
239 namerec->data.refresh_time = time_now + MIN((ttl/2), MAX_REFRESH_TIME);
241 DEBUG( 3, ( "add_name_to_subnet: Added netbios name %s with first IP %s \
242 ttl=%d nb_flags=%2x to subnet %s\n",
243 nmb_namestr( &namerec->name ),
244 inet_ntoa( *iplist ),
245 ttl,
246 (unsigned int)nb_flags,
247 subrec->subnet_name ) );
249 /* Now add the record to the name list. */
251 if (subrec == wins_server_subnet) {
252 ret = add_name_to_wins_subnet(namerec);
253 /* Free namerec - it's stored in the tdb. */
254 SAFE_FREE(namerec->data.ip);
255 SAFE_FREE(namerec);
256 } else {
257 DLIST_ADD(subrec->namelist, namerec);
258 subrec->namelist_changed = True;
259 ret = True;
262 return ret;
265 /*******************************************************************
266 Utility function automatically called when a name refresh or register
267 succeeds. By definition this is a SELF_NAME (or we wouldn't be registering
268 it).
269 ******************************************************************/
271 void standard_success_register(struct subnet_record *subrec,
272 struct userdata_struct *userdata,
273 struct nmb_name *nmbname, uint16 nb_flags, int ttl,
274 struct in_addr registered_ip)
276 struct name_record *namerec;
278 namerec = find_name_on_subnet( subrec, nmbname, FIND_SELF_NAME);
279 if (namerec == NULL) {
280 unstring name;
281 pull_ascii_nstring(name, sizeof(name), nmbname->name);
282 add_name_to_subnet( subrec, name, nmbname->name_type,
283 nb_flags, ttl, SELF_NAME, 1, &registered_ip );
284 } else {
285 update_name_ttl( namerec, ttl );
289 /*******************************************************************
290 Utility function automatically called when a name refresh or register
291 fails. Note that this is only ever called on a broadcast subnet with
292 one IP address per name. This is why it can just delete the name
293 without enumerating the IP adresses. JRA.
294 ******************************************************************/
296 void standard_fail_register( struct subnet_record *subrec,
297 struct nmb_name *nmbname )
299 struct name_record *namerec;
301 namerec = find_name_on_subnet( subrec, nmbname, FIND_SELF_NAME);
303 DEBUG( 0, ( "standard_fail_register: Failed to register/refresh name %s \
304 on subnet %s\n", nmb_namestr(nmbname), subrec->subnet_name) );
306 /* Remove the name from the subnet. */
307 if( namerec ) {
308 remove_name_from_namelist(subrec, namerec);
312 /*******************************************************************
313 Utility function to remove an IP address from a name record.
314 ******************************************************************/
316 static void remove_nth_ip_in_record( struct name_record *namerec, int ind)
318 if( ind != namerec->data.num_ips ) {
319 memmove( (char *)(&namerec->data.ip[ind]),
320 (char *)(&namerec->data.ip[ind+1]),
321 ( namerec->data.num_ips - ind - 1) * sizeof(struct in_addr) );
324 namerec->data.num_ips--;
325 if (namerec->subnet == wins_server_subnet) {
326 wins_store_changed_namerec(namerec);
327 } else {
328 namerec->subnet->namelist_changed = True;
332 /*******************************************************************
333 Utility function to check if an IP address exists in a name record.
334 ******************************************************************/
336 BOOL find_ip_in_name_record( struct name_record *namerec, struct in_addr ip )
338 int i;
340 for(i = 0; i < namerec->data.num_ips; i++) {
341 if(ip_equal( namerec->data.ip[i], ip)) {
342 return True;
346 return False;
349 /*******************************************************************
350 Utility function to add an IP address to a name record.
351 ******************************************************************/
353 void add_ip_to_name_record( struct name_record *namerec, struct in_addr new_ip )
355 struct in_addr *new_list;
357 /* Don't add one we already have. */
358 if( find_ip_in_name_record( namerec, new_ip )) {
359 return;
362 new_list = SMB_MALLOC_ARRAY( struct in_addr, namerec->data.num_ips + 1);
363 if( NULL == new_list ) {
364 DEBUG(0,("add_ip_to_name_record: Malloc fail !\n"));
365 return;
368 memcpy( (char *)new_list, (char *)namerec->data.ip, namerec->data.num_ips * sizeof(struct in_addr) );
369 new_list[namerec->data.num_ips] = new_ip;
371 SAFE_FREE(namerec->data.ip);
372 namerec->data.ip = new_list;
373 namerec->data.num_ips += 1;
375 if (namerec->subnet == wins_server_subnet) {
376 wins_store_changed_namerec(namerec);
377 } else {
378 namerec->subnet->namelist_changed = True;
382 /*******************************************************************
383 Utility function to remove an IP address from a name record.
384 ******************************************************************/
386 void remove_ip_from_name_record( struct name_record *namerec,
387 struct in_addr remove_ip )
389 /* Try and find the requested ip address - remove it. */
390 int i;
391 int orig_num = namerec->data.num_ips;
393 for(i = 0; i < orig_num; i++) {
394 if( ip_equal( remove_ip, namerec->data.ip[i]) ) {
395 remove_nth_ip_in_record( namerec, i);
396 break;
401 /*******************************************************************
402 Utility function that release_name callers can plug into as the
403 success function when a name release is successful. Used to save
404 duplication of success_function code.
405 ******************************************************************/
407 void standard_success_release( struct subnet_record *subrec,
408 struct userdata_struct *userdata,
409 struct nmb_name *nmbname,
410 struct in_addr released_ip )
412 struct name_record *namerec;
414 namerec = find_name_on_subnet( subrec, nmbname, FIND_ANY_NAME );
415 if( namerec == NULL ) {
416 DEBUG( 0, ( "standard_success_release: Name release for name %s IP %s \
417 on subnet %s. Name was not found on subnet.\n", nmb_namestr(nmbname), inet_ntoa(released_ip),
418 subrec->subnet_name) );
419 return;
420 } else {
421 int orig_num = namerec->data.num_ips;
423 remove_ip_from_name_record( namerec, released_ip );
425 if( namerec->data.num_ips == orig_num ) {
426 DEBUG( 0, ( "standard_success_release: Name release for name %s IP %s \
427 on subnet %s. This ip is not known for this name.\n", nmb_namestr(nmbname), inet_ntoa(released_ip), subrec->subnet_name ) );
431 if( namerec->data.num_ips == 0 ) {
432 remove_name_from_namelist( subrec, namerec );
436 /*******************************************************************
437 Expires old names in a subnet namelist.
438 NB. Does not touch the wins_subnet - no wins specific processing here.
439 ******************************************************************/
441 static void expire_names_on_subnet(struct subnet_record *subrec, time_t t)
443 struct name_record *namerec;
444 struct name_record *next_namerec;
446 for( namerec = subrec->namelist; namerec; namerec = next_namerec ) {
447 next_namerec = namerec->next;
448 if( (namerec->data.death_time != PERMANENT_TTL) && (namerec->data.death_time < t) ) {
449 if( namerec->data.source == SELF_NAME ) {
450 DEBUG( 3, ( "expire_names_on_subnet: Subnet %s not expiring SELF \
451 name %s\n", subrec->subnet_name, nmb_namestr(&namerec->name) ) );
452 namerec->data.death_time += 300;
453 namerec->subnet->namelist_changed = True;
454 continue;
457 DEBUG(3,("expire_names_on_subnet: Subnet %s - removing expired name %s\n",
458 subrec->subnet_name, nmb_namestr(&namerec->name)));
460 remove_name_from_namelist(subrec, namerec );
465 /*******************************************************************
466 Expires old names in all subnet namelists.
467 NB. Does not touch the wins_subnet.
468 ******************************************************************/
470 void expire_names(time_t t)
472 struct subnet_record *subrec;
474 for( subrec = FIRST_SUBNET; subrec; subrec = NEXT_SUBNET_INCLUDING_UNICAST(subrec) ) {
475 expire_names_on_subnet( subrec, t );
479 /****************************************************************************
480 Add the magic samba names, useful for finding samba servers.
481 These go directly into the name list for a particular subnet,
482 without going through the normal registration process.
483 When adding them to the unicast subnet, add them as a list of
484 all broadcast subnet IP addresses.
485 **************************************************************************/
487 void add_samba_names_to_subnet( struct subnet_record *subrec )
489 struct in_addr *iplist = &subrec->myip;
490 int num_ips = 1;
492 /* These names are added permanently (ttl of zero) and will NOT be refreshed. */
494 if( (subrec == unicast_subnet) || (subrec == wins_server_subnet) || (subrec == remote_broadcast_subnet) ) {
495 struct subnet_record *bcast_subrecs;
496 int i;
498 /* Create an IP list containing all our known subnets. */
500 num_ips = iface_count();
501 iplist = SMB_MALLOC_ARRAY( struct in_addr, num_ips);
502 if( NULL == iplist ) {
503 DEBUG(0,("add_samba_names_to_subnet: Malloc fail !\n"));
504 return;
507 for( bcast_subrecs = FIRST_SUBNET, i = 0; bcast_subrecs &&
508 i < num_ips;
509 bcast_subrecs = NEXT_SUBNET_EXCLUDING_UNICAST(bcast_subrecs), i++ ) {
510 iplist[i] = bcast_subrecs->myip;
512 num_ips = i;
515 add_name_to_subnet(subrec,"*",0x0,samba_nb_type, PERMANENT_TTL,
516 PERMANENT_NAME, num_ips, iplist);
517 add_name_to_subnet(subrec,"*",0x20,samba_nb_type,PERMANENT_TTL,
518 PERMANENT_NAME, num_ips, iplist);
519 add_name_to_subnet(subrec,"__SAMBA__",0x20,samba_nb_type,PERMANENT_TTL,
520 PERMANENT_NAME, num_ips, iplist);
521 add_name_to_subnet(subrec,"__SAMBA__",0x00,samba_nb_type,PERMANENT_TTL,
522 PERMANENT_NAME, num_ips, iplist);
524 if(iplist != &subrec->myip) {
525 SAFE_FREE(iplist);
529 /****************************************************************************
530 Dump a name_record struct.
531 **************************************************************************/
533 void dump_name_record( struct name_record *namerec, XFILE *fp)
535 const char *src_type;
536 struct tm *tm;
537 int i;
539 x_fprintf(fp,"\tName = %s\t", nmb_namestr(&namerec->name));
540 switch(namerec->data.source) {
541 case LMHOSTS_NAME:
542 src_type = "LMHOSTS_NAME";
543 break;
544 case WINS_PROXY_NAME:
545 src_type = "WINS_PROXY_NAME";
546 break;
547 case REGISTER_NAME:
548 src_type = "REGISTER_NAME";
549 break;
550 case SELF_NAME:
551 src_type = "SELF_NAME";
552 break;
553 case DNS_NAME:
554 src_type = "DNS_NAME";
555 break;
556 case DNSFAIL_NAME:
557 src_type = "DNSFAIL_NAME";
558 break;
559 case PERMANENT_NAME:
560 src_type = "PERMANENT_NAME";
561 break;
562 default:
563 src_type = "unknown!";
564 break;
567 x_fprintf(fp,"Source = %s\nb_flags = %x\t", src_type, namerec->data.nb_flags);
569 if(namerec->data.death_time != PERMANENT_TTL) {
570 const char *asct;
571 tm = localtime(&namerec->data.death_time);
572 if (!tm) {
573 return;
575 asct = asctime(tm);
576 if (!asct) {
577 return;
579 x_fprintf(fp, "death_time = %s\t", asct);
580 } else {
581 x_fprintf(fp, "death_time = PERMANENT\t");
584 if(namerec->data.refresh_time != PERMANENT_TTL) {
585 const char *asct;
586 tm = localtime(&namerec->data.refresh_time);
587 if (!tm) {
588 return;
590 asct = asctime(tm);
591 if (!asct) {
592 return;
594 x_fprintf(fp, "refresh_time = %s\n", asct);
595 } else {
596 x_fprintf(fp, "refresh_time = PERMANENT\n");
599 x_fprintf(fp, "\t\tnumber of IPS = %d", namerec->data.num_ips);
600 for(i = 0; i < namerec->data.num_ips; i++) {
601 x_fprintf(fp, "\t%s", inet_ntoa(namerec->data.ip[i]));
604 x_fprintf(fp, "\n\n");
608 /****************************************************************************
609 Dump the contents of the namelists on all the subnets (including unicast)
610 into a file. Initiated by SIGHUP - used to debug the state of the namelists.
611 **************************************************************************/
613 static void dump_subnet_namelist( struct subnet_record *subrec, XFILE *fp)
615 struct name_record *namerec;
616 x_fprintf(fp, "Subnet %s\n----------------------\n", subrec->subnet_name);
617 for( namerec = subrec->namelist; namerec; namerec = namerec->next) {
618 dump_name_record(namerec, fp);
622 /****************************************************************************
623 Dump the contents of the namelists on all the subnets (including unicast)
624 into a file. Initiated by SIGHUP - used to debug the state of the namelists.
625 **************************************************************************/
627 void dump_all_namelists(void)
629 XFILE *fp;
630 struct subnet_record *subrec;
632 fp = x_fopen(lock_path("namelist.debug"),O_WRONLY|O_CREAT|O_TRUNC, 0644);
634 if (!fp) {
635 DEBUG(0,("dump_all_namelists: Can't open file %s. Error was %s\n",
636 "namelist.debug",strerror(errno)));
637 return;
640 for (subrec = FIRST_SUBNET; subrec; subrec = NEXT_SUBNET_INCLUDING_UNICAST(subrec)) {
641 dump_subnet_namelist( subrec, fp );
644 if (!we_are_a_wins_client()) {
645 dump_subnet_namelist( unicast_subnet, fp );
648 if (remote_broadcast_subnet->namelist != NULL) {
649 dump_subnet_namelist( remote_broadcast_subnet, fp );
652 if (wins_server_subnet != NULL) {
653 dump_wins_subnet_namelist(fp );
656 x_fclose( fp );