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