]>
git.ipfire.org Git - thirdparty/cups.git/blob - cups/http-addr.c
4 * HTTP address routines for CUPS.
6 * Copyright 2007-2013 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/".
17 * httpAddrAny() - Check for the "any" address.
18 * httpAddrEqual() - Compare two addresses.
19 * httpAddrLength() - Return the length of the address in bytes.
20 * httpAddrListen() - Create a listening socket bound to the specified
22 * httpAddrLocalhost() - Check for the local loopback address.
23 * httpAddrLookup() - Lookup the hostname associated with the address.
24 * httpAddrPort() - Get the port number associated with an address.
25 * _httpAddrSetPort() - Set the port number associated with an address.
26 * httpAddrString() - Convert an address to a numeric string.
27 * httpGetHostByName() - Lookup a hostname or IPv4 address, and return
28 * address records for the specified name.
29 * httpGetHostname() - Get the FQDN for the connection or local system.
33 * Include necessary headers...
36 #include "cups-private.h"
39 #endif /* HAVE_RESOLV_H */
41 # include <CoreFoundation/CoreFoundation.h>
42 # include <SystemConfiguration/SystemConfiguration.h>
43 #endif /* __APPLE__ */
47 * 'httpAddrAny()' - Check for the "any" address.
49 * @since CUPS 1.2/OS X 10.5@
52 int /* O - 1 if "any", 0 otherwise */
53 httpAddrAny(const http_addr_t
*addr
) /* I - Address to check */
59 if (addr
->addr
.sa_family
== AF_INET6
&&
60 IN6_IS_ADDR_UNSPECIFIED(&(addr
->ipv6
.sin6_addr
)))
64 if (addr
->addr
.sa_family
== AF_INET
&&
65 ntohl(addr
->ipv4
.sin_addr
.s_addr
) == 0x00000000)
73 * 'httpAddrEqual()' - Compare two addresses.
75 * @since CUPS 1.2/OS X 10.5@
78 int /* O - 1 if equal, 0 if not */
79 httpAddrEqual(const http_addr_t
*addr1
, /* I - First address */
80 const http_addr_t
*addr2
) /* I - Second address */
88 if (addr1
->addr
.sa_family
!= addr2
->addr
.sa_family
)
92 if (addr1
->addr
.sa_family
== AF_LOCAL
)
93 return (!strcmp(addr1
->un
.sun_path
, addr2
->un
.sun_path
));
97 if (addr1
->addr
.sa_family
== AF_INET6
)
98 return (!memcmp(&(addr1
->ipv6
.sin6_addr
), &(addr2
->ipv6
.sin6_addr
), 16));
101 return (addr1
->ipv4
.sin_addr
.s_addr
== addr2
->ipv4
.sin_addr
.s_addr
);
106 * 'httpAddrLength()' - Return the length of the address in bytes.
108 * @since CUPS 1.2/OS X 10.5@
111 int /* O - Length in bytes */
112 httpAddrLength(const http_addr_t
*addr
) /* I - Address */
118 if (addr
->addr
.sa_family
== AF_INET6
)
119 return (sizeof(addr
->ipv6
));
121 #endif /* AF_INET6 */
123 if (addr
->addr
.sa_family
== AF_LOCAL
)
124 return (offsetof(struct sockaddr_un
, sun_path
) +
125 strlen(addr
->un
.sun_path
) + 1);
127 #endif /* AF_LOCAL */
128 if (addr
->addr
.sa_family
== AF_INET
)
129 return (sizeof(addr
->ipv4
));
137 * 'httpAddrListen()' - Create a listening socket bound to the specified
143 int /* O - Socket or -1 on error */
144 httpAddrListen(http_addr_t
*addr
, /* I - Address to bind to */
145 int port
) /* I - Port number to bind to */
147 int fd
= -1, /* Socket */
148 val
; /* Socket value */
152 * Range check input...
155 if (!addr
|| port
<= 0)
158 if ((fd
= socket(addr
->addr
.sa_family
, SOCK_STREAM
, 0)) < 0)
160 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
165 setsockopt(fd
, SOL_SOCKET
, SO_REUSEADDR
, CUPS_SOCAST
&val
, sizeof(val
));
168 if (addr
->addr
.sa_family
== AF_INET6
)
169 setsockopt(fd
, IPPROTO_IPV6
, IPV6_V6ONLY
, CUPS_SOCAST
&val
, sizeof(val
));
170 #endif /* IPV6_V6ONLY */
172 _httpAddrSetPort(addr
, port
);
174 if (bind(fd
, (struct sockaddr
*)addr
, httpAddrLength(addr
)))
176 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
185 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
194 * Disable SIGPIPE for this socket.
198 setsockopt(fd
, SOL_SOCKET
, SO_NOSIGPIPE
, CUPS_SOCAST
&val
, sizeof(val
));
199 #endif /* SO_NOSIGPIPE */
206 * 'httpAddrLocalhost()' - Check for the local loopback address.
208 * @since CUPS 1.2/OS X 10.5@
211 int /* O - 1 if local host, 0 otherwise */
213 const http_addr_t
*addr
) /* I - Address to check */
219 if (addr
->addr
.sa_family
== AF_INET6
&&
220 IN6_IS_ADDR_LOOPBACK(&(addr
->ipv6
.sin6_addr
)))
222 #endif /* AF_INET6 */
225 if (addr
->addr
.sa_family
== AF_LOCAL
)
227 #endif /* AF_LOCAL */
229 if (addr
->addr
.sa_family
== AF_INET
&&
230 (ntohl(addr
->ipv4
.sin_addr
.s_addr
) & 0xff000000) == 0x7f000000)
238 * 'httpAddrLookup()' - Lookup the hostname associated with the address.
240 * @since CUPS 1.2/OS X 10.5@
243 char * /* O - Host name */
245 const http_addr_t
*addr
, /* I - Address to lookup */
246 char *name
, /* I - Host name buffer */
247 int namelen
) /* I - Size of name buffer */
249 _cups_globals_t
*cg
= _cupsGlobals();
253 DEBUG_printf(("httpAddrLookup(addr=%p, name=%p, namelen=%d)", addr
, name
,
257 * Range check input...
260 if (!addr
|| !name
|| namelen
<= 2)
262 if (name
&& namelen
>= 1)
269 if (addr
->addr
.sa_family
== AF_LOCAL
)
271 strlcpy(name
, addr
->un
.sun_path
, namelen
);
274 #endif /* AF_LOCAL */
277 * Optimize lookups for localhost/loopback addresses...
280 if (httpAddrLocalhost(addr
))
282 strlcpy(name
, "localhost", namelen
);
288 * STR #2920: Initialize resolver after failure in cups-polld
290 * If the previous lookup failed, re-initialize the resolver to prevent
291 * temporary network errors from persisting. This *should* be handled by
292 * the resolver libraries, but apparently the glibc folks do not agree.
294 * We set a flag at the end of this function if we encounter an error that
295 * requires reinitialization of the resolver functions. We then call
296 * res_init() if the flag is set on the next call here or in httpAddrLookup().
299 if (cg
->need_res_init
)
303 cg
->need_res_init
= 0;
305 #endif /* HAVE_RES_INIT */
307 #ifdef HAVE_GETNAMEINFO
310 * STR #2486: httpAddrLookup() fails when getnameinfo() returns EAI_AGAIN
312 * FWIW, I think this is really a bug in the implementation of
313 * getnameinfo(), but falling back on httpAddrString() is easy to
317 int error
= getnameinfo(&addr
->addr
, httpAddrLength(addr
), name
, namelen
,
322 if (error
== EAI_FAIL
)
323 cg
->need_res_init
= 1;
325 return (httpAddrString(addr
, name
, namelen
));
330 struct hostent
*host
; /* Host from name service */
334 if (addr
->addr
.sa_family
== AF_INET6
)
335 host
= gethostbyaddr((char *)&(addr
->ipv6
.sin6_addr
),
336 sizeof(struct in_addr
), AF_INET6
);
338 # endif /* AF_INET6 */
339 host
= gethostbyaddr((char *)&(addr
->ipv4
.sin_addr
),
340 sizeof(struct in_addr
), AF_INET
);
345 * No hostname, so return the raw address...
348 if (h_errno
== NO_RECOVERY
)
349 cg
->need_res_init
= 1;
351 return (httpAddrString(addr
, name
, namelen
));
354 strlcpy(name
, host
->h_name
, namelen
);
356 #endif /* HAVE_GETNAMEINFO */
358 DEBUG_printf(("1httpAddrLookup: returning \"%s\"...", name
));
365 * 'httpAddrPort()' - Get the port number associated with an address.
370 int /* O - Port number */
371 httpAddrPort(http_addr_t
*addr
) /* I - Address */
376 else if (addr
->addr
.sa_family
== AF_INET6
)
377 return (ntohs(addr
->ipv6
.sin6_port
));
378 #endif /* AF_INET6 */
379 else if (addr
->addr
.sa_family
== AF_INET
)
380 return (ntohs(addr
->ipv4
.sin_port
));
385 /* For OS X 10.8 and earlier */
386 int _httpAddrPort(http_addr_t
*addr
) { return (httpAddrPort(addr
)); }
390 * '_httpAddrSetPort()' - Set the port number associated with an address.
394 _httpAddrSetPort(http_addr_t
*addr
, /* I - Address */
395 int port
) /* I - Port */
397 if (!addr
|| port
<= 0)
401 if (addr
->addr
.sa_family
== AF_INET6
)
402 addr
->ipv6
.sin6_port
= htons(port
);
404 #endif /* AF_INET6 */
405 if (addr
->addr
.sa_family
== AF_INET
)
406 addr
->ipv4
.sin_port
= htons(port
);
411 * 'httpAddrString()' - Convert an address to a numeric string.
413 * @since CUPS 1.2/OS X 10.5@
416 char * /* O - Numeric address string */
417 httpAddrString(const http_addr_t
*addr
, /* I - Address to convert */
418 char *s
, /* I - String buffer */
419 int slen
) /* I - Length of string */
421 DEBUG_printf(("httpAddrString(addr=%p, s=%p, slen=%d)", addr
, s
, slen
));
424 * Range check input...
427 if (!addr
|| !s
|| slen
<= 2)
436 if (addr
->addr
.sa_family
== AF_LOCAL
)
438 if (addr
->un
.sun_path
[0] == '/')
439 strlcpy(s
, addr
->un
.sun_path
, slen
);
441 strlcpy(s
, "localhost", slen
);
444 #endif /* AF_LOCAL */
445 if (addr
->addr
.sa_family
== AF_INET
)
447 unsigned temp
; /* Temporary address */
450 temp
= ntohl(addr
->ipv4
.sin_addr
.s_addr
);
452 snprintf(s
, slen
, "%d.%d.%d.%d", (temp
>> 24) & 255,
453 (temp
>> 16) & 255, (temp
>> 8) & 255, temp
& 255);
456 else if (addr
->addr
.sa_family
== AF_INET6
)
458 char *sptr
, /* Pointer into string */
459 temps
[64]; /* Temporary string for address */
461 # ifdef HAVE_GETNAMEINFO
462 if (getnameinfo(&addr
->addr
, httpAddrLength(addr
), temps
, sizeof(temps
),
463 NULL
, 0, NI_NUMERICHOST
))
466 * If we get an error back, then the address type is not supported
467 * and we should zero out the buffer...
474 else if ((sptr
= strchr(temps
, '%')) != NULL
)
477 * Convert "%zone" to "+zone" to match URI form...
484 int i
; /* Looping var */
485 unsigned temp
; /* Current value */
486 const char *prefix
; /* Prefix for address */
490 for (sptr
= temps
, i
= 0; i
< 4 && addr
->ipv6
.sin6_addr
.s6_addr32
[i
]; i
++)
492 temp
= ntohl(addr
->ipv6
.sin6_addr
.s6_addr32
[i
]);
494 snprintf(sptr
, sizeof(temps
) - (sptr
- temps
), "%s%x", prefix
,
495 (temp
>> 16) & 0xffff);
497 sptr
+= strlen(sptr
);
501 if (temp
|| i
== 3 || addr
->ipv6
.sin6_addr
.s6_addr32
[i
+ 1])
503 snprintf(sptr
, sizeof(temps
) - (sptr
- temps
), "%s%x", prefix
, temp
);
504 sptr
+= strlen(sptr
);
510 while (i
< 4 && !addr
->ipv6
.sin6_addr
.s6_addr32
[i
])
515 snprintf(sptr
, sizeof(temps
) - (sptr
- temps
), "%s:", prefix
);
517 sptr
+= strlen(sptr
);
521 temp
= ntohl(addr
->ipv6
.sin6_addr
.s6_addr32
[i
]);
523 if ((temp
& 0xffff0000) ||
524 (i
> 0 && addr
->ipv6
.sin6_addr
.s6_addr32
[i
- 1]))
526 snprintf(sptr
, sizeof(temps
) - (sptr
- temps
), "%s%x", prefix
,
527 (temp
>> 16) & 0xffff);
528 sptr
+= strlen(sptr
);
531 snprintf(sptr
, sizeof(temps
) - (sptr
- temps
), "%s%x", prefix
,
533 sptr
+= strlen(sptr
);
542 strlcpy(temps
, "::", sizeof(temps
));
550 strlcpy(sptr
, "::", sizeof(temps
) - (sptr
- temps
));
553 # endif /* HAVE_GETNAMEINFO */
556 * Add "[v1." and "]" around IPv6 address to convert to URI form.
559 snprintf(s
, slen
, "[v1.%s]", temps
);
561 #endif /* AF_INET6 */
563 strlcpy(s
, "UNKNOWN", slen
);
565 DEBUG_printf(("1httpAddrString: returning \"%s\"...", s
));
572 * 'httpGetHostByName()' - Lookup a hostname or IPv4 address, and return
573 * address records for the specified name.
578 struct hostent
* /* O - Host entry */
579 httpGetHostByName(const char *name
) /* I - Hostname or IP address */
581 const char *nameptr
; /* Pointer into name */
582 unsigned ip
[4]; /* IP address components */
583 _cups_globals_t
*cg
= _cupsGlobals();
584 /* Pointer to library globals */
587 DEBUG_printf(("httpGetHostByName(name=\"%s\")", name
));
590 * Avoid lookup delays and configuration problems when connecting
591 * to the localhost address...
594 if (!strcmp(name
, "localhost"))
598 * This function is needed because some operating systems have a
599 * buggy implementation of gethostbyname() that does not support
600 * IP addresses. If the first character of the name string is a
601 * number, then sscanf() is used to extract the IP components.
602 * We then pack the components into an IPv4 address manually,
603 * since the inet_aton() function is deprecated. We use the
604 * htonl() macro to get the right byte order for the address.
606 * We also support domain sockets when supported by the underlying
614 * A domain socket address, so make an AF_LOCAL entry and return it...
617 cg
->hostent
.h_name
= (char *)name
;
618 cg
->hostent
.h_aliases
= NULL
;
619 cg
->hostent
.h_addrtype
= AF_LOCAL
;
620 cg
->hostent
.h_length
= strlen(name
) + 1;
621 cg
->hostent
.h_addr_list
= cg
->ip_ptrs
;
622 cg
->ip_ptrs
[0] = (char *)name
;
623 cg
->ip_ptrs
[1] = NULL
;
625 DEBUG_puts("1httpGetHostByName: returning domain socket address...");
627 return (&cg
->hostent
);
629 #endif /* AF_LOCAL */
631 for (nameptr
= name
; isdigit(*nameptr
& 255) || *nameptr
== '.'; nameptr
++);
636 * We have an IPv4 address; break it up and provide the host entry
640 if (sscanf(name
, "%u.%u.%u.%u", ip
, ip
+ 1, ip
+ 2, ip
+ 3) != 4)
641 return (NULL
); /* Must have 4 numbers */
643 if (ip
[0] > 255 || ip
[1] > 255 || ip
[2] > 255 || ip
[3] > 255)
644 return (NULL
); /* Invalid byte ranges! */
646 cg
->ip_addr
= htonl(((((((ip
[0] << 8) | ip
[1]) << 8) | ip
[2]) << 8) |
650 * Fill in the host entry and return it...
653 cg
->hostent
.h_name
= (char *)name
;
654 cg
->hostent
.h_aliases
= NULL
;
655 cg
->hostent
.h_addrtype
= AF_INET
;
656 cg
->hostent
.h_length
= 4;
657 cg
->hostent
.h_addr_list
= cg
->ip_ptrs
;
658 cg
->ip_ptrs
[0] = (char *)&(cg
->ip_addr
);
659 cg
->ip_ptrs
[1] = NULL
;
661 DEBUG_puts("1httpGetHostByName: returning IPv4 address...");
663 return (&cg
->hostent
);
668 * Use the gethostbyname() function to get the IPv4 address for
672 DEBUG_puts("1httpGetHostByName: returning domain lookup address(es)...");
674 return (gethostbyname(name
));
680 * 'httpGetHostname()' - Get the FQDN for the connection or local system.
682 * When "http" points to a connected socket, return the hostname or
683 * address that was used in the call to httpConnect() or httpConnectEncrypt().
684 * Otherwise, return the FQDN for the local system using both gethostname()
685 * and gethostbyname() to get the local hostname with domain.
687 * @since CUPS 1.2/OS X 10.5@
690 const char * /* O - FQDN for connection or system */
691 httpGetHostname(http_t
*http
, /* I - HTTP connection or NULL */
692 char *s
, /* I - String buffer for name */
693 int slen
) /* I - Size of buffer */
700 if (http
->hostname
[0] == '/')
701 strlcpy(s
, "localhost", slen
);
703 strlcpy(s
, http
->hostname
, slen
);
708 * Get the hostname...
711 if (gethostname(s
, slen
) < 0)
712 strlcpy(s
, "localhost", slen
);
716 #ifdef HAVE_SCDYNAMICSTORECOPYCOMPUTERNAME
718 * The hostname is not a FQDN, so use the local hostname from the
719 * SystemConfiguration framework...
722 SCDynamicStoreRef sc
= SCDynamicStoreCreate(kCFAllocatorDefault
,
723 CFSTR("libcups"), NULL
, NULL
);
724 /* System configuration data */
725 CFStringRef local
= sc
? SCDynamicStoreCopyLocalHostName(sc
) : NULL
;
726 /* Local host name */
727 char localStr
[1024]; /* Local host name C string */
729 if (local
&& CFStringGetCString(local
, localStr
, sizeof(localStr
),
730 kCFStringEncodingUTF8
))
733 * Append ".local." to the hostname we get...
736 snprintf(s
, slen
, "%s.local.", localStr
);
746 * The hostname is not a FQDN, so look it up...
749 struct hostent
*host
; /* Host entry to get FQDN */
751 if ((host
= gethostbyname(s
)) != NULL
&& host
->h_name
)
754 * Use the resolved hostname...
757 strlcpy(s
, host
->h_name
, slen
);
759 #endif /* HAVE_SCDYNAMICSTORECOPYCOMPUTERNAME */
764 * Return the hostname with as much domain info as we have...