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.
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. */
38 samba_nb_type
= NB_BFLAG
; /* samba is broadcast-only node type. */
41 /***************************************************************************
42 Convert a NetBIOS name to upper case.
43 ***************************************************************************/
45 static void upcase_name( struct nmb_name
*target
, struct nmb_name
*source
)
52 memcpy( target
, source
, sizeof( struct nmb_name
) );
54 pull_ascii_nstring(targ
, sizeof(targ
), target
->name
);
56 push_ascii_nstring( target
->name
, targ
);
58 pull_ascii(scope
, target
->scope
, 64, -1, STR_TERMINATE
);
60 push_ascii(target
->scope
, scope
, 64, STR_TERMINATE
);
62 /* fudge... We're using a byte-by-byte compare, so we must be sure that
63 * unused space doesn't have garbage in it.
66 for( i
= strlen( target
->name
); i
< sizeof( target
->name
); i
++ )
67 target
->name
[i
] = '\0';
68 for( i
= strlen( target
->scope
); i
< sizeof( target
->scope
); i
++ )
69 target
->scope
[i
] = '\0';
72 /**************************************************************************
73 Add a new or overwrite an existing namelist entry.
74 ***************************************************************************/
76 static void update_name_in_namelist( struct subnet_record
*subrec
,
77 struct name_record
*namerec
)
79 struct name_record
*oldrec
= NULL
;
81 ubi_trInsert( subrec
->namelist
, namerec
, &(namerec
->name
), &oldrec
);
83 SAFE_FREE( oldrec
->data
.ip
);
88 /**************************************************************************
89 Remove a name from the namelist.
90 ***************************************************************************/
92 void remove_name_from_namelist( struct subnet_record
*subrec
,
93 struct name_record
*namerec
)
95 ubi_trRemove( subrec
->namelist
, namerec
);
96 SAFE_FREE(namerec
->data
.ip
);
97 ZERO_STRUCTP(namerec
);
99 subrec
->namelist_changed
= True
;
102 /**************************************************************************
103 Find a name in a subnet.
104 **************************************************************************/
106 struct name_record
*find_name_on_subnet( struct subnet_record
*subrec
,
107 struct nmb_name
*nmbname
,
110 struct nmb_name uc_name
[1];
111 struct name_record
*name_ret
;
113 upcase_name( uc_name
, nmbname
);
114 name_ret
= (struct name_record
*)ubi_trFind( subrec
->namelist
, uc_name
);
116 /* Self names only - these include permanent names. */
117 if( self_only
&& (name_ret
->data
.source
!= SELF_NAME
) && (name_ret
->data
.source
!= PERMANENT_NAME
) ) {
118 DEBUG( 9, ( "find_name_on_subnet: on subnet %s - self name %s NOT FOUND\n",
119 subrec
->subnet_name
, nmb_namestr(nmbname
) ) );
123 DEBUG( 9, ("find_name_on_subnet: on subnet %s - found name %s source=%d\n",
124 subrec
->subnet_name
, nmb_namestr(nmbname
), name_ret
->data
.source
) );
128 DEBUG( 9, ( "find_name_on_subnet: on subnet %s - name %s NOT FOUND\n",
129 subrec
->subnet_name
, nmb_namestr(nmbname
) ) );
133 /**************************************************************************
134 Find a name over all known broadcast subnets.
135 ************************************************************************/
137 struct name_record
*find_name_for_remote_broadcast_subnet(
138 struct nmb_name
*nmbname
,
141 struct subnet_record
*subrec
;
142 struct name_record
*namerec
= NULL
;
144 for( subrec
= FIRST_SUBNET
; subrec
; subrec
= NEXT_SUBNET_EXCLUDING_UNICAST(subrec
) ) {
145 if( NULL
!= (namerec
= find_name_on_subnet(subrec
, nmbname
, self_only
)) )
152 /**************************************************************************
153 Update the ttl of an entry in a subnet name list.
154 ***************************************************************************/
156 void update_name_ttl( struct name_record
*namerec
, int ttl
)
158 time_t time_now
= time(NULL
);
160 if( namerec
->data
.death_time
!= PERMANENT_TTL
)
161 namerec
->data
.death_time
= time_now
+ ttl
;
163 namerec
->data
.refresh_time
= time_now
+ MIN((ttl
/2), MAX_REFRESH_TIME
);
165 namerec
->subnet
->namelist_changed
= True
;
168 /**************************************************************************
169 Add an entry to a subnet name list.
170 ***********************************************************************/
172 struct name_record
*add_name_to_subnet( struct subnet_record
*subrec
,
177 enum name_source source
,
179 struct in_addr
*iplist
)
181 struct name_record
*namerec
;
182 time_t time_now
= time(NULL
);
184 namerec
= SMB_MALLOC_P(struct name_record
);
185 if( NULL
== namerec
) {
186 DEBUG( 0, ( "add_name_to_subnet: malloc fail.\n" ) );
190 memset( (char *)namerec
, '\0', sizeof(*namerec
) );
191 namerec
->data
.ip
= SMB_MALLOC_ARRAY( struct in_addr
, num_ips
);
192 if( NULL
== namerec
->data
.ip
) {
193 DEBUG( 0, ( "add_name_to_subnet: malloc fail when creating ip_flgs.\n" ) );
194 ZERO_STRUCTP(namerec
);
199 namerec
->subnet
= subrec
;
201 make_nmb_name(&namerec
->name
, name
, type
);
202 upcase_name(&namerec
->name
, NULL
);
204 /* Enter the name as active. */
205 namerec
->data
.nb_flags
= nb_flags
| NB_ACTIVE
;
206 namerec
->data
.wins_flags
= WINS_ACTIVE
;
208 /* If it's our primary name, flag it as so. */
209 if( strequal( my_netbios_names(0), name
) )
210 namerec
->data
.nb_flags
|= NB_PERM
;
213 namerec
->data
.num_ips
= num_ips
;
214 memcpy( (namerec
->data
.ip
), iplist
, num_ips
* sizeof(struct in_addr
) );
217 namerec
->data
.source
= source
;
219 /* Setup the death_time and refresh_time. */
220 if( ttl
== PERMANENT_TTL
)
221 namerec
->data
.death_time
= PERMANENT_TTL
;
223 namerec
->data
.death_time
= time_now
+ ttl
;
225 namerec
->data
.refresh_time
= time_now
+ MIN((ttl
/2), MAX_REFRESH_TIME
);
227 /* Now add the record to the name list. */
228 update_name_in_namelist( subrec
, namerec
);
230 DEBUG( 3, ( "add_name_to_subnet: Added netbios name %s with first IP %s \
231 ttl=%d nb_flags=%2x to subnet %s\n",
232 nmb_namestr( &namerec
->name
),
233 inet_ntoa( *iplist
),
235 (unsigned int)nb_flags
,
236 subrec
->subnet_name
) );
238 subrec
->namelist_changed
= True
;
243 /*******************************************************************
244 Utility function automatically called when a name refresh or register
245 succeeds. By definition this is a SELF_NAME (or we wouldn't be registering
247 ******************************************************************/
249 void standard_success_register(struct subnet_record
*subrec
,
250 struct userdata_struct
*userdata
,
251 struct nmb_name
*nmbname
, uint16 nb_flags
, int ttl
,
252 struct in_addr registered_ip
)
254 struct name_record
*namerec
;
256 namerec
= find_name_on_subnet( subrec
, nmbname
, FIND_SELF_NAME
);
257 if( NULL
== namerec
) {
259 pull_ascii_nstring(name
, sizeof(name
), nmbname
->name
);
260 add_name_to_subnet( subrec
, name
, nmbname
->name_type
,
261 nb_flags
, ttl
, SELF_NAME
, 1, ®istered_ip
);
263 update_name_ttl( namerec
, ttl
);
267 /*******************************************************************
268 Utility function automatically called when a name refresh or register
269 fails. Note that this is only ever called on a broadcast subnet with
270 one IP address per name. This is why it can just delete the name
271 without enumerating the IP adresses. JRA.
272 ******************************************************************/
274 void standard_fail_register( struct subnet_record
*subrec
,
275 struct response_record
*rrec
,
276 struct nmb_name
*nmbname
)
278 struct name_record
*namerec
;
280 namerec
= find_name_on_subnet( subrec
, nmbname
, FIND_SELF_NAME
);
282 DEBUG( 0, ( "standard_fail_register: Failed to register/refresh name %s \
283 on subnet %s\n", nmb_namestr(nmbname
), subrec
->subnet_name
) );
285 /* Remove the name from the subnet. */
287 remove_name_from_namelist(subrec
, namerec
);
290 /*******************************************************************
291 Utility function to remove an IP address from a name record.
292 ******************************************************************/
294 static void remove_nth_ip_in_record( struct name_record
*namerec
, int ind
)
296 if( ind
!= namerec
->data
.num_ips
)
297 memmove( (char *)(&namerec
->data
.ip
[ind
]),
298 (char *)(&namerec
->data
.ip
[ind
+1]),
299 ( namerec
->data
.num_ips
- ind
- 1) * sizeof(struct in_addr
) );
301 namerec
->data
.num_ips
--;
302 namerec
->subnet
->namelist_changed
= True
;
305 /*******************************************************************
306 Utility function to check if an IP address exists in a name record.
307 ******************************************************************/
309 BOOL
find_ip_in_name_record( struct name_record
*namerec
, struct in_addr ip
)
313 for(i
= 0; i
< namerec
->data
.num_ips
; i
++)
314 if(ip_equal( namerec
->data
.ip
[i
], ip
))
320 /*******************************************************************
321 Utility function to add an IP address to a name record.
322 ******************************************************************/
324 void add_ip_to_name_record( struct name_record
*namerec
, struct in_addr new_ip
)
326 struct in_addr
*new_list
;
328 /* Don't add one we already have. */
329 if( find_ip_in_name_record( namerec
, new_ip
) )
332 new_list
= SMB_MALLOC_ARRAY( struct in_addr
, namerec
->data
.num_ips
+ 1);
333 if( NULL
== new_list
) {
334 DEBUG(0,("add_ip_to_name_record: Malloc fail !\n"));
338 memcpy( (char *)new_list
, (char *)namerec
->data
.ip
, namerec
->data
.num_ips
* sizeof(struct in_addr
) );
339 new_list
[namerec
->data
.num_ips
] = new_ip
;
341 SAFE_FREE(namerec
->data
.ip
);
342 namerec
->data
.ip
= new_list
;
343 namerec
->data
.num_ips
+= 1;
345 namerec
->subnet
->namelist_changed
= True
;
348 /*******************************************************************
349 Utility function to remove an IP address from a name record.
350 ******************************************************************/
352 void remove_ip_from_name_record( struct name_record
*namerec
,
353 struct in_addr remove_ip
)
355 /* Try and find the requested ip address - remove it. */
357 int orig_num
= namerec
->data
.num_ips
;
359 for(i
= 0; i
< orig_num
; i
++) {
360 if( ip_equal( remove_ip
, namerec
->data
.ip
[i
]) ) {
361 remove_nth_ip_in_record( namerec
, i
);
367 /*******************************************************************
368 Utility function that release_name callers can plug into as the
369 success function when a name release is successful. Used to save
370 duplication of success_function code.
371 ******************************************************************/
373 void standard_success_release( struct subnet_record
*subrec
,
374 struct userdata_struct
*userdata
,
375 struct nmb_name
*nmbname
,
376 struct in_addr released_ip
)
378 struct name_record
*namerec
;
380 namerec
= find_name_on_subnet( subrec
, nmbname
, FIND_ANY_NAME
);
381 if( namerec
== NULL
) {
382 DEBUG( 0, ( "standard_success_release: Name release for name %s IP %s \
383 on subnet %s. Name was not found on subnet.\n", nmb_namestr(nmbname
), inet_ntoa(released_ip
),
384 subrec
->subnet_name
) );
387 int orig_num
= namerec
->data
.num_ips
;
389 remove_ip_from_name_record( namerec
, released_ip
);
391 if( namerec
->data
.num_ips
== orig_num
)
392 DEBUG( 0, ( "standard_success_release: Name release for name %s IP %s \
393 on subnet %s. This ip is not known for this name.\n", nmb_namestr(nmbname
), inet_ntoa(released_ip
), subrec
->subnet_name
) );
396 if( namerec
->data
.num_ips
== 0 )
397 remove_name_from_namelist( subrec
, namerec
);
400 /*******************************************************************
401 Expires old names in a subnet namelist.
402 ******************************************************************/
404 void expire_names_on_subnet(struct subnet_record
*subrec
, time_t t
)
406 struct name_record
*namerec
;
407 struct name_record
*next_namerec
;
409 for( namerec
= (struct name_record
*)ubi_trFirst( subrec
->namelist
); namerec
; namerec
= next_namerec
) {
410 next_namerec
= (struct name_record
*)ubi_trNext( namerec
);
411 if( (namerec
->data
.death_time
!= PERMANENT_TTL
) && (namerec
->data
.death_time
< t
) ) {
412 if( namerec
->data
.source
== SELF_NAME
) {
413 DEBUG( 3, ( "expire_names_on_subnet: Subnet %s not expiring SELF \
414 name %s\n", subrec
->subnet_name
, nmb_namestr(&namerec
->name
) ) );
415 namerec
->data
.death_time
+= 300;
416 namerec
->subnet
->namelist_changed
= True
;
420 DEBUG(3,("expire_names_on_subnet: Subnet %s - removing expired name %s\n",
421 subrec
->subnet_name
, nmb_namestr(&namerec
->name
)));
423 remove_name_from_namelist( subrec
, namerec
);
428 /*******************************************************************
429 Expires old names in all subnet namelists.
430 ******************************************************************/
432 void expire_names(time_t t
)
434 struct subnet_record
*subrec
;
436 for( subrec
= FIRST_SUBNET
; subrec
; subrec
= NEXT_SUBNET_INCLUDING_UNICAST(subrec
) ) {
437 expire_names_on_subnet( subrec
, t
);
441 /****************************************************************************
442 Add the magic samba names, useful for finding samba servers.
443 These go directly into the name list for a particular subnet,
444 without going through the normal registration process.
445 When adding them to the unicast subnet, add them as a list of
446 all broadcast subnet IP addresses.
447 **************************************************************************/
449 void add_samba_names_to_subnet( struct subnet_record
*subrec
)
451 struct in_addr
*iplist
= &subrec
->myip
;
454 /* These names are added permanently (ttl of zero) and will NOT be refreshed. */
456 if( (subrec
== unicast_subnet
) || (subrec
== wins_server_subnet
) || (subrec
== remote_broadcast_subnet
) ) {
457 struct subnet_record
*bcast_subrecs
;
460 /* Create an IP list containing all our known subnets. */
462 num_ips
= iface_count();
463 iplist
= SMB_MALLOC_ARRAY( struct in_addr
, num_ips
);
464 if( NULL
== iplist
) {
465 DEBUG(0,("add_samba_names_to_subnet: Malloc fail !\n"));
469 for( bcast_subrecs
= FIRST_SUBNET
, i
= 0; bcast_subrecs
; bcast_subrecs
= NEXT_SUBNET_EXCLUDING_UNICAST(bcast_subrecs
), i
++ )
470 iplist
[i
] = bcast_subrecs
->myip
;
473 add_name_to_subnet(subrec
,"*",0x0,samba_nb_type
, PERMANENT_TTL
,
474 PERMANENT_NAME
, num_ips
, iplist
);
475 add_name_to_subnet(subrec
,"*",0x20,samba_nb_type
,PERMANENT_TTL
,
476 PERMANENT_NAME
, num_ips
, iplist
);
477 add_name_to_subnet(subrec
,"__SAMBA__",0x20,samba_nb_type
,PERMANENT_TTL
,
478 PERMANENT_NAME
, num_ips
, iplist
);
479 add_name_to_subnet(subrec
,"__SAMBA__",0x00,samba_nb_type
,PERMANENT_TTL
,
480 PERMANENT_NAME
, num_ips
, iplist
);
482 if(iplist
!= &subrec
->myip
)
486 /****************************************************************************
487 Dump the contents of the namelists on all the subnets (including unicast)
488 into a file. Initiated by SIGHUP - used to debug the state of the namelists.
489 **************************************************************************/
491 static void dump_subnet_namelist( struct subnet_record
*subrec
, XFILE
*fp
)
493 struct name_record
*namerec
;
494 const char *src_type
;
498 x_fprintf(fp
, "Subnet %s\n----------------------\n", subrec
->subnet_name
);
499 for( namerec
= (struct name_record
*)ubi_trFirst( subrec
->namelist
); namerec
;
500 namerec
= (struct name_record
*)ubi_trNext( namerec
) ) {
502 x_fprintf(fp
,"\tName = %s\t", nmb_namestr(&namerec
->name
));
503 switch(namerec
->data
.source
) {
505 src_type
= "LMHOSTS_NAME";
507 case WINS_PROXY_NAME
:
508 src_type
= "WINS_PROXY_NAME";
511 src_type
= "REGISTER_NAME";
514 src_type
= "SELF_NAME";
517 src_type
= "DNS_NAME";
520 src_type
= "DNSFAIL_NAME";
523 src_type
= "PERMANENT_NAME";
526 src_type
= "unknown!";
530 x_fprintf(fp
,"Source = %s\nb_flags = %x\t", src_type
, namerec
->data
.nb_flags
);
532 if(namerec
->data
.death_time
!= PERMANENT_TTL
) {
533 tm
= localtime(&namerec
->data
.death_time
);
534 x_fprintf(fp
, "death_time = %s\t", asctime(tm
));
536 x_fprintf(fp
, "death_time = PERMANENT\t");
539 if(namerec
->data
.refresh_time
!= PERMANENT_TTL
) {
540 tm
= localtime(&namerec
->data
.refresh_time
);
541 x_fprintf(fp
, "refresh_time = %s\n", asctime(tm
));
543 x_fprintf(fp
, "refresh_time = PERMANENT\n");
546 x_fprintf(fp
, "\t\tnumber of IPS = %d", namerec
->data
.num_ips
);
547 for(i
= 0; i
< namerec
->data
.num_ips
; i
++)
548 x_fprintf(fp
, "\t%s", inet_ntoa(namerec
->data
.ip
[i
]));
550 x_fprintf(fp
, "\n\n");
554 /****************************************************************************
555 Dump the contents of the namelists on all the subnets (including unicast)
556 into a file. Initiated by SIGHUP - used to debug the state of the namelists.
557 **************************************************************************/
559 void dump_all_namelists(void)
562 struct subnet_record
*subrec
;
564 fp
= x_fopen(lock_path("namelist.debug"),O_WRONLY
|O_CREAT
|O_TRUNC
, 0644);
567 DEBUG(0,("dump_all_namelists: Can't open file %s. Error was %s\n",
568 "namelist.debug",strerror(errno
)));
572 for( subrec
= FIRST_SUBNET
; subrec
; subrec
= NEXT_SUBNET_INCLUDING_UNICAST(subrec
) )
573 dump_subnet_namelist( subrec
, fp
);
575 if( !we_are_a_wins_client() )
576 dump_subnet_namelist( unicast_subnet
, fp
);
578 if( remote_broadcast_subnet
->namelist
!= NULL
)
579 dump_subnet_namelist( remote_broadcast_subnet
, fp
);
581 if( wins_server_subnet
!= NULL
)
582 dump_subnet_namelist( wins_server_subnet
, fp
);