1 /* 2 * "$Id: http.h 9157 2010-06-16 05:27:41Z mike $" 3 * 4 * Hyper-Text Transport Protocol definitions for the Common UNIX Printing 5 * System (CUPS). 6 * 7 * Copyright 2007-2009 by Apple Inc. 8 * Copyright 1997-2007 by Easy Software Products, all rights reserved. 9 * 10 * These coded instructions, statements, and computer programs are the 11 * property of Apple Inc. and are protected by Federal copyright 12 * law. Distribution and use rights are outlined in the file "LICENSE.txt" 13 * which should have been included with this file. If this file is 14 * file is missing or damaged, see the license at "http://www.cups.org/". 15 * 16 * This file is subject to the Apple OS-Developed Software exception. 17 */ 18 19 #ifndef _CUPS_HTTP_H_ 20 # define _CUPS_HTTP_H_ 21 22 /* 23 * Include necessary headers... 24 */ 25 26 # include "versioning.h" 27 # include <string.h> 28 # include <time.h> 29 # include <sys/types.h> 30 # ifdef WIN32 31 # ifndef __CUPS_SSIZE_T_DEFINED 32 # define __CUPS_SSIZE_T_DEFINED 33 /* Windows does not support the ssize_t type, so map it to off_t... */ 34 typedef off_t ssize_t; /* @private@ */ 35 # endif /* !__CUPS_SSIZE_T_DEFINED */ 36 # include <winsock2.h> 37 # include <ws2tcpip.h> 38 # else 39 # ifdef __sgi 40 # define INET6 /* IRIX IPv6 support... */ 41 # endif /* __sgi */ 42 # include <unistd.h> 43 # include <sys/time.h> 44 # include <sys/socket.h> 45 # include <netdb.h> 46 # include <netinet/in.h> 47 # include <arpa/inet.h> 48 # include <netinet/in_systm.h> 49 # include <netinet/ip.h> 50 # if !defined(__APPLE__) || !defined(TCP_NODELAY) 51 # include <netinet/tcp.h> 52 # endif /* !__APPLE__ || !TCP_NODELAY */ 53 # if defined(AF_UNIX) && !defined(AF_LOCAL) 54 # define AF_LOCAL AF_UNIX /* Older UNIX's have old names... */ 55 # endif /* AF_UNIX && !AF_LOCAL */ 56 # ifdef AF_LOCAL 57 # include <sys/un.h> 58 # endif /* AF_LOCAL */ 59 # if defined(LOCAL_PEERCRED) && !defined(SO_PEERCRED) 60 # define SO_PEERCRED LOCAL_PEERCRED 61 # endif /* LOCAL_PEERCRED && !SO_PEERCRED */ 62 # endif /* WIN32 */ 63 64 65 /* 66 * C++ magic... 67 */ 68 69 # ifdef __cplusplus 70 extern "C" { 71 # endif /* __cplusplus */ 72 73 74 /* 75 * Oh, the wonderful world of IPv6 compatibility. Apparently some 76 * implementations expose the (more logical) 32-bit address parts 77 * to everyone, while others only expose it to kernel code... To 78 * make supporting IPv6 even easier, each vendor chose different 79 * core structure and union names, so the same defines or code 80 * can't be used on all platforms. 81 * 82 * The following will likely need tweaking on new platforms that 83 * support IPv6 - the "s6_addr32" define maps to the 32-bit integer 84 * array in the in6_addr union, which is named differently on various 85 * platforms. 86 */ 87 88 #if defined(AF_INET6) && !defined(s6_addr32) 89 # if defined(__sun) 90 # define s6_addr32 _S6_un._S6_u32 91 # elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__) 92 # define s6_addr32 __u6_addr.__u6_addr32 93 # elif defined(__osf__) 94 # define s6_addr32 s6_un.sa6_laddr 95 # elif defined(WIN32) 96 /* 97 * Windows only defines byte and 16-bit word members of the union and 98 * requires special casing of all raw address code... 99 */ 100 # define s6_addr32 error_need_win32_specific_code 101 # endif /* __sun */ 102 #endif /* AF_INET6 && !s6_addr32 */ 103 104 105 /* 106 * Limits... 107 */ 108 109 # define HTTP_MAX_URI 1024 /* Max length of URI string */ 110 # define HTTP_MAX_HOST 256 /* Max length of hostname string */ 111 # define HTTP_MAX_BUFFER 2048 /* Max length of data buffer */ 112 # define HTTP_MAX_VALUE 256 /* Max header field value length */ 113 114 115 /* 116 * Types and structures... 117 */ 118 119 typedef enum http_auth_e /**** HTTP authentication types ****/ 120 { 121 HTTP_AUTH_NONE, /* No authentication in use */ 122 HTTP_AUTH_BASIC, /* Basic authentication in use */ 123 HTTP_AUTH_MD5, /* Digest authentication in use */ 124 HTTP_AUTH_MD5_SESS, /* MD5-session authentication in use */ 125 HTTP_AUTH_MD5_INT, /* Digest authentication in use for body */ 126 HTTP_AUTH_MD5_SESS_INT, /* MD5-session authentication in use for body */ 127 HTTP_AUTH_NEGOTIATE /* GSSAPI authentication in use @since CUPS 1.3/Mac OS X 10.5@ */ 128 } http_auth_t; 129 130 typedef enum http_encoding_e /**** HTTP transfer encoding values ****/ 131 { 132 HTTP_ENCODE_LENGTH, /* Data is sent with Content-Length */ 133 HTTP_ENCODE_CHUNKED, /* Data is chunked */ 134 HTTP_ENCODE_FIELDS /* Sending HTTP fields */ 135 } http_encoding_t; 136 137 typedef enum http_encryption_e /**** HTTP encryption values ****/ 138 { 139 HTTP_ENCRYPT_IF_REQUESTED, /* Encrypt if requested (TLS upgrade) */ 140 HTTP_ENCRYPT_NEVER, /* Never encrypt */ 141 HTTP_ENCRYPT_REQUIRED, /* Encryption is required (TLS upgrade) */ 142 HTTP_ENCRYPT_ALWAYS /* Always encrypt (SSL) */ 143 } http_encryption_t; 144 145 typedef 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 */ 175 HTTP_FIELD_MAX /* Maximum field index */ 176 } http_field_t; 177 178 typedef enum http_keepalive_e /**** HTTP keep-alive values ****/ 179 { 180 HTTP_KEEPALIVE_OFF = 0, /* No keep alive support */ 181 HTTP_KEEPALIVE_ON /* Use keep alive */ 182 } http_keepalive_t; 183 184 typedef enum http_state_e /**** HTTP state values; states 185 **** are server-oriented... 186 ****/ 187 { 188 HTTP_WAITING, /* Waiting for command */ 189 HTTP_OPTIONS, /* OPTIONS command, waiting for blank line */ 190 HTTP_GET, /* GET command, waiting for blank line */ 191 HTTP_GET_SEND, /* GET command, sending data */ 192 HTTP_HEAD, /* HEAD command, waiting for blank line */ 193 HTTP_POST, /* POST command, waiting for blank line */ 194 HTTP_POST_RECV, /* POST command, receiving data */ 195 HTTP_POST_SEND, /* POST command, sending data */ 196 HTTP_PUT, /* PUT command, waiting for blank line */ 197 HTTP_PUT_RECV, /* PUT command, receiving data */ 198 HTTP_DELETE, /* DELETE command, waiting for blank line */ 199 HTTP_TRACE, /* TRACE command, waiting for blank line */ 200 HTTP_CLOSE, /* CLOSE command, waiting for blank line */ 201 HTTP_STATUS /* Command complete, sending status */ 202 } http_state_t; 203 204 typedef enum http_status_e /**** HTTP status codes ****/ 205 { 206 HTTP_ERROR = -1, /* An error response from httpXxxx() */ 207 208 HTTP_CONTINUE = 100, /* Everything OK, keep going... */ 209 HTTP_SWITCHING_PROTOCOLS, /* HTTP upgrade to TLS/SSL */ 210 211 HTTP_OK = 200, /* OPTIONS/GET/HEAD/POST/TRACE command was successful */ 212 HTTP_CREATED, /* PUT command was successful */ 213 HTTP_ACCEPTED, /* DELETE command was successful */ 214 HTTP_NOT_AUTHORITATIVE, /* Information isn't authoritative */ 215 HTTP_NO_CONTENT, /* Successful command, no new data */ 216 HTTP_RESET_CONTENT, /* Content was reset/recreated */ 217 HTTP_PARTIAL_CONTENT, /* Only a partial file was recieved/sent */ 218 219 HTTP_MULTIPLE_CHOICES = 300, /* Multiple files match request */ 220 HTTP_MOVED_PERMANENTLY, /* Document has moved permanently */ 221 HTTP_MOVED_TEMPORARILY, /* Document has moved temporarily */ 222 HTTP_SEE_OTHER, /* See this other link... */ 223 HTTP_NOT_MODIFIED, /* File not modified */ 224 HTTP_USE_PROXY, /* Must use a proxy to access this URI */ 225 226 HTTP_BAD_REQUEST = 400, /* Bad request */ 227 HTTP_UNAUTHORIZED, /* Unauthorized to access host */ 228 HTTP_PAYMENT_REQUIRED, /* Payment required */ 229 HTTP_FORBIDDEN, /* Forbidden to access this URI */ 230 HTTP_NOT_FOUND, /* URI was not found */ 231 HTTP_METHOD_NOT_ALLOWED, /* Method is not allowed */ 232 HTTP_NOT_ACCEPTABLE, /* Not Acceptable */ 233 HTTP_PROXY_AUTHENTICATION, /* Proxy Authentication is Required */ 234 HTTP_REQUEST_TIMEOUT, /* Request timed out */ 235 HTTP_CONFLICT, /* Request is self-conflicting */ 236 HTTP_GONE, /* Server has gone away */ 237 HTTP_LENGTH_REQUIRED, /* A content length or encoding is required */ 238 HTTP_PRECONDITION, /* Precondition failed */ 239 HTTP_REQUEST_TOO_LARGE, /* Request entity too large */ 240 HTTP_URI_TOO_LONG, /* URI too long */ 241 HTTP_UNSUPPORTED_MEDIATYPE, /* The requested media type is unsupported */ 242 HTTP_REQUESTED_RANGE, /* The requested range is not satisfiable */ 243 HTTP_EXPECTATION_FAILED, /* The expectation given in an Expect header field was not met */ 244 HTTP_UPGRADE_REQUIRED = 426, /* Upgrade to SSL/TLS required */ 245 246 HTTP_SERVER_ERROR = 500, /* Internal server error */ 247 HTTP_NOT_IMPLEMENTED, /* Feature not implemented */ 248 HTTP_BAD_GATEWAY, /* Bad gateway */ 249 HTTP_SERVICE_UNAVAILABLE, /* Service is unavailable */ 250 HTTP_GATEWAY_TIMEOUT, /* Gateway connection timed out */ 251 HTTP_NOT_SUPPORTED, /* HTTP version not supported */ 252 253 HTTP_AUTHORIZATION_CANCELED = 1000 /* User canceled authorization */ 254 255 } http_status_t; 256 257 typedef enum http_uri_status_e /**** URI separation status @since CUPS1.2@ ****/ 258 { 259 HTTP_URI_OVERFLOW = -8, /* URI buffer for httpAssembleURI is too small */ 260 HTTP_URI_BAD_ARGUMENTS = -7, /* Bad arguments to function (error) */ 261 HTTP_URI_BAD_RESOURCE = -6, /* Bad resource in URI (error) */ 262 HTTP_URI_BAD_PORT = -5, /* Bad port number in URI (error) */ 263 HTTP_URI_BAD_HOSTNAME = -4, /* Bad hostname in URI (error) */ 264 HTTP_URI_BAD_USERNAME = -3, /* Bad username in URI (error) */ 265 HTTP_URI_BAD_SCHEME = -2, /* Bad scheme in URI (error) */ 266 HTTP_URI_BAD_URI = -1, /* Bad/empty URI (error) */ 267 HTTP_URI_OK = 0, /* URI decoded OK */ 268 HTTP_URI_MISSING_SCHEME, /* Missing scheme in URI (warning) */ 269 HTTP_URI_UNKNOWN_SCHEME, /* Unknown scheme in URI (warning) */ 270 HTTP_URI_MISSING_RESOURCE /* Missing resource in URI (warning) */ 271 } http_uri_status_t; 272 273 typedef enum http_uri_coding_e /**** URI en/decode flags ****/ 274 { 275 HTTP_URI_CODING_NONE = 0, /* Don't en/decode anything */ 276 HTTP_URI_CODING_USERNAME = 1, /* En/decode the username portion */ 277 HTTP_URI_CODING_HOSTNAME = 2, /* En/decode the hostname portion */ 278 HTTP_URI_CODING_RESOURCE = 4, /* En/decode the resource portion */ 279 HTTP_URI_CODING_MOST = 7, /* En/decode all but the query */ 280 HTTP_URI_CODING_QUERY = 8, /* En/decode the query portion */ 281 HTTP_URI_CODING_ALL = 15 /* En/decode everything */ 282 } http_uri_coding_t; 283 284 typedef enum http_version_e /**** HTTP version numbers ****/ 285 { 286 HTTP_0_9 = 9, /* HTTP/0.9 */ 287 HTTP_1_0 = 100, /* HTTP/1.0 */ 288 HTTP_1_1 = 101 /* HTTP/1.1 */ 289 } http_version_t; 290 291 typedef union _http_addr_u /**** Socket address union, which 292 **** makes using IPv6 and other 293 **** address types easier and 294 **** more portable. @since CUPS 1.2/Mac OS X 10.5@ 295 ****/ 296 { 297 struct sockaddr addr; /* Base structure for family value */ 298 struct sockaddr_in ipv4; /* IPv4 address */ 299 #ifdef AF_INET6 300 struct sockaddr_in6 ipv6; /* IPv6 address */ 301 #endif /* AF_INET6 */ 302 #ifdef AF_LOCAL 303 struct sockaddr_un un; /* Domain socket file */ 304 #endif /* AF_LOCAL */ 305 char pad[256]; /* Padding to ensure binary compatibility */ 306 } http_addr_t; 307 308 typedef struct http_addrlist_s /**** Socket address list, which is 309 **** used to enumerate all of the 310 **** addresses that are associated 311 **** with a hostname. @since CUPS 1.2/Mac OS X 10.5@ 312 ****/ 313 { 314 struct http_addrlist_s *next; /* Pointer to next address in list */ 315 http_addr_t addr; /* Address */ 316 } http_addrlist_t; 317 318 typedef struct _http_s http_t; /**** HTTP connection type ****/ 319 320 321 /* 322 * Prototypes... 323 */ 324 325 extern void httpBlocking(http_t *http, int b); 326 extern int httpCheck(http_t *http); 327 extern void httpClearFields(http_t *http); 328 extern void httpClose(http_t *http); 329 extern http_t *httpConnect(const char *host, int port); 330 extern http_t *httpConnectEncrypt(const char *host, int port, 331 http_encryption_t encryption); 332 extern int httpDelete(http_t *http, const char *uri); 333 extern int httpEncryption(http_t *http, http_encryption_t e); 334 extern int httpError(http_t *http); 335 extern void httpFlush(http_t *http); 336 extern int httpGet(http_t *http, const char *uri); 337 extern char *httpGets(char *line, int length, http_t *http); 338 extern const char *httpGetDateString(time_t t); 339 extern time_t httpGetDateTime(const char *s); 340 extern const char *httpGetField(http_t *http, http_field_t field); 341 extern struct hostent *httpGetHostByName(const char *name); 342 extern char *httpGetSubField(http_t *http, http_field_t field, 343 const char *name, char *value); 344 extern int httpHead(http_t *http, const char *uri); 345 extern void httpInitialize(void); 346 extern int httpOptions(http_t *http, const char *uri); 347 extern int httpPost(http_t *http, const char *uri); 348 extern int httpPrintf(http_t *http, const char *format, ...) 349 # ifdef __GNUC__ 350 __attribute__ ((__format__ (__printf__, 2, 3))) 351 # endif /* __GNUC__ */ 352 ; 353 extern int httpPut(http_t *http, const char *uri); 354 extern int httpRead(http_t *http, char *buffer, int length) _CUPS_DEPRECATED; 355 extern int httpReconnect(http_t *http); 356 extern void httpSeparate(const char *uri, char *method, 357 char *username, char *host, int *port, 358 char *resource) _CUPS_DEPRECATED; 359 extern void httpSetField(http_t *http, http_field_t field, 360 const char *value); 361 extern const char *httpStatus(http_status_t status); 362 extern int httpTrace(http_t *http, const char *uri); 363 extern http_status_t httpUpdate(http_t *http); 364 extern int httpWrite(http_t *http, const char *buffer, int length) _CUPS_DEPRECATED; 365 extern char *httpEncode64(char *out, const char *in) _CUPS_DEPRECATED; 366 extern char *httpDecode64(char *out, const char *in) _CUPS_DEPRECATED; 367 extern int httpGetLength(http_t *http) _CUPS_DEPRECATED; 368 extern char *httpMD5(const char *, const char *, const char *, 369 char [33]); 370 extern char *httpMD5Final(const char *, const char *, const char *, 371 char [33]); 372 extern char *httpMD5String(const unsigned char *, char [33]); 373 374 /**** New in CUPS 1.1.19 ****/ 375 extern void httpClearCookie(http_t *http) _CUPS_API_1_1_19; 376 extern const char *httpGetCookie(http_t *http) _CUPS_API_1_1_19; 377 extern void httpSetCookie(http_t *http, const char *cookie) _CUPS_API_1_1_19; 378 extern int httpWait(http_t *http, int msec) _CUPS_API_1_1_19; 379 380 /**** New in CUPS 1.1.21 ****/ 381 extern char *httpDecode64_2(char *out, int *outlen, const char *in) _CUPS_API_1_1_21; 382 extern char *httpEncode64_2(char *out, int outlen, const char *in, 383 int inlen) _CUPS_API_1_1_21; 384 extern void httpSeparate2(const char *uri, 385 char *method, int methodlen, 386 char *username, int usernamelen, 387 char *host, int hostlen, int *port, 388 char *resource, int resourcelen) _CUPS_DEPRECATED; 389 390 /**** New in CUPS 1.2/Mac OS X 10.5 ****/ 391 extern int httpAddrAny(const http_addr_t *addr) _CUPS_API_1_2; 392 extern http_addrlist_t *httpAddrConnect(http_addrlist_t *addrlist, int *sock) _CUPS_API_1_2; 393 extern int httpAddrEqual(const http_addr_t *addr1, 394 const http_addr_t *addr2) _CUPS_API_1_2; 395 extern void httpAddrFreeList(http_addrlist_t *addrlist) _CUPS_API_1_2; 396 extern http_addrlist_t *httpAddrGetList(const char *hostname, int family, 397 const char *service) _CUPS_API_1_2; 398 extern int httpAddrLength(const http_addr_t *addr) _CUPS_API_1_2; 399 extern int httpAddrLocalhost(const http_addr_t *addr) _CUPS_API_1_2; 400 extern char *httpAddrLookup(const http_addr_t *addr, 401 char *name, int namelen) _CUPS_API_1_2; 402 extern char *httpAddrString(const http_addr_t *addr, 403 char *s, int slen) _CUPS_API_1_2; 404 extern http_uri_status_t httpAssembleURI(http_uri_coding_t encoding, 405 char *uri, int urilen, 406 const char *scheme, 407 const char *username, 408 const char *host, int port, 409 const char *resource) _CUPS_API_1_2; 410 extern http_uri_status_t httpAssembleURIf(http_uri_coding_t encoding, 411 char *uri, int urilen, 412 const char *scheme, 413 const char *username, 414 const char *host, int port, 415 const char *resourcef, ...) _CUPS_API_1_2; 416 extern int httpFlushWrite(http_t *http) _CUPS_API_1_2; 417 extern int httpGetBlocking(http_t *http) _CUPS_API_1_2; 418 extern const char *httpGetDateString2(time_t t, char *s, int slen) _CUPS_API_1_2; 419 extern int httpGetFd(http_t *http) _CUPS_API_1_2; 420 extern const char *httpGetHostname(http_t *http, char *s, int slen) _CUPS_API_1_2; 421 extern off_t httpGetLength2(http_t *http) _CUPS_API_1_2; 422 extern http_status_t httpGetStatus(http_t *http) _CUPS_API_1_2; 423 extern char *httpGetSubField2(http_t *http, http_field_t field, 424 const char *name, char *value, 425 int valuelen) _CUPS_API_1_2; 426 extern ssize_t httpRead2(http_t *http, char *buffer, size_t length) _CUPS_API_1_2; 427 extern http_uri_status_t httpSeparateURI(http_uri_coding_t decoding, 428 const char *uri, 429 char *scheme, int schemelen, 430 char *username, int usernamelen, 431 char *host, int hostlen, int *port, 432 char *resource, int resourcelen) _CUPS_API_1_2; 433 extern void httpSetExpect(http_t *http, http_status_t expect) _CUPS_API_1_2; 434 extern void httpSetLength(http_t *http, size_t length) _CUPS_API_1_2; 435 extern ssize_t httpWrite2(http_t *http, const char *buffer, 436 size_t length) _CUPS_API_1_2; 437 438 /**** New in CUPS 1.3/Mac OS X 10.5 ****/ 439 extern char *httpGetAuthString(http_t *http) _CUPS_API_1_3; 440 extern void httpSetAuthString(http_t *http, const char *scheme, 441 const char *data) _CUPS_API_1_3; 442 443 /* 444 * C++ magic... 445 */ 446 447 # ifdef __cplusplus 448 } 449 # endif /* __cplusplus */ 450 #endif /* !_CUPS_HTTP_H_ */ 451 452 /* 453 * End of "$Id: http.h 9157 2010-06-16 05:27:41Z mike $". 454 */ 455