1/*
2 * Hyper-Text Transport Protocol definitions for CUPS.
3 *
4 * Copyright © 2007-2018 by Apple Inc.
5 * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
6 *
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
8 * information.
9 */
10
11#ifndef _CUPS_HTTP_H_
12# define _CUPS_HTTP_H_
13
14/*
15 * Include necessary headers...
16 */
17
18# include "versioning.h"
19# include "array.h"
20# include <string.h>
21# include <time.h>
22# include <sys/types.h>
23# ifdef _WIN32
24# ifndef __CUPS_SSIZE_T_DEFINED
25# define __CUPS_SSIZE_T_DEFINED
26/* Windows does not support the ssize_t type, so map it to __int64... */
27typedef __int64 ssize_t; /* @private@ */
28# endif /* !__CUPS_SSIZE_T_DEFINED */
29# include <winsock2.h>
30# include <ws2tcpip.h>
31# else
32# include <unistd.h>
33# include <sys/time.h>
34# include <sys/socket.h>
35# include <netdb.h>
36# include <netinet/in.h>
37# include <arpa/inet.h>
38# include <netinet/in_systm.h>
39# include <netinet/ip.h>
40# if !defined(__APPLE__) || !defined(TCP_NODELAY)
41# include <netinet/tcp.h>
42# endif /* !__APPLE__ || !TCP_NODELAY */
43# if defined(AF_UNIX) && !defined(AF_LOCAL)
44# define AF_LOCAL AF_UNIX /* Older UNIX's have old names... */
45# endif /* AF_UNIX && !AF_LOCAL */
46# ifdef AF_LOCAL
47# include <sys/un.h>
48# endif /* AF_LOCAL */
49# if defined(LOCAL_PEERCRED) && !defined(SO_PEERCRED)
50# define SO_PEERCRED LOCAL_PEERCRED
51# endif /* LOCAL_PEERCRED && !SO_PEERCRED */
52# endif /* _WIN32 */
53
54
55/*
56 * C++ magic...
57 */
58
59# ifdef __cplusplus
60extern "C" {
61# endif /* __cplusplus */
62
63
64/*
65 * Oh, the wonderful world of IPv6 compatibility. Apparently some
66 * implementations expose the (more logical) 32-bit address parts
67 * to everyone, while others only expose it to kernel code... To
68 * make supporting IPv6 even easier, each vendor chose different
69 * core structure and union names, so the same defines or code
70 * can't be used on all platforms.
71 *
72 * The following will likely need tweaking on new platforms that
73 * support IPv6 - the "s6_addr32" define maps to the 32-bit integer
74 * array in the in6_addr union, which is named differently on various
75 * platforms.
76 */
77
78#if defined(AF_INET6) && !defined(s6_addr32)
79# if defined(__sun)
80# define s6_addr32 _S6_un._S6_u32
81# elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__)|| defined(__DragonFly__)
82# define s6_addr32 __u6_addr.__u6_addr32
83# elif defined(_WIN32)
84/*
85 * Windows only defines byte and 16-bit word members of the union and
86 * requires special casing of all raw address code...
87 */
88# define s6_addr32 error_need_win32_specific_code
89# endif /* __sun */
90#endif /* AF_INET6 && !s6_addr32 */
91
92
93/*
94 * Limits...
95 */
96
97# define HTTP_MAX_URI 1024 /* Max length of URI string */
98# define HTTP_MAX_HOST 256 /* Max length of hostname string */
99# define HTTP_MAX_BUFFER 2048 /* Max length of data buffer */
100# define HTTP_MAX_VALUE 256 /* Max header field value length */
101
102
103/*
104 * Types and structures...
105 */
106
107typedef enum http_auth_e /**** HTTP authentication types @exclude all@ ****/
108{
109 HTTP_AUTH_NONE, /* No authentication in use */
110 HTTP_AUTH_BASIC, /* Basic authentication in use */
111 HTTP_AUTH_MD5, /* Digest authentication in use */
112 HTTP_AUTH_MD5_SESS, /* MD5-session authentication in use */
113 HTTP_AUTH_MD5_INT, /* Digest authentication in use for body */
114 HTTP_AUTH_MD5_SESS_INT, /* MD5-session authentication in use for body */
115 HTTP_AUTH_NEGOTIATE /* GSSAPI authentication in use @since CUPS 1.3/macOS 10.5@ */
116} http_auth_t;
117
118typedef enum http_encoding_e /**** HTTP transfer encoding values ****/
119{
120 HTTP_ENCODING_LENGTH, /* Data is sent with Content-Length */
121 HTTP_ENCODING_CHUNKED, /* Data is chunked */
122 HTTP_ENCODING_FIELDS /* Sending HTTP fields */
123
124# ifndef _CUPS_NO_DEPRECATED
125# define HTTP_ENCODE_LENGTH HTTP_ENCODING_LENGTH
126# define HTTP_ENCODE_CHUNKED HTTP_ENCODING_CHUNKED
127# define HTTP_ENCODE_FIELDS HTTP_ENCODING_FIELDS
128# endif /* !_CUPS_NO_DEPRECATED */
129} http_encoding_t;
130
131typedef enum http_encryption_e /**** HTTP encryption values ****/
132{
133 HTTP_ENCRYPTION_IF_REQUESTED, /* Encrypt if requested (TLS upgrade) */
134 HTTP_ENCRYPTION_NEVER, /* Never encrypt */
135 HTTP_ENCRYPTION_REQUIRED, /* Encryption is required (TLS upgrade) */
136 HTTP_ENCRYPTION_ALWAYS /* Always encrypt (SSL) */
137
138# ifndef _CUPS_NO_DEPRECATED
139# define HTTP_ENCRYPT_IF_REQUESTED HTTP_ENCRYPTION_IF_REQUESTED
140# define HTTP_ENCRYPT_NEVER HTTP_ENCRYPTION_NEVER
141# define HTTP_ENCRYPT_REQUIRED HTTP_ENCRYPTION_REQUIRED
142# define HTTP_ENCRYPT_ALWAYS HTTP_ENCRYPTION_ALWAYS
143# endif /* !_CUPS_NO_DEPRECATED */
144} http_encryption_t;
145
146typedef enum http_field_e /**** HTTP field names ****/
147{
148 HTTP_FIELD_UNKNOWN = -1, /* Unknown field */
149 HTTP_FIELD_ACCEPT_LANGUAGE, /* Accept-Language field */
150 HTTP_FIELD_ACCEPT_RANGES, /* Accept-Ranges field */
151 HTTP_FIELD_AUTHORIZATION, /* Authorization field */
152 HTTP_FIELD_CONNECTION, /* Connection field */
153 HTTP_FIELD_CONTENT_ENCODING, /* Content-Encoding field */
154 HTTP_FIELD_CONTENT_LANGUAGE, /* Content-Language field */
155 HTTP_FIELD_CONTENT_LENGTH, /* Content-Length field */
156 HTTP_FIELD_CONTENT_LOCATION, /* Content-Location field */
157 HTTP_FIELD_CONTENT_MD5, /* Content-MD5 field */
158 HTTP_FIELD_CONTENT_RANGE, /* Content-Range field */
159 HTTP_FIELD_CONTENT_TYPE, /* Content-Type field */
160 HTTP_FIELD_CONTENT_VERSION, /* Content-Version field */
161 HTTP_FIELD_DATE, /* Date field */
162 HTTP_FIELD_HOST, /* Host field */
163 HTTP_FIELD_IF_MODIFIED_SINCE, /* If-Modified-Since field */
164 HTTP_FIELD_IF_UNMODIFIED_SINCE, /* If-Unmodified-Since field */
165 HTTP_FIELD_KEEP_ALIVE, /* Keep-Alive field */
166 HTTP_FIELD_LAST_MODIFIED, /* Last-Modified field */
167 HTTP_FIELD_LINK, /* Link field */
168 HTTP_FIELD_LOCATION, /* Location field */
169 HTTP_FIELD_RANGE, /* Range field */
170 HTTP_FIELD_REFERER, /* Referer field */
171 HTTP_FIELD_RETRY_AFTER, /* Retry-After field */
172 HTTP_FIELD_TRANSFER_ENCODING, /* Transfer-Encoding field */
173 HTTP_FIELD_UPGRADE, /* Upgrade field */
174 HTTP_FIELD_USER_AGENT, /* User-Agent field */
175 HTTP_FIELD_WWW_AUTHENTICATE, /* WWW-Authenticate field */
176 HTTP_FIELD_ACCEPT_ENCODING, /* Accepting-Encoding field @since CUPS 1.7/macOS 10.9@ */
177 HTTP_FIELD_ALLOW, /* Allow field @since CUPS 1.7/macOS 10.9@ */
178 HTTP_FIELD_SERVER, /* Server field @since CUPS 1.7/macOS 10.9@ */
179 HTTP_FIELD_AUTHENTICATION_INFO, /* Authentication-Info field @since CUPS 2.2.9@ */
180 HTTP_FIELD_ACCESS_CONTROL_ALLOW_CREDENTIALS,
181 /* CORS/Fetch Access-Control-Allow-Cresdentials field @since CUPS 2.4@ */
182 HTTP_FIELD_ACCESS_CONTROL_ALLOW_HEADERS,
183 /* CORS/Fetch Access-Control-Allow-Headers field @since CUPS 2.4@ */
184 HTTP_FIELD_ACCESS_CONTROL_ALLOW_METHODS,
185 /* CORS/Fetch Access-Control-Allow-Methods field @since CUPS 2.4@ */
186 HTTP_FIELD_ACCESS_CONTROL_ALLOW_ORIGIN,
187 /* CORS/Fetch Access-Control-Allow-Origin field @since CUPS 2.4@ */
188 HTTP_FIELD_ACCESS_CONTROL_EXPOSE_HEADERS,
189 /* CORS/Fetch Access-Control-Expose-Headers field @since CUPS 2.4@ */
190 HTTP_FIELD_ACCESS_CONTROL_MAX_AGE, /* CORS/Fetch Access-Control-Max-Age field @since CUPS 2.4@ */
191 HTTP_FIELD_ACCESS_CONTROL_REQUEST_HEADERS,
192 /* CORS/Fetch Access-Control-Request-Headers field @since CUPS 2.4@ */
193 HTTP_FIELD_ACCESS_CONTROL_REQUEST_METHOD,
194 /* CORS/Fetch Access-Control-Request-Method field @since CUPS 2.4@ */
195 HTTP_FIELD_OPTIONAL_WWW_AUTHENTICATE, /* RFC 8053 Optional-WWW-Authenticate field @since CUPS 2.4@ */
196 HTTP_FIELD_ORIGIN, /* RFC 6454 Origin field @since CUPS 2.4@ */
197 HTTP_FIELD_OSCORE, /* RFC 8613 OSCORE field @since CUPS 2.4@ */
198 HTTP_FIELD_STRICT_TRANSPORT_SECURITY, /* HSTS Strict-Transport-Security field @since CUPS 2.4@ */
199 HTTP_FIELD_MAX /* Maximum field index */
200} http_field_t;
201
202typedef enum http_keepalive_e /**** HTTP keep-alive values ****/
203{
204 HTTP_KEEPALIVE_OFF = 0, /* No keep alive support */
205 HTTP_KEEPALIVE_ON /* Use keep alive */
206} http_keepalive_t;
207
208typedef enum http_state_e /**** HTTP state values; states
209 **** are server-oriented...
210 ****/
211{
212 HTTP_STATE_ERROR = -1, /* Error on socket */
213 HTTP_STATE_WAITING, /* Waiting for command */
214 HTTP_STATE_OPTIONS, /* OPTIONS command, waiting for blank line */
215 HTTP_STATE_GET, /* GET command, waiting for blank line */
216 HTTP_STATE_GET_SEND, /* GET command, sending data */
217 HTTP_STATE_HEAD, /* HEAD command, waiting for blank line */
218 HTTP_STATE_POST, /* POST command, waiting for blank line */
219 HTTP_STATE_POST_RECV, /* POST command, receiving data */
220 HTTP_STATE_POST_SEND, /* POST command, sending data */
221 HTTP_STATE_PUT, /* PUT command, waiting for blank line */
222 HTTP_STATE_PUT_RECV, /* PUT command, receiving data */
223 HTTP_STATE_DELETE, /* DELETE command, waiting for blank line */
224 HTTP_STATE_TRACE, /* TRACE command, waiting for blank line */
225 HTTP_STATE_CONNECT, /* CONNECT command, waiting for blank line */
226 HTTP_STATE_STATUS, /* Command complete, sending status */
227 HTTP_STATE_UNKNOWN_METHOD, /* Unknown request method, waiting for blank line @since CUPS 1.7/macOS 10.9@ */
228 HTTP_STATE_UNKNOWN_VERSION /* Unknown request method, waiting for blank line @since CUPS 1.7/macOS 10.9@ */
229
230# ifndef _CUPS_NO_DEPRECATED
231# define HTTP_WAITING HTTP_STATE_WAITING
232# define HTTP_OPTIONS HTTP_STATE_OPTIONS
233# define HTTP_GET HTTP_STATE_GET
234# define HTTP_GET_SEND HTTP_STATE_GET_SEND
235# define HTTP_HEAD HTTP_STATE_HEAD
236# define HTTP_POST HTTP_STATE_POST
237# define HTTP_POST_RECV HTTP_STATE_POST_RECV
238# define HTTP_POST_SEND HTTP_STATE_POST_SEND
239# define HTTP_PUT HTTP_STATE_PUT
240# define HTTP_PUT_RECV HTTP_STATE_PUT_RECV
241# define HTTP_DELETE HTTP_STATE_DELETE
242# define HTTP_TRACE HTTP_STATE_TRACE
243# define HTTP_CLOSE HTTP_STATE_CONNECT
244# define HTTP_STATUS HTTP_STATE_STATUS
245# endif /* !_CUPS_NO_DEPRECATED */
246} http_state_t;
247
248typedef enum http_status_e /**** HTTP status codes ****/
249{
250 HTTP_STATUS_ERROR = -1, /* An error response from httpXxxx() */
251 HTTP_STATUS_NONE = 0, /* No Expect value @since CUPS 1.7/macOS 10.9@ */
252
253 HTTP_STATUS_CONTINUE = 100, /* Everything OK, keep going... */
254 HTTP_STATUS_SWITCHING_PROTOCOLS, /* HTTP upgrade to TLS/SSL */
255
256 HTTP_STATUS_OK = 200, /* OPTIONS/GET/HEAD/POST/TRACE command was successful */
257 HTTP_STATUS_CREATED, /* PUT command was successful */
258 HTTP_STATUS_ACCEPTED, /* DELETE command was successful */
259 HTTP_STATUS_NOT_AUTHORITATIVE, /* Information isn't authoritative */
260 HTTP_STATUS_NO_CONTENT, /* Successful command, no new data */
261 HTTP_STATUS_RESET_CONTENT, /* Content was reset/recreated */
262 HTTP_STATUS_PARTIAL_CONTENT, /* Only a partial file was received/sent */
263
264 HTTP_STATUS_MULTIPLE_CHOICES = 300, /* Multiple files match request */
265 HTTP_STATUS_MOVED_PERMANENTLY, /* Document has moved permanently */
266 HTTP_STATUS_FOUND, /* Document was found at a different URI */
267 HTTP_STATUS_SEE_OTHER, /* See this other link */
268 HTTP_STATUS_NOT_MODIFIED, /* File not modified */
269 HTTP_STATUS_USE_PROXY, /* Must use a proxy to access this URI */
270 HTTP_STATUS_TEMPORARY_REDIRECT = 307, /* Temporary redirection */
271
272 HTTP_STATUS_BAD_REQUEST = 400, /* Bad request */
273 HTTP_STATUS_UNAUTHORIZED, /* Unauthorized to access host */
274 HTTP_STATUS_PAYMENT_REQUIRED, /* Payment required */
275 HTTP_STATUS_FORBIDDEN, /* Forbidden to access this URI */
276 HTTP_STATUS_NOT_FOUND, /* URI was not found */
277 HTTP_STATUS_METHOD_NOT_ALLOWED, /* Method is not allowed */
278 HTTP_STATUS_NOT_ACCEPTABLE, /* Not Acceptable */
279 HTTP_STATUS_PROXY_AUTHENTICATION, /* Proxy Authentication is Required */
280 HTTP_STATUS_REQUEST_TIMEOUT, /* Request timed out */
281 HTTP_STATUS_CONFLICT, /* Request is self-conflicting */
282 HTTP_STATUS_GONE, /* Server has gone away */
283 HTTP_STATUS_LENGTH_REQUIRED, /* A content length or encoding is required */
284 HTTP_STATUS_PRECONDITION, /* Precondition failed */
285 HTTP_STATUS_REQUEST_TOO_LARGE, /* Request entity too large */
286 HTTP_STATUS_URI_TOO_LONG, /* URI too long */
287 HTTP_STATUS_UNSUPPORTED_MEDIATYPE, /* The requested media type is unsupported */
288 HTTP_STATUS_REQUESTED_RANGE, /* The requested range is not satisfiable */
289 HTTP_STATUS_EXPECTATION_FAILED, /* The expectation given in an Expect header field was not met */
290 HTTP_STATUS_UPGRADE_REQUIRED = 426, /* Upgrade to SSL/TLS required */
291
292 HTTP_STATUS_SERVER_ERROR = 500, /* Internal server error */
293 HTTP_STATUS_NOT_IMPLEMENTED, /* Feature not implemented */
294 HTTP_STATUS_BAD_GATEWAY, /* Bad gateway */
295 HTTP_STATUS_SERVICE_UNAVAILABLE, /* Service is unavailable */
296 HTTP_STATUS_GATEWAY_TIMEOUT, /* Gateway connection timed out */
297 HTTP_STATUS_NOT_SUPPORTED, /* HTTP version not supported */
298
299 HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED = 1000,
300 /* User canceled authorization @since CUPS 1.4@ */
301 HTTP_STATUS_CUPS_PKI_ERROR, /* Error negotiating a secure connection @since CUPS 1.5/macOS 10.7@ */
302 HTTP_STATUS_CUPS_WEBIF_DISABLED /* Web interface is disabled @private@ */
303
304# define HTTP_STATUS_MOVED_TEMPORARILY HTTP_STATUS_FOUND /* Renamed in RFC 7231 */
305
306# ifndef _CUPS_NO_DEPRECATED
307/* Old names for this enumeration */
308# define HTTP_ERROR HTTP_STATUS_ERROR
309
310# define HTTP_CONTINUE HTTP_STATUS_CONTINUE
311# define HTTP_SWITCHING_PROTOCOLS HTTP_STATUS_SWITCHING_PROTOCOLS
312
313# define HTTP_OK HTTP_STATUS_OK
314# define HTTP_CREATED HTTP_STATUS_CREATED
315# define HTTP_ACCEPTED HTTP_STATUS_ACCEPTED
316# define HTTP_NOT_AUTHORITATIVE HTTP_STATUS_NOT_AUTHORITATIVE
317# define HTTP_NO_CONTENT HTTP_STATUS_NO_CONTENT
318# define HTTP_RESET_CONTENT HTTP_STATUS_RESET_CONTENT
319# define HTTP_PARTIAL_CONTENT HTTP_STATUS_PARTIAL_CONTENT
320
321# define HTTP_MULTIPLE_CHOICES HTTP_STATUS_MULTIPLE_CHOICES
322# define HTTP_MOVED_PERMANENTLY HTTP_STATUS_MOVED_PERMANENTLY
323# define HTTP_MOVED_TEMPORARILY HTTP_STATUS_MOVED_TEMPORARILY
324# define HTTP_SEE_OTHER HTTP_STATUS_SEE_OTHER
325# define HTTP_NOT_MODIFIED HTTP_STATUS_NOT_MODIFIED
326# define HTTP_USE_PROXY HTTP_STATUS_USE_PROXY
327
328# define HTTP_BAD_REQUEST HTTP_STATUS_BAD_REQUEST
329# define HTTP_UNAUTHORIZED HTTP_STATUS_UNAUTHORIZED
330# define HTTP_PAYMENT_REQUIRED HTTP_STATUS_PAYMENT_REQUIRED
331# define HTTP_FORBIDDEN HTTP_STATUS_FORBIDDEN
332# define HTTP_NOT_FOUND HTTP_STATUS_NOT_FOUND
333# define HTTP_METHOD_NOT_ALLOWED HTTP_STATUS_METHOD_NOT_ALLOWED
334# define HTTP_NOT_ACCEPTABLE HTTP_STATUS_NOT_ACCEPTABLE
335# define HTTP_PROXY_AUTHENTICATION HTTP_STATUS_PROXY_AUTHENTICATION
336# define HTTP_REQUEST_TIMEOUT HTTP_STATUS_REQUEST_TIMEOUT
337# define HTTP_CONFLICT HTTP_STATUS_CONFLICT
338# define HTTP_GONE HTTP_STATUS_GONE
339# define HTTP_LENGTH_REQUIRED HTTP_STATUS_LENGTH_REQUIRED
340# define HTTP_PRECONDITION HTTP_STATUS_PRECONDITION
341# define HTTP_REQUEST_TOO_LARGE HTTP_STATUS_REQUEST_TOO_LARGE
342# define HTTP_URI_TOO_LONG HTTP_STATUS_URI_TOO_LONG
343# define HTTP_UNSUPPORTED_MEDIATYPE HTTP_STATUS_UNSUPPORTED_MEDIATYPE
344# define HTTP_REQUESTED_RANGE HTTP_STATUS_REQUESTED_RANGE
345# define HTTP_EXPECTATION_FAILED HTTP_STATUS_EXPECTATION_FAILED
346# define HTTP_UPGRADE_REQUIRED HTTP_STATUS_UPGRADE_REQUIRED
347
348# define HTTP_SERVER_ERROR HTTP_STATUS_SERVER_ERROR
349# define HTTP_NOT_IMPLEMENTED HTTP_STATUS_NOT_IMPLEMENTED
350# define HTTP_BAD_GATEWAY HTTP_STATUS_BAD_GATEWAY
351# define HTTP_SERVICE_UNAVAILABLE HTTP_STATUS_SERVICE_UNAVAILABLE
352# define HTTP_GATEWAY_TIMEOUT HTTP_STATUS_GATEWAY_TIMEOUT
353# define HTTP_NOT_SUPPORTED HTTP_STATUS_NOT_SUPPORTED
354
355# define HTTP_AUTHORIZATION_CANCELED HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED
356# define HTTP_PKI_ERROR HTTP_STATUS_CUPS_PKI_ERROR
357# define HTTP_WEBIF_DISABLED HTTP_STATUS_CUPS_WEBIF_DISABLED
358# endif /* !_CUPS_NO_DEPRECATED */
359} http_status_t;
360
361typedef enum http_trust_e /**** Level of trust for credentials @since CUPS 2.0/OS 10.10@ */
362{
363 HTTP_TRUST_OK = 0, /* Credentials are OK/trusted */
364 HTTP_TRUST_INVALID, /* Credentials are invalid */
365 HTTP_TRUST_CHANGED, /* Credentials have changed */
366 HTTP_TRUST_EXPIRED, /* Credentials are expired */
367 HTTP_TRUST_RENEWED, /* Credentials have been renewed */
368 HTTP_TRUST_UNKNOWN /* Credentials are unknown/new */
369} http_trust_t;
370
371typedef enum http_uri_status_e /**** URI separation status @since CUPS 1.2@ ****/
372{
373 HTTP_URI_STATUS_OVERFLOW = -8, /* URI buffer for httpAssembleURI is too small */
374 HTTP_URI_STATUS_BAD_ARGUMENTS = -7, /* Bad arguments to function (error) */
375 HTTP_URI_STATUS_BAD_RESOURCE = -6, /* Bad resource in URI (error) */
376 HTTP_URI_STATUS_BAD_PORT = -5, /* Bad port number in URI (error) */
377 HTTP_URI_STATUS_BAD_HOSTNAME = -4, /* Bad hostname in URI (error) */
378 HTTP_URI_STATUS_BAD_USERNAME = -3, /* Bad username in URI (error) */
379 HTTP_URI_STATUS_BAD_SCHEME = -2, /* Bad scheme in URI (error) */
380 HTTP_URI_STATUS_BAD_URI = -1, /* Bad/empty URI (error) */
381 HTTP_URI_STATUS_OK = 0, /* URI decoded OK */
382 HTTP_URI_STATUS_MISSING_SCHEME, /* Missing scheme in URI (warning) */
383 HTTP_URI_STATUS_UNKNOWN_SCHEME, /* Unknown scheme in URI (warning) */
384 HTTP_URI_STATUS_MISSING_RESOURCE /* Missing resource in URI (warning) */
385
386# ifndef _CUPS_NO_DEPRECATED
387# define HTTP_URI_OVERFLOW HTTP_URI_STATUS_OVERFLOW
388# define HTTP_URI_BAD_ARGUMENTS HTTP_URI_STATUS_BAD_ARGUMENTS
389# define HTTP_URI_BAD_RESOURCE HTTP_URI_STATUS_BAD_RESOURCE
390# define HTTP_URI_BAD_PORT HTTP_URI_STATUS_BAD_PORT
391# define HTTP_URI_BAD_HOSTNAME HTTP_URI_STATUS_BAD_HOSTNAME
392# define HTTP_URI_BAD_USERNAME HTTP_URI_STATUS_BAD_USERNAME
393# define HTTP_URI_BAD_SCHEME HTTP_URI_STATUS_BAD_SCHEME
394# define HTTP_URI_BAD_URI HTTP_URI_STATUS_BAD_URI
395# define HTTP_URI_OK HTTP_URI_STATUS_OK
396# define HTTP_URI_MISSING_SCHEME HTTP_URI_STATUS_MISSING_SCHEME
397# define HTTP_URI_UNKNOWN_SCHEME HTTP_URI_STATUS_UNKNOWN_SCHEME
398# define HTTP_URI_MISSING_RESOURCE HTTP_URI_STATUS_MISSING_RESOURCE
399# endif /* !_CUPS_NO_DEPRECATED */
400} http_uri_status_t;
401
402typedef enum http_uri_coding_e /**** URI en/decode flags ****/
403{
404 HTTP_URI_CODING_NONE = 0, /* Don't en/decode anything */
405 HTTP_URI_CODING_USERNAME = 1, /* En/decode the username portion */
406 HTTP_URI_CODING_HOSTNAME = 2, /* En/decode the hostname portion */
407 HTTP_URI_CODING_RESOURCE = 4, /* En/decode the resource portion */
408 HTTP_URI_CODING_MOST = 7, /* En/decode all but the query */
409 HTTP_URI_CODING_QUERY = 8, /* En/decode the query portion */
410 HTTP_URI_CODING_ALL = 15, /* En/decode everything */
411 HTTP_URI_CODING_RFC6874 = 16 /* Use RFC 6874 address format */
412} http_uri_coding_t;
413
414typedef enum http_version_e /**** HTTP version numbers @exclude all@ ****/
415{
416 HTTP_VERSION_0_9 = 9, /* HTTP/0.9 */
417 HTTP_VERSION_1_0 = 100, /* HTTP/1.0 */
418 HTTP_VERSION_1_1 = 101 /* HTTP/1.1 */
419
420# ifndef _CUPS_NO_DEPRECATED
421# define HTTP_0_9 HTTP_VERSION_0_9
422# define HTTP_1_0 HTTP_VERSION_1_0
423# define HTTP_1_1 HTTP_VERSION_1_1
424# endif /* !_CUPS_NO_DEPRECATED */
425} http_version_t;
426
427typedef union _http_addr_u /**** Socket address union, which
428 **** makes using IPv6 and other
429 **** address types easier and
430 **** more portable. @since CUPS 1.2/macOS 10.5@
431 ****/
432{
433 struct sockaddr addr; /* Base structure for family value */
434 struct sockaddr_in ipv4; /* IPv4 address */
435#ifdef AF_INET6
436 struct sockaddr_in6 ipv6; /* IPv6 address */
437#endif /* AF_INET6 */
438#ifdef AF_LOCAL
439 struct sockaddr_un un; /* Domain socket file */
440#endif /* AF_LOCAL */
441 char pad[256]; /* Padding to ensure binary compatibility */
442} http_addr_t;
443
444typedef struct http_addrlist_s /**** Socket address list, which is
445 **** used to enumerate all of the
446 **** addresses that are associated
447 **** with a hostname. @since CUPS 1.2/macOS 10.5@
448 **** @exclude all@
449 ****/
450{
451 struct http_addrlist_s *next; /* Pointer to next address in list */
452 http_addr_t addr; /* Address */
453} http_addrlist_t;
454
455typedef struct _http_s http_t; /**** HTTP connection type ****/
456
457typedef struct http_credential_s /**** HTTP credential data @since CUPS 1.5/macOS 10.7@ @exclude all@ ****/
458{
459 void *data; /* Pointer to credential data */
460 size_t datalen; /* Credential length */
461} http_credential_t;
462
463typedef int (*http_timeout_cb_t)(http_t *http, void *user_data);
464 /**** HTTP timeout callback @since CUPS 1.5/macOS 10.7@ ****/
465
466
467
468/*
469 * Prototypes...
470 */
471
472extern void httpBlocking(http_t *http, int b) _CUPS_PUBLIC;
473extern int httpCheck(http_t *http) _CUPS_PUBLIC;
474extern void httpClearFields(http_t *http) _CUPS_PUBLIC;
475extern void httpClose(http_t *http) _CUPS_PUBLIC;
476extern http_t *httpConnect(const char *host, int port) _CUPS_DEPRECATED_1_7_MSG("Use httpConnect2 instead.");
477extern http_t *httpConnectEncrypt(const char *host, int port, http_encryption_t encryption) _CUPS_DEPRECATED_1_7_MSG("Use httpConnect2 instead.");
478extern int httpDelete(http_t *http, const char *uri) _CUPS_PUBLIC;
479extern int httpEncryption(http_t *http, http_encryption_t e) _CUPS_PUBLIC;
480extern int httpError(http_t *http) _CUPS_PUBLIC;
481extern void httpFlush(http_t *http) _CUPS_PUBLIC;
482extern int httpGet(http_t *http, const char *uri) _CUPS_PUBLIC;
483extern char *httpGets(char *line, int length, http_t *http) _CUPS_PUBLIC;
484extern const char *httpGetDateString(time_t t) _CUPS_PUBLIC;
485extern time_t httpGetDateTime(const char *s) _CUPS_PUBLIC;
486extern const char *httpGetField(http_t *http, http_field_t field) _CUPS_PUBLIC;
487extern struct hostent *httpGetHostByName(const char *name) _CUPS_PUBLIC;
488extern char *httpGetSubField(http_t *http, http_field_t field, const char *name, char *value) _CUPS_PUBLIC;
489extern int httpHead(http_t *http, const char *uri) _CUPS_PUBLIC;
490extern void httpInitialize(void) _CUPS_PUBLIC;
491extern int httpOptions(http_t *http, const char *uri) _CUPS_PUBLIC;
492extern int httpPost(http_t *http, const char *uri) _CUPS_PUBLIC;
493extern int httpPrintf(http_t *http, const char *format, ...) _CUPS_FORMAT(2, 3) _CUPS_PUBLIC;
494extern int httpPut(http_t *http, const char *uri) _CUPS_PUBLIC;
495extern int httpRead(http_t *http, char *buffer, int length) _CUPS_DEPRECATED_MSG("Use httpRead2 instead.");
496extern int httpReconnect(http_t *http) _CUPS_DEPRECATED_1_6_MSG("Use httpReconnect2 instead.");
497extern void httpSeparate(const char *uri, char *method, char *username, char *host, int *port, char *resource) _CUPS_DEPRECATED_1_2_MSG("Use httpSeparateURI instead.");
498extern void httpSetField(http_t *http, http_field_t field, const char *value) _CUPS_PUBLIC;
499extern const char *httpStatus(http_status_t status) _CUPS_PUBLIC;
500extern int httpTrace(http_t *http, const char *uri) _CUPS_PUBLIC;
501extern http_status_t httpUpdate(http_t *http) _CUPS_PUBLIC;
502extern int httpWrite(http_t *http, const char *buffer, int length) _CUPS_DEPRECATED_MSG("Use httpWrite2 instead.");
503extern char *httpEncode64(char *out, const char *in) _CUPS_DEPRECATED_MSG("Use httpEncode64_2 instead.");
504extern char *httpDecode64(char *out, const char *in) _CUPS_DEPRECATED_MSG("Use httpDecode64_2 instead.");
505extern int httpGetLength(http_t *http) _CUPS_DEPRECATED_1_2_MSG("Use httpGetLength2 instead.");
506extern char *httpMD5(const char *, const char *, const char *, char [33]) _CUPS_DEPRECATED_MSG("Use cupsDoAuth or cupsHashData instead.");
507extern char *httpMD5Final(const char *, const char *, const char *, char [33]) _CUPS_DEPRECATED_2_2_MSG("Use cupsDoAuth or cupsHashData instead.");
508extern char *httpMD5String(const unsigned char *, char [33]) _CUPS_DEPRECATED_2_2_MSG("Use cupsHashString instead.");
509
510/**** New in CUPS 1.1.19 ****/
511extern void httpClearCookie(http_t *http) _CUPS_API_1_1_19;
512extern const char *httpGetCookie(http_t *http) _CUPS_API_1_1_19;
513extern void httpSetCookie(http_t *http, const char *cookie) _CUPS_API_1_1_19;
514extern int httpWait(http_t *http, int msec) _CUPS_API_1_1_19;
515
516/**** New in CUPS 1.1.21 ****/
517extern char *httpDecode64_2(char *out, int *outlen, const char *in) _CUPS_API_1_1_21;
518extern char *httpEncode64_2(char *out, int outlen, const char *in, int inlen) _CUPS_API_1_1_21;
519extern void httpSeparate2(const char *uri, char *method, int methodlen, char *username, int usernamelen, char *host, int hostlen, int *port, char *resource, int resourcelen) _CUPS_DEPRECATED_1_2_MSG("Use httpSeparateURI instead.");
520
521/**** New in CUPS 1.2/macOS 10.5 ****/
522extern int httpAddrAny(const http_addr_t *addr) _CUPS_API_1_2;
523extern http_addrlist_t *httpAddrConnect(http_addrlist_t *addrlist, int *sock) _CUPS_API_1_2;
524extern int httpAddrEqual(const http_addr_t *addr1, const http_addr_t *addr2) _CUPS_API_1_2;
525extern void httpAddrFreeList(http_addrlist_t *addrlist) _CUPS_API_1_2;
526extern http_addrlist_t *httpAddrGetList(const char *hostname, int family, const char *service) _CUPS_API_1_2;
527extern int httpAddrLength(const http_addr_t *addr) _CUPS_API_1_2;
528extern int httpAddrLocalhost(const http_addr_t *addr) _CUPS_API_1_2;
529extern char *httpAddrLookup(const http_addr_t *addr, char *name, int namelen) _CUPS_API_1_2;
530extern char *httpAddrString(const http_addr_t *addr, char *s, int slen) _CUPS_API_1_2;
531extern http_uri_status_t httpAssembleURI(http_uri_coding_t encoding, char *uri, int urilen, const char *scheme, const char *username, const char *host, int port, const char *resource) _CUPS_API_1_2;
532extern http_uri_status_t httpAssembleURIf(http_uri_coding_t encoding, char *uri, int urilen, const char *scheme, const char *username, const char *host, int port, const char *resourcef, ...) _CUPS_FORMAT(8, 9) _CUPS_API_1_2;
533extern int httpFlushWrite(http_t *http) _CUPS_API_1_2;
534extern int httpGetBlocking(http_t *http) _CUPS_API_1_2;
535extern const char *httpGetDateString2(time_t t, char *s, int slen) _CUPS_API_1_2;
536extern int httpGetFd(http_t *http) _CUPS_API_1_2;
537extern const char *httpGetHostname(http_t *http, char *s, int slen) _CUPS_API_1_2;
538extern off_t httpGetLength2(http_t *http) _CUPS_API_1_2;
539extern http_status_t httpGetStatus(http_t *http) _CUPS_API_1_2;
540extern char *httpGetSubField2(http_t *http, http_field_t field, const char *name, char *value, int valuelen) _CUPS_API_1_2;
541extern ssize_t httpRead2(http_t *http, char *buffer, size_t length) _CUPS_API_1_2;
542extern http_uri_status_t httpSeparateURI(http_uri_coding_t decoding, const char *uri, char *scheme, int schemelen, char *username, int usernamelen, char *host, int hostlen, int *port, char *resource, int resourcelen) _CUPS_API_1_2;
543extern void httpSetExpect(http_t *http, http_status_t expect) _CUPS_API_1_2;
544extern void httpSetLength(http_t *http, size_t length) _CUPS_API_1_2;
545extern ssize_t httpWrite2(http_t *http, const char *buffer, size_t length) _CUPS_API_1_2;
546
547/**** New in CUPS 1.3/macOS 10.5 ****/
548extern char *httpGetAuthString(http_t *http) _CUPS_API_1_3;
549extern void httpSetAuthString(http_t *http, const char *scheme, const char *data) _CUPS_API_1_3;
550
551/**** New in CUPS 1.5/macOS 10.7 ****/
552extern int httpAddCredential(cups_array_t *credentials, const void *data, size_t datalen) _CUPS_API_1_5;
553extern int httpCopyCredentials(http_t *http, cups_array_t **credentials) _CUPS_API_1_5;
554extern void httpFreeCredentials(cups_array_t *certs) _CUPS_API_1_5;
555extern int httpSetCredentials(http_t *http, cups_array_t *certs) _CUPS_API_1_5;
556extern void httpSetTimeout(http_t *http, double timeout, http_timeout_cb_t cb, void *user_data) _CUPS_API_1_5;
557
558/**** New in CUPS 1.6/macOS 10.8 ****/
559extern http_addrlist_t *httpAddrConnect2(http_addrlist_t *addrlist, int *sock, int msec, int *cancel) _CUPS_API_1_6;
560extern http_state_t httpGetState(http_t *http) _CUPS_API_1_6;
561extern http_version_t httpGetVersion(http_t *http) _CUPS_API_1_6;
562extern int httpReconnect2(http_t *http, int msec, int *cancel) _CUPS_API_1_6;
563
564
565/**** New in CUPS 1.7/macOS 10.9 ****/
566extern http_t *httpAcceptConnection(int fd, int blocking) _CUPS_API_1_7;
567extern http_addrlist_t *httpAddrCopyList(http_addrlist_t *src) _CUPS_API_1_7;
568extern int httpAddrListen(http_addr_t *addr, int port) _CUPS_API_1_7;
569extern int httpAddrPort(http_addr_t *addr) _CUPS_API_1_7;
570extern char *httpAssembleUUID(const char *server, int port, const char *name, int number, char *buffer, size_t bufsize) _CUPS_API_1_7;
571extern http_t *httpConnect2(const char *host, int port, http_addrlist_t *addrlist, int family, http_encryption_t encryption, int blocking, int msec, int *cancel) _CUPS_API_1_7;
572extern const char *httpGetContentEncoding(http_t *http) _CUPS_API_1_7;
573extern http_status_t httpGetExpect(http_t *http) _CUPS_API_1_7;
574extern ssize_t httpPeek(http_t *http, char *buffer, size_t length) _CUPS_API_1_7;
575extern http_state_t httpReadRequest(http_t *http, char *resource, size_t resourcelen) _CUPS_API_1_7;
576extern void httpSetDefaultField(http_t *http, http_field_t field, const char *value) _CUPS_API_1_7;
577extern http_state_t httpWriteResponse(http_t *http, http_status_t status) _CUPS_API_1_7;
578
579/* New in CUPS 2.0/macOS 10.10 */
580extern int httpAddrClose(http_addr_t *addr, int fd) _CUPS_API_2_0;
581extern int httpAddrFamily(http_addr_t *addr) _CUPS_API_2_0;
582extern int httpCompareCredentials(cups_array_t *cred1, cups_array_t *cred2) _CUPS_API_2_0;
583extern int httpCredentialsAreValidForName(cups_array_t *credentials, const char *common_name);
584extern time_t httpCredentialsGetExpiration(cups_array_t *credentials) _CUPS_API_2_0;
585extern http_trust_t httpCredentialsGetTrust(cups_array_t *credentials, const char *common_name) _CUPS_API_2_0;
586extern size_t httpCredentialsString(cups_array_t *credentials, char *buffer, size_t bufsize) _CUPS_API_2_0;
587extern http_field_t httpFieldValue(const char *name) _CUPS_API_2_0;
588extern time_t httpGetActivity(http_t *http) _CUPS_API_2_0;
589extern http_addr_t *httpGetAddress(http_t *http) _CUPS_API_2_0;
590extern http_encryption_t httpGetEncryption(http_t *http) _CUPS_API_2_0;
591extern http_keepalive_t httpGetKeepAlive(http_t *http) _CUPS_API_2_0;
592extern size_t httpGetPending(http_t *http) _CUPS_API_2_0;
593extern size_t httpGetReady(http_t *http) _CUPS_API_2_0;
594extern size_t httpGetRemaining(http_t *http) _CUPS_API_2_0;
595extern int httpIsChunked(http_t *http) _CUPS_API_2_0;
596extern int httpIsEncrypted(http_t *http) _CUPS_API_2_0;
597extern int httpLoadCredentials(const char *path, cups_array_t **credentials, const char *common_name) _CUPS_API_2_0;
598extern const char *httpResolveHostname(http_t *http, char *buffer, size_t bufsize) _CUPS_API_2_0;
599extern int httpSaveCredentials(const char *path, cups_array_t *credentials, const char *common_name) _CUPS_API_2_0;
600extern void httpSetKeepAlive(http_t *http, http_keepalive_t keep_alive) _CUPS_API_2_0;
601extern void httpShutdown(http_t *http) _CUPS_API_2_0;
602extern const char *httpStateString(http_state_t state) _CUPS_API_2_0;
603extern const char *httpURIStatusString(http_uri_status_t status) _CUPS_API_2_0;
604
605/*
606 * C++ magic...
607 */
608
609# ifdef __cplusplus
610}
611# endif /* __cplusplus */
612#endif /* !_CUPS_HTTP_H_ */
613

source code of include/cups/http.h