Allow to set correct info level log prefix in duplicates of copy_id21_to_sam_passwd.
[Samba.git] / source / lib / util_sock.c
blob71d48d60535f272636bf7ce8ad3f30a0c2a208ba
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
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.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "includes.h"
24 /****************************************************************************
25 Return true if a string could be an IPv4 address.
26 ****************************************************************************/
28 bool is_ipaddress_v4(const char *str)
30 int ret = -1;
31 struct in_addr dest;
33 ret = inet_pton(AF_INET, str, &dest);
34 if (ret > 0) {
35 return true;
37 return false;
40 /****************************************************************************
41 Return true if a string could be an IPv4 or IPv6 address.
42 ****************************************************************************/
44 bool is_ipaddress(const char *str)
46 int ret = -1;
48 #if defined(HAVE_IPV6)
49 if (strchr_m(str, ':')) {
50 char addr[INET6_ADDRSTRLEN];
51 struct in6_addr dest6;
52 const char *sp = str;
53 char *p = strchr_m(str, '%');
56 * Cope with link-local.
57 * This is IP:v6:addr%ifname.
60 if (p && (p > str) && (if_nametoindex(p+1) != 0)) {
61 strlcpy(addr, str,
62 MIN(PTR_DIFF(p,str)+1,
63 sizeof(addr)));
64 sp = addr;
66 ret = inet_pton(AF_INET6, addr, &dest6);
67 if (ret > 0) {
68 return true;
71 #endif
72 return is_ipaddress_v4(str);
75 /****************************************************************************
76 Is a sockaddr_storage a broadcast address ?
77 ****************************************************************************/
79 bool is_broadcast_addr(const struct sockaddr_storage *pss)
81 #if defined(HAVE_IPV6)
82 if (pss->ss_family == AF_INET6) {
83 const struct in6_addr *sin6 =
84 &((const struct sockaddr_in6 *)pss)->sin6_addr;
85 return IN6_IS_ADDR_MULTICAST(sin6);
87 #endif
88 if (pss->ss_family == AF_INET) {
89 uint32_t addr =
90 ntohl(((const struct sockaddr_in *)pss)->sin_addr.s_addr);
91 return addr == INADDR_BROADCAST;
93 return false;
96 /*******************************************************************
97 Wrap getaddrinfo...
98 ******************************************************************/
100 static bool interpret_string_addr_internal(struct addrinfo **ppres,
101 const char *str, int flags)
103 int ret;
104 struct addrinfo hints;
106 memset(&hints, '\0', sizeof(hints));
107 /* By default make sure it supports TCP. */
108 hints.ai_socktype = SOCK_STREAM;
109 hints.ai_flags = flags;
111 ret = getaddrinfo(str, NULL,
112 &hints,
113 ppres);
114 if (ret) {
115 DEBUG(3,("interpret_string_addr_internal: getaddrinfo failed "
116 "for name %s [%s]\n",
117 str,
118 gai_strerror(ret) ));
119 return false;
121 return true;
124 /****************************************************************************
125 Interpret an internet address or name into an IP address in 4 byte form.
126 RETURNS IN NETWORK BYTE ORDER (big endian).
127 ****************************************************************************/
129 uint32 interpret_addr(const char *str)
131 uint32 ret;
133 /* If it's in the form of an IP address then
134 * get the lib to interpret it */
135 if (is_ipaddress_v4(str)) {
136 struct in_addr dest;
138 if (inet_pton(AF_INET, str, &dest) <= 0) {
139 /* Error - this shouldn't happen ! */
140 DEBUG(0,("interpret_addr: inet_pton failed "
141 "host %s\n",
142 str));
143 return 0;
145 ret = dest.s_addr; /* NETWORK BYTE ORDER ! */
146 } else {
147 /* Otherwise assume it's a network name of some sort and use
148 getadddrinfo. */
149 struct addrinfo *res = NULL;
150 struct addrinfo *res_list = NULL;
151 if (!interpret_string_addr_internal(&res_list,
152 str,
153 AI_ADDRCONFIG)) {
154 DEBUG(3,("interpret_addr: Unknown host. %s\n",str));
155 return 0;
158 /* Find the first IPv4 address. */
159 for (res = res_list; res; res = res->ai_next) {
160 if (res->ai_family != AF_INET) {
161 continue;
163 if (res->ai_addr == NULL) {
164 continue;
166 break;
168 if(res == NULL) {
169 DEBUG(3,("interpret_addr: host address is "
170 "invalid for host %s\n",str));
171 if (res_list) {
172 freeaddrinfo(res_list);
174 return 0;
176 putip((char *)&ret,
177 &((struct sockaddr_in *)res->ai_addr)->sin_addr.s_addr);
178 if (res_list) {
179 freeaddrinfo(res_list);
183 /* This is so bogus - all callers need fixing... JRA. */
184 if (ret == (uint32)-1) {
185 return 0;
188 return ret;
191 /*******************************************************************
192 A convenient addition to interpret_addr().
193 ******************************************************************/
195 struct in_addr *interpret_addr2(struct in_addr *ip, const char *str)
197 uint32 a = interpret_addr(str);
198 ip->s_addr = a;
199 return ip;
202 /*******************************************************************
203 Map a text hostname or IP address (IPv4 or IPv6) into a
204 struct sockaddr_storage.
205 ******************************************************************/
207 bool interpret_string_addr(struct sockaddr_storage *pss,
208 const char *str,
209 int flags)
211 char addr[INET6_ADDRSTRLEN];
212 struct addrinfo *res = NULL;
213 #if defined(HAVE_IPV6)
214 unsigned int scope_id = 0;
216 if (strchr_m(str, ':')) {
217 char *p = strchr_m(str, '%');
220 * Cope with link-local.
221 * This is IP:v6:addr%ifname.
224 if (p && (p > str) && ((scope_id = if_nametoindex(p+1)) != 0)) {
225 strlcpy(addr, str,
226 MIN(PTR_DIFF(p,str)+1,
227 sizeof(addr)));
228 str = addr;
231 #endif
233 zero_addr(pss);
235 if (!interpret_string_addr_internal(&res, str, flags|AI_ADDRCONFIG)) {
236 return false;
238 if (!res) {
239 return false;
241 /* Copy the first sockaddr. */
242 memcpy(pss, res->ai_addr, res->ai_addrlen);
244 #if defined(HAVE_IPV6)
245 if (pss->ss_family == AF_INET6 && scope_id) {
246 struct sockaddr_in6 *ps6 = (struct sockaddr_in6 *)pss;
247 if (IN6_IS_ADDR_LINKLOCAL(&ps6->sin6_addr) &&
248 ps6->sin6_scope_id == 0) {
249 ps6->sin6_scope_id = scope_id;
252 #endif
254 freeaddrinfo(res);
255 return true;
258 /*******************************************************************
259 Check if an IPv7 is 127.0.0.1
260 ******************************************************************/
262 bool is_loopback_ip_v4(struct in_addr ip)
264 struct in_addr a;
265 a.s_addr = htonl(INADDR_LOOPBACK);
266 return(ip.s_addr == a.s_addr);
269 /*******************************************************************
270 Check if a struct sockaddr_storage is the loopback address.
271 ******************************************************************/
273 bool is_loopback_addr(const struct sockaddr_storage *pss)
275 #if defined(HAVE_IPV6)
276 if (pss->ss_family == AF_INET6) {
277 struct in6_addr *pin6 =
278 &((struct sockaddr_in6 *)pss)->sin6_addr;
279 return IN6_IS_ADDR_LOOPBACK(pin6);
281 #endif
282 if (pss->ss_family == AF_INET) {
283 struct in_addr *pin = &((struct sockaddr_in *)pss)->sin_addr;
284 return is_loopback_ip_v4(*pin);
286 return false;
289 /*******************************************************************
290 Check if an IPv4 is 0.0.0.0.
291 ******************************************************************/
293 bool is_zero_ip_v4(struct in_addr ip)
295 uint32 a;
296 putip((char *)&a,(char *)&ip);
297 return(a == 0);
300 /*******************************************************************
301 Check if a struct sockaddr_storage has an unspecified address.
302 ******************************************************************/
304 bool is_zero_addr(const struct sockaddr_storage *pss)
306 #if defined(HAVE_IPV6)
307 if (pss->ss_family == AF_INET6) {
308 struct in6_addr *pin6 =
309 &((struct sockaddr_in6 *)pss)->sin6_addr;
310 return IN6_IS_ADDR_UNSPECIFIED(pin6);
312 #endif
313 if (pss->ss_family == AF_INET) {
314 struct in_addr *pin = &((struct sockaddr_in *)pss)->sin_addr;
315 return is_zero_ip_v4(*pin);
317 return false;
320 /*******************************************************************
321 Set an IP to 0.0.0.0.
322 ******************************************************************/
324 void zero_ip_v4(struct in_addr *ip)
326 memset(ip, '\0', sizeof(struct in_addr));
329 /*******************************************************************
330 Set an address to INADDR_ANY.
331 ******************************************************************/
333 void zero_addr(struct sockaddr_storage *pss)
335 memset(pss, '\0', sizeof(*pss));
336 /* Ensure we're at least a valid sockaddr-storage. */
337 pss->ss_family = AF_INET;
340 /*******************************************************************
341 Are two IPs on the same subnet - IPv4 version ?
342 ********************************************************************/
344 bool same_net_v4(struct in_addr ip1,struct in_addr ip2,struct in_addr mask)
346 uint32 net1,net2,nmask;
348 nmask = ntohl(mask.s_addr);
349 net1 = ntohl(ip1.s_addr);
350 net2 = ntohl(ip2.s_addr);
352 return((net1 & nmask) == (net2 & nmask));
355 /*******************************************************************
356 Convert an IPv4 struct in_addr to a struct sockaddr_storage.
357 ********************************************************************/
359 void in_addr_to_sockaddr_storage(struct sockaddr_storage *ss,
360 struct in_addr ip)
362 struct sockaddr_in *sa = (struct sockaddr_in *)ss;
363 memset(ss, '\0', sizeof(*ss));
364 ss->ss_family = AF_INET;
365 sa->sin_addr = ip;
368 #if defined(HAVE_IPV6)
369 /*******************************************************************
370 Convert an IPv6 struct in_addr to a struct sockaddr_storage.
371 ********************************************************************/
373 void in6_addr_to_sockaddr_storage(struct sockaddr_storage *ss,
374 struct in6_addr ip)
376 struct sockaddr_in6 *sa = (struct sockaddr_in6 *)ss;
377 memset(ss, '\0', sizeof(*ss));
378 ss->ss_family = AF_INET6;
379 sa->sin6_addr = ip;
381 #endif
383 /*******************************************************************
384 Are two IPs on the same subnet?
385 ********************************************************************/
387 bool same_net(const struct sockaddr_storage *ip1,
388 const struct sockaddr_storage *ip2,
389 const struct sockaddr_storage *mask)
391 if (ip1->ss_family != ip2->ss_family) {
392 /* Never on the same net. */
393 return false;
396 #if defined(HAVE_IPV6)
397 if (ip1->ss_family == AF_INET6) {
398 struct sockaddr_in6 ip1_6 = *(struct sockaddr_in6 *)ip1;
399 struct sockaddr_in6 ip2_6 = *(struct sockaddr_in6 *)ip2;
400 struct sockaddr_in6 mask_6 = *(struct sockaddr_in6 *)mask;
401 char *p1 = (char *)&ip1_6.sin6_addr;
402 char *p2 = (char *)&ip2_6.sin6_addr;
403 char *m = (char *)&mask_6.sin6_addr;
404 int i;
406 for (i = 0; i < sizeof(struct in6_addr); i++) {
407 *p1++ &= *m;
408 *p2++ &= *m;
409 m++;
411 return (memcmp(&ip1_6.sin6_addr,
412 &ip2_6.sin6_addr,
413 sizeof(struct in6_addr)) == 0);
415 #endif
416 if (ip1->ss_family == AF_INET) {
417 return same_net_v4(((const struct sockaddr_in *)ip1)->sin_addr,
418 ((const struct sockaddr_in *)ip2)->sin_addr,
419 ((const struct sockaddr_in *)mask)->sin_addr);
421 return false;
424 /*******************************************************************
425 Are two sockaddr_storage's the same family and address ? Ignore port etc.
426 ********************************************************************/
428 bool addr_equal(const struct sockaddr_storage *ip1,
429 const struct sockaddr_storage *ip2)
431 if (ip1->ss_family != ip2->ss_family) {
432 /* Never the same. */
433 return false;
436 #if defined(HAVE_IPV6)
437 if (ip1->ss_family == AF_INET6) {
438 return (memcmp(&((const struct sockaddr_in6 *)ip1)->sin6_addr,
439 &((const struct sockaddr_in6 *)ip2)->sin6_addr,
440 sizeof(struct in6_addr)) == 0);
442 #endif
443 if (ip1->ss_family == AF_INET) {
444 return (memcmp(&((const struct sockaddr_in *)ip1)->sin_addr,
445 &((const struct sockaddr_in *)ip2)->sin_addr,
446 sizeof(struct in_addr)) == 0);
448 return false;
451 /****************************************************************************
452 Is an IP address the INADDR_ANY or in6addr_any value ?
453 ****************************************************************************/
455 bool is_address_any(const struct sockaddr_storage *psa)
457 #if defined(HAVE_IPV6)
458 if (psa->ss_family == AF_INET6) {
459 struct sockaddr_in6 *si6 = (struct sockaddr_in6 *)psa;
460 if (memcmp(&in6addr_any,
461 &si6->sin6_addr,
462 sizeof(in6addr_any)) == 0) {
463 return true;
465 return false;
467 #endif
468 if (psa->ss_family == AF_INET) {
469 struct sockaddr_in *si = (struct sockaddr_in *)psa;
470 if (si->sin_addr.s_addr == INADDR_ANY) {
471 return true;
473 return false;
475 return false;
478 /****************************************************************************
479 Get a port number in host byte order from a sockaddr_storage.
480 ****************************************************************************/
482 uint16_t get_sockaddr_port(const struct sockaddr_storage *pss)
484 uint16_t port = 0;
486 if (pss->ss_family != AF_INET) {
487 #if defined(HAVE_IPV6)
488 /* IPv6 */
489 const struct sockaddr_in6 *sa6 =
490 (const struct sockaddr_in6 *)pss;
491 port = ntohs(sa6->sin6_port);
492 #endif
493 } else {
494 const struct sockaddr_in *sa =
495 (const struct sockaddr_in *)pss;
496 port = ntohs(sa->sin_port);
498 return port;
501 /****************************************************************************
502 Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
503 ****************************************************************************/
505 static char *print_sockaddr_len(char *dest,
506 size_t destlen,
507 const struct sockaddr_storage *psa,
508 socklen_t psalen)
510 if (destlen > 0) {
511 dest[0] = '\0';
513 (void)sys_getnameinfo((const struct sockaddr *)psa,
514 psalen,
515 dest, destlen,
516 NULL, 0,
517 NI_NUMERICHOST);
518 return dest;
521 /****************************************************************************
522 Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
523 ****************************************************************************/
525 char *print_sockaddr(char *dest,
526 size_t destlen,
527 const struct sockaddr_storage *psa)
529 return print_sockaddr_len(dest, destlen, psa,
530 sizeof(struct sockaddr_storage));
533 /****************************************************************************
534 Print out a canonical IPv4 or IPv6 address from a struct sockaddr_storage.
535 ****************************************************************************/
537 char *print_canonical_sockaddr(TALLOC_CTX *ctx,
538 const struct sockaddr_storage *pss)
540 char addr[INET6_ADDRSTRLEN];
541 char *dest = NULL;
542 int ret;
544 ret = sys_getnameinfo((const struct sockaddr *)pss,
545 sizeof(struct sockaddr_storage),
546 addr, sizeof(addr),
547 NULL, 0,
548 NI_NUMERICHOST);
549 if (ret) {
550 return NULL;
552 if (pss->ss_family != AF_INET) {
553 #if defined(HAVE_IPV6)
554 /* IPv6 */
555 const struct sockaddr_in6 *sa6 =
556 (const struct sockaddr_in6 *)pss;
557 uint16_t port = ntohs(sa6->sin6_port);
559 if (port) {
560 dest = talloc_asprintf(ctx,
561 "[%s]:%d",
562 addr,
563 (unsigned int)port);
564 } else {
565 dest = talloc_asprintf(ctx,
566 "[%s]",
567 addr);
569 #else
570 return NULL;
571 #endif
572 } else {
573 const struct sockaddr_in *sa =
574 (const struct sockaddr_in *)pss;
575 uint16_t port = ntohs(sa->sin_port);
577 if (port) {
578 dest = talloc_asprintf(ctx,
579 "%s:%d",
580 addr,
581 (unsigned int)port);
582 } else {
583 dest = talloc_asprintf(ctx,
584 "%s",
585 addr);
588 return dest;
591 /****************************************************************************
592 Return the string of an IP address (IPv4 or IPv6).
593 ****************************************************************************/
595 static const char *get_socket_addr(int fd, char *addr_buf, size_t addr_len)
597 struct sockaddr_storage sa;
598 socklen_t length = sizeof(sa);
600 /* Ok, returning a hard coded IPv4 address
601 * is bogus, but it's just as bogus as a
602 * zero IPv6 address. No good choice here.
605 strlcpy(addr_buf, "0.0.0.0", addr_len);
607 if (fd == -1) {
608 return addr_buf;
611 if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
612 DEBUG(0,("getsockname failed. Error was %s\n",
613 strerror(errno) ));
614 return addr_buf;
617 return print_sockaddr_len(addr_buf, addr_len, &sa, length);
620 #if 0
621 /* Not currently used. JRA. */
622 /****************************************************************************
623 Return the port number we've bound to on a socket.
624 ****************************************************************************/
626 static int get_socket_port(int fd)
628 struct sockaddr_storage sa;
629 socklen_t length = sizeof(sa);
631 if (fd == -1) {
632 return -1;
635 if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
636 DEBUG(0,("getpeername failed. Error was %s\n",
637 strerror(errno) ));
638 return -1;
641 #if defined(HAVE_IPV6)
642 if (sa.ss_family == AF_INET6) {
643 return ntohs(((struct sockaddr_in6 *)&sa)->sin6_port);
645 #endif
646 if (sa.ss_family == AF_INET) {
647 return ntohs(((struct sockaddr_in *)&sa)->sin_port);
649 return -1;
651 #endif
653 void set_sockaddr_port(struct sockaddr_storage *psa, uint16 port)
655 #if defined(HAVE_IPV6)
656 if (psa->ss_family == AF_INET6) {
657 ((struct sockaddr_in6 *)psa)->sin6_port = htons(port);
659 #endif
660 if (psa->ss_family == AF_INET) {
661 ((struct sockaddr_in *)psa)->sin_port = htons(port);
665 const char *client_name(int fd)
667 return get_peer_name(fd,false);
670 const char *client_addr(int fd, char *addr, size_t addrlen)
672 return get_peer_addr(fd,addr,addrlen);
675 const char *client_socket_addr(int fd, char *addr, size_t addr_len)
677 return get_socket_addr(fd, addr, addr_len);
680 #if 0
681 /* Not currently used. JRA. */
682 int client_socket_port(int fd)
684 return get_socket_port(fd);
686 #endif
688 /****************************************************************************
689 Accessor functions to make thread-safe code easier later...
690 ****************************************************************************/
692 void set_smb_read_error(enum smb_read_errors *pre,
693 enum smb_read_errors newerr)
695 if (pre) {
696 *pre = newerr;
700 void cond_set_smb_read_error(enum smb_read_errors *pre,
701 enum smb_read_errors newerr)
703 if (pre && *pre == SMB_READ_OK) {
704 *pre = newerr;
708 /****************************************************************************
709 Determine if a file descriptor is in fact a socket.
710 ****************************************************************************/
712 bool is_a_socket(int fd)
714 int v;
715 socklen_t l;
716 l = sizeof(int);
717 return(getsockopt(fd, SOL_SOCKET, SO_TYPE, (char *)&v, &l) == 0);
720 enum SOCK_OPT_TYPES {OPT_BOOL,OPT_INT,OPT_ON};
722 typedef struct smb_socket_option {
723 const char *name;
724 int level;
725 int option;
726 int value;
727 int opttype;
728 } smb_socket_option;
730 static const smb_socket_option socket_options[] = {
731 {"SO_KEEPALIVE", SOL_SOCKET, SO_KEEPALIVE, 0, OPT_BOOL},
732 {"SO_REUSEADDR", SOL_SOCKET, SO_REUSEADDR, 0, OPT_BOOL},
733 {"SO_BROADCAST", SOL_SOCKET, SO_BROADCAST, 0, OPT_BOOL},
734 #ifdef TCP_NODELAY
735 {"TCP_NODELAY", IPPROTO_TCP, TCP_NODELAY, 0, OPT_BOOL},
736 #endif
737 #ifdef TCP_KEEPCNT
738 {"TCP_KEEPCNT", IPPROTO_TCP, TCP_KEEPCNT, 0, OPT_INT},
739 #endif
740 #ifdef TCP_KEEPIDLE
741 {"TCP_KEEPIDLE", IPPROTO_TCP, TCP_KEEPIDLE, 0, OPT_INT},
742 #endif
743 #ifdef TCP_KEEPINTVL
744 {"TCP_KEEPINTVL", IPPROTO_TCP, TCP_KEEPINTVL, 0, OPT_INT},
745 #endif
746 #ifdef IPTOS_LOWDELAY
747 {"IPTOS_LOWDELAY", IPPROTO_IP, IP_TOS, IPTOS_LOWDELAY, OPT_ON},
748 #endif
749 #ifdef IPTOS_THROUGHPUT
750 {"IPTOS_THROUGHPUT", IPPROTO_IP, IP_TOS, IPTOS_THROUGHPUT, OPT_ON},
751 #endif
752 #ifdef SO_REUSEPORT
753 {"SO_REUSEPORT", SOL_SOCKET, SO_REUSEPORT, 0, OPT_BOOL},
754 #endif
755 #ifdef SO_SNDBUF
756 {"SO_SNDBUF", SOL_SOCKET, SO_SNDBUF, 0, OPT_INT},
757 #endif
758 #ifdef SO_RCVBUF
759 {"SO_RCVBUF", SOL_SOCKET, SO_RCVBUF, 0, OPT_INT},
760 #endif
761 #ifdef SO_SNDLOWAT
762 {"SO_SNDLOWAT", SOL_SOCKET, SO_SNDLOWAT, 0, OPT_INT},
763 #endif
764 #ifdef SO_RCVLOWAT
765 {"SO_RCVLOWAT", SOL_SOCKET, SO_RCVLOWAT, 0, OPT_INT},
766 #endif
767 #ifdef SO_SNDTIMEO
768 {"SO_SNDTIMEO", SOL_SOCKET, SO_SNDTIMEO, 0, OPT_INT},
769 #endif
770 #ifdef SO_RCVTIMEO
771 {"SO_RCVTIMEO", SOL_SOCKET, SO_RCVTIMEO, 0, OPT_INT},
772 #endif
773 #ifdef TCP_FASTACK
774 {"TCP_FASTACK", IPPROTO_TCP, TCP_FASTACK, 0, OPT_INT},
775 #endif
776 {NULL,0,0,0,0}};
778 /****************************************************************************
779 Print socket options.
780 ****************************************************************************/
782 static void print_socket_options(int s)
784 int value;
785 socklen_t vlen = 4;
786 const smb_socket_option *p = &socket_options[0];
788 /* wrapped in if statement to prevent streams
789 * leak in SCO Openserver 5.0 */
790 /* reported on samba-technical --jerry */
791 if ( DEBUGLEVEL >= 5 ) {
792 for (; p->name != NULL; p++) {
793 if (getsockopt(s, p->level, p->option,
794 (void *)&value, &vlen) == -1) {
795 DEBUG(5,("Could not test socket option %s.\n",
796 p->name));
797 } else {
798 DEBUG(5,("socket option %s = %d\n",
799 p->name,value));
805 /****************************************************************************
806 Set user socket options.
807 ****************************************************************************/
809 void set_socket_options(int fd, const char *options)
811 TALLOC_CTX *ctx = talloc_stackframe();
812 char *tok;
814 while (next_token_talloc(ctx, &options, &tok," \t,")) {
815 int ret=0,i;
816 int value = 1;
817 char *p;
818 bool got_value = false;
820 if ((p = strchr_m(tok,'='))) {
821 *p = 0;
822 value = atoi(p+1);
823 got_value = true;
826 for (i=0;socket_options[i].name;i++)
827 if (strequal(socket_options[i].name,tok))
828 break;
830 if (!socket_options[i].name) {
831 DEBUG(0,("Unknown socket option %s\n",tok));
832 continue;
835 switch (socket_options[i].opttype) {
836 case OPT_BOOL:
837 case OPT_INT:
838 ret = setsockopt(fd,socket_options[i].level,
839 socket_options[i].option,
840 (char *)&value,sizeof(int));
841 break;
843 case OPT_ON:
844 if (got_value)
845 DEBUG(0,("syntax error - %s "
846 "does not take a value\n",tok));
849 int on = socket_options[i].value;
850 ret = setsockopt(fd,socket_options[i].level,
851 socket_options[i].option,
852 (char *)&on,sizeof(int));
854 break;
857 if (ret != 0) {
858 DEBUG(0,("Failed to set socket option %s (Error %s)\n",
859 tok, strerror(errno) ));
863 TALLOC_FREE(ctx);
864 print_socket_options(fd);
867 /****************************************************************************
868 Read from a socket.
869 ****************************************************************************/
871 ssize_t read_udp_v4_socket(int fd,
872 char *buf,
873 size_t len,
874 struct sockaddr_storage *psa)
876 ssize_t ret;
877 socklen_t socklen = sizeof(*psa);
878 struct sockaddr_in *si = (struct sockaddr_in *)psa;
880 memset((char *)psa,'\0',socklen);
882 ret = (ssize_t)sys_recvfrom(fd,buf,len,0,
883 (struct sockaddr *)psa,&socklen);
884 if (ret <= 0) {
885 /* Don't print a low debug error for a non-blocking socket. */
886 if (errno == EAGAIN) {
887 DEBUG(10,("read_udp_v4_socket: returned EAGAIN\n"));
888 } else {
889 DEBUG(2,("read_udp_v4_socket: failed. errno=%s\n",
890 strerror(errno)));
892 return 0;
895 if (psa->ss_family != AF_INET) {
896 DEBUG(2,("read_udp_v4_socket: invalid address family %d "
897 "(not IPv4)\n", (int)psa->ss_family));
898 return 0;
901 DEBUG(10,("read_udp_v4_socket: ip %s port %d read: %lu\n",
902 inet_ntoa(si->sin_addr),
903 si->sin_port,
904 (unsigned long)ret));
906 return ret;
909 /****************************************************************************
910 Read data from a socket with a timout in msec.
911 mincount = if timeout, minimum to read before returning
912 maxcount = number to be read.
913 time_out = timeout in milliseconds
914 ****************************************************************************/
916 NTSTATUS read_socket_with_timeout(int fd, char *buf,
917 size_t mincnt, size_t maxcnt,
918 unsigned int time_out,
919 size_t *size_ret)
921 fd_set fds;
922 int selrtn;
923 ssize_t readret;
924 size_t nread = 0;
925 struct timeval timeout;
926 char addr[INET6_ADDRSTRLEN];
928 /* just checking .... */
929 if (maxcnt <= 0)
930 return NT_STATUS_OK;
932 /* Blocking read */
933 if (time_out == 0) {
934 if (mincnt == 0) {
935 mincnt = maxcnt;
938 while (nread < mincnt) {
939 readret = sys_read(fd, buf + nread, maxcnt - nread);
941 if (readret == 0) {
942 DEBUG(5,("read_socket_with_timeout: "
943 "blocking read. EOF from client.\n"));
944 return NT_STATUS_END_OF_FILE;
947 if (readret == -1) {
948 if (fd == get_client_fd()) {
949 /* Try and give an error message
950 * saying what client failed. */
951 DEBUG(0,("read_socket_with_timeout: "
952 "client %s read error = %s.\n",
953 get_peer_addr(fd,addr,sizeof(addr)),
954 strerror(errno) ));
955 } else {
956 DEBUG(0,("read_socket_with_timeout: "
957 "read error = %s.\n",
958 strerror(errno) ));
960 return map_nt_error_from_unix(errno);
962 nread += readret;
964 goto done;
967 /* Most difficult - timeout read */
968 /* If this is ever called on a disk file and
969 mincnt is greater then the filesize then
970 system performance will suffer severely as
971 select always returns true on disk files */
973 /* Set initial timeout */
974 timeout.tv_sec = (time_t)(time_out / 1000);
975 timeout.tv_usec = (long)(1000 * (time_out % 1000));
977 for (nread=0; nread < mincnt; ) {
978 FD_ZERO(&fds);
979 FD_SET(fd,&fds);
981 selrtn = sys_select_intr(fd+1,&fds,NULL,NULL,&timeout);
983 /* Check if error */
984 if (selrtn == -1) {
985 /* something is wrong. Maybe the socket is dead? */
986 if (fd == get_client_fd()) {
987 /* Try and give an error message saying
988 * what client failed. */
989 DEBUG(0,("read_socket_with_timeout: timeout "
990 "read for client %s. select error = %s.\n",
991 get_peer_addr(fd,addr,sizeof(addr)),
992 strerror(errno) ));
993 } else {
994 DEBUG(0,("read_socket_with_timeout: timeout "
995 "read. select error = %s.\n",
996 strerror(errno) ));
998 return map_nt_error_from_unix(errno);
1001 /* Did we timeout ? */
1002 if (selrtn == 0) {
1003 DEBUG(10,("read_socket_with_timeout: timeout read. "
1004 "select timed out.\n"));
1005 return NT_STATUS_IO_TIMEOUT;
1008 readret = sys_read(fd, buf+nread, maxcnt-nread);
1010 if (readret == 0) {
1011 /* we got EOF on the file descriptor */
1012 DEBUG(5,("read_socket_with_timeout: timeout read. "
1013 "EOF from client.\n"));
1014 return NT_STATUS_END_OF_FILE;
1017 if (readret == -1) {
1018 /* the descriptor is probably dead */
1019 if (fd == get_client_fd()) {
1020 /* Try and give an error message
1021 * saying what client failed. */
1022 DEBUG(0,("read_socket_with_timeout: timeout "
1023 "read to client %s. read error = %s.\n",
1024 get_peer_addr(fd,addr,sizeof(addr)),
1025 strerror(errno) ));
1026 } else {
1027 DEBUG(0,("read_socket_with_timeout: timeout "
1028 "read. read error = %s.\n",
1029 strerror(errno) ));
1031 return map_nt_error_from_unix(errno);
1034 nread += readret;
1037 done:
1038 /* Return the number we got */
1039 if (size_ret) {
1040 *size_ret = nread;
1042 return NT_STATUS_OK;
1045 /****************************************************************************
1046 Read data from the client, reading exactly N bytes.
1047 ****************************************************************************/
1049 NTSTATUS read_data(int fd, char *buffer, size_t N)
1051 return read_socket_with_timeout(fd, buffer, N, N, 0, NULL);
1054 /****************************************************************************
1055 Write data to a fd.
1056 ****************************************************************************/
1058 ssize_t write_data(int fd, const char *buffer, size_t N)
1060 size_t total=0;
1061 ssize_t ret;
1062 char addr[INET6_ADDRSTRLEN];
1064 while (total < N) {
1065 ret = sys_write(fd,buffer + total,N - total);
1067 if (ret == -1) {
1068 if (fd == get_client_fd()) {
1069 /* Try and give an error message saying
1070 * what client failed. */
1071 DEBUG(0,("write_data: write failure in "
1072 "writing to client %s. Error %s\n",
1073 get_peer_addr(fd,addr,sizeof(addr)),
1074 strerror(errno) ));
1075 } else {
1076 DEBUG(0,("write_data: write failure. "
1077 "Error = %s\n", strerror(errno) ));
1079 return -1;
1082 if (ret == 0) {
1083 return total;
1086 total += ret;
1088 return (ssize_t)total;
1091 /****************************************************************************
1092 Send a keepalive packet (rfc1002).
1093 ****************************************************************************/
1095 bool send_keepalive(int client)
1097 unsigned char buf[4];
1099 buf[0] = SMBkeepalive;
1100 buf[1] = buf[2] = buf[3] = 0;
1102 return(write_data(client,(char *)buf,4) == 4);
1105 /****************************************************************************
1106 Read 4 bytes of a smb packet and return the smb length of the packet.
1107 Store the result in the buffer.
1108 This version of the function will return a length of zero on receiving
1109 a keepalive packet.
1110 Timeout is in milliseconds.
1111 ****************************************************************************/
1113 NTSTATUS read_smb_length_return_keepalive(int fd, char *inbuf,
1114 unsigned int timeout,
1115 size_t *len)
1117 int msg_type;
1118 NTSTATUS status;
1120 status = read_socket_with_timeout(fd, inbuf, 4, 4, timeout, NULL);
1122 if (!NT_STATUS_IS_OK(status)) {
1123 return status;
1126 *len = smb_len(inbuf);
1127 msg_type = CVAL(inbuf,0);
1129 if (msg_type == SMBkeepalive) {
1130 DEBUG(5,("Got keepalive packet\n"));
1133 DEBUG(10,("got smb length of %lu\n",(unsigned long)(*len)));
1135 return NT_STATUS_OK;
1138 /****************************************************************************
1139 Read 4 bytes of a smb packet and return the smb length of the packet.
1140 Store the result in the buffer. This version of the function will
1141 never return a session keepalive (length of zero).
1142 Timeout is in milliseconds.
1143 ****************************************************************************/
1145 NTSTATUS read_smb_length(int fd, char *inbuf, unsigned int timeout,
1146 size_t *len)
1148 uint8_t msgtype = SMBkeepalive;
1150 while (msgtype == SMBkeepalive) {
1151 NTSTATUS status;
1153 status = read_smb_length_return_keepalive(fd, inbuf, timeout,
1154 len);
1155 if (!NT_STATUS_IS_OK(status)) {
1156 return status;
1159 msgtype = CVAL(inbuf, 0);
1162 DEBUG(10,("read_smb_length: got smb length of %lu\n",
1163 (unsigned long)len));
1165 return NT_STATUS_OK;
1168 /****************************************************************************
1169 Read an smb from a fd. Note that the buffer *MUST* be of size
1170 BUFFER_SIZE+SAFETY_MARGIN.
1171 The timeout is in milliseconds.
1172 This function will return on receipt of a session keepalive packet.
1173 maxlen is the max number of bytes to return, not including the 4 byte
1174 length. If zero it means BUFFER_SIZE+SAFETY_MARGIN limit.
1175 Doesn't check the MAC on signed packets.
1176 ****************************************************************************/
1178 NTSTATUS receive_smb_raw(int fd, char *buffer, unsigned int timeout,
1179 size_t maxlen, size_t *p_len)
1181 size_t len;
1182 NTSTATUS status;
1184 status = read_smb_length_return_keepalive(fd,buffer,timeout,&len);
1186 if (!NT_STATUS_IS_OK(status)) {
1187 DEBUG(10, ("receive_smb_raw: %s!\n", nt_errstr(status)));
1188 return status;
1192 * A WRITEX with CAP_LARGE_WRITEX can be 64k worth of data plus 65 bytes
1193 * of header. Don't print the error if this fits.... JRA.
1196 if (len > (BUFFER_SIZE + LARGE_WRITEX_HDR_SIZE)) {
1197 DEBUG(0,("Invalid packet length! (%lu bytes).\n",
1198 (unsigned long)len));
1199 if (len > BUFFER_SIZE + (SAFETY_MARGIN/2)) {
1200 return NT_STATUS_INVALID_PARAMETER;
1204 if(len > 0) {
1205 if (maxlen) {
1206 len = MIN(len,maxlen);
1209 status = read_socket_with_timeout(
1210 fd, buffer+4, len, len, timeout, &len);
1212 if (!NT_STATUS_IS_OK(status)) {
1213 return status;
1216 /* not all of samba3 properly checks for packet-termination
1217 * of strings. This ensures that we don't run off into
1218 * empty space. */
1219 SSVAL(buffer+4,len, 0);
1222 *p_len = len;
1223 return NT_STATUS_OK;
1226 /****************************************************************************
1227 Open a socket of the specified type, port, and address for incoming data.
1228 ****************************************************************************/
1230 int open_socket_in(int type,
1231 uint16_t port,
1232 int dlevel,
1233 const struct sockaddr_storage *psock,
1234 bool rebind)
1236 struct sockaddr_storage sock;
1237 int res;
1238 socklen_t slen = sizeof(struct sockaddr_in);
1240 sock = *psock;
1242 #if defined(HAVE_IPV6)
1243 if (sock.ss_family == AF_INET6) {
1244 ((struct sockaddr_in6 *)&sock)->sin6_port = htons(port);
1245 slen = sizeof(struct sockaddr_in6);
1247 #endif
1248 if (sock.ss_family == AF_INET) {
1249 ((struct sockaddr_in *)&sock)->sin_port = htons(port);
1252 res = socket(sock.ss_family, type, 0 );
1253 if( res == -1 ) {
1254 if( DEBUGLVL(0) ) {
1255 dbgtext( "open_socket_in(): socket() call failed: " );
1256 dbgtext( "%s\n", strerror( errno ) );
1258 return -1;
1261 /* This block sets/clears the SO_REUSEADDR and possibly SO_REUSEPORT. */
1263 int val = rebind ? 1 : 0;
1264 if( setsockopt(res,SOL_SOCKET,SO_REUSEADDR,
1265 (char *)&val,sizeof(val)) == -1 ) {
1266 if( DEBUGLVL( dlevel ) ) {
1267 dbgtext( "open_socket_in(): setsockopt: " );
1268 dbgtext( "SO_REUSEADDR = %s ",
1269 val?"true":"false" );
1270 dbgtext( "on port %d failed ", port );
1271 dbgtext( "with error = %s\n", strerror(errno) );
1274 #ifdef SO_REUSEPORT
1275 if( setsockopt(res,SOL_SOCKET,SO_REUSEPORT,
1276 (char *)&val,sizeof(val)) == -1 ) {
1277 if( DEBUGLVL( dlevel ) ) {
1278 dbgtext( "open_socket_in(): setsockopt: ");
1279 dbgtext( "SO_REUSEPORT = %s ",
1280 val?"true":"false");
1281 dbgtext( "on port %d failed ", port);
1282 dbgtext( "with error = %s\n", strerror(errno));
1285 #endif /* SO_REUSEPORT */
1288 /* now we've got a socket - we need to bind it */
1289 if (bind(res, (struct sockaddr *)&sock, slen) == -1 ) {
1290 if( DEBUGLVL(dlevel) && (port == SMB_PORT1 ||
1291 port == SMB_PORT2 || port == NMB_PORT) ) {
1292 char addr[INET6_ADDRSTRLEN];
1293 print_sockaddr(addr, sizeof(addr),
1294 &sock);
1295 dbgtext( "bind failed on port %d ", port);
1296 dbgtext( "socket_addr = %s.\n", addr);
1297 dbgtext( "Error = %s\n", strerror(errno));
1299 close(res);
1300 return -1;
1303 DEBUG( 10, ( "bind succeeded on port %d\n", port ) );
1304 return( res );
1307 /****************************************************************************
1308 Create an outgoing socket. timeout is in milliseconds.
1309 **************************************************************************/
1311 int open_socket_out(int type,
1312 const struct sockaddr_storage *pss,
1313 uint16_t port,
1314 int timeout)
1316 char addr[INET6_ADDRSTRLEN];
1317 struct sockaddr_storage sock_out = *pss;
1318 int res,ret;
1319 int connect_loop = 10;
1320 int increment = 10;
1322 /* create a socket to write to */
1323 res = socket(pss->ss_family, type, 0);
1324 if (res == -1) {
1325 DEBUG(0,("socket error (%s)\n", strerror(errno)));
1326 return -1;
1329 if (type != SOCK_STREAM) {
1330 return res;
1333 #if defined(HAVE_IPV6)
1334 if (pss->ss_family == AF_INET6) {
1335 struct sockaddr_in6 *psa6 = (struct sockaddr_in6 *)&sock_out;
1336 psa6->sin6_port = htons(port);
1337 if (psa6->sin6_scope_id == 0 &&
1338 IN6_IS_ADDR_LINKLOCAL(&psa6->sin6_addr)) {
1339 setup_linklocal_scope_id(&sock_out);
1342 #endif
1343 if (pss->ss_family == AF_INET) {
1344 struct sockaddr_in *psa = (struct sockaddr_in *)&sock_out;
1345 psa->sin_port = htons(port);
1348 /* set it non-blocking */
1349 set_blocking(res,false);
1351 print_sockaddr(addr, sizeof(addr), &sock_out);
1352 DEBUG(3,("Connecting to %s at port %u\n",
1353 addr,
1354 (unsigned int)port));
1356 /* and connect it to the destination */
1357 connect_again:
1359 ret = sys_connect(res, (struct sockaddr *)&sock_out);
1361 /* Some systems return EAGAIN when they mean EINPROGRESS */
1362 if (ret < 0 && (errno == EINPROGRESS || errno == EALREADY ||
1363 errno == EAGAIN) && (connect_loop < timeout) ) {
1364 smb_msleep(connect_loop);
1365 timeout -= connect_loop;
1366 connect_loop += increment;
1367 if (increment < 250) {
1368 /* After 8 rounds we end up at a max of 255 msec */
1369 increment *= 1.5;
1371 goto connect_again;
1374 if (ret < 0 && (errno == EINPROGRESS || errno == EALREADY ||
1375 errno == EAGAIN)) {
1376 DEBUG(1,("timeout connecting to %s:%u\n",
1377 addr,
1378 (unsigned int)port));
1379 close(res);
1380 return -1;
1383 #ifdef EISCONN
1384 if (ret < 0 && errno == EISCONN) {
1385 errno = 0;
1386 ret = 0;
1388 #endif
1390 if (ret < 0) {
1391 DEBUG(2,("error connecting to %s:%d (%s)\n",
1392 addr,
1393 (unsigned int)port,
1394 strerror(errno)));
1395 close(res);
1396 return -1;
1399 /* set it blocking again */
1400 set_blocking(res,true);
1402 return res;
1405 /****************************************************************************
1406 Create an outgoing TCP socket to any of the addrs. This is for
1407 simultaneous connects to port 445 and 139 of a host or even a variety
1408 of DC's all of which are equivalent for our purposes.
1409 **************************************************************************/
1411 bool open_any_socket_out(struct sockaddr_storage *addrs, int num_addrs,
1412 int timeout, int *fd_index, int *fd)
1414 int i, resulting_index, res;
1415 int *sockets;
1416 bool good_connect;
1418 fd_set r_fds, wr_fds;
1419 struct timeval tv;
1420 int maxfd;
1422 int connect_loop = 10000; /* 10 milliseconds */
1424 timeout *= 1000; /* convert to microseconds */
1426 sockets = SMB_MALLOC_ARRAY(int, num_addrs);
1428 if (sockets == NULL)
1429 return false;
1431 resulting_index = -1;
1433 for (i=0; i<num_addrs; i++)
1434 sockets[i] = -1;
1436 for (i=0; i<num_addrs; i++) {
1437 sockets[i] = socket(addrs[i].ss_family, SOCK_STREAM, 0);
1438 if (sockets[i] < 0)
1439 goto done;
1440 set_blocking(sockets[i], false);
1443 connect_again:
1444 good_connect = false;
1446 for (i=0; i<num_addrs; i++) {
1447 const struct sockaddr * a =
1448 (const struct sockaddr *)&(addrs[i]);
1450 if (sockets[i] == -1)
1451 continue;
1453 if (sys_connect(sockets[i], a) == 0) {
1454 /* Rather unlikely as we are non-blocking, but it
1455 * might actually happen. */
1456 resulting_index = i;
1457 goto done;
1460 if (errno == EINPROGRESS || errno == EALREADY ||
1461 #ifdef EISCONN
1462 errno == EISCONN ||
1463 #endif
1464 errno == EAGAIN || errno == EINTR) {
1465 /* These are the error messages that something is
1466 progressing. */
1467 good_connect = true;
1468 } else if (errno != 0) {
1469 /* There was a direct error */
1470 close(sockets[i]);
1471 sockets[i] = -1;
1475 if (!good_connect) {
1476 /* All of the connect's resulted in real error conditions */
1477 goto done;
1480 /* Lets see if any of the connect attempts succeeded */
1482 maxfd = 0;
1483 FD_ZERO(&wr_fds);
1484 FD_ZERO(&r_fds);
1486 for (i=0; i<num_addrs; i++) {
1487 if (sockets[i] == -1)
1488 continue;
1489 FD_SET(sockets[i], &wr_fds);
1490 FD_SET(sockets[i], &r_fds);
1491 if (sockets[i]>maxfd)
1492 maxfd = sockets[i];
1495 tv.tv_sec = 0;
1496 tv.tv_usec = connect_loop;
1498 res = sys_select_intr(maxfd+1, &r_fds, &wr_fds, NULL, &tv);
1500 if (res < 0)
1501 goto done;
1503 if (res == 0)
1504 goto next_round;
1506 for (i=0; i<num_addrs; i++) {
1508 if (sockets[i] == -1)
1509 continue;
1511 /* Stevens, Network Programming says that if there's a
1512 * successful connect, the socket is only writable. Upon an
1513 * error, it's both readable and writable. */
1515 if (FD_ISSET(sockets[i], &r_fds) &&
1516 FD_ISSET(sockets[i], &wr_fds)) {
1517 /* readable and writable, so it's an error */
1518 close(sockets[i]);
1519 sockets[i] = -1;
1520 continue;
1523 if (!FD_ISSET(sockets[i], &r_fds) &&
1524 FD_ISSET(sockets[i], &wr_fds)) {
1525 /* Only writable, so it's connected */
1526 resulting_index = i;
1527 goto done;
1531 next_round:
1533 timeout -= connect_loop;
1534 if (timeout <= 0)
1535 goto done;
1536 connect_loop *= 1.5;
1537 if (connect_loop > timeout)
1538 connect_loop = timeout;
1539 goto connect_again;
1541 done:
1542 for (i=0; i<num_addrs; i++) {
1543 if (i == resulting_index)
1544 continue;
1545 if (sockets[i] >= 0)
1546 close(sockets[i]);
1549 if (resulting_index >= 0) {
1550 *fd_index = resulting_index;
1551 *fd = sockets[*fd_index];
1552 set_blocking(*fd, true);
1555 free(sockets);
1557 return (resulting_index >= 0);
1559 /****************************************************************************
1560 Open a connected UDP socket to host on port
1561 **************************************************************************/
1563 int open_udp_socket(const char *host, int port)
1565 int type = SOCK_DGRAM;
1566 struct sockaddr_in sock_out;
1567 int res;
1568 struct in_addr addr;
1570 (void)interpret_addr2(&addr, host);
1572 res = socket(PF_INET, type, 0);
1573 if (res == -1) {
1574 return -1;
1577 memset((char *)&sock_out,'\0',sizeof(sock_out));
1578 putip((char *)&sock_out.sin_addr,(char *)&addr);
1579 sock_out.sin_port = htons(port);
1580 sock_out.sin_family = PF_INET;
1582 if (sys_connect(res,(struct sockaddr *)&sock_out)) {
1583 close(res);
1584 return -1;
1587 return res;
1590 /*******************************************************************
1591 Return the IP addr of the remote end of a socket as a string.
1592 Optionally return the struct sockaddr_storage.
1593 ******************************************************************/
1595 static const char *get_peer_addr_internal(int fd,
1596 char *addr_buf,
1597 size_t addr_buf_len,
1598 struct sockaddr_storage *pss,
1599 socklen_t *plength)
1601 struct sockaddr_storage ss;
1602 socklen_t length = sizeof(ss);
1604 strlcpy(addr_buf,"0.0.0.0",addr_buf_len);
1606 if (fd == -1) {
1607 return addr_buf;
1610 if (pss == NULL) {
1611 pss = &ss;
1613 if (plength == NULL) {
1614 plength = &length;
1617 if (getpeername(fd, (struct sockaddr *)pss, plength) < 0) {
1618 DEBUG(0,("getpeername failed. Error was %s\n",
1619 strerror(errno) ));
1620 return addr_buf;
1623 print_sockaddr_len(addr_buf,
1624 addr_buf_len,
1625 pss,
1626 *plength);
1627 return addr_buf;
1630 /*******************************************************************
1631 Matchname - determine if host name matches IP address. Used to
1632 confirm a hostname lookup to prevent spoof attacks.
1633 ******************************************************************/
1635 static bool matchname(const char *remotehost,
1636 const struct sockaddr_storage *pss,
1637 socklen_t len)
1639 struct addrinfo *res = NULL;
1640 struct addrinfo *ailist = NULL;
1641 char addr_buf[INET6_ADDRSTRLEN];
1642 bool ret = interpret_string_addr_internal(&ailist,
1643 remotehost,
1644 AI_ADDRCONFIG|AI_CANONNAME);
1646 if (!ret || ailist == NULL) {
1647 DEBUG(3,("matchname: getaddrinfo failed for "
1648 "name %s [%s]\n",
1649 remotehost,
1650 gai_strerror(ret) ));
1651 return false;
1655 * Make sure that getaddrinfo() returns the "correct" host name.
1658 if (ailist->ai_canonname == NULL ||
1659 (!strequal(remotehost, ailist->ai_canonname) &&
1660 !strequal(remotehost, "localhost"))) {
1661 DEBUG(0,("matchname: host name/name mismatch: %s != %s\n",
1662 remotehost,
1663 ailist->ai_canonname ?
1664 ailist->ai_canonname : "(NULL)"));
1665 freeaddrinfo(ailist);
1666 return false;
1669 /* Look up the host address in the address list we just got. */
1670 for (res = ailist; res; res = res->ai_next) {
1671 if (!res->ai_addr) {
1672 continue;
1674 if (addr_equal((const struct sockaddr_storage *)res->ai_addr,
1675 pss)) {
1676 freeaddrinfo(ailist);
1677 return true;
1682 * The host name does not map to the original host address. Perhaps
1683 * someone has compromised a name server. More likely someone botched
1684 * it, but that could be dangerous, too.
1687 DEBUG(0,("matchname: host name/address mismatch: %s != %s\n",
1688 print_sockaddr_len(addr_buf,
1689 sizeof(addr_buf),
1690 pss,
1691 len),
1692 ailist->ai_canonname ? ailist->ai_canonname : "(NULL)"));
1694 if (ailist) {
1695 freeaddrinfo(ailist);
1697 return false;
1700 /*******************************************************************
1701 Deal with the singleton cache.
1702 ******************************************************************/
1704 struct name_addr_pair {
1705 struct sockaddr_storage ss;
1706 const char *name;
1709 /*******************************************************************
1710 Lookup a name/addr pair. Returns memory allocated from memcache.
1711 ******************************************************************/
1713 static bool lookup_nc(struct name_addr_pair *nc)
1715 DATA_BLOB tmp;
1717 ZERO_STRUCTP(nc);
1719 if (!memcache_lookup(
1720 NULL, SINGLETON_CACHE,
1721 data_blob_string_const("get_peer_name"),
1722 &tmp)) {
1723 return false;
1726 memcpy(&nc->ss, tmp.data, sizeof(nc->ss));
1727 nc->name = (const char *)tmp.data + sizeof(nc->ss);
1728 return true;
1731 /*******************************************************************
1732 Save a name/addr pair.
1733 ******************************************************************/
1735 static void store_nc(const struct name_addr_pair *nc)
1737 DATA_BLOB tmp;
1738 size_t namelen = strlen(nc->name);
1740 tmp = data_blob(NULL, sizeof(nc->ss) + namelen + 1);
1741 if (!tmp.data) {
1742 return;
1744 memcpy(tmp.data, &nc->ss, sizeof(nc->ss));
1745 memcpy(tmp.data+sizeof(nc->ss), nc->name, namelen+1);
1747 memcache_add(NULL, SINGLETON_CACHE,
1748 data_blob_string_const("get_peer_name"),
1749 tmp);
1750 data_blob_free(&tmp);
1753 /*******************************************************************
1754 Return the DNS name of the remote end of a socket.
1755 ******************************************************************/
1757 const char *get_peer_name(int fd, bool force_lookup)
1759 struct name_addr_pair nc;
1760 char addr_buf[INET6_ADDRSTRLEN];
1761 struct sockaddr_storage ss;
1762 socklen_t length = sizeof(ss);
1763 const char *p;
1764 int ret;
1765 char name_buf[MAX_DNS_NAME_LENGTH];
1766 char tmp_name[MAX_DNS_NAME_LENGTH];
1768 /* reverse lookups can be *very* expensive, and in many
1769 situations won't work because many networks don't link dhcp
1770 with dns. To avoid the delay we avoid the lookup if
1771 possible */
1772 if (!lp_hostname_lookups() && (force_lookup == false)) {
1773 length = sizeof(nc.ss);
1774 nc.name = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf),
1775 &nc.ss, &length);
1776 store_nc(&nc);
1777 lookup_nc(&nc);
1778 return nc.name ? nc.name : "UNKNOWN";
1781 lookup_nc(&nc);
1783 memset(&ss, '\0', sizeof(ss));
1784 p = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf), &ss, &length);
1786 /* it might be the same as the last one - save some DNS work */
1787 if (addr_equal(&ss, &nc.ss)) {
1788 return nc.name ? nc.name : "UNKNOWN";
1791 /* Not the same. We need to lookup. */
1792 if (fd == -1) {
1793 return "UNKNOWN";
1796 /* Look up the remote host name. */
1797 ret = sys_getnameinfo((struct sockaddr *)&ss,
1798 length,
1799 name_buf,
1800 sizeof(name_buf),
1801 NULL,
1805 if (ret) {
1806 DEBUG(1,("get_peer_name: getnameinfo failed "
1807 "for %s with error %s\n",
1809 gai_strerror(ret)));
1810 strlcpy(name_buf, p, sizeof(name_buf));
1811 } else {
1812 if (!matchname(name_buf, &ss, length)) {
1813 DEBUG(0,("Matchname failed on %s %s\n",name_buf,p));
1814 strlcpy(name_buf,"UNKNOWN",sizeof(name_buf));
1818 /* can't pass the same source and dest strings in when you
1819 use --enable-developer or the clobber_region() call will
1820 get you */
1822 strlcpy(tmp_name, name_buf, sizeof(tmp_name));
1823 alpha_strcpy(name_buf, tmp_name, "_-.", sizeof(name_buf));
1824 if (strstr(name_buf,"..")) {
1825 strlcpy(name_buf, "UNKNOWN", sizeof(name_buf));
1828 nc.name = name_buf;
1829 nc.ss = ss;
1831 store_nc(&nc);
1832 lookup_nc(&nc);
1833 return nc.name ? nc.name : "UNKNOWN";
1836 /*******************************************************************
1837 Return the IP addr of the remote end of a socket as a string.
1838 ******************************************************************/
1840 const char *get_peer_addr(int fd, char *addr, size_t addr_len)
1842 return get_peer_addr_internal(fd, addr, addr_len, NULL, NULL);
1845 /*******************************************************************
1846 Create protected unix domain socket.
1848 Some unixes cannot set permissions on a ux-dom-sock, so we
1849 have to make sure that the directory contains the protection
1850 permissions instead.
1851 ******************************************************************/
1853 int create_pipe_sock(const char *socket_dir,
1854 const char *socket_name,
1855 mode_t dir_perms)
1857 #ifdef HAVE_UNIXSOCKET
1858 struct sockaddr_un sunaddr;
1859 struct stat st;
1860 int sock;
1861 mode_t old_umask;
1862 char *path = NULL;
1864 old_umask = umask(0);
1866 /* Create the socket directory or reuse the existing one */
1868 if (lstat(socket_dir, &st) == -1) {
1869 if (errno == ENOENT) {
1870 /* Create directory */
1871 if (mkdir(socket_dir, dir_perms) == -1) {
1872 DEBUG(0, ("error creating socket directory "
1873 "%s: %s\n", socket_dir,
1874 strerror(errno)));
1875 goto out_umask;
1877 } else {
1878 DEBUG(0, ("lstat failed on socket directory %s: %s\n",
1879 socket_dir, strerror(errno)));
1880 goto out_umask;
1882 } else {
1883 /* Check ownership and permission on existing directory */
1884 if (!S_ISDIR(st.st_mode)) {
1885 DEBUG(0, ("socket directory %s isn't a directory\n",
1886 socket_dir));
1887 goto out_umask;
1889 if ((st.st_uid != sec_initial_uid()) ||
1890 ((st.st_mode & 0777) != dir_perms)) {
1891 DEBUG(0, ("invalid permissions on socket directory "
1892 "%s\n", socket_dir));
1893 goto out_umask;
1897 /* Create the socket file */
1899 sock = socket(AF_UNIX, SOCK_STREAM, 0);
1901 if (sock == -1) {
1902 DEBUG(0, ("create_pipe_sock: socket error %s\n",
1903 strerror(errno) ));
1904 goto out_close;
1907 asprintf(&path, "%s/%s", socket_dir, socket_name);
1908 if (!path) {
1909 goto out_close;
1912 unlink(path);
1913 memset(&sunaddr, 0, sizeof(sunaddr));
1914 sunaddr.sun_family = AF_UNIX;
1915 strlcpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path));
1917 if (bind(sock, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1) {
1918 DEBUG(0, ("bind failed on pipe socket %s: %s\n", path,
1919 strerror(errno)));
1920 goto out_close;
1923 if (listen(sock, 5) == -1) {
1924 DEBUG(0, ("listen failed on pipe socket %s: %s\n", path,
1925 strerror(errno)));
1926 goto out_close;
1929 SAFE_FREE(path);
1931 umask(old_umask);
1932 return sock;
1934 out_close:
1935 SAFE_FREE(path);
1936 close(sock);
1938 out_umask:
1939 umask(old_umask);
1940 return -1;
1942 #else
1943 DEBUG(0, ("create_pipe_sock: No Unix sockets on this system\n"));
1944 return -1;
1945 #endif /* HAVE_UNIXSOCKET */
1948 /****************************************************************************
1949 Get my own canonical name, including domain.
1950 ****************************************************************************/
1952 const char *get_mydnsfullname(void)
1954 struct addrinfo *res = NULL;
1955 char my_hostname[HOST_NAME_MAX];
1956 bool ret;
1957 DATA_BLOB tmp;
1959 if (memcache_lookup(NULL, SINGLETON_CACHE,
1960 data_blob_string_const("get_mydnsfullname"),
1961 &tmp)) {
1962 SMB_ASSERT(tmp.length > 0);
1963 return (const char *)tmp.data;
1966 /* get my host name */
1967 if (gethostname(my_hostname, sizeof(my_hostname)) == -1) {
1968 DEBUG(0,("get_mydnsfullname: gethostname failed\n"));
1969 return NULL;
1972 /* Ensure null termination. */
1973 my_hostname[sizeof(my_hostname)-1] = '\0';
1975 ret = interpret_string_addr_internal(&res,
1976 my_hostname,
1977 AI_ADDRCONFIG|AI_CANONNAME);
1979 if (!ret || res == NULL) {
1980 DEBUG(3,("get_mydnsfullname: getaddrinfo failed for "
1981 "name %s [%s]\n",
1982 my_hostname,
1983 gai_strerror(ret) ));
1984 return NULL;
1988 * Make sure that getaddrinfo() returns the "correct" host name.
1991 if (res->ai_canonname == NULL) {
1992 DEBUG(3,("get_mydnsfullname: failed to get "
1993 "canonical name for %s\n",
1994 my_hostname));
1995 freeaddrinfo(res);
1996 return NULL;
1999 /* This copies the data, so we must do a lookup
2000 * afterwards to find the value to return.
2003 memcache_add(NULL, SINGLETON_CACHE,
2004 data_blob_string_const("get_mydnsfullname"),
2005 data_blob_string_const(res->ai_canonname));
2007 if (!memcache_lookup(NULL, SINGLETON_CACHE,
2008 data_blob_string_const("get_mydnsfullname"),
2009 &tmp)) {
2010 tmp = data_blob_talloc(talloc_tos(), res->ai_canonname,
2011 strlen(res->ai_canonname) + 1);
2014 freeaddrinfo(res);
2016 return (const char *)tmp.data;
2019 /************************************************************
2020 Is this my name ?
2021 ************************************************************/
2023 bool is_myname_or_ipaddr(const char *s)
2025 TALLOC_CTX *ctx = talloc_tos();
2026 char *name = NULL;
2027 const char *dnsname;
2028 char *servername = NULL;
2030 if (!s) {
2031 return false;
2034 /* Santize the string from '\\name' */
2035 name = talloc_strdup(ctx, s);
2036 if (!name) {
2037 return false;
2040 servername = strrchr_m(name, '\\' );
2041 if (!servername) {
2042 servername = name;
2043 } else {
2044 servername++;
2047 /* Optimize for the common case */
2048 if (strequal(servername, global_myname())) {
2049 return true;
2052 /* Check for an alias */
2053 if (is_myname(servername)) {
2054 return true;
2057 /* Check for loopback */
2058 if (strequal(servername, "127.0.0.1") ||
2059 strequal(servername, "::1")) {
2060 return true;
2063 if (strequal(servername, "localhost")) {
2064 return true;
2067 /* Maybe it's my dns name */
2068 dnsname = get_mydnsfullname();
2069 if (dnsname && strequal(servername, dnsname)) {
2070 return true;
2073 /* Handle possible CNAME records - convert to an IP addr. */
2074 if (!is_ipaddress(servername)) {
2075 /* Use DNS to resolve the name, but only the first address */
2076 struct sockaddr_storage ss;
2077 if (interpret_string_addr(&ss, servername,0)) {
2078 print_sockaddr(name,
2079 sizeof(name),
2080 &ss);
2081 servername = name;
2085 /* Maybe its an IP address? */
2086 if (is_ipaddress(servername)) {
2087 struct sockaddr_storage ss;
2088 struct iface_struct *nics;
2089 int i, n;
2091 if (!interpret_string_addr(&ss, servername, AI_NUMERICHOST)) {
2092 return false;
2095 if (is_zero_addr(&ss) || is_loopback_addr(&ss)) {
2096 return false;
2099 nics = TALLOC_ARRAY(ctx, struct iface_struct,
2100 MAX_INTERFACES);
2101 if (!nics) {
2102 return false;
2104 n = get_interfaces(nics, MAX_INTERFACES);
2105 for (i=0; i<n; i++) {
2106 if (addr_equal(&nics[i].ip, &ss)) {
2107 TALLOC_FREE(nics);
2108 return true;
2111 TALLOC_FREE(nics);
2114 /* No match */
2115 return false;