2 * HTTP address list routines for CUPS.
4 * Copyright 2007-2016 by Apple Inc.
5 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
7 * These coded instructions, statements, and computer programs are the
8 * property of Apple Inc. and are protected by Federal copyright
9 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 * which should have been included with this file. If this file is
11 * missing or damaged, see the license at "http://www.cups.org/".
13 * This file is subject to the Apple OS-Developed Software exception.
17 * Include necessary headers...
20 #include "cups-private.h"
23 #endif /* HAVE_RESOLV_H */
26 #endif /* HAVE_POLL */
33 * 'httpAddrConnect()' - Connect to any of the addresses in the list.
35 * @since CUPS 1.2/macOS 10.5@
38 http_addrlist_t
* /* O - Connected address or NULL on failure */
40 http_addrlist_t
*addrlist
, /* I - List of potential addresses */
41 int *sock
) /* O - Socket */
43 DEBUG_printf(("httpAddrConnect(addrlist=%p, sock=%p)", (void *)addrlist
, (void *)sock
));
45 return (httpAddrConnect2(addrlist
, sock
, 30000, NULL
));
50 * 'httpAddrConnect2()' - Connect to any of the addresses in the list with a
51 * timeout and optional cancel.
53 * @since CUPS 1.7/macOS 10.9@
56 http_addrlist_t
* /* O - Connected address or NULL on failure */
58 http_addrlist_t
*addrlist
, /* I - List of potential addresses */
59 int *sock
, /* O - Socket */
60 int msec
, /* I - Timeout in milliseconds */
61 int *cancel
) /* I - Pointer to "cancel" variable */
63 int val
; /* Socket option value */
65 int flags
; /* Socket flags */
67 int remaining
; /* Remaining timeout */
68 int i
, /* Looping var */
69 nfds
, /* Number of file descriptors */
70 fds
[100], /* Socket file descriptors */
71 result
; /* Result from select() or poll() */
72 http_addrlist_t
*addrs
[100]; /* Addresses */
74 int max_fd
= -1; /* Highest file descriptor */
75 #endif /* !HAVE_POLL */
78 struct pollfd pfds
[100]; /* Polled file descriptors */
80 fd_set input_set
, /* select() input set */
81 output_set
, /* select() output set */
82 error_set
; /* select() error set */
83 struct timeval timeout
; /* Timeout */
84 # endif /* HAVE_POLL */
85 #endif /* O_NONBLOCK */
87 socklen_t len
; /* Length of value */
88 http_addr_t peer
; /* Peer address */
89 char temp
[256]; /* Temporary address string */
93 DEBUG_printf(("httpAddrConnect2(addrlist=%p, sock=%p, msec=%d, cancel=%p)", (void *)addrlist
, (void *)sock
, msec
, (void *)cancel
));
98 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
102 if (cancel
&& *cancel
)
109 * Loop through each address until we connect or run out of addresses...
115 while (remaining
> 0)
117 if (cancel
&& *cancel
)
122 httpAddrClose(NULL
, fds
[nfds
]);
128 if (addrlist
&& nfds
< (int)(sizeof(fds
) / sizeof(fds
[0])))
131 * Create the socket...
134 DEBUG_printf(("2httpAddrConnect2: Trying %s:%d...", httpAddrString(&(addrlist
->addr
), temp
, sizeof(temp
)), httpAddrPort(&(addrlist
->addr
))));
136 if ((fds
[nfds
] = (int)socket(httpAddrFamily(&(addrlist
->addr
)), SOCK_STREAM
, 0)) < 0)
139 * Don't abort yet, as this could just be an issue with the local
140 * system not being configured with IPv4/IPv6/domain socket enabled.
142 * Just skip this address...
145 addrlist
= addrlist
->next
;
154 setsockopt(fds
[nfds
], SOL_SOCKET
, SO_REUSEADDR
, CUPS_SOCAST
&val
, sizeof(val
));
158 setsockopt(fds
[nfds
], SOL_SOCKET
, SO_REUSEPORT
, CUPS_SOCAST
&val
, sizeof(val
));
159 #endif /* SO_REUSEPORT */
163 setsockopt(fds
[nfds
], SOL_SOCKET
, SO_NOSIGPIPE
, CUPS_SOCAST
&val
, sizeof(val
));
164 #endif /* SO_NOSIGPIPE */
167 * Using TCP_NODELAY improves responsiveness, especially on systems
168 * with a slow loopback interface...
172 setsockopt(fds
[nfds
], IPPROTO_TCP
, TCP_NODELAY
, CUPS_SOCAST
&val
, sizeof(val
));
176 * Close this socket when starting another process...
179 fcntl(fds
[nfds
], F_SETFD
, FD_CLOEXEC
);
180 #endif /* FD_CLOEXEC */
184 * Do an asynchronous connect by setting the socket non-blocking...
187 DEBUG_printf(("httpAddrConnect2: Setting non-blocking connect()"));
189 flags
= fcntl(fds
[nfds
], F_GETFL
, 0);
190 fcntl(fds
[nfds
], F_SETFL
, flags
| O_NONBLOCK
);
191 #endif /* O_NONBLOCK */
197 if (!connect(fds
[nfds
], &(addrlist
->addr
.addr
), (socklen_t
)httpAddrLength(&(addrlist
->addr
))))
199 DEBUG_printf(("1httpAddrConnect2: Connected to %s:%d...", httpAddrString(&(addrlist
->addr
), temp
, sizeof(temp
)), httpAddrPort(&(addrlist
->addr
))));
202 fcntl(fds
[nfds
], F_SETFL
, flags
);
203 #endif /* O_NONBLOCK */
210 httpAddrClose(NULL
, fds
[nfds
]);
217 if (WSAGetLastError() != WSAEINPROGRESS
&& WSAGetLastError() != WSAEWOULDBLOCK
)
219 if (errno
!= EINPROGRESS
&& errno
!= EWOULDBLOCK
)
222 DEBUG_printf(("1httpAddrConnect2: Unable to connect to %s:%d: %s", httpAddrString(&(addrlist
->addr
), temp
, sizeof(temp
)), httpAddrPort(&(addrlist
->addr
)), strerror(errno
)));
223 httpAddrClose(NULL
, fds
[nfds
]);
224 addrlist
= addrlist
->next
;
229 fcntl(fds
[nfds
], F_SETFL
, flags
);
233 if (fds
[nfds
] > max_fd
)
235 #endif /* !HAVE_POLL */
237 addrs
[nfds
] = addrlist
;
239 addrlist
= addrlist
->next
;
242 if (!addrlist
&& nfds
== 0)
246 * See if we can connect to any of the addresses so far...
250 DEBUG_puts("1httpAddrConnect2: Finishing async connect()");
254 if (cancel
&& *cancel
)
257 * Close this socket and return...
260 DEBUG_puts("1httpAddrConnect2: Canceled connect()");
265 httpAddrClose(NULL
, fds
[nfds
]);
274 for (i
= 0; i
< nfds
; i
++)
277 pfds
[i
].events
= POLLIN
| POLLOUT
;
280 result
= poll(pfds
, (nfds_t
)nfds
, addrlist
? 100 : remaining
> 250 ? 250 : remaining
);
282 DEBUG_printf(("1httpAddrConnect2: poll() returned %d (%d)", result
, errno
));
286 for (i
= 0; i
< nfds
; i
++)
287 FD_SET(fds
[i
], &input_set
);
288 output_set
= input_set
;
289 error_set
= input_set
;
292 timeout
.tv_usec
= (addrlist
? 100 : remaining
> 250 ? 250 : remaining
) * 1000;
294 result
= select(max_fd
+ 1, &input_set
, &output_set
, &error_set
, &timeout
);
296 DEBUG_printf(("1httpAddrConnect2: select() returned %d (%d)", result
, errno
));
297 # endif /* HAVE_POLL */
300 while (result
< 0 && (WSAGetLastError() == WSAEINTR
|| WSAGetLastError() == WSAEWOULDBLOCK
));
302 while (result
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
307 http_addrlist_t
*connaddr
= NULL
; /* Connected address, if any */
309 for (i
= 0; i
< nfds
; i
++)
312 DEBUG_printf(("pfds[%d].revents=%x\n", i
, pfds
[i
].revents
));
313 if (pfds
[i
].revents
&& !(pfds
[i
].revents
& (POLLERR
| POLLHUP
)))
315 if (FD_ISSET(fds
[i
], &input_set
) && !FD_ISSET(fds
[i
], &error_set
))
316 # endif /* HAVE_POLL */
323 if (!getpeername(fds
[i
], (struct sockaddr
*)&peer
, &len
))
324 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 #endif /* O_NONBLOCK */
362 httpAddrClose(NULL
, fds
[nfds
]);
366 _cupsSetError(IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
, "Connection failed", 0);
368 _cupsSetError(IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
, strerror(errno
), 0);
376 * 'httpAddrCopyList()' - Copy an address list.
378 * @since CUPS 1.7/macOS 10.9@
381 http_addrlist_t
* /* O - New address list or @code NULL@ on error */
383 http_addrlist_t
*src
) /* I - Source address list */
385 http_addrlist_t
*dst
= NULL
, /* First list entry */
386 *prev
= NULL
, /* Previous list entry */
387 *current
= NULL
;/* Current list entry */
392 if ((current
= malloc(sizeof(http_addrlist_t
))) == NULL
)
399 current
= current
->next
;
407 memcpy(current
, src
, sizeof(http_addrlist_t
));
409 current
->next
= NULL
;
412 prev
->next
= current
;
425 * 'httpAddrFreeList()' - Free an address list.
427 * @since CUPS 1.2/macOS 10.5@
432 http_addrlist_t
*addrlist
) /* I - Address list to free */
434 http_addrlist_t
*next
; /* Next address in list */
438 * Free each address in the list...
443 next
= addrlist
->next
;
453 * 'httpAddrGetList()' - Get a list of addresses for a hostname.
455 * @since CUPS 1.2/macOS 10.5@
458 http_addrlist_t
* /* O - List of addresses or NULL */
459 httpAddrGetList(const char *hostname
, /* I - Hostname, IP address, or NULL for passive listen address */
460 int family
, /* I - Address family or AF_UNSPEC */
461 const char *service
) /* I - Service name or port number */
463 http_addrlist_t
*first
, /* First address in list */
464 *addr
, /* Current address in list */
465 *temp
; /* New address */
466 _cups_globals_t
*cg
= _cupsGlobals();
471 _cups_debug_printf("httpAddrGetList(hostname=\"%s\", family=AF_%s, "
473 hostname
? hostname
: "(nil)",
474 family
== AF_UNSPEC
? "UNSPEC" :
476 family
== AF_LOCAL
? "LOCAL" :
477 # endif /* AF_LOCAL */
479 family
== AF_INET6
? "INET6" :
480 # endif /* AF_INET6 */
481 family
== AF_INET
? "INET" : "???", service
);
486 * STR #2920: Initialize resolver after failure in cups-polld
488 * If the previous lookup failed, re-initialize the resolver to prevent
489 * temporary network errors from persisting. This *should* be handled by
490 * the resolver libraries, but apparently the glibc folks do not agree.
492 * We set a flag at the end of this function if we encounter an error that
493 * requires reinitialization of the resolver functions. We then call
494 * res_init() if the flag is set on the next call here or in httpAddrLookup().
497 if (cg
->need_res_init
)
501 cg
->need_res_init
= 0;
503 #endif /* HAVE_RES_INIT */
506 * Lookup the address the best way we can...
512 if (hostname
&& hostname
[0] == '/')
515 * Domain socket address...
518 if ((first
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
))) != NULL
)
521 first
->addr
.un
.sun_family
= AF_LOCAL
;
522 strlcpy(first
->addr
.un
.sun_path
, hostname
, sizeof(first
->addr
.un
.sun_path
));
526 #endif /* AF_LOCAL */
527 if (!hostname
|| _cups_strcasecmp(hostname
, "localhost"))
529 #ifdef HAVE_GETADDRINFO
530 struct addrinfo hints
, /* Address lookup hints */
531 *results
, /* Address lookup results */
532 *current
; /* Current result */
533 char ipv6
[64], /* IPv6 address */
534 *ipv6zone
; /* Pointer to zone separator */
535 int ipv6len
; /* Length of IPv6 address */
536 int error
; /* getaddrinfo() error */
540 * Lookup the address as needed...
543 memset(&hints
, 0, sizeof(hints
));
544 hints
.ai_family
= family
;
545 hints
.ai_flags
= hostname
? 0 : AI_PASSIVE
;
546 hints
.ai_socktype
= SOCK_STREAM
;
548 if (hostname
&& *hostname
== '[')
551 * Remove brackets from numeric IPv6 address...
554 if (!strncmp(hostname
, "[v1.", 4))
557 * Copy the newer address format which supports link-local addresses...
560 strlcpy(ipv6
, hostname
+ 4, sizeof(ipv6
));
561 if ((ipv6len
= (int)strlen(ipv6
) - 1) >= 0 && ipv6
[ipv6len
] == ']')
563 ipv6
[ipv6len
] = '\0';
567 * Convert "+zone" in address to "%zone"...
570 if ((ipv6zone
= strrchr(ipv6
, '+')) != NULL
)
577 * Copy the regular non-link-local IPv6 address...
580 strlcpy(ipv6
, hostname
+ 1, sizeof(ipv6
));
581 if ((ipv6len
= (int)strlen(ipv6
) - 1) >= 0 && ipv6
[ipv6len
] == ']')
583 ipv6
[ipv6len
] = '\0';
589 if ((error
= getaddrinfo(hostname
, service
, &hints
, &results
)) == 0)
592 * Copy the results to our own address list structure...
595 for (current
= results
; current
; current
= current
->ai_next
)
596 if (current
->ai_family
== AF_INET
|| current
->ai_family
== AF_INET6
)
599 * Copy the address over...
602 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
605 httpAddrFreeList(first
);
606 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
610 if (current
->ai_family
== AF_INET6
)
611 memcpy(&(temp
->addr
.ipv6
), current
->ai_addr
,
612 sizeof(temp
->addr
.ipv6
));
614 memcpy(&(temp
->addr
.ipv4
), current
->ai_addr
,
615 sizeof(temp
->addr
.ipv4
));
618 * Append the address to the list...
631 * Free the results from getaddrinfo()...
634 freeaddrinfo(results
);
638 if (error
== EAI_FAIL
)
639 cg
->need_res_init
= 1;
641 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, gai_strerror(error
), 0);
647 int i
; /* Looping vars */
648 unsigned ip
[4]; /* IPv4 address components */
649 const char *ptr
; /* Pointer into hostname */
650 struct hostent
*host
; /* Result of lookup */
651 struct servent
*port
; /* Port number for service */
652 int portnum
; /* Port number */
656 * Lookup the service...
661 else if (isdigit(*service
& 255))
662 portnum
= atoi(service
);
663 else if ((port
= getservbyname(service
, NULL
)) != NULL
)
664 portnum
= ntohs(port
->s_port
);
665 else if (!strcmp(service
, "http"))
667 else if (!strcmp(service
, "https"))
669 else if (!strcmp(service
, "ipp") || !strcmp(service
, "ipps"))
671 else if (!strcmp(service
, "lpd"))
673 else if (!strcmp(service
, "socket"))
679 * This code is needed because some operating systems have a
680 * buggy implementation of gethostbyname() that does not support
681 * IPv4 addresses. If the hostname string is an IPv4 address, then
682 * sscanf() is used to extract the IPv4 components. We then pack
683 * the components into an IPv4 address manually, since the
684 * inet_aton() function is deprecated. We use the htonl() macro
685 * to get the right byte order for the address.
688 for (ptr
= hostname
; isdigit(*ptr
& 255) || *ptr
== '.'; ptr
++);
693 * We have an IPv4 address; break it up and create an IPv4 address...
696 if (sscanf(hostname
, "%u.%u.%u.%u", ip
, ip
+ 1, ip
+ 2, ip
+ 3) == 4 &&
697 ip
[0] <= 255 && ip
[1] <= 255 && ip
[2] <= 255 && ip
[3] <= 255)
699 first
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
703 first
->addr
.ipv4
.sin_family
= AF_INET
;
704 first
->addr
.ipv4
.sin_addr
.s_addr
= htonl((((((((unsigned)ip
[0] << 8) |
705 (unsigned)ip
[1]) << 8) |
706 (unsigned)ip
[2]) << 8) |
708 first
->addr
.ipv4
.sin_port
= htons(portnum
);
711 else if ((host
= gethostbyname(hostname
)) != NULL
&&
713 (host
->h_addrtype
== AF_INET
|| host
->h_addrtype
== AF_INET6
))
715 host
->h_addrtype
== AF_INET
)
716 # endif /* AF_INET6 */
718 for (i
= 0; host
->h_addr_list
[i
]; i
++)
721 * Copy the address over...
724 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
727 httpAddrFreeList(first
);
732 if (host
->h_addrtype
== AF_INET6
)
734 temp
->addr
.ipv6
.sin6_family
= AF_INET6
;
735 memcpy(&(temp
->addr
.ipv6
.sin6_addr
), host
->h_addr_list
[i
],
736 sizeof(temp
->addr
.ipv6
));
737 temp
->addr
.ipv6
.sin6_port
= htons(portnum
);
740 # endif /* AF_INET6 */
742 temp
->addr
.ipv4
.sin_family
= AF_INET
;
743 memcpy(&(temp
->addr
.ipv4
.sin_addr
), host
->h_addr_list
[i
],
744 sizeof(temp
->addr
.ipv4
));
745 temp
->addr
.ipv4
.sin_port
= htons(portnum
);
749 * Append the address to the list...
763 if (h_errno
== NO_RECOVERY
)
764 cg
->need_res_init
= 1;
766 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, hstrerror(h_errno
), 0);
769 #endif /* HAVE_GETADDRINFO */
773 * Detect some common errors and handle them sanely...
776 if (!addr
&& (!hostname
|| !_cups_strcasecmp(hostname
, "localhost")))
778 struct servent
*port
; /* Port number for service */
779 int portnum
; /* Port number */
783 * Lookup the service...
788 else if (isdigit(*service
& 255))
789 portnum
= atoi(service
);
790 else if ((port
= getservbyname(service
, NULL
)) != NULL
)
791 portnum
= ntohs(port
->s_port
);
792 else if (!strcmp(service
, "http"))
794 else if (!strcmp(service
, "https"))
796 else if (!strcmp(service
, "ipp") || !strcmp(service
, "ipps"))
798 else if (!strcmp(service
, "lpd"))
800 else if (!strcmp(service
, "socket"))
804 httpAddrFreeList(first
);
806 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Unknown service name."), 1);
810 if (hostname
&& !_cups_strcasecmp(hostname
, "localhost"))
813 * Unfortunately, some users ignore all of the warnings in the
814 * /etc/hosts file and delete "localhost" from it. If we get here
815 * then we were unable to resolve the name, so use the IPv6 and/or
816 * IPv4 loopback interface addresses...
820 if (family
!= AF_INET
)
823 * Add [::1] to the address list...
826 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
829 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
830 httpAddrFreeList(first
);
834 temp
->addr
.ipv6
.sin6_family
= AF_INET6
;
835 temp
->addr
.ipv6
.sin6_port
= htons(portnum
);
837 temp
->addr
.ipv6
.sin6_addr
.u
.Byte
[15] = 1;
839 temp
->addr
.ipv6
.sin6_addr
.s6_addr32
[3] = htonl(1);
848 if (family
!= AF_INET6
)
849 #endif /* AF_INET6 */
852 * Add 127.0.0.1 to the address list...
855 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
858 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
859 httpAddrFreeList(first
);
863 temp
->addr
.ipv4
.sin_family
= AF_INET
;
864 temp
->addr
.ipv4
.sin_port
= htons(portnum
);
865 temp
->addr
.ipv4
.sin_addr
.s_addr
= htonl(0x7f000001);
877 * Provide one or more passive listening addresses...
881 if (family
!= AF_INET
)
884 * Add [::] to the address list...
887 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
890 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
891 httpAddrFreeList(first
);
895 temp
->addr
.ipv6
.sin6_family
= AF_INET6
;
896 temp
->addr
.ipv6
.sin6_port
= htons(portnum
);
904 if (family
!= AF_INET6
)
905 #endif /* AF_INET6 */
908 * Add 0.0.0.0 to the address list...
911 temp
= (http_addrlist_t
*)calloc(1, sizeof(http_addrlist_t
));
914 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
915 httpAddrFreeList(first
);
919 temp
->addr
.ipv4
.sin_family
= AF_INET
;
920 temp
->addr
.ipv4
.sin_port
= htons(portnum
);
932 * Return the address list...