]>
git.ipfire.org Git - thirdparty/cups.git/blob - cups/http-addr.c
7ae25e449d19f8f4c1a44f2a8ede8cb0b5e0d9ad
4 * HTTP address routines for CUPS.
6 * Copyright 2007-2014 by Apple Inc.
7 * Copyright 1997-2006 by Easy Software Products, all rights reserved.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 * Include necessary headers...
22 #include "cups-private.h"
26 #endif /* HAVE_RESOLV_H */
28 # include <CoreFoundation/CoreFoundation.h>
29 # include <SystemConfiguration/SystemConfiguration.h>
30 #endif /* __APPLE__ */
34 * 'httpAddrAny()' - Check for the "any" address.
36 * @since CUPS 1.2/OS X 10.5@
39 int /* O - 1 if "any", 0 otherwise */
40 httpAddrAny(const http_addr_t
*addr
) /* I - Address to check */
46 if (addr
->addr
.sa_family
== AF_INET6
&&
47 IN6_IS_ADDR_UNSPECIFIED(&(addr
->ipv6
.sin6_addr
)))
51 if (addr
->addr
.sa_family
== AF_INET
&&
52 ntohl(addr
->ipv4
.sin_addr
.s_addr
) == 0x00000000)
60 * 'httpAddrClose()' - Close a socket created by @link httpAddrConnect@ or
61 * @link httpAddrListen@.
63 * Pass @code NULL@ for sockets created with @link httpAddrConnect@ and the
64 * listen address for sockets created with @link httpAddrListen@. This will
65 * ensure that domain sockets are removed when closed.
67 * @since CUPS 2.0/OS 10.10@
70 int /* O - 0 on success, -1 on failure */
71 httpAddrClose(http_addr_t
*addr
, /* I - Listen address or @code NULL@ */
72 int fd
) /* I - Socket file descriptor */
82 if (addr
&& addr
->addr
.sa_family
== AF_LOCAL
)
83 return (unlink(addr
->un
.sun_path
));
91 * 'httpAddrEqual()' - Compare two addresses.
93 * @since CUPS 1.2/OS X 10.5@
96 int /* O - 1 if equal, 0 if not */
97 httpAddrEqual(const http_addr_t
*addr1
, /* I - First address */
98 const http_addr_t
*addr2
) /* I - Second address */
100 if (!addr1
&& !addr2
)
103 if (!addr1
|| !addr2
)
106 if (addr1
->addr
.sa_family
!= addr2
->addr
.sa_family
)
110 if (addr1
->addr
.sa_family
== AF_LOCAL
)
111 return (!strcmp(addr1
->un
.sun_path
, addr2
->un
.sun_path
));
112 #endif /* AF_LOCAL */
115 if (addr1
->addr
.sa_family
== AF_INET6
)
116 return (!memcmp(&(addr1
->ipv6
.sin6_addr
), &(addr2
->ipv6
.sin6_addr
), 16));
117 #endif /* AF_INET6 */
119 return (addr1
->ipv4
.sin_addr
.s_addr
== addr2
->ipv4
.sin_addr
.s_addr
);
124 * 'httpAddrLength()' - Return the length of the address in bytes.
126 * @since CUPS 1.2/OS X 10.5@
129 int /* O - Length in bytes */
130 httpAddrLength(const http_addr_t
*addr
) /* I - Address */
136 if (addr
->addr
.sa_family
== AF_INET6
)
137 return (sizeof(addr
->ipv6
));
139 #endif /* AF_INET6 */
141 if (addr
->addr
.sa_family
== AF_LOCAL
)
142 return ((int)(offsetof(struct sockaddr_un
, sun_path
) + strlen(addr
->un
.sun_path
) + 1));
144 #endif /* AF_LOCAL */
145 if (addr
->addr
.sa_family
== AF_INET
)
146 return (sizeof(addr
->ipv4
));
154 * 'httpAddrListen()' - Create a listening socket bound to the specified
157 * @since CUPS 1.7/OS X 10.9@
160 int /* O - Socket or -1 on error */
161 httpAddrListen(http_addr_t
*addr
, /* I - Address to bind to */
162 int port
) /* I - Port number to bind to */
164 int fd
= -1, /* Socket */
165 val
, /* Socket value */
166 status
; /* Bind status */
170 * Range check input...
173 if (!addr
|| port
< 0)
177 * Create the socket and set options...
180 if ((fd
= socket(addr
->addr
.sa_family
, SOCK_STREAM
, 0)) < 0)
182 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
187 setsockopt(fd
, SOL_SOCKET
, SO_REUSEADDR
, CUPS_SOCAST
&val
, sizeof(val
));
190 if (addr
->addr
.sa_family
== AF_INET6
)
191 setsockopt(fd
, IPPROTO_IPV6
, IPV6_V6ONLY
, CUPS_SOCAST
&val
, sizeof(val
));
192 #endif /* IPV6_V6ONLY */
199 if (addr
->addr
.sa_family
== AF_LOCAL
)
201 mode_t mask
; /* Umask setting */
204 * Remove any existing domain socket file...
207 unlink(addr
->un
.sun_path
);
210 * Save the current umask and set it to 0 so that all users can access
211 * the domain socket...
217 * Bind the domain socket...
220 status
= bind(fd
, (struct sockaddr
*)addr
, (socklen_t
)httpAddrLength(addr
));
223 * Restore the umask and fix permissions...
227 chmod(addr
->un
.sun_path
, 0140777);
230 #endif /* AF_LOCAL */
232 _httpAddrSetPort(addr
, port
);
234 status
= bind(fd
, (struct sockaddr
*)addr
, (socklen_t
)httpAddrLength(addr
));
239 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
252 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
264 fcntl(fd
, F_SETFD
, fcntl(fd
, F_GETFD
) | FD_CLOEXEC
);
269 * Disable SIGPIPE for this socket.
273 setsockopt(fd
, SOL_SOCKET
, SO_NOSIGPIPE
, CUPS_SOCAST
&val
, sizeof(val
));
274 #endif /* SO_NOSIGPIPE */
281 * 'httpAddrLocalhost()' - Check for the local loopback address.
283 * @since CUPS 1.2/OS X 10.5@
286 int /* O - 1 if local host, 0 otherwise */
288 const http_addr_t
*addr
) /* I - Address to check */
294 if (addr
->addr
.sa_family
== AF_INET6
&&
295 IN6_IS_ADDR_LOOPBACK(&(addr
->ipv6
.sin6_addr
)))
297 #endif /* AF_INET6 */
300 if (addr
->addr
.sa_family
== AF_LOCAL
)
302 #endif /* AF_LOCAL */
304 if (addr
->addr
.sa_family
== AF_INET
&&
305 (ntohl(addr
->ipv4
.sin_addr
.s_addr
) & 0xff000000) == 0x7f000000)
313 * 'httpAddrLookup()' - Lookup the hostname associated with the address.
315 * @since CUPS 1.2/OS X 10.5@
318 char * /* O - Host name */
320 const http_addr_t
*addr
, /* I - Address to lookup */
321 char *name
, /* I - Host name buffer */
322 int namelen
) /* I - Size of name buffer */
324 _cups_globals_t
*cg
= _cupsGlobals();
328 DEBUG_printf(("httpAddrLookup(addr=%p, name=%p, namelen=%d)", (void *)addr
, (void *)name
, namelen
));
331 * Range check input...
334 if (!addr
|| !name
|| namelen
<= 2)
336 if (name
&& namelen
>= 1)
343 if (addr
->addr
.sa_family
== AF_LOCAL
)
345 strlcpy(name
, addr
->un
.sun_path
, (size_t)namelen
);
348 #endif /* AF_LOCAL */
351 * Optimize lookups for localhost/loopback addresses...
354 if (httpAddrLocalhost(addr
))
356 strlcpy(name
, "localhost", (size_t)namelen
);
362 * STR #2920: Initialize resolver after failure in cups-polld
364 * If the previous lookup failed, re-initialize the resolver to prevent
365 * temporary network errors from persisting. This *should* be handled by
366 * the resolver libraries, but apparently the glibc folks do not agree.
368 * We set a flag at the end of this function if we encounter an error that
369 * requires reinitialization of the resolver functions. We then call
370 * res_init() if the flag is set on the next call here or in httpAddrLookup().
373 if (cg
->need_res_init
)
377 cg
->need_res_init
= 0;
379 #endif /* HAVE_RES_INIT */
381 #ifdef HAVE_GETNAMEINFO
384 * STR #2486: httpAddrLookup() fails when getnameinfo() returns EAI_AGAIN
386 * FWIW, I think this is really a bug in the implementation of
387 * getnameinfo(), but falling back on httpAddrString() is easy to
391 int error
= getnameinfo(&addr
->addr
, (socklen_t
)httpAddrLength(addr
), name
, (socklen_t
)namelen
, NULL
, 0, 0);
395 if (error
== EAI_FAIL
)
396 cg
->need_res_init
= 1;
398 return (httpAddrString(addr
, name
, namelen
));
403 struct hostent
*host
; /* Host from name service */
407 if (addr
->addr
.sa_family
== AF_INET6
)
408 host
= gethostbyaddr((char *)&(addr
->ipv6
.sin6_addr
),
409 sizeof(struct in_addr
), AF_INET6
);
411 # endif /* AF_INET6 */
412 host
= gethostbyaddr((char *)&(addr
->ipv4
.sin_addr
),
413 sizeof(struct in_addr
), AF_INET
);
418 * No hostname, so return the raw address...
421 if (h_errno
== NO_RECOVERY
)
422 cg
->need_res_init
= 1;
424 return (httpAddrString(addr
, name
, namelen
));
427 strlcpy(name
, host
->h_name
, (size_t)namelen
);
429 #endif /* HAVE_GETNAMEINFO */
431 DEBUG_printf(("1httpAddrLookup: returning \"%s\"...", name
));
438 * 'httpAddrFamily()' - Get the address family of an address.
441 int /* O - Address family */
442 httpAddrFamily(http_addr_t
*addr
) /* I - Address */
445 return (addr
->addr
.sa_family
);
452 * 'httpAddrPort()' - Get the port number associated with an address.
454 * @since CUPS 1.7/OS X 10.9@
457 int /* O - Port number */
458 httpAddrPort(http_addr_t
*addr
) /* I - Address */
463 else if (addr
->addr
.sa_family
== AF_INET6
)
464 return (ntohs(addr
->ipv6
.sin6_port
));
465 #endif /* AF_INET6 */
466 else if (addr
->addr
.sa_family
== AF_INET
)
467 return (ntohs(addr
->ipv4
.sin_port
));
474 * '_httpAddrSetPort()' - Set the port number associated with an address.
478 _httpAddrSetPort(http_addr_t
*addr
, /* I - Address */
479 int port
) /* I - Port */
481 if (!addr
|| port
<= 0)
485 if (addr
->addr
.sa_family
== AF_INET6
)
486 addr
->ipv6
.sin6_port
= htons(port
);
488 #endif /* AF_INET6 */
489 if (addr
->addr
.sa_family
== AF_INET
)
490 addr
->ipv4
.sin_port
= htons(port
);
495 * 'httpAddrString()' - Convert an address to a numeric string.
497 * @since CUPS 1.2/OS X 10.5@
500 char * /* O - Numeric address string */
501 httpAddrString(const http_addr_t
*addr
, /* I - Address to convert */
502 char *s
, /* I - String buffer */
503 int slen
) /* I - Length of string */
505 DEBUG_printf(("httpAddrString(addr=%p, s=%p, slen=%d)", (void *)addr
, (void *)s
, slen
));
508 * Range check input...
511 if (!addr
|| !s
|| slen
<= 2)
520 if (addr
->addr
.sa_family
== AF_LOCAL
)
522 if (addr
->un
.sun_path
[0] == '/')
523 strlcpy(s
, addr
->un
.sun_path
, (size_t)slen
);
525 strlcpy(s
, "localhost", (size_t)slen
);
528 #endif /* AF_LOCAL */
529 if (addr
->addr
.sa_family
== AF_INET
)
531 unsigned temp
; /* Temporary address */
533 temp
= ntohl(addr
->ipv4
.sin_addr
.s_addr
);
535 snprintf(s
, (size_t)slen
, "%d.%d.%d.%d", (temp
>> 24) & 255,
536 (temp
>> 16) & 255, (temp
>> 8) & 255, temp
& 255);
539 else if (addr
->addr
.sa_family
== AF_INET6
)
541 char *sptr
, /* Pointer into string */
542 temps
[64]; /* Temporary string for address */
544 # ifdef HAVE_GETNAMEINFO
545 if (getnameinfo(&addr
->addr
, (socklen_t
)httpAddrLength(addr
), temps
, sizeof(temps
), NULL
, 0, NI_NUMERICHOST
))
548 * If we get an error back, then the address type is not supported
549 * and we should zero out the buffer...
556 else if ((sptr
= strchr(temps
, '%')) != NULL
)
559 * Convert "%zone" to "+zone" to match URI form...
566 int i
; /* Looping var */
567 unsigned temp
; /* Current value */
568 const char *prefix
; /* Prefix for address */
572 for (sptr
= temps
, i
= 0; i
< 4 && addr
->ipv6
.sin6_addr
.s6_addr32
[i
]; i
++)
574 temp
= ntohl(addr
->ipv6
.sin6_addr
.s6_addr32
[i
]);
576 snprintf(sptr
, sizeof(temps
) - (size_t)(sptr
- temps
), "%s%x", prefix
, (temp
>> 16) & 0xffff);
578 sptr
+= strlen(sptr
);
582 if (temp
|| i
== 3 || addr
->ipv6
.sin6_addr
.s6_addr32
[i
+ 1])
584 snprintf(sptr
, sizeof(temps
) - (size_t)(sptr
- temps
), "%s%x", prefix
, temp
);
585 sptr
+= strlen(sptr
);
591 while (i
< 4 && !addr
->ipv6
.sin6_addr
.s6_addr32
[i
])
596 snprintf(sptr
, sizeof(temps
) - (size_t)(sptr
- temps
), "%s:", prefix
);
598 sptr
+= strlen(sptr
);
602 temp
= ntohl(addr
->ipv6
.sin6_addr
.s6_addr32
[i
]);
604 if ((temp
& 0xffff0000) ||
605 (i
> 0 && addr
->ipv6
.sin6_addr
.s6_addr32
[i
- 1]))
607 snprintf(sptr
, sizeof(temps
) - (size_t)(sptr
- temps
), "%s%x", prefix
, (temp
>> 16) & 0xffff);
608 sptr
+= strlen(sptr
);
611 snprintf(sptr
, sizeof(temps
) - (size_t)(sptr
- temps
), "%s%x", prefix
, temp
& 0xffff);
612 sptr
+= strlen(sptr
);
621 strlcpy(temps
, "::", sizeof(temps
));
629 strlcpy(sptr
, "::", sizeof(temps
) - (size_t)(sptr
- temps
));
632 # endif /* HAVE_GETNAMEINFO */
635 * Add "[v1." and "]" around IPv6 address to convert to URI form.
638 snprintf(s
, (size_t)slen
, "[v1.%s]", temps
);
640 #endif /* AF_INET6 */
642 strlcpy(s
, "UNKNOWN", (size_t)slen
);
644 DEBUG_printf(("1httpAddrString: returning \"%s\"...", s
));
651 * 'httpGetAddress()' - Get the address of the connected peer of a connection.
653 * Returns @code NULL@ if the socket is currently unconnected.
655 * @since CUPS 2.0/OS 10.10@
658 http_addr_t
* /* O - Connected address or @code NULL@ */
659 httpGetAddress(http_t
*http
) /* I - HTTP connection */
662 return (http
->hostaddr
);
669 * 'httpGetHostByName()' - Lookup a hostname or IPv4 address, and return
670 * address records for the specified name.
675 struct hostent
* /* O - Host entry */
676 httpGetHostByName(const char *name
) /* I - Hostname or IP address */
678 const char *nameptr
; /* Pointer into name */
679 unsigned ip
[4]; /* IP address components */
680 _cups_globals_t
*cg
= _cupsGlobals();
681 /* Pointer to library globals */
684 DEBUG_printf(("httpGetHostByName(name=\"%s\")", name
));
687 * Avoid lookup delays and configuration problems when connecting
688 * to the localhost address...
691 if (!strcmp(name
, "localhost"))
695 * This function is needed because some operating systems have a
696 * buggy implementation of gethostbyname() that does not support
697 * IP addresses. If the first character of the name string is a
698 * number, then sscanf() is used to extract the IP components.
699 * We then pack the components into an IPv4 address manually,
700 * since the inet_aton() function is deprecated. We use the
701 * htonl() macro to get the right byte order for the address.
703 * We also support domain sockets when supported by the underlying
711 * A domain socket address, so make an AF_LOCAL entry and return it...
714 cg
->hostent
.h_name
= (char *)name
;
715 cg
->hostent
.h_aliases
= NULL
;
716 cg
->hostent
.h_addrtype
= AF_LOCAL
;
717 cg
->hostent
.h_length
= (int)strlen(name
) + 1;
718 cg
->hostent
.h_addr_list
= cg
->ip_ptrs
;
719 cg
->ip_ptrs
[0] = (char *)name
;
720 cg
->ip_ptrs
[1] = NULL
;
722 DEBUG_puts("1httpGetHostByName: returning domain socket address...");
724 return (&cg
->hostent
);
726 #endif /* AF_LOCAL */
728 for (nameptr
= name
; isdigit(*nameptr
& 255) || *nameptr
== '.'; nameptr
++);
733 * We have an IPv4 address; break it up and provide the host entry
737 if (sscanf(name
, "%u.%u.%u.%u", ip
, ip
+ 1, ip
+ 2, ip
+ 3) != 4)
738 return (NULL
); /* Must have 4 numbers */
740 if (ip
[0] > 255 || ip
[1] > 255 || ip
[2] > 255 || ip
[3] > 255)
741 return (NULL
); /* Invalid byte ranges! */
743 cg
->ip_addr
= htonl((((((((unsigned)ip
[0] << 8) | (unsigned)ip
[1]) << 8) |
744 (unsigned)ip
[2]) << 8) |
748 * Fill in the host entry and return it...
751 cg
->hostent
.h_name
= (char *)name
;
752 cg
->hostent
.h_aliases
= NULL
;
753 cg
->hostent
.h_addrtype
= AF_INET
;
754 cg
->hostent
.h_length
= 4;
755 cg
->hostent
.h_addr_list
= cg
->ip_ptrs
;
756 cg
->ip_ptrs
[0] = (char *)&(cg
->ip_addr
);
757 cg
->ip_ptrs
[1] = NULL
;
759 DEBUG_puts("1httpGetHostByName: returning IPv4 address...");
761 return (&cg
->hostent
);
766 * Use the gethostbyname() function to get the IPv4 address for
770 DEBUG_puts("1httpGetHostByName: returning domain lookup address(es)...");
772 return (gethostbyname(name
));
778 * 'httpGetHostname()' - Get the FQDN for the connection or local system.
780 * When "http" points to a connected socket, return the hostname or
781 * address that was used in the call to httpConnect() or httpConnectEncrypt(),
782 * or the address of the client for the connection from httpAcceptConnection().
783 * Otherwise, return the FQDN for the local system using both gethostname()
784 * and gethostbyname() to get the local hostname with domain.
786 * @since CUPS 1.2/OS X 10.5@
789 const char * /* O - FQDN for connection or system */
790 httpGetHostname(http_t
*http
, /* I - HTTP connection or NULL */
791 char *s
, /* I - String buffer for name */
792 int slen
) /* I - Size of buffer */
798 if (http
->hostname
[0] == '/')
799 return ("localhost");
801 return (http
->hostname
);
803 else if (http
->hostname
[0] == '/')
804 strlcpy(s
, "localhost", (size_t)slen
);
806 strlcpy(s
, http
->hostname
, (size_t)slen
);
811 * Get the hostname...
817 if (gethostname(s
, (size_t)slen
) < 0)
818 strlcpy(s
, "localhost", (size_t)slen
);
822 #ifdef HAVE_SCDYNAMICSTORECOPYCOMPUTERNAME
824 * The hostname is not a FQDN, so use the local hostname from the
825 * SystemConfiguration framework...
828 SCDynamicStoreRef sc
= SCDynamicStoreCreate(kCFAllocatorDefault
,
829 CFSTR("libcups"), NULL
, NULL
);
830 /* System configuration data */
831 CFStringRef local
= sc
? SCDynamicStoreCopyLocalHostName(sc
) : NULL
;
832 /* Local host name */
833 char localStr
[1024]; /* Local host name C string */
835 if (local
&& CFStringGetCString(local
, localStr
, sizeof(localStr
),
836 kCFStringEncodingUTF8
))
839 * Append ".local." to the hostname we get...
842 snprintf(s
, (size_t)slen
, "%s.local.", localStr
);
852 * The hostname is not a FQDN, so look it up...
855 struct hostent
*host
; /* Host entry to get FQDN */
857 if ((host
= gethostbyname(s
)) != NULL
&& host
->h_name
)
860 * Use the resolved hostname...
863 strlcpy(s
, host
->h_name
, (size_t)slen
);
865 #endif /* HAVE_SCDYNAMICSTORECOPYCOMPUTERNAME */
869 * Make sure .local hostnames end with a period...
872 if (strlen(s
) > 6 && !strcmp(s
+ strlen(s
) - 6, ".local"))
873 strlcat(s
, ".", (size_t)slen
);
877 * Return the hostname with as much domain info as we have...
885 * 'httpResolveHostname()' - Resolve the hostname of the HTTP connection
888 * @since CUPS 2.0/OS 10.10@
891 const char * /* O - Resolved hostname or @code NULL@ */
892 httpResolveHostname(http_t
*http
, /* I - HTTP connection */
893 char *buffer
, /* I - Hostname buffer */
894 size_t bufsize
) /* I - Size of buffer */
899 if (isdigit(http
->hostname
[0] & 255) || http
->hostname
[0] == '[')
901 char temp
[1024]; /* Temporary string */
903 if (httpAddrLookup(http
->hostaddr
, temp
, sizeof(temp
)))
904 strlcpy(http
->hostname
, temp
, sizeof(http
->hostname
));
911 if (http
->hostname
[0] == '/')
912 strlcpy(buffer
, "localhost", bufsize
);
914 strlcpy(buffer
, http
->hostname
, bufsize
);
918 else if (http
->hostname
[0] == '/')
919 return ("localhost");
921 return (http
->hostname
);