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/>.
24 /*******************************************************************
25 Map a text hostname or IP address (IPv4 or IPv6) into a
26 struct sockaddr_storage.
27 ******************************************************************/
29 bool interpret_string_addr(struct sockaddr_storage *pss,
33 struct addrinfo *res = NULL;
34 #if defined(HAVE_IPV6)
35 char addr[INET6_ADDRSTRLEN];
36 unsigned int scope_id = 0;
38 if (strchr_m(str, ':')) {
39 char *p = strchr_m(str, '%');
42 * Cope with link-local.
43 * This is IP:v6:addr%ifname.
46 if (p && (p > str) && ((scope_id = if_nametoindex(p+1)) != 0)) {
48 MIN(PTR_DIFF(p,str)+1,
57 if (!interpret_string_addr_internal(&res, str, flags|AI_ADDRCONFIG)) {
63 /* Copy the first sockaddr. */
64 memcpy(pss, res->ai_addr, res->ai_addrlen);
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;
80 /*******************************************************************
81 Set an address to INADDR_ANY.
82 ******************************************************************/
84 void zero_addr(struct sockaddr_storage *pss)
86 memset(pss, '\0', sizeof(*pss));
87 /* Ensure we're at least a valid sockaddr-storage. */
88 pss->ss_family = AF_INET;
91 /****************************************************************************
92 Get a port number in host byte order from a sockaddr_storage.
93 ****************************************************************************/
95 uint16_t get_sockaddr_port(const struct sockaddr_storage *pss)
99 if (pss->ss_family != AF_INET) {
100 #if defined(HAVE_IPV6)
102 const struct sockaddr_in6 *sa6 =
103 (const struct sockaddr_in6 *)pss;
104 port = ntohs(sa6->sin6_port);
107 const struct sockaddr_in *sa =
108 (const struct sockaddr_in *)pss;
109 port = ntohs(sa->sin_port);
114 /****************************************************************************
115 Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
116 ****************************************************************************/
118 static char *print_sockaddr_len(char *dest,
120 const struct sockaddr *psa,
126 (void)sys_getnameinfo(psa,
134 /****************************************************************************
135 Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
136 ****************************************************************************/
138 char *print_sockaddr(char *dest,
140 const struct sockaddr_storage *psa)
142 return print_sockaddr_len(dest, destlen, (struct sockaddr *)psa,
143 sizeof(struct sockaddr_storage));
146 /****************************************************************************
147 Print out a canonical IPv4 or IPv6 address from a struct sockaddr_storage.
148 ****************************************************************************/
150 char *print_canonical_sockaddr(TALLOC_CTX *ctx,
151 const struct sockaddr_storage *pss)
153 char addr[INET6_ADDRSTRLEN];
157 /* Linux getnameinfo() man pages says port is unitialized if
158 service name is NULL. */
160 ret = sys_getnameinfo((const struct sockaddr *)pss,
161 sizeof(struct sockaddr_storage),
169 if (pss->ss_family != AF_INET) {
170 #if defined(HAVE_IPV6)
171 dest = talloc_asprintf(ctx, "[%s]", addr);
176 dest = talloc_asprintf(ctx, "%s", addr);
182 /****************************************************************************
183 Return the string of an IP address (IPv4 or IPv6).
184 ****************************************************************************/
186 static const char *get_socket_addr(int fd, char *addr_buf, size_t addr_len)
188 struct sockaddr_storage sa;
189 socklen_t length = sizeof(sa);
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.
196 strlcpy(addr_buf, "0.0.0.0", addr_len);
202 if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
203 DEBUG(0,("getsockname failed. Error was %s\n",
208 return print_sockaddr_len(addr_buf, addr_len, (struct sockaddr *)&sa, length);
212 /* Not currently used. JRA. */
213 /****************************************************************************
214 Return the port number we've bound to on a socket.
215 ****************************************************************************/
217 static int get_socket_port(int fd)
219 struct sockaddr_storage sa;
220 socklen_t length = sizeof(sa);
226 if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
227 DEBUG(0,("getpeername failed. Error was %s\n",
232 #if defined(HAVE_IPV6)
233 if (sa.ss_family == AF_INET6) {
234 return ntohs(((struct sockaddr_in6 *)&sa)->sin6_port);
237 if (sa.ss_family == AF_INET) {
238 return ntohs(((struct sockaddr_in *)&sa)->sin_port);
244 void set_sockaddr_port(struct sockaddr_storage *psa, uint16 port)
246 #if defined(HAVE_IPV6)
247 if (psa->ss_family == AF_INET6) {
248 ((struct sockaddr_in6 *)psa)->sin6_port = htons(port);
251 if (psa->ss_family == AF_INET) {
252 ((struct sockaddr_in *)psa)->sin_port = htons(port);
256 const char *client_name(int fd)
258 return get_peer_name(fd,false);
261 const char *client_addr(int fd, char *addr, size_t addrlen)
263 return get_peer_addr(fd,addr,addrlen);
266 const char *client_socket_addr(int fd, char *addr, size_t addr_len)
268 return get_socket_addr(fd, addr, addr_len);
272 /* Not currently used. JRA. */
273 int client_socket_port(int fd)
275 return get_socket_port(fd);
279 /****************************************************************************
280 Accessor functions to make thread-safe code easier later...
281 ****************************************************************************/
283 void set_smb_read_error(enum smb_read_errors *pre,
284 enum smb_read_errors newerr)
291 void cond_set_smb_read_error(enum smb_read_errors *pre,
292 enum smb_read_errors newerr)
294 if (pre && *pre == SMB_READ_OK) {
299 /****************************************************************************
300 Determine if a file descriptor is in fact a socket.
301 ****************************************************************************/
303 bool is_a_socket(int fd)
308 return(getsockopt(fd, SOL_SOCKET, SO_TYPE, (char *)&v, &l) == 0);
311 enum SOCK_OPT_TYPES {OPT_BOOL,OPT_INT,OPT_ON};
313 typedef struct smb_socket_option {
321 static const smb_socket_option socket_options[] = {
322 {"SO_KEEPALIVE", SOL_SOCKET, SO_KEEPALIVE, 0, OPT_BOOL},
323 {"SO_REUSEADDR", SOL_SOCKET, SO_REUSEADDR, 0, OPT_BOOL},
324 {"SO_BROADCAST", SOL_SOCKET, SO_BROADCAST, 0, OPT_BOOL},
326 {"TCP_NODELAY", IPPROTO_TCP, TCP_NODELAY, 0, OPT_BOOL},
329 {"TCP_KEEPCNT", IPPROTO_TCP, TCP_KEEPCNT, 0, OPT_INT},
332 {"TCP_KEEPIDLE", IPPROTO_TCP, TCP_KEEPIDLE, 0, OPT_INT},
335 {"TCP_KEEPINTVL", IPPROTO_TCP, TCP_KEEPINTVL, 0, OPT_INT},
337 #ifdef IPTOS_LOWDELAY
338 {"IPTOS_LOWDELAY", IPPROTO_IP, IP_TOS, IPTOS_LOWDELAY, OPT_ON},
340 #ifdef IPTOS_THROUGHPUT
341 {"IPTOS_THROUGHPUT", IPPROTO_IP, IP_TOS, IPTOS_THROUGHPUT, OPT_ON},
344 {"SO_REUSEPORT", SOL_SOCKET, SO_REUSEPORT, 0, OPT_BOOL},
347 {"SO_SNDBUF", SOL_SOCKET, SO_SNDBUF, 0, OPT_INT},
350 {"SO_RCVBUF", SOL_SOCKET, SO_RCVBUF, 0, OPT_INT},
353 {"SO_SNDLOWAT", SOL_SOCKET, SO_SNDLOWAT, 0, OPT_INT},
356 {"SO_RCVLOWAT", SOL_SOCKET, SO_RCVLOWAT, 0, OPT_INT},
359 {"SO_SNDTIMEO", SOL_SOCKET, SO_SNDTIMEO, 0, OPT_INT},
362 {"SO_RCVTIMEO", SOL_SOCKET, SO_RCVTIMEO, 0, OPT_INT},
365 {"TCP_FASTACK", IPPROTO_TCP, TCP_FASTACK, 0, OPT_INT},
369 /****************************************************************************
370 Print socket options.
371 ****************************************************************************/
373 static void print_socket_options(int s)
377 const smb_socket_option *p = &socket_options[0];
379 /* wrapped in if statement to prevent streams
380 * leak in SCO Openserver 5.0 */
381 /* reported on samba-technical --jerry */
382 if ( DEBUGLEVEL >= 5 ) {
383 for (; p->name != NULL; p++) {
384 if (getsockopt(s, p->level, p->option,
385 (void *)&value, &vlen) == -1) {
386 DEBUG(5,("Could not test socket option %s.\n",
389 DEBUG(5,("socket option %s = %d\n",
396 /****************************************************************************
397 Set user socket options.
398 ****************************************************************************/
400 void set_socket_options(int fd, const char *options)
402 TALLOC_CTX *ctx = talloc_stackframe();
405 while (next_token_talloc(ctx, &options, &tok," \t,")) {
409 bool got_value = false;
411 if ((p = strchr_m(tok,'='))) {
417 for (i=0;socket_options[i].name;i++)
418 if (strequal(socket_options[i].name,tok))
421 if (!socket_options[i].name) {
422 DEBUG(0,("Unknown socket option %s\n",tok));
426 switch (socket_options[i].opttype) {
429 ret = setsockopt(fd,socket_options[i].level,
430 socket_options[i].option,
431 (char *)&value,sizeof(int));
436 DEBUG(0,("syntax error - %s "
437 "does not take a value\n",tok));
440 int on = socket_options[i].value;
441 ret = setsockopt(fd,socket_options[i].level,
442 socket_options[i].option,
443 (char *)&on,sizeof(int));
449 /* be aware that some systems like Solaris return
450 * EINVAL to a setsockopt() call when the client
451 * sent a RST previously - no need to worry */
452 DEBUG(2,("Failed to set socket option %s (Error %s)\n",
453 tok, strerror(errno) ));
458 print_socket_options(fd);
461 /****************************************************************************
463 ****************************************************************************/
465 ssize_t read_udp_v4_socket(int fd,
468 struct sockaddr_storage *psa)
471 socklen_t socklen = sizeof(*psa);
472 struct sockaddr_in *si = (struct sockaddr_in *)psa;
474 memset((char *)psa,'\0',socklen);
476 ret = (ssize_t)sys_recvfrom(fd,buf,len,0,
477 (struct sockaddr *)psa,&socklen);
479 /* Don't print a low debug error for a non-blocking socket. */
480 if (errno == EAGAIN) {
481 DEBUG(10,("read_udp_v4_socket: returned EAGAIN\n"));
483 DEBUG(2,("read_udp_v4_socket: failed. errno=%s\n",
489 if (psa->ss_family != AF_INET) {
490 DEBUG(2,("read_udp_v4_socket: invalid address family %d "
491 "(not IPv4)\n", (int)psa->ss_family));
495 DEBUG(10,("read_udp_v4_socket: ip %s port %d read: %lu\n",
496 inet_ntoa(si->sin_addr),
498 (unsigned long)ret));
503 /****************************************************************************
504 Read data from a socket with a timout in msec.
505 mincount = if timeout, minimum to read before returning
506 maxcount = number to be read.
507 time_out = timeout in milliseconds
508 ****************************************************************************/
510 NTSTATUS read_socket_with_timeout(int fd, char *buf,
511 size_t mincnt, size_t maxcnt,
512 unsigned int time_out,
519 struct timeval timeout;
520 char addr[INET6_ADDRSTRLEN];
522 /* just checking .... */
532 while (nread < mincnt) {
533 readret = sys_read(fd, buf + nread, maxcnt - nread);
536 DEBUG(5,("read_socket_with_timeout: "
537 "blocking read. EOF from client.\n"));
538 return NT_STATUS_END_OF_FILE;
542 if (fd == get_client_fd()) {
543 /* Try and give an error message
544 * saying what client failed. */
545 DEBUG(0,("read_socket_with_timeout: "
546 "client %s read error = %s.\n",
547 get_peer_addr(fd,addr,sizeof(addr)),
550 DEBUG(0,("read_socket_with_timeout: "
551 "read error = %s.\n",
554 return map_nt_error_from_unix(errno);
561 /* Most difficult - timeout read */
562 /* If this is ever called on a disk file and
563 mincnt is greater then the filesize then
564 system performance will suffer severely as
565 select always returns true on disk files */
567 /* Set initial timeout */
568 timeout.tv_sec = (time_t)(time_out / 1000);
569 timeout.tv_usec = (long)(1000 * (time_out % 1000));
571 for (nread=0; nread < mincnt; ) {
575 selrtn = sys_select_intr(fd+1,&fds,NULL,NULL,&timeout);
579 /* something is wrong. Maybe the socket is dead? */
580 if (fd == get_client_fd()) {
581 /* Try and give an error message saying
582 * what client failed. */
583 DEBUG(0,("read_socket_with_timeout: timeout "
584 "read for client %s. select error = %s.\n",
585 get_peer_addr(fd,addr,sizeof(addr)),
588 DEBUG(0,("read_socket_with_timeout: timeout "
589 "read. select error = %s.\n",
592 return map_nt_error_from_unix(errno);
595 /* Did we timeout ? */
597 DEBUG(10,("read_socket_with_timeout: timeout read. "
598 "select timed out.\n"));
599 return NT_STATUS_IO_TIMEOUT;
602 readret = sys_read(fd, buf+nread, maxcnt-nread);
605 /* we got EOF on the file descriptor */
606 DEBUG(5,("read_socket_with_timeout: timeout read. "
607 "EOF from client.\n"));
608 return NT_STATUS_END_OF_FILE;
612 /* the descriptor is probably dead */
613 if (fd == get_client_fd()) {
614 /* Try and give an error message
615 * saying what client failed. */
616 DEBUG(0,("read_socket_with_timeout: timeout "
617 "read to client %s. read error = %s.\n",
618 get_peer_addr(fd,addr,sizeof(addr)),
621 DEBUG(0,("read_socket_with_timeout: timeout "
622 "read. read error = %s.\n",
625 return map_nt_error_from_unix(errno);
632 /* Return the number we got */
639 /****************************************************************************
640 Read data from the client, reading exactly N bytes.
641 ****************************************************************************/
643 NTSTATUS read_data(int fd, char *buffer, size_t N)
645 return read_socket_with_timeout(fd, buffer, N, N, 0, NULL);
648 /****************************************************************************
650 ****************************************************************************/
652 ssize_t write_data(int fd, const char *buffer, size_t N)
656 char addr[INET6_ADDRSTRLEN];
659 ret = sys_write(fd,buffer + total,N - total);
662 if (fd == get_client_fd()) {
663 /* Try and give an error message saying
664 * what client failed. */
665 DEBUG(0,("write_data: write failure in "
666 "writing to client %s. Error %s\n",
667 get_peer_addr(fd,addr,sizeof(addr)),
670 DEBUG(0,("write_data: write failure. "
671 "Error = %s\n", strerror(errno) ));
682 return (ssize_t)total;
685 /****************************************************************************
686 Send a keepalive packet (rfc1002).
687 ****************************************************************************/
689 bool send_keepalive(int client)
691 unsigned char buf[4];
693 buf[0] = SMBkeepalive;
694 buf[1] = buf[2] = buf[3] = 0;
696 return(write_data(client,(char *)buf,4) == 4);
699 /****************************************************************************
700 Read 4 bytes of a smb packet and return the smb length of the packet.
701 Store the result in the buffer.
702 This version of the function will return a length of zero on receiving
704 Timeout is in milliseconds.
705 ****************************************************************************/
707 NTSTATUS read_smb_length_return_keepalive(int fd, char *inbuf,
708 unsigned int timeout,
714 status = read_socket_with_timeout(fd, inbuf, 4, 4, timeout, NULL);
716 if (!NT_STATUS_IS_OK(status)) {
720 *len = smb_len(inbuf);
721 msg_type = CVAL(inbuf,0);
723 if (msg_type == SMBkeepalive) {
724 DEBUG(5,("Got keepalive packet\n"));
727 DEBUG(10,("got smb length of %lu\n",(unsigned long)(*len)));
732 /****************************************************************************
733 Read 4 bytes of a smb packet and return the smb length of the packet.
734 Store the result in the buffer. This version of the function will
735 never return a session keepalive (length of zero).
736 Timeout is in milliseconds.
737 ****************************************************************************/
739 NTSTATUS read_smb_length(int fd, char *inbuf, unsigned int timeout,
742 uint8_t msgtype = SMBkeepalive;
744 while (msgtype == SMBkeepalive) {
747 status = read_smb_length_return_keepalive(fd, inbuf, timeout,
749 if (!NT_STATUS_IS_OK(status)) {
753 msgtype = CVAL(inbuf, 0);
756 DEBUG(10,("read_smb_length: got smb length of %lu\n",
757 (unsigned long)len));
762 /****************************************************************************
763 Read an smb from a fd.
764 The timeout is in milliseconds.
765 This function will return on receipt of a session keepalive packet.
766 maxlen is the max number of bytes to return, not including the 4 byte
767 length. If zero it means buflen limit.
768 Doesn't check the MAC on signed packets.
769 ****************************************************************************/
771 NTSTATUS receive_smb_raw(int fd, char *buffer, size_t buflen, unsigned int timeout,
772 size_t maxlen, size_t *p_len)
777 status = read_smb_length_return_keepalive(fd,buffer,timeout,&len);
779 if (!NT_STATUS_IS_OK(status)) {
780 DEBUG(10, ("receive_smb_raw: %s!\n", nt_errstr(status)));
785 DEBUG(0,("Invalid packet length! (%lu bytes).\n",
786 (unsigned long)len));
787 return NT_STATUS_INVALID_PARAMETER;
792 len = MIN(len,maxlen);
795 status = read_socket_with_timeout(
796 fd, buffer+4, len, len, timeout, &len);
798 if (!NT_STATUS_IS_OK(status)) {
802 /* not all of samba3 properly checks for packet-termination
803 * of strings. This ensures that we don't run off into
805 SSVAL(buffer+4,len, 0);
812 /****************************************************************************
813 Open a socket of the specified type, port, and address for incoming data.
814 ****************************************************************************/
816 int open_socket_in(int type,
819 const struct sockaddr_storage *psock,
822 struct sockaddr_storage sock;
824 socklen_t slen = sizeof(struct sockaddr_in);
828 #if defined(HAVE_IPV6)
829 if (sock.ss_family == AF_INET6) {
830 ((struct sockaddr_in6 *)&sock)->sin6_port = htons(port);
831 slen = sizeof(struct sockaddr_in6);
834 if (sock.ss_family == AF_INET) {
835 ((struct sockaddr_in *)&sock)->sin_port = htons(port);
838 res = socket(sock.ss_family, type, 0 );
841 dbgtext( "open_socket_in(): socket() call failed: " );
842 dbgtext( "%s\n", strerror( errno ) );
847 /* This block sets/clears the SO_REUSEADDR and possibly SO_REUSEPORT. */
849 int val = rebind ? 1 : 0;
850 if( setsockopt(res,SOL_SOCKET,SO_REUSEADDR,
851 (char *)&val,sizeof(val)) == -1 ) {
852 if( DEBUGLVL( dlevel ) ) {
853 dbgtext( "open_socket_in(): setsockopt: " );
854 dbgtext( "SO_REUSEADDR = %s ",
855 val?"true":"false" );
856 dbgtext( "on port %d failed ", port );
857 dbgtext( "with error = %s\n", strerror(errno) );
861 if( setsockopt(res,SOL_SOCKET,SO_REUSEPORT,
862 (char *)&val,sizeof(val)) == -1 ) {
863 if( DEBUGLVL( dlevel ) ) {
864 dbgtext( "open_socket_in(): setsockopt: ");
865 dbgtext( "SO_REUSEPORT = %s ",
867 dbgtext( "on port %d failed ", port);
868 dbgtext( "with error = %s\n", strerror(errno));
871 #endif /* SO_REUSEPORT */
874 /* now we've got a socket - we need to bind it */
875 if (bind(res, (struct sockaddr *)&sock, slen) == -1 ) {
876 if( DEBUGLVL(dlevel) && (port == SMB_PORT1 ||
877 port == SMB_PORT2 || port == NMB_PORT) ) {
878 char addr[INET6_ADDRSTRLEN];
879 print_sockaddr(addr, sizeof(addr),
881 dbgtext( "bind failed on port %d ", port);
882 dbgtext( "socket_addr = %s.\n", addr);
883 dbgtext( "Error = %s\n", strerror(errno));
889 DEBUG( 10, ( "bind succeeded on port %d\n", port ) );
893 /****************************************************************************
894 Create an outgoing socket. timeout is in milliseconds.
895 **************************************************************************/
897 int open_socket_out(int type,
898 const struct sockaddr_storage *pss,
902 char addr[INET6_ADDRSTRLEN];
903 struct sockaddr_storage sock_out = *pss;
905 int connect_loop = 10;
908 /* create a socket to write to */
909 res = socket(pss->ss_family, type, 0);
911 DEBUG(0,("socket error (%s)\n", strerror(errno)));
915 if (type != SOCK_STREAM) {
919 #if defined(HAVE_IPV6)
920 if (pss->ss_family == AF_INET6) {
921 struct sockaddr_in6 *psa6 = (struct sockaddr_in6 *)&sock_out;
922 psa6->sin6_port = htons(port);
923 if (psa6->sin6_scope_id == 0 &&
924 IN6_IS_ADDR_LINKLOCAL(&psa6->sin6_addr)) {
925 setup_linklocal_scope_id((struct sockaddr *)&sock_out);
929 if (pss->ss_family == AF_INET) {
930 struct sockaddr_in *psa = (struct sockaddr_in *)&sock_out;
931 psa->sin_port = htons(port);
934 /* set it non-blocking */
935 set_blocking(res,false);
937 print_sockaddr(addr, sizeof(addr), &sock_out);
938 DEBUG(3,("Connecting to %s at port %u\n",
940 (unsigned int)port));
942 /* and connect it to the destination */
945 ret = sys_connect(res, (struct sockaddr *)&sock_out);
947 /* Some systems return EAGAIN when they mean EINPROGRESS */
948 if (ret < 0 && (errno == EINPROGRESS || errno == EALREADY ||
949 errno == EAGAIN) && (connect_loop < timeout) ) {
950 smb_msleep(connect_loop);
951 timeout -= connect_loop;
952 connect_loop += increment;
953 if (increment < 250) {
954 /* After 8 rounds we end up at a max of 255 msec */
960 if (ret < 0 && (errno == EINPROGRESS || errno == EALREADY ||
962 DEBUG(1,("timeout connecting to %s:%u\n",
964 (unsigned int)port));
970 if (ret < 0 && errno == EISCONN) {
977 DEBUG(2,("error connecting to %s:%d (%s)\n",
985 /* set it blocking again */
986 set_blocking(res,true);
991 /*******************************************************************
992 Create an outgoing TCP socket to the first addr that connects.
994 This is for simultaneous connection attempts to port 445 and 139 of a host
995 or for simultatneous connection attempts to multiple DCs at once. We return
996 a socket fd of the first successful connection.
998 @param[in] addrs list of Internet addresses and ports to connect to
999 @param[in] num_addrs number of address/port pairs in the addrs list
1000 @param[in] timeout time after which we stop waiting for a socket connection
1001 to succeed, given in milliseconds
1002 @param[out] fd_index the entry in addrs which we successfully connected to
1003 @param[out] fd fd of the open and connected socket
1004 @return true on a successful connection, false if all connection attempts
1005 failed or we timed out
1006 *******************************************************************/
1008 bool open_any_socket_out(struct sockaddr_storage *addrs, int num_addrs,
1009 int timeout, int *fd_index, int *fd)
1011 int i, resulting_index, res;
1015 fd_set r_fds, wr_fds;
1019 int connect_loop = 10000; /* 10 milliseconds */
1021 timeout *= 1000; /* convert to microseconds */
1023 sockets = SMB_MALLOC_ARRAY(int, num_addrs);
1025 if (sockets == NULL)
1028 resulting_index = -1;
1030 for (i=0; i<num_addrs; i++)
1033 for (i=0; i<num_addrs; i++) {
1034 sockets[i] = socket(addrs[i].ss_family, SOCK_STREAM, 0);
1037 set_blocking(sockets[i], false);
1041 good_connect = false;
1043 for (i=0; i<num_addrs; i++) {
1044 const struct sockaddr * a =
1045 (const struct sockaddr *)&(addrs[i]);
1047 if (sockets[i] == -1)
1050 if (sys_connect(sockets[i], a) == 0) {
1051 /* Rather unlikely as we are non-blocking, but it
1052 * might actually happen. */
1053 resulting_index = i;
1057 if (errno == EINPROGRESS || errno == EALREADY ||
1061 errno == EAGAIN || errno == EINTR) {
1062 /* These are the error messages that something is
1064 good_connect = true;
1065 } else if (errno != 0) {
1066 /* There was a direct error */
1072 if (!good_connect) {
1073 /* All of the connect's resulted in real error conditions */
1077 /* Lets see if any of the connect attempts succeeded */
1083 for (i=0; i<num_addrs; i++) {
1084 if (sockets[i] == -1)
1086 FD_SET(sockets[i], &wr_fds);
1087 FD_SET(sockets[i], &r_fds);
1088 if (sockets[i]>maxfd)
1093 tv.tv_usec = connect_loop;
1095 res = sys_select_intr(maxfd+1, &r_fds, &wr_fds, NULL, &tv);
1103 for (i=0; i<num_addrs; i++) {
1105 if (sockets[i] == -1)
1108 /* Stevens, Network Programming says that if there's a
1109 * successful connect, the socket is only writable. Upon an
1110 * error, it's both readable and writable. */
1112 if (FD_ISSET(sockets[i], &r_fds) &&
1113 FD_ISSET(sockets[i], &wr_fds)) {
1114 /* readable and writable, so it's an error */
1120 if (!FD_ISSET(sockets[i], &r_fds) &&
1121 FD_ISSET(sockets[i], &wr_fds)) {
1122 /* Only writable, so it's connected */
1123 resulting_index = i;
1130 timeout -= connect_loop;
1133 connect_loop *= 1.5;
1134 if (connect_loop > timeout)
1135 connect_loop = timeout;
1139 for (i=0; i<num_addrs; i++) {
1140 if (i == resulting_index)
1142 if (sockets[i] >= 0)
1146 if (resulting_index >= 0) {
1147 *fd_index = resulting_index;
1148 *fd = sockets[*fd_index];
1149 set_blocking(*fd, true);
1154 return (resulting_index >= 0);
1156 /****************************************************************************
1157 Open a connected UDP socket to host on port
1158 **************************************************************************/
1160 int open_udp_socket(const char *host, int port)
1162 int type = SOCK_DGRAM;
1163 struct sockaddr_in sock_out;
1165 struct in_addr addr;
1167 addr = interpret_addr2(host);
1169 res = socket(PF_INET, type, 0);
1174 memset((char *)&sock_out,'\0',sizeof(sock_out));
1175 putip((char *)&sock_out.sin_addr,(char *)&addr);
1176 sock_out.sin_port = htons(port);
1177 sock_out.sin_family = PF_INET;
1179 if (sys_connect(res,(struct sockaddr *)&sock_out)) {
1187 /*******************************************************************
1188 Return the IP addr of the remote end of a socket as a string.
1189 Optionally return the struct sockaddr_storage.
1190 ******************************************************************/
1192 static const char *get_peer_addr_internal(int fd,
1194 size_t addr_buf_len,
1195 struct sockaddr *pss,
1198 struct sockaddr_storage ss;
1199 socklen_t length = sizeof(ss);
1201 strlcpy(addr_buf,"0.0.0.0",addr_buf_len);
1208 pss = (struct sockaddr *)&ss;
1212 if (getpeername(fd, (struct sockaddr *)pss, plength) < 0) {
1213 DEBUG(0,("getpeername failed. Error was %s\n",
1218 print_sockaddr_len(addr_buf,
1225 /*******************************************************************
1226 Matchname - determine if host name matches IP address. Used to
1227 confirm a hostname lookup to prevent spoof attacks.
1228 ******************************************************************/
1230 static bool matchname(const char *remotehost,
1231 const struct sockaddr *pss,
1234 struct addrinfo *res = NULL;
1235 struct addrinfo *ailist = NULL;
1236 char addr_buf[INET6_ADDRSTRLEN];
1237 bool ret = interpret_string_addr_internal(&ailist,
1239 AI_ADDRCONFIG|AI_CANONNAME);
1241 if (!ret || ailist == NULL) {
1242 DEBUG(3,("matchname: getaddrinfo failed for "
1245 gai_strerror(ret) ));
1250 * Make sure that getaddrinfo() returns the "correct" host name.
1253 if (ailist->ai_canonname == NULL ||
1254 (!strequal(remotehost, ailist->ai_canonname) &&
1255 !strequal(remotehost, "localhost"))) {
1256 DEBUG(0,("matchname: host name/name mismatch: %s != %s\n",
1258 ailist->ai_canonname ?
1259 ailist->ai_canonname : "(NULL)"));
1260 freeaddrinfo(ailist);
1264 /* Look up the host address in the address list we just got. */
1265 for (res = ailist; res; res = res->ai_next) {
1266 if (!res->ai_addr) {
1269 if (addr_equal((const struct sockaddr *)res->ai_addr,
1270 (struct sockaddr *)pss)) {
1271 freeaddrinfo(ailist);
1277 * The host name does not map to the original host address. Perhaps
1278 * someone has compromised a name server. More likely someone botched
1279 * it, but that could be dangerous, too.
1282 DEBUG(0,("matchname: host name/address mismatch: %s != %s\n",
1283 print_sockaddr_len(addr_buf,
1287 ailist->ai_canonname ? ailist->ai_canonname : "(NULL)"));
1290 freeaddrinfo(ailist);
1295 /*******************************************************************
1296 Deal with the singleton cache.
1297 ******************************************************************/
1299 struct name_addr_pair {
1300 struct sockaddr_storage ss;
1304 /*******************************************************************
1305 Lookup a name/addr pair. Returns memory allocated from memcache.
1306 ******************************************************************/
1308 static bool lookup_nc(struct name_addr_pair *nc)
1314 if (!memcache_lookup(
1315 NULL, SINGLETON_CACHE,
1316 data_blob_string_const_null("get_peer_name"),
1321 memcpy(&nc->ss, tmp.data, sizeof(nc->ss));
1322 nc->name = (const char *)tmp.data + sizeof(nc->ss);
1326 /*******************************************************************
1327 Save a name/addr pair.
1328 ******************************************************************/
1330 static void store_nc(const struct name_addr_pair *nc)
1333 size_t namelen = strlen(nc->name);
1335 tmp = data_blob(NULL, sizeof(nc->ss) + namelen + 1);
1339 memcpy(tmp.data, &nc->ss, sizeof(nc->ss));
1340 memcpy(tmp.data+sizeof(nc->ss), nc->name, namelen+1);
1342 memcache_add(NULL, SINGLETON_CACHE,
1343 data_blob_string_const_null("get_peer_name"),
1345 data_blob_free(&tmp);
1348 /*******************************************************************
1349 Return the DNS name of the remote end of a socket.
1350 ******************************************************************/
1352 const char *get_peer_name(int fd, bool force_lookup)
1354 struct name_addr_pair nc;
1355 char addr_buf[INET6_ADDRSTRLEN];
1356 struct sockaddr_storage ss;
1357 socklen_t length = sizeof(ss);
1360 char name_buf[MAX_DNS_NAME_LENGTH];
1361 char tmp_name[MAX_DNS_NAME_LENGTH];
1363 /* reverse lookups can be *very* expensive, and in many
1364 situations won't work because many networks don't link dhcp
1365 with dns. To avoid the delay we avoid the lookup if
1367 if (!lp_hostname_lookups() && (force_lookup == false)) {
1368 length = sizeof(nc.ss);
1369 nc.name = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf),
1370 (struct sockaddr *)&nc.ss, &length);
1373 return nc.name ? nc.name : "UNKNOWN";
1378 memset(&ss, '\0', sizeof(ss));
1379 p = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf), (struct sockaddr *)&ss, &length);
1381 /* it might be the same as the last one - save some DNS work */
1382 if (addr_equal((struct sockaddr *)&ss, (struct sockaddr *)&nc.ss)) {
1383 return nc.name ? nc.name : "UNKNOWN";
1386 /* Not the same. We need to lookup. */
1391 /* Look up the remote host name. */
1392 ret = sys_getnameinfo((struct sockaddr *)&ss,
1401 DEBUG(1,("get_peer_name: getnameinfo failed "
1402 "for %s with error %s\n",
1404 gai_strerror(ret)));
1405 strlcpy(name_buf, p, sizeof(name_buf));
1407 if (!matchname(name_buf, (struct sockaddr *)&ss, length)) {
1408 DEBUG(0,("Matchname failed on %s %s\n",name_buf,p));
1409 strlcpy(name_buf,"UNKNOWN",sizeof(name_buf));
1413 /* can't pass the same source and dest strings in when you
1414 use --enable-developer or the clobber_region() call will
1417 strlcpy(tmp_name, name_buf, sizeof(tmp_name));
1418 alpha_strcpy(name_buf, tmp_name, "_-.", sizeof(name_buf));
1419 if (strstr(name_buf,"..")) {
1420 strlcpy(name_buf, "UNKNOWN", sizeof(name_buf));
1428 return nc.name ? nc.name : "UNKNOWN";
1431 /*******************************************************************
1432 Return the IP addr of the remote end of a socket as a string.
1433 ******************************************************************/
1435 const char *get_peer_addr(int fd, char *addr, size_t addr_len)
1437 return get_peer_addr_internal(fd, addr, addr_len, NULL, NULL);
1440 /*******************************************************************
1441 Create protected unix domain socket.
1443 Some unixes cannot set permissions on a ux-dom-sock, so we
1444 have to make sure that the directory contains the protection
1445 permissions instead.
1446 ******************************************************************/
1448 int create_pipe_sock(const char *socket_dir,
1449 const char *socket_name,
1452 #ifdef HAVE_UNIXSOCKET
1453 struct sockaddr_un sunaddr;
1459 old_umask = umask(0);
1461 /* Create the socket directory or reuse the existing one */
1463 if (lstat(socket_dir, &st) == -1) {
1464 if (errno == ENOENT) {
1465 /* Create directory */
1466 if (mkdir(socket_dir, dir_perms) == -1) {
1467 DEBUG(0, ("error creating socket directory "
1468 "%s: %s\n", socket_dir,
1473 DEBUG(0, ("lstat failed on socket directory %s: %s\n",
1474 socket_dir, strerror(errno)));
1478 /* Check ownership and permission on existing directory */
1479 if (!S_ISDIR(st.st_mode)) {
1480 DEBUG(0, ("socket directory %s isn't a directory\n",
1484 if ((st.st_uid != sec_initial_uid()) ||
1485 ((st.st_mode & 0777) != dir_perms)) {
1486 DEBUG(0, ("invalid permissions on socket directory "
1487 "%s\n", socket_dir));
1492 /* Create the socket file */
1494 sock = socket(AF_UNIX, SOCK_STREAM, 0);
1497 DEBUG(0, ("create_pipe_sock: socket error %s\n",
1502 if (asprintf(&path, "%s/%s", socket_dir, socket_name) == -1) {
1507 memset(&sunaddr, 0, sizeof(sunaddr));
1508 sunaddr.sun_family = AF_UNIX;
1509 strlcpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path));
1511 if (bind(sock, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1) {
1512 DEBUG(0, ("bind failed on pipe socket %s: %s\n", path,
1517 if (listen(sock, 5) == -1) {
1518 DEBUG(0, ("listen failed on pipe socket %s: %s\n", path,
1538 DEBUG(0, ("create_pipe_sock: No Unix sockets on this system\n"));
1540 #endif /* HAVE_UNIXSOCKET */
1543 /****************************************************************************
1544 Get my own canonical name, including domain.
1545 ****************************************************************************/
1547 const char *get_mydnsfullname(void)
1549 struct addrinfo *res = NULL;
1550 char my_hostname[HOST_NAME_MAX];
1554 if (memcache_lookup(NULL, SINGLETON_CACHE,
1555 data_blob_string_const_null("get_mydnsfullname"),
1557 SMB_ASSERT(tmp.length > 0);
1558 return (const char *)tmp.data;
1561 /* get my host name */
1562 if (gethostname(my_hostname, sizeof(my_hostname)) == -1) {
1563 DEBUG(0,("get_mydnsfullname: gethostname failed\n"));
1567 /* Ensure null termination. */
1568 my_hostname[sizeof(my_hostname)-1] = '\0';
1570 ret = interpret_string_addr_internal(&res,
1572 AI_ADDRCONFIG|AI_CANONNAME);
1574 if (!ret || res == NULL) {
1575 DEBUG(3,("get_mydnsfullname: getaddrinfo failed for "
1578 gai_strerror(ret) ));
1583 * Make sure that getaddrinfo() returns the "correct" host name.
1586 if (res->ai_canonname == NULL) {
1587 DEBUG(3,("get_mydnsfullname: failed to get "
1588 "canonical name for %s\n",
1594 /* This copies the data, so we must do a lookup
1595 * afterwards to find the value to return.
1598 memcache_add(NULL, SINGLETON_CACHE,
1599 data_blob_string_const_null("get_mydnsfullname"),
1600 data_blob_string_const_null(res->ai_canonname));
1602 if (!memcache_lookup(NULL, SINGLETON_CACHE,
1603 data_blob_string_const_null("get_mydnsfullname"),
1605 tmp = data_blob_talloc(talloc_tos(), res->ai_canonname,
1606 strlen(res->ai_canonname) + 1);
1611 return (const char *)tmp.data;
1614 /************************************************************
1616 ************************************************************/
1618 bool is_myname_or_ipaddr(const char *s)
1620 TALLOC_CTX *ctx = talloc_tos();
1622 const char *dnsname;
1623 char *servername = NULL;
1629 /* Santize the string from '\\name' */
1630 name = talloc_strdup(ctx, s);
1635 servername = strrchr_m(name, '\\' );
1642 /* Optimize for the common case */
1643 if (strequal(servername, global_myname())) {
1647 /* Check for an alias */
1648 if (is_myname(servername)) {
1652 /* Check for loopback */
1653 if (strequal(servername, "127.0.0.1") ||
1654 strequal(servername, "::1")) {
1658 if (strequal(servername, "localhost")) {
1662 /* Maybe it's my dns name */
1663 dnsname = get_mydnsfullname();
1664 if (dnsname && strequal(servername, dnsname)) {
1668 /* Handle possible CNAME records - convert to an IP addr. */
1669 if (!is_ipaddress(servername)) {
1670 /* Use DNS to resolve the name, but only the first address */
1671 struct sockaddr_storage ss;
1672 if (interpret_string_addr(&ss, servername,0)) {
1673 print_sockaddr(name,
1680 /* Maybe its an IP address? */
1681 if (is_ipaddress(servername)) {
1682 struct sockaddr_storage ss;
1683 struct iface_struct *nics;
1686 if (!interpret_string_addr(&ss, servername, AI_NUMERICHOST)) {
1690 if (is_zero_addr((struct sockaddr *)&ss) ||
1691 is_loopback_addr((struct sockaddr *)&ss)) {
1695 nics = TALLOC_ARRAY(ctx, struct iface_struct,
1700 n = get_interfaces(nics, MAX_INTERFACES);
1701 for (i=0; i<n; i++) {
1702 if (addr_equal((struct sockaddr *)&nics[i].ip, (struct sockaddr *)&ss)) {