355b4669e025ff377602b6fc7caaf30dbc218371jacobs * "$Id: http.h 148 2006-04-25 16:54:17Z njacobs $"
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Hyper-Text Transport Protocol definitions for the Common UNIX Printing
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * System (CUPS).
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Copyright 1997-2005 by Easy Software Products, all rights reserved.
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * These coded instructions, statements, and computer programs are the
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * property of Easy Software Products and are protected by Federal
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * copyright law. Distribution and use rights are outlined in the file
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * "LICENSE.txt" which should have been included with this file. If this
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * file is missing or damaged please contact Easy Software Products
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Attn: CUPS Licensing Information
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Easy Software Products
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * 44141 Airport View Drive, Suite 204
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Hollywood, Maryland 20636 USA
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Voice: (301) 373-9600
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * EMail: cups-info@cups.org
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * This file is subject to the Apple OS-Developed Software exception.
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#pragma ident "%Z%%M% %I% %E% SMI"
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Include necessary headers...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# endif /* !__APPLE__ || !TCP_NODELAY */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# endif /* AF_LOCAL */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# endif /* WIN32 */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * C++ magic...
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern "C" {
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Oh, the wonderful world of IPv6 compatibility. Apparently some
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * implementations expose the (more logical) 32-bit address parts
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * to everyone, while others only expose it to kernel code... To
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * make supporting IPv6 even easier, each vendor chose different
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * core structure and union names, so the same defines or code
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * can't be used on all platforms.
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * The following will likely need tweeking on new platforms that
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * support IPv6 - the "s6_addr32" define maps to the 32-bit integer
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * array in the in6_addr union, which is named differently on various
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * platforms.
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# if defined(__sun)
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# endif /* __sun */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#endif /* AF_INET6 && !s6_addr32 */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Limits...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# define HTTP_MAX_URI 1024 /* Max length of URI string */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# define HTTP_MAX_HOST 256 /* Max length of hostname string */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# define HTTP_MAX_BUFFER 2048 /* Max length of data buffer */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# define HTTP_MAX_VALUE 256 /* Max header field value length */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP state values...
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum /* States are server-oriented */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_OPTIONS, /* OPTIONS command, waiting for blank line */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_HEAD, /* HEAD command, waiting for blank line */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_POST, /* POST command, waiting for blank line */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_DELETE, /* DELETE command, waiting for blank line */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_TRACE, /* TRACE command, waiting for blank line */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_CLOSE, /* CLOSE command, waiting for blank line */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP version numbers...
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP keep-alive values...
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP transfer encoding values...
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ENCODE_LENGTH, /* Data is sent with Content-Length */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP encryption values...
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ENCRYPT_IF_REQUESTED, /* Encrypt if requested (TLS upgrade) */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ENCRYPT_REQUIRED, /* Encryption is required (TLS upgrade) */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP authentication types...
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_AUTH_MD5_SESS, /* MD5-session authentication in use */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_AUTH_MD5_INT, /* Digest authentication in use for body */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_AUTH_MD5_SESS_INT /* MD5-session authentication in use for body */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP status codes...
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ERROR = -1, /* An error response from httpXxxx() */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_CONTINUE = 100, /* Everything OK, keep going... */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_SWITCHING_PROTOCOLS, /* HTTP upgrade to TLS/SSL */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_OK = 200, /* OPTIONS/GET/HEAD/POST/TRACE command was successful */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_NOT_AUTHORITATIVE, /* Information isn't authoritative */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_NO_CONTENT, /* Successful command, no new data */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_RESET_CONTENT, /* Content was reset/recreated */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_PARTIAL_CONTENT, /* Only a partial file was recieved/sent */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_MULTIPLE_CHOICES = 300, /* Multiple files match request */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_MOVED_PERMANENTLY, /* Document has moved permanently */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_MOVED_TEMPORARILY, /* Document has moved temporarily */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_USE_PROXY, /* Must use a proxy to access this URI */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_PROXY_AUTHENTICATION, /* Proxy Authentication is Required */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_LENGTH_REQUIRED, /* A content length or encoding is required */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_REQUEST_TOO_LARGE, /* Request entity too large */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_UNSUPPORTED_MEDIATYPE, /* The requested media type is unsupported */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_UPGRADE_REQUIRED = 426, /* Upgrade to SSL/TLS required */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_SERVICE_UNAVAILABLE, /* Service is unavailable */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_GATEWAY_TIMEOUT, /* Gateway connection timed out */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP field names...
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP address structure (makes using IPv6 a little easier and more portable.)
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef union
355b4669e025ff377602b6fc7caaf30dbc218371jacobs struct sockaddr addr; /* Base structure for family value */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#endif /* AF_INET6 */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#endif /* AF_LOCAL */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char pad[128]; /* Pad to ensure binary compatibility */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP connection structure...
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef struct
355b4669e025ff377602b6fc7caaf30dbc218371jacobs http_keepalive_t keep_alive; /* Keep-alive supported? */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs struct sockaddr_in oldaddr; /* Address of connected host */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Name of connected host */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Field values */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Buffer for messages */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Nonce value */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs http_encryption_t encryption; /* Encryption requirements */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /**** New in CUPS 1.1.19 ****/
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /**** New in CUPS 1.1.20 ****/
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Current Authentication value */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Username:password string */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs int digest_tries; /* Number of tries for digest auth */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /**** New in CUPS 1.2 ****/
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Prototypes...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# define httpClearFields(http) memset((http)->fields, 0, sizeof((http)->fields)),\
355b4669e025ff377602b6fc7caaf30dbc218371jacobs httpSetField((http), HTTP_FIELD_HOST, (http)->hostname)
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern http_t *httpConnect(const char *host, int port);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern http_t *httpConnectEncrypt(const char *host, int port,
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpEncryption(http_t *http, http_encryption_t e);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpGets(char *line, int length, http_t *http);
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# define httpGetField(http,field) (http)->fields[field]
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern struct hostent *httpGetHostByName(const char *name);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpGetSubField(http_t *http, http_field_t field,
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpInitialize(void);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpOptions(http_t *http, const char *uri);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpPrintf(http_t *http, const char *format, ...)
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# endif /* __GNUC__ */
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpRead(http_t *http, char *buffer, int length);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpSeparate(const char *uri, char *method,
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpSetField(http_t *http, http_field_t field,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs const char *value);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpWrite(http_t *http, const char *buffer, int length);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpMD5(const char *, const char *, const char *,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char [33]);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpMD5Final(const char *, const char *, const char *,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char [33]);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpMD5String(const unsigned char *, char [33]);
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/**** New in CUPS 1.1.19 ****/
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpSetCookie(http_t *http, const char *cookie);
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/**** New in CUPS 1.1.21 ****/
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpDecode64_2(char *out, int *outlen, const char *in);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpEncode64_2(char *out, int outlen, const char *in,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/**** New in CUPS 1.2 ****/
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpAddrLoad(const struct hostent *host, int port,
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpAddrLocalhost(const http_addr_t *addr);
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char *s, int slen);
0a44ef6d9afbfe052a7e975f55ea0d2954b62a82jacobsextern void httpDumpData(FILE *, const char *, const char *, int);
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * C++ magic...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#endif /* !_CUPS_HTTP_H_ */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * End of "$Id: http.h 148 2006-04-25 16:54:17Z njacobs $"