2 * "$Id: http.h 6188 2007-01-10 16:23:06Z mike $"
4 * Hyper-Text Transport Protocol definitions for the Common UNIX Printing
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
9 * These coded instructions, statements, and computer programs are the
10 * property of Easy Software Products and are protected by Federal
11 * copyright law. Distribution and use rights are outlined in the file
12 * "LICENSE.txt" which should have been included with this file. If this
13 * file is missing or damaged please contact Easy Software Products
16 * Attn: CUPS Licensing Information
17 * Easy Software Products
18 * 44141 Airport View Drive, Suite 204
19 * Hollywood, Maryland 20636 USA
21 * Voice: (301) 373-9600
22 * EMail: cups-info@cups.org
23 * WWW: http://www.cups.org
25 * This file is subject to the Apple OS-Developed Software exception.
29 # define _CUPS_HTTP_H_
32 * Include necessary headers...
37 # include <sys/types.h>
39 # ifndef __CUPS_SSIZE_T_DEFINED
40 # define __CUPS_SSIZE_T_DEFINED
41 /* Windows does not support the ssize_t type, so map it to off_t... */
42 typedef off_t ssize_t
; /* @private@ */
43 # endif /* !__CUPS_SSIZE_T_DEFINED */
44 # include <winsock2.h>
45 # include <ws2tcpip.h>
48 # define INET6 /* IRIX IPv6 support... */
51 # include <sys/time.h>
52 # include <sys/socket.h>
54 # include <netinet/in.h>
55 # include <arpa/inet.h>
56 # include <netinet/in_systm.h>
57 # include <netinet/ip.h>
58 # if !defined(__APPLE__) || !defined(TCP_NODELAY)
59 # include <netinet/tcp.h>
60 # endif /* !__APPLE__ || !TCP_NODELAY */
61 # if defined(AF_UNIX) && !defined(AF_LOCAL)
62 # define AF_LOCAL AF_UNIX /* Older UNIX's have old names... */
63 # endif /* AF_UNIX && !AF_LOCAL */
66 # endif /* AF_LOCAL */
72 * With GCC 3.0 and higher, we can mark old APIs "deprecated" so you get
73 * a warning at compile-time.
76 # if defined(__GNUC__) && __GNUC__ > 2
77 # define _HTTP_DEPRECATED __attribute__ ((__deprecated__))
79 # define _HTTP_DEPRECATED
80 # endif /* __GNUC__ && __GNUC__ > 2 */
89 # endif /* __cplusplus */
93 * Oh, the wonderful world of IPv6 compatibility. Apparently some
94 * implementations expose the (more logical) 32-bit address parts
95 * to everyone, while others only expose it to kernel code... To
96 * make supporting IPv6 even easier, each vendor chose different
97 * core structure and union names, so the same defines or code
98 * can't be used on all platforms.
100 * The following will likely need tweaking on new platforms that
101 * support IPv6 - the "s6_addr32" define maps to the 32-bit integer
102 * array in the in6_addr union, which is named differently on various
106 #if defined(AF_INET6) && !defined(s6_addr32)
108 # define s6_addr32 _S6_un._S6_u32
109 # elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__)
110 # define s6_addr32 __u6_addr.__u6_addr32
111 # elif defined(__osf__)
112 # define s6_addr32 s6_un.sa6_laddr
113 # elif defined(WIN32)
115 * Windows only defines byte and 16-bit word members of the union and
116 * requires special casing of all raw address code...
118 # define s6_addr32 error_need_win32_specific_code
120 #endif /* AF_INET6 && !s6_addr32 */
127 # define HTTP_MAX_URI 1024 /* Max length of URI string */
128 # define HTTP_MAX_HOST 256 /* Max length of hostname string */
129 # define HTTP_MAX_BUFFER 2048 /* Max length of data buffer */
130 # define HTTP_MAX_VALUE 256 /* Max header field value length */
134 * Types and structures...
137 typedef enum http_auth_e
/**** HTTP authentication types ****/
139 HTTP_AUTH_NONE
, /* No authentication in use */
140 HTTP_AUTH_BASIC
, /* Basic authentication in use */
141 HTTP_AUTH_MD5
, /* Digest authentication in use */
142 HTTP_AUTH_MD5_SESS
, /* MD5-session authentication in use */
143 HTTP_AUTH_MD5_INT
, /* Digest authentication in use for body */
144 HTTP_AUTH_MD5_SESS_INT
/* MD5-session authentication in use for body */
147 typedef enum http_encoding_e
/**** HTTP transfer encoding values ****/
149 HTTP_ENCODE_LENGTH
, /* Data is sent with Content-Length */
150 HTTP_ENCODE_CHUNKED
, /* Data is chunked */
151 HTTP_ENCODE_FIELDS
/* Sending HTTP fields */
154 typedef enum http_encryption_e
/**** HTTP encryption values ****/
156 HTTP_ENCRYPT_IF_REQUESTED
, /* Encrypt if requested (TLS upgrade) */
157 HTTP_ENCRYPT_NEVER
, /* Never encrypt */
158 HTTP_ENCRYPT_REQUIRED
, /* Encryption is required (TLS upgrade) */
159 HTTP_ENCRYPT_ALWAYS
/* Always encrypt (SSL) */
162 typedef enum http_field_e
/**** HTTP field names ****/
164 HTTP_FIELD_UNKNOWN
= -1, /* Unknown field */
165 HTTP_FIELD_ACCEPT_LANGUAGE
, /* Accept-Language field */
166 HTTP_FIELD_ACCEPT_RANGES
, /* Accept-Ranges field */
167 HTTP_FIELD_AUTHORIZATION
, /* Authorization field */
168 HTTP_FIELD_CONNECTION
, /* Connection field */
169 HTTP_FIELD_CONTENT_ENCODING
, /* Content-Encoding field */
170 HTTP_FIELD_CONTENT_LANGUAGE
, /* Content-Language field */
171 HTTP_FIELD_CONTENT_LENGTH
, /* Content-Length field */
172 HTTP_FIELD_CONTENT_LOCATION
, /* Content-Location field */
173 HTTP_FIELD_CONTENT_MD5
, /* Content-MD5 field */
174 HTTP_FIELD_CONTENT_RANGE
, /* Content-Range field */
175 HTTP_FIELD_CONTENT_TYPE
, /* Content-Type field */
176 HTTP_FIELD_CONTENT_VERSION
, /* Content-Version field */
177 HTTP_FIELD_DATE
, /* Date field */
178 HTTP_FIELD_HOST
, /* Host field */
179 HTTP_FIELD_IF_MODIFIED_SINCE
, /* If-Modified-Since field */
180 HTTP_FIELD_IF_UNMODIFIED_SINCE
, /* If-Unmodified-Since field */
181 HTTP_FIELD_KEEP_ALIVE
, /* Keep-Alive field */
182 HTTP_FIELD_LAST_MODIFIED
, /* Last-Modified field */
183 HTTP_FIELD_LINK
, /* Link field */
184 HTTP_FIELD_LOCATION
, /* Location field */
185 HTTP_FIELD_RANGE
, /* Range field */
186 HTTP_FIELD_REFERER
, /* Referer field */
187 HTTP_FIELD_RETRY_AFTER
, /* Retry-After field */
188 HTTP_FIELD_TRANSFER_ENCODING
, /* Transfer-Encoding field */
189 HTTP_FIELD_UPGRADE
, /* Upgrade field */
190 HTTP_FIELD_USER_AGENT
, /* User-Agent field */
191 HTTP_FIELD_WWW_AUTHENTICATE
, /* WWW-Authenticate field */
192 HTTP_FIELD_MAX
/* Maximum field index */
195 typedef enum http_keepalive_e
/**** HTTP keep-alive values ****/
197 HTTP_KEEPALIVE_OFF
= 0, /* No keep alive support */
198 HTTP_KEEPALIVE_ON
/* Use keep alive */
201 typedef enum http_state_e
/**** HTTP state values; states
202 **** are server-oriented...
205 HTTP_WAITING
, /* Waiting for command */
206 HTTP_OPTIONS
, /* OPTIONS command, waiting for blank line */
207 HTTP_GET
, /* GET command, waiting for blank line */
208 HTTP_GET_SEND
, /* GET command, sending data */
209 HTTP_HEAD
, /* HEAD command, waiting for blank line */
210 HTTP_POST
, /* POST command, waiting for blank line */
211 HTTP_POST_RECV
, /* POST command, receiving data */
212 HTTP_POST_SEND
, /* POST command, sending data */
213 HTTP_PUT
, /* PUT command, waiting for blank line */
214 HTTP_PUT_RECV
, /* PUT command, receiving data */
215 HTTP_DELETE
, /* DELETE command, waiting for blank line */
216 HTTP_TRACE
, /* TRACE command, waiting for blank line */
217 HTTP_CLOSE
, /* CLOSE command, waiting for blank line */
218 HTTP_STATUS
/* Command complete, sending status */
221 typedef enum http_status_e
/**** HTTP status codes ****/
223 HTTP_ERROR
= -1, /* An error response from httpXxxx() */
225 HTTP_CONTINUE
= 100, /* Everything OK, keep going... */
226 HTTP_SWITCHING_PROTOCOLS
, /* HTTP upgrade to TLS/SSL */
228 HTTP_OK
= 200, /* OPTIONS/GET/HEAD/POST/TRACE command was successful */
229 HTTP_CREATED
, /* PUT command was successful */
230 HTTP_ACCEPTED
, /* DELETE command was successful */
231 HTTP_NOT_AUTHORITATIVE
, /* Information isn't authoritative */
232 HTTP_NO_CONTENT
, /* Successful command, no new data */
233 HTTP_RESET_CONTENT
, /* Content was reset/recreated */
234 HTTP_PARTIAL_CONTENT
, /* Only a partial file was recieved/sent */
236 HTTP_MULTIPLE_CHOICES
= 300, /* Multiple files match request */
237 HTTP_MOVED_PERMANENTLY
, /* Document has moved permanently */
238 HTTP_MOVED_TEMPORARILY
, /* Document has moved temporarily */
239 HTTP_SEE_OTHER
, /* See this other link... */
240 HTTP_NOT_MODIFIED
, /* File not modified */
241 HTTP_USE_PROXY
, /* Must use a proxy to access this URI */
243 HTTP_BAD_REQUEST
= 400, /* Bad request */
244 HTTP_UNAUTHORIZED
, /* Unauthorized to access host */
245 HTTP_PAYMENT_REQUIRED
, /* Payment required */
246 HTTP_FORBIDDEN
, /* Forbidden to access this URI */
247 HTTP_NOT_FOUND
, /* URI was not found */
248 HTTP_METHOD_NOT_ALLOWED
, /* Method is not allowed */
249 HTTP_NOT_ACCEPTABLE
, /* Not Acceptable */
250 HTTP_PROXY_AUTHENTICATION
, /* Proxy Authentication is Required */
251 HTTP_REQUEST_TIMEOUT
, /* Request timed out */
252 HTTP_CONFLICT
, /* Request is self-conflicting */
253 HTTP_GONE
, /* Server has gone away */
254 HTTP_LENGTH_REQUIRED
, /* A content length or encoding is required */
255 HTTP_PRECONDITION
, /* Precondition failed */
256 HTTP_REQUEST_TOO_LARGE
, /* Request entity too large */
257 HTTP_URI_TOO_LONG
, /* URI too long */
258 HTTP_UNSUPPORTED_MEDIATYPE
, /* The requested media type is unsupported */
259 HTTP_REQUESTED_RANGE
, /* The requested range is not satisfiable */
260 HTTP_EXPECTATION_FAILED
, /* The expectation given in an Expect header field was not met */
261 HTTP_UPGRADE_REQUIRED
= 426, /* Upgrade to SSL/TLS required */
263 HTTP_SERVER_ERROR
= 500, /* Internal server error */
264 HTTP_NOT_IMPLEMENTED
, /* Feature not implemented */
265 HTTP_BAD_GATEWAY
, /* Bad gateway */
266 HTTP_SERVICE_UNAVAILABLE
, /* Service is unavailable */
267 HTTP_GATEWAY_TIMEOUT
, /* Gateway connection timed out */
268 HTTP_NOT_SUPPORTED
/* HTTP version not supported */
271 typedef enum http_uri_status_e
/**** URI separation status @since CUPS1.2@ ****/
273 HTTP_URI_OVERFLOW
= -8, /* URI buffer for httpAssembleURI is too small */
274 HTTP_URI_BAD_ARGUMENTS
= -7, /* Bad arguments to function (error) */
275 HTTP_URI_BAD_RESOURCE
= -6, /* Bad resource in URI (error) */
276 HTTP_URI_BAD_PORT
= -5, /* Bad port number in URI (error) */
277 HTTP_URI_BAD_HOSTNAME
= -4, /* Bad hostname in URI (error) */
278 HTTP_URI_BAD_USERNAME
= -3, /* Bad username in URI (error) */
279 HTTP_URI_BAD_SCHEME
= -2, /* Bad scheme in URI (error) */
280 HTTP_URI_BAD_URI
= -1, /* Bad/empty URI (error) */
281 HTTP_URI_OK
= 0, /* URI decoded OK */
282 HTTP_URI_MISSING_SCHEME
, /* Missing scheme in URI (warning) */
283 HTTP_URI_UNKNOWN_SCHEME
, /* Unknown scheme in URI (warning) */
284 HTTP_URI_MISSING_RESOURCE
/* Missing resource in URI (warning) */
287 typedef enum http_uri_coding_e
/**** URI en/decode flags ****/
289 HTTP_URI_CODING_NONE
= 0, /* Don't en/decode anything */
290 HTTP_URI_CODING_USERNAME
= 1, /* En/decode the username portion */
291 HTTP_URI_CODING_HOSTNAME
= 2, /* En/decode the hostname portion */
292 HTTP_URI_CODING_RESOURCE
= 4, /* En/decode the resource portion */
293 HTTP_URI_CODING_MOST
= 7, /* En/decode all but the query */
294 HTTP_URI_CODING_QUERY
= 8, /* En/decode the query portion */
295 HTTP_URI_CODING_ALL
= 15 /* En/decode everything */
298 typedef enum http_version_e
/**** HTTP version numbers ****/
300 HTTP_0_9
= 9, /* HTTP/0.9 */
301 HTTP_1_0
= 100, /* HTTP/1.0 */
302 HTTP_1_1
= 101 /* HTTP/1.1 */
305 typedef union _http_addr_u
/**** Socket address union, which
306 **** makes using IPv6 and other
307 **** address types easier and
308 **** more portable. @since CUPS 1.2@
311 struct sockaddr addr
; /* Base structure for family value */
312 struct sockaddr_in ipv4
; /* IPv4 address */
314 struct sockaddr_in6 ipv6
; /* IPv6 address */
315 #endif /* AF_INET6 */
317 struct sockaddr_un un
; /* Domain socket file */
318 #endif /* AF_LOCAL */
319 char pad
[256]; /* Padding to ensure binary compatibility */
322 typedef struct http_addrlist_s
/**** Socket address list, which is
323 **** used to enumerate all of the
324 **** addresses that are associated
325 **** with a hostname. @since CUPS 1.2@
328 struct http_addrlist_s
*next
; /* Pointer to next address in list */
329 http_addr_t addr
; /* Address */
332 typedef struct _http_s
/**** HTTP connection structure. ****/
335 * DO NOT ACCESS MEMBERS OF THIS STRUCTURE DIRECTLY; INSTEAD, USE THE
336 * PROVIDED APIS FOR ACCESSING THE VALUES INSTEAD.
338 * This structure definition will be removed from the public headers in
342 int fd
; /* File descriptor for this socket */
343 int blocking
; /* To block or not to block */
344 int error
; /* Last error on read */
345 time_t activity
; /* Time since last read/write */
346 http_state_t state
; /* State of client */
347 http_status_t status
; /* Status of last request */
348 http_version_t version
; /* Protocol version */
349 http_keepalive_t keep_alive
; /* Keep-alive supported? */
350 struct sockaddr_in _hostaddr
; /* Address of connected host @deprecated@ */
351 char hostname
[HTTP_MAX_HOST
],
352 /* Name of connected host */
353 fields
[HTTP_FIELD_MAX
][HTTP_MAX_VALUE
];
355 char *data
; /* Pointer to data buffer */
356 http_encoding_t data_encoding
; /* Chunked or not */
357 int _data_remaining
;/* Number of bytes left @deprecated@ */
358 int used
; /* Number of bytes used in buffer */
359 char buffer
[HTTP_MAX_BUFFER
];
360 /* Buffer for incoming data */
361 int auth_type
; /* Authentication in use */
362 _cups_md5_state_t md5_state
; /* MD5 state */
363 char nonce
[HTTP_MAX_VALUE
];
365 int nonce_count
; /* Nonce count */
366 void *tls
; /* TLS state information */
367 http_encryption_t encryption
; /* Encryption requirements */
368 /**** New in CUPS 1.1.19 ****/
369 fd_set
*input_set
; /* select() set for httpWait() @since CUPS 1.1.19@ */
370 http_status_t expect
; /* Expect: header @since CUPS 1.1.19@ */
371 char *cookie
; /* Cookie value(s) @since CUPS 1.1.19@ */
372 /**** New in CUPS 1.1.20 ****/
373 char authstring
[HTTP_MAX_VALUE
],
374 /* Current Authentication value @since CUPS 1.1.20@ */
375 userpass
[HTTP_MAX_VALUE
];
376 /* Username:password string @since CUPS 1.1.20@ */
377 int digest_tries
; /* Number of tries for digest auth @since CUPS 1.1.20@ */
378 /**** New in CUPS 1.2 ****/
379 off_t data_remaining
; /* Number of bytes left @since CUPS 1.2@ */
380 http_addr_t
*hostaddr
; /* Current host address and port @since CUPS 1.2@ */
381 http_addrlist_t
*addrlist
; /* List of valid addresses @since CUPS 1.2@ */
382 char wbuffer
[HTTP_MAX_BUFFER
];
383 /* Buffer for outgoing data */
384 int wused
; /* Write buffer bytes used @since CUPS 1.2@ */
392 extern void httpBlocking(http_t
*http
, int b
);
393 extern int httpCheck(http_t
*http
);
394 extern void httpClearFields(http_t
*http
);
395 extern void httpClose(http_t
*http
);
396 extern http_t
*httpConnect(const char *host
, int port
);
397 extern http_t
*httpConnectEncrypt(const char *host
, int port
,
398 http_encryption_t encryption
);
399 extern int httpDelete(http_t
*http
, const char *uri
);
400 extern int httpEncryption(http_t
*http
, http_encryption_t e
);
401 extern int httpError(http_t
*http
);
402 extern void httpFlush(http_t
*http
);
403 extern int httpGet(http_t
*http
, const char *uri
);
404 extern char *httpGets(char *line
, int length
, http_t
*http
);
405 extern const char *httpGetDateString(time_t t
);
406 extern time_t httpGetDateTime(const char *s
);
407 extern const char *httpGetField(http_t
*http
, http_field_t field
);
408 extern struct hostent
*httpGetHostByName(const char *name
);
409 extern char *httpGetSubField(http_t
*http
, http_field_t field
,
410 const char *name
, char *value
);
411 extern int httpHead(http_t
*http
, const char *uri
);
412 extern void httpInitialize(void);
413 extern int httpOptions(http_t
*http
, const char *uri
);
414 extern int httpPost(http_t
*http
, const char *uri
);
415 extern int httpPrintf(http_t
*http
, const char *format
, ...)
417 __attribute__ ((__format__ (__printf__
, 2, 3)))
418 # endif /* __GNUC__ */
420 extern int httpPut(http_t
*http
, const char *uri
);
421 extern int httpRead(http_t
*http
, char *buffer
, int length
) _HTTP_DEPRECATED
;
422 extern int httpReconnect(http_t
*http
);
423 extern void httpSeparate(const char *uri
, char *method
,
424 char *username
, char *host
, int *port
,
425 char *resource
) _HTTP_DEPRECATED
;
426 extern void httpSetField(http_t
*http
, http_field_t field
,
428 extern const char *httpStatus(http_status_t status
);
429 extern int httpTrace(http_t
*http
, const char *uri
);
430 extern http_status_t
httpUpdate(http_t
*http
);
431 extern int httpWrite(http_t
*http
, const char *buffer
, int length
) _HTTP_DEPRECATED
;
432 extern char *httpEncode64(char *out
, const char *in
) _HTTP_DEPRECATED
;
433 extern char *httpDecode64(char *out
, const char *in
) _HTTP_DEPRECATED
;
434 extern int httpGetLength(http_t
*http
) _HTTP_DEPRECATED
;
435 extern char *httpMD5(const char *, const char *, const char *,
437 extern char *httpMD5Final(const char *, const char *, const char *,
439 extern char *httpMD5String(const unsigned char *, char [33]);
441 /**** New in CUPS 1.1.19 ****/
442 extern void httpClearCookie(http_t
*http
);
443 extern const char *httpGetCookie(http_t
*http
);
444 extern void httpSetCookie(http_t
*http
, const char *cookie
);
445 extern int httpWait(http_t
*http
, int msec
);
447 /**** New in CUPS 1.1.21 ****/
448 extern char *httpDecode64_2(char *out
, int *outlen
, const char *in
);
449 extern char *httpEncode64_2(char *out
, int outlen
, const char *in
,
451 extern void httpSeparate2(const char *uri
,
452 char *method
, int methodlen
,
453 char *username
, int usernamelen
,
454 char *host
, int hostlen
, int *port
,
455 char *resource
, int resourcelen
) _HTTP_DEPRECATED
;
457 /**** New in CUPS 1.2 ****/
458 extern int httpAddrAny(const http_addr_t
*addr
);
459 extern http_addrlist_t
*httpAddrConnect(http_addrlist_t
*addrlist
, int *sock
);
460 extern int httpAddrEqual(const http_addr_t
*addr1
,
461 const http_addr_t
*addr2
);
462 extern void httpAddrFreeList(http_addrlist_t
*addrlist
);
463 extern http_addrlist_t
*httpAddrGetList(const char *hostname
, int family
,
464 const char *service
);
465 extern int httpAddrLength(const http_addr_t
*addr
);
466 extern int httpAddrLocalhost(const http_addr_t
*addr
);
467 extern char *httpAddrLookup(const http_addr_t
*addr
,
468 char *name
, int namelen
);
469 extern char *httpAddrString(const http_addr_t
*addr
,
471 extern http_uri_status_t
httpAssembleURI(http_uri_coding_t encoding
,
472 char *uri
, int urilen
,
474 const char *username
,
475 const char *host
, int port
,
476 const char *resource
);
477 extern http_uri_status_t
httpAssembleURIf(http_uri_coding_t encoding
,
478 char *uri
, int urilen
,
480 const char *username
,
481 const char *host
, int port
,
482 const char *resourcef
, ...);
483 extern int httpFlushWrite(http_t
*http
);
484 extern int httpGetBlocking(http_t
*http
);
485 extern const char *httpGetDateString2(time_t t
, char *s
, int slen
);
486 extern int httpGetFd(http_t
*http
);
487 extern const char *httpGetHostname(http_t
*http
, char *s
, int slen
);
488 extern off_t
httpGetLength2(http_t
*http
);
489 extern http_status_t
httpGetStatus(http_t
*http
);
490 extern char *httpGetSubField2(http_t
*http
, http_field_t field
,
491 const char *name
, char *value
,
493 extern ssize_t
httpRead2(http_t
*http
, char *buffer
, size_t length
);
494 extern http_uri_status_t
httpSeparateURI(http_uri_coding_t decoding
,
496 char *scheme
, int schemelen
,
497 char *username
, int usernamelen
,
498 char *host
, int hostlen
, int *port
,
499 char *resource
, int resourcelen
);
500 extern void httpSetExpect(http_t
*http
, http_status_t expect
);
501 extern void httpSetLength(http_t
*http
, size_t length
);
502 extern ssize_t
httpWrite2(http_t
*http
, const char *buffer
,
512 # endif /* __cplusplus */
513 #endif /* !_CUPS_HTTP_H_ */
516 * End of "$Id: http.h 6188 2007-01-10 16:23:06Z mike $".