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