]> 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
Fix whitespace issues.
[thirdparty/cups.git] / cups / http.h
CommitLineData
ef416fc2 1/*
996acce8 2 * Hyper-Text Transport Protocol definitions for CUPS.
ef416fc2 3 *
718ee2ff 4 * Copyright 2007-2017 by Apple Inc.
996acce8 5 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
ef416fc2 6 *
e3101897 7 * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
ef416fc2 8 */
9
10#ifndef _CUPS_HTTP_H_
11# define _CUPS_HTTP_H_
12
13/*
14 * Include necessary headers...
15 */
16
2fb76298 17# include "versioning.h"
7cf5915e 18# include "array.h"
ef416fc2 19# include <string.h>
20# include <time.h>
21# include <sys/types.h>
22# ifdef WIN32
b86bc4cf 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... */
26typedef off_t ssize_t; /* @private@ */
27# endif /* !__CUPS_SSIZE_T_DEFINED */
ef416fc2 28# include <winsock2.h>
29# include <ws2tcpip.h>
30# else
31# include <unistd.h>
32# include <sys/time.h>
33# include <sys/socket.h>
34# include <netdb.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 */
d09495fa 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 */
ef416fc2 45# ifdef AF_LOCAL
46# include <sys/un.h>
47# endif /* AF_LOCAL */
bc44d920 48# if defined(LOCAL_PEERCRED) && !defined(SO_PEERCRED)
49# define SO_PEERCRED LOCAL_PEERCRED
50# endif /* LOCAL_PEERCRED && !SO_PEERCRED */
ef416fc2 51# endif /* WIN32 */
52
ef416fc2 53
54/*
55 * C++ magic...
56 */
57
58# ifdef __cplusplus
59extern "C" {
60# endif /* __cplusplus */
61
62
63/*
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.
70 *
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
74 * platforms.
75 */
76
77#if defined(AF_INET6) && !defined(s6_addr32)
78# if defined(__sun)
79# define s6_addr32 _S6_un._S6_u32
0268488e 80# elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__)|| defined(__DragonFly__)
ef416fc2 81# define s6_addr32 __u6_addr.__u6_addr32
82# elif defined(WIN32)
83/*
84 * Windows only defines byte and 16-bit word members of the union and
85 * requires special casing of all raw address code...
86 */
87# define s6_addr32 error_need_win32_specific_code
88# endif /* __sun */
89#endif /* AF_INET6 && !s6_addr32 */
90
91
92/*
93 * Limits...
94 */
95
96# define HTTP_MAX_URI 1024 /* Max length of URI string */
97# define HTTP_MAX_HOST 256 /* Max length of hostname string */
fa73b229 98# define HTTP_MAX_BUFFER 2048 /* Max length of data buffer */
ef416fc2 99# define HTTP_MAX_VALUE 256 /* Max header field value length */
100
101
102/*
103 * Types and structures...
104 */
105
718ee2ff 106typedef enum http_auth_e /**** HTTP authentication types @exclude all@ ****/
ef416fc2 107{
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 */
f7deaa1a 113 HTTP_AUTH_MD5_SESS_INT, /* MD5-session authentication in use for body */
8072030b 114 HTTP_AUTH_NEGOTIATE /* GSSAPI authentication in use @since CUPS 1.3/macOS 10.5@ */
ef416fc2 115} http_auth_t;
116
117typedef enum http_encoding_e /**** HTTP transfer encoding values ****/
118{
a469f8a5
MS		 119 HTTP_ENCODING_LENGTH, /* Data is sent with Content-Length */
120 HTTP_ENCODING_CHUNKED, /* Data is chunked */
121 HTTP_ENCODING_FIELDS /* Sending HTTP fields */
122
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 */
ef416fc2 128} http_encoding_t;
129
130typedef enum http_encryption_e /**** HTTP encryption values ****/
131{
a469f8a5
MS		 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) */
136
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 */
ef416fc2 143} http_encryption_t;
144
145typedef enum http_field_e /**** HTTP field names ****/
146{
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 */
8072030b
MS		 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@ */
ef416fc2 178 HTTP_FIELD_MAX /* Maximum field index */
179} http_field_t;
180
181typedef enum http_keepalive_e /**** HTTP keep-alive values ****/
182{
183 HTTP_KEEPALIVE_OFF = 0, /* No keep alive support */
184 HTTP_KEEPALIVE_ON /* Use keep alive */
185} http_keepalive_t;
186
187typedef enum http_state_e /**** HTTP state values; states
188 **** are server-oriented...
189 ****/
190{
a469f8a5
MS		 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 */
8072030b
MS		 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@ */
a469f8a5
MS		 208
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 */
ef416fc2 225} http_state_t;
226
227typedef enum http_status_e /**** HTTP status codes ****/
228{
a469f8a5 229 HTTP_STATUS_ERROR = -1, /* An error response from httpXxxx() */
8072030b 230 HTTP_STATUS_NONE = 0, /* No Expect value @since CUPS 1.7/macOS 10.9@ */
a469f8a5
MS		 231
232 HTTP_STATUS_CONTINUE = 100, /* Everything OK, keep going... */
233 HTTP_STATUS_SWITCHING_PROTOCOLS, /* HTTP upgrade to TLS/SSL */
234
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 */
dd3fdd2c 241 HTTP_STATUS_PARTIAL_CONTENT, /* Only a partial file was received/sent */
a469f8a5
MS		 242
243 HTTP_STATUS_MULTIPLE_CHOICES = 300, /* Multiple files match request */
244 HTTP_STATUS_MOVED_PERMANENTLY, /* Document has moved permanently */
034b06df
MS		 245 HTTP_STATUS_FOUND, /* Document was found at a different URI */
246 HTTP_STATUS_SEE_OTHER, /* See this other link */
a469f8a5
MS		 247 HTTP_STATUS_NOT_MODIFIED, /* File not modified */
248 HTTP_STATUS_USE_PROXY, /* Must use a proxy to access this URI */
034b06df 249 HTTP_STATUS_TEMPORARY_REDIRECT = 307, /* Temporary redirection */
a469f8a5
MS		 250
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 */
270
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 */
277
cb7f98ee 278 HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED = 1000,
a469f8a5 279 /* User canceled authorization @since CUPS 1.4@ */
8072030b 280 HTTP_STATUS_CUPS_PKI_ERROR, /* Error negotiating a secure connection @since CUPS 1.5/macOS 10.7@ */
cb7f98ee 281 HTTP_STATUS_CUPS_WEBIF_DISABLED /* Web interface is disabled @private@ */
a469f8a5 282
034b06df
MS		 283# define HTTP_STATUS_MOVED_TEMPORARILY HTTP_STATUS_FOUND /* Renamed in RFC 7231 */
284
a469f8a5
MS		 285# ifndef _CUPS_NO_DEPRECATED
286/* Old names for this enumeration */
287# define HTTP_ERROR HTTP_STATUS_ERROR
288
289# define HTTP_CONTINUE HTTP_STATUS_CONTINUE
290# define HTTP_SWITCHING_PROTOCOLS HTTP_STATUS_SWITCHING_PROTOCOLS
291
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
299
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
306
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
326
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
333
cb7f98ee
MS		 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
a469f8a5 337# endif /* !_CUPS_NO_DEPRECATED */
ef416fc2 338} http_status_t;
339
e1f19878 340typedef enum http_trust_e /**** Level of trust for credentials @since CUPS 2.0/OS 10.10@ */
524c65e6
MS		 341{
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 */
348} http_trust_t;
349
7cf5915e 350typedef enum http_uri_status_e /**** URI separation status @since CUPS 1.2@ ****/
ef416fc2 351{
a469f8a5
MS		 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) */
364
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 */
ef416fc2 379} http_uri_status_t;
380
a4d04587 381typedef enum http_uri_coding_e /**** URI en/decode flags ****/
382{
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 */
86c809d9
MS		 389 HTTP_URI_CODING_ALL = 15, /* En/decode everything */
390 HTTP_URI_CODING_RFC6874 = 16 /* Use RFC 6874 address format */
a4d04587 391} http_uri_coding_t;
392
718ee2ff 393typedef enum http_version_e /**** HTTP version numbers @exclude all@ ****/
ef416fc2 394{
a469f8a5
MS		 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 */
398
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 */
ef416fc2 404} http_version_t;
405
ecdc0628 406typedef union _http_addr_u /**** Socket address union, which
ef416fc2 407 **** makes using IPv6 and other
408 **** address types easier and
8072030b 409 **** more portable. @since CUPS 1.2/macOS 10.5@
ef416fc2 410 ****/
411{
412 struct sockaddr addr; /* Base structure for family value */
413 struct sockaddr_in ipv4; /* IPv4 address */
414#ifdef AF_INET6
415 struct sockaddr_in6 ipv6; /* IPv6 address */
416#endif /* AF_INET6 */
417#ifdef AF_LOCAL
418 struct sockaddr_un un; /* Domain socket file */
419#endif /* AF_LOCAL */
420 char pad[256]; /* Padding to ensure binary compatibility */
421} http_addr_t;
422
423typedef struct http_addrlist_s /**** Socket address list, which is
424 **** used to enumerate all of the
425 **** addresses that are associated
8072030b 426 **** with a hostname. @since CUPS 1.2/macOS 10.5@
718ee2ff 427 **** @exclude all@
ef416fc2 428 ****/
429{
430 struct http_addrlist_s *next; /* Pointer to next address in list */
431 http_addr_t addr; /* Address */
432} http_addrlist_t;
433
f7deaa1a 434typedef struct _http_s http_t; /**** HTTP connection type ****/
ef416fc2 435
718ee2ff 436typedef struct http_credential_s /**** HTTP credential data @since CUPS 1.5/macOS 10.7@ @exclude all@ ****/
7cf5915e
MS		 437{
438 void *data; /* Pointer to credential data */
439 size_t datalen; /* Credential length */
440} http_credential_t;
441
f228370c 442typedef int (*http_timeout_cb_t)(http_t *http, void *user_data);
8072030b 443 /**** HTTP timeout callback @since CUPS 1.5/macOS 10.7@ ****/
f228370c
MS		 444
445
ef416fc2 446
447/*
448 * Prototypes...
449 */
450
ecdc0628 451extern void httpBlocking(http_t *http, int b);
ef416fc2 452extern int httpCheck(http_t *http);
ecdc0628 453extern void httpClearFields(http_t *http);
ef416fc2 454extern void httpClose(http_t *http);
a469f8a5 455extern http_t *httpConnect(const char *host, int port)
e666fe5e 456 _CUPS_DEPRECATED_1_7_MSG("Use httpConnect2 instead.");
ef416fc2 457extern http_t *httpConnectEncrypt(const char *host, int port,
a469f8a5 458 http_encryption_t encryption)
e666fe5e 459 _CUPS_DEPRECATED_1_7_MSG("Use httpConnect2 instead.");
ef416fc2 460extern int httpDelete(http_t *http, const char *uri);
461extern int httpEncryption(http_t *http, http_encryption_t e);
ecdc0628 462extern int httpError(http_t *http);
ef416fc2 463extern void httpFlush(http_t *http);
464extern int httpGet(http_t *http, const char *uri);
465extern char *httpGets(char *line, int length, http_t *http);
466extern const char *httpGetDateString(time_t t);
467extern time_t httpGetDateTime(const char *s);
ecdc0628 468extern const char *httpGetField(http_t *http, http_field_t field);
ef416fc2 469extern struct hostent *httpGetHostByName(const char *name);
470extern char *httpGetSubField(http_t *http, http_field_t field,
471 const char *name, char *value);
472extern int httpHead(http_t *http, const char *uri);
473extern void httpInitialize(void);
474extern int httpOptions(http_t *http, const char *uri);
475extern int httpPost(http_t *http, const char *uri);
476extern int httpPrintf(http_t *http, const char *format, ...)
85dda01c 477 __attribute__ ((__format__ (__printf__, 2, 3)));
ef416fc2 478extern int httpPut(http_t *http, const char *uri);
a469f8a5 479extern int httpRead(http_t *http, char *buffer, int length) _CUPS_DEPRECATED_MSG("Use httpRead2 instead.");
e666fe5e 480extern int httpReconnect(http_t *http) _CUPS_DEPRECATED_1_6_MSG("Use httpReconnect2 instead.");
ef416fc2 481extern void httpSeparate(const char *uri, char *method,
482 char *username, char *host, int *port,
a469f8a5 483 char *resource) _CUPS_DEPRECATED_MSG("Use httpSeparateURI instead.");
ef416fc2 484extern void httpSetField(http_t *http, http_field_t field,
485 const char *value);
486extern const char *httpStatus(http_status_t status);
487extern int httpTrace(http_t *http, const char *uri);
488extern http_status_t httpUpdate(http_t *http);
a469f8a5
MS		 489extern int httpWrite(http_t *http, const char *buffer, int length) _CUPS_DEPRECATED_MSG("Use httpWrite2 instead.");
490extern char *httpEncode64(char *out, const char *in) _CUPS_DEPRECATED_MSG("Use httpEncode64_2 instead.");
491extern char *httpDecode64(char *out, const char *in) _CUPS_DEPRECATED_MSG("Use httpDecode64_2 instead.");
492extern int httpGetLength(http_t *http) _CUPS_DEPRECATED_MSG("Use httpGetLength2 instead.");
ef416fc2 493extern char *httpMD5(const char *, const char *, const char *,
7ec11630 494 char [33]) _CUPS_DEPRECATED_MSG("Use cupsDoAuth or cupsHashData instead.");
ef416fc2 495extern char *httpMD5Final(const char *, const char *, const char *,
7ec11630
MS		 496 char [33]) _CUPS_DEPRECATED_MSG("Use cupsDoAuth or cupsHashData instead.");
497extern char *httpMD5String(const unsigned char *, char [33]) _CUPS_DEPRECATED_MSG("Use cupsHashString instead.");
ef416fc2 498
499/**** New in CUPS 1.1.19 ****/
2fb76298
MS		 500extern void httpClearCookie(http_t *http) _CUPS_API_1_1_19;
501extern const char *httpGetCookie(http_t *http) _CUPS_API_1_1_19;
502extern void httpSetCookie(http_t *http, const char *cookie) _CUPS_API_1_1_19;
503extern int httpWait(http_t *http, int msec) _CUPS_API_1_1_19;
ef416fc2 504
505/**** New in CUPS 1.1.21 ****/
2fb76298 506extern char *httpDecode64_2(char *out, int *outlen, const char *in) _CUPS_API_1_1_21;
ef416fc2 507extern char *httpEncode64_2(char *out, int outlen, const char *in,
2fb76298 508 int inlen) _CUPS_API_1_1_21;
ef416fc2 509extern void httpSeparate2(const char *uri,
510 char *method, int methodlen,
511 char *username, int usernamelen,
512 char *host, int hostlen, int *port,
a469f8a5 513 char *resource, int resourcelen) _CUPS_DEPRECATED_MSG("Use httpSeparateURI instead.");
ef416fc2 514
8072030b 515/**** New in CUPS 1.2/macOS 10.5 ****/
2fb76298
MS		 516extern int httpAddrAny(const http_addr_t *addr) _CUPS_API_1_2;
517extern http_addrlist_t *httpAddrConnect(http_addrlist_t *addrlist, int *sock) _CUPS_API_1_2;
ef416fc2 518extern int httpAddrEqual(const http_addr_t *addr1,
2fb76298
MS		 519 const http_addr_t *addr2) _CUPS_API_1_2;
520extern void httpAddrFreeList(http_addrlist_t *addrlist) _CUPS_API_1_2;
ef416fc2 521extern http_addrlist_t *httpAddrGetList(const char *hostname, int family,
2fb76298
MS		 522 const char *service) _CUPS_API_1_2;
523extern int httpAddrLength(const http_addr_t *addr) _CUPS_API_1_2;
524extern int httpAddrLocalhost(const http_addr_t *addr) _CUPS_API_1_2;
ef416fc2 525extern char *httpAddrLookup(const http_addr_t *addr,
2fb76298 526 char *name, int namelen) _CUPS_API_1_2;
ef416fc2 527extern char *httpAddrString(const http_addr_t *addr,
2fb76298 528 char *s, int slen) _CUPS_API_1_2;
a4d04587 529extern http_uri_status_t httpAssembleURI(http_uri_coding_t encoding,
530 char *uri, int urilen,
ef416fc2 531 const char *scheme,
532 const char *username,
533 const char *host, int port,
2fb76298 534 const char *resource) _CUPS_API_1_2;
a4d04587 535extern http_uri_status_t httpAssembleURIf(http_uri_coding_t encoding,
536 char *uri, int urilen,
ef416fc2 537 const char *scheme,
538 const char *username,
539 const char *host, int port,
2fb76298
MS		 540 const char *resourcef, ...) _CUPS_API_1_2;
541extern int httpFlushWrite(http_t *http) _CUPS_API_1_2;
542extern int httpGetBlocking(http_t *http) _CUPS_API_1_2;
543extern const char *httpGetDateString2(time_t t, char *s, int slen) _CUPS_API_1_2;
544extern int httpGetFd(http_t *http) _CUPS_API_1_2;
545extern const char *httpGetHostname(http_t *http, char *s, int slen) _CUPS_API_1_2;
546extern off_t httpGetLength2(http_t *http) _CUPS_API_1_2;
547extern http_status_t httpGetStatus(http_t *http) _CUPS_API_1_2;
ef416fc2 548extern char *httpGetSubField2(http_t *http, http_field_t field,
549 const char *name, char *value,
2fb76298
MS		 550 int valuelen) _CUPS_API_1_2;
551extern ssize_t httpRead2(http_t *http, char *buffer, size_t length) _CUPS_API_1_2;
a4d04587 552extern http_uri_status_t httpSeparateURI(http_uri_coding_t decoding,
553 const char *uri,
ef416fc2 554 char *scheme, int schemelen,
555 char *username, int usernamelen,
556 char *host, int hostlen, int *port,
2fb76298
MS		 557 char *resource, int resourcelen) _CUPS_API_1_2;
558extern void httpSetExpect(http_t *http, http_status_t expect) _CUPS_API_1_2;
559extern void httpSetLength(http_t *http, size_t length) _CUPS_API_1_2;
a4d04587 560extern ssize_t httpWrite2(http_t *http, const char *buffer,
2fb76298 561 size_t length) _CUPS_API_1_2;
ef416fc2 562
8072030b 563/**** New in CUPS 1.3/macOS 10.5 ****/
2fb76298 564extern char *httpGetAuthString(http_t *http) _CUPS_API_1_3;
355e94dc 565extern void httpSetAuthString(http_t *http, const char *scheme,
2fb76298 566 const char *data) _CUPS_API_1_3;
ef416fc2 567
8072030b 568/**** New in CUPS 1.5/macOS 10.7 ****/
7cf5915e
MS		 569extern int httpAddCredential(cups_array_t *credentials,
570 const void *data, size_t datalen)
571 _CUPS_API_1_5;
321d8d57
MS		 572extern int httpCopyCredentials(http_t *http,
573 cups_array_t **credentials)
7cf5915e
MS		 574 _CUPS_API_1_5;
575extern void httpFreeCredentials(cups_array_t *certs) _CUPS_API_1_5;
576extern int httpSetCredentials(http_t *http, cups_array_t *certs)
577 _CUPS_API_1_5;
f228370c 578extern void httpSetTimeout(http_t *http, double timeout,
a2326b5b
MS		 579 http_timeout_cb_t cb, void *user_data)
580 _CUPS_API_1_5;
581
8072030b 582/**** New in CUPS 1.6/macOS 10.8 ****/
dcb445bc
MS		 583extern http_addrlist_t *httpAddrConnect2(http_addrlist_t *addrlist, int *sock,
584 int msec, int *cancel)
585 _CUPS_API_1_6;
a2326b5b
MS		 586extern http_state_t httpGetState(http_t *http) _CUPS_API_1_6;
587extern http_version_t httpGetVersion(http_t *http) _CUPS_API_1_6;
dcb445bc
MS		 588extern int httpReconnect2(http_t *http, int msec, int *cancel)
589 _CUPS_API_1_6;
f228370c 590
7cf5915e 591
8072030b 592/**** New in CUPS 1.7/macOS 10.9 ****/
a469f8a5
MS		 593extern http_t *httpAcceptConnection(int fd, int blocking)
594 _CUPS_API_1_7;
595extern http_addrlist_t *httpAddrCopyList(http_addrlist_t *src) _CUPS_API_1_7;
596extern int httpAddrListen(http_addr_t *addr, int port)
597 _CUPS_API_1_7;
598extern int httpAddrPort(http_addr_t *addr) _CUPS_API_1_7;
0fa6c7fa
MS		 599extern char *httpAssembleUUID(const char *server, int port,
600 const char *name, int number,
601 char *buffer, size_t bufsize)
602 _CUPS_API_1_7;
a469f8a5
MS		 603extern 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)
607 _CUPS_API_1_7;
608extern const char *httpGetContentEncoding(http_t *http) _CUPS_API_1_7;
609extern http_status_t httpGetExpect(http_t *http) _CUPS_API_1_7;
610extern ssize_t httpPeek(http_t *http, char *buffer, size_t length)
611 _CUPS_API_1_7;
612extern http_state_t httpReadRequest(http_t *http, char *resource,
613 size_t resourcelen) _CUPS_API_1_7;
c1420c87
MS		 614extern void httpSetDefaultField(http_t *http, http_field_t field,
615 const char *value) _CUPS_API_1_7;
a469f8a5
MS		 616extern http_state_t httpWriteResponse(http_t *http,
617 http_status_t status) _CUPS_API_1_7;
618
8072030b 619/* New in CUPS 2.0/macOS 10.10 */
7855ab56
MS		 620extern int httpAddrClose(http_addr_t *addr, int fd) _CUPS_API_2_0;
621extern int httpAddrFamily(http_addr_t *addr) _CUPS_API_2_0;
dafebafd 622extern int httpCompareCredentials(cups_array_t *cred1, cups_array_t *cred2) _CUPS_API_2_0;
524c65e6 623extern int httpCredentialsAreValidForName(cups_array_t *credentials, const char *common_name);
3af9ac9e 624extern time_t httpCredentialsGetExpiration(cups_array_t *credentials) _CUPS_API_2_0;
524c65e6 625extern http_trust_t httpCredentialsGetTrust(cups_array_t *credentials, const char *common_name) _CUPS_API_2_0;
dafebafd 626extern size_t httpCredentialsString(cups_array_t *credentials, char *buffer, size_t bufsize) _CUPS_API_2_0;
48bd1142 627extern http_field_t httpFieldValue(const char *name) _CUPS_API_2_0;
996acce8
MS		 628extern time_t httpGetActivity(http_t *http) _CUPS_API_2_0;
629extern http_addr_t *httpGetAddress(http_t *http) _CUPS_API_2_0;
5ec1fd3d 630extern http_encryption_t httpGetEncryption(http_t *http) _CUPS_API_2_0;
996acce8 631extern http_keepalive_t httpGetKeepAlive(http_t *http) _CUPS_API_2_0;
d21dc0ed 632extern size_t httpGetPending(http_t *http) _CUPS_API_2_0;
996acce8 633extern size_t httpGetReady(http_t *http) _CUPS_API_2_0;
5ec1fd3d
MS		 634extern size_t httpGetRemaining(http_t *http) _CUPS_API_2_0;
635extern int httpIsChunked(http_t *http) _CUPS_API_2_0;
636extern int httpIsEncrypted(http_t *http) _CUPS_API_2_0;
dafebafd 637extern int httpLoadCredentials(const char *path, cups_array_t **credentials, const char *common_name) _CUPS_API_2_0;
48bd1142 638extern const char *httpResolveHostname(http_t *http, char *buffer, size_t bufsize) _CUPS_API_2_0;
dafebafd 639extern int httpSaveCredentials(const char *path, cups_array_t *credentials, const char *common_name) _CUPS_API_2_0;
e6b1a6a9 640extern void httpSetKeepAlive(http_t *http, http_keepalive_t keep_alive) _CUPS_API_2_0;
5ec1fd3d 641extern void httpShutdown(http_t *http) _CUPS_API_2_0;
7e86f2f6
MS		 642extern const char *httpStateString(http_state_t state) _CUPS_API_2_0;
643extern const char *httpURIStatusString(http_uri_status_t status) _CUPS_API_2_0;
996acce8 644
ef416fc2 645/*
646 * C++ magic...
647 */
648
649# ifdef __cplusplus
650}
651# endif /* __cplusplus */
652#endif /* !_CUPS_HTTP_H_ */
Unnamed repository; edit this file 'description' to name the repository.