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