2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2008
5 Copyright (C) Andrew Tridgell 1992-1998
6 Copyright (C) Jeremy Allison 1992-2007
7 Copyright (C) Simo Sorce 2001
8 Copyright (C) Jim McDonough (jmcd@us.ibm.com) 2003.
9 Copyright (C) James J Myers 2003
10 Copyright (C) Tim Potter 2000-2001
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 3 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>.
27 #include "system/network.h"
28 #include "system/locale.h"
29 #include "system/filesys.h"
30 #include "lib/util/util_net.h"
33 /*******************************************************************
34 Set an address to INADDR_ANY.
35 ******************************************************************/
37 void zero_sockaddr(struct sockaddr_storage
*pss
)
40 /* Ensure we're at least a valid sockaddr-storage. */
41 pss
->ss_family
= AF_INET
;
47 bool interpret_string_addr_internal(struct addrinfo
**ppres
,
48 const char *str
, int flags
)
51 struct addrinfo hints
;
55 /* By default make sure it supports TCP. */
56 hints
.ai_socktype
= SOCK_STREAM
;
58 /* always try as a numeric host first. This prevents unnecessary name
59 * lookups, and also ensures we accept IPv6 addresses */
60 hints
.ai_flags
= AI_PASSIVE
| AI_NUMERICHOST
;
61 ret
= getaddrinfo(str
, NULL
, &hints
, ppres
);
66 hints
.ai_flags
= flags
;
68 /* Linux man page on getaddrinfo() says port will be
69 uninitialized when service string is NULL */
71 ret
= getaddrinfo(str
, NULL
,
76 DEBUG(3, ("interpret_string_addr_internal: "
77 "getaddrinfo failed for name %s (flags %d) [%s]\n",
78 str
, flags
, gai_strerror(ret
)));
84 /*******************************************************************
85 Map a text hostname or IP address (IPv4 or IPv6) into a
86 struct sockaddr_storage. Takes a flag which allows it to
87 prefer an IPv4 address (needed for DC's).
88 ******************************************************************/
90 static bool interpret_string_addr_pref(struct sockaddr_storage
*pss
,
95 struct addrinfo
*res
= NULL
;
96 #if defined(HAVE_IPV6)
97 char addr
[INET6_ADDRSTRLEN
];
98 unsigned int scope_id
= 0;
101 if (strchr_m(str
, ':')) {
102 char *p
= strchr_m(str
, '%');
105 * Cope with link-local.
106 * This is IP:v6:addr%ifname.
109 if (p
&& (p
> str
) && ((scope_id
= if_nametoindex(p
+1)) != 0)) {
111 MIN(PTR_DIFF(p
,str
)+1,
120 if (flags
& AI_NUMERICHOST
) {
123 int_flags
= flags
|AI_ADDRCONFIG
;
126 if (!interpret_string_addr_internal(&res
, str
, int_flags
)) {
136 for (p
= res
; p
; p
= p
->ai_next
) {
137 if (p
->ai_family
== AF_INET
) {
138 memcpy(pss
, p
->ai_addr
, p
->ai_addrlen
);
143 /* Copy the first sockaddr. */
144 memcpy(pss
, res
->ai_addr
, res
->ai_addrlen
);
147 /* Copy the first sockaddr. */
148 memcpy(pss
, res
->ai_addr
, res
->ai_addrlen
);
151 #if defined(HAVE_IPV6)
152 if (pss
->ss_family
== AF_INET6
&& scope_id
) {
153 struct sockaddr_in6
*ps6
= (struct sockaddr_in6
*)pss
;
154 if (IN6_IS_ADDR_LINKLOCAL(&ps6
->sin6_addr
) &&
155 ps6
->sin6_scope_id
== 0) {
156 ps6
->sin6_scope_id
= scope_id
;
165 /*******************************************************************
166 Map a text hostname or IP address (IPv4 or IPv6) into a
167 struct sockaddr_storage. Address agnostic version.
168 ******************************************************************/
170 bool interpret_string_addr(struct sockaddr_storage
*pss
,
174 return interpret_string_addr_pref(pss
,
180 /*******************************************************************
181 Map a text hostname or IP address (IPv4 or IPv6) into a
182 struct sockaddr_storage. Version that prefers IPv4.
183 ******************************************************************/
185 bool interpret_string_addr_prefer_ipv4(struct sockaddr_storage
*pss
,
189 return interpret_string_addr_pref(pss
,
196 * Interpret an internet address or name into an IP address in 4 byte form.
197 * RETURNS IN NETWORK BYTE ORDER (big endian).
200 uint32_t interpret_addr(const char *str
)
204 /* If it's in the form of an IP address then
205 * get the lib to interpret it */
206 if (is_ipaddress_v4(str
)) {
209 if (inet_pton(AF_INET
, str
, &dest
) <= 0) {
210 /* Error - this shouldn't happen ! */
211 DEBUG(0,("interpret_addr: inet_pton failed "
216 ret
= dest
.s_addr
; /* NETWORK BYTE ORDER ! */
218 /* Otherwise assume it's a network name of some sort and use
220 struct addrinfo
*res
= NULL
;
221 struct addrinfo
*res_list
= NULL
;
222 if (!interpret_string_addr_internal(&res_list
,
225 DEBUG(3,("interpret_addr: Unknown host. %s\n",str
));
229 /* Find the first IPv4 address. */
230 for (res
= res_list
; res
; res
= res
->ai_next
) {
231 if (res
->ai_family
!= AF_INET
) {
234 if (res
->ai_addr
== NULL
) {
240 DEBUG(3,("interpret_addr: host address is "
241 "invalid for host %s\n",str
));
243 freeaddrinfo(res_list
);
248 &((struct sockaddr_in
*)res
->ai_addr
)->sin_addr
.s_addr
,
251 freeaddrinfo(res_list
);
255 /* This is so bogus - all callers need fixing... JRA. */
256 if (ret
== (uint32_t)-1) {
264 A convenient addition to interpret_addr().
266 _PUBLIC_
struct in_addr
interpret_addr2(const char *str
)
269 uint32_t a
= interpret_addr(str
);
275 Check if an IP is the 0.0.0.0.
278 _PUBLIC_
bool is_zero_ip_v4(struct in_addr ip
)
280 return ip
.s_addr
== 0;
284 Are two IPs on the same subnet?
287 _PUBLIC_
bool same_net_v4(struct in_addr ip1
, struct in_addr ip2
, struct in_addr mask
)
289 uint32_t net1
,net2
,nmask
;
291 nmask
= ntohl(mask
.s_addr
);
292 net1
= ntohl(ip1
.s_addr
);
293 net2
= ntohl(ip2
.s_addr
);
295 return((net1
& nmask
) == (net2
& nmask
));
299 * Return true if a string could be an IPv4 address.
302 bool is_ipaddress_v4(const char *str
)
307 ret
= inet_pton(AF_INET
, str
, &dest
);
315 * Return true if a string could be a IPv6 address.
318 bool is_ipaddress_v6(const char *str
)
320 #if defined(HAVE_IPV6)
323 if (strchr_m(str
, ':')) {
324 char addr
[INET6_ADDRSTRLEN
];
325 struct in6_addr dest6
;
326 const char *sp
= str
;
327 char *p
= strchr_m(str
, '%');
330 * Cope with link-local.
331 * This is IP:v6:addr%ifname.
334 if (p
&& (p
> str
) && (if_nametoindex(p
+1) != 0)) {
336 MIN(PTR_DIFF(p
,str
)+1,
340 ret
= inet_pton(AF_INET6
, sp
, &dest6
);
350 * Return true if a string could be an IPv4 or IPv6 address.
353 bool is_ipaddress(const char *str
)
355 return is_ipaddress_v4(str
) || is_ipaddress_v6(str
);
359 * Is a sockaddr a broadcast address ?
362 bool is_broadcast_addr(const struct sockaddr
*pss
)
364 #if defined(HAVE_IPV6)
365 if (pss
->sa_family
== AF_INET6
) {
366 const struct in6_addr
*sin6
=
367 &((const struct sockaddr_in6
*)pss
)->sin6_addr
;
368 return IN6_IS_ADDR_MULTICAST(sin6
);
371 if (pss
->sa_family
== AF_INET
) {
373 ntohl(((const struct sockaddr_in
*)pss
)->sin_addr
.s_addr
);
374 return addr
== INADDR_BROADCAST
;
380 * Check if an IPv7 is 127.0.0.1
382 bool is_loopback_ip_v4(struct in_addr ip
)
385 a
.s_addr
= htonl(INADDR_LOOPBACK
);
386 return(ip
.s_addr
== a
.s_addr
);
390 * Check if a struct sockaddr is the loopback address.
392 bool is_loopback_addr(const struct sockaddr
*pss
)
394 #if defined(HAVE_IPV6)
395 if (pss
->sa_family
== AF_INET6
) {
396 const struct in6_addr
*pin6
=
397 &((const struct sockaddr_in6
*)pss
)->sin6_addr
;
398 return IN6_IS_ADDR_LOOPBACK(pin6
);
401 if (pss
->sa_family
== AF_INET
) {
402 const struct in_addr
*pin
= &((const struct sockaddr_in
*)pss
)->sin_addr
;
403 return is_loopback_ip_v4(*pin
);
409 * Check if a struct sockaddr has an unspecified address.
411 bool is_zero_addr(const struct sockaddr_storage
*pss
)
413 #if defined(HAVE_IPV6)
414 if (pss
->ss_family
== AF_INET6
) {
415 const struct in6_addr
*pin6
=
416 &((const struct sockaddr_in6
*)pss
)->sin6_addr
;
417 return IN6_IS_ADDR_UNSPECIFIED(pin6
);
420 if (pss
->ss_family
== AF_INET
) {
421 const struct in_addr
*pin
= &((const struct sockaddr_in
*)pss
)->sin_addr
;
422 return is_zero_ip_v4(*pin
);
428 * Set an IP to 0.0.0.0.
430 void zero_ip_v4(struct in_addr
*ip
)
436 * Convert an IPv4 struct in_addr to a struct sockaddr_storage.
438 void in_addr_to_sockaddr_storage(struct sockaddr_storage
*ss
,
441 struct sockaddr_in
*sa
= (struct sockaddr_in
*)ss
;
443 sa
->sin_family
= AF_INET
;
447 #if defined(HAVE_IPV6)
449 * Convert an IPv6 struct in_addr to a struct sockaddr_storage.
451 void in6_addr_to_sockaddr_storage(struct sockaddr_storage
*ss
,
454 struct sockaddr_in6
*sa
= (struct sockaddr_in6
*)ss
;
455 memset(ss
, '\0', sizeof(*ss
));
456 sa
->sin6_family
= AF_INET6
;
462 * Are two IPs on the same subnet?
464 bool same_net(const struct sockaddr
*ip1
,
465 const struct sockaddr
*ip2
,
466 const struct sockaddr
*mask
)
468 if (ip1
->sa_family
!= ip2
->sa_family
) {
469 /* Never on the same net. */
473 #if defined(HAVE_IPV6)
474 if (ip1
->sa_family
== AF_INET6
) {
475 struct sockaddr_in6 ip1_6
= *(const struct sockaddr_in6
*)ip1
;
476 struct sockaddr_in6 ip2_6
= *(const struct sockaddr_in6
*)ip2
;
477 struct sockaddr_in6 mask_6
= *(const struct sockaddr_in6
*)mask
;
478 char *p1
= (char *)&ip1_6
.sin6_addr
;
479 char *p2
= (char *)&ip2_6
.sin6_addr
;
480 char *m
= (char *)&mask_6
.sin6_addr
;
483 for (i
= 0; i
< sizeof(struct in6_addr
); i
++) {
488 return (memcmp(&ip1_6
.sin6_addr
,
490 sizeof(struct in6_addr
)) == 0);
493 if (ip1
->sa_family
== AF_INET
) {
494 return same_net_v4(((const struct sockaddr_in
*)ip1
)->sin_addr
,
495 ((const struct sockaddr_in
*)ip2
)->sin_addr
,
496 ((const struct sockaddr_in
*)mask
)->sin_addr
);
502 * Are two sockaddr 's the same family and address ? Ignore port etc.
505 bool sockaddr_equal(const struct sockaddr
*ip1
,
506 const struct sockaddr
*ip2
)
508 if (ip1
->sa_family
!= ip2
->sa_family
) {
509 /* Never the same. */
513 #if defined(HAVE_IPV6)
514 if (ip1
->sa_family
== AF_INET6
) {
515 return (memcmp(&((const struct sockaddr_in6
*)ip1
)->sin6_addr
,
516 &((const struct sockaddr_in6
*)ip2
)->sin6_addr
,
517 sizeof(struct in6_addr
)) == 0);
520 if (ip1
->sa_family
== AF_INET
) {
521 return (memcmp(&((const struct sockaddr_in
*)ip1
)->sin_addr
,
522 &((const struct sockaddr_in
*)ip2
)->sin_addr
,
523 sizeof(struct in_addr
)) == 0);
529 * Is an IP address the INADDR_ANY or in6addr_any value ?
531 bool is_address_any(const struct sockaddr
*psa
)
533 #if defined(HAVE_IPV6)
534 if (psa
->sa_family
== AF_INET6
) {
535 const struct sockaddr_in6
*si6
= (const struct sockaddr_in6
*)psa
;
536 if (memcmp(&in6addr_any
,
538 sizeof(in6addr_any
)) == 0) {
544 if (psa
->sa_family
== AF_INET
) {
545 const struct sockaddr_in
*si
= (const struct sockaddr_in
*)psa
;
546 if (si
->sin_addr
.s_addr
== INADDR_ANY
) {
554 void set_sockaddr_port(struct sockaddr
*psa
, uint16_t port
)
556 #if defined(HAVE_IPV6)
557 if (psa
->sa_family
== AF_INET6
) {
558 ((struct sockaddr_in6
*)psa
)->sin6_port
= htons(port
);
561 if (psa
->sa_family
== AF_INET
) {
562 ((struct sockaddr_in
*)psa
)->sin_port
= htons(port
);
567 /****************************************************************************
568 Get a port number in host byte order from a sockaddr_storage.
569 ****************************************************************************/
571 uint16_t get_sockaddr_port(const struct sockaddr_storage
*pss
)
575 if (pss
->ss_family
!= AF_INET
) {
576 #if defined(HAVE_IPV6)
578 const struct sockaddr_in6
*sa6
=
579 (const struct sockaddr_in6
*)pss
;
580 port
= ntohs(sa6
->sin6_port
);
583 const struct sockaddr_in
*sa
=
584 (const struct sockaddr_in
*)pss
;
585 port
= ntohs(sa
->sin_port
);
590 /****************************************************************************
591 Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
592 ****************************************************************************/
594 char *print_sockaddr_len(char *dest
,
596 const struct sockaddr
*psa
,
602 (void)sys_getnameinfo(psa
,
610 /****************************************************************************
611 Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
612 ****************************************************************************/
614 char *print_sockaddr(char *dest
,
616 const struct sockaddr_storage
*psa
)
618 return print_sockaddr_len(dest
, destlen
, (const struct sockaddr
*)psa
,
619 sizeof(struct sockaddr_storage
));
622 /****************************************************************************
623 Print out a canonical IPv4 or IPv6 address from a struct sockaddr_storage.
624 ****************************************************************************/
626 char *print_canonical_sockaddr(TALLOC_CTX
*ctx
,
627 const struct sockaddr_storage
*pss
)
629 char addr
[INET6_ADDRSTRLEN
];
633 /* Linux getnameinfo() man pages says port is unitialized if
634 service name is NULL. */
636 ret
= sys_getnameinfo((const struct sockaddr
*)pss
,
637 sizeof(struct sockaddr_storage
),
645 if (pss
->ss_family
!= AF_INET
) {
646 #if defined(HAVE_IPV6)
647 dest
= talloc_asprintf(ctx
, "[%s]", addr
);
652 dest
= talloc_asprintf(ctx
, "%s", addr
);
658 /****************************************************************************
659 Return the port number we've bound to on a socket.
660 ****************************************************************************/
662 int get_socket_port(int fd
)
664 struct sockaddr_storage sa
;
665 socklen_t length
= sizeof(sa
);
671 if (getsockname(fd
, (struct sockaddr
*)&sa
, &length
) < 0) {
672 int level
= (errno
== ENOTCONN
) ? 2 : 0;
673 DEBUG(level
, ("getsockname failed. Error was %s\n",
678 #if defined(HAVE_IPV6)
679 if (sa
.ss_family
== AF_INET6
) {
680 return ntohs(((struct sockaddr_in6
*)&sa
)->sin6_port
);
683 if (sa
.ss_family
== AF_INET
) {
684 return ntohs(((struct sockaddr_in
*)&sa
)->sin_port
);
689 /****************************************************************************
690 Return the string of an IP address (IPv4 or IPv6).
691 ****************************************************************************/
693 static const char *get_socket_addr(int fd
, char *addr_buf
, size_t addr_len
)
695 struct sockaddr_storage sa
;
696 socklen_t length
= sizeof(sa
);
698 /* Ok, returning a hard coded IPv4 address
699 * is bogus, but it's just as bogus as a
700 * zero IPv6 address. No good choice here.
703 strlcpy(addr_buf
, "0.0.0.0", addr_len
);
709 if (getsockname(fd
, (struct sockaddr
*)&sa
, &length
) < 0) {
710 DEBUG(0,("getsockname failed. Error was %s\n",
715 return print_sockaddr_len(addr_buf
, addr_len
, (struct sockaddr
*)&sa
, length
);
718 const char *client_socket_addr(int fd
, char *addr
, size_t addr_len
)
720 return get_socket_addr(fd
, addr
, addr_len
);
724 enum SOCK_OPT_TYPES
{OPT_BOOL
,OPT_INT
,OPT_ON
};
726 typedef struct smb_socket_option
{
734 static const smb_socket_option socket_options
[] = {
735 {"SO_KEEPALIVE", SOL_SOCKET
, SO_KEEPALIVE
, 0, OPT_BOOL
},
736 {"SO_REUSEADDR", SOL_SOCKET
, SO_REUSEADDR
, 0, OPT_BOOL
},
737 {"SO_BROADCAST", SOL_SOCKET
, SO_BROADCAST
, 0, OPT_BOOL
},
739 {"TCP_NODELAY", IPPROTO_TCP
, TCP_NODELAY
, 0, OPT_BOOL
},
742 {"TCP_KEEPCNT", IPPROTO_TCP
, TCP_KEEPCNT
, 0, OPT_INT
},
745 {"TCP_KEEPIDLE", IPPROTO_TCP
, TCP_KEEPIDLE
, 0, OPT_INT
},
748 {"TCP_KEEPINTVL", IPPROTO_TCP
, TCP_KEEPINTVL
, 0, OPT_INT
},
750 #ifdef IPTOS_LOWDELAY
751 {"IPTOS_LOWDELAY", IPPROTO_IP
, IP_TOS
, IPTOS_LOWDELAY
, OPT_ON
},
753 #ifdef IPTOS_THROUGHPUT
754 {"IPTOS_THROUGHPUT", IPPROTO_IP
, IP_TOS
, IPTOS_THROUGHPUT
, OPT_ON
},
757 {"SO_REUSEPORT", SOL_SOCKET
, SO_REUSEPORT
, 0, OPT_BOOL
},
760 {"SO_SNDBUF", SOL_SOCKET
, SO_SNDBUF
, 0, OPT_INT
},
763 {"SO_RCVBUF", SOL_SOCKET
, SO_RCVBUF
, 0, OPT_INT
},
766 {"SO_SNDLOWAT", SOL_SOCKET
, SO_SNDLOWAT
, 0, OPT_INT
},
769 {"SO_RCVLOWAT", SOL_SOCKET
, SO_RCVLOWAT
, 0, OPT_INT
},
772 {"SO_SNDTIMEO", SOL_SOCKET
, SO_SNDTIMEO
, 0, OPT_INT
},
775 {"SO_RCVTIMEO", SOL_SOCKET
, SO_RCVTIMEO
, 0, OPT_INT
},
778 {"TCP_FASTACK", IPPROTO_TCP
, TCP_FASTACK
, 0, OPT_INT
},
781 {"TCP_QUICKACK", IPPROTO_TCP
, TCP_QUICKACK
, 0, OPT_BOOL
},
783 #ifdef TCP_KEEPALIVE_THRESHOLD
784 {"TCP_KEEPALIVE_THRESHOLD", IPPROTO_TCP
, TCP_KEEPALIVE_THRESHOLD
, 0, OPT_INT
},
786 #ifdef TCP_KEEPALIVE_ABORT_THRESHOLD
787 {"TCP_KEEPALIVE_ABORT_THRESHOLD", IPPROTO_TCP
, TCP_KEEPALIVE_ABORT_THRESHOLD
, 0, OPT_INT
},
791 /****************************************************************************
792 Print socket options.
793 ****************************************************************************/
795 static void print_socket_options(int s
)
799 const smb_socket_option
*p
= &socket_options
[0];
801 /* wrapped in if statement to prevent streams
802 * leak in SCO Openserver 5.0 */
803 /* reported on samba-technical --jerry */
804 if ( DEBUGLEVEL
>= 5 ) {
805 DEBUG(5,("Socket options:\n"));
806 for (; p
->name
!= NULL
; p
++) {
807 if (getsockopt(s
, p
->level
, p
->option
,
808 (void *)&value
, &vlen
) == -1) {
809 DEBUGADD(5,("\tCould not test socket option %s.\n",
812 DEBUGADD(5,("\t%s = %d\n",
819 /****************************************************************************
820 Set user socket options.
821 ****************************************************************************/
823 void set_socket_options(int fd
, const char *options
)
825 TALLOC_CTX
*ctx
= talloc_new(NULL
);
828 while (next_token_talloc(ctx
, &options
, &tok
," \t,")) {
832 bool got_value
= false;
834 if ((p
= strchr_m(tok
,'='))) {
840 for (i
=0;socket_options
[i
].name
;i
++)
841 if (strequal(socket_options
[i
].name
,tok
))
844 if (!socket_options
[i
].name
) {
845 DEBUG(0,("Unknown socket option %s\n",tok
));
849 switch (socket_options
[i
].opttype
) {
852 ret
= setsockopt(fd
,socket_options
[i
].level
,
853 socket_options
[i
].option
,
854 (char *)&value
,sizeof(int));
859 DEBUG(0,("syntax error - %s "
860 "does not take a value\n",tok
));
863 int on
= socket_options
[i
].value
;
864 ret
= setsockopt(fd
,socket_options
[i
].level
,
865 socket_options
[i
].option
,
866 (char *)&on
,sizeof(int));
872 /* be aware that some systems like Solaris return
873 * EINVAL to a setsockopt() call when the client
874 * sent a RST previously - no need to worry */
875 DEBUG(2,("Failed to set socket option %s (Error %s)\n",
876 tok
, strerror(errno
) ));
881 print_socket_options(fd
);