2 * "$Id: http.h 181 2006-06-22 20:01:18Z jlovell $"
4 * Hyper-Text Transport Protocol definitions for the Common UNIX Printing
7 * Copyright 1997-2006 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 # include <winsock2.h>
40 # include <ws2tcpip.h>
42 # ifdef __sgi /* IRIX needs this for IPv6 support!?! */
46 # include <sys/time.h>
47 # include <sys/socket.h>
49 # include <netinet/in.h>
50 # include <arpa/inet.h>
51 # include <netinet/in_systm.h>
52 # include <netinet/ip.h>
53 # if !defined(__APPLE__) || !defined(TCP_NODELAY)
54 # include <netinet/tcp.h>
55 # endif /* !__APPLE__ || !TCP_NODELAY */
58 # endif /* AF_LOCAL */
64 * With GCC 3.0 and higher, we can mark old APIs "deprecated" so you get
65 * a warning at compile-time.
68 # if defined(__GNUC__) && __GNUC__ > 2
69 # define _HTTP_DEPRECATED __attribute__ ((__deprecated__))
71 # define _HTTP_DEPRECATED
72 # endif /* __GNUC__ && __GNUC__ > 2 */
81 # endif /* __cplusplus */
85 * Oh, the wonderful world of IPv6 compatibility. Apparently some
86 * implementations expose the (more logical) 32-bit address parts
87 * to everyone, while others only expose it to kernel code... To
88 * make supporting IPv6 even easier, each vendor chose different
89 * core structure and union names, so the same defines or code
90 * can't be used on all platforms.
92 * The following will likely need tweaking on new platforms that
93 * support IPv6 - the "s6_addr32" define maps to the 32-bit integer
94 * array in the in6_addr union, which is named differently on various
98 #if defined(AF_INET6) && !defined(s6_addr32)
100 # define s6_addr32 _S6_un._S6_u32
101 # elif defined(__FreeBSD__) || defined(__APPLE__)
102 # define s6_addr32 __u6_addr.__u6_addr32
103 # elif defined(__osf__)
104 # define s6_addr32 s6_un.sa6_laddr
105 # elif defined(WIN32)
107 * Windows only defines byte and 16-bit word members of the union and
108 * requires special casing of all raw address code...
110 # define s6_addr32 error_need_win32_specific_code
112 #endif /* AF_INET6 && !s6_addr32 */
119 # define HTTP_MAX_URI 1024 /* Max length of URI string */
120 # define HTTP_MAX_HOST 256 /* Max length of hostname string */
121 # define HTTP_MAX_BUFFER 2048 /* Max length of data buffer */
122 # define HTTP_MAX_VALUE 256 /* Max header field value length */
126 * Types and structures...
129 typedef enum http_auth_e
/**** HTTP authentication types ****/
131 HTTP_AUTH_NONE
, /* No authentication in use */
132 HTTP_AUTH_BASIC
, /* Basic authentication in use */
133 HTTP_AUTH_MD5
, /* Digest authentication in use */
134 HTTP_AUTH_MD5_SESS
, /* MD5-session authentication in use */
135 HTTP_AUTH_MD5_INT
, /* Digest authentication in use for body */
136 HTTP_AUTH_MD5_SESS_INT
/* MD5-session authentication in use for body */
139 typedef enum http_encoding_e
/**** HTTP transfer encoding values ****/
141 HTTP_ENCODE_LENGTH
, /* Data is sent with Content-Length */
142 HTTP_ENCODE_CHUNKED
/* Data is chunked */
145 typedef enum http_encryption_e
/**** HTTP encryption values ****/
147 HTTP_ENCRYPT_IF_REQUESTED
, /* Encrypt if requested (TLS upgrade) */
148 HTTP_ENCRYPT_NEVER
, /* Never encrypt */
149 HTTP_ENCRYPT_REQUIRED
, /* Encryption is required (TLS upgrade) */
150 HTTP_ENCRYPT_ALWAYS
/* Always encrypt (SSL) */
153 typedef enum http_field_e
/**** HTTP field names ****/
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 */
183 HTTP_FIELD_MAX
/* Maximum field index */
186 typedef enum http_keepalive_e
/**** HTTP keep-alive values ****/
188 HTTP_KEEPALIVE_OFF
= 0, /* No keep alive support */
189 HTTP_KEEPALIVE_ON
/* Use keep alive */
192 typedef enum http_state_e
/**** HTTP state values; states
193 **** are server-oriented...
196 HTTP_WAITING
, /* Waiting for command */
197 HTTP_OPTIONS
, /* OPTIONS command, waiting for blank line */
198 HTTP_GET
, /* GET command, waiting for blank line */
199 HTTP_GET_SEND
, /* GET command, sending data */
200 HTTP_HEAD
, /* HEAD command, waiting for blank line */
201 HTTP_POST
, /* POST command, waiting for blank line */
202 HTTP_POST_RECV
, /* POST command, receiving data */
203 HTTP_POST_SEND
, /* POST command, sending data */
204 HTTP_PUT
, /* PUT command, waiting for blank line */
205 HTTP_PUT_RECV
, /* PUT command, receiving data */
206 HTTP_DELETE
, /* DELETE command, waiting for blank line */
207 HTTP_TRACE
, /* TRACE command, waiting for blank line */
208 HTTP_CLOSE
, /* CLOSE command, waiting for blank line */
209 HTTP_STATUS
/* Command complete, sending status */
212 typedef enum http_status_e
/**** HTTP status codes ****/
214 HTTP_ERROR
= -1, /* An error response from httpXxxx() */
216 HTTP_CONTINUE
= 100, /* Everything OK, keep going... */
217 HTTP_SWITCHING_PROTOCOLS
, /* HTTP upgrade to TLS/SSL */
219 HTTP_OK
= 200, /* OPTIONS/GET/HEAD/POST/TRACE command was successful */
220 HTTP_CREATED
, /* PUT command was successful */
221 HTTP_ACCEPTED
, /* DELETE command was successful */
222 HTTP_NOT_AUTHORITATIVE
, /* Information isn't authoritative */
223 HTTP_NO_CONTENT
, /* Successful command, no new data */
224 HTTP_RESET_CONTENT
, /* Content was reset/recreated */
225 HTTP_PARTIAL_CONTENT
, /* Only a partial file was recieved/sent */
227 HTTP_MULTIPLE_CHOICES
= 300, /* Multiple files match request */
228 HTTP_MOVED_PERMANENTLY
, /* Document has moved permanently */
229 HTTP_MOVED_TEMPORARILY
, /* Document has moved temporarily */
230 HTTP_SEE_OTHER
, /* See this other link... */
231 HTTP_NOT_MODIFIED
, /* File not modified */
232 HTTP_USE_PROXY
, /* Must use a proxy to access this URI */
234 HTTP_BAD_REQUEST
= 400, /* Bad request */
235 HTTP_UNAUTHORIZED
, /* Unauthorized to access host */
236 HTTP_PAYMENT_REQUIRED
, /* Payment required */
237 HTTP_FORBIDDEN
, /* Forbidden to access this URI */
238 HTTP_NOT_FOUND
, /* URI was not found */
239 HTTP_METHOD_NOT_ALLOWED
, /* Method is not allowed */
240 HTTP_NOT_ACCEPTABLE
, /* Not Acceptable */
241 HTTP_PROXY_AUTHENTICATION
, /* Proxy Authentication is Required */
242 HTTP_REQUEST_TIMEOUT
, /* Request timed out */
243 HTTP_CONFLICT
, /* Request is self-conflicting */
244 HTTP_GONE
, /* Server has gone away */
245 HTTP_LENGTH_REQUIRED
, /* A content length or encoding is required */
246 HTTP_PRECONDITION
, /* Precondition failed */
247 HTTP_REQUEST_TOO_LARGE
, /* Request entity too large */
248 HTTP_URI_TOO_LONG
, /* URI too long */
249 HTTP_UNSUPPORTED_MEDIATYPE
, /* The requested media type is unsupported */
250 HTTP_REQUESTED_RANGE
, /* The requested range is not satisfiable */
251 HTTP_EXPECTATION_FAILED
, /* The expectation given in an Expect header field was not met */
252 HTTP_UPGRADE_REQUIRED
= 426, /* Upgrade to SSL/TLS required */
254 HTTP_SERVER_ERROR
= 500, /* Internal server error */
255 HTTP_NOT_IMPLEMENTED
, /* Feature not implemented */
256 HTTP_BAD_GATEWAY
, /* Bad gateway */
257 HTTP_SERVICE_UNAVAILABLE
, /* Service is unavailable */
258 HTTP_GATEWAY_TIMEOUT
, /* Gateway connection timed out */
259 HTTP_NOT_SUPPORTED
/* HTTP version not supported */
262 typedef enum http_uri_status_e
/**** URI separation status @since CUPS1.2@ ****/
264 HTTP_URI_OVERFLOW
= -8, /* URI buffer for httpAssembleURI is too small */
265 HTTP_URI_BAD_ARGUMENTS
= -7, /* Bad arguments to function (error) */
266 HTTP_URI_BAD_RESOURCE
= -6, /* Bad resource in URI (error) */
267 HTTP_URI_BAD_PORT
= -5, /* Bad port number in URI (error) */
268 HTTP_URI_BAD_HOSTNAME
= -4, /* Bad hostname in URI (error) */
269 HTTP_URI_BAD_USERNAME
= -3, /* Bad username in URI (error) */
270 HTTP_URI_BAD_SCHEME
= -2, /* Bad scheme in URI (error) */
271 HTTP_URI_BAD_URI
= -1, /* Bad/empty URI (error) */
272 HTTP_URI_OK
= 0, /* URI decoded OK */
273 HTTP_URI_MISSING_SCHEME
, /* Missing scheme in URI (warning) */
274 HTTP_URI_UNKNOWN_SCHEME
, /* Unknown scheme in URI (warning) */
275 HTTP_URI_MISSING_RESOURCE
/* Missing resource in URI (warning) */
278 typedef enum http_uri_coding_e
/**** URI en/decode flags ****/
280 HTTP_URI_CODING_NONE
= 0, /* Don't en/decode anything */
281 HTTP_URI_CODING_USERNAME
= 1, /* En/decode the username portion */
282 HTTP_URI_CODING_HOSTNAME
= 2, /* En/decode the hostname portion */
283 HTTP_URI_CODING_RESOURCE
= 4, /* En/decode the resource portion */
284 HTTP_URI_CODING_MOST
= 7, /* En/decode all but the query */
285 HTTP_URI_CODING_QUERY
= 8, /* En/decode the query portion */
286 HTTP_URI_CODING_ALL
= 15 /* En/decode everything */
289 typedef enum http_version_e
/**** HTTP version numbers ****/
291 HTTP_0_9
= 9, /* HTTP/0.9 */
292 HTTP_1_0
= 100, /* HTTP/1.0 */
293 HTTP_1_1
= 101 /* HTTP/1.1 */
296 typedef union _http_addr_u
/**** Socket address union, which
297 **** makes using IPv6 and other
298 **** address types easier and
299 **** more portable. @since CUPS 1.2@
302 struct sockaddr addr
; /* Base structure for family value */
303 struct sockaddr_in ipv4
; /* IPv4 address */
305 struct sockaddr_in6 ipv6
; /* IPv6 address */
306 #endif /* AF_INET6 */
308 struct sockaddr_un un
; /* Domain socket file */
309 #endif /* AF_LOCAL */
310 char pad
[256]; /* Padding to ensure binary compatibility */
313 typedef struct http_addrlist_s
/**** Socket address list, which is
314 **** used to enumerate all of the
315 **** addresses that are associated
316 **** with a hostname. @since CUPS 1.2@
319 struct http_addrlist_s
*next
; /* Pointer to next address in list */
320 http_addr_t addr
; /* Address */
323 typedef struct _http_s http_t
; /**** HTTP connection type ****/
330 extern void httpBlocking(http_t
*http
, int b
);
331 extern int httpCheck(http_t
*http
);
332 extern void httpClearFields(http_t
*http
);
333 extern void httpClose(http_t
*http
);
334 extern http_t
*httpConnect(const char *host
, int port
);
335 extern http_t
*httpConnectEncrypt(const char *host
, int port
,
336 http_encryption_t encryption
);
337 extern int httpDelete(http_t
*http
, const char *uri
);
338 extern int httpEncryption(http_t
*http
, http_encryption_t e
);
339 extern int httpError(http_t
*http
);
340 extern void httpFlush(http_t
*http
);
341 extern int httpGet(http_t
*http
, const char *uri
);
342 extern char *httpGets(char *line
, int length
, http_t
*http
);
343 extern const char *httpGetDateString(time_t t
);
344 extern time_t httpGetDateTime(const char *s
);
345 extern const char *httpGetField(http_t
*http
, http_field_t field
);
346 extern struct hostent
*httpGetHostByName(const char *name
);
347 extern char *httpGetSubField(http_t
*http
, http_field_t field
,
348 const char *name
, char *value
);
349 extern int httpHead(http_t
*http
, const char *uri
);
350 extern void httpInitialize(void);
351 extern int httpOptions(http_t
*http
, const char *uri
);
352 extern int httpPost(http_t
*http
, const char *uri
);
353 extern int httpPrintf(http_t
*http
, const char *format
, ...)
355 __attribute__ ((__format__ (__printf__
, 2, 3)))
356 # endif /* __GNUC__ */
358 extern int httpPut(http_t
*http
, const char *uri
);
359 extern int httpRead(http_t
*http
, char *buffer
, int length
) _HTTP_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
) _HTTP_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
) _HTTP_DEPRECATED
;
370 extern char *httpEncode64(char *out
, const char *in
) _HTTP_DEPRECATED
;
371 extern char *httpDecode64(char *out
, const char *in
) _HTTP_DEPRECATED
;
372 extern int httpGetLength(http_t
*http
) _HTTP_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
);
381 extern const char *httpGetCookie(http_t
*http
);
382 extern void httpSetCookie(http_t
*http
, const char *cookie
);
383 extern int httpWait(http_t
*http
, int msec
);
385 /**** New in CUPS 1.1.21 ****/
386 extern char *httpDecode64_2(char *out
, int *outlen
, const char *in
);
387 extern char *httpEncode64_2(char *out
, int outlen
, const char *in
,
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
) _HTTP_DEPRECATED
;
395 /**** New in CUPS 1.2 ****/
396 extern int httpAddrAny(const http_addr_t
*addr
);
397 extern http_addrlist_t
*httpAddrConnect(http_addrlist_t
*addrlist
, int *sock
);
398 extern int httpAddrEqual(const http_addr_t
*addr1
,
399 const http_addr_t
*addr2
);
400 extern void httpAddrFreeList(http_addrlist_t
*addrlist
);
401 extern http_addrlist_t
*httpAddrGetList(const char *hostname
, int family
,
402 const char *service
);
403 extern int httpAddrLength(const http_addr_t
*addr
);
404 extern int httpAddrLocalhost(const http_addr_t
*addr
);
405 extern char *httpAddrLookup(const http_addr_t
*addr
,
406 char *name
, int namelen
);
407 extern char *httpAddrString(const http_addr_t
*addr
,
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
);
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
, ...);
421 extern int httpFlushWrite(http_t
*http
);
422 extern int httpGetBlocking(http_t
*http
);
423 extern const char *httpGetDateString2(time_t t
, char *s
, int slen
);
424 extern int httpGetFd(http_t
*http
);
425 extern const char *httpGetHostname(http_t
*http
, char *s
, int slen
);
426 extern off_t
httpGetLength2(http_t
*http
);
427 extern http_status_t
httpGetStatus(http_t
*http
);
428 extern char *httpGetSubField2(http_t
*http
, http_field_t field
,
429 const char *name
, char *value
,
431 extern ssize_t
httpRead2(http_t
*http
, char *buffer
, size_t length
);
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
);
438 extern void httpSetExpect(http_t
*http
, http_status_t expect
);
439 extern void httpSetLength(http_t
*http
, size_t length
);
440 extern ssize_t
httpWrite2(http_t
*http
, const char *buffer
,
450 # endif /* __cplusplus */
451 #endif /* !_CUPS_HTTP_H_ */
454 * End of "$Id: http.h 181 2006-06-22 20:01:18Z jlovell $".