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/>.
23 #include "system/filesys.h"
25 #include "../lib/async_req/async_sock.h"
26 #include "../lib/util/select.h"
27 #include "interfaces.h"
29 /****************************************************************************
30 Get a port number in host byte order from a sockaddr_storage.
31 ****************************************************************************/
33 uint16_t get_sockaddr_port(const struct sockaddr_storage *pss)
37 if (pss->ss_family != AF_INET) {
38 #if defined(HAVE_IPV6)
40 const struct sockaddr_in6 *sa6 =
41 (const struct sockaddr_in6 *)pss;
42 port = ntohs(sa6->sin6_port);
45 const struct sockaddr_in *sa =
46 (const struct sockaddr_in *)pss;
47 port = ntohs(sa->sin_port);
52 /****************************************************************************
53 Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
54 ****************************************************************************/
56 static char *print_sockaddr_len(char *dest,
58 const struct sockaddr *psa,
64 (void)sys_getnameinfo(psa,
72 /****************************************************************************
73 Print out an IPv4 or IPv6 address from a struct sockaddr_storage.
74 ****************************************************************************/
76 char *print_sockaddr(char *dest,
78 const struct sockaddr_storage *psa)
80 return print_sockaddr_len(dest, destlen, (struct sockaddr *)psa,
81 sizeof(struct sockaddr_storage));
84 /****************************************************************************
85 Print out a canonical IPv4 or IPv6 address from a struct sockaddr_storage.
86 ****************************************************************************/
88 char *print_canonical_sockaddr(TALLOC_CTX *ctx,
89 const struct sockaddr_storage *pss)
91 char addr[INET6_ADDRSTRLEN];
95 /* Linux getnameinfo() man pages says port is unitialized if
96 service name is NULL. */
98 ret = sys_getnameinfo((const struct sockaddr *)pss,
99 sizeof(struct sockaddr_storage),
107 if (pss->ss_family != AF_INET) {
108 #if defined(HAVE_IPV6)
109 dest = talloc_asprintf(ctx, "[%s]", addr);
114 dest = talloc_asprintf(ctx, "%s", addr);
120 /****************************************************************************
121 Return the string of an IP address (IPv4 or IPv6).
122 ****************************************************************************/
124 static const char *get_socket_addr(int fd, char *addr_buf, size_t addr_len)
126 struct sockaddr_storage sa;
127 socklen_t length = sizeof(sa);
129 /* Ok, returning a hard coded IPv4 address
130 * is bogus, but it's just as bogus as a
131 * zero IPv6 address. No good choice here.
134 strlcpy(addr_buf, "0.0.0.0", addr_len);
140 if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
141 DEBUG(0,("getsockname failed. Error was %s\n",
146 return print_sockaddr_len(addr_buf, addr_len, (struct sockaddr *)&sa, length);
149 /****************************************************************************
150 Return the port number we've bound to on a socket.
151 ****************************************************************************/
153 int get_socket_port(int fd)
155 struct sockaddr_storage sa;
156 socklen_t length = sizeof(sa);
162 if (getsockname(fd, (struct sockaddr *)&sa, &length) < 0) {
163 int level = (errno == ENOTCONN) ? 2 : 0;
164 DEBUG(level, ("getsockname failed. Error was %s\n",
169 #if defined(HAVE_IPV6)
170 if (sa.ss_family == AF_INET6) {
171 return ntohs(((struct sockaddr_in6 *)&sa)->sin6_port);
174 if (sa.ss_family == AF_INET) {
175 return ntohs(((struct sockaddr_in *)&sa)->sin_port);
180 const char *client_name(int fd)
182 return get_peer_name(fd,false);
185 const char *client_addr(int fd, char *addr, size_t addrlen)
187 return get_peer_addr(fd,addr,addrlen);
190 const char *client_socket_addr(int fd, char *addr, size_t addr_len)
192 return get_socket_addr(fd, addr, addr_len);
196 /* Not currently used. JRA. */
197 int client_socket_port(int fd)
199 return get_socket_port(fd);
203 /****************************************************************************
204 Accessor functions to make thread-safe code easier later...
205 ****************************************************************************/
207 void set_smb_read_error(enum smb_read_errors *pre,
208 enum smb_read_errors newerr)
215 void cond_set_smb_read_error(enum smb_read_errors *pre,
216 enum smb_read_errors newerr)
218 if (pre && *pre == SMB_READ_OK) {
223 /****************************************************************************
224 Determine if a file descriptor is in fact a socket.
225 ****************************************************************************/
227 bool is_a_socket(int fd)
232 return(getsockopt(fd, SOL_SOCKET, SO_TYPE, (char *)&v, &l) == 0);
235 enum SOCK_OPT_TYPES {OPT_BOOL,OPT_INT,OPT_ON};
237 typedef struct smb_socket_option {
245 static const smb_socket_option socket_options[] = {
246 {"SO_KEEPALIVE", SOL_SOCKET, SO_KEEPALIVE, 0, OPT_BOOL},
247 {"SO_REUSEADDR", SOL_SOCKET, SO_REUSEADDR, 0, OPT_BOOL},
248 {"SO_BROADCAST", SOL_SOCKET, SO_BROADCAST, 0, OPT_BOOL},
250 {"TCP_NODELAY", IPPROTO_TCP, TCP_NODELAY, 0, OPT_BOOL},
253 {"TCP_KEEPCNT", IPPROTO_TCP, TCP_KEEPCNT, 0, OPT_INT},
256 {"TCP_KEEPIDLE", IPPROTO_TCP, TCP_KEEPIDLE, 0, OPT_INT},
259 {"TCP_KEEPINTVL", IPPROTO_TCP, TCP_KEEPINTVL, 0, OPT_INT},
261 #ifdef IPTOS_LOWDELAY
262 {"IPTOS_LOWDELAY", IPPROTO_IP, IP_TOS, IPTOS_LOWDELAY, OPT_ON},
264 #ifdef IPTOS_THROUGHPUT
265 {"IPTOS_THROUGHPUT", IPPROTO_IP, IP_TOS, IPTOS_THROUGHPUT, OPT_ON},
268 {"SO_REUSEPORT", SOL_SOCKET, SO_REUSEPORT, 0, OPT_BOOL},
271 {"SO_SNDBUF", SOL_SOCKET, SO_SNDBUF, 0, OPT_INT},
274 {"SO_RCVBUF", SOL_SOCKET, SO_RCVBUF, 0, OPT_INT},
277 {"SO_SNDLOWAT", SOL_SOCKET, SO_SNDLOWAT, 0, OPT_INT},
280 {"SO_RCVLOWAT", SOL_SOCKET, SO_RCVLOWAT, 0, OPT_INT},
283 {"SO_SNDTIMEO", SOL_SOCKET, SO_SNDTIMEO, 0, OPT_INT},
286 {"SO_RCVTIMEO", SOL_SOCKET, SO_RCVTIMEO, 0, OPT_INT},
289 {"TCP_FASTACK", IPPROTO_TCP, TCP_FASTACK, 0, OPT_INT},
292 {"TCP_QUICKACK", IPPROTO_TCP, TCP_QUICKACK, 0, OPT_BOOL},
294 #ifdef TCP_KEEPALIVE_THRESHOLD
295 {"TCP_KEEPALIVE_THRESHOLD", IPPROTO_TCP, TCP_KEEPALIVE_THRESHOLD, 0, OPT_INT},
297 #ifdef TCP_KEEPALIVE_ABORT_THRESHOLD
298 {"TCP_KEEPALIVE_ABORT_THRESHOLD", IPPROTO_TCP, TCP_KEEPALIVE_ABORT_THRESHOLD, 0, OPT_INT},
302 /****************************************************************************
303 Print socket options.
304 ****************************************************************************/
306 static void print_socket_options(int s)
310 const smb_socket_option *p = &socket_options[0];
312 /* wrapped in if statement to prevent streams
313 * leak in SCO Openserver 5.0 */
314 /* reported on samba-technical --jerry */
315 if ( DEBUGLEVEL >= 5 ) {
316 DEBUG(5,("Socket options:\n"));
317 for (; p->name != NULL; p++) {
318 if (getsockopt(s, p->level, p->option,
319 (void *)&value, &vlen) == -1) {
320 DEBUGADD(5,("\tCould not test socket option %s.\n",
323 DEBUGADD(5,("\t%s = %d\n",
330 /****************************************************************************
331 Set user socket options.
332 ****************************************************************************/
334 void set_socket_options(int fd, const char *options)
336 TALLOC_CTX *ctx = talloc_stackframe();
339 while (next_token_talloc(ctx, &options, &tok," \t,")) {
343 bool got_value = false;
345 if ((p = strchr_m(tok,'='))) {
351 for (i=0;socket_options[i].name;i++)
352 if (strequal(socket_options[i].name,tok))
355 if (!socket_options[i].name) {
356 DEBUG(0,("Unknown socket option %s\n",tok));
360 switch (socket_options[i].opttype) {
363 ret = setsockopt(fd,socket_options[i].level,
364 socket_options[i].option,
365 (char *)&value,sizeof(int));
370 DEBUG(0,("syntax error - %s "
371 "does not take a value\n",tok));
374 int on = socket_options[i].value;
375 ret = setsockopt(fd,socket_options[i].level,
376 socket_options[i].option,
377 (char *)&on,sizeof(int));
383 /* be aware that some systems like Solaris return
384 * EINVAL to a setsockopt() call when the client
385 * sent a RST previously - no need to worry */
386 DEBUG(2,("Failed to set socket option %s (Error %s)\n",
387 tok, strerror(errno) ));
392 print_socket_options(fd);
395 /****************************************************************************
397 ****************************************************************************/
399 ssize_t read_udp_v4_socket(int fd,
402 struct sockaddr_storage *psa)
405 socklen_t socklen = sizeof(*psa);
406 struct sockaddr_in *si = (struct sockaddr_in *)psa;
408 memset((char *)psa,'\0',socklen);
410 ret = (ssize_t)sys_recvfrom(fd,buf,len,0,
411 (struct sockaddr *)psa,&socklen);
413 /* Don't print a low debug error for a non-blocking socket. */
414 if (errno == EAGAIN) {
415 DEBUG(10,("read_udp_v4_socket: returned EAGAIN\n"));
417 DEBUG(2,("read_udp_v4_socket: failed. errno=%s\n",
423 if (psa->ss_family != AF_INET) {
424 DEBUG(2,("read_udp_v4_socket: invalid address family %d "
425 "(not IPv4)\n", (int)psa->ss_family));
429 DEBUG(10,("read_udp_v4_socket: ip %s port %d read: %lu\n",
430 inet_ntoa(si->sin_addr),
432 (unsigned long)ret));
437 /****************************************************************************
438 Read data from a file descriptor with a timout in msec.
439 mincount = if timeout, minimum to read before returning
440 maxcount = number to be read.
441 time_out = timeout in milliseconds
442 NB. This can be called with a non-socket fd, don't change
443 sys_read() to sys_recv() or other socket call.
444 ****************************************************************************/
446 NTSTATUS read_fd_with_timeout(int fd, char *buf,
447 size_t mincnt, size_t maxcnt,
448 unsigned int time_out,
455 /* just checking .... */
465 while (nread < mincnt) {
466 readret = sys_read(fd, buf + nread, maxcnt - nread);
469 DEBUG(5,("read_fd_with_timeout: "
470 "blocking read. EOF from client.\n"));
471 return NT_STATUS_END_OF_FILE;
475 return map_nt_error_from_unix(errno);
482 /* Most difficult - timeout read */
483 /* If this is ever called on a disk file and
484 mincnt is greater then the filesize then
485 system performance will suffer severely as
486 select always returns true on disk files */
488 for (nread=0; nread < mincnt; ) {
491 pollrtn = poll_intr_one_fd(fd, POLLIN|POLLHUP, time_out,
496 return map_nt_error_from_unix(errno);
499 /* Did we timeout ? */
500 if ((pollrtn == 0) ||
501 ((revents & (POLLIN|POLLHUP|POLLERR)) == 0)) {
502 DEBUG(10,("read_fd_with_timeout: timeout read. "
503 "select timed out.\n"));
504 return NT_STATUS_IO_TIMEOUT;
507 readret = sys_read(fd, buf+nread, maxcnt-nread);
510 /* we got EOF on the file descriptor */
511 DEBUG(5,("read_fd_with_timeout: timeout read. "
512 "EOF from client.\n"));
513 return NT_STATUS_END_OF_FILE;
517 return map_nt_error_from_unix(errno);
524 /* Return the number we got */
531 /****************************************************************************
532 Read data from an fd, reading exactly N bytes.
533 NB. This can be called with a non-socket fd, don't add dependencies
535 ****************************************************************************/
537 NTSTATUS read_data(int fd, char *buffer, size_t N)
539 return read_fd_with_timeout(fd, buffer, N, N, 0, NULL);
542 /****************************************************************************
543 Write all data from an iov array
544 NB. This can be called with a non-socket fd, don't add dependencies
546 ****************************************************************************/
548 ssize_t write_data_iov(int fd, const struct iovec *orig_iov, int iovcnt)
554 struct iovec *iov_copy, *iov;
557 for (i=0; i<iovcnt; i++) {
558 to_send += orig_iov[i].iov_len;
561 thistime = sys_writev(fd, orig_iov, iovcnt);
562 if ((thistime <= 0) || (thistime == to_send)) {
568 * We could not send everything in one call. Make a copy of iov that
569 * we can mess with. We keep a copy of the array start in iov_copy for
570 * the TALLOC_FREE, because we're going to modify iov later on,
571 * discarding elements.
574 iov_copy = (struct iovec *)TALLOC_MEMDUP(
575 talloc_tos(), orig_iov, sizeof(struct iovec) * iovcnt);
577 if (iov_copy == NULL) {
583 while (sent < to_send) {
585 * We have to discard "thistime" bytes from the beginning
586 * iov array, "thistime" contains the number of bytes sent
589 while (thistime > 0) {
590 if (thistime < iov[0].iov_len) {
592 (char *)iov[0].iov_base + thistime;
593 iov[0].iov_base = (void *)new_base;
594 iov[0].iov_len -= thistime;
597 thistime -= iov[0].iov_len;
602 thistime = sys_writev(fd, iov, iovcnt);
609 TALLOC_FREE(iov_copy);
613 /****************************************************************************
615 NB. This can be called with a non-socket fd, don't add dependencies
617 ****************************************************************************/
619 ssize_t write_data(int fd, const char *buffer, size_t N)
623 iov.iov_base = CONST_DISCARD(void *, buffer);
625 return write_data_iov(fd, &iov, 1);
628 /****************************************************************************
629 Send a keepalive packet (rfc1002).
630 ****************************************************************************/
632 bool send_keepalive(int client)
634 unsigned char buf[4];
636 buf[0] = SMBkeepalive;
637 buf[1] = buf[2] = buf[3] = 0;
639 return(write_data(client,(char *)buf,4) == 4);
642 /****************************************************************************
643 Read 4 bytes of a smb packet and return the smb length of the packet.
644 Store the result in the buffer.
645 This version of the function will return a length of zero on receiving
647 Timeout is in milliseconds.
648 ****************************************************************************/
650 NTSTATUS read_smb_length_return_keepalive(int fd, char *inbuf,
651 unsigned int timeout,
657 status = read_fd_with_timeout(fd, inbuf, 4, 4, timeout, NULL);
659 if (!NT_STATUS_IS_OK(status)) {
663 *len = smb_len(inbuf);
664 msg_type = CVAL(inbuf,0);
666 if (msg_type == SMBkeepalive) {
667 DEBUG(5,("Got keepalive packet\n"));
670 DEBUG(10,("got smb length of %lu\n",(unsigned long)(*len)));
675 /****************************************************************************
676 Read an smb from a fd.
677 The timeout is in milliseconds.
678 This function will return on receipt of a session keepalive packet.
679 maxlen is the max number of bytes to return, not including the 4 byte
680 length. If zero it means buflen limit.
681 Doesn't check the MAC on signed packets.
682 ****************************************************************************/
684 NTSTATUS receive_smb_raw(int fd, char *buffer, size_t buflen, unsigned int timeout,
685 size_t maxlen, size_t *p_len)
690 status = read_smb_length_return_keepalive(fd,buffer,timeout,&len);
692 if (!NT_STATUS_IS_OK(status)) {
693 DEBUG(0, ("read_fd_with_timeout failed, read "
694 "error = %s.\n", nt_errstr(status)));
699 DEBUG(0,("Invalid packet length! (%lu bytes).\n",
700 (unsigned long)len));
701 return NT_STATUS_INVALID_PARAMETER;
706 len = MIN(len,maxlen);
709 status = read_fd_with_timeout(
710 fd, buffer+4, len, len, timeout, &len);
712 if (!NT_STATUS_IS_OK(status)) {
713 DEBUG(0, ("read_fd_with_timeout failed, read error = "
714 "%s.\n", nt_errstr(status)));
718 /* not all of samba3 properly checks for packet-termination
719 * of strings. This ensures that we don't run off into
721 SSVAL(buffer+4,len, 0);
728 /****************************************************************************
729 Open a socket of the specified type, port, and address for incoming data.
730 ****************************************************************************/
732 int open_socket_in(int type,
735 const struct sockaddr_storage *psock,
738 struct sockaddr_storage sock;
740 socklen_t slen = sizeof(struct sockaddr_in);
744 #if defined(HAVE_IPV6)
745 if (sock.ss_family == AF_INET6) {
746 ((struct sockaddr_in6 *)&sock)->sin6_port = htons(port);
747 slen = sizeof(struct sockaddr_in6);
750 if (sock.ss_family == AF_INET) {
751 ((struct sockaddr_in *)&sock)->sin_port = htons(port);
754 res = socket(sock.ss_family, type, 0 );
757 dbgtext( "open_socket_in(): socket() call failed: " );
758 dbgtext( "%s\n", strerror( errno ) );
763 /* This block sets/clears the SO_REUSEADDR and possibly SO_REUSEPORT. */
765 int val = rebind ? 1 : 0;
766 if( setsockopt(res,SOL_SOCKET,SO_REUSEADDR,
767 (char *)&val,sizeof(val)) == -1 ) {
768 if( DEBUGLVL( dlevel ) ) {
769 dbgtext( "open_socket_in(): setsockopt: " );
770 dbgtext( "SO_REUSEADDR = %s ",
771 val?"true":"false" );
772 dbgtext( "on port %d failed ", port );
773 dbgtext( "with error = %s\n", strerror(errno) );
777 if( setsockopt(res,SOL_SOCKET,SO_REUSEPORT,
778 (char *)&val,sizeof(val)) == -1 ) {
779 if( DEBUGLVL( dlevel ) ) {
780 dbgtext( "open_socket_in(): setsockopt: ");
781 dbgtext( "SO_REUSEPORT = %s ",
783 dbgtext( "on port %d failed ", port);
784 dbgtext( "with error = %s\n", strerror(errno));
787 #endif /* SO_REUSEPORT */
790 /* now we've got a socket - we need to bind it */
791 if (bind(res, (struct sockaddr *)&sock, slen) == -1 ) {
792 if( DEBUGLVL(dlevel) && (port == SMB_PORT1 ||
793 port == SMB_PORT2 || port == NMB_PORT) ) {
794 char addr[INET6_ADDRSTRLEN];
795 print_sockaddr(addr, sizeof(addr),
797 dbgtext( "bind failed on port %d ", port);
798 dbgtext( "socket_addr = %s.\n", addr);
799 dbgtext( "Error = %s\n", strerror(errno));
805 DEBUG( 10, ( "bind succeeded on port %d\n", port ) );
809 struct open_socket_out_state {
811 struct event_context *ev;
812 struct sockaddr_storage ss;
818 static void open_socket_out_connected(struct tevent_req *subreq);
820 static int open_socket_out_state_destructor(struct open_socket_out_state *s)
828 /****************************************************************************
829 Create an outgoing socket. timeout is in milliseconds.
830 **************************************************************************/
832 struct tevent_req *open_socket_out_send(TALLOC_CTX *mem_ctx,
833 struct event_context *ev,
834 const struct sockaddr_storage *pss,
838 char addr[INET6_ADDRSTRLEN];
839 struct tevent_req *result, *subreq;
840 struct open_socket_out_state *state;
843 result = tevent_req_create(mem_ctx, &state,
844 struct open_socket_out_state);
845 if (result == NULL) {
851 state->wait_nsec = 10000;
854 state->fd = socket(state->ss.ss_family, SOCK_STREAM, 0);
855 if (state->fd == -1) {
856 status = map_nt_error_from_unix(errno);
859 talloc_set_destructor(state, open_socket_out_state_destructor);
861 if (!tevent_req_set_endtime(
862 result, ev, timeval_current_ofs(0, timeout*1000))) {
866 #if defined(HAVE_IPV6)
867 if (pss->ss_family == AF_INET6) {
868 struct sockaddr_in6 *psa6;
869 psa6 = (struct sockaddr_in6 *)&state->ss;
870 psa6->sin6_port = htons(port);
871 if (psa6->sin6_scope_id == 0
872 && IN6_IS_ADDR_LINKLOCAL(&psa6->sin6_addr)) {
873 setup_linklocal_scope_id(
874 (struct sockaddr *)&(state->ss));
876 state->salen = sizeof(struct sockaddr_in6);
879 if (pss->ss_family == AF_INET) {
880 struct sockaddr_in *psa;
881 psa = (struct sockaddr_in *)&state->ss;
882 psa->sin_port = htons(port);
883 state->salen = sizeof(struct sockaddr_in);
886 if (pss->ss_family == AF_UNIX) {
887 state->salen = sizeof(struct sockaddr_un);
890 print_sockaddr(addr, sizeof(addr), &state->ss);
891 DEBUG(3,("Connecting to %s at port %u\n", addr, (unsigned int)port));
893 subreq = async_connect_send(state, state->ev, state->fd,
894 (struct sockaddr *)&state->ss,
897 || !tevent_req_set_endtime(
899 timeval_current_ofs(0, state->wait_nsec))) {
902 tevent_req_set_callback(subreq, open_socket_out_connected, result);
906 tevent_req_nterror(result, status);
907 return tevent_req_post(result, ev);
913 static void open_socket_out_connected(struct tevent_req *subreq)
915 struct tevent_req *req =
916 tevent_req_callback_data(subreq, struct tevent_req);
917 struct open_socket_out_state *state =
918 tevent_req_data(req, struct open_socket_out_state);
922 ret = async_connect_recv(subreq, &sys_errno);
925 tevent_req_done(req);
931 (sys_errno == ETIMEDOUT) ||
933 (sys_errno == EINPROGRESS) ||
934 (sys_errno == EALREADY) ||
935 (sys_errno == EAGAIN)) {
941 if (state->wait_nsec < 250000) {
942 state->wait_nsec *= 1.5;
945 subreq = async_connect_send(state, state->ev, state->fd,
946 (struct sockaddr *)&state->ss,
948 if (tevent_req_nomem(subreq, req)) {
951 if (!tevent_req_set_endtime(
953 timeval_current_ofs(0, state->wait_nsec))) {
954 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
957 tevent_req_set_callback(subreq, open_socket_out_connected, req);
962 if (sys_errno == EISCONN) {
963 tevent_req_done(req);
969 tevent_req_nterror(req, map_nt_error_from_unix(sys_errno));
972 NTSTATUS open_socket_out_recv(struct tevent_req *req, int *pfd)
974 struct open_socket_out_state *state =
975 tevent_req_data(req, struct open_socket_out_state);
978 if (tevent_req_is_nterror(req, &status)) {
987 * @brief open a socket
989 * @param pss a struct sockaddr_storage defining the address to connect to
990 * @param port to connect to
991 * @param timeout in MILLISECONDS
992 * @param pfd file descriptor returned
994 * @return NTSTATUS code
996 NTSTATUS open_socket_out(const struct sockaddr_storage *pss, uint16_t port,
997 int timeout, int *pfd)
999 TALLOC_CTX *frame = talloc_stackframe();
1000 struct event_context *ev;
1001 struct tevent_req *req;
1002 NTSTATUS status = NT_STATUS_NO_MEMORY;
1004 ev = event_context_init(frame);
1009 req = open_socket_out_send(frame, ev, pss, port, timeout);
1013 if (!tevent_req_poll(req, ev)) {
1014 status = NT_STATUS_INTERNAL_ERROR;
1017 status = open_socket_out_recv(req, pfd);
1023 struct open_socket_out_defer_state {
1024 struct event_context *ev;
1025 struct sockaddr_storage ss;
1031 static void open_socket_out_defer_waited(struct tevent_req *subreq);
1032 static void open_socket_out_defer_connected(struct tevent_req *subreq);
1034 struct tevent_req *open_socket_out_defer_send(TALLOC_CTX *mem_ctx,
1035 struct event_context *ev,
1036 struct timeval wait_time,
1037 const struct sockaddr_storage *pss,
1041 struct tevent_req *req, *subreq;
1042 struct open_socket_out_defer_state *state;
1044 req = tevent_req_create(mem_ctx, &state,
1045 struct open_socket_out_defer_state);
1052 state->timeout = timeout;
1054 subreq = tevent_wakeup_send(
1056 timeval_current_ofs(wait_time.tv_sec, wait_time.tv_usec));
1057 if (subreq == NULL) {
1060 tevent_req_set_callback(subreq, open_socket_out_defer_waited, req);
1067 static void open_socket_out_defer_waited(struct tevent_req *subreq)
1069 struct tevent_req *req = tevent_req_callback_data(
1070 subreq, struct tevent_req);
1071 struct open_socket_out_defer_state *state = tevent_req_data(
1072 req, struct open_socket_out_defer_state);
1075 ret = tevent_wakeup_recv(subreq);
1076 TALLOC_FREE(subreq);
1078 tevent_req_nterror(req, NT_STATUS_INTERNAL_ERROR);
1082 subreq = open_socket_out_send(state, state->ev, &state->ss,
1083 state->port, state->timeout);
1084 if (tevent_req_nomem(subreq, req)) {
1087 tevent_req_set_callback(subreq, open_socket_out_defer_connected, req);
1090 static void open_socket_out_defer_connected(struct tevent_req *subreq)
1092 struct tevent_req *req = tevent_req_callback_data(
1093 subreq, struct tevent_req);
1094 struct open_socket_out_defer_state *state = tevent_req_data(
1095 req, struct open_socket_out_defer_state);
1098 status = open_socket_out_recv(subreq, &state->fd);
1099 TALLOC_FREE(subreq);
1100 if (!NT_STATUS_IS_OK(status)) {
1101 tevent_req_nterror(req, status);
1104 tevent_req_done(req);
1107 NTSTATUS open_socket_out_defer_recv(struct tevent_req *req, int *pfd)
1109 struct open_socket_out_defer_state *state = tevent_req_data(
1110 req, struct open_socket_out_defer_state);
1113 if (tevent_req_is_nterror(req, &status)) {
1118 return NT_STATUS_OK;
1121 /****************************************************************************
1122 Open a connected UDP socket to host on port
1123 **************************************************************************/
1125 int open_udp_socket(const char *host, int port)
1127 struct sockaddr_storage ss;
1130 if (!interpret_string_addr(&ss, host, 0)) {
1131 DEBUG(10,("open_udp_socket: can't resolve name %s\n",
1136 res = socket(ss.ss_family, SOCK_DGRAM, 0);
1141 #if defined(HAVE_IPV6)
1142 if (ss.ss_family == AF_INET6) {
1143 struct sockaddr_in6 *psa6;
1144 psa6 = (struct sockaddr_in6 *)&ss;
1145 psa6->sin6_port = htons(port);
1146 if (psa6->sin6_scope_id == 0
1147 && IN6_IS_ADDR_LINKLOCAL(&psa6->sin6_addr)) {
1148 setup_linklocal_scope_id(
1149 (struct sockaddr *)&ss);
1153 if (ss.ss_family == AF_INET) {
1154 struct sockaddr_in *psa;
1155 psa = (struct sockaddr_in *)&ss;
1156 psa->sin_port = htons(port);
1159 if (sys_connect(res,(struct sockaddr *)&ss)) {
1167 /*******************************************************************
1168 Return the IP addr of the remote end of a socket as a string.
1169 Optionally return the struct sockaddr_storage.
1170 ******************************************************************/
1172 static const char *get_peer_addr_internal(int fd,
1174 size_t addr_buf_len,
1175 struct sockaddr *pss,
1178 struct sockaddr_storage ss;
1179 socklen_t length = sizeof(ss);
1181 strlcpy(addr_buf,"0.0.0.0",addr_buf_len);
1188 pss = (struct sockaddr *)&ss;
1192 if (getpeername(fd, (struct sockaddr *)pss, plength) < 0) {
1193 int level = (errno == ENOTCONN) ? 2 : 0;
1194 DEBUG(level, ("getpeername failed. Error was %s\n",
1199 print_sockaddr_len(addr_buf,
1206 /*******************************************************************
1207 Matchname - determine if host name matches IP address. Used to
1208 confirm a hostname lookup to prevent spoof attacks.
1209 ******************************************************************/
1211 static bool matchname(const char *remotehost,
1212 const struct sockaddr *pss,
1215 struct addrinfo *res = NULL;
1216 struct addrinfo *ailist = NULL;
1217 char addr_buf[INET6_ADDRSTRLEN];
1218 bool ret = interpret_string_addr_internal(&ailist,
1220 AI_ADDRCONFIG|AI_CANONNAME);
1222 if (!ret || ailist == NULL) {
1223 DEBUG(3,("matchname: getaddrinfo failed for "
1226 gai_strerror(ret) ));
1231 * Make sure that getaddrinfo() returns the "correct" host name.
1234 if (ailist->ai_canonname == NULL ||
1235 (!strequal(remotehost, ailist->ai_canonname) &&
1236 !strequal(remotehost, "localhost"))) {
1237 DEBUG(0,("matchname: host name/name mismatch: %s != %s\n",
1239 ailist->ai_canonname ?
1240 ailist->ai_canonname : "(NULL)"));
1241 freeaddrinfo(ailist);
1245 /* Look up the host address in the address list we just got. */
1246 for (res = ailist; res; res = res->ai_next) {
1247 if (!res->ai_addr) {
1250 if (sockaddr_equal((const struct sockaddr *)res->ai_addr,
1251 (struct sockaddr *)pss)) {
1252 freeaddrinfo(ailist);
1258 * The host name does not map to the original host address. Perhaps
1259 * someone has compromised a name server. More likely someone botched
1260 * it, but that could be dangerous, too.
1263 DEBUG(0,("matchname: host name/address mismatch: %s != %s\n",
1264 print_sockaddr_len(addr_buf,
1268 ailist->ai_canonname ? ailist->ai_canonname : "(NULL)"));
1271 freeaddrinfo(ailist);
1276 /*******************************************************************
1277 Deal with the singleton cache.
1278 ******************************************************************/
1280 struct name_addr_pair {
1281 struct sockaddr_storage ss;
1285 /*******************************************************************
1286 Lookup a name/addr pair. Returns memory allocated from memcache.
1287 ******************************************************************/
1289 static bool lookup_nc(struct name_addr_pair *nc)
1295 if (!memcache_lookup(
1296 NULL, SINGLETON_CACHE,
1297 data_blob_string_const_null("get_peer_name"),
1302 memcpy(&nc->ss, tmp.data, sizeof(nc->ss));
1303 nc->name = (const char *)tmp.data + sizeof(nc->ss);
1307 /*******************************************************************
1308 Save a name/addr pair.
1309 ******************************************************************/
1311 static void store_nc(const struct name_addr_pair *nc)
1314 size_t namelen = strlen(nc->name);
1316 tmp = data_blob(NULL, sizeof(nc->ss) + namelen + 1);
1320 memcpy(tmp.data, &nc->ss, sizeof(nc->ss));
1321 memcpy(tmp.data+sizeof(nc->ss), nc->name, namelen+1);
1323 memcache_add(NULL, SINGLETON_CACHE,
1324 data_blob_string_const_null("get_peer_name"),
1326 data_blob_free(&tmp);
1329 /*******************************************************************
1330 Return the DNS name of the remote end of a socket.
1331 ******************************************************************/
1333 const char *get_peer_name(int fd, bool force_lookup)
1335 struct name_addr_pair nc;
1336 char addr_buf[INET6_ADDRSTRLEN];
1337 struct sockaddr_storage ss;
1338 socklen_t length = sizeof(ss);
1341 char name_buf[MAX_DNS_NAME_LENGTH];
1342 char tmp_name[MAX_DNS_NAME_LENGTH];
1344 /* reverse lookups can be *very* expensive, and in many
1345 situations won't work because many networks don't link dhcp
1346 with dns. To avoid the delay we avoid the lookup if
1348 if (!lp_hostname_lookups() && (force_lookup == false)) {
1349 length = sizeof(nc.ss);
1350 nc.name = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf),
1351 (struct sockaddr *)&nc.ss, &length);
1354 return nc.name ? nc.name : "UNKNOWN";
1359 memset(&ss, '\0', sizeof(ss));
1360 p = get_peer_addr_internal(fd, addr_buf, sizeof(addr_buf), (struct sockaddr *)&ss, &length);
1362 /* it might be the same as the last one - save some DNS work */
1363 if (sockaddr_equal((struct sockaddr *)&ss, (struct sockaddr *)&nc.ss)) {
1364 return nc.name ? nc.name : "UNKNOWN";
1367 /* Not the same. We need to lookup. */
1372 /* Look up the remote host name. */
1373 ret = sys_getnameinfo((struct sockaddr *)&ss,
1382 DEBUG(1,("get_peer_name: getnameinfo failed "
1383 "for %s with error %s\n",
1385 gai_strerror(ret)));
1386 strlcpy(name_buf, p, sizeof(name_buf));
1388 if (!matchname(name_buf, (struct sockaddr *)&ss, length)) {
1389 DEBUG(0,("Matchname failed on %s %s\n",name_buf,p));
1390 strlcpy(name_buf,"UNKNOWN",sizeof(name_buf));
1394 strlcpy(tmp_name, name_buf, sizeof(tmp_name));
1395 alpha_strcpy(name_buf, tmp_name, "_-.", sizeof(name_buf));
1396 if (strstr(name_buf,"..")) {
1397 strlcpy(name_buf, "UNKNOWN", sizeof(name_buf));
1405 return nc.name ? nc.name : "UNKNOWN";
1408 /*******************************************************************
1409 Return the IP addr of the remote end of a socket as a string.
1410 ******************************************************************/
1412 const char *get_peer_addr(int fd, char *addr, size_t addr_len)
1414 return get_peer_addr_internal(fd, addr, addr_len, NULL, NULL);
1417 /*******************************************************************
1418 Create protected unix domain socket.
1420 Some unixes cannot set permissions on a ux-dom-sock, so we
1421 have to make sure that the directory contains the protection
1422 permissions instead.
1423 ******************************************************************/
1425 int create_pipe_sock(const char *socket_dir,
1426 const char *socket_name,
1429 #ifdef HAVE_UNIXSOCKET
1430 struct sockaddr_un sunaddr;
1436 old_umask = umask(0);
1438 /* Create the socket directory or reuse the existing one */
1440 if (lstat(socket_dir, &st) == -1) {
1441 if (errno == ENOENT) {
1442 /* Create directory */
1443 if (mkdir(socket_dir, dir_perms) == -1) {
1444 DEBUG(0, ("error creating socket directory "
1445 "%s: %s\n", socket_dir,
1450 DEBUG(0, ("lstat failed on socket directory %s: %s\n",
1451 socket_dir, strerror(errno)));
1455 /* Check ownership and permission on existing directory */
1456 if (!S_ISDIR(st.st_mode)) {
1457 DEBUG(0, ("socket directory %s isn't a directory\n",
1461 if ((st.st_uid != sec_initial_uid()) ||
1462 ((st.st_mode & 0777) != dir_perms)) {
1463 DEBUG(0, ("invalid permissions on socket directory "
1464 "%s\n", socket_dir));
1469 /* Create the socket file */
1471 sock = socket(AF_UNIX, SOCK_STREAM, 0);
1474 DEBUG(0, ("create_pipe_sock: socket error %s\n",
1479 if (asprintf(&path, "%s/%s", socket_dir, socket_name) == -1) {
1484 memset(&sunaddr, 0, sizeof(sunaddr));
1485 sunaddr.sun_family = AF_UNIX;
1486 strlcpy(sunaddr.sun_path, path, sizeof(sunaddr.sun_path));
1488 if (bind(sock, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) == -1) {
1489 DEBUG(0, ("bind failed on pipe socket %s: %s\n", path,
1494 if (listen(sock, 5) == -1) {
1495 DEBUG(0, ("listen failed on pipe socket %s: %s\n", path,
1515 DEBUG(0, ("create_pipe_sock: No Unix sockets on this system\n"));
1517 #endif /* HAVE_UNIXSOCKET */
1520 /****************************************************************************
1521 Get my own canonical name, including domain.
1522 ****************************************************************************/
1524 const char *get_mydnsfullname(void)
1526 struct addrinfo *res = NULL;
1527 char my_hostname[HOST_NAME_MAX];
1531 if (memcache_lookup(NULL, SINGLETON_CACHE,
1532 data_blob_string_const_null("get_mydnsfullname"),
1534 SMB_ASSERT(tmp.length > 0);
1535 return (const char *)tmp.data;
1538 /* get my host name */
1539 if (gethostname(my_hostname, sizeof(my_hostname)) == -1) {
1540 DEBUG(0,("get_mydnsfullname: gethostname failed\n"));
1544 /* Ensure null termination. */
1545 my_hostname[sizeof(my_hostname)-1] = '\0';
1547 ret = interpret_string_addr_internal(&res,
1549 AI_ADDRCONFIG|AI_CANONNAME);
1551 if (!ret || res == NULL) {
1552 DEBUG(3,("get_mydnsfullname: getaddrinfo failed for "
1555 gai_strerror(ret) ));
1560 * Make sure that getaddrinfo() returns the "correct" host name.
1563 if (res->ai_canonname == NULL) {
1564 DEBUG(3,("get_mydnsfullname: failed to get "
1565 "canonical name for %s\n",
1571 /* This copies the data, so we must do a lookup
1572 * afterwards to find the value to return.
1575 memcache_add(NULL, SINGLETON_CACHE,
1576 data_blob_string_const_null("get_mydnsfullname"),
1577 data_blob_string_const_null(res->ai_canonname));
1579 if (!memcache_lookup(NULL, SINGLETON_CACHE,
1580 data_blob_string_const_null("get_mydnsfullname"),
1582 tmp = data_blob_talloc(talloc_tos(), res->ai_canonname,
1583 strlen(res->ai_canonname) + 1);
1588 return (const char *)tmp.data;
1591 /************************************************************
1592 Is this my ip address ?
1593 ************************************************************/
1595 static bool is_my_ipaddr(const char *ipaddr_str)
1597 struct sockaddr_storage ss;
1598 struct iface_struct *nics;
1601 if (!interpret_string_addr(&ss, ipaddr_str, AI_NUMERICHOST)) {
1605 if (ismyaddr((struct sockaddr *)&ss)) {
1609 if (is_zero_addr(&ss) ||
1610 is_loopback_addr((struct sockaddr *)&ss)) {
1614 n = get_interfaces(talloc_tos(), &nics);
1615 for (i=0; i<n; i++) {
1616 if (sockaddr_equal((struct sockaddr *)&nics[i].ip, (struct sockaddr *)&ss)) {
1625 /************************************************************
1627 ************************************************************/
1629 bool is_myname_or_ipaddr(const char *s)
1631 TALLOC_CTX *ctx = talloc_tos();
1633 const char *dnsname;
1634 char *servername = NULL;
1640 /* Santize the string from '\\name' */
1641 name = talloc_strdup(ctx, s);
1646 servername = strrchr_m(name, '\\' );
1653 /* Optimize for the common case */
1654 if (strequal(servername, global_myname())) {
1658 /* Check for an alias */
1659 if (is_myname(servername)) {
1663 /* Check for loopback */
1664 if (strequal(servername, "127.0.0.1") ||
1665 strequal(servername, "::1")) {
1669 if (strequal(servername, "localhost")) {
1673 /* Maybe it's my dns name */
1674 dnsname = get_mydnsfullname();
1675 if (dnsname && strequal(servername, dnsname)) {
1679 /* Maybe its an IP address? */
1680 if (is_ipaddress(servername)) {
1681 return is_my_ipaddr(servername);
1684 /* Handle possible CNAME records - convert to an IP addr. list. */
1686 /* Use DNS to resolve the name, check all addresses. */
1687 struct addrinfo *p = NULL;
1688 struct addrinfo *res = NULL;
1690 if (!interpret_string_addr_internal(&res,
1696 for (p = res; p; p = p->ai_next) {
1697 char addr[INET6_ADDRSTRLEN];
1698 struct sockaddr_storage ss;
1701 memcpy(&ss, p->ai_addr, p->ai_addrlen);
1702 print_sockaddr(addr,
1705 if (is_my_ipaddr(addr)) {
1717 struct getaddrinfo_state {
1719 const char *service;
1720 const struct addrinfo *hints;
1721 struct addrinfo *res;
1725 static void getaddrinfo_do(void *private_data);
1726 static void getaddrinfo_done(struct tevent_req *subreq);
1728 struct tevent_req *getaddrinfo_send(TALLOC_CTX *mem_ctx,
1729 struct tevent_context *ev,
1730 struct fncall_context *ctx,
1732 const char *service,
1733 const struct addrinfo *hints)
1735 struct tevent_req *req, *subreq;
1736 struct getaddrinfo_state *state;
1738 req = tevent_req_create(mem_ctx, &state, struct getaddrinfo_state);
1744 state->service = service;
1745 state->hints = hints;
1747 subreq = fncall_send(state, ev, ctx, getaddrinfo_do, state);
1748 if (tevent_req_nomem(subreq, req)) {
1749 return tevent_req_post(req, ev);
1751 tevent_req_set_callback(subreq, getaddrinfo_done, req);
1755 static void getaddrinfo_do(void *private_data)
1757 struct getaddrinfo_state *state =
1758 (struct getaddrinfo_state *)private_data;
1760 state->ret = getaddrinfo(state->node, state->service, state->hints,
1764 static void getaddrinfo_done(struct tevent_req *subreq)
1766 struct tevent_req *req = tevent_req_callback_data(
1767 subreq, struct tevent_req);
1770 ret = fncall_recv(subreq, &err);
1771 TALLOC_FREE(subreq);
1773 tevent_req_error(req, err);
1776 tevent_req_done(req);
1779 int getaddrinfo_recv(struct tevent_req *req, struct addrinfo **res)
1781 struct getaddrinfo_state *state = tevent_req_data(
1782 req, struct getaddrinfo_state);
1785 if (tevent_req_is_unix_error(req, &err)) {
1793 if (state->ret == 0) {
1799 int poll_one_fd(int fd, int events, int timeout, int *revents)
1805 fds = TALLOC_ZERO_ARRAY(talloc_tos(), struct pollfd, 2);
1811 fds[0].events = events;
1813 ret = sys_poll(fds, 1, timeout);
1816 * Assign whatever poll did, even in the ret<=0 case.
1818 *revents = fds[0].revents;
1819 saved_errno = errno;
1821 errno = saved_errno;
1826 int poll_intr_one_fd(int fd, int events, int timeout, int *revents)
1832 pfd.events = events;
1834 ret = sys_poll_intr(&pfd, 1, timeout);
1839 *revents = pfd.revents;