WHATSNEW: Update release notes.
[Samba.git] / source3 / libsmb / nmblib.c
blob8230c5ac0fde822dc27fafc1eb241ae934e1195e
1 /*
2 Unix SMB/CIFS implementation.
3 NBT netbios library routines
4 Copyright (C) Andrew Tridgell 1994-1998
5 Copyright (C) Jeremy Allison 2007
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 3 of the License, or
10 (at your option) any later version.
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.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "includes.h"
24 static const struct opcode_names {
25 const char *nmb_opcode_name;
26 int opcode;
27 } nmb_header_opcode_names[] = {
28 {"Query", 0 },
29 {"Registration", 5 },
30 {"Release", 6 },
31 {"WACK", 7 },
32 {"Refresh", 8 },
33 {"Refresh(altcode)", 9 },
34 {"Multi-homed Registration", 15 },
35 {0, -1 }
38 /****************************************************************************
39 Lookup a nmb opcode name.
40 ****************************************************************************/
42 static const char *lookup_opcode_name( int opcode )
44 const struct opcode_names *op_namep;
45 int i;
47 for(i = 0; nmb_header_opcode_names[i].nmb_opcode_name != 0; i++) {
48 op_namep = &nmb_header_opcode_names[i];
49 if(opcode == op_namep->opcode)
50 return op_namep->nmb_opcode_name;
52 return "<unknown opcode>";
55 /****************************************************************************
56 Print out a res_rec structure.
57 ****************************************************************************/
59 static void debug_nmb_res_rec(struct res_rec *res, const char *hdr)
61 int i, j;
63 DEBUGADD( 4, ( " %s: nmb_name=%s rr_type=%d rr_class=%d ttl=%d\n",
64 hdr,
65 nmb_namestr(&res->rr_name),
66 res->rr_type,
67 res->rr_class,
68 res->ttl ) );
70 if( res->rdlength == 0 || res->rdata == NULL )
71 return;
73 for (i = 0; i < res->rdlength; i+= MAX_NETBIOSNAME_LEN) {
74 DEBUGADD(4, (" %s %3x char ", hdr, i));
76 for (j = 0; j < MAX_NETBIOSNAME_LEN; j++) {
77 unsigned char x = res->rdata[i+j];
78 if (x < 32 || x > 127)
79 x = '.';
81 if (i+j >= res->rdlength)
82 break;
83 DEBUGADD(4, ("%c", x));
86 DEBUGADD(4, (" hex "));
88 for (j = 0; j < MAX_NETBIOSNAME_LEN; j++) {
89 if (i+j >= res->rdlength)
90 break;
91 DEBUGADD(4, ("%02X", (unsigned char)res->rdata[i+j]));
94 DEBUGADD(4, ("\n"));
98 /****************************************************************************
99 Process a nmb packet.
100 ****************************************************************************/
102 void debug_nmb_packet(struct packet_struct *p)
104 struct nmb_packet *nmb = &p->packet.nmb;
106 if( DEBUGLVL( 4 ) ) {
107 dbgtext( "nmb packet from %s(%d) header: id=%d "
108 "opcode=%s(%d) response=%s\n",
109 inet_ntoa(p->ip), p->port,
110 nmb->header.name_trn_id,
111 lookup_opcode_name(nmb->header.opcode),
112 nmb->header.opcode,
113 BOOLSTR(nmb->header.response) );
114 dbgtext( " header: flags: bcast=%s rec_avail=%s "
115 "rec_des=%s trunc=%s auth=%s\n",
116 BOOLSTR(nmb->header.nm_flags.bcast),
117 BOOLSTR(nmb->header.nm_flags.recursion_available),
118 BOOLSTR(nmb->header.nm_flags.recursion_desired),
119 BOOLSTR(nmb->header.nm_flags.trunc),
120 BOOLSTR(nmb->header.nm_flags.authoritative) );
121 dbgtext( " header: rcode=%d qdcount=%d ancount=%d "
122 "nscount=%d arcount=%d\n",
123 nmb->header.rcode,
124 nmb->header.qdcount,
125 nmb->header.ancount,
126 nmb->header.nscount,
127 nmb->header.arcount );
130 if (nmb->header.qdcount) {
131 DEBUGADD( 4, ( " question: q_name=%s q_type=%d q_class=%d\n",
132 nmb_namestr(&nmb->question.question_name),
133 nmb->question.question_type,
134 nmb->question.question_class) );
137 if (nmb->answers && nmb->header.ancount) {
138 debug_nmb_res_rec(nmb->answers,"answers");
140 if (nmb->nsrecs && nmb->header.nscount) {
141 debug_nmb_res_rec(nmb->nsrecs,"nsrecs");
143 if (nmb->additional && nmb->header.arcount) {
144 debug_nmb_res_rec(nmb->additional,"additional");
148 /*******************************************************************
149 Handle "compressed" name pointers.
150 ******************************************************************/
152 static bool handle_name_ptrs(unsigned char *ubuf,int *offset,int length,
153 bool *got_pointer,int *ret)
155 int loop_count=0;
157 while ((ubuf[*offset] & 0xC0) == 0xC0) {
158 if (!*got_pointer)
159 (*ret) += 2;
160 (*got_pointer)=True;
161 (*offset) = ((ubuf[*offset] & ~0xC0)<<8) | ubuf[(*offset)+1];
162 if (loop_count++ == 10 ||
163 (*offset) < 0 || (*offset)>(length-2)) {
164 return False;
167 return True;
170 /*******************************************************************
171 Parse a nmb name from "compressed" format to something readable
172 return the space taken by the name, or 0 if the name is invalid
173 ******************************************************************/
175 static int parse_nmb_name(char *inbuf,int ofs,int length, struct nmb_name *name)
177 int m,n=0;
178 unsigned char *ubuf = (unsigned char *)inbuf;
179 int ret = 0;
180 bool got_pointer=False;
181 int loop_count=0;
182 int offset = ofs;
184 if (length - offset < 2)
185 return(0);
187 /* handle initial name pointers */
188 if (!handle_name_ptrs(ubuf,&offset,length,&got_pointer,&ret))
189 return(0);
191 m = ubuf[offset];
193 if (!m)
194 return(0);
195 if ((m & 0xC0) || offset+m+2 > length)
196 return(0);
198 memset((char *)name,'\0',sizeof(*name));
200 /* the "compressed" part */
201 if (!got_pointer)
202 ret += m + 2;
203 offset++;
204 while (m > 0) {
205 unsigned char c1,c2;
206 c1 = ubuf[offset++]-'A';
207 c2 = ubuf[offset++]-'A';
208 if ((c1 & 0xF0) || (c2 & 0xF0) || (n > sizeof(name->name)-1))
209 return(0);
210 name->name[n++] = (c1<<4) | c2;
211 m -= 2;
213 name->name[n] = 0;
215 if (n==MAX_NETBIOSNAME_LEN) {
216 /* parse out the name type, its always
217 * in the 16th byte of the name */
218 name->name_type = ((unsigned char)name->name[15]) & 0xff;
220 /* remove trailing spaces */
221 name->name[15] = 0;
222 n = 14;
223 while (n && name->name[n]==' ')
224 name->name[n--] = 0;
227 /* now the domain parts (if any) */
228 n = 0;
229 while (ubuf[offset]) {
230 /* we can have pointers within the domain part as well */
231 if (!handle_name_ptrs(ubuf,&offset,length,&got_pointer,&ret))
232 return(0);
234 m = ubuf[offset];
236 * Don't allow null domain parts.
238 if (!m)
239 return(0);
240 if (!got_pointer)
241 ret += m+1;
242 if (n)
243 name->scope[n++] = '.';
244 if (m+2+offset>length || n+m+1>sizeof(name->scope))
245 return(0);
246 offset++;
247 while (m--)
248 name->scope[n++] = (char)ubuf[offset++];
251 * Watch for malicious loops.
253 if (loop_count++ == 10)
254 return 0;
256 name->scope[n++] = 0;
258 return(ret);
261 /****************************************************************************
262 Put a netbios name, padding(s) and a name type into a 16 character buffer.
263 name is already in DOS charset.
264 [15 bytes name + padding][1 byte name type].
265 ****************************************************************************/
267 void put_name(char *dest, const char *name, int pad, unsigned int name_type)
269 size_t len = strlen(name);
271 memcpy(dest, name, (len < MAX_NETBIOSNAME_LEN) ?
272 len : MAX_NETBIOSNAME_LEN - 1);
273 if (len < MAX_NETBIOSNAME_LEN - 1) {
274 memset(dest + len, pad, MAX_NETBIOSNAME_LEN - 1 - len);
276 dest[MAX_NETBIOSNAME_LEN - 1] = name_type;
279 /*******************************************************************
280 Put a compressed nmb name into a buffer. Return the length of the
281 compressed name.
283 Compressed names are really weird. The "compression" doubles the
284 size. The idea is that it also means that compressed names conform
285 to the doman name system. See RFC1002.
287 If buf == NULL this is a length calculation.
288 ******************************************************************/
290 static int put_nmb_name(char *buf,int offset,struct nmb_name *name)
292 int ret,m;
293 nstring buf1;
294 char *p;
296 if (strcmp(name->name,"*") == 0) {
297 /* special case for wildcard name */
298 put_name(buf1, "*", '\0', name->name_type);
299 } else {
300 put_name(buf1, name->name, ' ', name->name_type);
303 if (buf) {
304 buf[offset] = 0x20;
307 ret = 34;
309 for (m=0;m<MAX_NETBIOSNAME_LEN;m++) {
310 if (buf) {
311 buf[offset+1+2*m] = 'A' + ((buf1[m]>>4)&0xF);
312 buf[offset+2+2*m] = 'A' + (buf1[m]&0xF);
315 offset += 33;
317 if (buf) {
318 buf[offset] = 0;
321 if (name->scope[0]) {
322 /* XXXX this scope handling needs testing */
323 ret += strlen(name->scope) + 1;
324 if (buf) {
325 safe_strcpy(&buf[offset+1],name->scope,
326 sizeof(name->scope));
328 p = &buf[offset+1];
329 while ((p = strchr_m(p,'.'))) {
330 buf[offset] = PTR_DIFF(p,&buf[offset+1]);
331 offset += (buf[offset] + 1);
332 p = &buf[offset+1];
334 buf[offset] = strlen(&buf[offset+1]);
338 return ret;
341 /*******************************************************************
342 Useful for debugging messages.
343 ******************************************************************/
345 char *nmb_namestr(const struct nmb_name *n)
347 fstring name;
348 char *result;
350 pull_ascii_fstring(name, n->name);
351 if (!n->scope[0])
352 result = talloc_asprintf(talloc_tos(), "%s<%02x>", name,
353 n->name_type);
354 else
355 result = talloc_asprintf(talloc_tos(), "%s<%02x>.%s", name,
356 n->name_type, n->scope);
358 SMB_ASSERT(result != NULL);
359 return result;
362 /*******************************************************************
363 Allocate and parse some resource records.
364 ******************************************************************/
366 static bool parse_alloc_res_rec(char *inbuf,int *offset,int length,
367 struct res_rec **recs, int count)
369 int i;
371 *recs = SMB_MALLOC_ARRAY(struct res_rec, count);
372 if (!*recs)
373 return(False);
375 memset((char *)*recs,'\0',sizeof(**recs)*count);
377 for (i=0;i<count;i++) {
378 int l = parse_nmb_name(inbuf,*offset,length,
379 &(*recs)[i].rr_name);
380 (*offset) += l;
381 if (!l || (*offset)+10 > length) {
382 SAFE_FREE(*recs);
383 return(False);
385 (*recs)[i].rr_type = RSVAL(inbuf,(*offset));
386 (*recs)[i].rr_class = RSVAL(inbuf,(*offset)+2);
387 (*recs)[i].ttl = RIVAL(inbuf,(*offset)+4);
388 (*recs)[i].rdlength = RSVAL(inbuf,(*offset)+8);
389 (*offset) += 10;
390 if ((*recs)[i].rdlength>sizeof((*recs)[i].rdata) ||
391 (*offset)+(*recs)[i].rdlength > length) {
392 SAFE_FREE(*recs);
393 return(False);
395 memcpy((*recs)[i].rdata,inbuf+(*offset),(*recs)[i].rdlength);
396 (*offset) += (*recs)[i].rdlength;
398 return(True);
401 /*******************************************************************
402 Put a resource record into a packet.
403 If buf == NULL this is a length calculation.
404 ******************************************************************/
406 static int put_res_rec(char *buf,int offset,struct res_rec *recs,int count)
408 int ret=0;
409 int i;
411 for (i=0;i<count;i++) {
412 int l = put_nmb_name(buf,offset,&recs[i].rr_name);
413 offset += l;
414 ret += l;
415 if (buf) {
416 RSSVAL(buf,offset,recs[i].rr_type);
417 RSSVAL(buf,offset+2,recs[i].rr_class);
418 RSIVAL(buf,offset+4,recs[i].ttl);
419 RSSVAL(buf,offset+8,recs[i].rdlength);
420 memcpy(buf+offset+10,recs[i].rdata,recs[i].rdlength);
422 offset += 10+recs[i].rdlength;
423 ret += 10+recs[i].rdlength;
426 return ret;
429 /*******************************************************************
430 Put a compressed name pointer record into a packet.
431 If buf == NULL this is a length calculation.
432 ******************************************************************/
434 static int put_compressed_name_ptr(unsigned char *buf,
435 int offset,
436 struct res_rec *rec,
437 int ptr_offset)
439 int ret=0;
440 if (buf) {
441 buf[offset] = (0xC0 | ((ptr_offset >> 8) & 0xFF));
442 buf[offset+1] = (ptr_offset & 0xFF);
444 offset += 2;
445 ret += 2;
446 if (buf) {
447 RSSVAL(buf,offset,rec->rr_type);
448 RSSVAL(buf,offset+2,rec->rr_class);
449 RSIVAL(buf,offset+4,rec->ttl);
450 RSSVAL(buf,offset+8,rec->rdlength);
451 memcpy(buf+offset+10,rec->rdata,rec->rdlength);
453 offset += 10+rec->rdlength;
454 ret += 10+rec->rdlength;
456 return ret;
459 /*******************************************************************
460 Parse a dgram packet. Return False if the packet can't be parsed
461 or is invalid for some reason, True otherwise.
463 This is documented in section 4.4.1 of RFC1002.
464 ******************************************************************/
466 static bool parse_dgram(char *inbuf,int length,struct dgram_packet *dgram)
468 int offset;
469 int flags;
471 memset((char *)dgram,'\0',sizeof(*dgram));
473 if (length < 14)
474 return(False);
476 dgram->header.msg_type = CVAL(inbuf,0);
477 flags = CVAL(inbuf,1);
478 dgram->header.flags.node_type = (enum node_type)((flags>>2)&3);
479 if (flags & 1)
480 dgram->header.flags.more = True;
481 if (flags & 2)
482 dgram->header.flags.first = True;
483 dgram->header.dgm_id = RSVAL(inbuf,2);
484 putip((char *)&dgram->header.source_ip,inbuf+4);
485 dgram->header.source_port = RSVAL(inbuf,8);
486 dgram->header.dgm_length = RSVAL(inbuf,10);
487 dgram->header.packet_offset = RSVAL(inbuf,12);
489 offset = 14;
491 if (dgram->header.msg_type == 0x10 ||
492 dgram->header.msg_type == 0x11 ||
493 dgram->header.msg_type == 0x12) {
494 offset += parse_nmb_name(inbuf,offset,length,
495 &dgram->source_name);
496 offset += parse_nmb_name(inbuf,offset,length,
497 &dgram->dest_name);
500 if (offset >= length || (length-offset > sizeof(dgram->data)))
501 return(False);
503 dgram->datasize = length-offset;
504 memcpy(dgram->data,inbuf+offset,dgram->datasize);
506 /* Paranioa. Ensure the last 2 bytes in the dgram buffer are
507 zero. This should be true anyway, just enforce it for
508 paranioa sake. JRA. */
509 SMB_ASSERT(dgram->datasize <= (sizeof(dgram->data)-2));
510 memset(&dgram->data[sizeof(dgram->data)-2], '\0', 2);
512 return(True);
515 /*******************************************************************
516 Parse a nmb packet. Return False if the packet can't be parsed
517 or is invalid for some reason, True otherwise.
518 ******************************************************************/
520 static bool parse_nmb(char *inbuf,int length,struct nmb_packet *nmb)
522 int nm_flags,offset;
524 memset((char *)nmb,'\0',sizeof(*nmb));
526 if (length < 12)
527 return(False);
529 /* parse the header */
530 nmb->header.name_trn_id = RSVAL(inbuf,0);
532 DEBUG(10,("parse_nmb: packet id = %d\n", nmb->header.name_trn_id));
534 nmb->header.opcode = (CVAL(inbuf,2) >> 3) & 0xF;
535 nmb->header.response = ((CVAL(inbuf,2)>>7)&1)?True:False;
536 nm_flags = ((CVAL(inbuf,2) & 0x7) << 4) + (CVAL(inbuf,3)>>4);
537 nmb->header.nm_flags.bcast = (nm_flags&1)?True:False;
538 nmb->header.nm_flags.recursion_available = (nm_flags&8)?True:False;
539 nmb->header.nm_flags.recursion_desired = (nm_flags&0x10)?True:False;
540 nmb->header.nm_flags.trunc = (nm_flags&0x20)?True:False;
541 nmb->header.nm_flags.authoritative = (nm_flags&0x40)?True:False;
542 nmb->header.rcode = CVAL(inbuf,3) & 0xF;
543 nmb->header.qdcount = RSVAL(inbuf,4);
544 nmb->header.ancount = RSVAL(inbuf,6);
545 nmb->header.nscount = RSVAL(inbuf,8);
546 nmb->header.arcount = RSVAL(inbuf,10);
548 if (nmb->header.qdcount) {
549 offset = parse_nmb_name(inbuf,12,length,
550 &nmb->question.question_name);
551 if (!offset)
552 return(False);
554 if (length - (12+offset) < 4)
555 return(False);
556 nmb->question.question_type = RSVAL(inbuf,12+offset);
557 nmb->question.question_class = RSVAL(inbuf,12+offset+2);
559 offset += 12+4;
560 } else {
561 offset = 12;
564 /* and any resource records */
565 if (nmb->header.ancount &&
566 !parse_alloc_res_rec(inbuf,&offset,length,&nmb->answers,
567 nmb->header.ancount))
568 return(False);
570 if (nmb->header.nscount &&
571 !parse_alloc_res_rec(inbuf,&offset,length,&nmb->nsrecs,
572 nmb->header.nscount))
573 return(False);
575 if (nmb->header.arcount &&
576 !parse_alloc_res_rec(inbuf,&offset,length,
577 &nmb->additional, nmb->header.arcount))
578 return(False);
580 return(True);
583 /*******************************************************************
584 'Copy constructor' for an nmb packet.
585 ******************************************************************/
587 static struct packet_struct *copy_nmb_packet(struct packet_struct *packet)
589 struct nmb_packet *nmb;
590 struct nmb_packet *copy_nmb;
591 struct packet_struct *pkt_copy;
593 if(( pkt_copy = SMB_MALLOC_P(struct packet_struct)) == NULL) {
594 DEBUG(0,("copy_nmb_packet: malloc fail.\n"));
595 return NULL;
598 /* Structure copy of entire thing. */
600 *pkt_copy = *packet;
602 /* Ensure this copy is not locked. */
603 pkt_copy->locked = False;
605 /* Ensure this copy has no resource records. */
606 nmb = &packet->packet.nmb;
607 copy_nmb = &pkt_copy->packet.nmb;
609 copy_nmb->answers = NULL;
610 copy_nmb->nsrecs = NULL;
611 copy_nmb->additional = NULL;
613 /* Now copy any resource records. */
615 if (nmb->answers) {
616 if((copy_nmb->answers = SMB_MALLOC_ARRAY(
617 struct res_rec,nmb->header.ancount)) == NULL)
618 goto free_and_exit;
619 memcpy((char *)copy_nmb->answers, (char *)nmb->answers,
620 nmb->header.ancount * sizeof(struct res_rec));
622 if (nmb->nsrecs) {
623 if((copy_nmb->nsrecs = SMB_MALLOC_ARRAY(
624 struct res_rec, nmb->header.nscount)) == NULL)
625 goto free_and_exit;
626 memcpy((char *)copy_nmb->nsrecs, (char *)nmb->nsrecs,
627 nmb->header.nscount * sizeof(struct res_rec));
629 if (nmb->additional) {
630 if((copy_nmb->additional = SMB_MALLOC_ARRAY(
631 struct res_rec, nmb->header.arcount)) == NULL)
632 goto free_and_exit;
633 memcpy((char *)copy_nmb->additional, (char *)nmb->additional,
634 nmb->header.arcount * sizeof(struct res_rec));
637 return pkt_copy;
639 free_and_exit:
641 SAFE_FREE(copy_nmb->answers);
642 SAFE_FREE(copy_nmb->nsrecs);
643 SAFE_FREE(copy_nmb->additional);
644 SAFE_FREE(pkt_copy);
646 DEBUG(0,("copy_nmb_packet: malloc fail in resource records.\n"));
647 return NULL;
650 /*******************************************************************
651 'Copy constructor' for a dgram packet.
652 ******************************************************************/
654 static struct packet_struct *copy_dgram_packet(struct packet_struct *packet)
656 struct packet_struct *pkt_copy;
658 if(( pkt_copy = SMB_MALLOC_P(struct packet_struct)) == NULL) {
659 DEBUG(0,("copy_dgram_packet: malloc fail.\n"));
660 return NULL;
663 /* Structure copy of entire thing. */
665 *pkt_copy = *packet;
667 /* Ensure this copy is not locked. */
668 pkt_copy->locked = False;
670 /* There are no additional pointers in a dgram packet,
671 we are finished. */
672 return pkt_copy;
675 /*******************************************************************
676 'Copy constructor' for a generic packet.
677 ******************************************************************/
679 struct packet_struct *copy_packet(struct packet_struct *packet)
681 if(packet->packet_type == NMB_PACKET)
682 return copy_nmb_packet(packet);
683 else if (packet->packet_type == DGRAM_PACKET)
684 return copy_dgram_packet(packet);
685 return NULL;
688 /*******************************************************************
689 Free up any resources associated with an nmb packet.
690 ******************************************************************/
692 static void free_nmb_packet(struct nmb_packet *nmb)
694 SAFE_FREE(nmb->answers);
695 SAFE_FREE(nmb->nsrecs);
696 SAFE_FREE(nmb->additional);
699 /*******************************************************************
700 Free up any resources associated with a dgram packet.
701 ******************************************************************/
703 static void free_dgram_packet(struct dgram_packet *nmb)
705 /* We have nothing to do for a dgram packet. */
708 /*******************************************************************
709 Free up any resources associated with a packet.
710 ******************************************************************/
712 void free_packet(struct packet_struct *packet)
714 if (packet->locked)
715 return;
716 if (packet->packet_type == NMB_PACKET)
717 free_nmb_packet(&packet->packet.nmb);
718 else if (packet->packet_type == DGRAM_PACKET)
719 free_dgram_packet(&packet->packet.dgram);
720 ZERO_STRUCTPN(packet);
721 SAFE_FREE(packet);
724 /*******************************************************************
725 Parse a packet buffer into a packet structure.
726 ******************************************************************/
728 struct packet_struct *parse_packet(char *buf,int length,
729 enum packet_type packet_type,
730 struct in_addr ip,
731 int port)
733 struct packet_struct *p;
734 bool ok=False;
736 p = SMB_MALLOC_P(struct packet_struct);
737 if (!p)
738 return(NULL);
740 ZERO_STRUCTP(p); /* initialize for possible padding */
742 p->next = NULL;
743 p->prev = NULL;
744 p->ip = ip;
745 p->port = port;
746 p->locked = False;
747 p->timestamp = time(NULL);
748 p->packet_type = packet_type;
750 switch (packet_type) {
751 case NMB_PACKET:
752 ok = parse_nmb(buf,length,&p->packet.nmb);
753 break;
755 case DGRAM_PACKET:
756 ok = parse_dgram(buf,length,&p->packet.dgram);
757 break;
760 if (!ok) {
761 free_packet(p);
762 return NULL;
765 return p;
768 /*******************************************************************
769 Read a packet from a socket and parse it, returning a packet ready
770 to be used or put on the queue. This assumes a UDP socket.
771 ******************************************************************/
773 struct packet_struct *read_packet(int fd,enum packet_type packet_type)
775 struct packet_struct *packet;
776 struct sockaddr_storage sa;
777 struct sockaddr_in *si = (struct sockaddr_in *)&sa;
778 char buf[MAX_DGRAM_SIZE];
779 int length;
781 length = read_udp_v4_socket(fd,buf,sizeof(buf),&sa);
782 if (length < MIN_DGRAM_SIZE || sa.ss_family != AF_INET) {
783 return NULL;
786 packet = parse_packet(buf,
787 length,
788 packet_type,
789 si->sin_addr,
790 ntohs(si->sin_port));
791 if (!packet)
792 return NULL;
794 packet->fd = fd;
796 DEBUG(5,("Received a packet of len %d from (%s) port %d\n",
797 length, inet_ntoa(packet->ip), packet->port ) );
799 return(packet);
802 /*******************************************************************
803 Send a udp packet on a already open socket.
804 ******************************************************************/
806 static bool send_udp(int fd,char *buf,int len,struct in_addr ip,int port)
808 bool ret = False;
809 int i;
810 struct sockaddr_in sock_out;
812 /* set the address and port */
813 memset((char *)&sock_out,'\0',sizeof(sock_out));
814 putip((char *)&sock_out.sin_addr,(char *)&ip);
815 sock_out.sin_port = htons( port );
816 sock_out.sin_family = AF_INET;
818 DEBUG( 5, ( "Sending a packet of len %d to (%s) on port %d\n",
819 len, inet_ntoa(ip), port ) );
822 * Patch to fix asynch error notifications from Linux kernel.
825 for (i = 0; i < 5; i++) {
826 ret = (sendto(fd,buf,len,0,(struct sockaddr *)&sock_out,
827 sizeof(sock_out)) >= 0);
828 if (ret || errno != ECONNREFUSED)
829 break;
832 if (!ret)
833 DEBUG(0,("Packet send failed to %s(%d) ERRNO=%s\n",
834 inet_ntoa(ip),port,strerror(errno)));
836 return(ret);
839 /*******************************************************************
840 Build a dgram packet ready for sending.
841 If buf == NULL this is a length calculation.
842 ******************************************************************/
844 static int build_dgram(char *buf, size_t len, struct dgram_packet *dgram)
846 unsigned char *ubuf = (unsigned char *)buf;
847 int offset=0;
849 /* put in the header */
850 if (buf) {
851 ubuf[0] = dgram->header.msg_type;
852 ubuf[1] = (((int)dgram->header.flags.node_type)<<2);
853 if (dgram->header.flags.more)
854 ubuf[1] |= 1;
855 if (dgram->header.flags.first)
856 ubuf[1] |= 2;
857 RSSVAL(ubuf,2,dgram->header.dgm_id);
858 putip(ubuf+4,(char *)&dgram->header.source_ip);
859 RSSVAL(ubuf,8,dgram->header.source_port);
860 RSSVAL(ubuf,12,dgram->header.packet_offset);
863 offset = 14;
865 if (dgram->header.msg_type == 0x10 ||
866 dgram->header.msg_type == 0x11 ||
867 dgram->header.msg_type == 0x12) {
868 offset += put_nmb_name((char *)ubuf,offset,&dgram->source_name);
869 offset += put_nmb_name((char *)ubuf,offset,&dgram->dest_name);
872 if (buf) {
873 memcpy(ubuf+offset,dgram->data,dgram->datasize);
875 offset += dgram->datasize;
877 /* automatically set the dgm_length
878 * NOTE: RFC1002 says the dgm_length does *not*
879 * include the fourteen-byte header. crh
881 dgram->header.dgm_length = (offset - 14);
882 if (buf) {
883 RSSVAL(ubuf,10,dgram->header.dgm_length);
886 return offset;
889 /*******************************************************************
890 Build a nmb name
891 *******************************************************************/
893 void make_nmb_name( struct nmb_name *n, const char *name, int type)
895 fstring unix_name;
896 memset( (char *)n, '\0', sizeof(struct nmb_name) );
897 fstrcpy(unix_name, name);
898 strupper_m(unix_name);
899 push_ascii(n->name, unix_name, sizeof(n->name), STR_TERMINATE);
900 n->name_type = (unsigned int)type & 0xFF;
901 push_ascii(n->scope, global_scope(), 64, STR_TERMINATE);
904 /*******************************************************************
905 Compare two nmb names
906 ******************************************************************/
908 bool nmb_name_equal(struct nmb_name *n1, struct nmb_name *n2)
910 return ((n1->name_type == n2->name_type) &&
911 strequal(n1->name ,n2->name ) &&
912 strequal(n1->scope,n2->scope));
915 /*******************************************************************
916 Build a nmb packet ready for sending.
917 If buf == NULL this is a length calculation.
918 ******************************************************************/
920 static int build_nmb(char *buf, size_t len, struct nmb_packet *nmb)
922 unsigned char *ubuf = (unsigned char *)buf;
923 int offset=0;
925 if (len && len < 12) {
926 return 0;
929 /* put in the header */
930 if (buf) {
931 RSSVAL(ubuf,offset,nmb->header.name_trn_id);
932 ubuf[offset+2] = (nmb->header.opcode & 0xF) << 3;
933 if (nmb->header.response)
934 ubuf[offset+2] |= (1<<7);
935 if (nmb->header.nm_flags.authoritative &&
936 nmb->header.response)
937 ubuf[offset+2] |= 0x4;
938 if (nmb->header.nm_flags.trunc)
939 ubuf[offset+2] |= 0x2;
940 if (nmb->header.nm_flags.recursion_desired)
941 ubuf[offset+2] |= 0x1;
942 if (nmb->header.nm_flags.recursion_available &&
943 nmb->header.response)
944 ubuf[offset+3] |= 0x80;
945 if (nmb->header.nm_flags.bcast)
946 ubuf[offset+3] |= 0x10;
947 ubuf[offset+3] |= (nmb->header.rcode & 0xF);
949 RSSVAL(ubuf,offset+4,nmb->header.qdcount);
950 RSSVAL(ubuf,offset+6,nmb->header.ancount);
951 RSSVAL(ubuf,offset+8,nmb->header.nscount);
952 RSSVAL(ubuf,offset+10,nmb->header.arcount);
955 offset += 12;
956 if (nmb->header.qdcount) {
957 /* XXXX this doesn't handle a qdcount of > 1 */
958 if (len) {
959 /* Length check. */
960 int extra = put_nmb_name(NULL,offset,
961 &nmb->question.question_name);
962 if (offset + extra > len) {
963 return 0;
966 offset += put_nmb_name((char *)ubuf,offset,
967 &nmb->question.question_name);
968 if (buf) {
969 RSSVAL(ubuf,offset,nmb->question.question_type);
970 RSSVAL(ubuf,offset+2,nmb->question.question_class);
972 offset += 4;
975 if (nmb->header.ancount) {
976 if (len) {
977 /* Length check. */
978 int extra = put_res_rec(NULL,offset,nmb->answers,
979 nmb->header.ancount);
980 if (offset + extra > len) {
981 return 0;
984 offset += put_res_rec((char *)ubuf,offset,nmb->answers,
985 nmb->header.ancount);
988 if (nmb->header.nscount) {
989 if (len) {
990 /* Length check. */
991 int extra = put_res_rec(NULL,offset,nmb->nsrecs,
992 nmb->header.nscount);
993 if (offset + extra > len) {
994 return 0;
997 offset += put_res_rec((char *)ubuf,offset,nmb->nsrecs,
998 nmb->header.nscount);
1002 * The spec says we must put compressed name pointers
1003 * in the following outgoing packets :
1004 * NAME_REGISTRATION_REQUEST, NAME_REFRESH_REQUEST,
1005 * NAME_RELEASE_REQUEST.
1008 if((nmb->header.response == False) &&
1009 ((nmb->header.opcode == NMB_NAME_REG_OPCODE) ||
1010 (nmb->header.opcode == NMB_NAME_RELEASE_OPCODE) ||
1011 (nmb->header.opcode == NMB_NAME_REFRESH_OPCODE_8) ||
1012 (nmb->header.opcode == NMB_NAME_REFRESH_OPCODE_9) ||
1013 (nmb->header.opcode == NMB_NAME_MULTIHOMED_REG_OPCODE)) &&
1014 (nmb->header.arcount == 1)) {
1016 if (len) {
1017 /* Length check. */
1018 int extra = put_compressed_name_ptr(NULL,offset,
1019 nmb->additional,12);
1020 if (offset + extra > len) {
1021 return 0;
1024 offset += put_compressed_name_ptr(ubuf,offset,
1025 nmb->additional,12);
1026 } else if (nmb->header.arcount) {
1027 if (len) {
1028 /* Length check. */
1029 int extra = put_res_rec(NULL,offset,nmb->additional,
1030 nmb->header.arcount);
1031 if (offset + extra > len) {
1032 return 0;
1035 offset += put_res_rec((char *)ubuf,offset,nmb->additional,
1036 nmb->header.arcount);
1038 return offset;
1041 /*******************************************************************
1042 Linearise a packet.
1043 ******************************************************************/
1045 int build_packet(char *buf, size_t buflen, struct packet_struct *p)
1047 int len = 0;
1049 switch (p->packet_type) {
1050 case NMB_PACKET:
1051 len = build_nmb(buf,buflen,&p->packet.nmb);
1052 break;
1054 case DGRAM_PACKET:
1055 len = build_dgram(buf,buflen,&p->packet.dgram);
1056 break;
1059 return len;
1062 /*******************************************************************
1063 Send a packet_struct.
1064 ******************************************************************/
1066 bool send_packet(struct packet_struct *p)
1068 char buf[1024];
1069 int len=0;
1071 memset(buf,'\0',sizeof(buf));
1073 len = build_packet(buf, sizeof(buf), p);
1075 if (!len)
1076 return(False);
1078 return(send_udp(p->fd,buf,len,p->ip,p->port));
1081 /****************************************************************************
1082 Receive a packet with timeout on a open UDP filedescriptor.
1083 The timeout is in milliseconds
1084 ***************************************************************************/
1086 struct packet_struct *receive_packet(int fd,enum packet_type type,int t)
1088 fd_set fds;
1089 struct timeval timeout;
1090 int ret;
1092 if (fd < 0 || fd >= FD_SETSIZE) {
1093 errno = EBADF;
1094 return NULL;
1097 FD_ZERO(&fds);
1098 FD_SET(fd,&fds);
1099 timeout.tv_sec = t/1000;
1100 timeout.tv_usec = 1000*(t%1000);
1102 if ((ret = sys_select_intr(fd+1,&fds,NULL,NULL,&timeout)) == -1) {
1103 /* errno should be EBADF or EINVAL. */
1104 DEBUG(0,("select returned -1, errno = %s (%d)\n",
1105 strerror(errno), errno));
1106 return NULL;
1109 if (ret == 0) /* timeout */
1110 return NULL;
1112 if (FD_ISSET(fd,&fds))
1113 return(read_packet(fd,type));
1115 return(NULL);
1118 /****************************************************************************
1119 Receive a UDP/137 packet either via UDP or from the unexpected packet
1120 queue. The packet must be a reply packet and have the specified trn_id.
1121 The timeout is in milliseconds.
1122 ***************************************************************************/
1124 struct packet_struct *receive_nmb_packet(int fd, int t, int trn_id)
1126 struct packet_struct *p;
1128 p = receive_packet(fd, NMB_PACKET, t);
1130 if (p && p->packet.nmb.header.response &&
1131 p->packet.nmb.header.name_trn_id == trn_id) {
1132 return p;
1134 if (p)
1135 free_packet(p);
1137 /* try the unexpected packet queue */
1138 return receive_unexpected(NMB_PACKET, trn_id, NULL);
1141 /****************************************************************************
1142 Receive a UDP/138 packet either via UDP or from the unexpected packet
1143 queue. The packet must be a reply packet and have the specified mailslot name
1144 The timeout is in milliseconds.
1145 ***************************************************************************/
1147 struct packet_struct *receive_dgram_packet(int fd, int t,
1148 const char *mailslot_name)
1150 struct packet_struct *p;
1152 p = receive_packet(fd, DGRAM_PACKET, t);
1154 if (p && match_mailslot_name(p, mailslot_name)) {
1155 return p;
1157 if (p)
1158 free_packet(p);
1160 /* try the unexpected packet queue */
1161 return receive_unexpected(DGRAM_PACKET, 0, mailslot_name);
1164 /****************************************************************************
1165 See if a datagram has the right mailslot name.
1166 ***************************************************************************/
1168 bool match_mailslot_name(struct packet_struct *p, const char *mailslot_name)
1170 struct dgram_packet *dgram = &p->packet.dgram;
1171 char *buf;
1173 buf = &dgram->data[0];
1174 buf -= 4;
1176 buf = smb_buf(buf);
1178 if (memcmp(buf, mailslot_name, strlen(mailslot_name)+1) == 0) {
1179 return True;
1182 return False;
1185 /****************************************************************************
1186 Return the number of bits that match between two len character buffers
1187 ***************************************************************************/
1189 int matching_len_bits(unsigned char *p1, unsigned char *p2, size_t len)
1191 size_t i, j;
1192 int ret = 0;
1193 for (i=0; i<len; i++) {
1194 if (p1[i] != p2[i])
1195 break;
1196 ret += 8;
1199 if (i==len)
1200 return ret;
1202 for (j=0; j<8; j++) {
1203 if ((p1[i] & (1<<(7-j))) != (p2[i] & (1<<(7-j))))
1204 break;
1205 ret++;
1208 return ret;
1211 static unsigned char sort_ip[4];
1213 /****************************************************************************
1214 Compare two query reply records.
1215 ***************************************************************************/
1217 static int name_query_comp(unsigned char *p1, unsigned char *p2)
1219 return matching_len_bits(p2+2, sort_ip, 4) -
1220 matching_len_bits(p1+2, sort_ip, 4);
1223 /****************************************************************************
1224 Sort a set of 6 byte name query response records so that the IPs that
1225 have the most leading bits in common with the specified address come first.
1226 ***************************************************************************/
1228 void sort_query_replies(char *data, int n, struct in_addr ip)
1230 if (n <= 1)
1231 return;
1233 putip(sort_ip, (char *)&ip);
1235 qsort(data, n, 6, QSORT_CAST name_query_comp);
1238 /****************************************************************************
1239 Interpret the weird netbios "name" into a unix fstring. Return the name type.
1240 ****************************************************************************/
1242 static int name_interpret(char *in, fstring name)
1244 int ret;
1245 int len = (*in++) / 2;
1246 fstring out_string;
1247 char *out = out_string;
1249 *out=0;
1251 if (len > 30 || len<1)
1252 return(0);
1254 while (len--) {
1255 if (in[0] < 'A' || in[0] > 'P' || in[1] < 'A' || in[1] > 'P') {
1256 *out = 0;
1257 return(0);
1259 *out = ((in[0]-'A')<<4) + (in[1]-'A');
1260 in += 2;
1261 out++;
1263 ret = out[-1];
1264 out[-1] = 0;
1266 #ifdef NETBIOS_SCOPE
1267 /* Handle any scope names */
1268 while(*in) {
1269 *out++ = '.'; /* Scope names are separated by periods */
1270 len = *(unsigned char *)in++;
1271 StrnCpy(out, in, len);
1272 out += len;
1273 *out=0;
1274 in += len;
1276 #endif
1277 pull_ascii_fstring(name, out_string);
1279 return(ret);
1282 /****************************************************************************
1283 Mangle a name into netbios format.
1284 Note: <Out> must be (33 + strlen(scope) + 2) bytes long, at minimum.
1285 ****************************************************************************/
1287 char *name_mangle(TALLOC_CTX *mem_ctx, const char *In, char name_type)
1289 int i;
1290 int len;
1291 nstring buf;
1292 char *result;
1293 char *p;
1295 result = talloc_array(mem_ctx, char, 33 + strlen(global_scope()) + 2);
1296 if (result == NULL) {
1297 return NULL;
1299 p = result;
1301 /* Safely copy the input string, In, into buf[]. */
1302 if (strcmp(In,"*") == 0)
1303 put_name(buf, "*", '\0', 0x00);
1304 else {
1305 /* We use an fstring here as mb dos names can expend x3 when
1306 going to utf8. */
1307 fstring buf_unix;
1308 nstring buf_dos;
1310 pull_ascii_fstring(buf_unix, In);
1311 strupper_m(buf_unix);
1313 push_ascii_nstring(buf_dos, buf_unix);
1314 put_name(buf, buf_dos, ' ', name_type);
1317 /* Place the length of the first field into the output buffer. */
1318 p[0] = 32;
1319 p++;
1321 /* Now convert the name to the rfc1001/1002 format. */
1322 for( i = 0; i < MAX_NETBIOSNAME_LEN; i++ ) {
1323 p[i*2] = ( (buf[i] >> 4) & 0x000F ) + 'A';
1324 p[(i*2)+1] = (buf[i] & 0x000F) + 'A';
1326 p += 32;
1327 p[0] = '\0';
1329 /* Add the scope string. */
1330 for( i = 0, len = 0; *(global_scope()) != '\0'; i++, len++ ) {
1331 switch( (global_scope())[i] ) {
1332 case '\0':
1333 p[0] = len;
1334 if( len > 0 )
1335 p[len+1] = 0;
1336 return result;
1337 case '.':
1338 p[0] = len;
1339 p += (len + 1);
1340 len = -1;
1341 break;
1342 default:
1343 p[len+1] = (global_scope())[i];
1344 break;
1348 return result;
1351 /****************************************************************************
1352 Find a pointer to a netbios name.
1353 ****************************************************************************/
1355 static char *name_ptr(char *buf,int ofs)
1357 unsigned char c = *(unsigned char *)(buf+ofs);
1359 if ((c & 0xC0) == 0xC0) {
1360 uint16 l = RSVAL(buf, ofs) & 0x3FFF;
1361 DEBUG(5,("name ptr to pos %d from %d is %s\n",l,ofs,buf+l));
1362 return(buf + l);
1363 } else {
1364 return(buf+ofs);
1368 /****************************************************************************
1369 Extract a netbios name from a buf (into a unix string) return name type.
1370 ****************************************************************************/
1372 int name_extract(char *buf,int ofs, fstring name)
1374 char *p = name_ptr(buf,ofs);
1375 int d = PTR_DIFF(p,buf+ofs);
1377 name[0] = '\0';
1378 if (d < -50 || d > 50)
1379 return(0);
1380 return(name_interpret(p,name));
1383 /****************************************************************************
1384 Return the total storage length of a mangled name.
1385 ****************************************************************************/
1387 int name_len(char *s1)
1389 /* NOTE: this argument _must_ be unsigned */
1390 unsigned char *s = (unsigned char *)s1;
1391 int len;
1393 /* If the two high bits of the byte are set, return 2. */
1394 if (0xC0 == (*s & 0xC0))
1395 return(2);
1397 /* Add up the length bytes. */
1398 for (len = 1; (*s); s += (*s) + 1) {
1399 len += *s + 1;
1400 SMB_ASSERT(len < 80);
1403 return(len);