b9a7f8788d3c9cc072b4680ef0ecea69282f2588
[tprouty/samba.git] / source3 / 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-2007
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 3 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, see <http://www.gnu.org/licenses/>.
20 */
21
22 #include "includes.h"
23
24 /*******************************************************************
25  Map a text hostname or IP address (IPv4 or IPv6) into a
26  struct sockaddr_storage.
27 ******************************************************************/
28
29 bool interpret_string_addr(struct sockaddr_storage *pss,
30                 const char *str,
31                 int flags)
32 {
33         struct addrinfo *res = NULL;
34 #if defined(HAVE_IPV6)
35         char addr[INET6_ADDRSTRLEN];
36         unsigned int scope_id = 0;
37
38         if (strchr_m(str, ':')) {
39                 char *p = strchr_m(str, '%');
40
41                 /*
42                  * Cope with link-local.
43                  * This is IP:v6:addr%ifname.
44                  */
45
46                 if (p && (p > str) && ((scope_id = if_nametoindex(p+1)) != 0)) {
47                         strlcpy(addr, str,
48                                 MIN(PTR_DIFF(p,str)+1,
49                                         sizeof(addr)));
50                         str = addr;
51                 }
52         }
53 #endif
54
55         zero_sockaddr(pss);
56
57         if (!interpret_string_addr_internal(&res, str, flags|AI_ADDRCONFIG)) {
58                 return false;
59         }
60         if (!res) {
61                 return false;
62         }
63         /* Copy the first sockaddr. */
64         memcpy(pss, res->ai_addr, res->ai_addrlen);
65
66 #if defined(HAVE_IPV6)
67         if (pss->ss_family == AF_INET6 && scope_id) {
68                 struct sockaddr_in6 *ps6 = (struct sockaddr_in6 *)pss;
69                 if (IN6_IS_ADDR_LINKLOCAL(&ps6->sin6_addr) &&
70                                 ps6->sin6_scope_id == 0) {
71                         ps6->sin6_scope_id = scope_id;
72                 }
73         }
74 #endif
75
76         freeaddrinfo(res);
77         return true;
78 }
79
80 /*******************************************************************
81  Set an address to INADDR_ANY.
82 ******************************************************************/
83
84 void zero_sockaddr(struct sockaddr_storage *pss)
85 {
86         memset(pss, '\0', sizeof(*pss));
87         /* Ensure we're at least a valid sockaddr-storage. */
88         pss->ss_family = AF_INET;
89 }
90
91 /****************************************************************************
92  Get a port number in host byte order from a sockaddr_storage.
93 ****************************************************************************/
94
95 uint16_t get_sockaddr_port(const struct sockaddr_storage *pss)
96 {
97         uint16_t port = 0;
98
99         if (pss->ss_family != AF_INET) {
100 #if defined(HAVE_IPV6)
101                 /* IPv6 */
102                 const struct sockaddr_in6 *sa6 =
103                         (const struct sockaddr_in6 *)pss;
104                 port = ntohs(sa6->sin6_port);
105 #endif
106         } else {
107                 const struct sockaddr_in *sa =
108                         (const struct sockaddr_in *)pss;
109                 port = ntohs(sa->sin_port);
110         }
111         return port;
112 }
113
114 /****************************************************************************
115  Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
116 ****************************************************************************/
117
118 static char *print_sockaddr_len(char *dest,
119                         size_t destlen,
120                         const struct sockaddr *psa,
121                         socklen_t psalen)
122 {
123         if (destlen > 0) {
124                 dest[0] = '\0';
125         }
126         (void)sys_getnameinfo(psa,
127                         psalen,
128                         dest, destlen,
129                         NULL, 0,
130                         NI_NUMERICHOST);
131         return dest;
132 }
133
134 /****************************************************************************
135  Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
136 ****************************************************************************/
137
138 char *print_sockaddr(char *dest,
139                         size_t destlen,
140                         const struct sockaddr_storage *psa)
141 {
142         return print_sockaddr_len(dest, destlen, (struct sockaddr *)psa,
143                         sizeof(struct sockaddr_storage));
144 }
145
146 /****************************************************************************
147  Print out a canonical IPv4 or IPv6 address from a struct sockaddr_storage.
148 ****************************************************************************/
149
150 char *print_canonical_sockaddr(TALLOC_CTX *ctx,
151                         const struct sockaddr_storage *pss)
152 {
153         char addr[INET6_ADDRSTRLEN];
154         char *dest = NULL;
155         int ret;
156
157         /* Linux getnameinfo() man pages says port is unitialized if
158            service name is NULL. */
159
160         ret = sys_getnameinfo((const struct sockaddr *)pss,
161                         sizeof(struct sockaddr_storage),
162                         addr, sizeof(addr),
163                         NULL, 0,
164                         NI_NUMERICHOST);
165         if (ret != 0) {
166                 return NULL;
167         }
168
169         if (pss->ss_family != AF_INET) {
170 #if defined(HAVE_IPV6)
171                 dest = talloc_asprintf(ctx, "[%s]", addr);
172 #else
173                 return NULL;
174 #endif
175         } else {
176                 dest = talloc_asprintf(ctx, "%s", addr);
177         }
178         
179         return dest;
180 }
181
182 /****************************************************************************
183  Return the string of an IP address (IPv4 or IPv6).
184 ****************************************************************************/
185
186 static const char *get_socket_addr(int fd, char *addr_buf, size_t addr_len)
187 {
188         struct sockaddr_storage sa;
189         socklen_t length = sizeof(sa);
190
191         /* Ok, returning a hard coded IPv4 address
192          * is bogus, but it's just as bogus as a
193          * zero IPv6 address. No good choice here.
194          */
195
196         strlcpy(addr_buf, "0.0.0.0", addr_len);
197
198         if (fd == -1) {
199                 return addr_buf;
200         }
201
202         if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
203                 DEBUG(0,("getsockname failed. Error was %s\n",
204                         strerror(errno) ));
205                 return addr_buf;
206         }
207
208         return print_sockaddr_len(addr_buf, addr_len, (struct sockaddr *)&sa, length);
209 }
210
211 #if 0
212 /* Not currently used. JRA. */
213 /****************************************************************************
214  Return the port number we've bound to on a socket.
215 ****************************************************************************/
216
217 static int get_socket_port(int fd)
218 {
219         struct sockaddr_storage sa;
220         socklen_t length = sizeof(sa);
221
222         if (fd == -1) {
223                 return -1;
224         }
225
226         if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
227                 DEBUG(0,("getpeername failed. Error was %s\n",
228                         strerror(errno) ));
229                 return -1;
230         }
231
232 #if defined(HAVE_IPV6)
233         if (sa.ss_family == AF_INET6) {
234                 return ntohs(((struct sockaddr_in6 *)&sa)->sin6_port);
235         }
236 #endif
237         if (sa.ss_family == AF_INET) {
238                 return ntohs(((struct sockaddr_in *)&sa)->sin_port);
239         }
240         return -1;
241 }
242 #endif
243
244 const char *client_name(int fd)
245 {
246         return get_peer_name(fd,false);
247 }
248
249 const char *client_addr(int fd, char *addr, size_t addrlen)
250 {
251         return get_peer_addr(fd,addr,addrlen);
252 }
253
254 const char *client_socket_addr(int fd, char *addr, size_t addr_len)
255 {
256         return get_socket_addr(fd, addr, addr_len);
257 }
258
259 #if 0
260 /* Not currently used. JRA. */
261 int client_socket_port(int fd)
262 {
263         return get_socket_port(fd);
264 }
265 #endif
266
267 /****************************************************************************
268  Accessor functions to make thread-safe code easier later...
269 ****************************************************************************/
270
271 void set_smb_read_error(enum smb_read_errors *pre,
272                         enum smb_read_errors newerr)
273 {
274         if (pre) {
275                 *pre = newerr;
276         }
277 }
278
279 void cond_set_smb_read_error(enum smb_read_errors *pre,
280                         enum smb_read_errors newerr)
281 {
282         if (pre && *pre == SMB_READ_OK) {
283                 *pre = newerr;
284         }
285 }
286
287 /****************************************************************************
288  Determine if a file descriptor is in fact a socket.
289 ****************************************************************************/
290
291 bool is_a_socket(int fd)
292 {
293         int v;
294         socklen_t l;
295         l = sizeof(int);
296         return(getsockopt(fd, SOL_SOCKET, SO_TYPE, (char *)&v, &l) == 0);
297 }
298
299 enum SOCK_OPT_TYPES {OPT_BOOL,OPT_INT,OPT_ON};
300
301 typedef struct smb_socket_option {
302         const char *name;
303         int level;
304         int option;
305         int value;
306         int opttype;
307 } smb_socket_option;
308
309 static const smb_socket_option socket_options[] = {
310   {"SO_KEEPALIVE", SOL_SOCKET, SO_KEEPALIVE, 0, OPT_BOOL},
311   {"SO_REUSEADDR", SOL_SOCKET, SO_REUSEADDR, 0, OPT_BOOL},
312   {"SO_BROADCAST", SOL_SOCKET, SO_BROADCAST, 0, OPT_BOOL},
313 #ifdef TCP_NODELAY
314   {"TCP_NODELAY", IPPROTO_TCP, TCP_NODELAY, 0, OPT_BOOL},
315 #endif
316 #ifdef TCP_KEEPCNT
317   {"TCP_KEEPCNT", IPPROTO_TCP, TCP_KEEPCNT, 0, OPT_INT},
318 #endif
319 #ifdef TCP_KEEPIDLE
320   {"TCP_KEEPIDLE", IPPROTO_TCP, TCP_KEEPIDLE, 0, OPT_INT},
321 #endif
322 #ifdef TCP_KEEPINTVL
323   {"TCP_KEEPINTVL", IPPROTO_TCP, TCP_KEEPINTVL, 0, OPT_INT},
324 #endif
325 #ifdef IPTOS_LOWDELAY
326   {"IPTOS_LOWDELAY", IPPROTO_IP, IP_TOS, IPTOS_LOWDELAY, OPT_ON},
327 #endif
328 #ifdef IPTOS_THROUGHPUT
329   {"IPTOS_THROUGHPUT", IPPROTO_IP, IP_TOS, IPTOS_THROUGHPUT, OPT_ON},
330 #endif
331 #ifdef SO_REUSEPORT
332   {"SO_REUSEPORT", SOL_SOCKET, SO_REUSEPORT, 0, OPT_BOOL},
333 #endif
334 #ifdef SO_SNDBUF
335   {"SO_SNDBUF", SOL_SOCKET, SO_SNDBUF, 0, OPT_INT},
336 #endif
337 #ifdef SO_RCVBUF
338   {"SO_RCVBUF", SOL_SOCKET, SO_RCVBUF, 0, OPT_INT},
339 #endif
340 #ifdef SO_SNDLOWAT
341   {"SO_SNDLOWAT", SOL_SOCKET, SO_SNDLOWAT, 0, OPT_INT},
342 #endif
343 #ifdef SO_RCVLOWAT
344   {"SO_RCVLOWAT", SOL_SOCKET, SO_RCVLOWAT, 0, OPT_INT},
345 #endif
346 #ifdef SO_SNDTIMEO
347   {"SO_SNDTIMEO", SOL_SOCKET, SO_SNDTIMEO, 0, OPT_INT},
348 #endif
349 #ifdef SO_RCVTIMEO
350   {"SO_RCVTIMEO", SOL_SOCKET, SO_RCVTIMEO, 0, OPT_INT},
351 #endif
352 #ifdef TCP_FASTACK
353   {"TCP_FASTACK", IPPROTO_TCP, TCP_FASTACK, 0, OPT_INT},
354 #endif
355   {NULL,0,0,0,0}};
356
357 /****************************************************************************
358  Print socket options.
359 ****************************************************************************/
360
361 static void print_socket_options(int s)
362 {
363         int value;
364         socklen_t vlen = 4;
365         const smb_socket_option *p = &socket_options[0];
366
367         /* wrapped in if statement to prevent streams
368          * leak in SCO Openserver 5.0 */
369         /* reported on samba-technical  --jerry */
370         if ( DEBUGLEVEL >= 5 ) {
371                 DEBUG(5,("Socket options:\n"));
372                 for (; p->name != NULL; p++) {
373                         if (getsockopt(s, p->level, p->option,
374                                                 (void *)&value, &vlen) == -1) {
375                                 DEBUGADD(5,("\tCould not test socket option %s.\n",
376                                                         p->name));
377                         } else {
378                                 DEBUGADD(5,("\t%s = %d\n",
379                                                         p->name,value));
380                         }
381                 }
382         }
383  }
384
385 /****************************************************************************
386  Set user socket options.
387 ****************************************************************************/
388
389 void set_socket_options(int fd, const char *options)
390 {
391         TALLOC_CTX *ctx = talloc_stackframe();
392         char *tok;
393
394         while (next_token_talloc(ctx, &options, &tok," \t,")) {
395                 int ret=0,i;
396                 int value = 1;
397                 char *p;
398                 bool got_value = false;
399
400                 if ((p = strchr_m(tok,'='))) {
401                         *p = 0;
402                         value = atoi(p+1);
403                         got_value = true;
404                 }
405
406                 for (i=0;socket_options[i].name;i++)
407                         if (strequal(socket_options[i].name,tok))
408                                 break;
409
410                 if (!socket_options[i].name) {
411                         DEBUG(0,("Unknown socket option %s\n",tok));
412                         continue;
413                 }
414
415                 switch (socket_options[i].opttype) {
416                 case OPT_BOOL:
417                 case OPT_INT:
418                         ret = setsockopt(fd,socket_options[i].level,
419                                         socket_options[i].option,
420                                         (char *)&value,sizeof(int));
421                         break;
422
423                 case OPT_ON:
424                         if (got_value)
425                                 DEBUG(0,("syntax error - %s "
426                                         "does not take a value\n",tok));
427
428                         {
429                                 int on = socket_options[i].value;
430                                 ret = setsockopt(fd,socket_options[i].level,
431                                         socket_options[i].option,
432                                         (char *)&on,sizeof(int));
433                         }
434                         break;
435                 }
436
437                 if (ret != 0) {
438                         /* be aware that some systems like Solaris return
439                          * EINVAL to a setsockopt() call when the client
440                          * sent a RST previously - no need to worry */
441                         DEBUG(2,("Failed to set socket option %s (Error %s)\n",
442                                 tok, strerror(errno) ));
443                 }
444         }
445
446         TALLOC_FREE(ctx);
447         print_socket_options(fd);
448 }
449
450 /****************************************************************************
451  Read from a socket.
452 ****************************************************************************/
453
454 ssize_t read_udp_v4_socket(int fd,
455                         char *buf,
456                         size_t len,
457                         struct sockaddr_storage *psa)
458 {
459         ssize_t ret;
460         socklen_t socklen = sizeof(*psa);
461         struct sockaddr_in *si = (struct sockaddr_in *)psa;
462
463         memset((char *)psa,'\0',socklen);
464
465         ret = (ssize_t)sys_recvfrom(fd,buf,len,0,
466                         (struct sockaddr *)psa,&socklen);
467         if (ret <= 0) {
468                 /* Don't print a low debug error for a non-blocking socket. */
469                 if (errno == EAGAIN) {
470                         DEBUG(10,("read_udp_v4_socket: returned EAGAIN\n"));
471                 } else {
472                         DEBUG(2,("read_udp_v4_socket: failed. errno=%s\n",
473                                 strerror(errno)));
474                 }
475                 return 0;
476         }
477
478         if (psa->ss_family != AF_INET) {
479                 DEBUG(2,("read_udp_v4_socket: invalid address family %d "
480                         "(not IPv4)\n", (int)psa->ss_family));
481                 return 0;
482         }
483
484         DEBUG(10,("read_udp_v4_socket: ip %s port %d read: %lu\n",
485                         inet_ntoa(si->sin_addr),
486                         si->sin_port,
487                         (unsigned long)ret));
488
489         return ret;
490 }
491
492 /****************************************************************************
493  Read data from a socket with a timout in msec.
494  mincount = if timeout, minimum to read before returning
495  maxcount = number to be read.
496  time_out = timeout in milliseconds
497 ****************************************************************************/
498
499 NTSTATUS read_socket_with_timeout(int fd, char *buf,
500                                   size_t mincnt, size_t maxcnt,
501                                   unsigned int time_out,
502                                   size_t *size_ret)
503 {
504         fd_set fds;
505         int selrtn;
506         ssize_t readret;
507         size_t nread = 0;
508         struct timeval timeout;
509         char addr[INET6_ADDRSTRLEN];
510
511         /* just checking .... */
512         if (maxcnt <= 0)
513                 return NT_STATUS_OK;
514
515         /* Blocking read */
516         if (time_out == 0) {
517                 if (mincnt == 0) {
518                         mincnt = maxcnt;
519                 }
520
521                 while (nread < mincnt) {
522                         readret = sys_read(fd, buf + nread, maxcnt - nread);
523
524                         if (readret == 0) {
525                                 DEBUG(5,("read_socket_with_timeout: "
526                                         "blocking read. EOF from client.\n"));
527                                 return NT_STATUS_END_OF_FILE;
528                         }
529
530                         if (readret == -1) {
531                                 if (fd == get_client_fd()) {
532                                         /* Try and give an error message
533                                          * saying what client failed. */
534                                         DEBUG(0,("read_socket_with_timeout: "
535                                                 "client %s read error = %s.\n",
536                                                 get_peer_addr(fd,addr,sizeof(addr)),
537                                                 strerror(errno) ));
538                                 } else {
539                                         DEBUG(0,("read_socket_with_timeout: "
540                                                 "read error = %s.\n",
541                                                 strerror(errno) ));
542                                 }
543                                 return map_nt_error_from_unix(errno);
544                         }
545                         nread += readret;
546                 }
547                 goto done;
548         }
549
550         /* Most difficult - timeout read */
551         /* If this is ever called on a disk file and
552            mincnt is greater then the filesize then
553            system performance will suffer severely as
554            select always returns true on disk files */
555
556         /* Set initial timeout */
557         timeout.tv_sec = (time_t)(time_out / 1000);
558         timeout.tv_usec = (long)(1000 * (time_out % 1000));
559
560         for (nread=0; nread < mincnt; ) {
561                 FD_ZERO(&fds);
562                 FD_SET(fd,&fds);
563
564                 selrtn = sys_select_intr(fd+1,&fds,NULL,NULL,&timeout);
565
566                 /* Check if error */
567                 if (selrtn == -1) {
568                         /* something is wrong. Maybe the socket is dead? */
569                         if (fd == get_client_fd()) {
570                                 /* Try and give an error message saying
571                                  * what client failed. */
572                                 DEBUG(0,("read_socket_with_timeout: timeout "
573                                 "read for client %s. select error = %s.\n",
574                                 get_peer_addr(fd,addr,sizeof(addr)),
575                                 strerror(errno) ));
576                         } else {
577                                 DEBUG(0,("read_socket_with_timeout: timeout "
578                                 "read. select error = %s.\n",
579                                 strerror(errno) ));
580                         }
581                         return map_nt_error_from_unix(errno);
582                 }
583
584                 /* Did we timeout ? */
585                 if (selrtn == 0) {
586                         DEBUG(10,("read_socket_with_timeout: timeout read. "
587                                 "select timed out.\n"));
588                         return NT_STATUS_IO_TIMEOUT;
589                 }
590
591                 readret = sys_read(fd, buf+nread, maxcnt-nread);
592
593                 if (readret == 0) {
594                         /* we got EOF on the file descriptor */
595                         DEBUG(5,("read_socket_with_timeout: timeout read. "
596                                 "EOF from client.\n"));
597                         return NT_STATUS_END_OF_FILE;
598                 }
599
600                 if (readret == -1) {
601                         /* the descriptor is probably dead */
602                         if (fd == get_client_fd()) {
603                                 /* Try and give an error message
604                                  * saying what client failed. */
605                                 DEBUG(0,("read_socket_with_timeout: timeout "
606                                         "read to client %s. read error = %s.\n",
607                                         get_peer_addr(fd,addr,sizeof(addr)),
608                                         strerror(errno) ));
609                         } else {
610                                 DEBUG(0,("read_socket_with_timeout: timeout "
611                                         "read. read error = %s.\n",
612                                         strerror(errno) ));
613                         }
614                         return map_nt_error_from_unix(errno);
615                 }
616
617                 nread += readret;
618         }
619
620  done:
621         /* Return the number we got */
622         if (size_ret) {
623                 *size_ret = nread;
624         }
625         return NT_STATUS_OK;
626 }
627
628 /****************************************************************************
629  Read data from the client, reading exactly N bytes.
630 ****************************************************************************/
631
632 NTSTATUS read_data(int fd, char *buffer, size_t N)
633 {
634         return read_socket_with_timeout(fd, buffer, N, N, 0, NULL);
635 }
636
637 /****************************************************************************
638  Write all data from an iov array
639 ****************************************************************************/
640
641 ssize_t write_data_iov(int fd, const struct iovec *orig_iov, int iovcnt)
642 {
643         int i;
644         size_t to_send;
645         ssize_t thistime;
646         size_t sent;
647         struct iovec *iov_copy, *iov;
648
649         to_send = 0;
650         for (i=0; i<iovcnt; i++) {
651                 to_send += orig_iov[i].iov_len;
652         }
653
654         thistime = sys_writev(fd, orig_iov, iovcnt);
655         if ((thistime <= 0) || (thistime == to_send)) {
656                 return thistime;
657         }
658         sent = thistime;
659
660         /*
661          * We could not send everything in one call. Make a copy of iov that
662          * we can mess with. We keep a copy of the array start in iov_copy for
663          * the TALLOC_FREE, because we're going to modify iov later on,
664          * discarding elements.
665          */
666
667         iov_copy = (struct iovec *)TALLOC_MEMDUP(
668                 talloc_tos(), orig_iov, sizeof(struct iovec) * iovcnt);
669
670         if (iov_copy == NULL) {
671                 errno = ENOMEM;
672                 return -1;
673         }
674         iov = iov_copy;
675
676         while (sent < to_send) {
677                 /*
678                  * We have to discard "thistime" bytes from the beginning
679                  * iov array, "thistime" contains the number of bytes sent
680                  * via writev last.
681                  */
682                 while (thistime > 0) {
683                         if (thistime < iov[0].iov_len) {
684                                 char *new_base =
685                                         (char *)iov[0].iov_base + thistime;
686                                 iov[0].iov_base = new_base;
687                                 iov[0].iov_len -= thistime;
688                                 break;
689                         }
690                         thistime -= iov[0].iov_len;
691                         iov += 1;
692                         iovcnt -= 1;
693                 }
694
695                 thistime = sys_writev(fd, iov, iovcnt);
696                 if (thistime <= 0) {
697                         break;
698                 }
699                 sent += thistime;
700         }
701
702         TALLOC_FREE(iov_copy);
703         return sent;
704 }
705
706 /****************************************************************************
707  Write data to a fd.
708 ****************************************************************************/
709
710 ssize_t write_data(int fd, const char *buffer, size_t N)
711 {
712         ssize_t ret;
713         struct iovec iov;
714
715         iov.iov_base = CONST_DISCARD(char *, buffer);
716         iov.iov_len = N;
717
718         ret = write_data_iov(fd, &iov, 1);
719         if (ret >= 0) {
720                 return ret;
721         }
722
723         if (fd == get_client_fd()) {
724                 char addr[INET6_ADDRSTRLEN];
725                 /*
726                  * Try and give an error message saying what client failed.
727                  */
728                 DEBUG(0, ("write_data: write failure in writing to client %s. "
729                           "Error %s\n", get_peer_addr(fd,addr,sizeof(addr)),
730                           strerror(errno)));
731         } else {
732                 DEBUG(0,("write_data: write failure. Error = %s\n",
733                          strerror(errno) ));
734         }
735
736         return -1;
737 }
738
739 /****************************************************************************
740  Send a keepalive packet (rfc1002).
741 ****************************************************************************/
742
743 bool send_keepalive(int client)
744 {
745         unsigned char buf[4];
746
747         buf[0] = SMBkeepalive;
748         buf[1] = buf[2] = buf[3] = 0;
749
750         return(write_data(client,(char *)buf,4) == 4);
751 }
752
753 /****************************************************************************
754  Read 4 bytes of a smb packet and return the smb length of the packet.
755  Store the result in the buffer.
756  This version of the function will return a length of zero on receiving
757  a keepalive packet.
758  Timeout is in milliseconds.
759 ****************************************************************************/
760
761 NTSTATUS read_smb_length_return_keepalive(int fd, char *inbuf,
762                                           unsigned int timeout,
763                                           size_t *len)
764 {
765         int msg_type;
766         NTSTATUS status;
767
768         status = read_socket_with_timeout(fd, inbuf, 4, 4, timeout, NULL);
769
770         if (!NT_STATUS_IS_OK(status)) {
771                 return status;
772         }
773
774         *len = smb_len(inbuf);
775         msg_type = CVAL(inbuf,0);
776
777         if (msg_type == SMBkeepalive) {
778                 DEBUG(5,("Got keepalive packet\n"));
779         }
780
781         DEBUG(10,("got smb length of %lu\n",(unsigned long)(*len)));
782
783         return NT_STATUS_OK;
784 }
785
786 /****************************************************************************
787  Read 4 bytes of a smb packet and return the smb length of the packet.
788  Store the result in the buffer. This version of the function will
789  never return a session keepalive (length of zero).
790  Timeout is in milliseconds.
791 ****************************************************************************/
792
793 NTSTATUS read_smb_length(int fd, char *inbuf, unsigned int timeout,
794                          size_t *len)
795 {
796         uint8_t msgtype = SMBkeepalive;
797
798         while (msgtype == SMBkeepalive) {
799                 NTSTATUS status;
800
801                 status = read_smb_length_return_keepalive(fd, inbuf, timeout,
802                                                           len);
803                 if (!NT_STATUS_IS_OK(status)) {
804                         return status;
805                 }
806
807                 msgtype = CVAL(inbuf, 0);
808         }
809
810         DEBUG(10,("read_smb_length: got smb length of %lu\n",
811                   (unsigned long)len));
812
813         return NT_STATUS_OK;
814 }
815
816 /****************************************************************************
817  Read an smb from a fd.
818  The timeout is in milliseconds.
819  This function will return on receipt of a session keepalive packet.
820  maxlen is the max number of bytes to return, not including the 4 byte
821  length. If zero it means buflen limit.
822  Doesn't check the MAC on signed packets.
823 ****************************************************************************/
824
825 NTSTATUS receive_smb_raw(int fd, char *buffer, size_t buflen, unsigned int timeout,
826                          size_t maxlen, size_t *p_len)
827 {
828         size_t len;
829         NTSTATUS status;
830
831         status = read_smb_length_return_keepalive(fd,buffer,timeout,&len);
832
833         if (!NT_STATUS_IS_OK(status)) {
834                 DEBUG(10, ("receive_smb_raw: %s!\n", nt_errstr(status)));
835                 return status;
836         }
837
838         if (len > buflen) {
839                 DEBUG(0,("Invalid packet length! (%lu bytes).\n",
840                                         (unsigned long)len));
841                 return NT_STATUS_INVALID_PARAMETER;
842         }
843
844         if(len > 0) {
845                 if (maxlen) {
846                         len = MIN(len,maxlen);
847                 }
848
849                 status = read_socket_with_timeout(
850                         fd, buffer+4, len, len, timeout, &len);
851
852                 if (!NT_STATUS_IS_OK(status)) {
853                         return status;
854                 }
855
856                 /* not all of samba3 properly checks for packet-termination
857                  * of strings. This ensures that we don't run off into
858                  * empty space. */
859                 SSVAL(buffer+4,len, 0);
860         }
861
862         *p_len = len;
863         return NT_STATUS_OK;
864 }
865
866 /****************************************************************************
867  Open a socket of the specified type, port, and address for incoming data.
868 ****************************************************************************/
869
870 int open_socket_in(int type,
871                 uint16_t port,
872                 int dlevel,
873                 const struct sockaddr_storage *psock,
874                 bool rebind)
875 {
876         struct sockaddr_storage sock;
877         int res;
878         socklen_t slen = sizeof(struct sockaddr_in);
879
880         sock = *psock;
881
882 #if defined(HAVE_IPV6)
883         if (sock.ss_family == AF_INET6) {
884                 ((struct sockaddr_in6 *)&sock)->sin6_port = htons(port);
885                 slen = sizeof(struct sockaddr_in6);
886         }
887 #endif
888         if (sock.ss_family == AF_INET) {
889                 ((struct sockaddr_in *)&sock)->sin_port = htons(port);
890         }
891
892         res = socket(sock.ss_family, type, 0 );
893         if( res == -1 ) {
894                 if( DEBUGLVL(0) ) {
895                         dbgtext( "open_socket_in(): socket() call failed: " );
896                         dbgtext( "%s\n", strerror( errno ) );
897                 }
898                 return -1;
899         }
900
901         /* This block sets/clears the SO_REUSEADDR and possibly SO_REUSEPORT. */
902         {
903                 int val = rebind ? 1 : 0;
904                 if( setsockopt(res,SOL_SOCKET,SO_REUSEADDR,
905                                         (char *)&val,sizeof(val)) == -1 ) {
906                         if( DEBUGLVL( dlevel ) ) {
907                                 dbgtext( "open_socket_in(): setsockopt: " );
908                                 dbgtext( "SO_REUSEADDR = %s ",
909                                                 val?"true":"false" );
910                                 dbgtext( "on port %d failed ", port );
911                                 dbgtext( "with error = %s\n", strerror(errno) );
912                         }
913                 }
914 #ifdef SO_REUSEPORT
915                 if( setsockopt(res,SOL_SOCKET,SO_REUSEPORT,
916                                         (char *)&val,sizeof(val)) == -1 ) {
917                         if( DEBUGLVL( dlevel ) ) {
918                                 dbgtext( "open_socket_in(): setsockopt: ");
919                                 dbgtext( "SO_REUSEPORT = %s ",
920                                                 val?"true":"false");
921                                 dbgtext( "on port %d failed ", port);
922                                 dbgtext( "with error = %s\n", strerror(errno));
923                         }
924                 }
925 #endif /* SO_REUSEPORT */
926         }
927
928         /* now we've got a socket - we need to bind it */
929         if (bind(res, (struct sockaddr *)&sock, slen) == -1 ) {
930                 if( DEBUGLVL(dlevel) && (port == SMB_PORT1 ||
931                                 port == SMB_PORT2 || port == NMB_PORT) ) {
932                         char addr[INET6_ADDRSTRLEN];
933                         print_sockaddr(addr, sizeof(addr),
934                                         &sock);
935                         dbgtext( "bind failed on port %d ", port);
936                         dbgtext( "socket_addr = %s.\n", addr);
937                         dbgtext( "Error = %s\n", strerror(errno));
938                 }
939                 close(res);
940                 return -1;
941         }
942
943         DEBUG( 10, ( "bind succeeded on port %d\n", port ) );
944         return( res );
945  }
946
947 struct open_socket_out_state {
948         int fd;
949         struct event_context *ev;
950         struct sockaddr_storage ss;
951         socklen_t salen;
952         uint16_t port;
953         int wait_nsec;
954 };
955
956 static void open_socket_out_connected(struct async_req *subreq);
957
958 static int open_socket_out_state_destructor(struct open_socket_out_state *s)
959 {
960         if (s->fd != -1) {
961                 close(s->fd);
962         }
963         return 0;
964 }
965
966 /****************************************************************************
967  Create an outgoing socket. timeout is in milliseconds.
968 **************************************************************************/
969
970 struct async_req *open_socket_out_send(TALLOC_CTX *mem_ctx,
971                                        struct event_context *ev,
972                                        const struct sockaddr_storage *pss,
973                                        uint16_t port,
974                                        int timeout)
975 {
976         char addr[INET6_ADDRSTRLEN];
977         struct async_req *result, *subreq;
978         struct open_socket_out_state *state;
979         NTSTATUS status;
980
981         if (!async_req_setup(mem_ctx, &result, &state,
982                              struct open_socket_out_state)) {
983                 return NULL;
984         }
985         state->ev = ev;
986         state->ss = *pss;
987         state->port = port;
988         state->wait_nsec = 10000;
989         state->salen = -1;
990
991         state->fd = socket(state->ss.ss_family, SOCK_STREAM, 0);
992         if (state->fd == -1) {
993                 status = map_nt_error_from_unix(errno);
994                 goto post_status;
995         }
996         talloc_set_destructor(state, open_socket_out_state_destructor);
997
998         if (!async_req_set_timeout(result, ev, timeval_set(0, timeout*1000))) {
999                 goto fail;
1000         }
1001
1002 #if defined(HAVE_IPV6)
1003         if (pss->ss_family == AF_INET6) {
1004                 struct sockaddr_in6 *psa6;
1005                 psa6 = (struct sockaddr_in6 *)&state->ss;
1006                 psa6->sin6_port = htons(port);
1007                 if (psa6->sin6_scope_id == 0
1008                     && IN6_IS_ADDR_LINKLOCAL(&psa6->sin6_addr)) {
1009                         setup_linklocal_scope_id(
1010                                 (struct sockaddr *)&(state->ss));
1011                 }
1012                 state->salen = sizeof(struct sockaddr_in6);
1013         }
1014 #endif
1015         if (pss->ss_family == AF_INET) {
1016                 struct sockaddr_in *psa;
1017                 psa = (struct sockaddr_in *)&state->ss;
1018                 psa->sin_port = htons(port);
1019                 state->salen = sizeof(struct sockaddr_in);
1020         }
1021
1022         print_sockaddr(addr, sizeof(addr), &state->ss);
1023         DEBUG(3,("Connecting to %s at port %u\n", addr, (unsigned int)port));
1024
1025         subreq = async_connect_send(state, state->ev, state->fd,
1026                                     (struct sockaddr *)&state->ss,
1027                                     state->salen);
1028         if ((subreq == NULL)
1029             || !async_req_set_timeout(subreq, state->ev,
1030                                       timeval_set(0, state->wait_nsec))) {
1031                 status = NT_STATUS_NO_MEMORY;
1032                 goto post_status;
1033         }
1034         subreq->async.fn = open_socket_out_connected;
1035         subreq->async.priv = result;
1036         return result;
1037
1038  post_status:
1039         if (!async_post_ntstatus(result, ev, status)) {
1040                 goto fail;
1041         }
1042         return result;
1043  fail:
1044         TALLOC_FREE(result);
1045         return NULL;
1046 }
1047
1048 static void open_socket_out_connected(struct async_req *subreq)
1049 {
1050         struct async_req *req = talloc_get_type_abort(
1051                 subreq->async.priv, struct async_req);
1052         struct open_socket_out_state *state = talloc_get_type_abort(
1053                 req->private_data, struct open_socket_out_state);
1054         int err;
1055         int sys_errno;
1056
1057         err = async_connect_recv(subreq, &sys_errno);
1058         TALLOC_FREE(subreq);
1059         if (err == 0) {
1060                 async_req_done(req);
1061                 return;
1062         }
1063
1064         if ((sys_errno == ETIME)
1065             || (sys_errno == EINPROGRESS)
1066             || (sys_errno == EALREADY)
1067             || (sys_errno == EAGAIN)) {
1068
1069                 /*
1070                  * retry
1071                  */
1072
1073                 if (state->wait_nsec < 250000) {
1074                         state->wait_nsec *= 1.5;
1075                 }
1076
1077                 subreq = async_connect_send(state, state->ev, state->fd,
1078                                             (struct sockaddr *)&state->ss,
1079                                             state->salen);
1080                 if (async_req_nomem(subreq, req)) {
1081                         return;
1082                 }
1083                 if (!async_req_set_timeout(subreq, state->ev,
1084                                            timeval_set(0, state->wait_nsec))) {
1085                         async_req_error(req, ENOMEM);
1086                         return;
1087                 }
1088                 subreq->async.fn = open_socket_out_connected;
1089                 subreq->async.priv = req;
1090                 return;
1091         }
1092
1093 #ifdef EISCONN
1094         if (sys_errno == EISCONN) {
1095                 async_req_done(req);
1096                 return;
1097         }
1098 #endif
1099
1100         /* real error */
1101         async_req_error(req, sys_errno);
1102 }
1103
1104 NTSTATUS open_socket_out_recv(struct async_req *req, int *pfd)
1105 {
1106         struct open_socket_out_state *state = talloc_get_type_abort(
1107                 req->private_data, struct open_socket_out_state);
1108         int err;
1109
1110         if (async_req_is_errno(req, &err)) {
1111                 return map_nt_error_from_unix(err);
1112         }
1113         *pfd = state->fd;
1114         state->fd = -1;
1115         return NT_STATUS_OK;
1116 }
1117
1118 NTSTATUS open_socket_out(const struct sockaddr_storage *pss, uint16_t port,
1119                          int timeout, int *pfd)
1120 {
1121         TALLOC_CTX *frame = talloc_stackframe();
1122         struct event_context *ev;
1123         struct async_req *req;
1124         NTSTATUS status = NT_STATUS_NO_MEMORY;
1125
1126         ev = event_context_init(frame);
1127         if (ev == NULL) {
1128                 goto fail;
1129         }
1130
1131         req = open_socket_out_send(frame, ev, pss, port, timeout);
1132         if (req == NULL) {
1133                 goto fail;
1134         }
1135         while (req->state < ASYNC_REQ_DONE) {
1136                 event_loop_once(ev);
1137         }
1138
1139         status = open_socket_out_recv(req, pfd);
1140  fail:
1141         TALLOC_FREE(frame);
1142         return status;
1143 }
1144
1145 struct open_socket_out_defer_state {
1146         struct event_context *ev;
1147         struct sockaddr_storage ss;
1148         uint16_t port;
1149         int timeout;
1150         int fd;
1151 };
1152
1153 static void open_socket_out_defer_waited(struct async_req *subreq);
1154 static void open_socket_out_defer_connected(struct async_req *subreq);
1155
1156 struct async_req *open_socket_out_defer_send(TALLOC_CTX *mem_ctx,
1157                                              struct event_context *ev,
1158                                              struct timeval wait_time,
1159                                              const struct sockaddr_storage *pss,
1160                                              uint16_t port,
1161                                              int timeout)
1162 {
1163         struct async_req *result, *subreq;
1164         struct open_socket_out_defer_state *state;
1165         NTSTATUS status;
1166
1167         if (!async_req_setup(mem_ctx, &result, &state,
1168                              struct open_socket_out_defer_state)) {
1169                 return NULL;
1170         }
1171         state->ev = ev;
1172         state->ss = *pss;
1173         state->port = port;
1174         state->timeout = timeout;
1175
1176         subreq = async_wait_send(state, ev, wait_time);
1177         if (subreq == NULL) {
1178                 status = NT_STATUS_NO_MEMORY;
1179                 goto post_status;
1180         }
1181         subreq->async.fn = open_socket_out_defer_waited;
1182         subreq->async.priv = result;
1183         return result;
1184
1185  post_status:
1186         if (!async_post_ntstatus(result, ev, status)) {
1187                 goto fail;
1188         }
1189         return result;
1190  fail:
1191         TALLOC_FREE(result);
1192         return NULL;
1193 }
1194
1195 static void open_socket_out_defer_waited(struct async_req *subreq)
1196 {
1197         struct async_req *req = talloc_get_type_abort(
1198                 subreq->async.priv, struct async_req);
1199         struct open_socket_out_defer_state *state = talloc_get_type_abort(
1200                 req->private_data, struct open_socket_out_defer_state);
1201         bool ret;
1202
1203         ret = async_wait_recv(subreq);
1204         TALLOC_FREE(subreq);
1205         if (!ret) {
1206                 async_req_nterror(req, NT_STATUS_INTERNAL_ERROR);
1207                 return;
1208         }
1209
1210         subreq = open_socket_out_send(state, state->ev, &state->ss,
1211                                       state->port, state->timeout);
1212         if (async_req_nomem(subreq, req)) {
1213                 return;
1214         }
1215         subreq->async.fn = open_socket_out_defer_connected;
1216         subreq->async.priv = req;
1217 }
1218
1219 static void open_socket_out_defer_connected(struct async_req *subreq)
1220 {
1221         struct async_req *req = talloc_get_type_abort(
1222                 subreq->async.priv, struct async_req);
1223         struct open_socket_out_defer_state *state = talloc_get_type_abort(
1224                 req->private_data, struct open_socket_out_defer_state);
1225         NTSTATUS status;
1226
1227         status = open_socket_out_recv(subreq, &state->fd);
1228         TALLOC_FREE(subreq);
1229         if (!NT_STATUS_IS_OK(status)) {
1230                 async_req_nterror(req, status);
1231                 return;
1232         }
1233         async_req_done(req);
1234 }
1235
1236 NTSTATUS open_socket_out_defer_recv(struct async_req *req, int *pfd)
1237 {
1238         struct open_socket_out_defer_state *state = talloc_get_type_abort(
1239                 req->private_data, struct open_socket_out_defer_state);
1240         NTSTATUS status;
1241
1242         if (async_req_is_nterror(req, &status)) {
1243                 return status;
1244         }
1245         *pfd = state->fd;
1246         state->fd = -1;
1247         return NT_STATUS_OK;
1248 }
1249
1250 /*******************************************************************
1251  Create an outgoing TCP socket to the first addr that connects.
1252
1253  This is for simultaneous connection attempts to port 445 and 139 of a host
1254  or for simultatneous connection attempts to multiple DCs at once.  We return
1255  a socket fd of the first successful connection.
1256
1257  @param[in] addrs list of Internet addresses and ports to connect to
1258  @param[in] num_addrs number of address/port pairs in the addrs list
1259  @param[in] timeout time after which we stop waiting for a socket connection
1260             to succeed, given in milliseconds
1261  @param[out] fd_index the entry in addrs which we successfully connected to
1262  @param[out] fd fd of the open and connected socket
1263  @return true on a successful connection, false if all connection attempts
1264          failed or we timed out
1265 *******************************************************************/
1266
1267 bool open_any_socket_out(struct sockaddr_storage *addrs, int num_addrs,
1268                          int timeout, int *fd_index, int *fd)
1269 {
1270         int i, resulting_index, res;
1271         int *sockets;
1272         bool good_connect;
1273
1274         fd_set r_fds, wr_fds;
1275         struct timeval tv;
1276         int maxfd;
1277
1278         int connect_loop = 10000; /* 10 milliseconds */
1279
1280         timeout *= 1000;        /* convert to microseconds */
1281
1282         sockets = SMB_MALLOC_ARRAY(int, num_addrs);
1283
1284         if (sockets == NULL)
1285                 return false;
1286
1287         resulting_index = -1;
1288
1289         for (i=0; i<num_addrs; i++)
1290                 sockets[i] = -1;
1291
1292         for (i=0; i<num_addrs; i++) {
1293                 sockets[i] = socket(addrs[i].ss_family, SOCK_STREAM, 0);
1294                 if (sockets[i] < 0)
1295                         goto done;
1296                 set_blocking(sockets[i], false);
1297         }
1298
1299  connect_again:
1300         good_connect = false;
1301
1302         for (i=0; i<num_addrs; i++) {
1303                 const struct sockaddr * a = 
1304                     (const struct sockaddr *)&(addrs[i]);
1305
1306                 if (sockets[i] == -1)
1307                         continue;
1308
1309                 if (sys_connect(sockets[i], a) == 0) {
1310                         /* Rather unlikely as we are non-blocking, but it
1311                          * might actually happen. */
1312                         resulting_index = i;
1313                         goto done;
1314                 }
1315
1316                 if (errno == EINPROGRESS || errno == EALREADY ||
1317 #ifdef EISCONN
1318                         errno == EISCONN ||
1319 #endif
1320                     errno == EAGAIN || errno == EINTR) {
1321                         /* These are the error messages that something is
1322                            progressing. */
1323                         good_connect = true;
1324                 } else if (errno != 0) {
1325                         /* There was a direct error */
1326                         close(sockets[i]);
1327                         sockets[i] = -1;
1328                 }
1329         }
1330
1331         if (!good_connect) {
1332                 /* All of the connect's resulted in real error conditions */
1333                 goto done;
1334         }
1335
1336         /* Lets see if any of the connect attempts succeeded */
1337
1338         maxfd = 0;
1339         FD_ZERO(&wr_fds);
1340         FD_ZERO(&r_fds);
1341
1342         for (i=0; i<num_addrs; i++) {
1343                 if (sockets[i] == -1)
1344                         continue;
1345                 FD_SET(sockets[i], &wr_fds);
1346                 FD_SET(sockets[i], &r_fds);
1347                 if (sockets[i]>maxfd)
1348                         maxfd = sockets[i];
1349         }
1350
1351         tv.tv_sec = 0;
1352         tv.tv_usec = connect_loop;
1353
1354         res = sys_select_intr(maxfd+1, &r_fds, &wr_fds, NULL, &tv);
1355
1356         if (res < 0)
1357                 goto done;
1358
1359         if (res == 0)
1360                 goto next_round;
1361
1362         for (i=0; i<num_addrs; i++) {
1363
1364                 if (sockets[i] == -1)
1365                         continue;
1366
1367                 /* Stevens, Network Programming says that if there's a
1368                  * successful connect, the socket is only writable. Upon an
1369                  * error, it's both readable and writable. */
1370
1371                 if (FD_ISSET(sockets[i], &r_fds) &&
1372                     FD_ISSET(sockets[i], &wr_fds)) {
1373                         /* readable and writable, so it's an error */
1374                         close(sockets[i]);
1375                         sockets[i] = -1;
1376                         continue;
1377                 }
1378
1379                 if (!FD_ISSET(sockets[i], &r_fds) &&
1380                     FD_ISSET(sockets[i], &wr_fds)) {
1381                         /* Only writable, so it's connected */
1382                         resulting_index = i;
1383                         goto done;
1384                 }
1385         }
1386
1387  next_round:
1388
1389         timeout -= connect_loop;
1390         if (timeout <= 0)
1391                 goto done;
1392         connect_loop *= 1.5;
1393         if (connect_loop > timeout)
1394                 connect_loop = timeout;
1395         goto connect_again;
1396
1397  done:
1398         for (i=0; i<num_addrs; i++) {
1399                 if (i == resulting_index)
1400                         continue;
1401                 if (sockets[i] >= 0)
1402                         close(sockets[i]);
1403         }
1404
1405         if (resulting_index >= 0) {
1406                 *fd_index = resulting_index;
1407                 *fd = sockets[*fd_index];
1408                 set_blocking(*fd, true);
1409         }
1410
1411         free(sockets);
1412
1413         return (resulting_index >= 0);
1414 }
1415 /****************************************************************************
1416  Open a connected UDP socket to host on port
1417 **************************************************************************/
1418
1419 int open_udp_socket(const char *host, int port)
1420 {
1421         int type = SOCK_DGRAM;
1422         struct sockaddr_in sock_out;
1423         int res;
1424         struct in_addr addr;
1425
1426         addr = interpret_addr2(host);
1427
1428         res = socket(PF_INET, type, 0);
1429         if (res == -1) {
1430                 return -1;
1431         }
1432
1433         memset((char *)&sock_out,'\0',sizeof(sock_out));
1434         putip((char *)&sock_out.sin_addr,(char *)&addr);
1435         sock_out.sin_port = htons(port);
1436         sock_out.sin_family = PF_INET;
1437
1438         if (sys_connect(res,(struct sockaddr *)&sock_out)) {
1439                 close(res);
1440                 return -1;
1441         }
1442
1443         return res;
1444 }
1445
1446 /*******************************************************************
1447  Return the IP addr of the remote end of a socket as a string.
1448  Optionally return the struct sockaddr_storage.
1449  ******************************************************************/
1450
1451 static const char *get_peer_addr_internal(int fd,
1452                                 char *addr_buf,
1453                                 size_t addr_buf_len,
1454                                 struct sockaddr *pss,
1455                                 socklen_t *plength)
1456 {
1457         struct sockaddr_storage ss;
1458         socklen_t length = sizeof(ss);
1459
1460         strlcpy(addr_buf,"0.0.0.0",addr_buf_len);
1461
1462         if (fd == -1) {
1463                 return addr_buf;
1464         }
1465
1466         if (pss == NULL) {
1467                 pss = (struct sockaddr *)&ss;
1468                 plength = &length;
1469         }
1470
1471         if (getpeername(fd, (struct sockaddr *)pss, plength) < 0) {
1472                 DEBUG(0,("getpeername failed. Error was %s\n",
1473                                         strerror(errno) ));
1474                 return addr_buf;
1475         }
1476
1477         print_sockaddr_len(addr_buf,
1478                         addr_buf_len,
1479                         pss,
1480                         *plength);
1481         return addr_buf;
1482 }
1483
1484 /*******************************************************************
1485  Matchname - determine if host name matches IP address. Used to
1486  confirm a hostname lookup to prevent spoof attacks.
1487 ******************************************************************/
1488
1489 static bool matchname(const char *remotehost,
1490                 const struct sockaddr *pss,
1491                 socklen_t len)
1492 {
1493         struct addrinfo *res = NULL;
1494         struct addrinfo *ailist = NULL;
1495         char addr_buf[INET6_ADDRSTRLEN];
1496         bool ret = interpret_string_addr_internal(&ailist,
1497                         remotehost,
1498                         AI_ADDRCONFIG|AI_CANONNAME);
1499
1500         if (!ret || ailist == NULL) {
1501                 DEBUG(3,("matchname: getaddrinfo failed for "
1502                         "name %s [%s]\n",
1503                         remotehost,
1504                         gai_strerror(ret) ));
1505                 return false;
1506         }
1507
1508         /*
1509          * Make sure that getaddrinfo() returns the "correct" host name.
1510          */
1511
1512         if (ailist->ai_canonname == NULL ||
1513                 (!strequal(remotehost, ailist->ai_canonname) &&
1514                  !strequal(remotehost, "localhost"))) {
1515                 DEBUG(0,("matchname: host name/name mismatch: %s != %s\n",
1516                          remotehost,
1517                          ailist->ai_canonname ?
1518                                  ailist->ai_canonname : "(NULL)"));
1519                 freeaddrinfo(ailist);
1520                 return false;
1521         }
1522
1523         /* Look up the host address in the address list we just got. */
1524         for (res = ailist; res; res = res->ai_next) {
1525                 if (!res->ai_addr) {
1526                         continue;
1527                 }
1528                 if (sockaddr_equal((const struct sockaddr *)res->ai_addr,
1529                                         (struct sockaddr *)pss)) {
1530                         freeaddrinfo(ailist);
1531                         return true;
1532                 }
1533         }
1534
1535         /*
1536          * The host name does not map to the original host address. Perhaps
1537          * someone has compromised a name server. More likely someone botched
1538          * it, but that could be dangerous, too.
1539          */
1540
1541         DEBUG(0,("matchname: host name/address mismatch: %s != %s\n",
1542                 print_sockaddr_len(addr_buf,
1543                         sizeof(addr_buf),
1544                         pss,
1545                         len),
1546                  ailist->ai_canonname ? ailist->ai_canonname : "(NULL)"));
1547
1548         if (ailist) {
1549                 freeaddrinfo(ailist);
1550         }
1551         return false;
1552 }
1553
1554 /*******************************************************************
1555  Deal with the singleton cache.
1556 ******************************************************************/
1557
1558 struct name_addr_pair {
1559         struct sockaddr_storage ss;
1560         const char *name;
1561 };
1562
1563 /*******************************************************************
1564  Lookup a name/addr pair. Returns memory allocated from memcache.
1565 ******************************************************************/
1566
1567 static bool lookup_nc(struct name_addr_pair *nc)
1568 {
1569         DATA_BLOB tmp;
1570
1571         ZERO_STRUCTP(nc);
1572
1573         if (!memcache_lookup(
1574                         NULL, SINGLETON_CACHE,
1575                         data_blob_string_const_null("get_peer_name"),
1576                         &tmp)) {
1577                 return false;
1578         }
1579
1580         memcpy(&nc->ss, tmp.data, sizeof(nc->ss));
1581         nc->name = (const char *)tmp.data + sizeof(nc->ss);
1582         return true;
1583 }
1584
1585 /*******************************************************************
1586  Save a name/addr pair.
1587 ******************************************************************/
1588
1589 static void store_nc(const struct name_addr_pair *nc)
1590 {
1591         DATA_BLOB tmp;
1592         size_t namelen = strlen(nc->name);
1593
1594         tmp = data_blob(NULL, sizeof(nc->ss) + namelen + 1);
1595         if (!tmp.data) {
1596                 return;
1597         }
1598         memcpy(tmp.data, &nc->ss, sizeof(nc->ss));
1599         memcpy(tmp.data+sizeof(nc->ss), nc->name, namelen+1);
1600
1601         memcache_add(NULL, SINGLETON_CACHE,
1602                         data_blob_string_const_null("get_peer_name"),
1603                         tmp);
1604         data_blob_free(&tmp);
1605 }
1606
1607 /*******************************************************************
1608  Return the DNS name of the remote end of a socket.
1609 ******************************************************************/
1610
1611 const char *get_peer_name(int fd, bool force_lookup)
1612 {
1613         struct name_addr_pair nc;
1614         char addr_buf[INET6_ADDRSTRLEN];
1615         struct sockaddr_storage ss;
1616         socklen_t length = sizeof(ss);
1617         const char *p;
1618         int ret;
1619         char name_buf[MAX_DNS_NAME_LENGTH];
1620         char tmp_name[MAX_DNS_NAME_LENGTH];
1621
1622         /* reverse lookups can be *very* expensive, and in many
1623            situations won't work because many networks don't link dhcp
1624            with dns. To avoid the delay we avoid the lookup if
1625            possible */
1626         if (!lp_hostname_lookups() && (force_lookup == false)) {
1627                 length = sizeof(nc.ss);
1628                 nc.name = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf),
1629                         (struct sockaddr *)&nc.ss, &length);
1630                 store_nc(&nc);
1631                 lookup_nc(&nc);
1632                 return nc.name ? nc.name : "UNKNOWN";
1633         }
1634
1635         lookup_nc(&nc);
1636
1637         memset(&ss, '\0', sizeof(ss));
1638         p = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf), (struct sockaddr *)&ss, &length);
1639
1640         /* it might be the same as the last one - save some DNS work */
1641         if (sockaddr_equal((struct sockaddr *)&ss, (struct sockaddr *)&nc.ss)) {
1642                 return nc.name ? nc.name : "UNKNOWN";
1643         }
1644
1645         /* Not the same. We need to lookup. */
1646         if (fd == -1) {
1647                 return "UNKNOWN";
1648         }
1649
1650         /* Look up the remote host name. */
1651         ret = sys_getnameinfo((struct sockaddr *)&ss,
1652                         length,
1653                         name_buf,
1654                         sizeof(name_buf),
1655                         NULL,
1656                         0,
1657                         0);
1658
1659         if (ret) {
1660                 DEBUG(1,("get_peer_name: getnameinfo failed "
1661                         "for %s with error %s\n",
1662                         p,
1663                         gai_strerror(ret)));
1664                 strlcpy(name_buf, p, sizeof(name_buf));
1665         } else {
1666                 if (!matchname(name_buf, (struct sockaddr *)&ss, length)) {
1667                         DEBUG(0,("Matchname failed on %s %s\n",name_buf,p));
1668                         strlcpy(name_buf,"UNKNOWN",sizeof(name_buf));
1669                 }
1670         }
1671
1672         /* can't pass the same source and dest strings in when you
1673            use --enable-developer or the clobber_region() call will
1674            get you */
1675
1676         strlcpy(tmp_name, name_buf, sizeof(tmp_name));
1677         alpha_strcpy(name_buf, tmp_name, "_-.", sizeof(name_buf));
1678         if (strstr(name_buf,"..")) {
1679                 strlcpy(name_buf, "UNKNOWN", sizeof(name_buf));
1680         }
1681
1682         nc.name = name_buf;
1683         nc.ss = ss;
1684
1685         store_nc(&nc);
1686         lookup_nc(&nc);
1687         return nc.name ? nc.name : "UNKNOWN";
1688 }
1689
1690 /*******************************************************************
1691  Return the IP addr of the remote end of a socket as a string.
1692  ******************************************************************/
1693
1694 const char *get_peer_addr(int fd, char *addr, size_t addr_len)
1695 {
1696         return get_peer_addr_internal(fd, addr, addr_len, NULL, NULL);
1697 }
1698
1699 /*******************************************************************
1700  Create protected unix domain socket.
1701
1702  Some unixes cannot set permissions on a ux-dom-sock, so we
1703  have to make sure that the directory contains the protection
1704  permissions instead.
1705  ******************************************************************/
1706
1707 int create_pipe_sock(const char *socket_dir,
1708                      const char *socket_name,
1709                      mode_t dir_perms)
1710 {
1711 #ifdef HAVE_UNIXSOCKET
1712         struct sockaddr_un sunaddr;
1713         struct stat st;
1714         int sock;
1715         mode_t old_umask;
1716         char *path = NULL;
1717
1718         old_umask = umask(0);
1719
1720         /* Create the socket directory or reuse the existing one */
1721
1722         if (lstat(socket_dir, &st) == -1) {
1723                 if (errno == ENOENT) {
1724                         /* Create directory */
1725                         if (mkdir(socket_dir, dir_perms) == -1) {
1726                                 DEBUG(0, ("error creating socket directory "
1727                                         "%s: %s\n", socket_dir,
1728                                         strerror(errno)));
1729                                 goto out_umask;
1730                         }
1731                 } else {
1732                         DEBUG(0, ("lstat failed on socket directory %s: %s\n",
1733                                 socket_dir, strerror(errno)));
1734                         goto out_umask;
1735                 }
1736         } else {
1737                 /* Check ownership and permission on existing directory */
1738                 if (!S_ISDIR(st.st_mode)) {
1739                         DEBUG(0, ("socket directory %s isn't a directory\n",
1740                                 socket_dir));
1741                         goto out_umask;
1742                 }
1743                 if ((st.st_uid != sec_initial_uid()) ||
1744                                 ((st.st_mode & 0777) != dir_perms)) {
1745                         DEBUG(0, ("invalid permissions on socket directory "
1746                                 "%s\n", socket_dir));
1747                         goto out_umask;
1748                 }
1749         }
1750
1751         /* Create the socket file */
1752
1753         sock = socket(AF_UNIX, SOCK_STREAM, 0);
1754
1755         if (sock == -1) {
1756                 DEBUG(0, ("create_pipe_sock: socket error %s\n",
1757                         strerror(errno) ));
1758                 goto out_close;
1759         }
1760
1761         if (asprintf(&path, "%s/%s", socket_dir, socket_name) == -1) {
1762                 goto out_close;
1763         }
1764
1765         unlink(path);
1766         memset(&sunaddr, 0, sizeof(sunaddr));
1767         sunaddr.sun_family = AF_UNIX;
1768         strlcpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path));
1769
1770         if (bind(sock, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1) {
1771                 DEBUG(0, ("bind failed on pipe socket %s: %s\n", path,
1772                         strerror(errno)));
1773                 goto out_close;
1774         }
1775
1776         if (listen(sock, 5) == -1) {
1777                 DEBUG(0, ("listen failed on pipe socket %s: %s\n", path,
1778                         strerror(errno)));
1779                 goto out_close;
1780         }
1781
1782         SAFE_FREE(path);
1783
1784         umask(old_umask);
1785         return sock;
1786
1787 out_close:
1788         SAFE_FREE(path);
1789         if (sock != -1)
1790                 close(sock);
1791
1792 out_umask:
1793         umask(old_umask);
1794         return -1;
1795
1796 #else
1797         DEBUG(0, ("create_pipe_sock: No Unix sockets on this system\n"));
1798         return -1;
1799 #endif /* HAVE_UNIXSOCKET */
1800 }
1801
1802 /****************************************************************************
1803  Get my own canonical name, including domain.
1804 ****************************************************************************/
1805
1806 const char *get_mydnsfullname(void)
1807 {
1808         struct addrinfo *res = NULL;
1809         char my_hostname[HOST_NAME_MAX];
1810         bool ret;
1811         DATA_BLOB tmp;
1812
1813         if (memcache_lookup(NULL, SINGLETON_CACHE,
1814                         data_blob_string_const_null("get_mydnsfullname"),
1815                         &tmp)) {
1816                 SMB_ASSERT(tmp.length > 0);
1817                 return (const char *)tmp.data;
1818         }
1819
1820         /* get my host name */
1821         if (gethostname(my_hostname, sizeof(my_hostname)) == -1) {
1822                 DEBUG(0,("get_mydnsfullname: gethostname failed\n"));
1823                 return NULL;
1824         }
1825
1826         /* Ensure null termination. */
1827         my_hostname[sizeof(my_hostname)-1] = '\0';
1828
1829         ret = interpret_string_addr_internal(&res,
1830                                 my_hostname,
1831                                 AI_ADDRCONFIG|AI_CANONNAME);
1832
1833         if (!ret || res == NULL) {
1834                 DEBUG(3,("get_mydnsfullname: getaddrinfo failed for "
1835                         "name %s [%s]\n",
1836                         my_hostname,
1837                         gai_strerror(ret) ));
1838                 return NULL;
1839         }
1840
1841         /*
1842          * Make sure that getaddrinfo() returns the "correct" host name.
1843          */
1844
1845         if (res->ai_canonname == NULL) {
1846                 DEBUG(3,("get_mydnsfullname: failed to get "
1847                         "canonical name for %s\n",
1848                         my_hostname));
1849                 freeaddrinfo(res);
1850                 return NULL;
1851         }
1852
1853         /* This copies the data, so we must do a lookup
1854          * afterwards to find the value to return.
1855          */
1856
1857         memcache_add(NULL, SINGLETON_CACHE,
1858                         data_blob_string_const_null("get_mydnsfullname"),
1859                         data_blob_string_const_null(res->ai_canonname));
1860
1861         if (!memcache_lookup(NULL, SINGLETON_CACHE,
1862                         data_blob_string_const_null("get_mydnsfullname"),
1863                         &tmp)) {
1864                 tmp = data_blob_talloc(talloc_tos(), res->ai_canonname,
1865                                 strlen(res->ai_canonname) + 1);
1866         }
1867
1868         freeaddrinfo(res);
1869
1870         return (const char *)tmp.data;
1871 }
1872
1873 /************************************************************
1874  Is this my name ?
1875 ************************************************************/
1876
1877 bool is_myname_or_ipaddr(const char *s)
1878 {
1879         TALLOC_CTX *ctx = talloc_tos();
1880         char addr[INET6_ADDRSTRLEN];
1881         char *name = NULL;
1882         const char *dnsname;
1883         char *servername = NULL;
1884
1885         if (!s) {
1886                 return false;
1887         }
1888
1889         /* Santize the string from '\\name' */
1890         name = talloc_strdup(ctx, s);
1891         if (!name) {
1892                 return false;
1893         }
1894
1895         servername = strrchr_m(name, '\\' );
1896         if (!servername) {
1897                 servername = name;
1898         } else {
1899                 servername++;
1900         }
1901
1902         /* Optimize for the common case */
1903         if (strequal(servername, global_myname())) {
1904                 return true;
1905         }
1906
1907         /* Check for an alias */
1908         if (is_myname(servername)) {
1909                 return true;
1910         }
1911
1912         /* Check for loopback */
1913         if (strequal(servername, "127.0.0.1") ||
1914                         strequal(servername, "::1")) {
1915                 return true;
1916         }
1917
1918         if (strequal(servername, "localhost")) {
1919                 return true;
1920         }
1921
1922         /* Maybe it's my dns name */
1923         dnsname = get_mydnsfullname();
1924         if (dnsname && strequal(servername, dnsname)) {
1925                 return true;
1926         }
1927
1928         /* Handle possible CNAME records - convert to an IP addr. */
1929         if (!is_ipaddress(servername)) {
1930                 /* Use DNS to resolve the name, but only the first address */
1931                 struct sockaddr_storage ss;
1932                 if (interpret_string_addr(&ss, servername, 0)) {
1933                         print_sockaddr(addr,
1934                                         sizeof(addr),
1935                                         &ss);
1936                         servername = addr;
1937                 }
1938         }
1939
1940         /* Maybe its an IP address? */
1941         if (is_ipaddress(servername)) {
1942                 struct sockaddr_storage ss;
1943                 struct iface_struct *nics;
1944                 int i, n;
1945
1946                 if (!interpret_string_addr(&ss, servername, AI_NUMERICHOST)) {
1947                         return false;
1948                 }
1949
1950                 if (is_zero_addr((struct sockaddr *)&ss) || 
1951                         is_loopback_addr((struct sockaddr *)&ss)) {
1952                         return false;
1953                 }
1954
1955                 nics = TALLOC_ARRAY(ctx, struct iface_struct,
1956                                         MAX_INTERFACES);
1957                 if (!nics) {
1958                         return false;
1959                 }
1960                 n = get_interfaces(nics, MAX_INTERFACES);
1961                 for (i=0; i<n; i++) {
1962                         if (sockaddr_equal((struct sockaddr *)&nics[i].ip, (struct sockaddr *)&ss)) {
1963                                 TALLOC_FREE(nics);
1964                                 return true;
1965                         }
1966                 }
1967                 TALLOC_FREE(nics);
1968         }
1969
1970         /* No match */
1971         return false;
1972 }