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;
445 char addr[INET6_ADDRSTRLEN];
448 /* just checking .... */
458 while (nread < mincnt) {
459 readret = sys_read(fd, buf + nread, maxcnt - nread);
462 DEBUG(5,("read_fd_with_timeout: "
463 "blocking read. EOF from client.\n"));
464 return NT_STATUS_END_OF_FILE;
469 if (fd == get_client_fd()) {
470 /* Try and give an error message
471 * saying what client failed. */
472 DEBUG(0,("read_fd_with_timeout: "
473 "client %s read error = %s.\n",
474 get_peer_addr(fd,addr,sizeof(addr)),
475 strerror(save_errno) ));
477 DEBUG(0,("read_fd_with_timeout: "
478 "read error = %s.\n",
479 strerror(save_errno) ));
481 return map_nt_error_from_unix(save_errno);
488 /* Most difficult - timeout read */
489 /* If this is ever called on a disk file and
490 mincnt is greater then the filesize then
491 system performance will suffer severely as
492 select always returns true on disk files */
494 /* Set initial timeout */
495 timeout.tv_sec = (time_t)(time_out / 1000);
496 timeout.tv_usec = (long)(1000 * (time_out % 1000));
498 for (nread=0; nread < mincnt; ) {
502 selrtn = sys_select_intr(fd+1,&fds,NULL,NULL,&timeout);
507 /* something is wrong. Maybe the socket is dead? */
508 if (fd == get_client_fd()) {
509 /* Try and give an error message saying
510 * what client failed. */
511 DEBUG(0,("read_fd_with_timeout: timeout "
512 "read for client %s. select error = %s.\n",
513 get_peer_addr(fd,addr,sizeof(addr)),
514 strerror(save_errno) ));
516 DEBUG(0,("read_fd_with_timeout: timeout "
517 "read. select error = %s.\n",
518 strerror(save_errno) ));
520 return map_nt_error_from_unix(save_errno);
523 /* Did we timeout ? */
525 DEBUG(10,("read_fd_with_timeout: timeout read. "
526 "select timed out.\n"));
527 return NT_STATUS_IO_TIMEOUT;
530 readret = sys_read(fd, buf+nread, maxcnt-nread);
533 /* we got EOF on the file descriptor */
534 DEBUG(5,("read_fd_with_timeout: timeout read. "
535 "EOF from client.\n"));
536 return NT_STATUS_END_OF_FILE;
541 /* the descriptor is probably dead */
542 if (fd == get_client_fd()) {
543 /* Try and give an error message
544 * saying what client failed. */
545 DEBUG(0,("read_fd_with_timeout: timeout "
546 "read to client %s. read error = %s.\n",
547 get_peer_addr(fd,addr,sizeof(addr)),
548 strerror(save_errno) ));
550 DEBUG(0,("read_fd_with_timeout: timeout "
551 "read. read error = %s.\n",
552 strerror(save_errno) ));
554 return map_nt_error_from_unix(errno);
561 /* Return the number we got */
568 /****************************************************************************
569 Read data from an fd, reading exactly N bytes.
570 NB. This can be called with a non-socket fd, don't add dependencies
572 ****************************************************************************/
574 NTSTATUS read_data(int fd, char *buffer, size_t N)
576 return read_fd_with_timeout(fd, buffer, N, N, 0, NULL);
579 /****************************************************************************
580 Write all data from an iov array
581 NB. This can be called with a non-socket fd, don't add dependencies
583 ****************************************************************************/
585 ssize_t write_data_iov(int fd, const struct iovec *orig_iov, int iovcnt)
591 struct iovec *iov_copy, *iov;
594 for (i=0; i<iovcnt; i++) {
595 to_send += orig_iov[i].iov_len;
598 thistime = sys_writev(fd, orig_iov, iovcnt);
599 if ((thistime <= 0) || (thistime == to_send)) {
605 * We could not send everything in one call. Make a copy of iov that
606 * we can mess with. We keep a copy of the array start in iov_copy for
607 * the TALLOC_FREE, because we're going to modify iov later on,
608 * discarding elements.
611 iov_copy = (struct iovec *)TALLOC_MEMDUP(
612 talloc_tos(), orig_iov, sizeof(struct iovec) * iovcnt);
614 if (iov_copy == NULL) {
620 while (sent < to_send) {
622 * We have to discard "thistime" bytes from the beginning
623 * iov array, "thistime" contains the number of bytes sent
626 while (thistime > 0) {
627 if (thistime < iov[0].iov_len) {
629 (char *)iov[0].iov_base + thistime;
630 iov[0].iov_base = (void *)new_base;
631 iov[0].iov_len -= thistime;
634 thistime -= iov[0].iov_len;
639 thistime = sys_writev(fd, iov, iovcnt);
646 TALLOC_FREE(iov_copy);
650 /****************************************************************************
652 NB. This can be called with a non-socket fd, don't add dependencies
654 ****************************************************************************/
656 ssize_t write_data(int fd, const char *buffer, size_t N)
661 iov.iov_base = CONST_DISCARD(void *, buffer);
664 ret = write_data_iov(fd, &iov, 1);
669 if (fd == get_client_fd()) {
670 char addr[INET6_ADDRSTRLEN];
672 * Try and give an error message saying what client failed.
674 DEBUG(0, ("write_data: write failure in writing to client %s. "
675 "Error %s\n", get_peer_addr(fd,addr,sizeof(addr)),
678 DEBUG(0,("write_data: write failure. Error = %s\n",
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_fd_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_fd_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 struct open_socket_out_state {
895 struct event_context *ev;
896 struct sockaddr_storage ss;
902 static void open_socket_out_connected(struct tevent_req *subreq);
904 static int open_socket_out_state_destructor(struct open_socket_out_state *s)
912 /****************************************************************************
913 Create an outgoing socket. timeout is in milliseconds.
914 **************************************************************************/
916 struct tevent_req *open_socket_out_send(TALLOC_CTX *mem_ctx,
917 struct event_context *ev,
918 const struct sockaddr_storage *pss,
922 char addr[INET6_ADDRSTRLEN];
923 struct tevent_req *result, *subreq;
924 struct open_socket_out_state *state;
927 result = tevent_req_create(mem_ctx, &state,
928 struct open_socket_out_state);
929 if (result == NULL) {
935 state->wait_nsec = 10000;
938 state->fd = socket(state->ss.ss_family, SOCK_STREAM, 0);
939 if (state->fd == -1) {
940 status = map_nt_error_from_unix(errno);
943 talloc_set_destructor(state, open_socket_out_state_destructor);
945 if (!tevent_req_set_endtime(
946 result, ev, timeval_current_ofs(0, timeout*1000))) {
950 #if defined(HAVE_IPV6)
951 if (pss->ss_family == AF_INET6) {
952 struct sockaddr_in6 *psa6;
953 psa6 = (struct sockaddr_in6 *)&state->ss;
954 psa6->sin6_port = htons(port);
955 if (psa6->sin6_scope_id == 0
956 && IN6_IS_ADDR_LINKLOCAL(&psa6->sin6_addr)) {
957 setup_linklocal_scope_id(
958 (struct sockaddr *)&(state->ss));
960 state->salen = sizeof(struct sockaddr_in6);
963 if (pss->ss_family == AF_INET) {
964 struct sockaddr_in *psa;
965 psa = (struct sockaddr_in *)&state->ss;
966 psa->sin_port = htons(port);
967 state->salen = sizeof(struct sockaddr_in);
970 if (pss->ss_family == AF_UNIX) {
971 state->salen = sizeof(struct sockaddr_un);
974 print_sockaddr(addr, sizeof(addr), &state->ss);
975 DEBUG(3,("Connecting to %s at port %u\n", addr, (unsigned int)port));
977 subreq = async_connect_send(state, state->ev, state->fd,
978 (struct sockaddr *)&state->ss,
981 || !tevent_req_set_endtime(
983 timeval_current_ofs(0, state->wait_nsec))) {
986 tevent_req_set_callback(subreq, open_socket_out_connected, result);
990 tevent_req_nterror(result, status);
991 return tevent_req_post(result, ev);
997 static void open_socket_out_connected(struct tevent_req *subreq)
999 struct tevent_req *req =
1000 tevent_req_callback_data(subreq, struct tevent_req);
1001 struct open_socket_out_state *state =
1002 tevent_req_data(req, struct open_socket_out_state);
1006 ret = async_connect_recv(subreq, &sys_errno);
1007 TALLOC_FREE(subreq);
1009 tevent_req_done(req);
1015 (sys_errno == ETIMEDOUT) ||
1017 (sys_errno == EINPROGRESS) ||
1018 (sys_errno == EALREADY) ||
1019 (sys_errno == EAGAIN)) {
1025 if (state->wait_nsec < 250000) {
1026 state->wait_nsec *= 1.5;
1029 subreq = async_connect_send(state, state->ev, state->fd,
1030 (struct sockaddr *)&state->ss,
1032 if (tevent_req_nomem(subreq, req)) {
1035 if (!tevent_req_set_endtime(
1037 timeval_current_ofs(0, state->wait_nsec))) {
1038 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
1041 tevent_req_set_callback(subreq, open_socket_out_connected, req);
1046 if (sys_errno == EISCONN) {
1047 tevent_req_done(req);
1053 tevent_req_nterror(req, map_nt_error_from_unix(sys_errno));
1056 NTSTATUS open_socket_out_recv(struct tevent_req *req, int *pfd)
1058 struct open_socket_out_state *state =
1059 tevent_req_data(req, struct open_socket_out_state);
1062 if (tevent_req_is_nterror(req, &status)) {
1067 return NT_STATUS_OK;
1070 NTSTATUS open_socket_out(const struct sockaddr_storage *pss, uint16_t port,
1071 int timeout, int *pfd)
1073 TALLOC_CTX *frame = talloc_stackframe();
1074 struct event_context *ev;
1075 struct tevent_req *req;
1076 NTSTATUS status = NT_STATUS_NO_MEMORY;
1078 ev = event_context_init(frame);
1083 req = open_socket_out_send(frame, ev, pss, port, timeout);
1087 if (!tevent_req_poll(req, ev)) {
1088 status = NT_STATUS_INTERNAL_ERROR;
1091 status = open_socket_out_recv(req, pfd);
1097 struct open_socket_out_defer_state {
1098 struct event_context *ev;
1099 struct sockaddr_storage ss;
1105 static void open_socket_out_defer_waited(struct tevent_req *subreq);
1106 static void open_socket_out_defer_connected(struct tevent_req *subreq);
1108 struct tevent_req *open_socket_out_defer_send(TALLOC_CTX *mem_ctx,
1109 struct event_context *ev,
1110 struct timeval wait_time,
1111 const struct sockaddr_storage *pss,
1115 struct tevent_req *req, *subreq;
1116 struct open_socket_out_defer_state *state;
1118 req = tevent_req_create(mem_ctx, &state,
1119 struct open_socket_out_defer_state);
1126 state->timeout = timeout;
1128 subreq = tevent_wakeup_send(
1130 timeval_current_ofs(wait_time.tv_sec, wait_time.tv_usec));
1131 if (subreq == NULL) {
1134 tevent_req_set_callback(subreq, open_socket_out_defer_waited, req);
1141 static void open_socket_out_defer_waited(struct tevent_req *subreq)
1143 struct tevent_req *req = tevent_req_callback_data(
1144 subreq, struct tevent_req);
1145 struct open_socket_out_defer_state *state = tevent_req_data(
1146 req, struct open_socket_out_defer_state);
1149 ret = tevent_wakeup_recv(subreq);
1150 TALLOC_FREE(subreq);
1152 tevent_req_nterror(req, NT_STATUS_INTERNAL_ERROR);
1156 subreq = open_socket_out_send(state, state->ev, &state->ss,
1157 state->port, state->timeout);
1158 if (tevent_req_nomem(subreq, req)) {
1161 tevent_req_set_callback(subreq, open_socket_out_defer_connected, req);
1164 static void open_socket_out_defer_connected(struct tevent_req *subreq)
1166 struct tevent_req *req = tevent_req_callback_data(
1167 subreq, struct tevent_req);
1168 struct open_socket_out_defer_state *state = tevent_req_data(
1169 req, struct open_socket_out_defer_state);
1172 status = open_socket_out_recv(subreq, &state->fd);
1173 TALLOC_FREE(subreq);
1174 if (!NT_STATUS_IS_OK(status)) {
1175 tevent_req_nterror(req, status);
1178 tevent_req_done(req);
1181 NTSTATUS open_socket_out_defer_recv(struct tevent_req *req, int *pfd)
1183 struct open_socket_out_defer_state *state = tevent_req_data(
1184 req, struct open_socket_out_defer_state);
1187 if (tevent_req_is_nterror(req, &status)) {
1192 return NT_STATUS_OK;
1195 /*******************************************************************
1196 Create an outgoing TCP socket to the first addr that connects.
1198 This is for simultaneous connection attempts to port 445 and 139 of a host
1199 or for simultatneous connection attempts to multiple DCs at once. We return
1200 a socket fd of the first successful connection.
1202 @param[in] addrs list of Internet addresses and ports to connect to
1203 @param[in] num_addrs number of address/port pairs in the addrs list
1204 @param[in] timeout time after which we stop waiting for a socket connection
1205 to succeed, given in milliseconds
1206 @param[out] fd_index the entry in addrs which we successfully connected to
1207 @param[out] fd fd of the open and connected socket
1208 @return true on a successful connection, false if all connection attempts
1209 failed or we timed out
1210 *******************************************************************/
1212 bool open_any_socket_out(struct sockaddr_storage *addrs, int num_addrs,
1213 int timeout, int *fd_index, int *fd)
1215 int i, resulting_index, res;
1219 fd_set r_fds, wr_fds;
1223 int connect_loop = 10000; /* 10 milliseconds */
1225 timeout *= 1000; /* convert to microseconds */
1227 sockets = SMB_MALLOC_ARRAY(int, num_addrs);
1229 if (sockets == NULL)
1232 resulting_index = -1;
1234 for (i=0; i<num_addrs; i++)
1237 for (i=0; i<num_addrs; i++) {
1238 sockets[i] = socket(addrs[i].ss_family, SOCK_STREAM, 0);
1241 set_blocking(sockets[i], false);
1245 good_connect = false;
1247 for (i=0; i<num_addrs; i++) {
1248 const struct sockaddr * a =
1249 (const struct sockaddr *)&(addrs[i]);
1251 if (sockets[i] == -1)
1254 if (sys_connect(sockets[i], a) == 0) {
1255 /* Rather unlikely as we are non-blocking, but it
1256 * might actually happen. */
1257 resulting_index = i;
1261 if (errno == EINPROGRESS || errno == EALREADY ||
1265 errno == EAGAIN || errno == EINTR) {
1266 /* These are the error messages that something is
1268 good_connect = true;
1269 } else if (errno != 0) {
1270 /* There was a direct error */
1276 if (!good_connect) {
1277 /* All of the connect's resulted in real error conditions */
1281 /* Lets see if any of the connect attempts succeeded */
1287 for (i=0; i<num_addrs; i++) {
1288 if (sockets[i] == -1)
1290 FD_SET(sockets[i], &wr_fds);
1291 FD_SET(sockets[i], &r_fds);
1292 if (sockets[i]>maxfd)
1297 tv.tv_usec = connect_loop;
1299 res = sys_select_intr(maxfd+1, &r_fds, &wr_fds, NULL, &tv);
1307 for (i=0; i<num_addrs; i++) {
1309 if (sockets[i] == -1)
1312 /* Stevens, Network Programming says that if there's a
1313 * successful connect, the socket is only writable. Upon an
1314 * error, it's both readable and writable. */
1316 if (FD_ISSET(sockets[i], &r_fds) &&
1317 FD_ISSET(sockets[i], &wr_fds)) {
1318 /* readable and writable, so it's an error */
1324 if (!FD_ISSET(sockets[i], &r_fds) &&
1325 FD_ISSET(sockets[i], &wr_fds)) {
1326 /* Only writable, so it's connected */
1327 resulting_index = i;
1334 timeout -= connect_loop;
1337 connect_loop *= 1.5;
1338 if (connect_loop > timeout)
1339 connect_loop = timeout;
1343 for (i=0; i<num_addrs; i++) {
1344 if (i == resulting_index)
1346 if (sockets[i] >= 0)
1350 if (resulting_index >= 0) {
1351 *fd_index = resulting_index;
1352 *fd = sockets[*fd_index];
1353 set_blocking(*fd, true);
1358 return (resulting_index >= 0);
1360 /****************************************************************************
1361 Open a connected UDP socket to host on port
1362 **************************************************************************/
1364 int open_udp_socket(const char *host, int port)
1366 struct sockaddr_storage ss;
1369 if (!interpret_string_addr(&ss, host, 0)) {
1370 DEBUG(10,("open_udp_socket: can't resolve name %s\n",
1375 res = socket(ss.ss_family, SOCK_DGRAM, 0);
1380 #if defined(HAVE_IPV6)
1381 if (ss.ss_family == AF_INET6) {
1382 struct sockaddr_in6 *psa6;
1383 psa6 = (struct sockaddr_in6 *)&ss;
1384 psa6->sin6_port = htons(port);
1385 if (psa6->sin6_scope_id == 0
1386 && IN6_IS_ADDR_LINKLOCAL(&psa6->sin6_addr)) {
1387 setup_linklocal_scope_id(
1388 (struct sockaddr *)&ss);
1392 if (ss.ss_family == AF_INET) {
1393 struct sockaddr_in *psa;
1394 psa = (struct sockaddr_in *)&ss;
1395 psa->sin_port = htons(port);
1398 if (sys_connect(res,(struct sockaddr *)&ss)) {
1406 /*******************************************************************
1407 Return the IP addr of the remote end of a socket as a string.
1408 Optionally return the struct sockaddr_storage.
1409 ******************************************************************/
1411 static const char *get_peer_addr_internal(int fd,
1413 size_t addr_buf_len,
1414 struct sockaddr *pss,
1417 struct sockaddr_storage ss;
1418 socklen_t length = sizeof(ss);
1420 strlcpy(addr_buf,"0.0.0.0",addr_buf_len);
1427 pss = (struct sockaddr *)&ss;
1431 if (getpeername(fd, (struct sockaddr *)pss, plength) < 0) {
1432 int level = (errno == ENOTCONN) ? 2 : 0;
1433 DEBUG(level, ("getpeername failed. Error was %s\n",
1438 print_sockaddr_len(addr_buf,
1445 /*******************************************************************
1446 Matchname - determine if host name matches IP address. Used to
1447 confirm a hostname lookup to prevent spoof attacks.
1448 ******************************************************************/
1450 static bool matchname(const char *remotehost,
1451 const struct sockaddr *pss,
1454 struct addrinfo *res = NULL;
1455 struct addrinfo *ailist = NULL;
1456 char addr_buf[INET6_ADDRSTRLEN];
1457 bool ret = interpret_string_addr_internal(&ailist,
1459 AI_ADDRCONFIG|AI_CANONNAME);
1461 if (!ret || ailist == NULL) {
1462 DEBUG(3,("matchname: getaddrinfo failed for "
1465 gai_strerror(ret) ));
1470 * Make sure that getaddrinfo() returns the "correct" host name.
1473 if (ailist->ai_canonname == NULL ||
1474 (!strequal(remotehost, ailist->ai_canonname) &&
1475 !strequal(remotehost, "localhost"))) {
1476 DEBUG(0,("matchname: host name/name mismatch: %s != %s\n",
1478 ailist->ai_canonname ?
1479 ailist->ai_canonname : "(NULL)"));
1480 freeaddrinfo(ailist);
1484 /* Look up the host address in the address list we just got. */
1485 for (res = ailist; res; res = res->ai_next) {
1486 if (!res->ai_addr) {
1489 if (sockaddr_equal((const struct sockaddr *)res->ai_addr,
1490 (struct sockaddr *)pss)) {
1491 freeaddrinfo(ailist);
1497 * The host name does not map to the original host address. Perhaps
1498 * someone has compromised a name server. More likely someone botched
1499 * it, but that could be dangerous, too.
1502 DEBUG(0,("matchname: host name/address mismatch: %s != %s\n",
1503 print_sockaddr_len(addr_buf,
1507 ailist->ai_canonname ? ailist->ai_canonname : "(NULL)"));
1510 freeaddrinfo(ailist);
1515 /*******************************************************************
1516 Deal with the singleton cache.
1517 ******************************************************************/
1519 struct name_addr_pair {
1520 struct sockaddr_storage ss;
1524 /*******************************************************************
1525 Lookup a name/addr pair. Returns memory allocated from memcache.
1526 ******************************************************************/
1528 static bool lookup_nc(struct name_addr_pair *nc)
1534 if (!memcache_lookup(
1535 NULL, SINGLETON_CACHE,
1536 data_blob_string_const_null("get_peer_name"),
1541 memcpy(&nc->ss, tmp.data, sizeof(nc->ss));
1542 nc->name = (const char *)tmp.data + sizeof(nc->ss);
1546 /*******************************************************************
1547 Save a name/addr pair.
1548 ******************************************************************/
1550 static void store_nc(const struct name_addr_pair *nc)
1553 size_t namelen = strlen(nc->name);
1555 tmp = data_blob(NULL, sizeof(nc->ss) + namelen + 1);
1559 memcpy(tmp.data, &nc->ss, sizeof(nc->ss));
1560 memcpy(tmp.data+sizeof(nc->ss), nc->name, namelen+1);
1562 memcache_add(NULL, SINGLETON_CACHE,
1563 data_blob_string_const_null("get_peer_name"),
1565 data_blob_free(&tmp);
1568 /*******************************************************************
1569 Return the DNS name of the remote end of a socket.
1570 ******************************************************************/
1572 const char *get_peer_name(int fd, bool force_lookup)
1574 struct name_addr_pair nc;
1575 char addr_buf[INET6_ADDRSTRLEN];
1576 struct sockaddr_storage ss;
1577 socklen_t length = sizeof(ss);
1580 char name_buf[MAX_DNS_NAME_LENGTH];
1581 char tmp_name[MAX_DNS_NAME_LENGTH];
1583 /* reverse lookups can be *very* expensive, and in many
1584 situations won't work because many networks don't link dhcp
1585 with dns. To avoid the delay we avoid the lookup if
1587 if (!lp_hostname_lookups() && (force_lookup == false)) {
1588 length = sizeof(nc.ss);
1589 nc.name = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf),
1590 (struct sockaddr *)&nc.ss, &length);
1593 return nc.name ? nc.name : "UNKNOWN";
1598 memset(&ss, '\0', sizeof(ss));
1599 p = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf), (struct sockaddr *)&ss, &length);
1601 /* it might be the same as the last one - save some DNS work */
1602 if (sockaddr_equal((struct sockaddr *)&ss, (struct sockaddr *)&nc.ss)) {
1603 return nc.name ? nc.name : "UNKNOWN";
1606 /* Not the same. We need to lookup. */
1611 /* Look up the remote host name. */
1612 ret = sys_getnameinfo((struct sockaddr *)&ss,
1621 DEBUG(1,("get_peer_name: getnameinfo failed "
1622 "for %s with error %s\n",
1624 gai_strerror(ret)));
1625 strlcpy(name_buf, p, sizeof(name_buf));
1627 if (!matchname(name_buf, (struct sockaddr *)&ss, length)) {
1628 DEBUG(0,("Matchname failed on %s %s\n",name_buf,p));
1629 strlcpy(name_buf,"UNKNOWN",sizeof(name_buf));
1633 /* can't pass the same source and dest strings in when you
1634 use --enable-developer or the clobber_region() call will
1637 strlcpy(tmp_name, name_buf, sizeof(tmp_name));
1638 alpha_strcpy(name_buf, tmp_name, "_-.", sizeof(name_buf));
1639 if (strstr(name_buf,"..")) {
1640 strlcpy(name_buf, "UNKNOWN", sizeof(name_buf));
1648 return nc.name ? nc.name : "UNKNOWN";
1651 /*******************************************************************
1652 Return the IP addr of the remote end of a socket as a string.
1653 ******************************************************************/
1655 const char *get_peer_addr(int fd, char *addr, size_t addr_len)
1657 return get_peer_addr_internal(fd, addr, addr_len, NULL, NULL);
1660 /*******************************************************************
1661 Create protected unix domain socket.
1663 Some unixes cannot set permissions on a ux-dom-sock, so we
1664 have to make sure that the directory contains the protection
1665 permissions instead.
1666 ******************************************************************/
1668 int create_pipe_sock(const char *socket_dir,
1669 const char *socket_name,
1672 #ifdef HAVE_UNIXSOCKET
1673 struct sockaddr_un sunaddr;
1679 old_umask = umask(0);
1681 /* Create the socket directory or reuse the existing one */
1683 if (lstat(socket_dir, &st) == -1) {
1684 if (errno == ENOENT) {
1685 /* Create directory */
1686 if (mkdir(socket_dir, dir_perms) == -1) {
1687 DEBUG(0, ("error creating socket directory "
1688 "%s: %s\n", socket_dir,
1693 DEBUG(0, ("lstat failed on socket directory %s: %s\n",
1694 socket_dir, strerror(errno)));
1698 /* Check ownership and permission on existing directory */
1699 if (!S_ISDIR(st.st_mode)) {
1700 DEBUG(0, ("socket directory %s isn't a directory\n",
1704 if ((st.st_uid != sec_initial_uid()) ||
1705 ((st.st_mode & 0777) != dir_perms)) {
1706 DEBUG(0, ("invalid permissions on socket directory "
1707 "%s\n", socket_dir));
1712 /* Create the socket file */
1714 sock = socket(AF_UNIX, SOCK_STREAM, 0);
1717 DEBUG(0, ("create_pipe_sock: socket error %s\n",
1722 if (asprintf(&path, "%s/%s", socket_dir, socket_name) == -1) {
1727 memset(&sunaddr, 0, sizeof(sunaddr));
1728 sunaddr.sun_family = AF_UNIX;
1729 strlcpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path));
1731 if (bind(sock, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1) {
1732 DEBUG(0, ("bind failed on pipe socket %s: %s\n", path,
1737 if (listen(sock, 5) == -1) {
1738 DEBUG(0, ("listen failed on pipe socket %s: %s\n", path,
1758 DEBUG(0, ("create_pipe_sock: No Unix sockets on this system\n"));
1760 #endif /* HAVE_UNIXSOCKET */
1763 /****************************************************************************
1764 Get my own canonical name, including domain.
1765 ****************************************************************************/
1767 const char *get_mydnsfullname(void)
1769 struct addrinfo *res = NULL;
1770 char my_hostname[HOST_NAME_MAX];
1774 if (memcache_lookup(NULL, SINGLETON_CACHE,
1775 data_blob_string_const_null("get_mydnsfullname"),
1777 SMB_ASSERT(tmp.length > 0);
1778 return (const char *)tmp.data;
1781 /* get my host name */
1782 if (gethostname(my_hostname, sizeof(my_hostname)) == -1) {
1783 DEBUG(0,("get_mydnsfullname: gethostname failed\n"));
1787 /* Ensure null termination. */
1788 my_hostname[sizeof(my_hostname)-1] = '\0';
1790 ret = interpret_string_addr_internal(&res,
1792 AI_ADDRCONFIG|AI_CANONNAME);
1794 if (!ret || res == NULL) {
1795 DEBUG(3,("get_mydnsfullname: getaddrinfo failed for "
1798 gai_strerror(ret) ));
1803 * Make sure that getaddrinfo() returns the "correct" host name.
1806 if (res->ai_canonname == NULL) {
1807 DEBUG(3,("get_mydnsfullname: failed to get "
1808 "canonical name for %s\n",
1814 /* This copies the data, so we must do a lookup
1815 * afterwards to find the value to return.
1818 memcache_add(NULL, SINGLETON_CACHE,
1819 data_blob_string_const_null("get_mydnsfullname"),
1820 data_blob_string_const_null(res->ai_canonname));
1822 if (!memcache_lookup(NULL, SINGLETON_CACHE,
1823 data_blob_string_const_null("get_mydnsfullname"),
1825 tmp = data_blob_talloc(talloc_tos(), res->ai_canonname,
1826 strlen(res->ai_canonname) + 1);
1831 return (const char *)tmp.data;
1834 /************************************************************
1836 ************************************************************/
1838 bool is_myname_or_ipaddr(const char *s)
1840 TALLOC_CTX *ctx = talloc_tos();
1841 char addr[INET6_ADDRSTRLEN];
1843 const char *dnsname;
1844 char *servername = NULL;
1850 /* Santize the string from '\\name' */
1851 name = talloc_strdup(ctx, s);
1856 servername = strrchr_m(name, '\\' );
1863 /* Optimize for the common case */
1864 if (strequal(servername, global_myname())) {
1868 /* Check for an alias */
1869 if (is_myname(servername)) {
1873 /* Check for loopback */
1874 if (strequal(servername, "127.0.0.1") ||
1875 strequal(servername, "::1")) {
1879 if (strequal(servername, "localhost")) {
1883 /* Maybe it's my dns name */
1884 dnsname = get_mydnsfullname();
1885 if (dnsname && strequal(servername, dnsname)) {
1889 /* Handle possible CNAME records - convert to an IP addr. */
1890 if (!is_ipaddress(servername)) {
1891 /* Use DNS to resolve the name, but only the first address */
1892 struct sockaddr_storage ss;
1893 if (interpret_string_addr(&ss, servername, 0)) {
1894 print_sockaddr(addr,
1901 /* Maybe its an IP address? */
1902 if (is_ipaddress(servername)) {
1903 struct sockaddr_storage ss;
1904 struct iface_struct *nics;
1907 if (!interpret_string_addr(&ss, servername, AI_NUMERICHOST)) {
1911 if (ismyaddr((struct sockaddr *)&ss)) {
1915 if (is_zero_addr((struct sockaddr *)&ss) ||
1916 is_loopback_addr((struct sockaddr *)&ss)) {
1920 n = get_interfaces(talloc_tos(), &nics);
1921 for (i=0; i<n; i++) {
1922 if (sockaddr_equal((struct sockaddr *)&nics[i].ip, (struct sockaddr *)&ss)) {
1934 struct getaddrinfo_state {
1936 const char *service;
1937 const struct addrinfo *hints;
1938 struct addrinfo *res;
1942 static void getaddrinfo_do(void *private_data);
1943 static void getaddrinfo_done(struct tevent_req *subreq);
1945 struct tevent_req *getaddrinfo_send(TALLOC_CTX *mem_ctx,
1946 struct tevent_context *ev,
1947 struct fncall_context *ctx,
1949 const char *service,
1950 const struct addrinfo *hints)
1952 struct tevent_req *req, *subreq;
1953 struct getaddrinfo_state *state;
1955 req = tevent_req_create(mem_ctx, &state, struct getaddrinfo_state);
1961 state->service = service;
1962 state->hints = hints;
1964 subreq = fncall_send(state, ev, ctx, getaddrinfo_do, state);
1965 if (tevent_req_nomem(subreq, req)) {
1966 return tevent_req_post(req, ev);
1968 tevent_req_set_callback(subreq, getaddrinfo_done, req);
1972 static void getaddrinfo_do(void *private_data)
1974 struct getaddrinfo_state *state =
1975 (struct getaddrinfo_state *)private_data;
1977 state->ret = getaddrinfo(state->node, state->service, state->hints,
1981 static void getaddrinfo_done(struct tevent_req *subreq)
1983 struct tevent_req *req = tevent_req_callback_data(
1984 subreq, struct tevent_req);
1987 ret = fncall_recv(subreq, &err);
1988 TALLOC_FREE(subreq);
1990 tevent_req_error(req, err);
1993 tevent_req_done(req);
1996 int getaddrinfo_recv(struct tevent_req *req, struct addrinfo **res)
1998 struct getaddrinfo_state *state = tevent_req_data(
1999 req, struct getaddrinfo_state);
2002 if (tevent_req_is_unix_error(req, &err)) {
2010 if (state->ret == 0) {