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 Get a port number in host byte order from a sockaddr_storage.
26 ****************************************************************************/
28 uint16_t get_sockaddr_port(const struct sockaddr_storage *pss)
32 if (pss->ss_family != AF_INET) {
33 #if defined(HAVE_IPV6)
35 const struct sockaddr_in6 *sa6 =
36 (const struct sockaddr_in6 *)pss;
37 port = ntohs(sa6->sin6_port);
40 const struct sockaddr_in *sa =
41 (const struct sockaddr_in *)pss;
42 port = ntohs(sa->sin_port);
47 /****************************************************************************
48 Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
49 ****************************************************************************/
51 static char *print_sockaddr_len(char *dest,
53 const struct sockaddr *psa,
59 (void)sys_getnameinfo(psa,
67 /****************************************************************************
68 Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
69 ****************************************************************************/
71 char *print_sockaddr(char *dest,
73 const struct sockaddr_storage *psa)
75 return print_sockaddr_len(dest, destlen, (struct sockaddr *)psa,
76 sizeof(struct sockaddr_storage));
79 /****************************************************************************
80 Print out a canonical IPv4 or IPv6 address from a struct sockaddr_storage.
81 ****************************************************************************/
83 char *print_canonical_sockaddr(TALLOC_CTX *ctx,
84 const struct sockaddr_storage *pss)
86 char addr[INET6_ADDRSTRLEN];
90 /* Linux getnameinfo() man pages says port is unitialized if
91 service name is NULL. */
93 ret = sys_getnameinfo((const struct sockaddr *)pss,
94 sizeof(struct sockaddr_storage),
102 if (pss->ss_family != AF_INET) {
103 #if defined(HAVE_IPV6)
104 dest = talloc_asprintf(ctx, "[%s]", addr);
109 dest = talloc_asprintf(ctx, "%s", addr);
115 /****************************************************************************
116 Return the string of an IP address (IPv4 or IPv6).
117 ****************************************************************************/
119 static const char *get_socket_addr(int fd, char *addr_buf, size_t addr_len)
121 struct sockaddr_storage sa;
122 socklen_t length = sizeof(sa);
124 /* Ok, returning a hard coded IPv4 address
125 * is bogus, but it's just as bogus as a
126 * zero IPv6 address. No good choice here.
129 strlcpy(addr_buf, "0.0.0.0", addr_len);
135 if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
136 DEBUG(0,("getsockname failed. Error was %s\n",
141 return print_sockaddr_len(addr_buf, addr_len, (struct sockaddr *)&sa, length);
144 /****************************************************************************
145 Return the port number we've bound to on a socket.
146 ****************************************************************************/
148 int get_socket_port(int fd)
150 struct sockaddr_storage sa;
151 socklen_t length = sizeof(sa);
157 if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
158 int level = (errno == ENOTCONN) ? 2 : 0;
159 DEBUG(level, ("getpeername failed. Error was %s\n",
164 #if defined(HAVE_IPV6)
165 if (sa.ss_family == AF_INET6) {
166 return ntohs(((struct sockaddr_in6 *)&sa)->sin6_port);
169 if (sa.ss_family == AF_INET) {
170 return ntohs(((struct sockaddr_in *)&sa)->sin_port);
175 const char *client_name(int fd)
177 return get_peer_name(fd,false);
180 const char *client_addr(int fd, char *addr, size_t addrlen)
182 return get_peer_addr(fd,addr,addrlen);
185 const char *client_socket_addr(int fd, char *addr, size_t addr_len)
187 return get_socket_addr(fd, addr, addr_len);
191 /* Not currently used. JRA. */
192 int client_socket_port(int fd)
194 return get_socket_port(fd);
198 /****************************************************************************
199 Accessor functions to make thread-safe code easier later...
200 ****************************************************************************/
202 void set_smb_read_error(enum smb_read_errors *pre,
203 enum smb_read_errors newerr)
210 void cond_set_smb_read_error(enum smb_read_errors *pre,
211 enum smb_read_errors newerr)
213 if (pre && *pre == SMB_READ_OK) {
218 /****************************************************************************
219 Determine if a file descriptor is in fact a socket.
220 ****************************************************************************/
222 bool is_a_socket(int fd)
227 return(getsockopt(fd, SOL_SOCKET, SO_TYPE, (char *)&v, &l) == 0);
230 enum SOCK_OPT_TYPES {OPT_BOOL,OPT_INT,OPT_ON};
232 typedef struct smb_socket_option {
240 static const smb_socket_option socket_options[] = {
241 {"SO_KEEPALIVE", SOL_SOCKET, SO_KEEPALIVE, 0, OPT_BOOL},
242 {"SO_REUSEADDR", SOL_SOCKET, SO_REUSEADDR, 0, OPT_BOOL},
243 {"SO_BROADCAST", SOL_SOCKET, SO_BROADCAST, 0, OPT_BOOL},
245 {"TCP_NODELAY", IPPROTO_TCP, TCP_NODELAY, 0, OPT_BOOL},
248 {"TCP_KEEPCNT", IPPROTO_TCP, TCP_KEEPCNT, 0, OPT_INT},
251 {"TCP_KEEPIDLE", IPPROTO_TCP, TCP_KEEPIDLE, 0, OPT_INT},
254 {"TCP_KEEPINTVL", IPPROTO_TCP, TCP_KEEPINTVL, 0, OPT_INT},
256 #ifdef IPTOS_LOWDELAY
257 {"IPTOS_LOWDELAY", IPPROTO_IP, IP_TOS, IPTOS_LOWDELAY, OPT_ON},
259 #ifdef IPTOS_THROUGHPUT
260 {"IPTOS_THROUGHPUT", IPPROTO_IP, IP_TOS, IPTOS_THROUGHPUT, OPT_ON},
263 {"SO_REUSEPORT", SOL_SOCKET, SO_REUSEPORT, 0, OPT_BOOL},
266 {"SO_SNDBUF", SOL_SOCKET, SO_SNDBUF, 0, OPT_INT},
269 {"SO_RCVBUF", SOL_SOCKET, SO_RCVBUF, 0, OPT_INT},
272 {"SO_SNDLOWAT", SOL_SOCKET, SO_SNDLOWAT, 0, OPT_INT},
275 {"SO_RCVLOWAT", SOL_SOCKET, SO_RCVLOWAT, 0, OPT_INT},
278 {"SO_SNDTIMEO", SOL_SOCKET, SO_SNDTIMEO, 0, OPT_INT},
281 {"SO_RCVTIMEO", SOL_SOCKET, SO_RCVTIMEO, 0, OPT_INT},
284 {"TCP_FASTACK", IPPROTO_TCP, TCP_FASTACK, 0, OPT_INT},
287 {"TCP_QUICKACK", IPPROTO_TCP, TCP_QUICKACK, 0, OPT_BOOL},
291 /****************************************************************************
292 Print socket options.
293 ****************************************************************************/
295 static void print_socket_options(int s)
299 const smb_socket_option *p = &socket_options[0];
301 /* wrapped in if statement to prevent streams
302 * leak in SCO Openserver 5.0 */
303 /* reported on samba-technical --jerry */
304 if ( DEBUGLEVEL >= 5 ) {
305 DEBUG(5,("Socket options:\n"));
306 for (; p->name != NULL; p++) {
307 if (getsockopt(s, p->level, p->option,
308 (void *)&value, &vlen) == -1) {
309 DEBUGADD(5,("\tCould not test socket option %s.\n",
312 DEBUGADD(5,("\t%s = %d\n",
319 /****************************************************************************
320 Set user socket options.
321 ****************************************************************************/
323 void set_socket_options(int fd, const char *options)
325 TALLOC_CTX *ctx = talloc_stackframe();
328 while (next_token_talloc(ctx, &options, &tok," \t,")) {
332 bool got_value = false;
334 if ((p = strchr_m(tok,'='))) {
340 for (i=0;socket_options[i].name;i++)
341 if (strequal(socket_options[i].name,tok))
344 if (!socket_options[i].name) {
345 DEBUG(0,("Unknown socket option %s\n",tok));
349 switch (socket_options[i].opttype) {
352 ret = setsockopt(fd,socket_options[i].level,
353 socket_options[i].option,
354 (char *)&value,sizeof(int));
359 DEBUG(0,("syntax error - %s "
360 "does not take a value\n",tok));
363 int on = socket_options[i].value;
364 ret = setsockopt(fd,socket_options[i].level,
365 socket_options[i].option,
366 (char *)&on,sizeof(int));
372 /* be aware that some systems like Solaris return
373 * EINVAL to a setsockopt() call when the client
374 * sent a RST previously - no need to worry */
375 DEBUG(2,("Failed to set socket option %s (Error %s)\n",
376 tok, strerror(errno) ));
381 print_socket_options(fd);
384 /****************************************************************************
386 ****************************************************************************/
388 ssize_t read_udp_v4_socket(int fd,
391 struct sockaddr_storage *psa)
394 socklen_t socklen = sizeof(*psa);
395 struct sockaddr_in *si = (struct sockaddr_in *)psa;
397 memset((char *)psa,'\0',socklen);
399 ret = (ssize_t)sys_recvfrom(fd,buf,len,0,
400 (struct sockaddr *)psa,&socklen);
402 /* Don't print a low debug error for a non-blocking socket. */
403 if (errno == EAGAIN) {
404 DEBUG(10,("read_udp_v4_socket: returned EAGAIN\n"));
406 DEBUG(2,("read_udp_v4_socket: failed. errno=%s\n",
412 if (psa->ss_family != AF_INET) {
413 DEBUG(2,("read_udp_v4_socket: invalid address family %d "
414 "(not IPv4)\n", (int)psa->ss_family));
418 DEBUG(10,("read_udp_v4_socket: ip %s port %d read: %lu\n",
419 inet_ntoa(si->sin_addr),
421 (unsigned long)ret));
426 /****************************************************************************
427 Read data from a file descriptor with a timout in msec.
428 mincount = if timeout, minimum to read before returning
429 maxcount = number to be read.
430 time_out = timeout in milliseconds
431 NB. This can be called with a non-socket fd, don't change
432 sys_read() to sys_recv() or other socket call.
433 ****************************************************************************/
435 NTSTATUS read_fd_with_timeout(int fd, char *buf,
436 size_t mincnt, size_t maxcnt,
437 unsigned int time_out,
444 struct timeval timeout;
447 /* just checking .... */
457 while (nread < mincnt) {
458 readret = sys_read(fd, buf + nread, maxcnt - nread);
461 DEBUG(5,("read_fd_with_timeout: "
462 "blocking read. EOF from client.\n"));
463 return NT_STATUS_END_OF_FILE;
467 return map_nt_error_from_unix(save_errno);
474 /* Most difficult - timeout read */
475 /* If this is ever called on a disk file and
476 mincnt is greater then the filesize then
477 system performance will suffer severely as
478 select always returns true on disk files */
480 /* Set initial timeout */
481 timeout.tv_sec = (time_t)(time_out / 1000);
482 timeout.tv_usec = (long)(1000 * (time_out % 1000));
484 for (nread=0; nread < mincnt; ) {
488 selrtn = sys_select_intr(fd+1,&fds,NULL,NULL,&timeout);
492 return map_nt_error_from_unix(save_errno);
495 /* Did we timeout ? */
497 DEBUG(10,("read_fd_with_timeout: timeout read. "
498 "select timed out.\n"));
499 return NT_STATUS_IO_TIMEOUT;
502 readret = sys_read(fd, buf+nread, maxcnt-nread);
505 /* we got EOF on the file descriptor */
506 DEBUG(5,("read_fd_with_timeout: timeout read. "
507 "EOF from client.\n"));
508 return NT_STATUS_END_OF_FILE;
512 return map_nt_error_from_unix(errno);
519 /* Return the number we got */
526 /****************************************************************************
527 Read data from an fd, reading exactly N bytes.
528 NB. This can be called with a non-socket fd, don't add dependencies
530 ****************************************************************************/
532 NTSTATUS read_data(int fd, char *buffer, size_t N)
534 return read_fd_with_timeout(fd, buffer, N, N, 0, NULL);
537 /****************************************************************************
538 Write all data from an iov array
539 NB. This can be called with a non-socket fd, don't add dependencies
541 ****************************************************************************/
543 ssize_t write_data_iov(int fd, const struct iovec *orig_iov, int iovcnt)
549 struct iovec *iov_copy, *iov;
552 for (i=0; i<iovcnt; i++) {
553 to_send += orig_iov[i].iov_len;
556 thistime = sys_writev(fd, orig_iov, iovcnt);
557 if ((thistime <= 0) || (thistime == to_send)) {
563 * We could not send everything in one call. Make a copy of iov that
564 * we can mess with. We keep a copy of the array start in iov_copy for
565 * the TALLOC_FREE, because we're going to modify iov later on,
566 * discarding elements.
569 iov_copy = (struct iovec *)TALLOC_MEMDUP(
570 talloc_tos(), orig_iov, sizeof(struct iovec) * iovcnt);
572 if (iov_copy == NULL) {
578 while (sent < to_send) {
580 * We have to discard "thistime" bytes from the beginning
581 * iov array, "thistime" contains the number of bytes sent
584 while (thistime > 0) {
585 if (thistime < iov[0].iov_len) {
587 (char *)iov[0].iov_base + thistime;
588 iov[0].iov_base = (void *)new_base;
589 iov[0].iov_len -= thistime;
592 thistime -= iov[0].iov_len;
597 thistime = sys_writev(fd, iov, iovcnt);
604 TALLOC_FREE(iov_copy);
608 /****************************************************************************
610 NB. This can be called with a non-socket fd, don't add dependencies
612 ****************************************************************************/
614 ssize_t write_data(int fd, const char *buffer, size_t N)
618 iov.iov_base = CONST_DISCARD(void *, buffer);
620 return write_data_iov(fd, &iov, 1);
623 /****************************************************************************
624 Send a keepalive packet (rfc1002).
625 ****************************************************************************/
627 bool send_keepalive(int client)
629 unsigned char buf[4];
631 buf[0] = SMBkeepalive;
632 buf[1] = buf[2] = buf[3] = 0;
634 return(write_data(client,(char *)buf,4) == 4);
637 /****************************************************************************
638 Read 4 bytes of a smb packet and return the smb length of the packet.
639 Store the result in the buffer.
640 This version of the function will return a length of zero on receiving
642 Timeout is in milliseconds.
643 ****************************************************************************/
645 NTSTATUS read_smb_length_return_keepalive(int fd, char *inbuf,
646 unsigned int timeout,
652 status = read_fd_with_timeout(fd, inbuf, 4, 4, timeout, NULL);
654 if (!NT_STATUS_IS_OK(status)) {
655 if (fd == smbd_server_fd()) {
656 char addr[INET6_ADDRSTRLEN];
657 /* Try and give an error message
658 * saying what client failed. */
659 DEBUG(0, ("read_fd_with_timeout failed for "
660 "client %s read error = %s.\n",
661 get_peer_addr(fd,addr,sizeof(addr)),
664 DEBUG(0, ("read_fd_with_timeout failed, read error = "
665 "%s.\n", nt_errstr(status)));
670 *len = smb_len(inbuf);
671 msg_type = CVAL(inbuf,0);
673 if (msg_type == SMBkeepalive) {
674 DEBUG(5,("Got keepalive packet\n"));
677 DEBUG(10,("got smb length of %lu\n",(unsigned long)(*len)));
682 /****************************************************************************
683 Read 4 bytes of a smb packet and return the smb length of the packet.
684 Store the result in the buffer. This version of the function will
685 never return a session keepalive (length of zero).
686 Timeout is in milliseconds.
687 ****************************************************************************/
689 NTSTATUS read_smb_length(int fd, char *inbuf, unsigned int timeout,
692 uint8_t msgtype = SMBkeepalive;
694 while (msgtype == SMBkeepalive) {
697 status = read_smb_length_return_keepalive(fd, inbuf, timeout,
699 if (!NT_STATUS_IS_OK(status)) {
703 msgtype = CVAL(inbuf, 0);
706 DEBUG(10,("read_smb_length: got smb length of %lu\n",
707 (unsigned long)len));
712 /****************************************************************************
713 Read an smb from a fd.
714 The timeout is in milliseconds.
715 This function will return on receipt of a session keepalive packet.
716 maxlen is the max number of bytes to return, not including the 4 byte
717 length. If zero it means buflen limit.
718 Doesn't check the MAC on signed packets.
719 ****************************************************************************/
721 NTSTATUS receive_smb_raw(int fd, char *buffer, size_t buflen, unsigned int timeout,
722 size_t maxlen, size_t *p_len)
727 status = read_smb_length_return_keepalive(fd,buffer,timeout,&len);
729 if (!NT_STATUS_IS_OK(status)) {
730 DEBUG(10, ("receive_smb_raw: %s!\n", nt_errstr(status)));
735 DEBUG(0,("Invalid packet length! (%lu bytes).\n",
736 (unsigned long)len));
737 return NT_STATUS_INVALID_PARAMETER;
742 len = MIN(len,maxlen);
745 status = read_fd_with_timeout(
746 fd, buffer+4, len, len, timeout, &len);
748 if (!NT_STATUS_IS_OK(status)) {
749 if (fd == smbd_server_fd()) {
750 char addr[INET6_ADDRSTRLEN];
751 /* Try and give an error message
752 * saying what client failed. */
753 DEBUG(0, ("read_fd_with_timeout failed for "
754 "client %s read error = %s.\n",
755 get_peer_addr(fd,addr,sizeof(addr)),
758 DEBUG(0, ("read_fd_with_timeout failed, "
759 "read error = %s.\n",
765 /* not all of samba3 properly checks for packet-termination
766 * of strings. This ensures that we don't run off into
768 SSVAL(buffer+4,len, 0);
775 /****************************************************************************
776 Open a socket of the specified type, port, and address for incoming data.
777 ****************************************************************************/
779 int open_socket_in(int type,
782 const struct sockaddr_storage *psock,
785 struct sockaddr_storage sock;
787 socklen_t slen = sizeof(struct sockaddr_in);
791 #if defined(HAVE_IPV6)
792 if (sock.ss_family == AF_INET6) {
793 ((struct sockaddr_in6 *)&sock)->sin6_port = htons(port);
794 slen = sizeof(struct sockaddr_in6);
797 if (sock.ss_family == AF_INET) {
798 ((struct sockaddr_in *)&sock)->sin_port = htons(port);
801 res = socket(sock.ss_family, type, 0 );
804 dbgtext( "open_socket_in(): socket() call failed: " );
805 dbgtext( "%s\n", strerror( errno ) );
810 /* This block sets/clears the SO_REUSEADDR and possibly SO_REUSEPORT. */
812 int val = rebind ? 1 : 0;
813 if( setsockopt(res,SOL_SOCKET,SO_REUSEADDR,
814 (char *)&val,sizeof(val)) == -1 ) {
815 if( DEBUGLVL( dlevel ) ) {
816 dbgtext( "open_socket_in(): setsockopt: " );
817 dbgtext( "SO_REUSEADDR = %s ",
818 val?"true":"false" );
819 dbgtext( "on port %d failed ", port );
820 dbgtext( "with error = %s\n", strerror(errno) );
824 if( setsockopt(res,SOL_SOCKET,SO_REUSEPORT,
825 (char *)&val,sizeof(val)) == -1 ) {
826 if( DEBUGLVL( dlevel ) ) {
827 dbgtext( "open_socket_in(): setsockopt: ");
828 dbgtext( "SO_REUSEPORT = %s ",
830 dbgtext( "on port %d failed ", port);
831 dbgtext( "with error = %s\n", strerror(errno));
834 #endif /* SO_REUSEPORT */
837 /* now we've got a socket - we need to bind it */
838 if (bind(res, (struct sockaddr *)&sock, slen) == -1 ) {
839 if( DEBUGLVL(dlevel) && (port == SMB_PORT1 ||
840 port == SMB_PORT2 || port == NMB_PORT) ) {
841 char addr[INET6_ADDRSTRLEN];
842 print_sockaddr(addr, sizeof(addr),
844 dbgtext( "bind failed on port %d ", port);
845 dbgtext( "socket_addr = %s.\n", addr);
846 dbgtext( "Error = %s\n", strerror(errno));
852 DEBUG( 10, ( "bind succeeded on port %d\n", port ) );
856 struct open_socket_out_state {
858 struct event_context *ev;
859 struct sockaddr_storage ss;
865 static void open_socket_out_connected(struct tevent_req *subreq);
867 static int open_socket_out_state_destructor(struct open_socket_out_state *s)
875 /****************************************************************************
876 Create an outgoing socket. timeout is in milliseconds.
877 **************************************************************************/
879 struct tevent_req *open_socket_out_send(TALLOC_CTX *mem_ctx,
880 struct event_context *ev,
881 const struct sockaddr_storage *pss,
885 char addr[INET6_ADDRSTRLEN];
886 struct tevent_req *result, *subreq;
887 struct open_socket_out_state *state;
890 result = tevent_req_create(mem_ctx, &state,
891 struct open_socket_out_state);
892 if (result == NULL) {
898 state->wait_nsec = 10000;
901 state->fd = socket(state->ss.ss_family, SOCK_STREAM, 0);
902 if (state->fd == -1) {
903 status = map_nt_error_from_unix(errno);
906 talloc_set_destructor(state, open_socket_out_state_destructor);
908 if (!tevent_req_set_endtime(
909 result, ev, timeval_current_ofs(0, timeout*1000))) {
913 #if defined(HAVE_IPV6)
914 if (pss->ss_family == AF_INET6) {
915 struct sockaddr_in6 *psa6;
916 psa6 = (struct sockaddr_in6 *)&state->ss;
917 psa6->sin6_port = htons(port);
918 if (psa6->sin6_scope_id == 0
919 && IN6_IS_ADDR_LINKLOCAL(&psa6->sin6_addr)) {
920 setup_linklocal_scope_id(
921 (struct sockaddr *)&(state->ss));
923 state->salen = sizeof(struct sockaddr_in6);
926 if (pss->ss_family == AF_INET) {
927 struct sockaddr_in *psa;
928 psa = (struct sockaddr_in *)&state->ss;
929 psa->sin_port = htons(port);
930 state->salen = sizeof(struct sockaddr_in);
933 if (pss->ss_family == AF_UNIX) {
934 state->salen = sizeof(struct sockaddr_un);
937 print_sockaddr(addr, sizeof(addr), &state->ss);
938 DEBUG(3,("Connecting to %s at port %u\n", addr, (unsigned int)port));
940 subreq = async_connect_send(state, state->ev, state->fd,
941 (struct sockaddr *)&state->ss,
944 || !tevent_req_set_endtime(
946 timeval_current_ofs(0, state->wait_nsec))) {
949 tevent_req_set_callback(subreq, open_socket_out_connected, result);
953 tevent_req_nterror(result, status);
954 return tevent_req_post(result, ev);
960 static void open_socket_out_connected(struct tevent_req *subreq)
962 struct tevent_req *req =
963 tevent_req_callback_data(subreq, struct tevent_req);
964 struct open_socket_out_state *state =
965 tevent_req_data(req, struct open_socket_out_state);
969 ret = async_connect_recv(subreq, &sys_errno);
972 tevent_req_done(req);
978 (sys_errno == ETIMEDOUT) ||
980 (sys_errno == EINPROGRESS) ||
981 (sys_errno == EALREADY) ||
982 (sys_errno == EAGAIN)) {
988 if (state->wait_nsec < 250000) {
989 state->wait_nsec *= 1.5;
992 subreq = async_connect_send(state, state->ev, state->fd,
993 (struct sockaddr *)&state->ss,
995 if (tevent_req_nomem(subreq, req)) {
998 if (!tevent_req_set_endtime(
1000 timeval_current_ofs(0, state->wait_nsec))) {
1001 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
1004 tevent_req_set_callback(subreq, open_socket_out_connected, req);
1009 if (sys_errno == EISCONN) {
1010 tevent_req_done(req);
1016 tevent_req_nterror(req, map_nt_error_from_unix(sys_errno));
1019 NTSTATUS open_socket_out_recv(struct tevent_req *req, int *pfd)
1021 struct open_socket_out_state *state =
1022 tevent_req_data(req, struct open_socket_out_state);
1025 if (tevent_req_is_nterror(req, &status)) {
1030 return NT_STATUS_OK;
1033 NTSTATUS open_socket_out(const struct sockaddr_storage *pss, uint16_t port,
1034 int timeout, int *pfd)
1036 TALLOC_CTX *frame = talloc_stackframe();
1037 struct event_context *ev;
1038 struct tevent_req *req;
1039 NTSTATUS status = NT_STATUS_NO_MEMORY;
1041 ev = event_context_init(frame);
1046 req = open_socket_out_send(frame, ev, pss, port, timeout);
1050 if (!tevent_req_poll(req, ev)) {
1051 status = NT_STATUS_INTERNAL_ERROR;
1054 status = open_socket_out_recv(req, pfd);
1060 struct open_socket_out_defer_state {
1061 struct event_context *ev;
1062 struct sockaddr_storage ss;
1068 static void open_socket_out_defer_waited(struct tevent_req *subreq);
1069 static void open_socket_out_defer_connected(struct tevent_req *subreq);
1071 struct tevent_req *open_socket_out_defer_send(TALLOC_CTX *mem_ctx,
1072 struct event_context *ev,
1073 struct timeval wait_time,
1074 const struct sockaddr_storage *pss,
1078 struct tevent_req *req, *subreq;
1079 struct open_socket_out_defer_state *state;
1081 req = tevent_req_create(mem_ctx, &state,
1082 struct open_socket_out_defer_state);
1089 state->timeout = timeout;
1091 subreq = tevent_wakeup_send(
1093 timeval_current_ofs(wait_time.tv_sec, wait_time.tv_usec));
1094 if (subreq == NULL) {
1097 tevent_req_set_callback(subreq, open_socket_out_defer_waited, req);
1104 static void open_socket_out_defer_waited(struct tevent_req *subreq)
1106 struct tevent_req *req = tevent_req_callback_data(
1107 subreq, struct tevent_req);
1108 struct open_socket_out_defer_state *state = tevent_req_data(
1109 req, struct open_socket_out_defer_state);
1112 ret = tevent_wakeup_recv(subreq);
1113 TALLOC_FREE(subreq);
1115 tevent_req_nterror(req, NT_STATUS_INTERNAL_ERROR);
1119 subreq = open_socket_out_send(state, state->ev, &state->ss,
1120 state->port, state->timeout);
1121 if (tevent_req_nomem(subreq, req)) {
1124 tevent_req_set_callback(subreq, open_socket_out_defer_connected, req);
1127 static void open_socket_out_defer_connected(struct tevent_req *subreq)
1129 struct tevent_req *req = tevent_req_callback_data(
1130 subreq, struct tevent_req);
1131 struct open_socket_out_defer_state *state = tevent_req_data(
1132 req, struct open_socket_out_defer_state);
1135 status = open_socket_out_recv(subreq, &state->fd);
1136 TALLOC_FREE(subreq);
1137 if (!NT_STATUS_IS_OK(status)) {
1138 tevent_req_nterror(req, status);
1141 tevent_req_done(req);
1144 NTSTATUS open_socket_out_defer_recv(struct tevent_req *req, int *pfd)
1146 struct open_socket_out_defer_state *state = tevent_req_data(
1147 req, struct open_socket_out_defer_state);
1150 if (tevent_req_is_nterror(req, &status)) {
1155 return NT_STATUS_OK;
1158 /*******************************************************************
1159 Create an outgoing TCP socket to the first addr that connects.
1161 This is for simultaneous connection attempts to port 445 and 139 of a host
1162 or for simultatneous connection attempts to multiple DCs at once. We return
1163 a socket fd of the first successful connection.
1165 @param[in] addrs list of Internet addresses and ports to connect to
1166 @param[in] num_addrs number of address/port pairs in the addrs list
1167 @param[in] timeout time after which we stop waiting for a socket connection
1168 to succeed, given in milliseconds
1169 @param[out] fd_index the entry in addrs which we successfully connected to
1170 @param[out] fd fd of the open and connected socket
1171 @return true on a successful connection, false if all connection attempts
1172 failed or we timed out
1173 *******************************************************************/
1175 bool open_any_socket_out(struct sockaddr_storage *addrs, int num_addrs,
1176 int timeout, int *fd_index, int *fd)
1178 int i, resulting_index, res;
1182 fd_set r_fds, wr_fds;
1186 int connect_loop = 10000; /* 10 milliseconds */
1188 timeout *= 1000; /* convert to microseconds */
1190 sockets = SMB_MALLOC_ARRAY(int, num_addrs);
1192 if (sockets == NULL)
1195 resulting_index = -1;
1197 for (i=0; i<num_addrs; i++)
1200 for (i=0; i<num_addrs; i++) {
1201 sockets[i] = socket(addrs[i].ss_family, SOCK_STREAM, 0);
1204 set_blocking(sockets[i], false);
1208 good_connect = false;
1210 for (i=0; i<num_addrs; i++) {
1211 const struct sockaddr * a =
1212 (const struct sockaddr *)&(addrs[i]);
1214 if (sockets[i] == -1)
1217 if (sys_connect(sockets[i], a) == 0) {
1218 /* Rather unlikely as we are non-blocking, but it
1219 * might actually happen. */
1220 resulting_index = i;
1224 if (errno == EINPROGRESS || errno == EALREADY ||
1228 errno == EAGAIN || errno == EINTR) {
1229 /* These are the error messages that something is
1231 good_connect = true;
1232 } else if (errno != 0) {
1233 /* There was a direct error */
1239 if (!good_connect) {
1240 /* All of the connect's resulted in real error conditions */
1244 /* Lets see if any of the connect attempts succeeded */
1250 for (i=0; i<num_addrs; i++) {
1251 if (sockets[i] == -1)
1253 FD_SET(sockets[i], &wr_fds);
1254 FD_SET(sockets[i], &r_fds);
1255 if (sockets[i]>maxfd)
1260 tv.tv_usec = connect_loop;
1262 res = sys_select_intr(maxfd+1, &r_fds, &wr_fds, NULL, &tv);
1270 for (i=0; i<num_addrs; i++) {
1272 if (sockets[i] == -1)
1275 /* Stevens, Network Programming says that if there's a
1276 * successful connect, the socket is only writable. Upon an
1277 * error, it's both readable and writable. */
1279 if (FD_ISSET(sockets[i], &r_fds) &&
1280 FD_ISSET(sockets[i], &wr_fds)) {
1281 /* readable and writable, so it's an error */
1287 if (!FD_ISSET(sockets[i], &r_fds) &&
1288 FD_ISSET(sockets[i], &wr_fds)) {
1289 /* Only writable, so it's connected */
1290 resulting_index = i;
1297 timeout -= connect_loop;
1300 connect_loop *= 1.5;
1301 if (connect_loop > timeout)
1302 connect_loop = timeout;
1306 for (i=0; i<num_addrs; i++) {
1307 if (i == resulting_index)
1309 if (sockets[i] >= 0)
1313 if (resulting_index >= 0) {
1314 *fd_index = resulting_index;
1315 *fd = sockets[*fd_index];
1316 set_blocking(*fd, true);
1321 return (resulting_index >= 0);
1323 /****************************************************************************
1324 Open a connected UDP socket to host on port
1325 **************************************************************************/
1327 int open_udp_socket(const char *host, int port)
1329 struct sockaddr_storage ss;
1332 if (!interpret_string_addr(&ss, host, 0)) {
1333 DEBUG(10,("open_udp_socket: can't resolve name %s\n",
1338 res = socket(ss.ss_family, SOCK_DGRAM, 0);
1343 #if defined(HAVE_IPV6)
1344 if (ss.ss_family == AF_INET6) {
1345 struct sockaddr_in6 *psa6;
1346 psa6 = (struct sockaddr_in6 *)&ss;
1347 psa6->sin6_port = htons(port);
1348 if (psa6->sin6_scope_id == 0
1349 && IN6_IS_ADDR_LINKLOCAL(&psa6->sin6_addr)) {
1350 setup_linklocal_scope_id(
1351 (struct sockaddr *)&ss);
1355 if (ss.ss_family == AF_INET) {
1356 struct sockaddr_in *psa;
1357 psa = (struct sockaddr_in *)&ss;
1358 psa->sin_port = htons(port);
1361 if (sys_connect(res,(struct sockaddr *)&ss)) {
1369 /*******************************************************************
1370 Return the IP addr of the remote end of a socket as a string.
1371 Optionally return the struct sockaddr_storage.
1372 ******************************************************************/
1374 static const char *get_peer_addr_internal(int fd,
1376 size_t addr_buf_len,
1377 struct sockaddr *pss,
1380 struct sockaddr_storage ss;
1381 socklen_t length = sizeof(ss);
1383 strlcpy(addr_buf,"0.0.0.0",addr_buf_len);
1390 pss = (struct sockaddr *)&ss;
1394 if (getpeername(fd, (struct sockaddr *)pss, plength) < 0) {
1395 int level = (errno == ENOTCONN) ? 2 : 0;
1396 DEBUG(level, ("getpeername failed. Error was %s\n",
1401 print_sockaddr_len(addr_buf,
1408 /*******************************************************************
1409 Matchname - determine if host name matches IP address. Used to
1410 confirm a hostname lookup to prevent spoof attacks.
1411 ******************************************************************/
1413 static bool matchname(const char *remotehost,
1414 const struct sockaddr *pss,
1417 struct addrinfo *res = NULL;
1418 struct addrinfo *ailist = NULL;
1419 char addr_buf[INET6_ADDRSTRLEN];
1420 bool ret = interpret_string_addr_internal(&ailist,
1422 AI_ADDRCONFIG|AI_CANONNAME);
1424 if (!ret || ailist == NULL) {
1425 DEBUG(3,("matchname: getaddrinfo failed for "
1428 gai_strerror(ret) ));
1433 * Make sure that getaddrinfo() returns the "correct" host name.
1436 if (ailist->ai_canonname == NULL ||
1437 (!strequal(remotehost, ailist->ai_canonname) &&
1438 !strequal(remotehost, "localhost"))) {
1439 DEBUG(0,("matchname: host name/name mismatch: %s != %s\n",
1441 ailist->ai_canonname ?
1442 ailist->ai_canonname : "(NULL)"));
1443 freeaddrinfo(ailist);
1447 /* Look up the host address in the address list we just got. */
1448 for (res = ailist; res; res = res->ai_next) {
1449 if (!res->ai_addr) {
1452 if (sockaddr_equal((const struct sockaddr *)res->ai_addr,
1453 (struct sockaddr *)pss)) {
1454 freeaddrinfo(ailist);
1460 * The host name does not map to the original host address. Perhaps
1461 * someone has compromised a name server. More likely someone botched
1462 * it, but that could be dangerous, too.
1465 DEBUG(0,("matchname: host name/address mismatch: %s != %s\n",
1466 print_sockaddr_len(addr_buf,
1470 ailist->ai_canonname ? ailist->ai_canonname : "(NULL)"));
1473 freeaddrinfo(ailist);
1478 /*******************************************************************
1479 Deal with the singleton cache.
1480 ******************************************************************/
1482 struct name_addr_pair {
1483 struct sockaddr_storage ss;
1487 /*******************************************************************
1488 Lookup a name/addr pair. Returns memory allocated from memcache.
1489 ******************************************************************/
1491 static bool lookup_nc(struct name_addr_pair *nc)
1497 if (!memcache_lookup(
1498 NULL, SINGLETON_CACHE,
1499 data_blob_string_const_null("get_peer_name"),
1504 memcpy(&nc->ss, tmp.data, sizeof(nc->ss));
1505 nc->name = (const char *)tmp.data + sizeof(nc->ss);
1509 /*******************************************************************
1510 Save a name/addr pair.
1511 ******************************************************************/
1513 static void store_nc(const struct name_addr_pair *nc)
1516 size_t namelen = strlen(nc->name);
1518 tmp = data_blob(NULL, sizeof(nc->ss) + namelen + 1);
1522 memcpy(tmp.data, &nc->ss, sizeof(nc->ss));
1523 memcpy(tmp.data+sizeof(nc->ss), nc->name, namelen+1);
1525 memcache_add(NULL, SINGLETON_CACHE,
1526 data_blob_string_const_null("get_peer_name"),
1528 data_blob_free(&tmp);
1531 /*******************************************************************
1532 Return the DNS name of the remote end of a socket.
1533 ******************************************************************/
1535 const char *get_peer_name(int fd, bool force_lookup)
1537 struct name_addr_pair nc;
1538 char addr_buf[INET6_ADDRSTRLEN];
1539 struct sockaddr_storage ss;
1540 socklen_t length = sizeof(ss);
1543 char name_buf[MAX_DNS_NAME_LENGTH];
1544 char tmp_name[MAX_DNS_NAME_LENGTH];
1546 /* reverse lookups can be *very* expensive, and in many
1547 situations won't work because many networks don't link dhcp
1548 with dns. To avoid the delay we avoid the lookup if
1550 if (!lp_hostname_lookups() && (force_lookup == false)) {
1551 length = sizeof(nc.ss);
1552 nc.name = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf),
1553 (struct sockaddr *)&nc.ss, &length);
1556 return nc.name ? nc.name : "UNKNOWN";
1561 memset(&ss, '\0', sizeof(ss));
1562 p = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf), (struct sockaddr *)&ss, &length);
1564 /* it might be the same as the last one - save some DNS work */
1565 if (sockaddr_equal((struct sockaddr *)&ss, (struct sockaddr *)&nc.ss)) {
1566 return nc.name ? nc.name : "UNKNOWN";
1569 /* Not the same. We need to lookup. */
1574 /* Look up the remote host name. */
1575 ret = sys_getnameinfo((struct sockaddr *)&ss,
1584 DEBUG(1,("get_peer_name: getnameinfo failed "
1585 "for %s with error %s\n",
1587 gai_strerror(ret)));
1588 strlcpy(name_buf, p, sizeof(name_buf));
1590 if (!matchname(name_buf, (struct sockaddr *)&ss, length)) {
1591 DEBUG(0,("Matchname failed on %s %s\n",name_buf,p));
1592 strlcpy(name_buf,"UNKNOWN",sizeof(name_buf));
1596 /* can't pass the same source and dest strings in when you
1597 use --enable-developer or the clobber_region() call will
1600 strlcpy(tmp_name, name_buf, sizeof(tmp_name));
1601 alpha_strcpy(name_buf, tmp_name, "_-.", sizeof(name_buf));
1602 if (strstr(name_buf,"..")) {
1603 strlcpy(name_buf, "UNKNOWN", sizeof(name_buf));
1611 return nc.name ? nc.name : "UNKNOWN";
1614 /*******************************************************************
1615 Return the IP addr of the remote end of a socket as a string.
1616 ******************************************************************/
1618 const char *get_peer_addr(int fd, char *addr, size_t addr_len)
1620 return get_peer_addr_internal(fd, addr, addr_len, NULL, NULL);
1623 /*******************************************************************
1624 Create protected unix domain socket.
1626 Some unixes cannot set permissions on a ux-dom-sock, so we
1627 have to make sure that the directory contains the protection
1628 permissions instead.
1629 ******************************************************************/
1631 int create_pipe_sock(const char *socket_dir,
1632 const char *socket_name,
1635 #ifdef HAVE_UNIXSOCKET
1636 struct sockaddr_un sunaddr;
1642 old_umask = umask(0);
1644 /* Create the socket directory or reuse the existing one */
1646 if (lstat(socket_dir, &st) == -1) {
1647 if (errno == ENOENT) {
1648 /* Create directory */
1649 if (mkdir(socket_dir, dir_perms) == -1) {
1650 DEBUG(0, ("error creating socket directory "
1651 "%s: %s\n", socket_dir,
1656 DEBUG(0, ("lstat failed on socket directory %s: %s\n",
1657 socket_dir, strerror(errno)));
1661 /* Check ownership and permission on existing directory */
1662 if (!S_ISDIR(st.st_mode)) {
1663 DEBUG(0, ("socket directory %s isn't a directory\n",
1667 if ((st.st_uid != sec_initial_uid()) ||
1668 ((st.st_mode & 0777) != dir_perms)) {
1669 DEBUG(0, ("invalid permissions on socket directory "
1670 "%s\n", socket_dir));
1675 /* Create the socket file */
1677 sock = socket(AF_UNIX, SOCK_STREAM, 0);
1680 DEBUG(0, ("create_pipe_sock: socket error %s\n",
1685 if (asprintf(&path, "%s/%s", socket_dir, socket_name) == -1) {
1690 memset(&sunaddr, 0, sizeof(sunaddr));
1691 sunaddr.sun_family = AF_UNIX;
1692 strlcpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path));
1694 if (bind(sock, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1) {
1695 DEBUG(0, ("bind failed on pipe socket %s: %s\n", path,
1700 if (listen(sock, 5) == -1) {
1701 DEBUG(0, ("listen failed on pipe socket %s: %s\n", path,
1721 DEBUG(0, ("create_pipe_sock: No Unix sockets on this system\n"));
1723 #endif /* HAVE_UNIXSOCKET */
1726 /****************************************************************************
1727 Get my own canonical name, including domain.
1728 ****************************************************************************/
1730 const char *get_mydnsfullname(void)
1732 struct addrinfo *res = NULL;
1733 char my_hostname[HOST_NAME_MAX];
1737 if (memcache_lookup(NULL, SINGLETON_CACHE,
1738 data_blob_string_const_null("get_mydnsfullname"),
1740 SMB_ASSERT(tmp.length > 0);
1741 return (const char *)tmp.data;
1744 /* get my host name */
1745 if (gethostname(my_hostname, sizeof(my_hostname)) == -1) {
1746 DEBUG(0,("get_mydnsfullname: gethostname failed\n"));
1750 /* Ensure null termination. */
1751 my_hostname[sizeof(my_hostname)-1] = '\0';
1753 ret = interpret_string_addr_internal(&res,
1755 AI_ADDRCONFIG|AI_CANONNAME);
1757 if (!ret || res == NULL) {
1758 DEBUG(3,("get_mydnsfullname: getaddrinfo failed for "
1761 gai_strerror(ret) ));
1766 * Make sure that getaddrinfo() returns the "correct" host name.
1769 if (res->ai_canonname == NULL) {
1770 DEBUG(3,("get_mydnsfullname: failed to get "
1771 "canonical name for %s\n",
1777 /* This copies the data, so we must do a lookup
1778 * afterwards to find the value to return.
1781 memcache_add(NULL, SINGLETON_CACHE,
1782 data_blob_string_const_null("get_mydnsfullname"),
1783 data_blob_string_const_null(res->ai_canonname));
1785 if (!memcache_lookup(NULL, SINGLETON_CACHE,
1786 data_blob_string_const_null("get_mydnsfullname"),
1788 tmp = data_blob_talloc(talloc_tos(), res->ai_canonname,
1789 strlen(res->ai_canonname) + 1);
1794 return (const char *)tmp.data;
1797 /************************************************************
1799 ************************************************************/
1801 bool is_myname_or_ipaddr(const char *s)
1803 TALLOC_CTX *ctx = talloc_tos();
1804 char addr[INET6_ADDRSTRLEN];
1806 const char *dnsname;
1807 char *servername = NULL;
1813 /* Santize the string from '\\name' */
1814 name = talloc_strdup(ctx, s);
1819 servername = strrchr_m(name, '\\' );
1826 /* Optimize for the common case */
1827 if (strequal(servername, global_myname())) {
1831 /* Check for an alias */
1832 if (is_myname(servername)) {
1836 /* Check for loopback */
1837 if (strequal(servername, "127.0.0.1") ||
1838 strequal(servername, "::1")) {
1842 if (strequal(servername, "localhost")) {
1846 /* Maybe it's my dns name */
1847 dnsname = get_mydnsfullname();
1848 if (dnsname && strequal(servername, dnsname)) {
1852 /* Handle possible CNAME records - convert to an IP addr. */
1853 if (!is_ipaddress(servername)) {
1854 /* Use DNS to resolve the name, but only the first address */
1855 struct sockaddr_storage ss;
1856 if (interpret_string_addr(&ss, servername, 0)) {
1857 print_sockaddr(addr,
1864 /* Maybe its an IP address? */
1865 if (is_ipaddress(servername)) {
1866 struct sockaddr_storage ss;
1867 struct iface_struct *nics;
1870 if (!interpret_string_addr(&ss, servername, AI_NUMERICHOST)) {
1874 if (ismyaddr((struct sockaddr *)&ss)) {
1878 if (is_zero_addr((struct sockaddr *)&ss) ||
1879 is_loopback_addr((struct sockaddr *)&ss)) {
1883 n = get_interfaces(talloc_tos(), &nics);
1884 for (i=0; i<n; i++) {
1885 if (sockaddr_equal((struct sockaddr *)&nics[i].ip, (struct sockaddr *)&ss)) {
1897 struct getaddrinfo_state {
1899 const char *service;
1900 const struct addrinfo *hints;
1901 struct addrinfo *res;
1905 static void getaddrinfo_do(void *private_data);
1906 static void getaddrinfo_done(struct tevent_req *subreq);
1908 struct tevent_req *getaddrinfo_send(TALLOC_CTX *mem_ctx,
1909 struct tevent_context *ev,
1910 struct fncall_context *ctx,
1912 const char *service,
1913 const struct addrinfo *hints)
1915 struct tevent_req *req, *subreq;
1916 struct getaddrinfo_state *state;
1918 req = tevent_req_create(mem_ctx, &state, struct getaddrinfo_state);
1924 state->service = service;
1925 state->hints = hints;
1927 subreq = fncall_send(state, ev, ctx, getaddrinfo_do, state);
1928 if (tevent_req_nomem(subreq, req)) {
1929 return tevent_req_post(req, ev);
1931 tevent_req_set_callback(subreq, getaddrinfo_done, req);
1935 static void getaddrinfo_do(void *private_data)
1937 struct getaddrinfo_state *state =
1938 (struct getaddrinfo_state *)private_data;
1940 state->ret = getaddrinfo(state->node, state->service, state->hints,
1944 static void getaddrinfo_done(struct tevent_req *subreq)
1946 struct tevent_req *req = tevent_req_callback_data(
1947 subreq, struct tevent_req);
1950 ret = fncall_recv(subreq, &err);
1951 TALLOC_FREE(subreq);
1953 tevent_req_error(req, err);
1956 tevent_req_done(req);
1959 int getaddrinfo_recv(struct tevent_req *req, struct addrinfo **res)
1961 struct getaddrinfo_state *state = tevent_req_data(
1962 req, struct getaddrinfo_state);
1965 if (tevent_req_is_unix_error(req, &err)) {
1973 if (state->ret == 0) {