2 * HTTP address list routines for CUPS.
4 * Copyright 2007-2018 by Apple Inc.
5 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
12 * Include necessary headers...
15 #include "cups-private.h"
16 #include "debug-internal.h"
19 #endif /* HAVE_RESOLV_H */
22 #endif /* HAVE_POLL */
29 * 'httpAddrConnect()' - Connect to any of the addresses in the list.
31 * @since CUPS 1.2/macOS 10.5@ @exclude all@
34 http_addrlist_t
* /* O - Connected address or NULL on failure */
36 http_addrlist_t
*addrlist
, /* I - List of potential addresses */
37 int *sock
) /* O - Socket */
39 DEBUG_printf(("httpAddrConnect(addrlist=%p, sock=%p)", (void *)addrlist
, (void *)sock
));
41 return (httpAddrConnect2(addrlist
, sock
, 30000, NULL
));
46 * 'httpAddrConnect2()' - Connect to any of the addresses in the list with a
47 * timeout and optional cancel.
49 * @since CUPS 1.7/macOS 10.9@
52 http_addrlist_t
* /* O - Connected address or NULL on failure */
54 http_addrlist_t
*addrlist
, /* I - List of potential addresses */
55 int *sock
, /* O - Socket */
56 int msec
, /* I - Timeout in milliseconds */
57 int *cancel
) /* I - Pointer to "cancel" variable */
59 int val
; /* Socket option value */
61 int i
, j
, /* Looping vars */
62 flags
, /* Socket flags */
63 result
; /* Result from select() or poll() */
65 int remaining
; /* Remaining timeout */
66 int nfds
, /* Number of file descriptors */
67 fds
[100]; /* Socket file descriptors */
68 http_addrlist_t
*addrs
[100]; /* Addresses */
70 int max_fd
= -1; /* Highest file descriptor */
71 #endif /* !HAVE_POLL */
74 struct pollfd pfds
[100]; /* Polled file descriptors */
76 fd_set input_set
, /* select() input set */
77 output_set
, /* select() output set */
78 error_set
; /* select() error set */
79 struct timeval timeout
; /* Timeout */
80 # endif /* HAVE_POLL */
81 #endif /* O_NONBLOCK */
84 socklen_t len
; /* Length of value */
85 http_addr_t peer
; /* Peer address */
87 char temp
[256]; /* Temporary address string */
91 DEBUG_printf(("httpAddrConnect2(addrlist=%p, sock=%p, msec=%d, cancel=%p)", (void *)addrlist
, (void *)sock
, msec
, (void *)cancel
));
96 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
100 if (cancel
&& *cancel
)
107 * Loop through each address until we connect or run out of addresses...
113 while (remaining
> 0)
115 if (cancel
&& *cancel
)
120 httpAddrClose(NULL
, fds
[nfds
]);
126 if (addrlist
&& nfds
< (int)(sizeof(fds
) / sizeof(fds
[0])))
129 * Create the socket...
132 DEBUG_printf(("2httpAddrConnect2: Trying %s:%d...", httpAddrString(&(addrlist
->addr
), temp
, sizeof(temp
)), httpAddrPort(&(addrlist
->addr
))));
134 if ((fds
[nfds
] = (int)socket(httpAddrFamily(&(addrlist
->addr
)), SOCK_STREAM
, 0)) < 0)
137 * Don't abort yet, as this could just be an issue with the local
138 * system not being configured with IPv4/IPv6/domain socket enabled.
140 * Just skip this address...
143 addrlist
= addrlist
->next
;
152 setsockopt(fds
[nfds
], SOL_SOCKET
, SO_REUSEADDR
, CUPS_SOCAST
&val
, sizeof(val
));
156 setsockopt(fds
[nfds
], SOL_SOCKET
, SO_REUSEPORT
, CUPS_SOCAST
&val
, sizeof(val
));
157 #endif /* SO_REUSEPORT */
161 setsockopt(fds
[nfds
], SOL_SOCKET
, SO_NOSIGPIPE
, CUPS_SOCAST
&val
, sizeof(val
));
162 #endif /* SO_NOSIGPIPE */
165 * Using TCP_NODELAY improves responsiveness, especially on systems
166 * with a slow loopback interface...
170 setsockopt(fds
[nfds
], IPPROTO_TCP
, TCP_NODELAY
, CUPS_SOCAST
&val
, sizeof(val
));
174 * Close this socket when starting another process...
177 fcntl(fds
[nfds
], F_SETFD
, FD_CLOEXEC
);
178 #endif /* FD_CLOEXEC */
182 * Do an asynchronous connect by setting the socket non-blocking...
185 DEBUG_printf(("httpAddrConnect2: Setting non-blocking connect()"));
187 flags
= fcntl(fds
[nfds
], F_GETFL
, 0);
188 fcntl(fds
[nfds
], F_SETFL
, flags
| O_NONBLOCK
);
189 #endif /* O_NONBLOCK */
195 if (!connect(fds
[nfds
], &(addrlist
->addr
.addr
), (socklen_t
)httpAddrLength(&(addrlist
->addr
))))
197 DEBUG_printf(("1httpAddrConnect2: Connected to %s:%d...", httpAddrString(&(addrlist
->addr
), temp
, sizeof(temp
)), httpAddrPort(&(addrlist
->addr
))));
200 fcntl(fds
[nfds
], F_SETFL
, flags
);
201 #endif /* O_NONBLOCK */
208 httpAddrClose(NULL
, fds
[nfds
]);
215 if (WSAGetLastError() != WSAEINPROGRESS
&& WSAGetLastError() != WSAEWOULDBLOCK
)
217 if (errno
!= EINPROGRESS
&& errno
!= EWOULDBLOCK
)
220 DEBUG_printf(("1httpAddrConnect2: Unable to connect to %s:%d: %s", httpAddrString(&(addrlist
->addr
), temp
, sizeof(temp
)), httpAddrPort(&(addrlist
->addr
)), strerror(errno
)));
221 httpAddrClose(NULL
, fds
[nfds
]);
222 addrlist
= addrlist
->next
;
227 fcntl(fds
[nfds
], F_SETFL
, flags
);
231 if (fds
[nfds
] > max_fd
)
233 #endif /* !HAVE_POLL */
235 addrs
[nfds
] = addrlist
;
237 addrlist
= addrlist
->next
;
240 if (!addrlist
&& nfds
== 0)
244 * See if we can connect to any of the addresses so far...
248 DEBUG_puts("1httpAddrConnect2: Finishing async connect()");
252 if (cancel
&& *cancel
)
255 * Close this socket and return...
258 DEBUG_puts("1httpAddrConnect2: Canceled connect()");
263 httpAddrClose(NULL
, fds
[nfds
]);
272 for (i
= 0; i
< nfds
; i
++)
275 pfds
[i
].events
= POLLIN
| POLLOUT
;
278 result
= poll(pfds
, (nfds_t
)nfds
, addrlist
? 100 : remaining
> 250 ? 250 : remaining
);
280 DEBUG_printf(("1httpAddrConnect2: poll() returned %d (%d)", result
, errno
));
284 for (i
= 0; i
< nfds
; i
++)
285 FD_SET(fds
[i
], &input_set
);
286 output_set
= input_set
;
287 error_set
= input_set
;
290 timeout
.tv_usec
= (addrlist
? 100 : remaining
> 250 ? 250 : remaining
) * 1000;
292 result
= select(max_fd
+ 1, &input_set
, &output_set
, &error_set
, &timeout
);
294 DEBUG_printf(("1httpAddrConnect2: select() returned %d (%d)", result
, errno
));
295 # endif /* HAVE_POLL */
298 while (result
< 0 && (WSAGetLastError() == WSAEINTR
|| WSAGetLastError() == WSAEWOULDBLOCK
));
300 while (result
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
305 http_addrlist_t
*connaddr
= NULL
; /* Connected address, if any */
307 for (i
= 0; i
< nfds
; i
++)
310 DEBUG_printf(("pfds[%d].revents=%x\n", i
, pfds
[i
].revents
));
311 if (pfds
[i
].revents
&& !(pfds
[i
].revents
& (POLLERR
| POLLHUP
)))
313 if (FD_ISSET(fds
[i
], &input_set
) && !FD_ISSET(fds
[i
], &error_set
))
314 # endif /* HAVE_POLL */
321 if (!getpeername(fds
[i
], (struct sockaddr
*)&peer
, &len
))
322 DEBUG_printf(("1httpAddrConnect2: Connected to %s:%d...", httpAddrString(&peer
, temp
, sizeof(temp
)), httpAddrPort(&peer
)));
328 else if (pfds
[i
].revents
& (POLLERR
| POLLHUP
))
330 else if (FD_ISSET(fds
[i
], &error_set
))
331 # endif /* HAVE_POLL */
334 * Error on socket, remove from the "pool"...
337 httpAddrClose(NULL
, fds
[i
]);
341 memmove(fds
+ i
, fds
+ i
+ 1, (size_t)(nfds
- i
) * (sizeof(fds
[0])));
342 memmove(addrs
+ i
, addrs
+ i
+ 1, (size_t)(nfds
- i
) * (sizeof(addrs
[0])));
351 * Connected on one address, close all of the other sockets we have so
355 for (j
= 0; j
< i
; j
++)
356 httpAddrClose(NULL
, fds
[j
]);
358 for (j
++; j
< nfds
; j
++)
359 httpAddrClose(NULL
, fds
[j
]);
364 #endif /* O_NONBLOCK */
375 httpAddrClose(NULL
, fds
[nfds
]);
379 _cupsSetError(IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
, "Connection failed", 0);
381 _cupsSetError(IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
, strerror(errno
), 0);
389 * 'httpAddrCopyList()' - Copy an address list.
391 * @since CUPS 1.7/macOS 10.9@
394 http_addrlist_t
* /* O - New address list or @code NULL@ on error */
396 http_addrlist_t
*src
) /* I - Source address list */
398 http_addrlist_t
*dst
= NULL
, /* First list entry */
399 *prev
= NULL
, /* Previous list entry */
400 *current
= NULL
;/* Current list entry */
405 if ((current
= malloc(sizeof(http_addrlist_t
))) == NULL
)
412 current
= current
->next
;
420 memcpy(current
, src
, sizeof(http_addrlist_t
));
422 current
->next
= NULL
;
425 prev
->next
= current
;
438 * 'httpAddrFreeList()' - Free an address list.
440 * @since CUPS 1.2/macOS 10.5@
445 http_addrlist_t
*addrlist
) /* I - Address list to free */
447 http_addrlist_t
*next
; /* Next address in list */
451 * Free each address in the list...
456 next
= addrlist
->next
;
466 * 'httpAddrGetList()' - Get a list of addresses for a hostname.
468 * @since CUPS 1.2/macOS 10.5@
471 http_addrlist_t
* /* O - List of addresses or NULL */
472 httpAddrGetList(const char *hostname
, /* I - Hostname, IP address, or NULL for passive listen address */
473 int family
, /* I - Address family or AF_UNSPEC */
474 const char *service
) /* I - Service name or port number */
476 http_addrlist_t
*first
, /* First address in list */
477 *addr
, /* Current address in list */
478 *temp
; /* New address */
479 _cups_globals_t
*cg
= _cupsGlobals();
484 _cups_debug_printf("httpAddrGetList(hostname=\"%s\", family=AF_%s, "
486 hostname
? hostname
: "(nil)",
487 family
== AF_UNSPEC
? "UNSPEC" :
489 family
== AF_LOCAL
? "LOCAL" :
490 # endif /* AF_LOCAL */
492 family
== AF_INET6
? "INET6" :
493 # endif /* AF_INET6 */
494 family
== AF_INET
? "INET" : "???", service
);
499 * STR #2920: Initialize resolver after failure in cups-polld
501 * If the previous lookup failed, re-initialize the resolver to prevent
502 * temporary network errors from persisting. This *should* be handled by
503 * the resolver libraries, but apparently the glibc folks do not agree.
505 * We set a flag at the end of this function if we encounter an error that
506 * requires reinitialization of the resolver functions. We then call
507 * res_init() if the flag is set on the next call here or in httpAddrLookup().
510 if (cg
->need_res_init
)
514 cg
->need_res_init
= 0;
516 #endif /* HAVE_RES_INIT */
519 * Lookup the address the best way we can...
525 if (hostname
&& hostname
[0] == '/')
528 * Domain socket address...
531 if ((first
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
))) != NULL
)
534 first
->addr
.un
.sun_family
= AF_LOCAL
;
535 strlcpy(first
->addr
.un
.sun_path
, hostname
, sizeof(first
->addr
.un
.sun_path
));
539 #endif /* AF_LOCAL */
540 if (!hostname
|| _cups_strcasecmp(hostname
, "localhost"))
542 #ifdef HAVE_GETADDRINFO
543 struct addrinfo hints
, /* Address lookup hints */
544 *results
, /* Address lookup results */
545 *current
; /* Current result */
546 char ipv6
[64], /* IPv6 address */
547 *ipv6zone
; /* Pointer to zone separator */
548 int ipv6len
; /* Length of IPv6 address */
549 int error
; /* getaddrinfo() error */
553 * Lookup the address as needed...
556 memset(&hints
, 0, sizeof(hints
));
557 hints
.ai_family
= family
;
558 hints
.ai_flags
= hostname
? 0 : AI_PASSIVE
;
559 hints
.ai_socktype
= SOCK_STREAM
;
561 if (hostname
&& *hostname
== '[')
564 * Remove brackets from numeric IPv6 address...
567 if (!strncmp(hostname
, "[v1.", 4))
570 * Copy the newer address format which supports link-local addresses...
573 strlcpy(ipv6
, hostname
+ 4, sizeof(ipv6
));
574 if ((ipv6len
= (int)strlen(ipv6
) - 1) >= 0 && ipv6
[ipv6len
] == ']')
576 ipv6
[ipv6len
] = '\0';
580 * Convert "+zone" in address to "%zone"...
583 if ((ipv6zone
= strrchr(ipv6
, '+')) != NULL
)
590 * Copy the regular non-link-local IPv6 address...
593 strlcpy(ipv6
, hostname
+ 1, sizeof(ipv6
));
594 if ((ipv6len
= (int)strlen(ipv6
) - 1) >= 0 && ipv6
[ipv6len
] == ']')
596 ipv6
[ipv6len
] = '\0';
602 if ((error
= getaddrinfo(hostname
, service
, &hints
, &results
)) == 0)
605 * Copy the results to our own address list structure...
608 for (current
= results
; current
; current
= current
->ai_next
)
609 if (current
->ai_family
== AF_INET
|| current
->ai_family
== AF_INET6
)
612 * Copy the address over...
615 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
618 httpAddrFreeList(first
);
619 freeaddrinfo(results
);
620 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
624 if (current
->ai_family
== AF_INET6
)
625 memcpy(&(temp
->addr
.ipv6
), current
->ai_addr
,
626 sizeof(temp
->addr
.ipv6
));
628 memcpy(&(temp
->addr
.ipv4
), current
->ai_addr
,
629 sizeof(temp
->addr
.ipv4
));
632 * Append the address to the list...
645 * Free the results from getaddrinfo()...
648 freeaddrinfo(results
);
652 if (error
== EAI_FAIL
)
653 cg
->need_res_init
= 1;
655 # ifdef _WIN32 /* Really, Microsoft?!? */
656 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, gai_strerrorA(error
), 0);
658 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, gai_strerror(error
), 0);
665 int i
; /* Looping vars */
666 unsigned ip
[4]; /* IPv4 address components */
667 const char *ptr
; /* Pointer into hostname */
668 struct hostent
*host
; /* Result of lookup */
669 struct servent
*port
; /* Port number for service */
670 int portnum
; /* Port number */
674 * Lookup the service...
679 else if (isdigit(*service
& 255))
680 portnum
= atoi(service
);
681 else if ((port
= getservbyname(service
, NULL
)) != NULL
)
682 portnum
= ntohs(port
->s_port
);
683 else if (!strcmp(service
, "http"))
685 else if (!strcmp(service
, "https"))
687 else if (!strcmp(service
, "ipp") || !strcmp(service
, "ipps"))
689 else if (!strcmp(service
, "lpd"))
691 else if (!strcmp(service
, "socket"))
697 * This code is needed because some operating systems have a
698 * buggy implementation of gethostbyname() that does not support
699 * IPv4 addresses. If the hostname string is an IPv4 address, then
700 * sscanf() is used to extract the IPv4 components. We then pack
701 * the components into an IPv4 address manually, since the
702 * inet_aton() function is deprecated. We use the htonl() macro
703 * to get the right byte order for the address.
706 for (ptr
= hostname
; isdigit(*ptr
& 255) || *ptr
== '.'; ptr
++);
711 * We have an IPv4 address; break it up and create an IPv4 address...
714 if (sscanf(hostname
, "%u.%u.%u.%u", ip
, ip
+ 1, ip
+ 2, ip
+ 3) == 4 &&
715 ip
[0] <= 255 && ip
[1] <= 255 && ip
[2] <= 255 && ip
[3] <= 255)
717 first
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
721 first
->addr
.ipv4
.sin_family
= AF_INET
;
722 first
->addr
.ipv4
.sin_addr
.s_addr
= htonl((((((((unsigned)ip
[0] << 8) |
723 (unsigned)ip
[1]) << 8) |
724 (unsigned)ip
[2]) << 8) |
726 first
->addr
.ipv4
.sin_port
= htons(portnum
);
729 else if ((host
= gethostbyname(hostname
)) != NULL
&&
731 (host
->h_addrtype
== AF_INET
|| host
->h_addrtype
== AF_INET6
))
733 host
->h_addrtype
== AF_INET
)
734 # endif /* AF_INET6 */
736 for (i
= 0; host
->h_addr_list
[i
]; i
++)
739 * Copy the address over...
742 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
745 httpAddrFreeList(first
);
750 if (host
->h_addrtype
== AF_INET6
)
752 temp
->addr
.ipv6
.sin6_family
= AF_INET6
;
753 memcpy(&(temp
->addr
.ipv6
.sin6_addr
), host
->h_addr_list
[i
],
754 sizeof(temp
->addr
.ipv6
));
755 temp
->addr
.ipv6
.sin6_port
= htons(portnum
);
758 # endif /* AF_INET6 */
760 temp
->addr
.ipv4
.sin_family
= AF_INET
;
761 memcpy(&(temp
->addr
.ipv4
.sin_addr
), host
->h_addr_list
[i
],
762 sizeof(temp
->addr
.ipv4
));
763 temp
->addr
.ipv4
.sin_port
= htons(portnum
);
767 * Append the address to the list...
781 if (h_errno
== NO_RECOVERY
)
782 cg
->need_res_init
= 1;
784 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, hstrerror(h_errno
), 0);
787 #endif /* HAVE_GETADDRINFO */
791 * Detect some common errors and handle them sanely...
794 if (!addr
&& (!hostname
|| !_cups_strcasecmp(hostname
, "localhost")))
796 struct servent
*port
; /* Port number for service */
797 int portnum
; /* Port number */
801 * Lookup the service...
806 else if (isdigit(*service
& 255))
807 portnum
= atoi(service
);
808 else if ((port
= getservbyname(service
, NULL
)) != NULL
)
809 portnum
= ntohs(port
->s_port
);
810 else if (!strcmp(service
, "http"))
812 else if (!strcmp(service
, "https"))
814 else if (!strcmp(service
, "ipp") || !strcmp(service
, "ipps"))
816 else if (!strcmp(service
, "lpd"))
818 else if (!strcmp(service
, "socket"))
822 httpAddrFreeList(first
);
824 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Unknown service name."), 1);
828 if (hostname
&& !_cups_strcasecmp(hostname
, "localhost"))
831 * Unfortunately, some users ignore all of the warnings in the
832 * /etc/hosts file and delete "localhost" from it. If we get here
833 * then we were unable to resolve the name, so use the IPv6 and/or
834 * IPv4 loopback interface addresses...
838 if (family
!= AF_INET
)
841 * Add [::1] to the address list...
844 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
847 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
848 httpAddrFreeList(first
);
852 temp
->addr
.ipv6
.sin6_family
= AF_INET6
;
853 temp
->addr
.ipv6
.sin6_port
= htons(portnum
);
855 temp
->addr
.ipv6
.sin6_addr
.u
.Byte
[15] = 1;
857 temp
->addr
.ipv6
.sin6_addr
.s6_addr32
[3] = htonl(1);
866 if (family
!= AF_INET6
)
867 #endif /* AF_INET6 */
870 * Add 127.0.0.1 to the address list...
873 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
876 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
877 httpAddrFreeList(first
);
881 temp
->addr
.ipv4
.sin_family
= AF_INET
;
882 temp
->addr
.ipv4
.sin_port
= htons(portnum
);
883 temp
->addr
.ipv4
.sin_addr
.s_addr
= htonl(0x7f000001);
895 * Provide one or more passive listening addresses...
899 if (family
!= AF_INET
)
902 * Add [::] to the address list...
905 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
908 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
909 httpAddrFreeList(first
);
913 temp
->addr
.ipv6
.sin6_family
= AF_INET6
;
914 temp
->addr
.ipv6
.sin6_port
= htons(portnum
);
922 if (family
!= AF_INET6
)
923 #endif /* AF_INET6 */
926 * Add 0.0.0.0 to the address list...
929 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
932 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
933 httpAddrFreeList(first
);
937 temp
->addr
.ipv4
.sin_family
= AF_INET
;
938 temp
->addr
.ipv4
.sin_port
= htons(portnum
);
950 * Return the address list...