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