2 * "$Id: http.h 7026 2007-10-19 00:57:45Z mike $"
4 * Hyper-Text Transport Protocol definitions for CUPS.
6 * Copyright 2007-2012 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 # define _CUPS_HTTP_H_
22 * Include necessary headers...
25 # include "versioning.h"
29 # include <sys/types.h>
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... */
34 typedef off_t ssize_t
; /* @private@ */
35 # endif /* !__CUPS_SSIZE_T_DEFINED */
36 # include <winsock2.h>
37 # include <ws2tcpip.h>
40 # include <sys/time.h>
41 # include <sys/socket.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 */
55 # endif /* AF_LOCAL */
56 # if defined(LOCAL_PEERCRED) && !defined(SO_PEERCRED)
57 # define SO_PEERCRED LOCAL_PEERCRED
58 # endif /* LOCAL_PEERCRED && !SO_PEERCRED */
68 # endif /* __cplusplus */
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.
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
85 #if defined(AF_INET6) && !defined(s6_addr32)
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
94 * Windows only defines byte and 16-bit word members of the union and
95 * requires special casing of all raw address code...
97 # define s6_addr32 error_need_win32_specific_code
99 #endif /* AF_INET6 && !s6_addr32 */
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 */
113 * Types and structures...
116 typedef enum http_auth_e
/**** HTTP authentication types ****/
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@ */
127 typedef enum http_encoding_e
/**** HTTP transfer encoding values ****/
129 HTTP_ENCODE_LENGTH
, /* Data is sent with Content-Length */
130 HTTP_ENCODE_CHUNKED
, /* Data is chunked */
131 HTTP_ENCODE_FIELDS
/* Sending HTTP fields */
134 typedef enum http_encryption_e
/**** HTTP encryption values ****/
136 HTTP_ENCRYPT_IF_REQUESTED
, /* Encrypt if requested (TLS upgrade) */
137 HTTP_ENCRYPT_NEVER
, /* Never encrypt */
138 HTTP_ENCRYPT_REQUIRED
, /* Encryption is required (TLS upgrade) */
139 HTTP_ENCRYPT_ALWAYS
/* Always encrypt (SSL) */
142 typedef enum http_field_e
/**** HTTP field names ****/
144 HTTP_FIELD_UNKNOWN
= -1, /* Unknown field */
145 HTTP_FIELD_ACCEPT_LANGUAGE
, /* Accept-Language field */
146 HTTP_FIELD_ACCEPT_RANGES
, /* Accept-Ranges field */
147 HTTP_FIELD_AUTHORIZATION
, /* Authorization field */
148 HTTP_FIELD_CONNECTION
, /* Connection field */
149 HTTP_FIELD_CONTENT_ENCODING
, /* Content-Encoding field */
150 HTTP_FIELD_CONTENT_LANGUAGE
, /* Content-Language field */
151 HTTP_FIELD_CONTENT_LENGTH
, /* Content-Length field */
152 HTTP_FIELD_CONTENT_LOCATION
, /* Content-Location field */
153 HTTP_FIELD_CONTENT_MD5
, /* Content-MD5 field */
154 HTTP_FIELD_CONTENT_RANGE
, /* Content-Range field */
155 HTTP_FIELD_CONTENT_TYPE
, /* Content-Type field */
156 HTTP_FIELD_CONTENT_VERSION
, /* Content-Version field */
157 HTTP_FIELD_DATE
, /* Date field */
158 HTTP_FIELD_HOST
, /* Host field */
159 HTTP_FIELD_IF_MODIFIED_SINCE
, /* If-Modified-Since field */
160 HTTP_FIELD_IF_UNMODIFIED_SINCE
, /* If-Unmodified-Since field */
161 HTTP_FIELD_KEEP_ALIVE
, /* Keep-Alive field */
162 HTTP_FIELD_LAST_MODIFIED
, /* Last-Modified field */
163 HTTP_FIELD_LINK
, /* Link field */
164 HTTP_FIELD_LOCATION
, /* Location field */
165 HTTP_FIELD_RANGE
, /* Range field */
166 HTTP_FIELD_REFERER
, /* Referer field */
167 HTTP_FIELD_RETRY_AFTER
, /* Retry-After field */
168 HTTP_FIELD_TRANSFER_ENCODING
, /* Transfer-Encoding field */
169 HTTP_FIELD_UPGRADE
, /* Upgrade field */
170 HTTP_FIELD_USER_AGENT
, /* User-Agent field */
171 HTTP_FIELD_WWW_AUTHENTICATE
, /* WWW-Authenticate field */
172 HTTP_FIELD_MAX
/* Maximum field index */
175 typedef enum http_keepalive_e
/**** HTTP keep-alive values ****/
177 HTTP_KEEPALIVE_OFF
= 0, /* No keep alive support */
178 HTTP_KEEPALIVE_ON
/* Use keep alive */
181 typedef enum http_state_e
/**** HTTP state values; states
182 **** are server-oriented...
185 HTTP_WAITING
, /* Waiting for command */
186 HTTP_OPTIONS
, /* OPTIONS command, waiting for blank line */
187 HTTP_GET
, /* GET command, waiting for blank line */
188 HTTP_GET_SEND
, /* GET command, sending data */
189 HTTP_HEAD
, /* HEAD command, waiting for blank line */
190 HTTP_POST
, /* POST command, waiting for blank line */
191 HTTP_POST_RECV
, /* POST command, receiving data */
192 HTTP_POST_SEND
, /* POST command, sending data */
193 HTTP_PUT
, /* PUT command, waiting for blank line */
194 HTTP_PUT_RECV
, /* PUT command, receiving data */
195 HTTP_DELETE
, /* DELETE command, waiting for blank line */
196 HTTP_TRACE
, /* TRACE command, waiting for blank line */
197 HTTP_CLOSE
, /* CLOSE command, waiting for blank line */
198 HTTP_STATUS
/* Command complete, sending status */
201 typedef enum http_status_e
/**** HTTP status codes ****/
203 HTTP_ERROR
= -1, /* An error response from httpXxxx() */
205 HTTP_CONTINUE
= 100, /* Everything OK, keep going... */
206 HTTP_SWITCHING_PROTOCOLS
, /* HTTP upgrade to TLS/SSL */
208 HTTP_OK
= 200, /* OPTIONS/GET/HEAD/POST/TRACE command was successful */
209 HTTP_CREATED
, /* PUT command was successful */
210 HTTP_ACCEPTED
, /* DELETE command was successful */
211 HTTP_NOT_AUTHORITATIVE
, /* Information isn't authoritative */
212 HTTP_NO_CONTENT
, /* Successful command, no new data */
213 HTTP_RESET_CONTENT
, /* Content was reset/recreated */
214 HTTP_PARTIAL_CONTENT
, /* Only a partial file was recieved/sent */
216 HTTP_MULTIPLE_CHOICES
= 300, /* Multiple files match request */
217 HTTP_MOVED_PERMANENTLY
, /* Document has moved permanently */
218 HTTP_MOVED_TEMPORARILY
, /* Document has moved temporarily */
219 HTTP_SEE_OTHER
, /* See this other link... */
220 HTTP_NOT_MODIFIED
, /* File not modified */
221 HTTP_USE_PROXY
, /* Must use a proxy to access this URI */
223 HTTP_BAD_REQUEST
= 400, /* Bad request */
224 HTTP_UNAUTHORIZED
, /* Unauthorized to access host */
225 HTTP_PAYMENT_REQUIRED
, /* Payment required */
226 HTTP_FORBIDDEN
, /* Forbidden to access this URI */
227 HTTP_NOT_FOUND
, /* URI was not found */
228 HTTP_METHOD_NOT_ALLOWED
, /* Method is not allowed */
229 HTTP_NOT_ACCEPTABLE
, /* Not Acceptable */
230 HTTP_PROXY_AUTHENTICATION
, /* Proxy Authentication is Required */
231 HTTP_REQUEST_TIMEOUT
, /* Request timed out */
232 HTTP_CONFLICT
, /* Request is self-conflicting */
233 HTTP_GONE
, /* Server has gone away */
234 HTTP_LENGTH_REQUIRED
, /* A content length or encoding is required */
235 HTTP_PRECONDITION
, /* Precondition failed */
236 HTTP_REQUEST_TOO_LARGE
, /* Request entity too large */
237 HTTP_URI_TOO_LONG
, /* URI too long */
238 HTTP_UNSUPPORTED_MEDIATYPE
, /* The requested media type is unsupported */
239 HTTP_REQUESTED_RANGE
, /* The requested range is not satisfiable */
240 HTTP_EXPECTATION_FAILED
, /* The expectation given in an Expect header field was not met */
241 HTTP_UPGRADE_REQUIRED
= 426, /* Upgrade to SSL/TLS required */
243 HTTP_SERVER_ERROR
= 500, /* Internal server error */
244 HTTP_NOT_IMPLEMENTED
, /* Feature not implemented */
245 HTTP_BAD_GATEWAY
, /* Bad gateway */
246 HTTP_SERVICE_UNAVAILABLE
, /* Service is unavailable */
247 HTTP_GATEWAY_TIMEOUT
, /* Gateway connection timed out */
248 HTTP_NOT_SUPPORTED
, /* HTTP version not supported */
250 HTTP_AUTHORIZATION_CANCELED
= 1000, /* User canceled authorization @since CUPS 1.4@ */
251 HTTP_PKI_ERROR
, /* Error negotiating a secure connection @since CUPS 1.5/OS X 10.7@ */
252 HTTP_WEBIF_DISABLED
/* Web interface is disabled @private@ */
255 typedef enum http_uri_status_e
/**** URI separation status @since CUPS 1.2@ ****/
257 HTTP_URI_OVERFLOW
= -8, /* URI buffer for httpAssembleURI is too small */
258 HTTP_URI_BAD_ARGUMENTS
= -7, /* Bad arguments to function (error) */
259 HTTP_URI_BAD_RESOURCE
= -6, /* Bad resource in URI (error) */
260 HTTP_URI_BAD_PORT
= -5, /* Bad port number in URI (error) */
261 HTTP_URI_BAD_HOSTNAME
= -4, /* Bad hostname in URI (error) */
262 HTTP_URI_BAD_USERNAME
= -3, /* Bad username in URI (error) */
263 HTTP_URI_BAD_SCHEME
= -2, /* Bad scheme in URI (error) */
264 HTTP_URI_BAD_URI
= -1, /* Bad/empty URI (error) */
265 HTTP_URI_OK
= 0, /* URI decoded OK */
266 HTTP_URI_MISSING_SCHEME
, /* Missing scheme in URI (warning) */
267 HTTP_URI_UNKNOWN_SCHEME
, /* Unknown scheme in URI (warning) */
268 HTTP_URI_MISSING_RESOURCE
/* Missing resource in URI (warning) */
271 typedef enum http_uri_coding_e
/**** URI en/decode flags ****/
273 HTTP_URI_CODING_NONE
= 0, /* Don't en/decode anything */
274 HTTP_URI_CODING_USERNAME
= 1, /* En/decode the username portion */
275 HTTP_URI_CODING_HOSTNAME
= 2, /* En/decode the hostname portion */
276 HTTP_URI_CODING_RESOURCE
= 4, /* En/decode the resource portion */
277 HTTP_URI_CODING_MOST
= 7, /* En/decode all but the query */
278 HTTP_URI_CODING_QUERY
= 8, /* En/decode the query portion */
279 HTTP_URI_CODING_ALL
= 15 /* En/decode everything */
282 typedef enum http_version_e
/**** HTTP version numbers ****/
284 HTTP_0_9
= 9, /* HTTP/0.9 */
285 HTTP_1_0
= 100, /* HTTP/1.0 */
286 HTTP_1_1
= 101 /* HTTP/1.1 */
289 typedef union _http_addr_u
/**** Socket address union, which
290 **** makes using IPv6 and other
291 **** address types easier and
292 **** more portable. @since CUPS 1.2/OS X 10.5@
295 struct sockaddr addr
; /* Base structure for family value */
296 struct sockaddr_in ipv4
; /* IPv4 address */
298 struct sockaddr_in6 ipv6
; /* IPv6 address */
299 #endif /* AF_INET6 */
301 struct sockaddr_un un
; /* Domain socket file */
302 #endif /* AF_LOCAL */
303 char pad
[256]; /* Padding to ensure binary compatibility */
306 typedef struct http_addrlist_s
/**** Socket address list, which is
307 **** used to enumerate all of the
308 **** addresses that are associated
309 **** with a hostname. @since CUPS 1.2/OS X 10.5@
312 struct http_addrlist_s
*next
; /* Pointer to next address in list */
313 http_addr_t addr
; /* Address */
316 typedef struct _http_s http_t
; /**** HTTP connection type ****/
318 typedef struct http_credential_s
/**** HTTP credential data @since CUPS 1.5/OS X 10.7@ ****/
320 void *data
; /* Pointer to credential data */
321 size_t datalen
; /* Credential length */
324 typedef int (*http_timeout_cb_t
)(http_t
*http
, void *user_data
);
325 /**** HTTP timeout callback @since CUPS 1.5/OS X 10.7@ ****/
333 extern void httpBlocking(http_t
*http
, int b
);
334 extern int httpCheck(http_t
*http
);
335 extern void httpClearFields(http_t
*http
);
336 extern void httpClose(http_t
*http
);
337 extern http_t
*httpConnect(const char *host
, int port
);
338 extern http_t
*httpConnectEncrypt(const char *host
, int port
,
339 http_encryption_t encryption
);
340 extern int httpDelete(http_t
*http
, const char *uri
);
341 extern int httpEncryption(http_t
*http
, http_encryption_t e
);
342 extern int httpError(http_t
*http
);
343 extern void httpFlush(http_t
*http
);
344 extern int httpGet(http_t
*http
, const char *uri
);
345 extern char *httpGets(char *line
, int length
, http_t
*http
);
346 extern const char *httpGetDateString(time_t t
);
347 extern time_t httpGetDateTime(const char *s
);
348 extern const char *httpGetField(http_t
*http
, http_field_t field
);
349 extern struct hostent
*httpGetHostByName(const char *name
);
350 extern char *httpGetSubField(http_t
*http
, http_field_t field
,
351 const char *name
, char *value
);
352 extern int httpHead(http_t
*http
, const char *uri
);
353 extern void httpInitialize(void);
354 extern int httpOptions(http_t
*http
, const char *uri
);
355 extern int httpPost(http_t
*http
, const char *uri
);
356 extern int httpPrintf(http_t
*http
, const char *format
, ...)
357 __attribute__ ((__format__ (__printf__
, 2, 3)));
358 extern int httpPut(http_t
*http
, const char *uri
);
359 extern int httpRead(http_t
*http
, char *buffer
, int length
) _CUPS_DEPRECATED
;
360 extern int httpReconnect(http_t
*http
);
361 extern void httpSeparate(const char *uri
, char *method
,
362 char *username
, char *host
, int *port
,
363 char *resource
) _CUPS_DEPRECATED
;
364 extern void httpSetField(http_t
*http
, http_field_t field
,
366 extern const char *httpStatus(http_status_t status
);
367 extern int httpTrace(http_t
*http
, const char *uri
);
368 extern http_status_t
httpUpdate(http_t
*http
);
369 extern int httpWrite(http_t
*http
, const char *buffer
, int length
) _CUPS_DEPRECATED
;
370 extern char *httpEncode64(char *out
, const char *in
) _CUPS_DEPRECATED
;
371 extern char *httpDecode64(char *out
, const char *in
) _CUPS_DEPRECATED
;
372 extern int httpGetLength(http_t
*http
) _CUPS_DEPRECATED
;
373 extern char *httpMD5(const char *, const char *, const char *,
375 extern char *httpMD5Final(const char *, const char *, const char *,
377 extern char *httpMD5String(const unsigned char *, char [33]);
379 /**** New in CUPS 1.1.19 ****/
380 extern void httpClearCookie(http_t
*http
) _CUPS_API_1_1_19
;
381 extern const char *httpGetCookie(http_t
*http
) _CUPS_API_1_1_19
;
382 extern void httpSetCookie(http_t
*http
, const char *cookie
) _CUPS_API_1_1_19
;
383 extern int httpWait(http_t
*http
, int msec
) _CUPS_API_1_1_19
;
385 /**** New in CUPS 1.1.21 ****/
386 extern char *httpDecode64_2(char *out
, int *outlen
, const char *in
) _CUPS_API_1_1_21
;
387 extern char *httpEncode64_2(char *out
, int outlen
, const char *in
,
388 int inlen
) _CUPS_API_1_1_21
;
389 extern void httpSeparate2(const char *uri
,
390 char *method
, int methodlen
,
391 char *username
, int usernamelen
,
392 char *host
, int hostlen
, int *port
,
393 char *resource
, int resourcelen
) _CUPS_DEPRECATED
;
395 /**** New in CUPS 1.2/OS X 10.5 ****/
396 extern int httpAddrAny(const http_addr_t
*addr
) _CUPS_API_1_2
;
397 extern http_addrlist_t
*httpAddrConnect(http_addrlist_t
*addrlist
, int *sock
) _CUPS_API_1_2
;
398 extern int httpAddrEqual(const http_addr_t
*addr1
,
399 const http_addr_t
*addr2
) _CUPS_API_1_2
;
400 extern void httpAddrFreeList(http_addrlist_t
*addrlist
) _CUPS_API_1_2
;
401 extern http_addrlist_t
*httpAddrGetList(const char *hostname
, int family
,
402 const char *service
) _CUPS_API_1_2
;
403 extern int httpAddrLength(const http_addr_t
*addr
) _CUPS_API_1_2
;
404 extern int httpAddrLocalhost(const http_addr_t
*addr
) _CUPS_API_1_2
;
405 extern char *httpAddrLookup(const http_addr_t
*addr
,
406 char *name
, int namelen
) _CUPS_API_1_2
;
407 extern char *httpAddrString(const http_addr_t
*addr
,
408 char *s
, int slen
) _CUPS_API_1_2
;
409 extern http_uri_status_t
httpAssembleURI(http_uri_coding_t encoding
,
410 char *uri
, int urilen
,
412 const char *username
,
413 const char *host
, int port
,
414 const char *resource
) _CUPS_API_1_2
;
415 extern http_uri_status_t
httpAssembleURIf(http_uri_coding_t encoding
,
416 char *uri
, int urilen
,
418 const char *username
,
419 const char *host
, int port
,
420 const char *resourcef
, ...) _CUPS_API_1_2
;
421 extern int httpFlushWrite(http_t
*http
) _CUPS_API_1_2
;
422 extern int httpGetBlocking(http_t
*http
) _CUPS_API_1_2
;
423 extern const char *httpGetDateString2(time_t t
, char *s
, int slen
) _CUPS_API_1_2
;
424 extern int httpGetFd(http_t
*http
) _CUPS_API_1_2
;
425 extern const char *httpGetHostname(http_t
*http
, char *s
, int slen
) _CUPS_API_1_2
;
426 extern off_t
httpGetLength2(http_t
*http
) _CUPS_API_1_2
;
427 extern http_status_t
httpGetStatus(http_t
*http
) _CUPS_API_1_2
;
428 extern char *httpGetSubField2(http_t
*http
, http_field_t field
,
429 const char *name
, char *value
,
430 int valuelen
) _CUPS_API_1_2
;
431 extern ssize_t
httpRead2(http_t
*http
, char *buffer
, size_t length
) _CUPS_API_1_2
;
432 extern http_uri_status_t
httpSeparateURI(http_uri_coding_t decoding
,
434 char *scheme
, int schemelen
,
435 char *username
, int usernamelen
,
436 char *host
, int hostlen
, int *port
,
437 char *resource
, int resourcelen
) _CUPS_API_1_2
;
438 extern void httpSetExpect(http_t
*http
, http_status_t expect
) _CUPS_API_1_2
;
439 extern void httpSetLength(http_t
*http
, size_t length
) _CUPS_API_1_2
;
440 extern ssize_t
httpWrite2(http_t
*http
, const char *buffer
,
441 size_t length
) _CUPS_API_1_2
;
443 /**** New in CUPS 1.3/OS X 10.5 ****/
444 extern char *httpGetAuthString(http_t
*http
) _CUPS_API_1_3
;
445 extern void httpSetAuthString(http_t
*http
, const char *scheme
,
446 const char *data
) _CUPS_API_1_3
;
448 /**** New in CUPS 1.5/OS X 10.7 ****/
449 extern int httpAddCredential(cups_array_t
*credentials
,
450 const void *data
, size_t datalen
)
452 extern int httpCopyCredentials(http_t
*http
,
453 cups_array_t
**credentials
)
455 extern void httpFreeCredentials(cups_array_t
*certs
) _CUPS_API_1_5
;
456 extern int httpSetCredentials(http_t
*http
, cups_array_t
*certs
)
458 extern void httpSetTimeout(http_t
*http
, double timeout
,
459 http_timeout_cb_t cb
, void *user_data
)
462 /**** New in CUPS 1.6/OS X 10.8 ****/
463 extern http_addrlist_t
*httpAddrConnect2(http_addrlist_t
*addrlist
, int *sock
,
464 int msec
, int *cancel
)
466 extern http_state_t
httpGetState(http_t
*http
) _CUPS_API_1_6
;
467 extern http_version_t
httpGetVersion(http_t
*http
) _CUPS_API_1_6
;
468 extern int httpReconnect2(http_t
*http
, int msec
, int *cancel
)
478 # endif /* __cplusplus */
479 #endif /* !_CUPS_HTTP_H_ */
482 * End of "$Id: http.h 7026 2007-10-19 00:57:45Z mike $".