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