355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * "$Id: http.h 148 2006-04-25 16:54:17Z njacobs $"
355b4669e025ff377602b6fc7caaf30dbc218371jacobs *
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Hyper-Text Transport Protocol definitions for the Common UNIX Printing
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * System (CUPS).
355b4669e025ff377602b6fc7caaf30dbc218371jacobs *
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Copyright 1997-2005 by Easy Software Products, all rights reserved.
355b4669e025ff377602b6fc7caaf30dbc218371jacobs *
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 * at:
355b4669e025ff377602b6fc7caaf30dbc218371jacobs *
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Attn: CUPS Licensing Information
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Easy Software Products
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * 44141 Airport View Drive, Suite 204
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Hollywood, Maryland 20636 USA
355b4669e025ff377602b6fc7caaf30dbc218371jacobs *
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Voice: (301) 373-9600
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * EMail: cups-info@cups.org
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * WWW: http://www.cups.org
355b4669e025ff377602b6fc7caaf30dbc218371jacobs *
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * This file is subject to the Apple OS-Developed Software exception.
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#ifndef _CUPS_HTTP_H_
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#define _CUPS_HTTP_H_
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#pragma ident "%Z%%M% %I% %E% SMI"
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Include necessary headers...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <string.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <time.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# ifdef WIN32
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <winsock.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# else
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <unistd.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <sys/time.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <sys/types.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <sys/socket.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <netdb.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <netinet/in.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <arpa/inet.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <netinet/in_systm.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <netinet/ip.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# if !defined(__APPLE__) || !defined(TCP_NODELAY)
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <netinet/tcp.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# endif /* !__APPLE__ || !TCP_NODELAY */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# ifdef AF_LOCAL
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# include <sys/un.h>
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# endif /* AF_LOCAL */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# endif /* WIN32 */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * C++ magic...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#ifdef __cplusplus
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern "C" {
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#endif
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
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 *
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 */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#if defined(AF_INET6) && !defined(s6_addr32)
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# if defined(__sun)
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# define s6_addr32 _S6_un._S6_u32
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# elif defined(__FreeBSD__) || defined(__APPLE__)
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# define s6_addr32 __u6_addr.__u6_addr32
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# endif /* __sun */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#endif /* AF_INET6 && !s6_addr32 */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Limits...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
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
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP state values...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum /* States are server-oriented */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs{
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_WAITING, /* Waiting for command */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_OPTIONS, /* OPTIONS command, waiting for blank line */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_GET, /* GET command, waiting for blank line */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_GET_SEND, /* GET command, sending data */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_HEAD, /* HEAD command, waiting for blank line */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_POST, /* POST command, waiting for blank line */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_POST_RECV, /* POST command, receiving data */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_POST_SEND, /* POST command, sending data */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_PUT, /* PUT command, waiting for blank line */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_PUT_RECV, /* PUT command, receiving data */
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_STATUS /* Command complete, sending status */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs} http_state_t;
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP version numbers...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs{
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_0_9 = 9, /* HTTP/0.9 */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_1_0 = 100, /* HTTP/1.0 */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_1_1 = 101 /* HTTP/1.1 */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs} http_version_t;
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP keep-alive values...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs{
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_KEEPALIVE_OFF = 0,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_KEEPALIVE_ON
355b4669e025ff377602b6fc7caaf30dbc218371jacobs} http_keepalive_t;
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP transfer encoding values...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs{
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ENCODE_LENGTH, /* Data is sent with Content-Length */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ENCODE_CHUNKED /* Data is chunked */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs} http_encoding_t;
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP encryption values...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs{
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ENCRYPT_IF_REQUESTED, /* Encrypt if requested (TLS upgrade) */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ENCRYPT_NEVER, /* Never encrypt */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ENCRYPT_REQUIRED, /* Encryption is required (TLS upgrade) */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ENCRYPT_ALWAYS /* Always encrypt (SSL) */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs} http_encryption_t;
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP authentication types...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs{
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_AUTH_NONE, /* No authentication in use */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_AUTH_BASIC, /* Basic authentication in use */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_AUTH_MD5, /* Digest authentication in use */
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_auth_t;
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP status codes...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs{
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ERROR = -1, /* An error response from httpXxxx() */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_CONTINUE = 100, /* Everything OK, keep going... */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_SWITCHING_PROTOCOLS, /* HTTP upgrade to TLS/SSL */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_OK = 200, /* OPTIONS/GET/HEAD/POST/TRACE command was successful */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_CREATED, /* PUT command was successful */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_ACCEPTED, /* DELETE 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
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_SEE_OTHER, /* See this other link... */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_NOT_MODIFIED, /* File not modified */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_USE_PROXY, /* Must use a proxy to access this URI */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_BAD_REQUEST = 400, /* Bad request */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_UNAUTHORIZED, /* Unauthorized to access host */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_PAYMENT_REQUIRED, /* Payment required */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FORBIDDEN, /* Forbidden to access this URI */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_NOT_FOUND, /* URI was not found */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_METHOD_NOT_ALLOWED, /* Method is not allowed */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_NOT_ACCEPTABLE, /* Not Acceptable */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_PROXY_AUTHENTICATION, /* Proxy Authentication is Required */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_REQUEST_TIMEOUT, /* Request timed out */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_CONFLICT, /* Request is self-conflicting */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_GONE, /* Server has gone away */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_LENGTH_REQUIRED, /* A content length or encoding is required */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_PRECONDITION, /* Precondition failed */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_REQUEST_TOO_LARGE, /* Request entity too large */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_URI_TOO_LONG, /* URI too long */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_UNSUPPORTED_MEDIATYPE, /* The requested media type is unsupported */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_UPGRADE_REQUIRED = 426, /* Upgrade to SSL/TLS required */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_SERVER_ERROR = 500, /* Internal server error */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_NOT_IMPLEMENTED, /* Feature not implemented */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_BAD_GATEWAY, /* Bad gateway */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_SERVICE_UNAVAILABLE, /* Service is unavailable */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_GATEWAY_TIMEOUT, /* Gateway connection timed out */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_NOT_SUPPORTED /* HTTP version not supported */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs} http_status_t;
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP field names...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef enum
355b4669e025ff377602b6fc7caaf30dbc218371jacobs{
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_UNKNOWN = -1,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_ACCEPT_LANGUAGE,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_ACCEPT_RANGES,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_AUTHORIZATION,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_CONNECTION,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_CONTENT_ENCODING,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_CONTENT_LANGUAGE,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_CONTENT_LENGTH,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_CONTENT_LOCATION,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_CONTENT_MD5,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_CONTENT_RANGE,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_CONTENT_TYPE,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_CONTENT_VERSION,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_DATE,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_HOST,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_IF_MODIFIED_SINCE,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_IF_UNMODIFIED_SINCE,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_KEEP_ALIVE,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_LAST_MODIFIED,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_LINK,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_LOCATION,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_RANGE,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_REFERER,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_RETRY_AFTER,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_TRANSFER_ENCODING,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_UPGRADE,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_USER_AGENT,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_WWW_AUTHENTICATE,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs HTTP_FIELD_MAX
355b4669e025ff377602b6fc7caaf30dbc218371jacobs} http_field_t;
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP address structure (makes using IPv6 a little easier and more portable.)
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef union
355b4669e025ff377602b6fc7caaf30dbc218371jacobs{
355b4669e025ff377602b6fc7caaf30dbc218371jacobs struct sockaddr addr; /* Base structure for family value */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs struct sockaddr_in ipv4; /* IPv4 address */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#ifdef AF_INET6
355b4669e025ff377602b6fc7caaf30dbc218371jacobs struct sockaddr_in6 ipv6; /* IPv6 address */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#endif /* AF_INET6 */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#ifdef AF_LOCAL
355b4669e025ff377602b6fc7caaf30dbc218371jacobs struct sockaddr_un un; /* Domain socket file */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#endif /* AF_LOCAL */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char pad[128]; /* Pad to ensure binary compatibility */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs} http_addr_t;
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * HTTP connection structure...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobstypedef struct
355b4669e025ff377602b6fc7caaf30dbc218371jacobs{
355b4669e025ff377602b6fc7caaf30dbc218371jacobs int fd; /* File descriptor for this socket */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs int blocking; /* To block or not to block */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs int error; /* Last error on read */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs time_t activity; /* Time since last read/write */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs http_state_t state; /* State of client */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs http_status_t status; /* Status of last request */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs http_version_t version; /* Protocol version */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs http_keepalive_t keep_alive; /* Keep-alive supported? */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs struct sockaddr_in oldaddr; /* Address of connected host */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char hostname[HTTP_MAX_HOST],
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Name of connected host */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs fields[HTTP_FIELD_MAX][HTTP_MAX_VALUE];
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Field values */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char *data; /* Pointer to data buffer */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs http_encoding_t data_encoding; /* Chunked or not */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs int data_remaining; /* Number of bytes left */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs int used; /* Number of bytes used in buffer */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char buffer[HTTP_MAX_BUFFER];
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Buffer for messages */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs int auth_type; /* Authentication in use */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char nonce[HTTP_MAX_VALUE];
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Nonce value */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs int nonce_count; /* Nonce count */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs void *tls; /* TLS state information */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs http_encryption_t encryption; /* Encryption requirements */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /**** New in CUPS 1.1.19 ****/
355b4669e025ff377602b6fc7caaf30dbc218371jacobs fd_set *input_set; /* select() set for httpWait() */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs http_status_t expect; /* Expect: header */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char *cookie; /* Cookie value(s) */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /**** New in CUPS 1.1.20 ****/
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char authstring[HTTP_MAX_VALUE],
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Current Authentication value */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs userpass[HTTP_MAX_VALUE];
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /* Username:password string */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs int digest_tries; /* Number of tries for digest auth */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs /**** New in CUPS 1.2 ****/
355b4669e025ff377602b6fc7caaf30dbc218371jacobs http_addr_t hostaddr; /* Host address and port */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs} http_t;
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * Prototypes...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# define httpBlocking(http,b) (http)->blocking = (b)
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpCheck(http_t *http);
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# define httpClearFields(http) memset((http)->fields, 0, sizeof((http)->fields)),\
355b4669e025ff377602b6fc7caaf30dbc218371jacobs httpSetField((http), HTTP_FIELD_HOST, (http)->hostname)
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpClose(http_t *http);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern http_t *httpConnect(const char *host, int port);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern http_t *httpConnectEncrypt(const char *host, int port,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs http_encryption_t encrypt);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpDelete(http_t *http, const char *uri);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpEncryption(http_t *http, http_encryption_t e);
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# define httpError(http) ((http)->error)
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpFlush(http_t *http);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpGet(http_t *http, const char *uri);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpGets(char *line, int length, http_t *http);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern const char *httpGetDateString(time_t t);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern time_t httpGetDateTime(const char *s);
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,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs const char *name, char *value);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpHead(http_t *http, const char *uri);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpInitialize(void);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpOptions(http_t *http, const char *uri);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpPost(http_t *http, const char *uri);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpPrintf(http_t *http, const char *format, ...)
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# ifdef __GNUC__
355b4669e025ff377602b6fc7caaf30dbc218371jacobs__attribute__ ((__format__ (__printf__, 2, 3)))
355b4669e025ff377602b6fc7caaf30dbc218371jacobs# endif /* __GNUC__ */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs;
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpPut(http_t *http, const char *uri);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpRead(http_t *http, char *buffer, int length);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpReconnect(http_t *http);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpSeparate(const char *uri, char *method,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char *username, char *host, int *port,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char *resource);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpSetField(http_t *http, http_field_t field,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs const char *value);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern const char *httpStatus(http_status_t status);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpTrace(http_t *http, const char *uri);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern http_status_t httpUpdate(http_t *http);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpWrite(http_t *http, const char *buffer, int length);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpEncode64(char *out, const char *in);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpDecode64(char *out, const char *in);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpGetLength(http_t *http);
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
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/**** New in CUPS 1.1.19 ****/
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpClearCookie(http_t *http);
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#define httpGetCookie(http) ((http)->cookie)
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpSetCookie(http_t *http, const char *cookie);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpWait(http_t *http, int msec);
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
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 int inlen);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpSeparate2(const char *uri,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char *method, int methodlen,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char *username, int usernamelen,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char *host, int hostlen, int *port,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char *resource, int resourcelen);
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/**** New in CUPS 1.2 ****/
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpAddrAny(const http_addr_t *addr);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpAddrEqual(const http_addr_t *addr1,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs const http_addr_t *addr2);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern void httpAddrLoad(const struct hostent *host, int port,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs int n, http_addr_t *addr);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern int httpAddrLocalhost(const http_addr_t *addr);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpAddrLookup(const http_addr_t *addr,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char *name, int namelen);
355b4669e025ff377602b6fc7caaf30dbc218371jacobsextern char *httpAddrString(const http_addr_t *addr,
355b4669e025ff377602b6fc7caaf30dbc218371jacobs char *s, int slen);
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
0a44ef6d9afbfe052a7e975f55ea0d2954b62a82jacobs#include <stdio.h>
0a44ef6d9afbfe052a7e975f55ea0d2954b62a82jacobsextern void httpDumpData(FILE *, const char *, const char *, int);
0a44ef6d9afbfe052a7e975f55ea0d2954b62a82jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * C++ magic...
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#ifdef __cplusplus
355b4669e025ff377602b6fc7caaf30dbc218371jacobs}
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#endif
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs#endif /* !_CUPS_HTTP_H_ */
355b4669e025ff377602b6fc7caaf30dbc218371jacobs
355b4669e025ff377602b6fc7caaf30dbc218371jacobs/*
355b4669e025ff377602b6fc7caaf30dbc218371jacobs * End of "$Id: http.h 148 2006-04-25 16:54:17Z njacobs $"
355b4669e025ff377602b6fc7caaf30dbc218371jacobs */