2 * HTTP support routines for CUPS.
4 * Copyright 2007-2019 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"
21 # elif defined(HAVE_POLL)
24 # include <sys/select.h>
26 #elif defined(HAVE_AVAHI)
27 # include <avahi-client/client.h>
28 # include <avahi-client/lookup.h>
29 # include <avahi-common/simple-watch.h>
30 #endif /* HAVE_DNSSD */
37 typedef struct _http_uribuf_s
/* URI buffer */
40 AvahiSimplePoll
*poll
; /* Poll state */
41 #endif /* HAVE_AVAHI */
42 char *buffer
; /* Pointer to buffer */
43 size_t bufsize
; /* Size of buffer */
44 int options
; /* Options passed to _httpResolveURI */
45 const char *resource
; /* Resource from URI */
46 const char *uuid
; /* UUID from URI */
54 static const char * const http_days
[7] =/* Days of the week */
64 static const char * const http_months
[12] =
65 { /* Months of the year */
79 static const char * const http_states
[] =
80 { /* HTTP state strings */
85 "HTTP_STATE_GET_SEND",
88 "HTTP_STATE_POST_RECV",
89 "HTTP_STATE_POST_SEND",
91 "HTTP_STATE_PUT_RECV",
96 "HTTP_STATE_UNKNOWN_METHOD",
97 "HTTP_STATE_UNKNOWN_VERSION"
105 static const char *http_copy_decode(char *dst
, const char *src
,
106 int dstsize
, const char *term
,
108 static char *http_copy_encode(char *dst
, const char *src
,
109 char *dstend
, const char *reserved
,
110 const char *term
, int encode
);
112 static void DNSSD_API
http_resolve_cb(DNSServiceRef sdRef
,
113 DNSServiceFlags flags
,
114 uint32_t interfaceIndex
,
115 DNSServiceErrorType errorCode
,
116 const char *fullName
,
117 const char *hostTarget
,
118 uint16_t port
, uint16_t txtLen
,
119 const unsigned char *txtRecord
,
121 #endif /* HAVE_DNSSD */
124 static void http_client_cb(AvahiClient
*client
,
125 AvahiClientState state
, void *simple_poll
);
126 static int http_poll_cb(struct pollfd
*pollfds
, unsigned int num_pollfds
,
127 int timeout
, void *context
);
128 static void http_resolve_cb(AvahiServiceResolver
*resolver
,
129 AvahiIfIndex interface
,
130 AvahiProtocol protocol
,
131 AvahiResolverEvent event
,
132 const char *name
, const char *type
,
133 const char *domain
, const char *host_name
,
134 const AvahiAddress
*address
, uint16_t port
,
135 AvahiStringList
*txt
,
136 AvahiLookupResultFlags flags
, void *context
);
137 #endif /* HAVE_AVAHI */
141 * 'httpAssembleURI()' - Assemble a uniform resource identifier from its
144 * This function escapes reserved characters in the URI depending on the
145 * value of the "encoding" argument. You should use this function in
146 * place of traditional string functions whenever you need to create a
149 * @since CUPS 1.2/macOS 10.5@
152 http_uri_status_t
/* O - URI status */
154 http_uri_coding_t encoding
, /* I - Encoding flags */
155 char *uri
, /* I - URI buffer */
156 int urilen
, /* I - Size of URI buffer */
157 const char *scheme
, /* I - Scheme name */
158 const char *username
, /* I - Username */
159 const char *host
, /* I - Hostname or address */
160 int port
, /* I - Port number */
161 const char *resource
) /* I - Resource */
163 char *ptr
, /* Pointer into URI buffer */
164 *end
; /* End of URI buffer */
168 * Range check input...
171 if (!uri
|| urilen
< 1 || !scheme
|| port
< 0)
176 return (HTTP_URI_STATUS_BAD_ARGUMENTS
);
180 * Assemble the URI starting with the scheme...
183 end
= uri
+ urilen
- 1;
184 ptr
= http_copy_encode(uri
, scheme
, end
, NULL
, NULL
, 0);
187 goto assemble_overflow
;
189 if (!strcmp(scheme
, "geo") || !strcmp(scheme
, "mailto") || !strcmp(scheme
, "tel"))
192 * geo:, mailto:, and tel: only have :, no //...
198 goto assemble_overflow
;
203 * Schemes other than geo:, mailto:, and tel: typically have //...
213 goto assemble_overflow
;
217 * Next the username and hostname, if any...
222 const char *hostptr
; /* Pointer into hostname */
223 int have_ipv6
; /* Do we have an IPv6 address? */
225 if (username
&& *username
)
228 * Add username@ first...
231 ptr
= http_copy_encode(ptr
, username
, end
, "/?#[]@", NULL
,
232 encoding
& HTTP_URI_CODING_USERNAME
);
235 goto assemble_overflow
;
240 goto assemble_overflow
;
244 * Then add the hostname. Since IPv6 is a particular pain to deal
245 * with, we have several special cases to deal with. If we get
246 * an IPv6 address with brackets around it, assume it is already in
247 * URI format. Since DNS-SD service names can sometimes look like
248 * raw IPv6 addresses, we specifically look for "._tcp" in the name,
253 have_ipv6
= strchr(host
, ':') && !strstr(host
, "._tcp");
254 *hostptr
&& have_ipv6
;
256 if (*hostptr
!= ':' && !isxdigit(*hostptr
& 255))
258 have_ipv6
= *hostptr
== '%';
265 * We have a raw IPv6 address...
268 if (strchr(host
, '%') && !(encoding
& HTTP_URI_CODING_RFC6874
))
271 * We have a link-local address, add "[v1." prefix...
282 goto assemble_overflow
;
287 * We have a normal (or RFC 6874 link-local) address, add "[" prefix...
293 goto assemble_overflow
;
297 * Copy the rest of the IPv6 address, and terminate with "]".
300 while (ptr
< end
&& *host
)
305 * Convert/encode zone separator
308 if (encoding
& HTTP_URI_CODING_RFC6874
)
310 if (ptr
>= (end
- 2))
311 goto assemble_overflow
;
327 goto assemble_overflow
;
332 goto assemble_overflow
;
337 * Otherwise, just copy the host string (the extra chars are not in the
338 * "reg-name" ABNF rule; anything <= SP or >= DEL plus % gets automatically
342 ptr
= http_copy_encode(ptr
, host
, end
, "\"#/:<>?@[\\]^`{|}", NULL
,
343 encoding
& HTTP_URI_CODING_HOSTNAME
);
346 goto assemble_overflow
;
350 * Finish things off with the port number...
355 snprintf(ptr
, (size_t)(end
- ptr
+ 1), ":%d", port
);
359 goto assemble_overflow
;
364 * Last but not least, add the resource string...
369 char *query
; /* Pointer to query string */
373 * Copy the resource string up to the query string if present...
376 query
= strchr(resource
, '?');
377 ptr
= http_copy_encode(ptr
, resource
, end
, NULL
, "?",
378 encoding
& HTTP_URI_CODING_RESOURCE
);
380 goto assemble_overflow
;
385 * Copy query string without encoding...
388 ptr
= http_copy_encode(ptr
, query
, end
, NULL
, NULL
,
389 encoding
& HTTP_URI_CODING_QUERY
);
391 goto assemble_overflow
;
397 goto assemble_overflow
;
400 * Nul-terminate the URI buffer and return with no errors...
405 return (HTTP_URI_STATUS_OK
);
408 * Clear the URI string and return an overflow error; I don't usually
409 * like goto's, but in this case it makes sense...
415 return (HTTP_URI_STATUS_OVERFLOW
);
420 * 'httpAssembleURIf()' - Assemble a uniform resource identifier from its
421 * components with a formatted resource.
423 * This function creates a formatted version of the resource string
424 * argument "resourcef" and escapes reserved characters in the URI
425 * depending on the value of the "encoding" argument. You should use
426 * this function in place of traditional string functions whenever
427 * you need to create a URI string.
429 * @since CUPS 1.2/macOS 10.5@
432 http_uri_status_t
/* O - URI status */
434 http_uri_coding_t encoding
, /* I - Encoding flags */
435 char *uri
, /* I - URI buffer */
436 int urilen
, /* I - Size of URI buffer */
437 const char *scheme
, /* I - Scheme name */
438 const char *username
, /* I - Username */
439 const char *host
, /* I - Hostname or address */
440 int port
, /* I - Port number */
441 const char *resourcef
, /* I - Printf-style resource */
442 ...) /* I - Additional arguments as needed */
444 va_list ap
; /* Pointer to additional arguments */
445 char resource
[1024]; /* Formatted resource string */
446 int bytes
; /* Bytes in formatted string */
450 * Range check input...
453 if (!uri
|| urilen
< 1 || !scheme
|| port
< 0 || !resourcef
)
458 return (HTTP_URI_STATUS_BAD_ARGUMENTS
);
462 * Format the resource string and assemble the URI...
465 va_start(ap
, resourcef
);
466 bytes
= vsnprintf(resource
, sizeof(resource
), resourcef
, ap
);
469 if ((size_t)bytes
>= sizeof(resource
))
472 return (HTTP_URI_STATUS_OVERFLOW
);
475 return (httpAssembleURI(encoding
, uri
, urilen
, scheme
, username
, host
,
481 * 'httpAssembleUUID()' - Assemble a name-based UUID URN conforming to RFC 4122.
483 * This function creates a unique 128-bit identifying number using the server
484 * name, port number, random data, and optionally an object name and/or object
485 * number. The result is formatted as a UUID URN as defined in RFC 4122.
487 * The buffer needs to be at least 46 bytes in size.
489 * @since CUPS 1.7/macOS 10.9@
492 char * /* I - UUID string */
493 httpAssembleUUID(const char *server
, /* I - Server name */
494 int port
, /* I - Port number */
495 const char *name
, /* I - Object name or NULL */
496 int number
, /* I - Object number or 0 */
497 char *buffer
, /* I - String buffer */
498 size_t bufsize
) /* I - Size of buffer */
500 char data
[1024]; /* Source string for MD5 */
501 unsigned char md5sum
[16]; /* MD5 digest/sum */
505 * Build a version 3 UUID conforming to RFC 4122.
507 * Start with the MD5 sum of the server, port, object name and
508 * number, and some random data on the end.
511 snprintf(data
, sizeof(data
), "%s:%d:%s:%d:%04x:%04x", server
,
512 port
, name
? name
: server
, number
,
513 (unsigned)CUPS_RAND() & 0xffff, (unsigned)CUPS_RAND() & 0xffff);
515 cupsHashData("md5", (unsigned char *)data
, strlen(data
), md5sum
, sizeof(md5sum
));
518 * Generate the UUID from the MD5...
521 snprintf(buffer
, bufsize
,
522 "urn:uuid:%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-"
523 "%02x%02x%02x%02x%02x%02x",
524 md5sum
[0], md5sum
[1], md5sum
[2], md5sum
[3], md5sum
[4], md5sum
[5],
525 (md5sum
[6] & 15) | 0x30, md5sum
[7], (md5sum
[8] & 0x3f) | 0x40,
526 md5sum
[9], md5sum
[10], md5sum
[11], md5sum
[12], md5sum
[13],
527 md5sum
[14], md5sum
[15]);
534 * 'httpDecode64()' - Base64-decode a string.
536 * This function is deprecated. Use the httpDecode64_2() function instead
537 * which provides buffer length arguments.
539 * @deprecated@ @exclude all@
542 char * /* O - Decoded string */
543 httpDecode64(char *out
, /* I - String to write to */
544 const char *in
) /* I - String to read from */
546 int outlen
; /* Output buffer length */
550 * Use the old maximum buffer size for binary compatibility...
555 return (httpDecode64_2(out
, &outlen
, in
));
560 * 'httpDecode64_2()' - Base64-decode a string.
562 * The caller must initialize "outlen" to the maximum size of the decoded
563 * string before calling @code httpDecode64_2@. On return "outlen" contains the
564 * decoded length of the string.
566 * @since CUPS 1.1.21/macOS 10.4@
569 char * /* O - Decoded string */
570 httpDecode64_2(char *out
, /* I - String to write to */
571 int *outlen
, /* IO - Size of output string */
572 const char *in
) /* I - String to read from */
574 int pos
; /* Bit position */
575 unsigned base64
; /* Value of this character */
576 char *outptr
, /* Output pointer */
577 *outend
; /* End of output buffer */
581 * Range check input...
584 if (!out
|| !outlen
|| *outlen
< 1 || !in
)
596 * Convert from base-64 to bytes...
599 for (outptr
= out
, outend
= out
+ *outlen
- 1, pos
= 0; *in
!= '\0'; in
++)
602 * Decode this character into a number from 0 to 63...
605 if (*in
>= 'A' && *in
<= 'Z')
606 base64
= (unsigned)(*in
- 'A');
607 else if (*in
>= 'a' && *in
<= 'z')
608 base64
= (unsigned)(*in
- 'a' + 26);
609 else if (*in
>= '0' && *in
<= '9')
610 base64
= (unsigned)(*in
- '0' + 52);
621 * Store the result in the appropriate chars...
628 *outptr
= (char)(base64
<< 2);
633 *outptr
++ |= (char)((base64
>> 4) & 3);
635 *outptr
= (char)((base64
<< 4) & 255);
640 *outptr
++ |= (char)((base64
>> 2) & 15);
642 *outptr
= (char)((base64
<< 6) & 255);
647 *outptr
++ |= (char)base64
;
656 * Return the decoded string and size...
659 *outlen
= (int)(outptr
- out
);
666 * 'httpEncode64()' - Base64-encode a string.
668 * This function is deprecated. Use the httpEncode64_2() function instead
669 * which provides buffer length arguments.
671 * @deprecated@ @exclude all@
674 char * /* O - Encoded string */
675 httpEncode64(char *out
, /* I - String to write to */
676 const char *in
) /* I - String to read from */
678 return (httpEncode64_2(out
, 512, in
, (int)strlen(in
)));
683 * 'httpEncode64_2()' - Base64-encode a string.
685 * @since CUPS 1.1.21/macOS 10.4@
688 char * /* O - Encoded string */
689 httpEncode64_2(char *out
, /* I - String to write to */
690 int outlen
, /* I - Maximum size of output string */
691 const char *in
, /* I - String to read from */
692 int inlen
) /* I - Size of input string */
694 char *outptr
, /* Output pointer */
695 *outend
; /* End of output buffer */
696 static const char base64
[] = /* Base64 characters... */
698 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
699 "abcdefghijklmnopqrstuvwxyz"
706 * Range check input...
709 if (!out
|| outlen
< 1 || !in
)
713 * Convert bytes to base-64...
716 for (outptr
= out
, outend
= out
+ outlen
- 1; inlen
> 0; in
++, inlen
--)
719 * Encode the up to 3 characters as 4 Base64 numbers...
723 *outptr
++ = base64
[(in
[0] & 255) >> 2];
728 *outptr
++ = base64
[(((in
[0] & 255) << 4) | ((in
[1] & 255) >> 4)) & 63];
730 *outptr
++ = base64
[((in
[0] & 255) << 4) & 63];
747 *outptr
++ = base64
[(((in
[0] & 255) << 2) | ((in
[1] & 255) >> 6)) & 63];
749 *outptr
++ = base64
[((in
[0] & 255) << 2) & 63];
762 *outptr
++ = base64
[in
[0] & 63];
768 * Return the encoded string...
776 * 'httpGetDateString()' - Get a formatted date/time string from a time value.
778 * @deprecated@ @exclude all@
781 const char * /* O - Date/time string */
782 httpGetDateString(time_t t
) /* I - Time in seconds */
784 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
787 return (httpGetDateString2(t
, cg
->http_date
, sizeof(cg
->http_date
)));
792 * 'httpGetDateString2()' - Get a formatted date/time string from a time value.
794 * @since CUPS 1.2/macOS 10.5@
797 const char * /* O - Date/time string */
798 httpGetDateString2(time_t t
, /* I - Time in seconds */
799 char *s
, /* I - String buffer */
800 int slen
) /* I - Size of string buffer */
802 struct tm tdate
; /* UNIX date/time data */
805 gmtime_r(&t
, &tdate
);
807 snprintf(s
, (size_t)slen
, "%s, %02d %s %d %02d:%02d:%02d GMT", http_days
[tdate
.tm_wday
], tdate
.tm_mday
, http_months
[tdate
.tm_mon
], tdate
.tm_year
+ 1900, tdate
.tm_hour
, tdate
.tm_min
, tdate
.tm_sec
);
814 * 'httpGetDateTime()' - Get a time value from a formatted date/time string.
817 time_t /* O - Time in seconds */
818 httpGetDateTime(const char *s
) /* I - Date/time string */
820 int i
; /* Looping var */
821 char mon
[16]; /* Abbreviated month name */
822 int day
, year
; /* Day of month and year */
823 int hour
, min
, sec
; /* Time */
824 int days
; /* Number of days since 1970 */
825 static const int normal_days
[] = /* Days to a month, normal years */
826 { 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334, 365 };
827 static const int leap_days
[] = /* Days to a month, leap years */
828 { 0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335, 366 };
831 DEBUG_printf(("2httpGetDateTime(s=\"%s\")", s
));
834 * Extract the date and time from the formatted string...
837 if (sscanf(s
, "%*s%d%15s%d%d:%d:%d", &day
, mon
, &year
, &hour
, &min
, &sec
) < 6)
840 DEBUG_printf(("4httpGetDateTime: day=%d, mon=\"%s\", year=%d, hour=%d, "
841 "min=%d, sec=%d", day
, mon
, year
, hour
, min
, sec
));
844 * Convert the month name to a number from 0 to 11.
847 for (i
= 0; i
< 12; i
++)
848 if (!_cups_strcasecmp(mon
, http_months
[i
]))
854 DEBUG_printf(("4httpGetDateTime: i=%d", i
));
857 * Now convert the date and time to a UNIX time value in seconds since
858 * 1970. We can't use mktime() since the timezone may not be UTC but
859 * the date/time string *is* UTC.
862 if ((year
& 3) == 0 && ((year
% 100) != 0 || (year
% 400) == 0))
863 days
= leap_days
[i
] + day
- 1;
865 days
= normal_days
[i
] + day
- 1;
867 DEBUG_printf(("4httpGetDateTime: days=%d", days
));
869 days
+= (year
- 1970) * 365 + /* 365 days per year (normally) */
870 ((year
- 1) / 4 - 492) - /* + leap days */
871 ((year
- 1) / 100 - 19) + /* - 100 year days */
872 ((year
- 1) / 400 - 4); /* + 400 year days */
874 DEBUG_printf(("4httpGetDateTime: days=%d\n", days
));
876 return (days
* 86400 + hour
* 3600 + min
* 60 + sec
);
881 * 'httpSeparate()' - Separate a Universal Resource Identifier into its
884 * This function is deprecated; use the httpSeparateURI() function instead.
886 * @deprecated@ @exclude all@
890 httpSeparate(const char *uri
, /* I - Universal Resource Identifier */
891 char *scheme
, /* O - Scheme [32] (http, https, etc.) */
892 char *username
, /* O - Username [1024] */
893 char *host
, /* O - Hostname [1024] */
894 int *port
, /* O - Port number to use */
895 char *resource
) /* O - Resource/filename [1024] */
897 httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, 32, username
,
898 HTTP_MAX_URI
, host
, HTTP_MAX_URI
, port
, resource
,
904 * 'httpSeparate2()' - Separate a Universal Resource Identifier into its
907 * This function is deprecated; use the httpSeparateURI() function instead.
909 * @since CUPS 1.1.21/macOS 10.4@
910 * @deprecated@ @exclude all@
914 httpSeparate2(const char *uri
, /* I - Universal Resource Identifier */
915 char *scheme
, /* O - Scheme (http, https, etc.) */
916 int schemelen
, /* I - Size of scheme buffer */
917 char *username
, /* O - Username */
918 int usernamelen
, /* I - Size of username buffer */
919 char *host
, /* O - Hostname */
920 int hostlen
, /* I - Size of hostname buffer */
921 int *port
, /* O - Port number to use */
922 char *resource
, /* O - Resource/filename */
923 int resourcelen
) /* I - Size of resource buffer */
925 httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, schemelen
, username
,
926 usernamelen
, host
, hostlen
, port
, resource
, resourcelen
);
931 * 'httpSeparateURI()' - Separate a Universal Resource Identifier into its
934 * @since CUPS 1.2/macOS 10.5@
937 http_uri_status_t
/* O - Result of separation */
939 http_uri_coding_t decoding
, /* I - Decoding flags */
940 const char *uri
, /* I - Universal Resource Identifier */
941 char *scheme
, /* O - Scheme (http, https, etc.) */
942 int schemelen
, /* I - Size of scheme buffer */
943 char *username
, /* O - Username */
944 int usernamelen
, /* I - Size of username buffer */
945 char *host
, /* O - Hostname */
946 int hostlen
, /* I - Size of hostname buffer */
947 int *port
, /* O - Port number to use */
948 char *resource
, /* O - Resource/filename */
949 int resourcelen
) /* I - Size of resource buffer */
951 char *ptr
, /* Pointer into string... */
952 *end
; /* End of string */
953 const char *sep
; /* Separator character */
954 http_uri_status_t status
; /* Result of separation */
958 * Initialize everything to blank...
961 if (scheme
&& schemelen
> 0)
964 if (username
&& usernamelen
> 0)
967 if (host
&& hostlen
> 0)
973 if (resource
&& resourcelen
> 0)
977 * Range check input...
980 if (!uri
|| !port
|| !scheme
|| schemelen
<= 0 || !username
||
981 usernamelen
<= 0 || !host
|| hostlen
<= 0 || !resource
||
983 return (HTTP_URI_STATUS_BAD_ARGUMENTS
);
986 return (HTTP_URI_STATUS_BAD_URI
);
989 * Grab the scheme portion of the URI...
992 status
= HTTP_URI_STATUS_OK
;
994 if (!strncmp(uri
, "//", 2))
997 * Workaround for HP IPP client bug...
1000 strlcpy(scheme
, "ipp", (size_t)schemelen
);
1001 status
= HTTP_URI_STATUS_MISSING_SCHEME
;
1003 else if (*uri
== '/')
1009 strlcpy(scheme
, "file", (size_t)schemelen
);
1010 status
= HTTP_URI_STATUS_MISSING_SCHEME
;
1015 * Standard URI with scheme...
1018 for (ptr
= scheme
, end
= scheme
+ schemelen
- 1;
1019 *uri
&& *uri
!= ':' && ptr
< end
;)
1020 if (strchr("ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1021 "abcdefghijklmnopqrstuvwxyz"
1022 "0123456789-+.", *uri
) != NULL
)
1029 if (*uri
!= ':' || *scheme
== '.' || !*scheme
)
1032 return (HTTP_URI_STATUS_BAD_SCHEME
);
1039 * Set the default port number...
1042 if (!strcmp(scheme
, "http"))
1044 else if (!strcmp(scheme
, "https"))
1046 else if (!strcmp(scheme
, "ipp") || !strcmp(scheme
, "ipps"))
1048 else if (!_cups_strcasecmp(scheme
, "lpd"))
1050 else if (!strcmp(scheme
, "socket")) /* Not yet registered with IANA... */
1052 else if (strcmp(scheme
, "file") && strcmp(scheme
, "mailto") && strcmp(scheme
, "tel"))
1053 status
= HTTP_URI_STATUS_UNKNOWN_SCHEME
;
1056 * Now see if we have a hostname...
1059 if (!strncmp(uri
, "//", 2))
1062 * Yes, extract it...
1068 * Grab the username, if any...
1071 if ((sep
= strpbrk(uri
, "@/")) != NULL
&& *sep
== '@')
1074 * Get a username:password combo...
1077 uri
= http_copy_decode(username
, uri
, usernamelen
, "@",
1078 decoding
& HTTP_URI_CODING_USERNAME
);
1083 return (HTTP_URI_STATUS_BAD_USERNAME
);
1090 * Then the hostname/IP address...
1096 * Grab IPv6 address...
1103 * Skip IPvFuture ("vXXXX.") prefix...
1108 while (isxdigit(*uri
& 255))
1114 return (HTTP_URI_STATUS_BAD_HOSTNAME
);
1120 uri
= http_copy_decode(host
, uri
, hostlen
, "]",
1121 decoding
& HTTP_URI_CODING_HOSTNAME
);
1126 return (HTTP_URI_STATUS_BAD_HOSTNAME
);
1136 return (HTTP_URI_STATUS_BAD_HOSTNAME
);
1141 for (ptr
= host
; *ptr
; ptr
++)
1145 * Convert zone separator to % and stop here...
1151 else if (*ptr
== '%')
1154 * Stop at zone separator (RFC 6874)
1159 else if (*ptr
!= ':' && *ptr
!= '.' && !isxdigit(*ptr
& 255))
1162 return (HTTP_URI_STATUS_BAD_HOSTNAME
);
1168 * Validate the hostname or IPv4 address first...
1171 for (ptr
= (char *)uri
; *ptr
; ptr
++)
1172 if (strchr(":?/", *ptr
))
1174 else if (!strchr("abcdefghijklmnopqrstuvwxyz" /* unreserved */
1175 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" /* unreserved */
1176 "0123456789" /* unreserved */
1177 "-._~" /* unreserved */
1178 "%" /* pct-encoded */
1179 "!$&'()*+,;=" /* sub-delims */
1180 "\\", *ptr
)) /* SMB domain */
1183 return (HTTP_URI_STATUS_BAD_HOSTNAME
);
1187 * Then copy the hostname or IPv4 address to the buffer...
1190 uri
= http_copy_decode(host
, uri
, hostlen
, ":?/",
1191 decoding
& HTTP_URI_CODING_HOSTNAME
);
1196 return (HTTP_URI_STATUS_BAD_HOSTNAME
);
1201 * Validate hostname for file scheme - only empty and localhost are
1205 if (!strcmp(scheme
, "file") && strcmp(host
, "localhost") && host
[0])
1208 return (HTTP_URI_STATUS_BAD_HOSTNAME
);
1212 * See if we have a port number...
1218 * Yes, collect the port number...
1221 if (!isdigit(uri
[1] & 255))
1224 return (HTTP_URI_STATUS_BAD_PORT
);
1227 *port
= (int)strtol(uri
+ 1, (char **)&uri
, 10);
1229 if (*port
<= 0 || *port
> 65535)
1232 return (HTTP_URI_STATUS_BAD_PORT
);
1235 if (*uri
!= '/' && *uri
)
1238 return (HTTP_URI_STATUS_BAD_PORT
);
1244 * The remaining portion is the resource string...
1247 if (*uri
== '?' || !*uri
)
1250 * Hostname but no path...
1253 status
= HTTP_URI_STATUS_MISSING_RESOURCE
;
1257 * Copy any query string...
1261 uri
= http_copy_decode(resource
+ 1, uri
, resourcelen
- 1, NULL
,
1262 decoding
& HTTP_URI_CODING_QUERY
);
1268 uri
= http_copy_decode(resource
, uri
, resourcelen
, "?",
1269 decoding
& HTTP_URI_CODING_RESOURCE
);
1271 if (uri
&& *uri
== '?')
1274 * Concatenate any query string...
1277 char *resptr
= resource
+ strlen(resource
);
1279 uri
= http_copy_decode(resptr
, uri
,
1280 resourcelen
- (int)(resptr
- resource
), NULL
,
1281 decoding
& HTTP_URI_CODING_QUERY
);
1288 return (HTTP_URI_STATUS_BAD_RESOURCE
);
1292 * Return the URI separation status...
1300 * '_httpSetDigestAuthString()' - Calculate a Digest authentication response
1301 * using the appropriate RFC 2068/2617/7616
1305 int /* O - 1 on success, 0 on failure */
1306 _httpSetDigestAuthString(
1307 http_t
*http
, /* I - HTTP connection */
1308 const char *nonce
, /* I - Nonce value */
1309 const char *method
, /* I - HTTP method */
1310 const char *resource
) /* I - HTTP resource path */
1312 char kd
[65], /* Final MD5/SHA-256 digest */
1313 ha1
[65], /* Hash of username:realm:password */
1314 ha2
[65], /* Hash of method:request-uri */
1315 username
[HTTP_MAX_VALUE
],
1316 /* username:password */
1317 *password
, /* Pointer to password */
1318 temp
[1024], /* Temporary string */
1319 digest
[1024]; /* Digest auth data */
1320 unsigned char hash
[32]; /* Hash buffer */
1321 size_t hashsize
; /* Size of hash */
1322 _cups_globals_t
*cg
= _cupsGlobals(); /* Per-thread globals */
1325 DEBUG_printf(("2_httpSetDigestAuthString(http=%p, nonce=\"%s\", method=\"%s\", resource=\"%s\")", (void *)http
, nonce
, method
, resource
));
1327 if (nonce
&& *nonce
&& strcmp(nonce
, http
->nonce
))
1329 strlcpy(http
->nonce
, nonce
, sizeof(http
->nonce
));
1331 if (nonce
== http
->nextnonce
)
1332 http
->nextnonce
[0] = '\0';
1334 http
->nonce_count
= 1;
1337 http
->nonce_count
++;
1339 strlcpy(username
, http
->userpass
, sizeof(username
));
1340 if ((password
= strchr(username
, ':')) != NULL
)
1345 if (http
->algorithm
[0])
1348 * Follow RFC 2617/7616...
1351 int i
; /* Looping var */
1352 char cnonce
[65]; /* cnonce value */
1353 const char *hashalg
; /* Hashing algorithm */
1355 for (i
= 0; i
< 64; i
++)
1356 cnonce
[i
] = "0123456789ABCDEF"[CUPS_RAND() & 15];
1359 if (!_cups_strcasecmp(http
->algorithm
, "MD5"))
1362 * RFC 2617 Digest with MD5
1365 if (cg
->digestoptions
== _CUPS_DIGESTOPTIONS_DENYMD5
)
1367 DEBUG_puts("3_httpSetDigestAuthString: MD5 Digest is disabled.");
1373 else if (!_cups_strcasecmp(http
->algorithm
, "SHA-256"))
1376 * RFC 7616 Digest with SHA-256
1379 hashalg
= "sha2-256";
1384 * Some other algorithm we don't support, skip this one...
1391 * Calculate digest value...
1394 /* H(A1) = H(username:realm:password) */
1395 snprintf(temp
, sizeof(temp
), "%s:%s:%s", username
, http
->realm
, password
);
1396 hashsize
= (size_t)cupsHashData(hashalg
, (unsigned char *)temp
, strlen(temp
), hash
, sizeof(hash
));
1397 cupsHashString(hash
, hashsize
, ha1
, sizeof(ha1
));
1399 /* H(A2) = H(method:uri) */
1400 snprintf(temp
, sizeof(temp
), "%s:%s", method
, resource
);
1401 hashsize
= (size_t)cupsHashData(hashalg
, (unsigned char *)temp
, strlen(temp
), hash
, sizeof(hash
));
1402 cupsHashString(hash
, hashsize
, ha2
, sizeof(ha2
));
1404 /* KD = H(H(A1):nonce:nc:cnonce:qop:H(A2)) */
1405 snprintf(temp
, sizeof(temp
), "%s:%s:%08x:%s:%s:%s", ha1
, http
->nonce
, http
->nonce_count
, cnonce
, "auth", ha2
);
1406 hashsize
= (size_t)cupsHashData(hashalg
, (unsigned char *)temp
, strlen(temp
), hash
, sizeof(hash
));
1407 cupsHashString(hash
, hashsize
, kd
, sizeof(kd
));
1410 * Pass the RFC 2617/7616 WWW-Authenticate header...
1413 if (http
->opaque
[0])
1414 snprintf(digest
, sizeof(digest
), "username=\"%s\", realm=\"%s\", nonce=\"%s\", algorithm=%s, qop=auth, opaque=\"%s\", cnonce=\"%s\", nc=%08x, uri=\"%s\", response=\"%s\"", cupsUser(), http
->realm
, http
->nonce
, http
->algorithm
, http
->opaque
, cnonce
, http
->nonce_count
, resource
, kd
);
1416 snprintf(digest
, sizeof(digest
), "username=\"%s\", realm=\"%s\", nonce=\"%s\", algorithm=%s, qop=auth, cnonce=\"%s\", nc=%08x, uri=\"%s\", response=\"%s\"", username
, http
->realm
, http
->nonce
, http
->algorithm
, cnonce
, http
->nonce_count
, resource
, kd
);
1421 * Use old RFC 2069 Digest method...
1424 /* H(A1) = H(username:realm:password) */
1425 snprintf(temp
, sizeof(temp
), "%s:%s:%s", username
, http
->realm
, password
);
1426 hashsize
= (size_t)cupsHashData("md5", (unsigned char *)temp
, strlen(temp
), hash
, sizeof(hash
));
1427 cupsHashString(hash
, hashsize
, ha1
, sizeof(ha1
));
1429 /* H(A2) = H(method:uri) */
1430 snprintf(temp
, sizeof(temp
), "%s:%s", method
, resource
);
1431 hashsize
= (size_t)cupsHashData("md5", (unsigned char *)temp
, strlen(temp
), hash
, sizeof(hash
));
1432 cupsHashString(hash
, hashsize
, ha2
, sizeof(ha2
));
1434 /* KD = H(H(A1):nonce:H(A2)) */
1435 snprintf(temp
, sizeof(temp
), "%s:%s:%s", ha1
, http
->nonce
, ha2
);
1436 hashsize
= (size_t)cupsHashData("md5", (unsigned char *)temp
, strlen(temp
), hash
, sizeof(hash
));
1437 cupsHashString(hash
, hashsize
, kd
, sizeof(kd
));
1440 * Pass the old RFC 2069 WWW-Authenticate header...
1443 snprintf(digest
, sizeof(digest
), "username=\"%s\", realm=\"%s\", nonce=\"%s\", uri=\"%s\", response=\"%s\"", username
, http
->realm
, http
->nonce
, resource
, kd
);
1446 httpSetAuthString(http
, "Digest", digest
);
1453 * 'httpStateString()' - Return the string describing a HTTP state value.
1455 * @since CUPS 2.0/OS 10.10@
1458 const char * /* O - State string */
1459 httpStateString(http_state_t state
) /* I - HTTP state value */
1461 if (state
< HTTP_STATE_ERROR
|| state
> HTTP_STATE_UNKNOWN_VERSION
)
1462 return ("HTTP_STATE_???");
1464 return (http_states
[state
- HTTP_STATE_ERROR
]);
1469 * '_httpStatus()' - Return the localized string describing a HTTP status code.
1471 * The returned string is localized using the passed message catalog.
1474 const char * /* O - Localized status string */
1475 _httpStatus(cups_lang_t
*lang
, /* I - Language */
1476 http_status_t status
) /* I - HTTP status code */
1478 const char *s
; /* Status string */
1483 case HTTP_STATUS_ERROR
:
1484 s
= strerror(errno
);
1486 case HTTP_STATUS_CONTINUE
:
1489 case HTTP_STATUS_SWITCHING_PROTOCOLS
:
1490 s
= _("Switching Protocols");
1492 case HTTP_STATUS_OK
:
1495 case HTTP_STATUS_CREATED
:
1498 case HTTP_STATUS_ACCEPTED
:
1501 case HTTP_STATUS_NO_CONTENT
:
1502 s
= _("No Content");
1504 case HTTP_STATUS_MOVED_PERMANENTLY
:
1505 s
= _("Moved Permanently");
1507 case HTTP_STATUS_FOUND
:
1510 case HTTP_STATUS_SEE_OTHER
:
1513 case HTTP_STATUS_NOT_MODIFIED
:
1514 s
= _("Not Modified");
1516 case HTTP_STATUS_BAD_REQUEST
:
1517 s
= _("Bad Request");
1519 case HTTP_STATUS_UNAUTHORIZED
:
1520 case HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED
:
1521 s
= _("Unauthorized");
1523 case HTTP_STATUS_FORBIDDEN
:
1526 case HTTP_STATUS_NOT_FOUND
:
1529 case HTTP_STATUS_REQUEST_TOO_LARGE
:
1530 s
= _("Request Entity Too Large");
1532 case HTTP_STATUS_URI_TOO_LONG
:
1533 s
= _("URI Too Long");
1535 case HTTP_STATUS_UPGRADE_REQUIRED
:
1536 s
= _("Upgrade Required");
1538 case HTTP_STATUS_NOT_IMPLEMENTED
:
1539 s
= _("Not Implemented");
1541 case HTTP_STATUS_NOT_SUPPORTED
:
1542 s
= _("Not Supported");
1544 case HTTP_STATUS_EXPECTATION_FAILED
:
1545 s
= _("Expectation Failed");
1547 case HTTP_STATUS_SERVICE_UNAVAILABLE
:
1548 s
= _("Service Unavailable");
1550 case HTTP_STATUS_SERVER_ERROR
:
1551 s
= _("Internal Server Error");
1553 case HTTP_STATUS_CUPS_PKI_ERROR
:
1554 s
= _("SSL/TLS Negotiation Error");
1556 case HTTP_STATUS_CUPS_WEBIF_DISABLED
:
1557 s
= _("Web Interface is Disabled");
1565 return (_cupsLangString(lang
, s
));
1570 * 'httpStatus()' - Return a short string describing a HTTP status code.
1572 * The returned string is localized to the current POSIX locale and is based
1573 * on the status strings defined in RFC 7231.
1576 const char * /* O - Localized status string */
1577 httpStatus(http_status_t status
) /* I - HTTP status code */
1579 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
1582 if (!cg
->lang_default
)
1583 cg
->lang_default
= cupsLangDefault();
1585 return (_httpStatus(cg
->lang_default
, status
));
1589 * 'httpURIStatusString()' - Return a string describing a URI status code.
1591 * @since CUPS 2.0/OS 10.10@
1594 const char * /* O - Localized status string */
1595 httpURIStatusString(
1596 http_uri_status_t status
) /* I - URI status code */
1598 const char *s
; /* Status string */
1599 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
1602 if (!cg
->lang_default
)
1603 cg
->lang_default
= cupsLangDefault();
1607 case HTTP_URI_STATUS_OVERFLOW
:
1608 s
= _("URI too large");
1610 case HTTP_URI_STATUS_BAD_ARGUMENTS
:
1611 s
= _("Bad arguments to function");
1613 case HTTP_URI_STATUS_BAD_RESOURCE
:
1614 s
= _("Bad resource in URI");
1616 case HTTP_URI_STATUS_BAD_PORT
:
1617 s
= _("Bad port number in URI");
1619 case HTTP_URI_STATUS_BAD_HOSTNAME
:
1620 s
= _("Bad hostname/address in URI");
1622 case HTTP_URI_STATUS_BAD_USERNAME
:
1623 s
= _("Bad username in URI");
1625 case HTTP_URI_STATUS_BAD_SCHEME
:
1626 s
= _("Bad scheme in URI");
1628 case HTTP_URI_STATUS_BAD_URI
:
1629 s
= _("Bad/empty URI");
1631 case HTTP_URI_STATUS_OK
:
1634 case HTTP_URI_STATUS_MISSING_SCHEME
:
1635 s
= _("Missing scheme in URI");
1637 case HTTP_URI_STATUS_UNKNOWN_SCHEME
:
1638 s
= _("Unknown scheme in URI");
1640 case HTTP_URI_STATUS_MISSING_RESOURCE
:
1641 s
= _("Missing resource in URI");
1649 return (_cupsLangString(cg
->lang_default
, s
));
1653 #ifndef HAVE_HSTRERROR
1655 * '_cups_hstrerror()' - hstrerror() emulation function for Solaris and others.
1658 const char * /* O - Error string */
1659 _cups_hstrerror(int error
) /* I - Error number */
1661 static const char * const errors
[] = /* Error strings */
1666 "Unrecoverable lookup error.",
1667 "No data associated with name."
1671 if (error
< 0 || error
> 4)
1672 return ("Unknown hostname lookup error.");
1674 return (errors
[error
]);
1676 #endif /* !HAVE_HSTRERROR */
1680 * '_httpDecodeURI()' - Percent-decode a HTTP request URI.
1683 char * /* O - Decoded URI or NULL on error */
1684 _httpDecodeURI(char *dst
, /* I - Destination buffer */
1685 const char *src
, /* I - Source URI */
1686 size_t dstsize
) /* I - Size of destination buffer */
1688 if (http_copy_decode(dst
, src
, (int)dstsize
, NULL
, 1))
1696 * '_httpEncodeURI()' - Percent-encode a HTTP request URI.
1699 char * /* O - Encoded URI */
1700 _httpEncodeURI(char *dst
, /* I - Destination buffer */
1701 const char *src
, /* I - Source URI */
1702 size_t dstsize
) /* I - Size of destination buffer */
1704 http_copy_encode(dst
, src
, dst
+ dstsize
- 1, NULL
, NULL
, 1);
1710 * '_httpResolveURI()' - Resolve a DNS-SD URI.
1713 const char * /* O - Resolved URI */
1715 const char *uri
, /* I - DNS-SD URI */
1716 char *resolved_uri
, /* I - Buffer for resolved URI */
1717 size_t resolved_size
, /* I - Size of URI buffer */
1718 int options
, /* I - Resolve options */
1719 int (*cb
)(void *context
), /* I - Continue callback function */
1720 void *context
) /* I - Context pointer for callback */
1722 char scheme
[32], /* URI components... */
1728 http_uri_status_t status
; /* URI decode status */
1732 DEBUG_printf(("_httpResolveURI(uri=\"%s\", resolved_uri=%p, resolved_size=" CUPS_LLFMT
", options=0x%x, cb=%p, context=%p)", uri
, (void *)resolved_uri
, CUPS_LLCAST resolved_size
, options
, (void *)cb
, context
));
1735 * Get the device URI...
1739 if ((status
= httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
,
1740 sizeof(scheme
), userpass
, sizeof(userpass
),
1741 hostname
, sizeof(hostname
), &port
, resource
,
1742 sizeof(resource
))) < HTTP_URI_STATUS_OK
)
1744 if (httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
,
1745 sizeof(scheme
), userpass
, sizeof(userpass
),
1746 hostname
, sizeof(hostname
), &port
, resource
,
1747 sizeof(resource
)) < HTTP_URI_STATUS_OK
)
1750 if (options
& _HTTP_RESOLVE_STDERR
)
1751 _cupsLangPrintFilter(stderr
, "ERROR", _("Bad device-uri \"%s\"."), uri
);
1753 DEBUG_printf(("2_httpResolveURI: httpSeparateURI returned %d!", status
));
1754 DEBUG_puts("2_httpResolveURI: Returning NULL");
1759 * Resolve it as needed...
1762 if (strstr(hostname
, "._tcp"))
1764 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1765 char *regtype
, /* Pointer to type in hostname */
1766 *domain
, /* Pointer to domain in hostname */
1767 *uuid
, /* Pointer to UUID in URI */
1768 *uuidend
; /* Pointer to end of UUID in URI */
1769 _http_uribuf_t uribuf
; /* URI buffer */
1770 int offline
= 0; /* offline-report state set? */
1772 DNSServiceRef ref
, /* DNS-SD master service reference */
1773 domainref
= NULL
,/* DNS-SD service reference for domain */
1774 ippref
= NULL
, /* DNS-SD service reference for network IPP */
1775 ippsref
= NULL
, /* DNS-SD service reference for network IPPS */
1776 localref
; /* DNS-SD service reference for .local */
1777 int extrasent
= 0; /* Send the domain/IPP/IPPS resolves? */
1779 struct pollfd polldata
; /* Polling data */
1780 # else /* select() */
1781 fd_set input_set
; /* Input set for select() */
1782 struct timeval stimeout
; /* Timeout value for select() */
1783 # endif /* HAVE_POLL */
1784 # elif defined(HAVE_AVAHI)
1785 AvahiClient
*client
; /* Client information */
1786 int error
; /* Status */
1787 # endif /* HAVE_DNSSD */
1789 if (options
& _HTTP_RESOLVE_STDERR
)
1790 fprintf(stderr
, "DEBUG: Resolving \"%s\"...\n", hostname
);
1793 * Separate the hostname into service name, registration type, and domain...
1796 for (regtype
= strstr(hostname
, "._tcp") - 2;
1799 if (regtype
[0] == '.' && regtype
[1] == '_')
1802 * Found ._servicetype in front of ._tcp...
1809 if (regtype
<= hostname
)
1811 DEBUG_puts("2_httpResolveURI: Bad hostname, returning NULL");
1815 for (domain
= strchr(regtype
, '.');
1817 domain
= strchr(domain
+ 1, '.'))
1818 if (domain
[1] != '_')
1824 if ((uuid
= strstr(resource
, "?uuid=")) != NULL
)
1828 if ((uuidend
= strchr(uuid
, '&')) != NULL
)
1832 resolved_uri
[0] = '\0';
1834 uribuf
.buffer
= resolved_uri
;
1835 uribuf
.bufsize
= resolved_size
;
1836 uribuf
.options
= options
;
1837 uribuf
.resource
= resource
;
1840 DEBUG_printf(("2_httpResolveURI: Resolving hostname=\"%s\", regtype=\"%s\", "
1841 "domain=\"%s\"\n", hostname
, regtype
, domain
));
1842 if (options
& _HTTP_RESOLVE_STDERR
)
1844 fputs("STATE: +connecting-to-device\n", stderr
);
1845 fprintf(stderr
, "DEBUG: Resolving \"%s\", regtype=\"%s\", "
1846 "domain=\"local.\"...\n", hostname
, regtype
);
1852 if (DNSServiceCreateConnection(&ref
) == kDNSServiceErr_NoError
)
1854 uint32_t myinterface
= kDNSServiceInterfaceIndexAny
;
1855 /* Lookup on any interface */
1857 if (!strcmp(scheme
, "ippusb"))
1858 myinterface
= kDNSServiceInterfaceIndexLocalOnly
;
1861 if (DNSServiceResolve(&localref
,
1862 kDNSServiceFlagsShareConnection
, myinterface
,
1863 hostname
, regtype
, "local.", http_resolve_cb
,
1864 &uribuf
) == kDNSServiceErr_NoError
)
1866 int fds
; /* Number of ready descriptors */
1867 time_t timeout
, /* Poll timeout */
1868 start_time
= time(NULL
),/* Start time */
1869 end_time
= start_time
+ 90;
1872 while (time(NULL
) < end_time
)
1874 if (options
& _HTTP_RESOLVE_STDERR
)
1875 _cupsLangPrintFilter(stderr
, "INFO", _("Looking for printer."));
1877 if (cb
&& !(*cb
)(context
))
1879 DEBUG_puts("2_httpResolveURI: callback returned 0 (stop)");
1884 * Wakeup every 2 seconds to emit a "looking for printer" message...
1887 if ((timeout
= end_time
- time(NULL
)) > 2)
1891 polldata
.fd
= DNSServiceRefSockFD(ref
);
1892 polldata
.events
= POLLIN
;
1894 fds
= poll(&polldata
, 1, (int)(1000 * timeout
));
1896 # else /* select() */
1897 FD_ZERO(&input_set
);
1898 FD_SET(DNSServiceRefSockFD(ref
), &input_set
);
1901 stimeout
.tv_sec
= (long)timeout
;
1903 stimeout
.tv_sec
= timeout
;
1904 # endif /* _WIN32 */
1905 stimeout
.tv_usec
= 0;
1907 fds
= select(DNSServiceRefSockFD(ref
)+1, &input_set
, NULL
, NULL
,
1909 # endif /* HAVE_POLL */
1913 if (errno
!= EINTR
&& errno
!= EAGAIN
)
1915 DEBUG_printf(("2_httpResolveURI: poll error: %s", strerror(errno
)));
1922 * Wait 2 seconds for a response to the local resolve; if nothing
1923 * comes in, do an additional domain resolution...
1926 if (extrasent
== 0 && domain
&& _cups_strcasecmp(domain
, "local."))
1928 if (options
& _HTTP_RESOLVE_STDERR
)
1930 "DEBUG: Resolving \"%s\", regtype=\"%s\", "
1931 "domain=\"%s\"...\n", hostname
, regtype
,
1932 domain
? domain
: "");
1935 if (DNSServiceResolve(&domainref
,
1936 kDNSServiceFlagsShareConnection
,
1937 myinterface
, hostname
, regtype
, domain
,
1939 &uribuf
) == kDNSServiceErr_NoError
)
1942 else if (extrasent
== 0 && !strcmp(scheme
, "ippusb"))
1944 if (options
& _HTTP_RESOLVE_STDERR
)
1945 fprintf(stderr
, "DEBUG: Resolving \"%s\", regtype=\"_ipps._tcp\", domain=\"local.\"...\n", hostname
);
1948 if (DNSServiceResolve(&ippsref
,
1949 kDNSServiceFlagsShareConnection
,
1950 kDNSServiceInterfaceIndexAny
, hostname
,
1951 "_ipps._tcp", domain
, http_resolve_cb
,
1952 &uribuf
) == kDNSServiceErr_NoError
)
1955 else if (extrasent
== 1 && !strcmp(scheme
, "ippusb"))
1957 if (options
& _HTTP_RESOLVE_STDERR
)
1958 fprintf(stderr
, "DEBUG: Resolving \"%s\", regtype=\"_ipp._tcp\", domain=\"local.\"...\n", hostname
);
1961 if (DNSServiceResolve(&ippref
,
1962 kDNSServiceFlagsShareConnection
,
1963 kDNSServiceInterfaceIndexAny
, hostname
,
1964 "_ipp._tcp", domain
, http_resolve_cb
,
1965 &uribuf
) == kDNSServiceErr_NoError
)
1970 * If it hasn't resolved within 5 seconds set the offline-report
1971 * printer-state-reason...
1974 if ((options
& _HTTP_RESOLVE_STDERR
) && offline
== 0 &&
1975 time(NULL
) > (start_time
+ 5))
1977 fputs("STATE: +offline-report\n", stderr
);
1983 if (DNSServiceProcessResult(ref
) == kDNSServiceErr_NoError
&&
1995 DNSServiceRefDeallocate(domainref
);
1997 DNSServiceRefDeallocate(ippref
);
1999 DNSServiceRefDeallocate(ippsref
);
2002 DNSServiceRefDeallocate(localref
);
2005 DNSServiceRefDeallocate(ref
);
2007 # else /* HAVE_AVAHI */
2008 if ((uribuf
.poll
= avahi_simple_poll_new()) != NULL
)
2010 avahi_simple_poll_set_func(uribuf
.poll
, http_poll_cb
, NULL
);
2012 if ((client
= avahi_client_new(avahi_simple_poll_get(uribuf
.poll
),
2014 &uribuf
, &error
)) != NULL
)
2016 if (avahi_service_resolver_new(client
, AVAHI_IF_UNSPEC
,
2017 AVAHI_PROTO_UNSPEC
, hostname
,
2018 regtype
, "local.", AVAHI_PROTO_UNSPEC
, 0,
2019 http_resolve_cb
, &uribuf
) != NULL
)
2021 time_t start_time
= time(NULL
),
2023 end_time
= start_time
+ 90;
2025 int pstatus
; /* Poll status */
2027 pstatus
= avahi_simple_poll_iterate(uribuf
.poll
, 2000);
2029 if (pstatus
== 0 && !resolved_uri
[0] && domain
&&
2030 _cups_strcasecmp(domain
, "local."))
2033 * Resolve for .local hasn't returned anything, try the listed
2037 avahi_service_resolver_new(client
, AVAHI_IF_UNSPEC
,
2038 AVAHI_PROTO_UNSPEC
, hostname
,
2039 regtype
, domain
, AVAHI_PROTO_UNSPEC
, 0,
2040 http_resolve_cb
, &uribuf
);
2043 while (!pstatus
&& !resolved_uri
[0] && time(NULL
) < end_time
)
2045 if ((pstatus
= avahi_simple_poll_iterate(uribuf
.poll
, 2000)) != 0)
2049 * If it hasn't resolved within 5 seconds set the offline-report
2050 * printer-state-reason...
2053 if ((options
& _HTTP_RESOLVE_STDERR
) && offline
== 0 &&
2054 time(NULL
) > (start_time
+ 5))
2056 fputs("STATE: +offline-report\n", stderr
);
2062 * Collect the result (if we got one).
2065 if (resolved_uri
[0])
2069 avahi_client_free(client
);
2072 avahi_simple_poll_free(uribuf
.poll
);
2074 # endif /* HAVE_DNSSD */
2076 if (options
& _HTTP_RESOLVE_STDERR
)
2080 fprintf(stderr
, "DEBUG: Resolved as \"%s\"...\n", uri
);
2081 fputs("STATE: -connecting-to-device,offline-report\n", stderr
);
2085 fputs("DEBUG: Unable to resolve URI\n", stderr
);
2086 fputs("STATE: -connecting-to-device\n", stderr
);
2090 #else /* HAVE_DNSSD || HAVE_AVAHI */
2092 * No DNS-SD support...
2096 #endif /* HAVE_DNSSD || HAVE_AVAHI */
2098 if ((options
& _HTTP_RESOLVE_STDERR
) && !uri
)
2099 _cupsLangPrintFilter(stderr
, "INFO", _("Unable to find printer."));
2104 * Nothing more to do...
2107 strlcpy(resolved_uri
, uri
, resolved_size
);
2111 DEBUG_printf(("2_httpResolveURI: Returning \"%s\"", uri
));
2119 * 'http_client_cb()' - Client callback for resolving URI.
2124 AvahiClient
*client
, /* I - Client information */
2125 AvahiClientState state
, /* I - Current state */
2126 void *context
) /* I - Pointer to URI buffer */
2128 DEBUG_printf(("7http_client_cb(client=%p, state=%d, context=%p)", client
,
2132 * If the connection drops, quit.
2135 if (state
== AVAHI_CLIENT_FAILURE
)
2137 _http_uribuf_t
*uribuf
= (_http_uribuf_t
*)context
;
2140 avahi_simple_poll_quit(uribuf
->poll
);
2143 #endif /* HAVE_AVAHI */
2147 * 'http_copy_decode()' - Copy and decode a URI.
2150 static const char * /* O - New source pointer or NULL on error */
2151 http_copy_decode(char *dst
, /* O - Destination buffer */
2152 const char *src
, /* I - Source pointer */
2153 int dstsize
, /* I - Destination size */
2154 const char *term
, /* I - Terminating characters */
2155 int decode
) /* I - Decode %-encoded values */
2157 char *ptr
, /* Pointer into buffer */
2158 *end
; /* End of buffer */
2159 int quoted
; /* Quoted character */
2163 * Copy the src to the destination until we hit a terminating character
2164 * or the end of the string.
2167 for (ptr
= dst
, end
= dst
+ dstsize
- 1;
2168 *src
&& (!term
|| !strchr(term
, *src
));
2172 if (*src
== '%' && decode
)
2174 if (isxdigit(src
[1] & 255) && isxdigit(src
[2] & 255))
2177 * Grab a hex-encoded character...
2182 quoted
= (tolower(*src
) - 'a' + 10) << 4;
2184 quoted
= (*src
- '0') << 4;
2188 quoted
|= tolower(*src
) - 'a' + 10;
2190 quoted
|= *src
- '0';
2192 *ptr
++ = (char)quoted
;
2197 * Bad hex-encoded character...
2204 else if ((*src
& 255) <= 0x20 || (*src
& 255) >= 0x7f)
2220 * 'http_copy_encode()' - Copy and encode a URI.
2223 static char * /* O - End of current URI */
2224 http_copy_encode(char *dst
, /* O - Destination buffer */
2225 const char *src
, /* I - Source pointer */
2226 char *dstend
, /* I - End of destination buffer */
2227 const char *reserved
, /* I - Extra reserved characters */
2228 const char *term
, /* I - Terminating characters */
2229 int encode
) /* I - %-encode reserved chars? */
2231 static const char hex
[] = "0123456789ABCDEF";
2234 while (*src
&& dst
< dstend
)
2236 if (term
&& *src
== *term
)
2239 if (encode
&& (*src
== '%' || *src
<= ' ' || *src
& 128 ||
2240 (reserved
&& strchr(reserved
, *src
))))
2243 * Hex encode reserved characters...
2246 if ((dst
+ 2) >= dstend
)
2250 *dst
++ = hex
[(*src
>> 4) & 15];
2251 *dst
++ = hex
[*src
& 15];
2270 * 'http_resolve_cb()' - Build a device URI for the given service name.
2273 static void DNSSD_API
2275 DNSServiceRef sdRef
, /* I - Service reference */
2276 DNSServiceFlags flags
, /* I - Results flags */
2277 uint32_t interfaceIndex
, /* I - Interface number */
2278 DNSServiceErrorType errorCode
, /* I - Error, if any */
2279 const char *fullName
, /* I - Full service name */
2280 const char *hostTarget
, /* I - Hostname */
2281 uint16_t port
, /* I - Port number */
2282 uint16_t txtLen
, /* I - Length of TXT record */
2283 const unsigned char *txtRecord
, /* I - TXT record data */
2284 void *context
) /* I - Pointer to URI buffer */
2286 _http_uribuf_t
*uribuf
= (_http_uribuf_t
*)context
;
2288 const char *scheme
, /* URI scheme */
2289 *hostptr
, /* Pointer into hostTarget */
2290 *reskey
, /* "rp" or "rfo" */
2291 *resdefault
; /* Default path */
2292 char resource
[257], /* Remote path */
2293 fqdn
[256]; /* FQDN of the .local name */
2294 const void *value
; /* Value from TXT record */
2295 uint8_t valueLen
; /* Length of value */
2298 DEBUG_printf(("4http_resolve_cb(sdRef=%p, flags=%x, interfaceIndex=%u, errorCode=%d, fullName=\"%s\", hostTarget=\"%s\", port=%u, txtLen=%u, txtRecord=%p, context=%p)", (void *)sdRef
, flags
, interfaceIndex
, errorCode
, fullName
, hostTarget
, port
, txtLen
, (void *)txtRecord
, context
));
2301 * If we have a UUID, compare it...
2305 (value
= TXTRecordGetValuePtr(txtLen
, txtRecord
, "UUID",
2306 &valueLen
)) != NULL
)
2308 char uuid
[256]; /* UUID value */
2310 memcpy(uuid
, value
, valueLen
);
2311 uuid
[valueLen
] = '\0';
2313 if (_cups_strcasecmp(uuid
, uribuf
->uuid
))
2315 if (uribuf
->options
& _HTTP_RESOLVE_STDERR
)
2316 fprintf(stderr
, "DEBUG: Found UUID %s, looking for %s.", uuid
,
2319 DEBUG_printf(("5http_resolve_cb: Found UUID %s, looking for %s.", uuid
,
2326 * Figure out the scheme from the full name...
2329 if (strstr(fullName
, "._ipps") || strstr(fullName
, "._ipp-tls"))
2331 else if (strstr(fullName
, "._ipp") || strstr(fullName
, "._fax-ipp"))
2333 else if (strstr(fullName
, "._http."))
2335 else if (strstr(fullName
, "._https."))
2337 else if (strstr(fullName
, "._printer."))
2339 else if (strstr(fullName
, "._pdl-datastream."))
2342 scheme
= "riousbprint";
2345 * Extract the "remote printer" key from the TXT record...
2348 if ((uribuf
->options
& _HTTP_RESOLVE_FAXOUT
) &&
2349 (!strcmp(scheme
, "ipp") || !strcmp(scheme
, "ipps")) &&
2350 !TXTRecordGetValuePtr(txtLen
, txtRecord
, "printer-type", &valueLen
))
2353 resdefault
= "/ipp/faxout";
2361 if ((value
= TXTRecordGetValuePtr(txtLen
, txtRecord
, reskey
,
2362 &valueLen
)) != NULL
)
2364 if (((char *)value
)[0] == '/')
2367 * Value (incorrectly) has a leading slash already...
2370 memcpy(resource
, value
, valueLen
);
2371 resource
[valueLen
] = '\0';
2376 * Convert to resource by concatenating with a leading "/"...
2380 memcpy(resource
+ 1, value
, valueLen
);
2381 resource
[valueLen
+ 1] = '\0';
2387 * Use the default value...
2390 strlcpy(resource
, resdefault
, sizeof(resource
));
2394 * Lookup the FQDN if needed...
2397 if ((uribuf
->options
& _HTTP_RESOLVE_FQDN
) &&
2398 (hostptr
= hostTarget
+ strlen(hostTarget
) - 7) > hostTarget
&&
2399 !_cups_strcasecmp(hostptr
, ".local."))
2402 * OK, we got a .local name but the caller needs a real domain. Start by
2403 * getting the IP address of the .local name and then do reverse-lookups...
2406 http_addrlist_t
*addrlist
, /* List of addresses */
2407 *addr
; /* Current address */
2409 DEBUG_printf(("5http_resolve_cb: Looking up \"%s\".", hostTarget
));
2411 snprintf(fqdn
, sizeof(fqdn
), "%d", ntohs(port
));
2412 if ((addrlist
= httpAddrGetList(hostTarget
, AF_UNSPEC
, fqdn
)) != NULL
)
2414 for (addr
= addrlist
; addr
; addr
= addr
->next
)
2416 int error
= getnameinfo(&(addr
->addr
.addr
), (socklen_t
)httpAddrLength(&(addr
->addr
)), fqdn
, sizeof(fqdn
), NULL
, 0, NI_NAMEREQD
);
2420 DEBUG_printf(("5http_resolve_cb: Found \"%s\".", fqdn
));
2422 if ((hostptr
= fqdn
+ strlen(fqdn
) - 6) <= fqdn
||
2423 _cups_strcasecmp(hostptr
, ".local"))
2431 DEBUG_printf(("5http_resolve_cb: \"%s\" did not resolve: %d",
2432 httpAddrString(&(addr
->addr
), fqdn
, sizeof(fqdn
)),
2437 httpAddrFreeList(addrlist
);
2442 * Assemble the final device URI...
2445 if ((!strcmp(scheme
, "ipp") || !strcmp(scheme
, "ipps")) &&
2446 !strcmp(uribuf
->resource
, "/cups"))
2447 httpAssembleURIf(HTTP_URI_CODING_ALL
, uribuf
->buffer
, (int)uribuf
->bufsize
, scheme
, NULL
, hostTarget
, ntohs(port
), "%s?snmp=false", resource
);
2449 httpAssembleURI(HTTP_URI_CODING_ALL
, uribuf
->buffer
, (int)uribuf
->bufsize
, scheme
, NULL
, hostTarget
, ntohs(port
), resource
);
2451 DEBUG_printf(("5http_resolve_cb: Resolved URI is \"%s\"...", uribuf
->buffer
));
2454 #elif defined(HAVE_AVAHI)
2456 * 'http_poll_cb()' - Wait for input on the specified file descriptors.
2458 * Note: This function is needed because avahi_simple_poll_iterate is broken
2459 * and always uses a timeout of 0 (!) milliseconds.
2460 * (Avahi Ticket #364)
2465 static int /* O - Number of file descriptors matching */
2467 struct pollfd
*pollfds
, /* I - File descriptors */
2468 unsigned int num_pollfds
, /* I - Number of file descriptors */
2469 int timeout
, /* I - Timeout in milliseconds (used) */
2470 void *context
) /* I - User data (unused) */
2475 return (poll(pollfds
, num_pollfds
, 2000));
2480 * 'http_resolve_cb()' - Build a device URI for the given service name.
2485 AvahiServiceResolver
*resolver
, /* I - Resolver (unused) */
2486 AvahiIfIndex interface
, /* I - Interface index (unused) */
2487 AvahiProtocol protocol
, /* I - Network protocol (unused) */
2488 AvahiResolverEvent event
, /* I - Event (found, etc.) */
2489 const char *name
, /* I - Service name */
2490 const char *type
, /* I - Registration type */
2491 const char *domain
, /* I - Domain (unused) */
2492 const char *hostTarget
, /* I - Hostname */
2493 const AvahiAddress
*address
, /* I - Address (unused) */
2494 uint16_t port
, /* I - Port number */
2495 AvahiStringList
*txt
, /* I - TXT record */
2496 AvahiLookupResultFlags flags
, /* I - Lookup flags (unused) */
2497 void *context
) /* I - Pointer to URI buffer */
2499 _http_uribuf_t
*uribuf
= (_http_uribuf_t
*)context
;
2501 const char *scheme
, /* URI scheme */
2502 *hostptr
, /* Pointer into hostTarget */
2503 *reskey
, /* "rp" or "rfo" */
2504 *resdefault
; /* Default path */
2505 char resource
[257], /* Remote path */
2506 fqdn
[256]; /* FQDN of the .local name */
2507 AvahiStringList
*pair
; /* Current TXT record key/value pair */
2508 char *value
; /* Value for "rp" key */
2509 size_t valueLen
= 0; /* Length of "rp" key */
2512 DEBUG_printf(("4http_resolve_cb(resolver=%p, "
2513 "interface=%d, protocol=%d, event=%d, name=\"%s\", "
2514 "type=\"%s\", domain=\"%s\", hostTarget=\"%s\", address=%p, "
2515 "port=%d, txt=%p, flags=%d, context=%p)",
2516 resolver
, interface
, protocol
, event
, name
, type
, domain
,
2517 hostTarget
, address
, port
, txt
, flags
, context
));
2519 if (event
!= AVAHI_RESOLVER_FOUND
)
2521 avahi_service_resolver_free(resolver
);
2522 avahi_simple_poll_quit(uribuf
->poll
);
2527 * If we have a UUID, compare it...
2530 if (uribuf
->uuid
&& (pair
= avahi_string_list_find(txt
, "UUID")) != NULL
)
2532 char uuid
[256]; /* UUID value */
2534 avahi_string_list_get_pair(pair
, NULL
, &value
, &valueLen
);
2536 memcpy(uuid
, value
, valueLen
);
2537 uuid
[valueLen
] = '\0';
2539 if (_cups_strcasecmp(uuid
, uribuf
->uuid
))
2541 if (uribuf
->options
& _HTTP_RESOLVE_STDERR
)
2542 fprintf(stderr
, "DEBUG: Found UUID %s, looking for %s.", uuid
,
2545 DEBUG_printf(("5http_resolve_cb: Found UUID %s, looking for %s.", uuid
,
2552 * Figure out the scheme from the full name...
2555 if (strstr(type
, "_ipp."))
2557 else if (strstr(type
, "_printer."))
2559 else if (strstr(type
, "_pdl-datastream."))
2562 scheme
= "riousbprint";
2564 if (!strncmp(type
, "_ipps.", 6) || !strncmp(type
, "_ipp-tls.", 9))
2566 else if (!strncmp(type
, "_ipp.", 5) || !strncmp(type
, "_fax-ipp.", 9))
2568 else if (!strncmp(type
, "_http.", 6))
2570 else if (!strncmp(type
, "_https.", 7))
2572 else if (!strncmp(type
, "_printer.", 9))
2574 else if (!strncmp(type
, "_pdl-datastream.", 16))
2578 avahi_service_resolver_free(resolver
);
2579 avahi_simple_poll_quit(uribuf
->poll
);
2584 * Extract the remote resource key from the TXT record...
2587 if ((uribuf
->options
& _HTTP_RESOLVE_FAXOUT
) &&
2588 (!strcmp(scheme
, "ipp") || !strcmp(scheme
, "ipps")) &&
2589 !avahi_string_list_find(txt
, "printer-type"))
2592 resdefault
= "/ipp/faxout";
2600 if ((pair
= avahi_string_list_find(txt
, reskey
)) != NULL
)
2602 avahi_string_list_get_pair(pair
, NULL
, &value
, &valueLen
);
2604 if (value
[0] == '/')
2607 * Value (incorrectly) has a leading slash already...
2610 memcpy(resource
, value
, valueLen
);
2611 resource
[valueLen
] = '\0';
2616 * Convert to resource by concatenating with a leading "/"...
2620 memcpy(resource
+ 1, value
, valueLen
);
2621 resource
[valueLen
+ 1] = '\0';
2627 * Use the default value...
2630 strlcpy(resource
, resdefault
, sizeof(resource
));
2634 * Lookup the FQDN if needed...
2637 if ((uribuf
->options
& _HTTP_RESOLVE_FQDN
) &&
2638 (hostptr
= hostTarget
+ strlen(hostTarget
) - 6) > hostTarget
&&
2639 !_cups_strcasecmp(hostptr
, ".local"))
2642 * OK, we got a .local name but the caller needs a real domain. Start by
2643 * getting the IP address of the .local name and then do reverse-lookups...
2646 http_addrlist_t
*addrlist
, /* List of addresses */
2647 *addr
; /* Current address */
2649 DEBUG_printf(("5http_resolve_cb: Looking up \"%s\".", hostTarget
));
2651 snprintf(fqdn
, sizeof(fqdn
), "%d", ntohs(port
));
2652 if ((addrlist
= httpAddrGetList(hostTarget
, AF_UNSPEC
, fqdn
)) != NULL
)
2654 for (addr
= addrlist
; addr
; addr
= addr
->next
)
2656 int error
= getnameinfo(&(addr
->addr
.addr
), (socklen_t
)httpAddrLength(&(addr
->addr
)), fqdn
, sizeof(fqdn
), NULL
, 0, NI_NAMEREQD
);
2660 DEBUG_printf(("5http_resolve_cb: Found \"%s\".", fqdn
));
2662 if ((hostptr
= fqdn
+ strlen(fqdn
) - 6) <= fqdn
||
2663 _cups_strcasecmp(hostptr
, ".local"))
2671 DEBUG_printf(("5http_resolve_cb: \"%s\" did not resolve: %d",
2672 httpAddrString(&(addr
->addr
), fqdn
, sizeof(fqdn
)),
2677 httpAddrFreeList(addrlist
);
2682 * Assemble the final device URI using the resolved hostname...
2685 httpAssembleURI(HTTP_URI_CODING_ALL
, uribuf
->buffer
, (int)uribuf
->bufsize
, scheme
,
2686 NULL
, hostTarget
, port
, resource
);
2687 DEBUG_printf(("5http_resolve_cb: Resolved URI is \"%s\".", uribuf
->buffer
));
2689 avahi_simple_poll_quit(uribuf
->poll
);
2691 #endif /* HAVE_DNSSD */