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_sockaddr(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 const char *client_name(int fd)
246 return get_peer_name(fd,false);
249 const char *client_addr(int fd, char *addr, size_t addrlen)
251 return get_peer_addr(fd,addr,addrlen);
254 const char *client_socket_addr(int fd, char *addr, size_t addr_len)
256 return get_socket_addr(fd, addr, addr_len);
260 /* Not currently used. JRA. */
261 int client_socket_port(int fd)
263 return get_socket_port(fd);
267 /****************************************************************************
268 Accessor functions to make thread-safe code easier later...
269 ****************************************************************************/
271 void set_smb_read_error(enum smb_read_errors *pre,
272 enum smb_read_errors newerr)
279 void cond_set_smb_read_error(enum smb_read_errors *pre,
280 enum smb_read_errors newerr)
282 if (pre && *pre == SMB_READ_OK) {
287 /****************************************************************************
288 Determine if a file descriptor is in fact a socket.
289 ****************************************************************************/
291 bool is_a_socket(int fd)
296 return(getsockopt(fd, SOL_SOCKET, SO_TYPE, (char *)&v, &l) == 0);
299 enum SOCK_OPT_TYPES {OPT_BOOL,OPT_INT,OPT_ON};
301 typedef struct smb_socket_option {
309 static const smb_socket_option socket_options[] = {
310 {"SO_KEEPALIVE", SOL_SOCKET, SO_KEEPALIVE, 0, OPT_BOOL},
311 {"SO_REUSEADDR", SOL_SOCKET, SO_REUSEADDR, 0, OPT_BOOL},
312 {"SO_BROADCAST", SOL_SOCKET, SO_BROADCAST, 0, OPT_BOOL},
314 {"TCP_NODELAY", IPPROTO_TCP, TCP_NODELAY, 0, OPT_BOOL},
317 {"TCP_KEEPCNT", IPPROTO_TCP, TCP_KEEPCNT, 0, OPT_INT},
320 {"TCP_KEEPIDLE", IPPROTO_TCP, TCP_KEEPIDLE, 0, OPT_INT},
323 {"TCP_KEEPINTVL", IPPROTO_TCP, TCP_KEEPINTVL, 0, OPT_INT},
325 #ifdef IPTOS_LOWDELAY
326 {"IPTOS_LOWDELAY", IPPROTO_IP, IP_TOS, IPTOS_LOWDELAY, OPT_ON},
328 #ifdef IPTOS_THROUGHPUT
329 {"IPTOS_THROUGHPUT", IPPROTO_IP, IP_TOS, IPTOS_THROUGHPUT, OPT_ON},
332 {"SO_REUSEPORT", SOL_SOCKET, SO_REUSEPORT, 0, OPT_BOOL},
335 {"SO_SNDBUF", SOL_SOCKET, SO_SNDBUF, 0, OPT_INT},
338 {"SO_RCVBUF", SOL_SOCKET, SO_RCVBUF, 0, OPT_INT},
341 {"SO_SNDLOWAT", SOL_SOCKET, SO_SNDLOWAT, 0, OPT_INT},
344 {"SO_RCVLOWAT", SOL_SOCKET, SO_RCVLOWAT, 0, OPT_INT},
347 {"SO_SNDTIMEO", SOL_SOCKET, SO_SNDTIMEO, 0, OPT_INT},
350 {"SO_RCVTIMEO", SOL_SOCKET, SO_RCVTIMEO, 0, OPT_INT},
353 {"TCP_FASTACK", IPPROTO_TCP, TCP_FASTACK, 0, OPT_INT},
357 /****************************************************************************
358 Print socket options.
359 ****************************************************************************/
361 static void print_socket_options(int s)
365 const smb_socket_option *p = &socket_options[0];
367 /* wrapped in if statement to prevent streams
368 * leak in SCO Openserver 5.0 */
369 /* reported on samba-technical --jerry */
370 if ( DEBUGLEVEL >= 5 ) {
371 DEBUG(5,("Socket options:\n"));
372 for (; p->name != NULL; p++) {
373 if (getsockopt(s, p->level, p->option,
374 (void *)&value, &vlen) == -1) {
375 DEBUGADD(5,("\tCould not test socket option %s.\n",
378 DEBUGADD(5,("\t%s = %d\n",
385 /****************************************************************************
386 Set user socket options.
387 ****************************************************************************/
389 void set_socket_options(int fd, const char *options)
391 TALLOC_CTX *ctx = talloc_stackframe();
394 while (next_token_talloc(ctx, &options, &tok," \t,")) {
398 bool got_value = false;
400 if ((p = strchr_m(tok,'='))) {
406 for (i=0;socket_options[i].name;i++)
407 if (strequal(socket_options[i].name,tok))
410 if (!socket_options[i].name) {
411 DEBUG(0,("Unknown socket option %s\n",tok));
415 switch (socket_options[i].opttype) {
418 ret = setsockopt(fd,socket_options[i].level,
419 socket_options[i].option,
420 (char *)&value,sizeof(int));
425 DEBUG(0,("syntax error - %s "
426 "does not take a value\n",tok));
429 int on = socket_options[i].value;
430 ret = setsockopt(fd,socket_options[i].level,
431 socket_options[i].option,
432 (char *)&on,sizeof(int));
438 /* be aware that some systems like Solaris return
439 * EINVAL to a setsockopt() call when the client
440 * sent a RST previously - no need to worry */
441 DEBUG(2,("Failed to set socket option %s (Error %s)\n",
442 tok, strerror(errno) ));
447 print_socket_options(fd);
450 /****************************************************************************
452 ****************************************************************************/
454 ssize_t read_udp_v4_socket(int fd,
457 struct sockaddr_storage *psa)
460 socklen_t socklen = sizeof(*psa);
461 struct sockaddr_in *si = (struct sockaddr_in *)psa;
463 memset((char *)psa,'\0',socklen);
465 ret = (ssize_t)sys_recvfrom(fd,buf,len,0,
466 (struct sockaddr *)psa,&socklen);
468 /* Don't print a low debug error for a non-blocking socket. */
469 if (errno == EAGAIN) {
470 DEBUG(10,("read_udp_v4_socket: returned EAGAIN\n"));
472 DEBUG(2,("read_udp_v4_socket: failed. errno=%s\n",
478 if (psa->ss_family != AF_INET) {
479 DEBUG(2,("read_udp_v4_socket: invalid address family %d "
480 "(not IPv4)\n", (int)psa->ss_family));
484 DEBUG(10,("read_udp_v4_socket: ip %s port %d read: %lu\n",
485 inet_ntoa(si->sin_addr),
487 (unsigned long)ret));
492 /****************************************************************************
493 Read data from a socket with a timout in msec.
494 mincount = if timeout, minimum to read before returning
495 maxcount = number to be read.
496 time_out = timeout in milliseconds
497 ****************************************************************************/
499 NTSTATUS read_socket_with_timeout(int fd, char *buf,
500 size_t mincnt, size_t maxcnt,
501 unsigned int time_out,
508 struct timeval timeout;
509 char addr[INET6_ADDRSTRLEN];
511 /* just checking .... */
521 while (nread < mincnt) {
522 readret = sys_read(fd, buf + nread, maxcnt - nread);
525 DEBUG(5,("read_socket_with_timeout: "
526 "blocking read. EOF from client.\n"));
527 return NT_STATUS_END_OF_FILE;
531 if (fd == get_client_fd()) {
532 /* Try and give an error message
533 * saying what client failed. */
534 DEBUG(0,("read_socket_with_timeout: "
535 "client %s read error = %s.\n",
536 get_peer_addr(fd,addr,sizeof(addr)),
539 DEBUG(0,("read_socket_with_timeout: "
540 "read error = %s.\n",
543 return map_nt_error_from_unix(errno);
550 /* Most difficult - timeout read */
551 /* If this is ever called on a disk file and
552 mincnt is greater then the filesize then
553 system performance will suffer severely as
554 select always returns true on disk files */
556 /* Set initial timeout */
557 timeout.tv_sec = (time_t)(time_out / 1000);
558 timeout.tv_usec = (long)(1000 * (time_out % 1000));
560 for (nread=0; nread < mincnt; ) {
564 selrtn = sys_select_intr(fd+1,&fds,NULL,NULL,&timeout);
568 /* something is wrong. Maybe the socket is dead? */
569 if (fd == get_client_fd()) {
570 /* Try and give an error message saying
571 * what client failed. */
572 DEBUG(0,("read_socket_with_timeout: timeout "
573 "read for client %s. select error = %s.\n",
574 get_peer_addr(fd,addr,sizeof(addr)),
577 DEBUG(0,("read_socket_with_timeout: timeout "
578 "read. select error = %s.\n",
581 return map_nt_error_from_unix(errno);
584 /* Did we timeout ? */
586 DEBUG(10,("read_socket_with_timeout: timeout read. "
587 "select timed out.\n"));
588 return NT_STATUS_IO_TIMEOUT;
591 readret = sys_read(fd, buf+nread, maxcnt-nread);
594 /* we got EOF on the file descriptor */
595 DEBUG(5,("read_socket_with_timeout: timeout read. "
596 "EOF from client.\n"));
597 return NT_STATUS_END_OF_FILE;
601 /* the descriptor is probably dead */
602 if (fd == get_client_fd()) {
603 /* Try and give an error message
604 * saying what client failed. */
605 DEBUG(0,("read_socket_with_timeout: timeout "
606 "read to client %s. read error = %s.\n",
607 get_peer_addr(fd,addr,sizeof(addr)),
610 DEBUG(0,("read_socket_with_timeout: timeout "
611 "read. read error = %s.\n",
614 return map_nt_error_from_unix(errno);
621 /* Return the number we got */
628 /****************************************************************************
629 Read data from the client, reading exactly N bytes.
630 ****************************************************************************/
632 NTSTATUS read_data(int fd, char *buffer, size_t N)
634 return read_socket_with_timeout(fd, buffer, N, N, 0, NULL);
637 /****************************************************************************
638 Write all data from an iov array
639 ****************************************************************************/
641 ssize_t write_data_iov(int fd, const struct iovec *orig_iov, int iovcnt)
647 struct iovec *iov_copy, *iov;
650 for (i=0; i<iovcnt; i++) {
651 to_send += orig_iov[i].iov_len;
654 thistime = sys_writev(fd, orig_iov, iovcnt);
655 if ((thistime <= 0) || (thistime == to_send)) {
661 * We could not send everything in one call. Make a copy of iov that
662 * we can mess with. We keep a copy of the array start in iov_copy for
663 * the TALLOC_FREE, because we're going to modify iov later on,
664 * discarding elements.
667 iov_copy = (struct iovec *)TALLOC_MEMDUP(
668 talloc_tos(), orig_iov, sizeof(struct iovec) * iovcnt);
670 if (iov_copy == NULL) {
676 while (sent < to_send) {
678 * We have to discard "thistime" bytes from the beginning
679 * iov array, "thistime" contains the number of bytes sent
682 while (thistime > 0) {
683 if (thistime < iov[0].iov_len) {
685 (char *)iov[0].iov_base + thistime;
686 iov[0].iov_base = new_base;
687 iov[0].iov_len -= thistime;
690 thistime -= iov[0].iov_len;
695 thistime = sys_writev(fd, iov, iovcnt);
702 TALLOC_FREE(iov_copy);
706 /****************************************************************************
708 ****************************************************************************/
710 ssize_t write_data(int fd, const char *buffer, size_t N)
715 iov.iov_base = CONST_DISCARD(char *, buffer);
718 ret = write_data_iov(fd, &iov, 1);
723 if (fd == get_client_fd()) {
724 char addr[INET6_ADDRSTRLEN];
726 * Try and give an error message saying what client failed.
728 DEBUG(0, ("write_data: write failure in writing to client %s. "
729 "Error %s\n", get_peer_addr(fd,addr,sizeof(addr)),
732 DEBUG(0,("write_data: write failure. Error = %s\n",
739 /****************************************************************************
740 Send a keepalive packet (rfc1002).
741 ****************************************************************************/
743 bool send_keepalive(int client)
745 unsigned char buf[4];
747 buf[0] = SMBkeepalive;
748 buf[1] = buf[2] = buf[3] = 0;
750 return(write_data(client,(char *)buf,4) == 4);
753 /****************************************************************************
754 Read 4 bytes of a smb packet and return the smb length of the packet.
755 Store the result in the buffer.
756 This version of the function will return a length of zero on receiving
758 Timeout is in milliseconds.
759 ****************************************************************************/
761 NTSTATUS read_smb_length_return_keepalive(int fd, char *inbuf,
762 unsigned int timeout,
768 status = read_socket_with_timeout(fd, inbuf, 4, 4, timeout, NULL);
770 if (!NT_STATUS_IS_OK(status)) {
774 *len = smb_len(inbuf);
775 msg_type = CVAL(inbuf,0);
777 if (msg_type == SMBkeepalive) {
778 DEBUG(5,("Got keepalive packet\n"));
781 DEBUG(10,("got smb length of %lu\n",(unsigned long)(*len)));
786 /****************************************************************************
787 Read 4 bytes of a smb packet and return the smb length of the packet.
788 Store the result in the buffer. This version of the function will
789 never return a session keepalive (length of zero).
790 Timeout is in milliseconds.
791 ****************************************************************************/
793 NTSTATUS read_smb_length(int fd, char *inbuf, unsigned int timeout,
796 uint8_t msgtype = SMBkeepalive;
798 while (msgtype == SMBkeepalive) {
801 status = read_smb_length_return_keepalive(fd, inbuf, timeout,
803 if (!NT_STATUS_IS_OK(status)) {
807 msgtype = CVAL(inbuf, 0);
810 DEBUG(10,("read_smb_length: got smb length of %lu\n",
811 (unsigned long)len));
816 /****************************************************************************
817 Read an smb from a fd.
818 The timeout is in milliseconds.
819 This function will return on receipt of a session keepalive packet.
820 maxlen is the max number of bytes to return, not including the 4 byte
821 length. If zero it means buflen limit.
822 Doesn't check the MAC on signed packets.
823 ****************************************************************************/
825 NTSTATUS receive_smb_raw(int fd, char *buffer, size_t buflen, unsigned int timeout,
826 size_t maxlen, size_t *p_len)
831 status = read_smb_length_return_keepalive(fd,buffer,timeout,&len);
833 if (!NT_STATUS_IS_OK(status)) {
834 DEBUG(10, ("receive_smb_raw: %s!\n", nt_errstr(status)));
839 DEBUG(0,("Invalid packet length! (%lu bytes).\n",
840 (unsigned long)len));
841 return NT_STATUS_INVALID_PARAMETER;
846 len = MIN(len,maxlen);
849 status = read_socket_with_timeout(
850 fd, buffer+4, len, len, timeout, &len);
852 if (!NT_STATUS_IS_OK(status)) {
856 /* not all of samba3 properly checks for packet-termination
857 * of strings. This ensures that we don't run off into
859 SSVAL(buffer+4,len, 0);
866 /****************************************************************************
867 Open a socket of the specified type, port, and address for incoming data.
868 ****************************************************************************/
870 int open_socket_in(int type,
873 const struct sockaddr_storage *psock,
876 struct sockaddr_storage sock;
878 socklen_t slen = sizeof(struct sockaddr_in);
882 #if defined(HAVE_IPV6)
883 if (sock.ss_family == AF_INET6) {
884 ((struct sockaddr_in6 *)&sock)->sin6_port = htons(port);
885 slen = sizeof(struct sockaddr_in6);
888 if (sock.ss_family == AF_INET) {
889 ((struct sockaddr_in *)&sock)->sin_port = htons(port);
892 res = socket(sock.ss_family, type, 0 );
895 dbgtext( "open_socket_in(): socket() call failed: " );
896 dbgtext( "%s\n", strerror( errno ) );
901 /* This block sets/clears the SO_REUSEADDR and possibly SO_REUSEPORT. */
903 int val = rebind ? 1 : 0;
904 if( setsockopt(res,SOL_SOCKET,SO_REUSEADDR,
905 (char *)&val,sizeof(val)) == -1 ) {
906 if( DEBUGLVL( dlevel ) ) {
907 dbgtext( "open_socket_in(): setsockopt: " );
908 dbgtext( "SO_REUSEADDR = %s ",
909 val?"true":"false" );
910 dbgtext( "on port %d failed ", port );
911 dbgtext( "with error = %s\n", strerror(errno) );
915 if( setsockopt(res,SOL_SOCKET,SO_REUSEPORT,
916 (char *)&val,sizeof(val)) == -1 ) {
917 if( DEBUGLVL( dlevel ) ) {
918 dbgtext( "open_socket_in(): setsockopt: ");
919 dbgtext( "SO_REUSEPORT = %s ",
921 dbgtext( "on port %d failed ", port);
922 dbgtext( "with error = %s\n", strerror(errno));
925 #endif /* SO_REUSEPORT */
928 /* now we've got a socket - we need to bind it */
929 if (bind(res, (struct sockaddr *)&sock, slen) == -1 ) {
930 if( DEBUGLVL(dlevel) && (port == SMB_PORT1 ||
931 port == SMB_PORT2 || port == NMB_PORT) ) {
932 char addr[INET6_ADDRSTRLEN];
933 print_sockaddr(addr, sizeof(addr),
935 dbgtext( "bind failed on port %d ", port);
936 dbgtext( "socket_addr = %s.\n", addr);
937 dbgtext( "Error = %s\n", strerror(errno));
943 DEBUG( 10, ( "bind succeeded on port %d\n", port ) );
947 struct open_socket_out_state {
949 struct event_context *ev;
950 struct sockaddr_storage ss;
956 static void open_socket_out_connected(struct async_req *subreq);
958 static int open_socket_out_state_destructor(struct open_socket_out_state *s)
966 /****************************************************************************
967 Create an outgoing socket. timeout is in milliseconds.
968 **************************************************************************/
970 struct async_req *open_socket_out_send(TALLOC_CTX *mem_ctx,
971 struct event_context *ev,
972 const struct sockaddr_storage *pss,
976 char addr[INET6_ADDRSTRLEN];
977 struct async_req *result, *subreq;
978 struct open_socket_out_state *state;
981 if (!async_req_setup(mem_ctx, &result, &state,
982 struct open_socket_out_state)) {
988 state->wait_nsec = 10000;
991 state->fd = socket(state->ss.ss_family, SOCK_STREAM, 0);
992 if (state->fd == -1) {
993 status = map_nt_error_from_unix(errno);
996 talloc_set_destructor(state, open_socket_out_state_destructor);
998 if (!async_req_set_timeout(result, ev, timeval_set(0, timeout*1000))) {
1002 #if defined(HAVE_IPV6)
1003 if (pss->ss_family == AF_INET6) {
1004 struct sockaddr_in6 *psa6;
1005 psa6 = (struct sockaddr_in6 *)&state->ss;
1006 psa6->sin6_port = htons(port);
1007 if (psa6->sin6_scope_id == 0
1008 && IN6_IS_ADDR_LINKLOCAL(&psa6->sin6_addr)) {
1009 setup_linklocal_scope_id(
1010 (struct sockaddr *)&(state->ss));
1012 state->salen = sizeof(struct sockaddr_in6);
1015 if (pss->ss_family == AF_INET) {
1016 struct sockaddr_in *psa;
1017 psa = (struct sockaddr_in *)&state->ss;
1018 psa->sin_port = htons(port);
1019 state->salen = sizeof(struct sockaddr_in);
1022 print_sockaddr(addr, sizeof(addr), &state->ss);
1023 DEBUG(3,("Connecting to %s at port %u\n", addr, (unsigned int)port));
1025 subreq = async_connect_send(state, state->ev, state->fd,
1026 (struct sockaddr *)&state->ss,
1028 if ((subreq == NULL)
1029 || !async_req_set_timeout(subreq, state->ev,
1030 timeval_set(0, state->wait_nsec))) {
1031 status = NT_STATUS_NO_MEMORY;
1034 subreq->async.fn = open_socket_out_connected;
1035 subreq->async.priv = result;
1039 if (!async_post_ntstatus(result, ev, status)) {
1044 TALLOC_FREE(result);
1048 static void open_socket_out_connected(struct async_req *subreq)
1050 struct async_req *req = talloc_get_type_abort(
1051 subreq->async.priv, struct async_req);
1052 struct open_socket_out_state *state = talloc_get_type_abort(
1053 req->private_data, struct open_socket_out_state);
1057 err = async_connect_recv(subreq, &sys_errno);
1058 TALLOC_FREE(subreq);
1060 async_req_done(req);
1066 (sys_errno == ETIMEDOUT) ||
1068 (sys_errno == EINPROGRESS) ||
1069 (sys_errno == EALREADY) ||
1070 (sys_errno == EAGAIN)) {
1076 if (state->wait_nsec < 250000) {
1077 state->wait_nsec *= 1.5;
1080 subreq = async_connect_send(state, state->ev, state->fd,
1081 (struct sockaddr *)&state->ss,
1083 if (async_req_nomem(subreq, req)) {
1086 if (!async_req_set_timeout(subreq, state->ev,
1087 timeval_set(0, state->wait_nsec))) {
1088 async_req_error(req, ENOMEM);
1091 subreq->async.fn = open_socket_out_connected;
1092 subreq->async.priv = req;
1097 if (sys_errno == EISCONN) {
1098 async_req_done(req);
1104 async_req_error(req, sys_errno);
1107 NTSTATUS open_socket_out_recv(struct async_req *req, int *pfd)
1109 struct open_socket_out_state *state = talloc_get_type_abort(
1110 req->private_data, struct open_socket_out_state);
1113 if (async_req_is_errno(req, &err)) {
1114 return map_nt_error_from_unix(err);
1118 return NT_STATUS_OK;
1121 NTSTATUS open_socket_out(const struct sockaddr_storage *pss, uint16_t port,
1122 int timeout, int *pfd)
1124 TALLOC_CTX *frame = talloc_stackframe();
1125 struct event_context *ev;
1126 struct async_req *req;
1127 NTSTATUS status = NT_STATUS_NO_MEMORY;
1129 ev = event_context_init(frame);
1134 req = open_socket_out_send(frame, ev, pss, port, timeout);
1138 while (req->state < ASYNC_REQ_DONE) {
1139 event_loop_once(ev);
1142 status = open_socket_out_recv(req, pfd);
1148 struct open_socket_out_defer_state {
1149 struct event_context *ev;
1150 struct sockaddr_storage ss;
1156 static void open_socket_out_defer_waited(struct async_req *subreq);
1157 static void open_socket_out_defer_connected(struct async_req *subreq);
1159 struct async_req *open_socket_out_defer_send(TALLOC_CTX *mem_ctx,
1160 struct event_context *ev,
1161 struct timeval wait_time,
1162 const struct sockaddr_storage *pss,
1166 struct async_req *result, *subreq;
1167 struct open_socket_out_defer_state *state;
1170 if (!async_req_setup(mem_ctx, &result, &state,
1171 struct open_socket_out_defer_state)) {
1177 state->timeout = timeout;
1179 subreq = async_wait_send(state, ev, wait_time);
1180 if (subreq == NULL) {
1181 status = NT_STATUS_NO_MEMORY;
1184 subreq->async.fn = open_socket_out_defer_waited;
1185 subreq->async.priv = result;
1189 if (!async_post_ntstatus(result, ev, status)) {
1194 TALLOC_FREE(result);
1198 static void open_socket_out_defer_waited(struct async_req *subreq)
1200 struct async_req *req = talloc_get_type_abort(
1201 subreq->async.priv, struct async_req);
1202 struct open_socket_out_defer_state *state = talloc_get_type_abort(
1203 req->private_data, struct open_socket_out_defer_state);
1206 ret = async_wait_recv(subreq);
1207 TALLOC_FREE(subreq);
1209 async_req_nterror(req, NT_STATUS_INTERNAL_ERROR);
1213 subreq = open_socket_out_send(state, state->ev, &state->ss,
1214 state->port, state->timeout);
1215 if (async_req_nomem(subreq, req)) {
1218 subreq->async.fn = open_socket_out_defer_connected;
1219 subreq->async.priv = req;
1222 static void open_socket_out_defer_connected(struct async_req *subreq)
1224 struct async_req *req = talloc_get_type_abort(
1225 subreq->async.priv, struct async_req);
1226 struct open_socket_out_defer_state *state = talloc_get_type_abort(
1227 req->private_data, struct open_socket_out_defer_state);
1230 status = open_socket_out_recv(subreq, &state->fd);
1231 TALLOC_FREE(subreq);
1232 if (!NT_STATUS_IS_OK(status)) {
1233 async_req_nterror(req, status);
1236 async_req_done(req);
1239 NTSTATUS open_socket_out_defer_recv(struct async_req *req, int *pfd)
1241 struct open_socket_out_defer_state *state = talloc_get_type_abort(
1242 req->private_data, struct open_socket_out_defer_state);
1245 if (async_req_is_nterror(req, &status)) {
1250 return NT_STATUS_OK;
1253 /*******************************************************************
1254 Create an outgoing TCP socket to the first addr that connects.
1256 This is for simultaneous connection attempts to port 445 and 139 of a host
1257 or for simultatneous connection attempts to multiple DCs at once. We return
1258 a socket fd of the first successful connection.
1260 @param[in] addrs list of Internet addresses and ports to connect to
1261 @param[in] num_addrs number of address/port pairs in the addrs list
1262 @param[in] timeout time after which we stop waiting for a socket connection
1263 to succeed, given in milliseconds
1264 @param[out] fd_index the entry in addrs which we successfully connected to
1265 @param[out] fd fd of the open and connected socket
1266 @return true on a successful connection, false if all connection attempts
1267 failed or we timed out
1268 *******************************************************************/
1270 bool open_any_socket_out(struct sockaddr_storage *addrs, int num_addrs,
1271 int timeout, int *fd_index, int *fd)
1273 int i, resulting_index, res;
1277 fd_set r_fds, wr_fds;
1281 int connect_loop = 10000; /* 10 milliseconds */
1283 timeout *= 1000; /* convert to microseconds */
1285 sockets = SMB_MALLOC_ARRAY(int, num_addrs);
1287 if (sockets == NULL)
1290 resulting_index = -1;
1292 for (i=0; i<num_addrs; i++)
1295 for (i=0; i<num_addrs; i++) {
1296 sockets[i] = socket(addrs[i].ss_family, SOCK_STREAM, 0);
1299 set_blocking(sockets[i], false);
1303 good_connect = false;
1305 for (i=0; i<num_addrs; i++) {
1306 const struct sockaddr * a =
1307 (const struct sockaddr *)&(addrs[i]);
1309 if (sockets[i] == -1)
1312 if (sys_connect(sockets[i], a) == 0) {
1313 /* Rather unlikely as we are non-blocking, but it
1314 * might actually happen. */
1315 resulting_index = i;
1319 if (errno == EINPROGRESS || errno == EALREADY ||
1323 errno == EAGAIN || errno == EINTR) {
1324 /* These are the error messages that something is
1326 good_connect = true;
1327 } else if (errno != 0) {
1328 /* There was a direct error */
1334 if (!good_connect) {
1335 /* All of the connect's resulted in real error conditions */
1339 /* Lets see if any of the connect attempts succeeded */
1345 for (i=0; i<num_addrs; i++) {
1346 if (sockets[i] == -1)
1348 FD_SET(sockets[i], &wr_fds);
1349 FD_SET(sockets[i], &r_fds);
1350 if (sockets[i]>maxfd)
1355 tv.tv_usec = connect_loop;
1357 res = sys_select_intr(maxfd+1, &r_fds, &wr_fds, NULL, &tv);
1365 for (i=0; i<num_addrs; i++) {
1367 if (sockets[i] == -1)
1370 /* Stevens, Network Programming says that if there's a
1371 * successful connect, the socket is only writable. Upon an
1372 * error, it's both readable and writable. */
1374 if (FD_ISSET(sockets[i], &r_fds) &&
1375 FD_ISSET(sockets[i], &wr_fds)) {
1376 /* readable and writable, so it's an error */
1382 if (!FD_ISSET(sockets[i], &r_fds) &&
1383 FD_ISSET(sockets[i], &wr_fds)) {
1384 /* Only writable, so it's connected */
1385 resulting_index = i;
1392 timeout -= connect_loop;
1395 connect_loop *= 1.5;
1396 if (connect_loop > timeout)
1397 connect_loop = timeout;
1401 for (i=0; i<num_addrs; i++) {
1402 if (i == resulting_index)
1404 if (sockets[i] >= 0)
1408 if (resulting_index >= 0) {
1409 *fd_index = resulting_index;
1410 *fd = sockets[*fd_index];
1411 set_blocking(*fd, true);
1416 return (resulting_index >= 0);
1418 /****************************************************************************
1419 Open a connected UDP socket to host on port
1420 **************************************************************************/
1422 int open_udp_socket(const char *host, int port)
1424 int type = SOCK_DGRAM;
1425 struct sockaddr_in sock_out;
1427 struct in_addr addr;
1429 addr = interpret_addr2(host);
1431 res = socket(PF_INET, type, 0);
1436 memset((char *)&sock_out,'\0',sizeof(sock_out));
1437 putip((char *)&sock_out.sin_addr,(char *)&addr);
1438 sock_out.sin_port = htons(port);
1439 sock_out.sin_family = PF_INET;
1441 if (sys_connect(res,(struct sockaddr *)&sock_out)) {
1449 /*******************************************************************
1450 Return the IP addr of the remote end of a socket as a string.
1451 Optionally return the struct sockaddr_storage.
1452 ******************************************************************/
1454 static const char *get_peer_addr_internal(int fd,
1456 size_t addr_buf_len,
1457 struct sockaddr *pss,
1460 struct sockaddr_storage ss;
1461 socklen_t length = sizeof(ss);
1463 strlcpy(addr_buf,"0.0.0.0",addr_buf_len);
1470 pss = (struct sockaddr *)&ss;
1474 if (getpeername(fd, (struct sockaddr *)pss, plength) < 0) {
1475 DEBUG(0,("getpeername failed. Error was %s\n",
1480 print_sockaddr_len(addr_buf,
1487 /*******************************************************************
1488 Matchname - determine if host name matches IP address. Used to
1489 confirm a hostname lookup to prevent spoof attacks.
1490 ******************************************************************/
1492 static bool matchname(const char *remotehost,
1493 const struct sockaddr *pss,
1496 struct addrinfo *res = NULL;
1497 struct addrinfo *ailist = NULL;
1498 char addr_buf[INET6_ADDRSTRLEN];
1499 bool ret = interpret_string_addr_internal(&ailist,
1501 AI_ADDRCONFIG|AI_CANONNAME);
1503 if (!ret || ailist == NULL) {
1504 DEBUG(3,("matchname: getaddrinfo failed for "
1507 gai_strerror(ret) ));
1512 * Make sure that getaddrinfo() returns the "correct" host name.
1515 if (ailist->ai_canonname == NULL ||
1516 (!strequal(remotehost, ailist->ai_canonname) &&
1517 !strequal(remotehost, "localhost"))) {
1518 DEBUG(0,("matchname: host name/name mismatch: %s != %s\n",
1520 ailist->ai_canonname ?
1521 ailist->ai_canonname : "(NULL)"));
1522 freeaddrinfo(ailist);
1526 /* Look up the host address in the address list we just got. */
1527 for (res = ailist; res; res = res->ai_next) {
1528 if (!res->ai_addr) {
1531 if (sockaddr_equal((const struct sockaddr *)res->ai_addr,
1532 (struct sockaddr *)pss)) {
1533 freeaddrinfo(ailist);
1539 * The host name does not map to the original host address. Perhaps
1540 * someone has compromised a name server. More likely someone botched
1541 * it, but that could be dangerous, too.
1544 DEBUG(0,("matchname: host name/address mismatch: %s != %s\n",
1545 print_sockaddr_len(addr_buf,
1549 ailist->ai_canonname ? ailist->ai_canonname : "(NULL)"));
1552 freeaddrinfo(ailist);
1557 /*******************************************************************
1558 Deal with the singleton cache.
1559 ******************************************************************/
1561 struct name_addr_pair {
1562 struct sockaddr_storage ss;
1566 /*******************************************************************
1567 Lookup a name/addr pair. Returns memory allocated from memcache.
1568 ******************************************************************/
1570 static bool lookup_nc(struct name_addr_pair *nc)
1576 if (!memcache_lookup(
1577 NULL, SINGLETON_CACHE,
1578 data_blob_string_const_null("get_peer_name"),
1583 memcpy(&nc->ss, tmp.data, sizeof(nc->ss));
1584 nc->name = (const char *)tmp.data + sizeof(nc->ss);
1588 /*******************************************************************
1589 Save a name/addr pair.
1590 ******************************************************************/
1592 static void store_nc(const struct name_addr_pair *nc)
1595 size_t namelen = strlen(nc->name);
1597 tmp = data_blob(NULL, sizeof(nc->ss) + namelen + 1);
1601 memcpy(tmp.data, &nc->ss, sizeof(nc->ss));
1602 memcpy(tmp.data+sizeof(nc->ss), nc->name, namelen+1);
1604 memcache_add(NULL, SINGLETON_CACHE,
1605 data_blob_string_const_null("get_peer_name"),
1607 data_blob_free(&tmp);
1610 /*******************************************************************
1611 Return the DNS name of the remote end of a socket.
1612 ******************************************************************/
1614 const char *get_peer_name(int fd, bool force_lookup)
1616 struct name_addr_pair nc;
1617 char addr_buf[INET6_ADDRSTRLEN];
1618 struct sockaddr_storage ss;
1619 socklen_t length = sizeof(ss);
1622 char name_buf[MAX_DNS_NAME_LENGTH];
1623 char tmp_name[MAX_DNS_NAME_LENGTH];
1625 /* reverse lookups can be *very* expensive, and in many
1626 situations won't work because many networks don't link dhcp
1627 with dns. To avoid the delay we avoid the lookup if
1629 if (!lp_hostname_lookups() && (force_lookup == false)) {
1630 length = sizeof(nc.ss);
1631 nc.name = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf),
1632 (struct sockaddr *)&nc.ss, &length);
1635 return nc.name ? nc.name : "UNKNOWN";
1640 memset(&ss, '\0', sizeof(ss));
1641 p = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf), (struct sockaddr *)&ss, &length);
1643 /* it might be the same as the last one - save some DNS work */
1644 if (sockaddr_equal((struct sockaddr *)&ss, (struct sockaddr *)&nc.ss)) {
1645 return nc.name ? nc.name : "UNKNOWN";
1648 /* Not the same. We need to lookup. */
1653 /* Look up the remote host name. */
1654 ret = sys_getnameinfo((struct sockaddr *)&ss,
1663 DEBUG(1,("get_peer_name: getnameinfo failed "
1664 "for %s with error %s\n",
1666 gai_strerror(ret)));
1667 strlcpy(name_buf, p, sizeof(name_buf));
1669 if (!matchname(name_buf, (struct sockaddr *)&ss, length)) {
1670 DEBUG(0,("Matchname failed on %s %s\n",name_buf,p));
1671 strlcpy(name_buf,"UNKNOWN",sizeof(name_buf));
1675 /* can't pass the same source and dest strings in when you
1676 use --enable-developer or the clobber_region() call will
1679 strlcpy(tmp_name, name_buf, sizeof(tmp_name));
1680 alpha_strcpy(name_buf, tmp_name, "_-.", sizeof(name_buf));
1681 if (strstr(name_buf,"..")) {
1682 strlcpy(name_buf, "UNKNOWN", sizeof(name_buf));
1690 return nc.name ? nc.name : "UNKNOWN";
1693 /*******************************************************************
1694 Return the IP addr of the remote end of a socket as a string.
1695 ******************************************************************/
1697 const char *get_peer_addr(int fd, char *addr, size_t addr_len)
1699 return get_peer_addr_internal(fd, addr, addr_len, NULL, NULL);
1702 /*******************************************************************
1703 Create protected unix domain socket.
1705 Some unixes cannot set permissions on a ux-dom-sock, so we
1706 have to make sure that the directory contains the protection
1707 permissions instead.
1708 ******************************************************************/
1710 int create_pipe_sock(const char *socket_dir,
1711 const char *socket_name,
1714 #ifdef HAVE_UNIXSOCKET
1715 struct sockaddr_un sunaddr;
1721 old_umask = umask(0);
1723 /* Create the socket directory or reuse the existing one */
1725 if (lstat(socket_dir, &st) == -1) {
1726 if (errno == ENOENT) {
1727 /* Create directory */
1728 if (mkdir(socket_dir, dir_perms) == -1) {
1729 DEBUG(0, ("error creating socket directory "
1730 "%s: %s\n", socket_dir,
1735 DEBUG(0, ("lstat failed on socket directory %s: %s\n",
1736 socket_dir, strerror(errno)));
1740 /* Check ownership and permission on existing directory */
1741 if (!S_ISDIR(st.st_mode)) {
1742 DEBUG(0, ("socket directory %s isn't a directory\n",
1746 if ((st.st_uid != sec_initial_uid()) ||
1747 ((st.st_mode & 0777) != dir_perms)) {
1748 DEBUG(0, ("invalid permissions on socket directory "
1749 "%s\n", socket_dir));
1754 /* Create the socket file */
1756 sock = socket(AF_UNIX, SOCK_STREAM, 0);
1759 DEBUG(0, ("create_pipe_sock: socket error %s\n",
1764 if (asprintf(&path, "%s/%s", socket_dir, socket_name) == -1) {
1769 memset(&sunaddr, 0, sizeof(sunaddr));
1770 sunaddr.sun_family = AF_UNIX;
1771 strlcpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path));
1773 if (bind(sock, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1) {
1774 DEBUG(0, ("bind failed on pipe socket %s: %s\n", path,
1779 if (listen(sock, 5) == -1) {
1780 DEBUG(0, ("listen failed on pipe socket %s: %s\n", path,
1800 DEBUG(0, ("create_pipe_sock: No Unix sockets on this system\n"));
1802 #endif /* HAVE_UNIXSOCKET */
1805 /****************************************************************************
1806 Get my own canonical name, including domain.
1807 ****************************************************************************/
1809 const char *get_mydnsfullname(void)
1811 struct addrinfo *res = NULL;
1812 char my_hostname[HOST_NAME_MAX];
1816 if (memcache_lookup(NULL, SINGLETON_CACHE,
1817 data_blob_string_const_null("get_mydnsfullname"),
1819 SMB_ASSERT(tmp.length > 0);
1820 return (const char *)tmp.data;
1823 /* get my host name */
1824 if (gethostname(my_hostname, sizeof(my_hostname)) == -1) {
1825 DEBUG(0,("get_mydnsfullname: gethostname failed\n"));
1829 /* Ensure null termination. */
1830 my_hostname[sizeof(my_hostname)-1] = '\0';
1832 ret = interpret_string_addr_internal(&res,
1834 AI_ADDRCONFIG|AI_CANONNAME);
1836 if (!ret || res == NULL) {
1837 DEBUG(3,("get_mydnsfullname: getaddrinfo failed for "
1840 gai_strerror(ret) ));
1845 * Make sure that getaddrinfo() returns the "correct" host name.
1848 if (res->ai_canonname == NULL) {
1849 DEBUG(3,("get_mydnsfullname: failed to get "
1850 "canonical name for %s\n",
1856 /* This copies the data, so we must do a lookup
1857 * afterwards to find the value to return.
1860 memcache_add(NULL, SINGLETON_CACHE,
1861 data_blob_string_const_null("get_mydnsfullname"),
1862 data_blob_string_const_null(res->ai_canonname));
1864 if (!memcache_lookup(NULL, SINGLETON_CACHE,
1865 data_blob_string_const_null("get_mydnsfullname"),
1867 tmp = data_blob_talloc(talloc_tos(), res->ai_canonname,
1868 strlen(res->ai_canonname) + 1);
1873 return (const char *)tmp.data;
1876 /************************************************************
1878 ************************************************************/
1880 bool is_myname_or_ipaddr(const char *s)
1882 TALLOC_CTX *ctx = talloc_tos();
1883 char addr[INET6_ADDRSTRLEN];
1885 const char *dnsname;
1886 char *servername = NULL;
1892 /* Santize the string from '\\name' */
1893 name = talloc_strdup(ctx, s);
1898 servername = strrchr_m(name, '\\' );
1905 /* Optimize for the common case */
1906 if (strequal(servername, global_myname())) {
1910 /* Check for an alias */
1911 if (is_myname(servername)) {
1915 /* Check for loopback */
1916 if (strequal(servername, "127.0.0.1") ||
1917 strequal(servername, "::1")) {
1921 if (strequal(servername, "localhost")) {
1925 /* Maybe it's my dns name */
1926 dnsname = get_mydnsfullname();
1927 if (dnsname && strequal(servername, dnsname)) {
1931 /* Handle possible CNAME records - convert to an IP addr. */
1932 if (!is_ipaddress(servername)) {
1933 /* Use DNS to resolve the name, but only the first address */
1934 struct sockaddr_storage ss;
1935 if (interpret_string_addr(&ss, servername, 0)) {
1936 print_sockaddr(addr,
1943 /* Maybe its an IP address? */
1944 if (is_ipaddress(servername)) {
1945 struct sockaddr_storage ss;
1946 struct iface_struct *nics;
1949 if (!interpret_string_addr(&ss, servername, AI_NUMERICHOST)) {
1953 if (is_zero_addr((struct sockaddr *)&ss) ||
1954 is_loopback_addr((struct sockaddr *)&ss)) {
1958 nics = TALLOC_ARRAY(ctx, struct iface_struct,
1963 n = get_interfaces(nics, MAX_INTERFACES);
1964 for (i=0; i<n; i++) {
1965 if (sockaddr_equal((struct sockaddr *)&nics[i].ip, (struct sockaddr *)&ss)) {