91c3305996e8cf18a3e4c813e0801883cf3a0029
[samba] / source / lib / util_sock.c
1 /* 
2    Unix SMB/CIFS implementation.
3    Samba utility functions
4    Copyright (C) Andrew Tridgell 1992-1998
5    Copyright (C) Tim Potter      2000-2001
6    Copyright (C) Jeremy Allison  1992-2005
7    
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.
12    
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.
17    
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.
21 */
22
23 #include "includes.h"
24
25 /* the following 3 client_*() functions are nasty ways of allowing
26    some generic functions to get info that really should be hidden in
27    particular modules */
28 static int client_fd = -1;
29 /* What to print out on a client disconnect error. */
30 static char client_ip_string[16];
31
32 void client_setfd(int fd)
33 {
34         client_fd = fd;
35         safe_strcpy(client_ip_string, get_peer_addr(client_fd), sizeof(client_ip_string)-1);
36 }
37
38 static char *get_socket_addr(int fd)
39 {
40         struct sockaddr sa;
41         struct sockaddr_in *sockin = (struct sockaddr_in *) (&sa);
42         socklen_t length = sizeof(sa);
43         static fstring addr_buf;
44
45         fstrcpy(addr_buf,"0.0.0.0");
46
47         if (fd == -1) {
48                 return addr_buf;
49         }
50         
51         if (getsockname(fd, &sa, &length) < 0) {
52                 DEBUG(0,("getsockname failed. Error was %s\n", strerror(errno) ));
53                 return addr_buf;
54         }
55         
56         fstrcpy(addr_buf,(char *)inet_ntoa(sockin->sin_addr));
57         
58         return addr_buf;
59 }
60
61 static int get_socket_port(int fd)
62 {
63         struct sockaddr sa;
64         struct sockaddr_in *sockin = (struct sockaddr_in *) (&sa);
65         socklen_t length = sizeof(sa);
66
67         if (fd == -1)
68                 return -1;
69         
70         if (getsockname(fd, &sa, &length) < 0) {
71                 DEBUG(0,("getpeername failed. Error was %s\n", strerror(errno) ));
72                 return -1;
73         }
74         
75         return ntohs(sockin->sin_port);
76 }
77
78 char *client_name(void)
79 {
80         return get_peer_name(client_fd,False);
81 }
82
83 char *client_addr(void)
84 {
85         return get_peer_addr(client_fd);
86 }
87
88 char *client_socket_addr(void)
89 {
90         return get_socket_addr(client_fd);
91 }
92
93 int client_socket_port(void)
94 {
95         return get_socket_port(client_fd);
96 }
97
98 struct in_addr *client_inaddr(struct sockaddr *sa)
99 {
100         struct sockaddr_in *sockin = (struct sockaddr_in *) (sa);
101         socklen_t  length = sizeof(*sa);
102         
103         if (getpeername(client_fd, sa, &length) < 0) {
104                 DEBUG(0,("getpeername failed. Error was %s\n", strerror(errno) ));
105                 return NULL;
106         }
107         
108         return &sockin->sin_addr;
109 }
110
111 /* the last IP received from */
112 struct in_addr lastip;
113
114 /* the last port received from */
115 int lastport=0;
116
117 int smb_read_error = 0;
118
119 /****************************************************************************
120  Determine if a file descriptor is in fact a socket.
121 ****************************************************************************/
122
123 BOOL is_a_socket(int fd)
124 {
125         int v;
126         socklen_t l;
127         l = sizeof(int);
128         return(getsockopt(fd, SOL_SOCKET, SO_TYPE, (char *)&v, &l) == 0);
129 }
130
131 enum SOCK_OPT_TYPES {OPT_BOOL,OPT_INT,OPT_ON};
132
133 typedef struct smb_socket_option {
134         const char *name;
135         int level;
136         int option;
137         int value;
138         int opttype;
139 } smb_socket_option;
140
141 static const smb_socket_option socket_options[] = {
142   {"SO_KEEPALIVE",      SOL_SOCKET,    SO_KEEPALIVE,    0,                 OPT_BOOL},
143   {"SO_REUSEADDR",      SOL_SOCKET,    SO_REUSEADDR,    0,                 OPT_BOOL},
144   {"SO_BROADCAST",      SOL_SOCKET,    SO_BROADCAST,    0,                 OPT_BOOL},
145 #ifdef TCP_NODELAY
146   {"TCP_NODELAY",       IPPROTO_TCP,   TCP_NODELAY,     0,                 OPT_BOOL},
147 #endif
148 #ifdef TCP_KEEPCNT
149   {"TCP_KEEPCNT",       IPPROTO_TCP,   TCP_KEEPCNT,     0,                 OPT_INT},
150 #endif
151 #ifdef TCP_KEEPIDLE
152   {"TCP_KEEPIDLE",      IPPROTO_TCP,   TCP_KEEPIDLE,    0,                 OPT_INT},
153 #endif
154 #ifdef TCP_KEEPINTVL
155   {"TCP_KEEPINTVL",     IPPROTO_TCP,   TCP_KEEPINTVL,   0,                 OPT_INT},
156 #endif
157 #ifdef IPTOS_LOWDELAY
158   {"IPTOS_LOWDELAY",    IPPROTO_IP,    IP_TOS,          IPTOS_LOWDELAY,    OPT_ON},
159 #endif
160 #ifdef IPTOS_THROUGHPUT
161   {"IPTOS_THROUGHPUT",  IPPROTO_IP,    IP_TOS,          IPTOS_THROUGHPUT,  OPT_ON},
162 #endif
163 #ifdef SO_REUSEPORT
164   {"SO_REUSEPORT",      SOL_SOCKET,    SO_REUSEPORT,    0,                 OPT_BOOL},
165 #endif
166 #ifdef SO_SNDBUF
167   {"SO_SNDBUF",         SOL_SOCKET,    SO_SNDBUF,       0,                 OPT_INT},
168 #endif
169 #ifdef SO_RCVBUF
170   {"SO_RCVBUF",         SOL_SOCKET,    SO_RCVBUF,       0,                 OPT_INT},
171 #endif
172 #ifdef SO_SNDLOWAT
173   {"SO_SNDLOWAT",       SOL_SOCKET,    SO_SNDLOWAT,     0,                 OPT_INT},
174 #endif
175 #ifdef SO_RCVLOWAT
176   {"SO_RCVLOWAT",       SOL_SOCKET,    SO_RCVLOWAT,     0,                 OPT_INT},
177 #endif
178 #ifdef SO_SNDTIMEO
179   {"SO_SNDTIMEO",       SOL_SOCKET,    SO_SNDTIMEO,     0,                 OPT_INT},
180 #endif
181 #ifdef SO_RCVTIMEO
182   {"SO_RCVTIMEO",       SOL_SOCKET,    SO_RCVTIMEO,     0,                 OPT_INT},
183 #endif
184 #ifdef TCP_FASTACK
185   {"TCP_FASTACK",       IPPROTO_TCP,   TCP_FASTACK,     0,                 OPT_INT},
186 #endif
187   {NULL,0,0,0,0}};
188
189 /****************************************************************************
190  Print socket options.
191 ****************************************************************************/
192
193 static void print_socket_options(int s)
194 {
195         int value;
196         socklen_t vlen = 4;
197         const smb_socket_option *p = &socket_options[0];
198
199         /* wrapped in if statement to prevent streams leak in SCO Openserver 5.0 */
200         /* reported on samba-technical  --jerry */
201         if ( DEBUGLEVEL >= 5 ) {
202         for (; p->name != NULL; p++) {
203                 if (getsockopt(s, p->level, p->option, (void *)&value, &vlen) == -1) {
204                         DEBUG(5,("Could not test socket option %s.\n", p->name));
205                 } else {
206                         DEBUG(5,("socket option %s = %d\n",p->name,value));
207                         }
208                 }
209         }
210  }
211
212 /****************************************************************************
213  Set user socket options.
214 ****************************************************************************/
215
216 void set_socket_options(int fd, const char *options)
217 {
218         fstring tok;
219
220         while (next_token(&options,tok," \t,", sizeof(tok))) {
221                 int ret=0,i;
222                 int value = 1;
223                 char *p;
224                 BOOL got_value = False;
225
226                 if ((p = strchr_m(tok,'='))) {
227                         *p = 0;
228                         value = atoi(p+1);
229                         got_value = True;
230                 }
231
232                 for (i=0;socket_options[i].name;i++)
233                         if (strequal(socket_options[i].name,tok))
234                                 break;
235
236                 if (!socket_options[i].name) {
237                         DEBUG(0,("Unknown socket option %s\n",tok));
238                         continue;
239                 }
240
241                 switch (socket_options[i].opttype) {
242                 case OPT_BOOL:
243                 case OPT_INT:
244                         ret = setsockopt(fd,socket_options[i].level,
245                                                 socket_options[i].option,(char *)&value,sizeof(int));
246                         break;
247
248                 case OPT_ON:
249                         if (got_value)
250                                 DEBUG(0,("syntax error - %s does not take a value\n",tok));
251
252                         {
253                                 int on = socket_options[i].value;
254                                 ret = setsockopt(fd,socket_options[i].level,
255                                                         socket_options[i].option,(char *)&on,sizeof(int));
256                         }
257                         break;    
258                 }
259       
260                 if (ret != 0)
261                         DEBUG(0,("Failed to set socket option %s (Error %s)\n",tok, strerror(errno) ));
262         }
263
264         print_socket_options(fd);
265 }
266
267 /****************************************************************************
268  Read from a socket.
269 ****************************************************************************/
270
271 ssize_t read_udp_socket(int fd,char *buf,size_t len)
272 {
273         ssize_t ret;
274         struct sockaddr_in sock;
275         socklen_t socklen = sizeof(sock);
276
277         memset((char *)&sock,'\0',socklen);
278         memset((char *)&lastip,'\0',sizeof(lastip));
279         ret = (ssize_t)sys_recvfrom(fd,buf,len,0,(struct sockaddr *)&sock,&socklen);
280         if (ret <= 0) {
281                 DEBUG(2,("read socket failed. ERRNO=%s\n",strerror(errno)));
282                 return(0);
283         }
284
285         lastip = sock.sin_addr;
286         lastport = ntohs(sock.sin_port);
287
288         DEBUG(10,("read_udp_socket: lastip %s lastport %d read: %lu\n",
289                         inet_ntoa(lastip), lastport, (unsigned long)ret));
290
291         return(ret);
292 }
293
294 #if 0
295
296 Socket routines from HEAD - maybe re-enable in future. JRA.
297
298 /****************************************************************************
299  Work out if we've timed out.
300 ****************************************************************************/
301
302 static BOOL timeout_until(struct timeval *timeout, const struct timeval *endtime)
303 {
304         struct timeval now;
305         SMB_BIG_INT t_dif;
306
307         GetTimeOfDay(&now);
308
309         t_dif = usec_time_diff(endtime, &now);
310         if (t_dif <= 0) {
311                 return False;
312         }
313
314         timeout->tv_sec = (t_dif / (SMB_BIG_INT)1000000);
315         timeout->tv_usec = (t_dif % (SMB_BIG_INT)1000000);
316         return True;
317 }
318
319 /****************************************************************************
320  Read data from the client, reading exactly N bytes, or until endtime timeout.
321  Use with a non-blocking socket if endtime != NULL.
322 ****************************************************************************/
323
324 ssize_t read_data_until(int fd,char *buffer,size_t N, const struct timeval *endtime)
325 {
326         ssize_t ret;
327         size_t total=0;
328
329         smb_read_error = 0;
330
331         while (total < N) {
332
333                 if (endtime != NULL) {
334                         fd_set r_fds;
335                         struct timeval timeout;
336                         int selrtn;
337
338                         if (!timeout_until(&timeout, endtime)) {
339                                 DEBUG(10,("read_data_until: read timed out\n"));
340                                 smb_read_error = READ_TIMEOUT;
341                                 return -1;
342                         }
343
344                         FD_ZERO(&r_fds);
345                         FD_SET(fd, &r_fds);
346
347                         /* Select but ignore EINTR. */
348                         selrtn = sys_select_intr(fd+1, &r_fds, NULL, NULL, &timeout);
349                         if (selrtn == -1) {
350                                 /* something is wrong. Maybe the socket is dead? */
351                                 DEBUG(0,("read_data_until: select error = %s.\n", strerror(errno) ));
352                                 smb_read_error = READ_ERROR;
353                                 return -1;
354                         }
355
356                         /* Did we timeout ? */
357                         if (selrtn == 0) {
358                                 DEBUG(10,("read_data_until: select timed out.\n"));
359                                 smb_read_error = READ_TIMEOUT;
360                                 return -1;
361                         }
362                 }
363
364                 ret = sys_read(fd,buffer + total,N - total);
365
366                 if (ret == 0) {
367                         DEBUG(10,("read_data_until: read of %d returned 0. Error = %s\n", (int)(N - total), strerror(errno) ));
368                         smb_read_error = READ_EOF;
369                         return 0;
370                 }
371
372                 if (ret == -1) {
373                         if (errno == EAGAIN) {
374                                 /* Non-blocking socket with no data available. Try select again. */
375                                 continue;
376                         }
377                         DEBUG(0,("read_data_until: read failure for %d. Error = %s\n", (int)(N - total), strerror(errno) ));
378                         smb_read_error = READ_ERROR;
379                         return -1;
380                 }
381                 total += ret;
382         }
383         return (ssize_t)total;
384 }
385 #endif
386
387 /****************************************************************************
388  Read data from a socket with a timout in msec.
389  mincount = if timeout, minimum to read before returning
390  maxcount = number to be read.
391  time_out = timeout in milliseconds
392 ****************************************************************************/
393
394 ssize_t read_socket_with_timeout(int fd,char *buf,size_t mincnt,size_t maxcnt,unsigned int time_out)
395 {
396         fd_set fds;
397         int selrtn;
398         ssize_t readret;
399         size_t nread = 0;
400         struct timeval timeout;
401         
402         /* just checking .... */
403         if (maxcnt <= 0)
404                 return(0);
405         
406         smb_read_error = 0;
407         
408         /* Blocking read */
409         if (time_out == 0) {
410                 if (mincnt == 0) {
411                         mincnt = maxcnt;
412                 }
413                 
414                 while (nread < mincnt) {
415                         readret = sys_read(fd, buf + nread, maxcnt - nread);
416                         
417                         if (readret == 0) {
418                                 DEBUG(5,("read_socket_with_timeout: blocking read. EOF from client.\n"));
419                                 smb_read_error = READ_EOF;
420                                 return -1;
421                         }
422                         
423                         if (readret == -1) {
424                                 if (fd == client_fd) {
425                                         /* Try and give an error message saying what client failed. */
426                                         DEBUG(0,("read_socket_with_timeout: client %s read error = %s.\n",
427                                                 client_ip_string, strerror(errno) ));
428                                 } else {
429                                         DEBUG(0,("read_socket_with_timeout: read error = %s.\n", strerror(errno) ));
430                                 }
431                                 smb_read_error = READ_ERROR;
432                                 return -1;
433                         }
434                         nread += readret;
435                 }
436                 return((ssize_t)nread);
437         }
438         
439         /* Most difficult - timeout read */
440         /* If this is ever called on a disk file and 
441            mincnt is greater then the filesize then
442            system performance will suffer severely as 
443            select always returns true on disk files */
444         
445         /* Set initial timeout */
446         timeout.tv_sec = (time_t)(time_out / 1000);
447         timeout.tv_usec = (long)(1000 * (time_out % 1000));
448         
449         for (nread=0; nread < mincnt; ) {      
450                 FD_ZERO(&fds);
451                 FD_SET(fd,&fds);
452                 
453                 selrtn = sys_select_intr(fd+1,&fds,NULL,NULL,&timeout);
454                 
455                 /* Check if error */
456                 if (selrtn == -1) {
457                         /* something is wrong. Maybe the socket is dead? */
458                         if (fd == client_fd) {
459                                 /* Try and give an error message saying what client failed. */
460                                 DEBUG(0,("read_socket_with_timeout: timeout read for client %s. select error = %s.\n",
461                                         client_ip_string, strerror(errno) ));
462                         } else {
463                                 DEBUG(0,("read_socket_with_timeout: timeout read. select error = %s.\n", strerror(errno) ));
464                         }
465                         smb_read_error = READ_ERROR;
466                         return -1;
467                 }
468                 
469                 /* Did we timeout ? */
470                 if (selrtn == 0) {
471                         DEBUG(10,("read_socket_with_timeout: timeout read. select timed out.\n"));
472                         smb_read_error = READ_TIMEOUT;
473                         return -1;
474                 }
475                 
476                 readret = sys_read(fd, buf+nread, maxcnt-nread);
477                 
478                 if (readret == 0) {
479                         /* we got EOF on the file descriptor */
480                         DEBUG(5,("read_socket_with_timeout: timeout read. EOF from client.\n"));
481                         smb_read_error = READ_EOF;
482                         return -1;
483                 }
484                 
485                 if (readret == -1) {
486                         /* the descriptor is probably dead */
487                         if (fd == client_fd) {
488                                 /* Try and give an error message saying what client failed. */
489                                 DEBUG(0,("read_socket_with_timeout: timeout read to client %s. read error = %s.\n",
490                                         client_ip_string, strerror(errno) ));
491                         } else {
492                                 DEBUG(0,("read_socket_with_timeout: timeout read. read error = %s.\n", strerror(errno) ));
493                         }
494                         smb_read_error = READ_ERROR;
495                         return -1;
496                 }
497                 
498                 nread += readret;
499         }
500         
501         /* Return the number we got */
502         return (ssize_t)nread;
503 }
504
505 /****************************************************************************
506  Read data from the client, reading exactly N bytes. 
507 ****************************************************************************/
508
509 ssize_t read_data(int fd,char *buffer,size_t N)
510 {
511         ssize_t ret;
512         size_t total=0;  
513  
514         smb_read_error = 0;
515
516         while (total < N) {
517                 ret = sys_read(fd,buffer + total,N - total);
518
519                 if (ret == 0) {
520                         DEBUG(10,("read_data: read of %d returned 0. Error = %s\n", (int)(N - total), strerror(errno) ));
521                         smb_read_error = READ_EOF;
522                         return 0;
523                 }
524
525                 if (ret == -1) {
526                         if (fd == client_fd) {
527                                 /* Try and give an error message saying what client failed. */
528                                 DEBUG(0,("read_data: read failure for %d bytes to client %s. Error = %s\n",
529                                         (int)(N - total), client_ip_string, strerror(errno) ));
530                         } else {
531                                 DEBUG(0,("read_data: read failure for %d. Error = %s\n", (int)(N - total), strerror(errno) ));
532                         }
533                         smb_read_error = READ_ERROR;
534                         return -1;
535                 }
536                 total += ret;
537         }
538         return (ssize_t)total;
539 }
540
541 /****************************************************************************
542  Write data to a fd.
543 ****************************************************************************/
544
545 ssize_t write_data(int fd, const char *buffer, size_t N)
546 {
547         size_t total=0;
548         ssize_t ret;
549
550         while (total < N) {
551                 ret = sys_write(fd,buffer + total,N - total);
552
553                 if (ret == -1) {
554                         if (fd == client_fd) {
555                                 /* Try and give an error message saying what client failed. */
556                                 DEBUG(0,("write_data: write failure in writing to client %s. Error %s\n",
557                                         client_ip_string, strerror(errno) ));
558                         } else {
559                                 DEBUG(0,("write_data: write failure. Error = %s\n", strerror(errno) ));
560                         }
561                         return -1;
562                 }
563
564                 if (ret == 0) {
565                         return total;
566                 }
567
568                 total += ret;
569         }
570         return (ssize_t)total;
571 }
572
573 /****************************************************************************
574  Send a keepalive packet (rfc1002).
575 ****************************************************************************/
576
577 BOOL send_keepalive(int client)
578 {
579         unsigned char buf[4];
580
581         buf[0] = SMBkeepalive;
582         buf[1] = buf[2] = buf[3] = 0;
583
584         return(write_data(client,(char *)buf,4) == 4);
585 }
586
587
588 /****************************************************************************
589  Read 4 bytes of a smb packet and return the smb length of the packet.
590  Store the result in the buffer.
591  This version of the function will return a length of zero on receiving
592  a keepalive packet.
593  Timeout is in milliseconds.
594 ****************************************************************************/
595
596 static ssize_t read_smb_length_return_keepalive(int fd, char *inbuf, unsigned int timeout)
597 {
598         ssize_t len=0;
599         int msg_type;
600         BOOL ok = False;
601
602         while (!ok) {
603                 if (timeout > 0)
604                         ok = (read_socket_with_timeout(fd,inbuf,4,4,timeout) == 4);
605                 else 
606                         ok = (read_data(fd,inbuf,4) == 4);
607
608                 if (!ok)
609                         return(-1);
610
611                 len = smb_len(inbuf);
612                 msg_type = CVAL(inbuf,0);
613
614                 if (msg_type == SMBkeepalive) 
615                         DEBUG(5,("Got keepalive packet\n"));
616         }
617
618         DEBUG(10,("got smb length of %lu\n",(unsigned long)len));
619
620         return(len);
621 }
622
623 /****************************************************************************
624  Read 4 bytes of a smb packet and return the smb length of the packet.
625  Store the result in the buffer. This version of the function will
626  never return a session keepalive (length of zero).
627  Timeout is in milliseconds.
628 ****************************************************************************/
629
630 ssize_t read_smb_length(int fd, char *inbuf, unsigned int timeout)
631 {
632         ssize_t len;
633
634         for(;;) {
635                 len = read_smb_length_return_keepalive(fd, inbuf, timeout);
636
637                 if(len < 0)
638                         return len;
639
640                 /* Ignore session keepalives. */
641                 if(CVAL(inbuf,0) != SMBkeepalive)
642                         break;
643         }
644
645         DEBUG(10,("read_smb_length: got smb length of %lu\n",
646                   (unsigned long)len));
647
648         return len;
649 }
650
651 /****************************************************************************
652  Read an smb from a fd. Note that the buffer *MUST* be of size
653  BUFFER_SIZE+SAFETY_MARGIN.
654  The timeout is in milliseconds. 
655  This function will return on receipt of a session keepalive packet.
656  Doesn't check the MAC on signed packets.
657 ****************************************************************************/
658
659 BOOL receive_smb_raw(int fd, char *buffer, unsigned int timeout)
660 {
661         ssize_t len,ret;
662
663         smb_read_error = 0;
664
665         memset(buffer,'\0',smb_size + 100);
666
667         len = read_smb_length_return_keepalive(fd,buffer,timeout);
668         if (len < 0) {
669                 DEBUG(10,("receive_smb_raw: length < 0!\n"));
670
671                 /*
672                  * Correct fix. smb_read_error may have already been
673                  * set. Only set it here if not already set. Global
674                  * variables still suck :-). JRA.
675                  */
676
677                 if (smb_read_error == 0)
678                         smb_read_error = READ_ERROR;
679                 return False;
680         }
681
682         /*
683          * A WRITEX with CAP_LARGE_WRITEX can be 64k worth of data plus 65 bytes
684          * of header. Don't print the error if this fits.... JRA.
685          */
686
687         if (len > (BUFFER_SIZE + LARGE_WRITEX_HDR_SIZE)) {
688                 DEBUG(0,("Invalid packet length! (%lu bytes).\n",(unsigned long)len));
689                 if (len > BUFFER_SIZE + (SAFETY_MARGIN/2)) {
690
691                         /*
692                          * Correct fix. smb_read_error may have already been
693                          * set. Only set it here if not already set. Global
694                          * variables still suck :-). JRA.
695                          */
696
697                         if (smb_read_error == 0)
698                                 smb_read_error = READ_ERROR;
699                         return False;
700                 }
701         }
702
703         if(len > 0) {
704                 if (timeout > 0) {
705                         ret = read_socket_with_timeout(fd,buffer+4,len,len,timeout);
706                 } else {
707                         ret = read_data(fd,buffer+4,len);
708                 }
709
710                 if (ret != len) {
711                         if (smb_read_error == 0)
712                                 smb_read_error = READ_ERROR;
713                         return False;
714                 }
715                 
716                 /* not all of samba3 properly checks for packet-termination of strings. This
717                    ensures that we don't run off into empty space. */
718                 SSVAL(buffer+4,len, 0);
719         }
720
721         return True;
722 }
723
724 /****************************************************************************
725  Wrapper for receive_smb_raw().
726  Checks the MAC on signed packets.
727 ****************************************************************************/
728
729 BOOL receive_smb(int fd, char *buffer, unsigned int timeout)
730 {
731         if (!receive_smb_raw(fd, buffer, timeout)) {
732                 return False;
733         }
734
735         /* Check the incoming SMB signature. */
736         if (!srv_check_sign_mac(buffer, True)) {
737                 DEBUG(0, ("receive_smb: SMB Signature verification failed on incoming packet!\n"));
738                 if (smb_read_error == 0)
739                         smb_read_error = READ_BAD_SIG;
740                 return False;
741         };
742
743         return(True);
744 }
745
746 /****************************************************************************
747  Send an smb to a fd.
748 ****************************************************************************/
749
750 BOOL send_smb(int fd, char *buffer)
751 {
752         size_t len;
753         size_t nwritten=0;
754         ssize_t ret;
755
756         /* Sign the outgoing packet if required. */
757         srv_calculate_sign_mac(buffer);
758
759         len = smb_len(buffer) + 4;
760
761         while (nwritten < len) {
762                 ret = write_data(fd,buffer+nwritten,len - nwritten);
763                 if (ret <= 0) {
764                         DEBUG(0,("Error writing %d bytes to client. %d. (%s)\n",
765                                 (int)len,(int)ret, strerror(errno) ));
766                         return False;
767                 }
768                 nwritten += ret;
769         }
770
771         return True;
772 }
773
774 /****************************************************************************
775  Open a socket of the specified type, port, and address for incoming data.
776 ****************************************************************************/
777
778 int open_socket_in( int type, int port, int dlevel, uint32 socket_addr, BOOL rebind )
779 {
780         struct sockaddr_in sock;
781         int res;
782
783         memset( (char *)&sock, '\0', sizeof(sock) );
784
785 #ifdef HAVE_SOCK_SIN_LEN
786         sock.sin_len         = sizeof(sock);
787 #endif
788         sock.sin_port        = htons( port );
789         sock.sin_family      = AF_INET;
790         sock.sin_addr.s_addr = socket_addr;
791
792         res = socket( AF_INET, type, 0 );
793         if( res == -1 ) {
794                 if( DEBUGLVL(0) ) {
795                         dbgtext( "open_socket_in(): socket() call failed: " );
796                         dbgtext( "%s\n", strerror( errno ) );
797                 }
798                 return -1;
799         }
800
801         /* This block sets/clears the SO_REUSEADDR and possibly SO_REUSEPORT. */
802         {
803                 int val = rebind ? 1 : 0;
804                 if( setsockopt(res,SOL_SOCKET,SO_REUSEADDR,(char *)&val,sizeof(val)) == -1 ) {
805                         if( DEBUGLVL( dlevel ) ) {
806                                 dbgtext( "open_socket_in(): setsockopt: " );
807                                 dbgtext( "SO_REUSEADDR = %s ", val?"True":"False" );
808                                 dbgtext( "on port %d failed ", port );
809                                 dbgtext( "with error = %s\n", strerror(errno) );
810                         }
811                 }
812 #ifdef SO_REUSEPORT
813                 if( setsockopt(res,SOL_SOCKET,SO_REUSEPORT,(char *)&val,sizeof(val)) == -1 ) {
814                         if( DEBUGLVL( dlevel ) ) {
815                                 dbgtext( "open_socket_in(): setsockopt: ");
816                                 dbgtext( "SO_REUSEPORT = %s ", val?"True":"False" );
817                                 dbgtext( "on port %d failed ", port );
818                                 dbgtext( "with error = %s\n", strerror(errno) );
819                         }
820                 }
821 #endif /* SO_REUSEPORT */
822         }
823
824         /* now we've got a socket - we need to bind it */
825         if( bind( res, (struct sockaddr *)&sock, sizeof(sock) ) == -1 ) {
826                 if( DEBUGLVL(dlevel) && (port == SMB_PORT1 || port == SMB_PORT2 || port == NMB_PORT) ) {
827                         dbgtext( "bind failed on port %d ", port );
828                         dbgtext( "socket_addr = %s.\n", inet_ntoa( sock.sin_addr ) );
829                         dbgtext( "Error = %s\n", strerror(errno) );
830                 }
831                 close( res ); 
832                 return( -1 ); 
833         }
834
835         DEBUG( 10, ( "bind succeeded on port %d\n", port ) );
836
837         return( res );
838  }
839
840 /****************************************************************************
841  Create an outgoing socket. timeout is in milliseconds.
842 **************************************************************************/
843
844 int open_socket_out(int type, struct in_addr *addr, int port ,int timeout)
845 {
846         struct sockaddr_in sock_out;
847         int res,ret;
848         int connect_loop = 10;
849         int increment = 10;
850
851         /* create a socket to write to */
852         res = socket(PF_INET, type, 0);
853         if (res == -1) {
854                 DEBUG(0,("socket error (%s)\n", strerror(errno)));
855                 return -1;
856         }
857
858         if (type != SOCK_STREAM)
859                 return(res);
860   
861         memset((char *)&sock_out,'\0',sizeof(sock_out));
862         putip((char *)&sock_out.sin_addr,(char *)addr);
863   
864         sock_out.sin_port = htons( port );
865         sock_out.sin_family = PF_INET;
866
867         /* set it non-blocking */
868         set_blocking(res,False);
869
870         DEBUG(3,("Connecting to %s at port %d\n",inet_ntoa(*addr),port));
871   
872         /* and connect it to the destination */
873   connect_again:
874
875         ret = connect(res,(struct sockaddr *)&sock_out,sizeof(sock_out));
876
877         /* Some systems return EAGAIN when they mean EINPROGRESS */
878         if (ret < 0 && (errno == EINPROGRESS || errno == EALREADY ||
879                         errno == EAGAIN) && (connect_loop < timeout) ) {
880                 smb_msleep(connect_loop);
881                 timeout -= connect_loop;
882                 connect_loop += increment;
883                 if (increment < 250) {
884                         /* After 8 rounds we end up at a max of 255 msec */
885                         increment *= 1.5;
886                 }
887                 goto connect_again;
888         }
889
890         if (ret < 0 && (errno == EINPROGRESS || errno == EALREADY ||
891                         errno == EAGAIN)) {
892                 DEBUG(1,("timeout connecting to %s:%d\n",inet_ntoa(*addr),port));
893                 close(res);
894                 return -1;
895         }
896
897 #ifdef EISCONN
898
899         if (ret < 0 && errno == EISCONN) {
900                 errno = 0;
901                 ret = 0;
902         }
903 #endif
904
905         if (ret < 0) {
906                 DEBUG(2,("error connecting to %s:%d (%s)\n",
907                                 inet_ntoa(*addr),port,strerror(errno)));
908                 close(res);
909                 return -1;
910         }
911
912         /* set it blocking again */
913         set_blocking(res,True);
914
915         return res;
916 }
917
918 /****************************************************************************
919  Create an outgoing TCP socket to any of the addrs. This is for
920  simultaneous connects to port 445 and 139 of a host or even a variety
921  of DC's all of which are equivalent for our purposes.
922 **************************************************************************/
923
924 BOOL open_any_socket_out(struct sockaddr_in *addrs, int num_addrs,
925                          int timeout, int *fd_index, int *fd)
926 {
927         int i, resulting_index, res;
928         int *sockets;
929         BOOL good_connect;
930
931         fd_set r_fds, wr_fds;
932         struct timeval tv;
933         int maxfd;
934
935         int connect_loop = 10000; /* 10 milliseconds */
936
937         timeout *= 1000;        /* convert to microseconds */
938
939         sockets = SMB_MALLOC_ARRAY(int, num_addrs);
940
941         if (sockets == NULL)
942                 return False;
943
944         resulting_index = -1;
945
946         for (i=0; i<num_addrs; i++)
947                 sockets[i] = -1;
948
949         for (i=0; i<num_addrs; i++) {
950                 sockets[i] = socket(PF_INET, SOCK_STREAM, 0);
951                 if (sockets[i] < 0)
952                         goto done;
953                 set_blocking(sockets[i], False);
954         }
955
956  connect_again:
957         good_connect = False;
958
959         for (i=0; i<num_addrs; i++) {
960
961                 if (sockets[i] == -1)
962                         continue;
963
964                 if (connect(sockets[i], (struct sockaddr *)&(addrs[i]),
965                             sizeof(*addrs)) == 0) {
966                         /* Rather unlikely as we are non-blocking, but it
967                          * might actually happen. */
968                         resulting_index = i;
969                         goto done;
970                 }
971
972                 if (errno == EINPROGRESS || errno == EALREADY ||
973                     errno == EAGAIN) {
974                         /* These are the error messages that something is
975                            progressing. */
976                         good_connect = True;
977                 } else if (errno != 0) {
978                         /* There was a direct error */
979                         close(sockets[i]);
980                         sockets[i] = -1;
981                 }
982         }
983
984         if (!good_connect) {
985                 /* All of the connect's resulted in real error conditions */
986                 goto done;
987         }
988
989         /* Lets see if any of the connect attempts succeeded */
990
991         maxfd = 0;
992         FD_ZERO(&wr_fds);
993         FD_ZERO(&r_fds);
994
995         for (i=0; i<num_addrs; i++) {
996                 if (sockets[i] == -1)
997                         continue;
998                 FD_SET(sockets[i], &wr_fds);
999                 FD_SET(sockets[i], &r_fds);
1000                 if (sockets[i]>maxfd)
1001                         maxfd = sockets[i];
1002         }
1003
1004         tv.tv_sec = 0;
1005         tv.tv_usec = connect_loop;
1006
1007         res = sys_select(maxfd+1, &r_fds, &wr_fds, NULL, &tv);
1008
1009         if (res < 0)
1010                 goto done;
1011
1012         if (res == 0)
1013                 goto next_round;
1014
1015         for (i=0; i<num_addrs; i++) {
1016
1017                 if (sockets[i] == -1)
1018                         continue;
1019
1020                 /* Stevens, Network Programming says that if there's a
1021                  * successful connect, the socket is only writable. Upon an
1022                  * error, it's both readable and writable. */
1023
1024                 if (FD_ISSET(sockets[i], &r_fds) &&
1025                     FD_ISSET(sockets[i], &wr_fds)) {
1026                         /* readable and writable, so it's an error */
1027                         close(sockets[i]);
1028                         sockets[i] = -1;
1029                         continue;
1030                 }
1031
1032                 if (!FD_ISSET(sockets[i], &r_fds) &&
1033                     FD_ISSET(sockets[i], &wr_fds)) {
1034                         /* Only writable, so it's connected */
1035                         resulting_index = i;
1036                         goto done;
1037                 }
1038         }
1039
1040  next_round:
1041
1042         timeout -= connect_loop;
1043         if (timeout <= 0)
1044                 goto done;
1045         connect_loop *= 1.5;
1046         if (connect_loop > timeout)
1047                 connect_loop = timeout;
1048         goto connect_again;
1049
1050  done:
1051         for (i=0; i<num_addrs; i++) {
1052                 if (i == resulting_index)
1053                         continue;
1054                 if (sockets[i] >= 0)
1055                         close(sockets[i]);
1056         }
1057
1058         if (resulting_index >= 0) {
1059                 *fd_index = resulting_index;
1060                 *fd = sockets[*fd_index];
1061                 set_blocking(*fd, True);
1062         }
1063
1064         free(sockets);
1065
1066         return (resulting_index >= 0);
1067 }
1068 /****************************************************************************
1069  Open a connected UDP socket to host on port
1070 **************************************************************************/
1071
1072 int open_udp_socket(const char *host, int port)
1073 {
1074         int type = SOCK_DGRAM;
1075         struct sockaddr_in sock_out;
1076         int res;
1077         struct in_addr *addr;
1078
1079         addr = interpret_addr2(host);
1080
1081         res = socket(PF_INET, type, 0);
1082         if (res == -1) {
1083                 return -1;
1084         }
1085
1086         memset((char *)&sock_out,'\0',sizeof(sock_out));
1087         putip((char *)&sock_out.sin_addr,(char *)addr);
1088         sock_out.sin_port = htons(port);
1089         sock_out.sin_family = PF_INET;
1090
1091         if (connect(res,(struct sockaddr *)&sock_out,sizeof(sock_out))) {
1092                 close(res);
1093                 return -1;
1094         }
1095
1096         return res;
1097 }
1098
1099
1100 /*******************************************************************
1101  Matchname - determine if host name matches IP address. Used to
1102  confirm a hostname lookup to prevent spoof attacks.
1103 ******************************************************************/
1104
1105 static BOOL matchname(char *remotehost,struct in_addr  addr)
1106 {
1107         struct hostent *hp;
1108         int     i;
1109         
1110         if ((hp = sys_gethostbyname(remotehost)) == 0) {
1111                 DEBUG(0,("sys_gethostbyname(%s): lookup failure.\n", remotehost));
1112                 return False;
1113         } 
1114
1115         /*
1116          * Make sure that gethostbyname() returns the "correct" host name.
1117          * Unfortunately, gethostbyname("localhost") sometimes yields
1118          * "localhost.domain". Since the latter host name comes from the
1119          * local DNS, we just have to trust it (all bets are off if the local
1120          * DNS is perverted). We always check the address list, though.
1121          */
1122         
1123         if (!strequal(remotehost, hp->h_name)
1124             && !strequal(remotehost, "localhost")) {
1125                 DEBUG(0,("host name/name mismatch: %s != %s\n",
1126                          remotehost, hp->h_name));
1127                 return False;
1128         }
1129         
1130         /* Look up the host address in the address list we just got. */
1131         for (i = 0; hp->h_addr_list[i]; i++) {
1132                 if (memcmp(hp->h_addr_list[i], (char *) & addr, sizeof(addr)) == 0)
1133                         return True;
1134         }
1135         
1136         /*
1137          * The host name does not map to the original host address. Perhaps
1138          * someone has compromised a name server. More likely someone botched
1139          * it, but that could be dangerous, too.
1140          */
1141         
1142         DEBUG(0,("host name/address mismatch: %s != %s\n",
1143                  inet_ntoa(addr), hp->h_name));
1144         return False;
1145 }
1146
1147 /*******************************************************************
1148  Return the DNS name of the remote end of a socket.
1149 ******************************************************************/
1150
1151 char *get_peer_name(int fd, BOOL force_lookup)
1152 {
1153         static pstring name_buf;
1154         pstring tmp_name;
1155         static fstring addr_buf;
1156         struct hostent *hp;
1157         struct in_addr addr;
1158         char *p;
1159
1160         /* reverse lookups can be *very* expensive, and in many
1161            situations won't work because many networks don't link dhcp
1162            with dns. To avoid the delay we avoid the lookup if
1163            possible */
1164         if (!lp_hostname_lookups() && (force_lookup == False)) {
1165                 return get_peer_addr(fd);
1166         }
1167         
1168         p = get_peer_addr(fd);
1169
1170         /* it might be the same as the last one - save some DNS work */
1171         if (strcmp(p, addr_buf) == 0) 
1172                 return name_buf;
1173
1174         pstrcpy(name_buf,"UNKNOWN");
1175         if (fd == -1) 
1176                 return name_buf;
1177
1178         fstrcpy(addr_buf, p);
1179
1180         addr = *interpret_addr2(p);
1181         
1182         /* Look up the remote host name. */
1183         if ((hp = gethostbyaddr((char *)&addr.s_addr, sizeof(addr.s_addr), AF_INET)) == 0) {
1184                 DEBUG(1,("Gethostbyaddr failed for %s\n",p));
1185                 pstrcpy(name_buf, p);
1186         } else {
1187                 pstrcpy(name_buf,(char *)hp->h_name);
1188                 if (!matchname(name_buf, addr)) {
1189                         DEBUG(0,("Matchname failed on %s %s\n",name_buf,p));
1190                         pstrcpy(name_buf,"UNKNOWN");
1191                 }
1192         }
1193
1194         /* can't pass the same source and dest strings in when you 
1195            use --enable-developer or the clobber_region() call will 
1196            get you */
1197         
1198         pstrcpy( tmp_name, name_buf );
1199         alpha_strcpy(name_buf, tmp_name, "_-.", sizeof(name_buf));
1200         if (strstr(name_buf,"..")) {
1201                 pstrcpy(name_buf, "UNKNOWN");
1202         }
1203
1204         return name_buf;
1205 }
1206
1207 /*******************************************************************
1208  Return the IP addr of the remote end of a socket as a string.
1209  ******************************************************************/
1210
1211 char *get_peer_addr(int fd)
1212 {
1213         struct sockaddr sa;
1214         struct sockaddr_in *sockin = (struct sockaddr_in *) (&sa);
1215         socklen_t length = sizeof(sa);
1216         static fstring addr_buf;
1217
1218         fstrcpy(addr_buf,"0.0.0.0");
1219
1220         if (fd == -1) {
1221                 return addr_buf;
1222         }
1223         
1224         if (getpeername(fd, &sa, &length) < 0) {
1225                 DEBUG(0,("getpeername failed. Error was %s\n", strerror(errno) ));
1226                 return addr_buf;
1227         }
1228         
1229         fstrcpy(addr_buf,(char *)inet_ntoa(sockin->sin_addr));
1230         
1231         return addr_buf;
1232 }
1233
1234 /*******************************************************************
1235  Create protected unix domain socket.
1236
1237  Some unixes cannot set permissions on a ux-dom-sock, so we
1238  have to make sure that the directory contains the protection
1239  permissions instead.
1240  ******************************************************************/
1241
1242 int create_pipe_sock(const char *socket_dir,
1243                      const char *socket_name,
1244                      mode_t dir_perms)
1245 {
1246 #ifdef HAVE_UNIXSOCKET
1247         struct sockaddr_un sunaddr;
1248         struct stat st;
1249         int sock;
1250         mode_t old_umask;
1251         pstring path;
1252         
1253         old_umask = umask(0);
1254         
1255         /* Create the socket directory or reuse the existing one */
1256         
1257         if (lstat(socket_dir, &st) == -1) {
1258                 if (errno == ENOENT) {
1259                         /* Create directory */
1260                         if (mkdir(socket_dir, dir_perms) == -1) {
1261                                 DEBUG(0, ("error creating socket directory "
1262                                         "%s: %s\n", socket_dir, 
1263                                         strerror(errno)));
1264                                 goto out_umask;
1265                         }
1266                 } else {
1267                         DEBUG(0, ("lstat failed on socket directory %s: %s\n",
1268                                 socket_dir, strerror(errno)));
1269                         goto out_umask;
1270                 }
1271         } else {
1272                 /* Check ownership and permission on existing directory */
1273                 if (!S_ISDIR(st.st_mode)) {
1274                         DEBUG(0, ("socket directory %s isn't a directory\n",
1275                                 socket_dir));
1276                         goto out_umask;
1277                 }
1278                 if ((st.st_uid != sec_initial_uid()) || 
1279                                 ((st.st_mode & 0777) != dir_perms)) {
1280                         DEBUG(0, ("invalid permissions on socket directory "
1281                                 "%s\n", socket_dir));
1282                         goto out_umask;
1283                 }
1284         }
1285         
1286         /* Create the socket file */
1287         
1288         sock = socket(AF_UNIX, SOCK_STREAM, 0);
1289         
1290         if (sock == -1) {
1291                 perror("socket");
1292                 goto out_umask;
1293         }
1294         
1295         pstr_sprintf(path, "%s/%s", socket_dir, socket_name);
1296         
1297         unlink(path);
1298         memset(&sunaddr, 0, sizeof(sunaddr));
1299         sunaddr.sun_family = AF_UNIX;
1300         safe_strcpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path)-1);
1301         
1302         if (bind(sock, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1) {
1303                 DEBUG(0, ("bind failed on pipe socket %s: %s\n", path,
1304                         strerror(errno)));
1305                 goto out_close;
1306         }
1307         
1308         if (listen(sock, 5) == -1) {
1309                 DEBUG(0, ("listen failed on pipe socket %s: %s\n", path,
1310                         strerror(errno)));
1311                 goto out_close;
1312         }
1313         
1314         umask(old_umask);
1315         return sock;
1316
1317 out_close:
1318         close(sock);
1319
1320 out_umask:
1321         umask(old_umask);
1322         return -1;
1323
1324 #else
1325         DEBUG(0, ("create_pipe_sock: No Unix sockets on this system\n"));
1326         return -1;
1327 #endif /* HAVE_UNIXSOCKET */
1328 }